Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Beta documentation index#284 #290

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/int/quickstart/activate-dv.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem';
# Activate a DV

:::caution
Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).

:::

If you have successfully created a distributed validator and you are ready to activate it, congratulations! 🎉
Expand Down
16 changes: 8 additions & 8 deletions docs/int/quickstart/advanced/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,18 @@ To create alerts for Node-Exporter, follow these steps based on the sample rules
5. Finally, save and apply the configuration file. Prometheus should now trigger alerts based on these rules.


For alerts specific to Charon/Alpha, refer to the alerting rules available on this [ObolNetwork/monitoring](https://github.com/ObolNetwork/monitoring/tree/main/alerting-rules).
For alerts specific to Charon/Beta, refer to the alerting rules available on this [ObolNetwork/monitoring](https://github.com/ObolNetwork/monitoring/tree/main/alerting-rules).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove all mentions of Alpha/beta from this page and try to keep alerts as generic as possible


## Understanding Alert Rules

1. `ClusterBeaconNodeDown`This alert is activated when the beacon node in a specified Alpha cluster is offline. The beacon node is crucial for validating transactions and producing new blocks. Its unavailability could disrupt the overall functionality of the cluster.
2. `ClusterBeaconNodeSyncing`This alert indicates that the beacon node in a specified Alpha cluster is synchronizing, i.e., catching up with the latest blocks in the cluster.
3. `ClusterNodeDown`This alert is activated when a node in a specified Alpha cluster is offline.
4. `ClusterMissedAttestations`:This alert indicates that there have been missed attestations in a specified Alpha cluster. Missed attestations may suggest that validators are not operating correctly, compromising the security and efficiency of the cluster.
1. `ClusterBeaconNodeDown`This alert is activated when the beacon node in a specified Beta cluster is offline. The beacon node is crucial for validating transactions and producing new blocks. Its unavailability could disrupt the overall functionality of the cluster.
2. `ClusterBeaconNodeSyncing`This alert indicates that the beacon node in a specified Beta cluster is synchronizing, i.e., catching up with the latest blocks in the cluster.
3. `ClusterNodeDown`This alert is activated when a node in a specified Beta cluster is offline.
4. `ClusterMissedAttestations`:This alert indicates that there have been missed attestations in a specified Beta cluster. Missed attestations may suggest that validators are not operating correctly, compromising the security and efficiency of the cluster.
5. `ClusterInUnknownStatus`: This alert is designed to activate when a node within the cluster is detected to be in an unknown state. The condition is evaluated by checking whether the maximum of the app_monitoring_readyz metric is 0.
6. `ClusterInsufficientPeers`:This alert is set to activate when the number of peers for a node in the Alpha M1 Cluster #1 is insufficient. The condition is evaluated by checking whether the maximum of the **`app_monitoring_readyz`** equals 4.
7. `ClusterFailureRate`: This alert is activated when the failure rate of the Alpha M1 Cluster #1 exceeds a certain threshold.
8. `ClusterVCMissingValidators`: This alert is activated if any validators in the Alpha M1 Cluster #1 are missing.
6. `ClusterInsufficientPeers`:This alert is set to activate when the number of peers for a node in the Beta M2 Cluster #1 is insufficient. The condition is evaluated by checking whether the maximum of the **`app_monitoring_readyz`** equals 4.
7. `ClusterFailureRate`: This alert is activated when the failure rate of the Beta M2 Cluster #1 exceeds a certain threshold.
8. `ClusterVCMissingValidators`: This alert is activated if any validators in the Beta M2 Cluster #1 are missing.
Comment on lines +46 to +53
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree with Thomas that this doesn't make a whole load of sense. Alpha M1 is the name of a particular example cluster, not some term to be changed to Beta M2.

9. `ClusterHighPctFailedSyncMsgDuty`: This alert is activated if a high percentage of sync message duties failed in the cluster. The alert is activated if the sum of the increase in failed duties tagged with "sync_message" in the last hour divided by the sum of the increase in total duties tagged with "sync_message" in the last hour is greater than 0.1.
10. `ClusterNumConnectedRelays`: This alert is activated if the number of connected relays in the cluster falls to 0.
11. PeerPingLatency: 1. This alert is activated if the 90th percentile of the ping latency to the peers in a cluster exceeds 500ms within 2 minutes.
Expand Down
2 changes: 1 addition & 1 deletion docs/int/quickstart/advanced/quickstart-builder-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem';
# Run a cluster with MEV enabled

:::caution
Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).

:::

This quickstart guide focuses on configuring the builder API for Charon and supported validator and consensus clients.
Expand Down
2 changes: 1 addition & 1 deletion docs/int/quickstart/advanced/quickstart-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';

:::caution

The Obol-SDK is in an alpha state and should be used with caution., particularly on mainnet.
The Obol-SDK is in an beta state and should be used with caution., particularly on mainnet.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Obol-SDK is in an beta state and should be used with caution., particularly on mainnet.
The Obol-SDK is in a beta state and should be used with caution, only on testnet.

:::

This is a walkthrough of using the [Obol-SDK](https://www.npmjs.com/package/@obolnetwork/obol-sdk) to propose a four-node distributed validator cluster for creation using the [DV Launchpad](../../../dvl/intro.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/int/quickstart/advanced/quickstart-split.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Split existing validator keys
# Split existing validator private keys

:::caution
Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).


This process should only be used if you want to split an *existing validator private key* into multiple private key shares for use in a Distributed Validator Cluster. If your existing validator is not properly shut down before the Distributed Validator starts, your validator may be slashed.

Expand Down
2 changes: 1 addition & 1 deletion docs/int/quickstart/alone/create-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem';
# Create the private key shares

:::caution
Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).

:::

:::info
Expand Down
2 changes: 1 addition & 1 deletion docs/int/quickstart/group/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Run a cluster as a group

:::caution
Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).

:::

:::info
Expand Down
2 changes: 1 addition & 1 deletion docs/int/quickstart/group/quickstart-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Run one node in a multi-operator distributed validator cluster usin
# Using the CLI

:::caution
Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).

:::

The following instructions aim to assist a group of operators coordinating together to create a distributed validator cluster via the CLI.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem';
# Creator & Leader Journey

:::caution
Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).

:::

The following instructions aim to assist with the preparation of a distributed validator key generation ceremony. Select the *Leader* tab if you **will** be an operator participating in the cluster, and select the *Creator* tab if you **will NOT** be an operator in the cluster.
Expand Down
2 changes: 1 addition & 1 deletion docs/int/quickstart/group/quickstart-group-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: A node operator joins a DV cluster
# Operator Journey

:::caution
Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).

:::

The following instructions aim to assist a group of operators coordinating together to create a distributed validator cluster after receiving an cluster invite link from a leader or creator.
Expand Down
2 changes: 1 addition & 1 deletion docs/int/quickstart/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Quickstart Guides

:::caution
Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).

:::

There are two ways to set up a distributed validator and each comes with its own quickstart
Expand Down
2 changes: 1 addition & 1 deletion docs/int/quickstart/quickstart-exit.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem';
# Exit a DV

:::caution
Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).
Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).

:::

Users looking to exit staking entirely and withdraw their full balance back must also sign and broadcast a "voluntary exit" message with validator keys which will start the process of exiting from staking. This is done with your validator client and submitted to your beacon node, and does not require gas. In the case of a DV, each charon node needs to broadcast a partial exit to the other nodes of the cluster. Once a threshold of partial exits has been received by any node, the full voluntary exit will be sent to the beacon chain.
Expand Down
2 changes: 1 addition & 1 deletion docs/int/quickstart/quickstart-mainnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Run a cluster on mainnet
# Run a DV on mainnet

:::caution
Charon is in an alpha state, and you should proceed only if you accept the risk, the [terms of use](https://obol.tech/terms.pdf), and have tested running a Distributed Validator on a testnet first.
Charon is in an beta state, and you should proceed only if you accept the risk, the [terms of use](https://obol.tech/terms.pdf), and have tested running a Distributed Validator on a testnet first.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Charon is in an beta state, and you should proceed only if you accept the risk, the [terms of use](https://obol.tech/terms.pdf), and have tested running a Distributed Validator on a testnet first.
Charon is in a beta state, and you should proceed only if you accept the risk, the [terms of use](https://obol.tech/terms.pdf), and have tested running a Distributed Validator on a testnet first.


Distributed Validators created for goerli cannot be used on mainnet and vice versa, please take caution when creating, backing up, and activating mainnet validators.
:::
Expand Down