From dc9ff4ad5239a771485054fe019eebd6a7def309 Mon Sep 17 00:00:00 2001 From: Raj Karamchedu Date: Wed, 12 Oct 2022 11:29:57 -0700 Subject: [PATCH] [Docs] Adding haproxy cfg file to the node file list. (#4966) * [Docs] Adding haproxy cfg file to the node file list. * [Docs] Updated the download instruction in all the node install docs. * [Docs] Adding links and instructions to download additional files. * [Docs] Updated paths. * [Docs] Fixing what files are needed. --- developer-docs-site/docs/nodes/node-files.md | 47 +++++++++++++++---- .../running-validator-node/using-aws.md | 5 +- .../running-validator-node/using-azure.md | 4 +- .../running-validator-node/using-docker.md | 12 ++++- .../running-validator-node/using-gcp.md | 4 +- .../using-source-code.md | 18 +++++-- 6 files changed, 69 insertions(+), 21 deletions(-) diff --git a/developer-docs-site/docs/nodes/node-files.md b/developer-docs-site/docs/nodes/node-files.md index e57dd3f7128a4..9e61a8ac2b115 100644 --- a/developer-docs-site/docs/nodes/node-files.md +++ b/developer-docs-site/docs/nodes/node-files.md @@ -13,19 +13,19 @@ When you are deploying an Aptos node, you will need the following files. These c ## docker-compose.yaml - **Git repo:** `aptos-core` -- **Git branch:** `mainnet` on https://github.com/aptos-labs/aptos-core +- **Git branch:** `mainnet_deployment` on https://github.com/aptos-labs/aptos-core - **Command to download:** ```bash - wget -O docker-compose.yaml https://raw.githubusercontent.com/aptos-labs/aptos-core/mainnet/docker/compose/aptos-node/docker-compose.yaml + wget -O docker-compose.yaml https://raw.githubusercontent.com/aptos-labs/aptos-core/mainnet_deployment/docker/compose/aptos-node/docker-compose.yaml ``` ## validator.yaml - **Git repo:** `aptos-core` -- **Git branch:** `mainnet` on https://github.com/aptos-labs/aptos-core +- **Git branch:** `mainnet_deployment` on https://github.com/aptos-labs/aptos-core - **Command to download:** ```bash - wget -O validator.yaml https://raw.githubusercontent.com/aptos-labs/aptos-core/mainnet/docker/compose/aptos-node/validator.yaml + wget -O validator.yaml https://raw.githubusercontent.com/aptos-labs/aptos-core/mainnet_deployment/docker/compose/aptos-node/validator.yaml ``` ## genesis.blob @@ -46,13 +46,31 @@ When you are deploying an Aptos node, you will need the following files. These c wget -O waypoint.txt https://raw.githubusercontent.com/aptos-labs/aptos-networks/main/premainnet/waypoint.txt ``` +## docker-compose-src.yaml + +- **Git repo:** `aptos-core` +- **Git branch:** `mainnet_deployment` on https://github.com/aptos-labs/aptos-core +- **Command to download:** + ```bash + wget -O docker-compose-src.yaml https://raw.githubusercontent.com/aptos-labs/aptos-core/mainnet_deployment/docker/compose/aptos-node/docker-compose-src.yaml + ``` + +## haproxy.cfg + +- **Git repo:** `aptos-core` +- **Git branch:** `mainnet_deployment` on https://github.com/aptos-labs/aptos-core +- **Command to download:** + ```bash + wget -O haproxy.cfg https://raw.githubusercontent.com/aptos-labs/aptos-core/mainnet_deployment/docker/compose/aptos-node/haproxy.cfg + ``` + ## blocked.ips - **Git repo:** `aptos-core` -- **Git branch:** `mainnet` on https://github.com/aptos-labs/aptos-core +- **Git branch:** `mainnet_deployment` on https://github.com/aptos-labs/aptos-core - **Command to download:** ```bash - wget -O blocked.ips https://raw.githubusercontent.com/aptos-labs/aptos-core/mainnet/docker/compose/aptos-node/blocked.ips + wget -O blocked.ips https://raw.githubusercontent.com/aptos-labs/aptos-core/mainnet_deployment/docker/compose/aptos-node/blocked.ips ``` ## docker-compose-fullnode.yaml (fullnode only) @@ -62,10 +80,10 @@ Fullnode means either a validator fullnode or a public fullnode. ::: - **Git repo:** `aptos-core` -- **Git branch:** `mainnet` on https://github.com/aptos-labs/aptos-core +- **Git branch:** `mainnet_deployment` on https://github.com/aptos-labs/aptos-core - **Command to download:** ```bash - wget -O docker-compose.yaml https://raw.githubusercontent.com/aptos-labs/aptos-core/mainnet/docker/compose/aptos-node/docker-compose-fullnode.yaml + wget -O docker-compose.yaml https://raw.githubusercontent.com/aptos-labs/aptos-core/mainnet_deployment/docker/compose/aptos-node/docker-compose-fullnode.yaml ``` ## fullnode.yaml (fullnode only) @@ -75,8 +93,17 @@ Fullnode means either a validator fullnode or a public fullnode. ::: - **Git repo:** `aptos-core` -- **Git branch:** `mainnet` on https://github.com/aptos-labs/aptos-core +- **Git branch:** `mainnet_deployment` on https://github.com/aptos-labs/aptos-core +- **Command to download:** + ```bash + wget -O fullnode.yaml https://raw.githubusercontent.com/aptos-labs/aptos-core/mainnet_deployment/docker/compose/aptos-node/fullnode.yaml + ``` + +## haproxy-fullnode.cfg (fullnode only) + +- **Git repo:** `aptos-core` +- **Git branch:** `mainnet_deployment` on https://github.com/aptos-labs/aptos-core - **Command to download:** ```bash - wget -O fullnode.yaml https://raw.githubusercontent.com/aptos-labs/aptos-core/mainnet/docker/compose/aptos-node/fullnode.yaml + wget -O haproxy-fullnode.cfg https://raw.githubusercontent.com/aptos-labs/aptos-core/mainnet_deployment/docker/compose/aptos-node/haproxy-fullnode.cfg ``` diff --git a/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-aws.md b/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-aws.md index 8589e8554e456..fbb19ce16207b 100644 --- a/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-aws.md +++ b/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-aws.md @@ -158,8 +158,9 @@ This will download all the Terraform dependencies into the `.terraform` folder i This will create two YAML files in the `~/$WORKSPACE/$USERNAME` directory: `owner.yaml` and `operator.yaml`. -12. Download the genesis blob and waypoint for the network you want to connect to. See [Node Files](/nodes/node-files.md) for a full list of files you should download and the download commands. - +12. Download the following files by following the download commands on the [Node Files](/nodes/node-files.md) page: + - `genesis.blob` + - `waypoint.txt` 13. **Summary:** To summarize, in your working directory you should have a list of files: - `main.tf`: The Terraform files to install the `aptos-node` module (from steps 3 and 4). diff --git a/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-azure.md b/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-azure.md index 9575c5ed1c5b7..5a1004429d8ae 100644 --- a/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-azure.md +++ b/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-azure.md @@ -150,7 +150,9 @@ This will download all the Terraform dependencies for you, in the `.terraform` f This will create two YAML files in the `~/$WORKSPACE/$USERNAME` directory: `owner.yaml` and `operator.yaml`. -12. Download the genesis blob and waypoint for the network you want to connect to. See [Node Files](/nodes/node-files.md) for a full list of files you should download and the download commands. +12. Download the following files by following the download commands on the [Node Files](/nodes/node-files.md) page: + - `genesis.blob` + - `waypoint.txt` 13. **Summary:** To summarize, in your working directory you should have a list of files: - `main.tf`: The Terraform files to install the `aptos-node` module (from steps 3 and 4). diff --git a/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-docker.md b/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-docker.md index a131117390667..556863fbff143 100644 --- a/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-docker.md +++ b/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-docker.md @@ -27,7 +27,13 @@ Docker method has only been tested on Linux, Windows, and Intel macOS. If you ar cd ~/$WORKSPACE ``` -2. Download the validator.yaml, docker-compose.yaml and blocked.ips configuration files into this directory. See [Node Files](/nodes/node-files.md) for a full list of files you should download and the download commands. +2. Download the following files by following the download commands on the [Node Files](/nodes/node-files.md) page: + - `validator.yaml` + - `docker-compose.yaml` + - `docker-compose-fullnode.yaml` + - `haproxy.cfg` + - `haproxy-fullnode.cfg` + - `blocked.ips` 3. Generate the key pairs (node owner, voter, operator key, consensus key and networking key) in your working directory. @@ -81,7 +87,9 @@ Docker method has only been tested on Linux, Windows, and Intel macOS. If you ar This will create two YAML files in the `~/$WORKSPACE/$USERNAME` directory: `owner.yaml` and `operator.yaml`. -5. Download the genesis blob and waypoint for the network you want to connect to. See [Node Files](/nodes/node-files.md) for a full list of files you should download and the download commands. +5. Download the following files by following the download commands on the [Node Files](/nodes/node-files.md) page: + - `genesis.blob` + - `waypoint.txt` 6. To recap, in your working directory, you should have a list of files: diff --git a/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-gcp.md b/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-gcp.md index 63ad6766f89de..a48e51213c86d 100644 --- a/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-gcp.md +++ b/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-gcp.md @@ -149,7 +149,9 @@ This will download all the Terraform dependencies for you, in the `.terraform` f This will create two YAML files in the `~/$WORKSPACE/$USERNAME` directory: `owner.yaml` and `operator.yaml`. -12. Download the genesis blob and waypoint for the network you want to connect to. See [Node Files](/nodes/node-files.md) for a full list of files you should download and the download commands. +12. Download the following files by following the download commands on the [Node Files](/nodes/node-files.md) page: + - `genesis.blob` + - `waypoint.txt` 13. To summarize, in your working directory you should have a list of files: - `main.tf`: The Terraform files to install the `aptos-node` module (from steps 3 and 4). diff --git a/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-source-code.md b/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-source-code.md index 41d1f422d4d0a..96639cbc5aadb 100644 --- a/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-source-code.md +++ b/developer-docs-site/docs/nodes/validator-node/operator/running-validator-node/using-source-code.md @@ -105,13 +105,21 @@ With your development environment ready, now you can start to setup your validat This will create two YAML files in the `~/$WORKSPACE/$USERNAME` directory: `owner.yaml` and `operator.yaml`. -9. Download the genesis blob and waypoint for the network you want to connect to. See [Node Files](/nodes/node-files.md) for a full list of files you should download and the download commands. - -10. Copy the `validator.yaml`, `fullnode.yaml` files into this directory. +9. Download the following files by following the download commands on the [Node Files](/nodes/node-files.md) page: + - `validator.yaml` + - `fullnode.yaml` + - `genesis.blob` + - `waypoint.txt` + - `haproxy.cfg` + - `haproxy-fullnode.cfg` and + - `blocked.ips` + - `docker-compose-src.yaml` + +10. Copy the `validator.yaml`, `fullnode.yaml` files into ~/$WORKSPACE/config/ directory. ```bash mkdir ~/$WORKSPACE/config - cp docker/compose/aptos-node/validator.yaml ~/$WORKSPACE/config/validator.yaml - cp docker/compose/aptos-node/fullnode.yaml ~/$WORKSPACE/config/fullnode.yaml + cp validator.yaml ~/$WORKSPACE/config/validator.yaml + cp fullnode.yaml ~/$WORKSPACE/config/fullnode.yaml ``` Modify the config files to update the data directory, key path, genesis file path, waypoint path. User must have write access to data directory.