From 9615d5db0cbbeefddb9d31a985990eba00a7ba54 Mon Sep 17 00:00:00 2001 From: Muhammet Kara Date: Fri, 23 May 2025 00:10:28 +0300 Subject: [PATCH 1/3] Clarify node setup applies to all node types, not just validators Signed-off-by: Muhammet Kara --- docs/operators/setup/index.md | 2 +- versioned_docs/version-2.0.0/operators/setup/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/operators/setup/index.md b/docs/operators/setup/index.md index 0141ff60a..f9d3695cd 100644 --- a/docs/operators/setup/index.md +++ b/docs/operators/setup/index.md @@ -1,6 +1,6 @@ # Setting up a Node -The prerequisite for becoming a validator is to set up a node and join a network as described here. +To participate as a validator, you must first set up a Casper node and join the network. Node setup instructions apply whether you're running a validator, an RPC node, or an archival node. | Title | Description | | ----------------------------------------------------------- | ----------------------------------------------- | diff --git a/versioned_docs/version-2.0.0/operators/setup/index.md b/versioned_docs/version-2.0.0/operators/setup/index.md index 0141ff60a..f9d3695cd 100644 --- a/versioned_docs/version-2.0.0/operators/setup/index.md +++ b/versioned_docs/version-2.0.0/operators/setup/index.md @@ -1,6 +1,6 @@ # Setting up a Node -The prerequisite for becoming a validator is to set up a node and join a network as described here. +To participate as a validator, you must first set up a Casper node and join the network. Node setup instructions apply whether you're running a validator, an RPC node, or an archival node. | Title | Description | | ----------------------------------------------------------- | ----------------------------------------------- | From 8122fcf14cac89f733f8ec32bdf2c541f5263a74 Mon Sep 17 00:00:00 2001 From: Muhammet Kara Date: Fri, 23 May 2025 00:13:23 +0300 Subject: [PATCH 2/3] Reword upgrade section to reflect protocol staging, not initial setup Signed-off-by: Muhammet Kara --- docs/operators/setup/index.md | 2 +- versioned_docs/version-2.0.0/operators/setup/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/operators/setup/index.md b/docs/operators/setup/index.md index f9d3695cd..ecb12d86f 100644 --- a/docs/operators/setup/index.md +++ b/docs/operators/setup/index.md @@ -9,7 +9,7 @@ To participate as a validator, you must first set up a Casper node and join the |[Node Endpoints](./node-endpoints.md) | Ports for communicating with other nodes and dApps | |[Installing a Node](./install-node.md) | Step-by-step instructions to install a Casper node | |[Setting the Open Files Limit](./open-files.md) | Required setting for the Casper node to run correctly | -|[Upgrading the Node](./upgrade.md) | Before joining the network, the node needs to be upgraded | +|[Upgrading the Node](./upgrade.md) | How to stage and verify protocol upgrades on your node | |[Joining a Running Network](./joining.md) | Steps to join an existing Casper network | |[Setting up a Non-Root User](./non-root-user.md) | Logging into the node remotely using a key | |[Node Events](./node-events.md) | Information on a node's events stream | diff --git a/versioned_docs/version-2.0.0/operators/setup/index.md b/versioned_docs/version-2.0.0/operators/setup/index.md index f9d3695cd..ecb12d86f 100644 --- a/versioned_docs/version-2.0.0/operators/setup/index.md +++ b/versioned_docs/version-2.0.0/operators/setup/index.md @@ -9,7 +9,7 @@ To participate as a validator, you must first set up a Casper node and join the |[Node Endpoints](./node-endpoints.md) | Ports for communicating with other nodes and dApps | |[Installing a Node](./install-node.md) | Step-by-step instructions to install a Casper node | |[Setting the Open Files Limit](./open-files.md) | Required setting for the Casper node to run correctly | -|[Upgrading the Node](./upgrade.md) | Before joining the network, the node needs to be upgraded | +|[Upgrading the Node](./upgrade.md) | How to stage and verify protocol upgrades on your node | |[Joining a Running Network](./joining.md) | Steps to join an existing Casper network | |[Setting up a Non-Root User](./non-root-user.md) | Logging into the node remotely using a key | |[Node Events](./node-events.md) | Information on a node's events stream | From d678544809c87e968d9f38c98a9578cfe886f2a2 Mon Sep 17 00:00:00 2001 From: Muhammet Kara Date: Fri, 23 May 2025 00:30:30 +0300 Subject: [PATCH 3/3] Move upgrade staging to the maintenance section As it's not a setup, but a maintenance task when there is an upgrade to be staged on a node which is already part of the network Signed-off-by: Muhammet Kara --- docs/operators/maintenance/index.md | 1 + docs/operators/{setup => maintenance}/upgrade.md | 0 docs/operators/setup/index.md | 1 - docs/operators/setup/node-endpoints.md | 4 ++-- versioned_docs/version-2.0.0/operators/maintenance/index.md | 1 + .../version-2.0.0/operators/{setup => maintenance}/upgrade.md | 0 versioned_docs/version-2.0.0/operators/setup/index.md | 1 - .../version-2.0.0/operators/setup/node-endpoints.md | 4 ++-- 8 files changed, 6 insertions(+), 6 deletions(-) rename docs/operators/{setup => maintenance}/upgrade.md (100%) rename versioned_docs/version-2.0.0/operators/{setup => maintenance}/upgrade.md (100%) diff --git a/docs/operators/maintenance/index.md b/docs/operators/maintenance/index.md index 185b3dad4..37c9593d4 100644 --- a/docs/operators/maintenance/index.md +++ b/docs/operators/maintenance/index.md @@ -4,5 +4,6 @@ This section covers maintenance actions such as moving a node to a different loc | Title | Description | | ----------------------------------------------------------- | ----------------------------------------------- | +|[Upgrading the Node](./upgrade.md) | How to stage and verify protocol upgrades on your node | |[Archiving and Restoring a Database](./archiving-and-restoring.md) | Using `zstd` for the compression and decompression of a Casper node database and streaming from a backup location | |[Moving a Validating Node](./moving-node.md) | Ways to move a validator node to another machine | \ No newline at end of file diff --git a/docs/operators/setup/upgrade.md b/docs/operators/maintenance/upgrade.md similarity index 100% rename from docs/operators/setup/upgrade.md rename to docs/operators/maintenance/upgrade.md diff --git a/docs/operators/setup/index.md b/docs/operators/setup/index.md index ecb12d86f..3b6e6d9e2 100644 --- a/docs/operators/setup/index.md +++ b/docs/operators/setup/index.md @@ -9,7 +9,6 @@ To participate as a validator, you must first set up a Casper node and join the |[Node Endpoints](./node-endpoints.md) | Ports for communicating with other nodes and dApps | |[Installing a Node](./install-node.md) | Step-by-step instructions to install a Casper node | |[Setting the Open Files Limit](./open-files.md) | Required setting for the Casper node to run correctly | -|[Upgrading the Node](./upgrade.md) | How to stage and verify protocol upgrades on your node | |[Joining a Running Network](./joining.md) | Steps to join an existing Casper network | |[Setting up a Non-Root User](./non-root-user.md) | Logging into the node remotely using a key | |[Node Events](./node-events.md) | Information on a node's events stream | diff --git a/docs/operators/setup/node-endpoints.md b/docs/operators/setup/node-endpoints.md index 43fc95fef..fae06b053 100644 --- a/docs/operators/setup/node-endpoints.md +++ b/docs/operators/setup/node-endpoints.md @@ -50,7 +50,7 @@ address = '0.0.0.0:8888' Opening port 8888 is recommended but not required. This port allows the node to be included in the general network health metrics, thus giving a more accurate picture of overall network health. If this port is closed, the requests coming to this port will not be served, but the node remains unaffected. -One may use this port to [get a trusted hash](./basic-node-configuration.md#trusted-hash-for-synchronizing), [verify successful staging](./upgrade.md#verifying-successful-staging) during an upgrade, or to [confirm that the node is synchronized](./joining.md#step-7-confirm-the-node-is-synchronized). +One may use this port to [get a trusted hash](./basic-node-configuration.md#trusted-hash-for-synchronizing), [verify successful staging](../maintenance/upgrade.md#verifying-successful-staging) during an upgrade, or to [confirm that the node is synchronized](./joining.md#step-7-confirm-the-node-is-synchronized). ### Example usage @@ -210,7 +210,7 @@ Here is a summary of the links mentioned on this page: - [Interacting with the network using CLI](../../developers/cli/index.md) - [Bonding](../becoming-a-validator/bonding.md#example-bonding-transaction) or [unbonding](../becoming-a-validator/unbonding.md) as a validator - [Getting a trusted node hash](./basic-node-configuration.md#trusted-hash-for-synchronizing) -- [Verifying successful staging](./upgrade.md#verifying-successful-staging) +- [Verifying successful staging](../maintenance/upgrade.md#verifying-successful-staging) - [Confirming that the node is synchronized](./joining.md#step-7-confirm-the-node-is-synchronized) - [Monitoring and consuming events](../../developers/dapps/monitor-and-consume-events.md) - [Private network access control](../setup-network/create-private.md#network-access-control) diff --git a/versioned_docs/version-2.0.0/operators/maintenance/index.md b/versioned_docs/version-2.0.0/operators/maintenance/index.md index 185b3dad4..37c9593d4 100644 --- a/versioned_docs/version-2.0.0/operators/maintenance/index.md +++ b/versioned_docs/version-2.0.0/operators/maintenance/index.md @@ -4,5 +4,6 @@ This section covers maintenance actions such as moving a node to a different loc | Title | Description | | ----------------------------------------------------------- | ----------------------------------------------- | +|[Upgrading the Node](./upgrade.md) | How to stage and verify protocol upgrades on your node | |[Archiving and Restoring a Database](./archiving-and-restoring.md) | Using `zstd` for the compression and decompression of a Casper node database and streaming from a backup location | |[Moving a Validating Node](./moving-node.md) | Ways to move a validator node to another machine | \ No newline at end of file diff --git a/versioned_docs/version-2.0.0/operators/setup/upgrade.md b/versioned_docs/version-2.0.0/operators/maintenance/upgrade.md similarity index 100% rename from versioned_docs/version-2.0.0/operators/setup/upgrade.md rename to versioned_docs/version-2.0.0/operators/maintenance/upgrade.md diff --git a/versioned_docs/version-2.0.0/operators/setup/index.md b/versioned_docs/version-2.0.0/operators/setup/index.md index ecb12d86f..3b6e6d9e2 100644 --- a/versioned_docs/version-2.0.0/operators/setup/index.md +++ b/versioned_docs/version-2.0.0/operators/setup/index.md @@ -9,7 +9,6 @@ To participate as a validator, you must first set up a Casper node and join the |[Node Endpoints](./node-endpoints.md) | Ports for communicating with other nodes and dApps | |[Installing a Node](./install-node.md) | Step-by-step instructions to install a Casper node | |[Setting the Open Files Limit](./open-files.md) | Required setting for the Casper node to run correctly | -|[Upgrading the Node](./upgrade.md) | How to stage and verify protocol upgrades on your node | |[Joining a Running Network](./joining.md) | Steps to join an existing Casper network | |[Setting up a Non-Root User](./non-root-user.md) | Logging into the node remotely using a key | |[Node Events](./node-events.md) | Information on a node's events stream | diff --git a/versioned_docs/version-2.0.0/operators/setup/node-endpoints.md b/versioned_docs/version-2.0.0/operators/setup/node-endpoints.md index 43fc95fef..fae06b053 100644 --- a/versioned_docs/version-2.0.0/operators/setup/node-endpoints.md +++ b/versioned_docs/version-2.0.0/operators/setup/node-endpoints.md @@ -50,7 +50,7 @@ address = '0.0.0.0:8888' Opening port 8888 is recommended but not required. This port allows the node to be included in the general network health metrics, thus giving a more accurate picture of overall network health. If this port is closed, the requests coming to this port will not be served, but the node remains unaffected. -One may use this port to [get a trusted hash](./basic-node-configuration.md#trusted-hash-for-synchronizing), [verify successful staging](./upgrade.md#verifying-successful-staging) during an upgrade, or to [confirm that the node is synchronized](./joining.md#step-7-confirm-the-node-is-synchronized). +One may use this port to [get a trusted hash](./basic-node-configuration.md#trusted-hash-for-synchronizing), [verify successful staging](../maintenance/upgrade.md#verifying-successful-staging) during an upgrade, or to [confirm that the node is synchronized](./joining.md#step-7-confirm-the-node-is-synchronized). ### Example usage @@ -210,7 +210,7 @@ Here is a summary of the links mentioned on this page: - [Interacting with the network using CLI](../../developers/cli/index.md) - [Bonding](../becoming-a-validator/bonding.md#example-bonding-transaction) or [unbonding](../becoming-a-validator/unbonding.md) as a validator - [Getting a trusted node hash](./basic-node-configuration.md#trusted-hash-for-synchronizing) -- [Verifying successful staging](./upgrade.md#verifying-successful-staging) +- [Verifying successful staging](../maintenance/upgrade.md#verifying-successful-staging) - [Confirming that the node is synchronized](./joining.md#step-7-confirm-the-node-is-synchronized) - [Monitoring and consuming events](../../developers/dapps/monitor-and-consume-events.md) - [Private network access control](../setup-network/create-private.md#network-access-control)