external components

Author: skudasov

book/src/SUMMARY.md

@@ -16,6 +16,7 @@
     - [Test Configuration](./framework/test_configuration_overrides.md)
     - [Components Persistence](framework/components/state.md)
     - [Components Caching](framework/components/caching.md)
+    - [External Environment](framework/components/external.md)
     - [Secrets]()
     - [Docker](framework/docker.md)
     - [Observability Stack](framework/observability/observability_stack.md)

book/src/framework/components/caching.md

@@ -9,21 +9,3 @@ If cached config has any outputs with `use_cache = true` it will be used instead
 ```
 export CTF_CONFIGS=smoke-cache.toml
 ```
-
-### Using remote components
-
-Because components are decoupled through outputs, you can use a cached config and switch outputs to any deployed infrastructure, such as staging. This allows you to reuse the same testing logic for behavior validation.
-
-Example:
-```
-[blockchain_a.out]
-use_cache = true
-chain_id = '31337'
-
-[[blockchain_a.out.nodes]]
-ws_url = 'ws://127.0.0.1:33447'
-http_url = 'http://127.0.0.1:33447'
-docker_internal_ws_url = 'ws://anvil-3716a:8900'
-docker_internal_http_url = 'http://anvil-3716a:8900'
-```
-Set flag `use_cache = true` on any component output, change output fields as needed and run your test again.

book/src/framework/components/external.md

@@ -0,0 +1,62 @@
+# External Environment
+
+### Using remote components
+
+Because components are decoupled through outputs, you can use a cached config and switch outputs to any deployed infrastructure, such as staging. 
+
+This allows you to reuse the same testing logic for behavior validation.
+
+For example, to integrate with remote `k8s` environment you can use `CTF_CONFIGS=smoke_external.toml` and override all the outputs of components to connect to your remote env.
+
+```toml
+[blockchain_a]
+
+  [blockchain_a.out]
+    chain_id = "31337"
+    use_cache = true
+
+    [[blockchain_a.out.nodes]]
+      # set up your RPC URLs
+      docker_internal_http_url = "http://anvil-2cfcf:8545"
+      docker_internal_ws_url = "ws://anvil-2cfcf:8545"
+      http_url = "http://127.0.0.1:8545"
+      ws_url = "ws://127.0.0.1:8545"
+
+[contracts]
+
+  [contracts.out]
+    # set up your contracts
+    addresses = ["0x5fbdb2315678afecb367f032d93f642f64180aa3"]
+    use_cache = true
+
+[data_provider]
+  port = 9111
+
+  [data_provider.out]
+    # setup your data provider URLs
+    base_url_docker = "http://host.docker.internal:9111"
+    base_url_host = "http://localhost:9111"
+
+[nodeset]
+
+  [[nodeset.node_specs]]
+
+  [nodeset.out]
+    use_cache = true
+
+    [[nodeset.out.cl_nodes]]
+      use_cache = true
+
+      [nodeset.out.cl_nodes.node]
+        # set up each node URLs
+        docker_internal_url = "http://node0:6688"
+        p2p_docker_internal_url = "http://node0:6690"
+        p2p_url = "http://127.0.0.1:12000"
+        url = "http://127.0.0.1:10000"
+
+      [nodeset.out.cl_nodes.postgresql]
+        # set up a database URL so tests can connect to your database if needed
+        url = "postgresql://chainlink:[email protected]:13000/db_0?sslmode=disable"
+      
+      # more nodes in this array, configuration is the same ...
+```