Add port config to deployment spec. (#498)

* Add port config to deployment spec.
2023-08-11 15:25:54 -05:00
parent fd78935fe6
commit 18e45af463
2 changed files with 72 additions and 17 deletions
@@ -70,12 +70,41 @@ To permanently *delete* the stack's data volumes run:
 $ laconic-so deployment --dir mainnet-eth-deployment stop --delete-data-volumes
 ```
 After deleting the volumes, any subsequent re-start will begin chain sync from cold.
+
+## Ports
+It is usually necessary to expose certain container ports on one or more the host's addresses to allow incoming connections.
+Any ports defined in the Docker compose file are exposed by default with random port assignments, but the values can be
+customized by editing the "spec" file generated by `laconic-so deploy init`.
+
+In this example, ports `8545` and `5052` have been assigned to a specific addresses/port combination on the host, while
+port `40000` has been left with random assignment:
+```
+$ cat mainnet-eth-spec.yml
+stack: mainnet-eth
+ports:
+  mainnet-eth-geth-1:
+   - '10.10.10.10:8545:8545'
+   - '40000'
+  mainnet-eth-lighthouse-1:
+   - '10.10.10.10:5052:5052'
+volumes:
+  mainnet_eth_config_data: ./data/mainnet_eth_config_data
+  mainnet_eth_geth_1_data: ./data/mainnet_eth_geth_1_data
+  mainnet_eth_lighthouse_1_data: ./data/mainnet_eth_lighthouse_1_data
+```
+
 ## Data volumes
 Container data volumes are bind-mounted to specified paths in the host filesystem.
 The default setup (generated by `laconic-so deploy init`) places the volumes in the `./data` subdirectory of the deployment directory:
 ```
 $ cat mainnet-eth-spec.yml
 stack: mainnet-eth
+ports:
+  mainnet-eth-geth-1:
+   - '10.10.10.10:8545:8545'
+   - '40000'
+  mainnet-eth-lighthouse-1:
+   - '10.10.10.10:5052:5052'
 volumes:
  mainnet_eth_config_data: ./data/mainnet_eth_config_data
  mainnet_eth_geth_1_data: ./data/mainnet_eth_geth_1_data