From f9c3ef31c391aca051585b358ed864189a7e2c1c Mon Sep 17 00:00:00 2001 From: "Rex St. John | Anza" <160657826+rexstjohn-anza@users.noreply.github.com> Date: Mon, 29 Jul 2024 10:10:03 -0700 Subject: [PATCH] Update install.md (#2243) * Update install.md * Update install.md * Update architecture.md * Update index.md * Update prerequisites.md * Update requirements.md * Update setup-a-validator.md * Update setup-an-rpc-node.md * Update general.md * Update monitoring.md * Update security.md * Update restart-cluster.md --- docs/src/architecture.md | 6 +++--- docs/src/cli/install.md | 4 ++-- docs/src/operations/best-practices/general.md | 6 +++--- docs/src/operations/best-practices/monitoring.md | 4 ++-- docs/src/operations/best-practices/security.md | 4 ++-- docs/src/operations/guides/restart-cluster.md | 4 ++-- docs/src/operations/index.md | 2 +- docs/src/operations/prerequisites.md | 6 +++--- docs/src/operations/requirements.md | 12 ++++++------ docs/src/operations/setup-a-validator.md | 6 +++--- docs/src/operations/setup-an-rpc-node.md | 4 ++-- 11 files changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/src/architecture.md b/docs/src/architecture.md index b51bc0fff76702..798860f9adf15a 100644 --- a/docs/src/architecture.md +++ b/docs/src/architecture.md @@ -1,8 +1,8 @@ --- -title: Solana Validator Architecture +title: Agave Validator Architecture sidebar_position: 0 sidebar_label: Overview -pagination_label: Solana Validator Architecture +pagination_label: Agave Validator Architecture --- -In this section, we will describe the architecture of the Solana Validator. +In this section, we will describe the architecture of the Agave Validator. diff --git a/docs/src/cli/install.md b/docs/src/cli/install.md index c9a5c682d40592..d2d0cad8f84566 100644 --- a/docs/src/cli/install.md +++ b/docs/src/cli/install.md @@ -8,12 +8,12 @@ sidebar_position: 1 There are multiple ways to install the Solana tools on your computer depending on your preferred workflow: -- [Use Solana's Install Tool (Simplest option)](#use-solanas-install-tool) +- [Use the Solana Install Tool (Simplest option)](#use-solanas-install-tool) - [Download Prebuilt Binaries](#download-prebuilt-binaries) - [Build from Source](#build-from-source) - [Use Homebrew](#use-homebrew) -## Use Solana's Install Tool +## Use The Solana Install Tool ### MacOS & Linux diff --git a/docs/src/operations/best-practices/general.md b/docs/src/operations/best-practices/general.md index 3e531b0160c571..92d73578ee38ee 100644 --- a/docs/src/operations/best-practices/general.md +++ b/docs/src/operations/best-practices/general.md @@ -1,5 +1,5 @@ --- -title: Solana Validator Operations Best Practices +title: Agave Validator Operations Best Practices sidebar_label: General Operations pagination_label: "Best Practices: Validator Operations" --- @@ -72,7 +72,7 @@ process. ### Building From Source -It is a best practice to always build your Solana binaries from source. If you +It is a best practice to always build your Agave binaries from source. If you build from source, you are certain that the code you are building has not been tampered with before the binary was created. You may also be able to optimize your `agave-validator` binary to your specific hardware. @@ -88,7 +88,7 @@ If you are not comfortable building from source, or you need to quickly install a new version to test something out, you could instead try using the `agave-install` command. -Assuming you want to install Solana version `1.14.17`, you would execute the +Assuming you want to install Agave version `1.14.17`, you would execute the following: ``` diff --git a/docs/src/operations/best-practices/monitoring.md b/docs/src/operations/best-practices/monitoring.md index a0f2ef9df9fa22..babef520b01abc 100644 --- a/docs/src/operations/best-practices/monitoring.md +++ b/docs/src/operations/best-practices/monitoring.md @@ -1,5 +1,5 @@ --- -title: Solana Validator Monitoring Best Practices +title: Agave Validator Monitoring Best Practices sidebar_label: Monitoring pagination_label: "Best Practices: Validator Monitoring" --- @@ -83,4 +83,4 @@ export TELEGRAM_CHAT_ID= Once your environment variables are set, restart `agave-watchtower`. You should see output about your validator. -To test that your Telegram configuration is working properly, you could stop your validator briefly until it is labeled as delinquent. Up to a minute after the validator is delinquent, you should receive a message in the Telegram group from your bot. Start the validator again and verify that you get another message in your Telegram group from the bot. The message should say `all clear`. \ No newline at end of file +To test that your Telegram configuration is working properly, you could stop your validator briefly until it is labeled as delinquent. Up to a minute after the validator is delinquent, you should receive a message in the Telegram group from your bot. Start the validator again and verify that you get another message in your Telegram group from the bot. The message should say `all clear`. diff --git a/docs/src/operations/best-practices/security.md b/docs/src/operations/best-practices/security.md index fab46b665ad7fa..861f0ecdfe9214 100644 --- a/docs/src/operations/best-practices/security.md +++ b/docs/src/operations/best-practices/security.md @@ -1,5 +1,5 @@ --- -title: Solana Validator Security Best Practices +title: Agave Validator Security Best Practices sidebar_label: Security pagination_label: "Best Practices: Validator Security" --- @@ -45,4 +45,4 @@ sudo apt install fail2ban ## DO NOT Use Password Authentication for SSH -In addition to installing `fail2ban`, it is recommended to disable password based authentication for SSH access. SSH key based authentication is preferred. \ No newline at end of file +In addition to installing `fail2ban`, it is recommended to disable password based authentication for SSH access. SSH key based authentication is preferred. diff --git a/docs/src/operations/guides/restart-cluster.md b/docs/src/operations/guides/restart-cluster.md index cda3f30a5a016d..0d3178b36a39e4 100644 --- a/docs/src/operations/guides/restart-cluster.md +++ b/docs/src/operations/guides/restart-cluster.md @@ -8,13 +8,13 @@ pagination_label: "Validator Guides: Restart a Cluster" ### Step 1. Identify the latest optimistically confirmed slot for the cluster -In Solana 1.14 or greater, run the following command to output the latest +In Agave 1.14 or greater, run the following command to output the latest optimistically confirmed slot your validator observed: ```bash agave-ledger-tool -l ledger latest-optimistic-slots ``` -In Solana 1.13 or less, the latest optimistically confirmed can be found by looking for the more recent occurrence of +In Agave 1.13 or less, the latest optimistically confirmed can be found by looking for the more recent occurrence of [this](https://github.com/solana-labs/solana/blob/0264147d42d506fb888f5c4c021a998e231a3e74/core/src/optimistic_confirmation_verifier.rs#L71) metrics datapoint. diff --git a/docs/src/operations/index.md b/docs/src/operations/index.md index 51e29ac4078cab..54312ae38d852f 100644 --- a/docs/src/operations/index.md +++ b/docs/src/operations/index.md @@ -3,6 +3,6 @@ title: Operating a Validator sidebar_position: 0 --- -This section describes how to run a Solana validator node. +This section describes how to run an Agave validator node. There are several clusters available to connect to; see [Choosing a Cluster](../cli/examples/choose-a-cluster.md) for an overview of each. diff --git a/docs/src/operations/prerequisites.md b/docs/src/operations/prerequisites.md index fb37d9ec4de3ff..d2bdf1e248d958 100644 --- a/docs/src/operations/prerequisites.md +++ b/docs/src/operations/prerequisites.md @@ -1,11 +1,11 @@ --- -title: Solana Validator Prerequisites +title: Agave Validator Prerequisites sidebar_position: 2 sidebar_label: Prerequisites pagination_label: Prerequisites to run a Validator --- -Operating a Solana validator is an interesting and rewarding task. Generally speaking, it requires someone with a technical background but also involves community engagement and marketing. +Operating an Agave validator is an interesting and rewarding task. Generally speaking, it requires someone with a technical background but also involves community engagement and marketing. ## How to be a good Validator Operator @@ -34,4 +34,4 @@ Whether you decide to run a [validator](../what-is-a-validator.md) or an [RPC no While anyone can join the network, you should make sure that your home computer and network meets the specifications in the [hardware requirements](./requirements.md) doc. Most home internet service providers do not provide consistent service that would allow your validator to perform well. If your home network or personal hardware is not performant enough to keep up with the Solana cluster, your validator will not be able to participate in consensus. -In addition to performance considerations, you will want to make sure that your home computer is resistant to outages caused by loss of power, flooding, fire, theft, etc. If you are just getting started and learning about being an operator, a home setup may be sufficient, but you will want to consider all of these factors when you start operating your validator on the mainnet-beta cluster. \ No newline at end of file +In addition to performance considerations, you will want to make sure that your home computer is resistant to outages caused by loss of power, flooding, fire, theft, etc. If you are just getting started and learning about being an operator, a home setup may be sufficient, but you will want to consider all of these factors when you start operating your validator on the mainnet-beta cluster. diff --git a/docs/src/operations/requirements.md b/docs/src/operations/requirements.md index 2810c0e749bf5a..03f3e0a4e4b245 100644 --- a/docs/src/operations/requirements.md +++ b/docs/src/operations/requirements.md @@ -1,5 +1,5 @@ --- -title: Solana Validator Requirements +title: Agave Validator Requirements sidebar_position: 3 sidebar_label: Requirements pagination_label: Requirements to Operate a Validator @@ -7,7 +7,7 @@ pagination_label: Requirements to Operate a Validator ## Minimum SOL requirements -There is no strict minimum amount of SOL required to run a validator on Solana. +There is no strict minimum amount of SOL required to run an Agave validator on Solana. However in order to participate in consensus, a vote account is required which has a rent-exempt reserve of 0.02685864 SOL. Voting also requires sending a vote @@ -30,14 +30,14 @@ The hardware recommendations below are provided as a guide. Operators are encou ## Virtual machines on Cloud Platforms -Running a solana node in the cloud requires significantly greater +Running an Agave node in the cloud requires significantly greater operational expertise to achieve stability and performance. Do not expect to find sympathetic voices should you chose this route and find yourself in need of support. ## Docker -Running validator for live clusters (including mainnet-beta) inside Docker is +Running an Agave validator for live clusters (including mainnet-beta) inside Docker is not recommended and generally not supported. This is due to concerns of general Docker's containerization overhead and resultant performance degradation unless specially configured. @@ -48,7 +48,7 @@ releases at [solanalabs/solana](https://hub.docker.com/r/solanalabs/solana). ## Software - We build and run on Ubuntu 20.04. -- See [Installing Solana CLI](../cli/install.md) for the current Solana software release. +- See [Installing Solana CLI](../cli/install.md) for the current Solana CLI software release. Prebuilt binaries are available for Linux x86_64 on CPUs supporting AVX2 \(Ubuntu 20.04 recommended\). MacOS or WSL users may build from source. @@ -71,4 +71,4 @@ be limited to any free 13 port range with `--dynamic-port-range` For security purposes, it is not suggested that the following ports be open to the internet on staked, mainnet-beta validators. - 8899 TCP - JSONRPC over HTTP. Change with `--rpc-port RPC_PORT`` -- 8900 TCP - JSONRPC over Websockets. Derived. Uses `RPC_PORT + 1` \ No newline at end of file +- 8900 TCP - JSONRPC over Websockets. Derived. Uses `RPC_PORT + 1` diff --git a/docs/src/operations/setup-a-validator.md b/docs/src/operations/setup-a-validator.md index c8d602f0bcf744..2a54b069ec20d7 100644 --- a/docs/src/operations/setup-a-validator.md +++ b/docs/src/operations/setup-a-validator.md @@ -1,6 +1,6 @@ --- -title: Setup a Solana Validator -sidebar_label: Setup a Validator +title: Setup an Agave Validator +sidebar_label: Setup an Agave Validator sidebar_position: 5 --- @@ -383,7 +383,7 @@ su - sol ## Install The Solana CLI on Remote Machine -Your remote machine will need the Solana cli installed to run the validator +Your remote machine will need the Solana CLI installed to run the Agave validator software. For simplicity, install the cli with user `sol`. Refer again to [Solana's Install Tool](../cli/install.md#use-solanas-install-tool) or [build from source](../cli/install.md#build-from-source). It is best for diff --git a/docs/src/operations/setup-an-rpc-node.md b/docs/src/operations/setup-an-rpc-node.md index e436ac21b11c4f..1fbd8202fcdcc5 100644 --- a/docs/src/operations/setup-an-rpc-node.md +++ b/docs/src/operations/setup-an-rpc-node.md @@ -1,6 +1,6 @@ --- -title: Setup a Solana RPC Node -sidebar_label: Setup an RPC Node +title: Setup an Agave RPC Node +sidebar_label: Setup an Agave RPC Node sidebar_position: 6 ---