diff --git a/docs/tooling/cli-create-nodes/create-a-validator-aws.md b/docs/tooling/cli-create-nodes/create-a-validator-aws.md index 77cb3038c62..fea26db4d87 100644 --- a/docs/tooling/cli-create-nodes/create-a-validator-aws.md +++ b/docs/tooling/cli-create-nodes/create-a-validator-aws.md @@ -29,9 +29,9 @@ Before we begin, you will need to: set. More info can be found [here](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html#file-format-creds) -## Start the Validator +## Create Validators -To start Avalanche validators, run: +To create Avalanche validators, run: ```shell avalanche node create @@ -68,9 +68,7 @@ The command will ask which region you want to set up your cloud server in: Choose custom region (list of regions available at https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) ``` -The command will next ask whether you want to set up monitoring for your nodes. If you choose to -set up monitoring, you can either set up monitoring on a separate AWS instance or on the same -instance. +The command will next ask whether you want to set up monitoring for your nodes. ```text Do you want to set up a separate instance to host monitoring? (This enables you to monitor all your set up instances in one dashboard): @@ -78,9 +76,10 @@ instance. No ``` -Setting up monitoring on a separate AWS instance enables you to have a unified Grafana dashboard -for all nodes in a cluster, as seen below: +Setting up monitoring on a separate AWS instance enables you to have a centralized Grafana logs and +dashboard for all nodes in a cluster, as seen below: +![Centralized Logs](/img/centralized-logs.png) ![Main Dashboard](/img/monitoring-dashboard.png) The separate monitoring AWS instance will have similar specs to the default AWS cloud server, @@ -99,6 +98,9 @@ node IDs as well as the public IP that each node can be reached at. Avalanche-CLI also outputs the command that you can use to ssh into each cloud server node. +Finally, if monitoring is set up, Avalanche-CLI will also output the Grafana link where the +centralized dashboards and logs can be accessed. + By the end of successful run of `create` command, Avalanche-CLI would have: - Installed Avalanche Go in cloud server @@ -107,7 +109,7 @@ By the end of successful run of `create` command, Avalanche-CLI would have: Back up this private key file as you will not be able to ssh into the cloud server node without it (unless `ssh-agent` is used). - Downloaded `staker.crt` and `staker.key` files to your local `.avalanche-cli` directory so that you can back up your node. More info about node backup can be found [here](/nodes/maintain/node-backup-and-restore.md) -- Started the process of bootstrapping your new Avalanche node to the Primary Network +- Started the process of bootstrapping your new Avalanche node to the Primary Network (for non-Devnet only). Please note that Avalanche CLI can be configured to use `ssh-agent` for ssh communication. In this case public key will be read from there and cloud server will be accessible using it. Yubikey hardware can be also used to store private ssh @@ -115,6 +117,12 @@ key. Please use official Yubikey documentation, for example [https://developers. ## Check Bootstrap Status +:::note + +Ignore for Devnet + +::: + Please note that you will have to wait until the nodes have finished bootstrapping before the nodes can be Primary Network or Subnet Validators. To check whether all the nodes in a cluster have finished bootstrapping, run `avalanche node status `. diff --git a/docs/tooling/cli-create-nodes/create-a-validator-gcp.md b/docs/tooling/cli-create-nodes/create-a-validator-gcp.md index 499bf974050..ba706014c98 100644 --- a/docs/tooling/cli-create-nodes/create-a-validator-gcp.md +++ b/docs/tooling/cli-create-nodes/create-a-validator-gcp.md @@ -29,9 +29,9 @@ Before we begin, you will need to: - Enable Compute Engine API [here](https://console.cloud.google.com/apis/api/compute.googleapis.com) - Download the key json for the automatically created service account as shown [here](https://cloud.google.com/iam/docs/keys-create-delete#creating) -## Start the Validator +## Create Validator -To start Avalanche validators, run: +To create Avalanche validators, run: ```shell avalanche node create @@ -67,9 +67,7 @@ Which Google Region do you want to set up your node(s) in?: Choose custom Google Region (list of Google Regions available at https://cloud.google.com/compute/docs/regions-zones/) ``` -The command will next ask whether you want to set up monitoring for your nodes. If you choose to -set up monitoring, you can either set up monitoring on a separate GCP instance or on the same -instance. +The command will next ask whether you want to set up monitoring for your nodes. ```text Do you want to set up a separate instance to host monitoring? (This enables you to monitor all your set up instances in one dashboard): @@ -80,6 +78,7 @@ instance. Setting up monitoring on a separate GCP instance enables you to have a unified Grafana dashboard for all nodes in a cluster, as seen below: +![Centralized Logs](/img/centralized-logs.png) ![Main Dashboard](/img/monitoring-dashboard.png) The separate monitoring GCP instance will have similar specs to the default GCP cloud server, @@ -98,6 +97,9 @@ node IDs as well as the public IP that each node can be reached at. Avalanche-CLI also outputs the command that you can use to ssh into each cloud server node. +Finally, if monitoring is set up, Avalanche-CLI will also output the Grafana link where the +centralized dashboards and logs can be accessed. + By the end of successful run of `create` command, Avalanche-CLI would have: - Installed Avalanche Go in cloud server @@ -113,6 +115,12 @@ key. Please use official Yubikey documentation, for example [https://developers. ## Check Bootstrap Status +:::note + +Ignore for Devnet + +::: + Please note that you will have to wait until the nodes have finished bootstrapping before the nodes can be Primary Network or Subnet Validators. To check whether all the nodes in a cluster have finished bootstrapping, run `avalanche node status `. diff --git a/docs/tooling/cli-create-nodes/setup-a-devnet.md b/docs/tooling/cli-create-nodes/setup-a-devnet.md index fc3de89efb3..d876b3d8145 100644 --- a/docs/tooling/cli-create-nodes/setup-a-devnet.md +++ b/docs/tooling/cli-create-nodes/setup-a-devnet.md @@ -10,7 +10,7 @@ sidebar_position: 2 This page demonstrates how to set up a Devnet of cloud-based validators using Avalanche-CLI. -Devnets (Developer Networks) are isolated avalanche networks deployed on the cloud. Similar to local networks +Devnets (Developer Networks) are isolated Avalanche networks deployed on the cloud. Similar to local networks in terms of configuration and usage but installed on remote nodes. Think of Devnets as being an intermediate step in the developer testing process after local network and before Fuji network. @@ -30,7 +30,7 @@ Before we begin, you will need to have: Note: the tutorial uses AWS hosts, but Devnets can also be created and operated in other supported cloud providers, such as GCP. -## Choose a Deployment Method +## Setting up a Devnet Setting up a Devnet consists of: diff --git a/docs/tooling/cli-create-nodes/upload-a-custom-vm-to-cloud.md b/docs/tooling/cli-create-nodes/upload-a-custom-vm-to-cloud.md index 97a742cc51b..452cc5c81fe 100644 --- a/docs/tooling/cli-create-nodes/upload-a-custom-vm-to-cloud.md +++ b/docs/tooling/cli-create-nodes/upload-a-custom-vm-to-cloud.md @@ -24,12 +24,11 @@ ALPHA WARNING: This command is currently in experimental mode. Proceed at your o Before we begin, you will need to have: -- Created a Cloud Server node as described [here](/tooling/cli-create-nodes/create-a-validator-aws.md) +- Created a cloud server node as described [here](/tooling/cli-create-nodes/create-a-validator-aws.md) - Created a Custom VM, as described [here](/build/vm/intro.md). -- Set up a key to be able to pay for the Fuji Fees, as described [here](/build/subnet/deploy/fuji-testnet-subnet.md). +- (Ignore for Devnet) Set up a key to be able to pay for transaction Fees, as described [here](/build/subnet/deploy/fuji-testnet-subnet.md). -Currently, we only support AWS cloud services, but we plan to add support for more cloud -services in the near future. +Currently, only AWS & GCP cloud services are supported. ## Deploying the VM @@ -135,9 +134,9 @@ Cloning into ... Successfully created subnet configuration ``` -## Deploy Subnet on Fuji +## Deploy Subnet -To deploy the Subnet and blockchain on Fuji, run: +For this example, we will deploy the Subnet and blockchain on Fuji. Run: ```shell avalanche subnet deploy diff --git a/docs/tooling/cli-create-nodes/validate-subnets.md b/docs/tooling/cli-create-nodes/validate-subnets.md index cfbe991f1ed..f38dd11515a 100644 --- a/docs/tooling/cli-create-nodes/validate-subnets.md +++ b/docs/tooling/cli-create-nodes/validate-subnets.md @@ -9,7 +9,7 @@ sidebar_position: 3 # Configure a Node to Validate a Subnet with Avalanche-CLI This page demonstrates how to configure nodes to validate an Avalanche Subnet. -Validation via Avalanche-CLI is currently only supported on Fuji. +Subnet Validation via Avalanche-CLI is currently only supported on Fuji and Devnet. :::warning @@ -24,11 +24,11 @@ Before we begin, you will need to have: - Created a Cloud Server node as described for [AWS](/tooling/cli-create-nodes/create-a-validator-aws.md) or [GCP](/tooling/cli-create-nodes/create-a-validator-gcp.md) - A node bootstrapped to the Primary Network (run `avalanche node status ` to check - bootstrap status) -- Deployed a Subnet on Fuji through CLI as described [here](/build/subnet/deploy/fuji-testnet-subnet) + bootstrap status) (Ignore for Devnet) +- Deployed a Subnet on [Fuji](/build/subnet/deploy/fuji-testnet-subnet) or Devnet - Stored key / Ledger with AVAX to pay for gas fess associated with adding node as Primary Network and Subnet Validator transactions. Instructions on how to fund stored key on Fuji can be found - [here](/build/subnet/deploy/fuji-testnet-subnet.md#funding-the-key) + [here](/build/subnet/deploy/fuji-testnet-subnet.md#funding-the-key) (Ignore for Devnet) ## Sync with Subnet @@ -61,8 +61,8 @@ To have the nodes be Subnet Validators, run: avalanche node validate subnet ``` -If any of the nodes is not yet a Primary Network Validator, we will first add it as a Primary -Network Validator. +For Fuji Only: If any of the nodes is not yet a Primary Network Validator, we will first add it as +a Primary Network Validator. The wizard will ask us how we want to pay for the transaction fees. Choose `Use stored key` for Fuji: @@ -98,8 +98,6 @@ Note: if you see an error indicating that the transaction is not committed, run `avalanche node validate subnet ` again as it could be due to the validator start time having elapsed. -Next, we will wait for 20 seconds for the node to officially start as a Primary Network Validator. - We will then proceed with adding the node as a Subnet Validator. Similar to adding the node as a Primary Network Validator, the wizard will ask you for how you would like to pay for the transaction fee. diff --git a/static/img/centralized-logs.png b/static/img/centralized-logs.png new file mode 100644 index 00000000000..3975b93c65b Binary files /dev/null and b/static/img/centralized-logs.png differ