Skip to content

Commit

Permalink
Update install.md (#2243)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
rexstjohn-anza authored Jul 29, 2024
1 parent c90eee3 commit f9c3ef3
Show file tree
Hide file tree
Showing 11 changed files with 29 additions and 29 deletions.
6 changes: 3 additions & 3 deletions docs/src/architecture.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 2 additions & 2 deletions docs/src/cli/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/src/operations/best-practices/general.md
Original file line number Diff line number Diff line change
@@ -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"
---
Expand Down Expand Up @@ -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.
Expand All @@ -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:

```
Expand Down
4 changes: 2 additions & 2 deletions docs/src/operations/best-practices/monitoring.md
Original file line number Diff line number Diff line change
@@ -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"
---
Expand Down Expand Up @@ -83,4 +83,4 @@ export TELEGRAM_CHAT_ID=<negative chat id number>

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`.
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`.
4 changes: 2 additions & 2 deletions docs/src/operations/best-practices/security.md
Original file line number Diff line number Diff line change
@@ -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"
---
Expand Down Expand Up @@ -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.
In addition to installing `fail2ban`, it is recommended to disable password based authentication for SSH access. SSH key based authentication is preferred.
4 changes: 2 additions & 2 deletions docs/src/operations/guides/restart-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/operations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions docs/src/operations/prerequisites.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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.
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.
12 changes: 6 additions & 6 deletions docs/src/operations/requirements.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Solana Validator Requirements
title: Agave Validator Requirements
sidebar_position: 3
sidebar_label: Requirements
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
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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`
- 8900 TCP - JSONRPC over Websockets. Derived. Uses `RPC_PORT + 1`
6 changes: 3 additions & 3 deletions docs/src/operations/setup-a-validator.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/src/operations/setup-an-rpc-node.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down

0 comments on commit f9c3ef3

Please sign in to comment.