Update terminology around experimental features (#1162)

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
pull/1164/head
Alexandra Tran 2 years ago committed by GitHub
parent 49bc233373
commit 3401687746
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      docs/private-networks/how-to/configure/curves.md
  2. 2
      docs/private-networks/how-to/use-permissioning/local.md
  3. 2
      docs/private-networks/how-to/use-permissioning/onchain.md
  4. 2
      docs/private-networks/reference/api/index.md
  5. 6
      docs/public-networks/concepts/node-keys.md
  6. 2
      docs/public-networks/how-to/connect/manage-peers.md
  7. 6
      docs/public-networks/how-to/connect/sync-node.md
  8. 3
      docs/public-networks/how-to/monitor/understand-metrics.md
  9. 4
      docs/public-networks/how-to/use-besu-api/index.md
  10. 4
      docs/public-networks/how-to/use-besu-api/json-rpc.md
  11. 11
      docs/public-networks/reference/cli/options.md

@ -6,7 +6,7 @@ description: Using alternative elliptic curves in Besu
!!! caution
Configuring alternative elliptic curves is an experimental feature.
Configuring alternative elliptic curves is an early access feature.
By default, Besu uses the Ethereum standard `secp256k1` elliptic curve (EC).
However, when running nodes in a private network, it is possible to configure an alternative elliptic curve.

@ -14,7 +14,7 @@ enabled, communication is only between nodes in the allowlist.
!!! important
Node allowlists [support domain names] in enode URLs as an experimental feature. Use the `--Xdns-enabled` option
Node allowlists [support domain names] in enode URLs as an early access feature. Use the `--Xdns-enabled` option
to enable domain name support.
If using Kubernetes, enable domain name support and use the `--Xdns-update-enabled` option to ensure that Besu can

@ -55,7 +55,7 @@ To add a node to the Hyperledger Besu nodes allowlist:
!!! important
Node allowlists [support domain names] in enode URLs as an experimental feature. Use the `--Xdns-enabled` option
Node allowlists [support domain names] in enode URLs as an early access feature. Use the `--Xdns-enabled` option
to enable domain name support.
If using Kubernetes, enable domain name support and use the `--Xdns-update-enabled` option to ensure that Besu can

@ -720,7 +720,7 @@ to avoid receiving a `request contains an invalid node` error.
!!! warning
Enode URL domain name support is an experimental feature.
Enode URL domain name support is an early access feature.
#### Parameters

@ -102,13 +102,13 @@ defined by [`--nat-method`](../how-to/connect/specify-nat.md).
!!! warning
Enode URL domain name support is an experimental feature that you can use in private
Enode URL domain name support is an early access feature that you can use in private
[permissioned networks](../../private-networks/concepts/permissioning/index.md) only.
To use domain names in enode URLs:
* Configure DNS reverse lookup.
* Enable DNS support using Besu's `--Xdns-enabled` experimental command line option.
* Enable DNS support using the early access option `--Xdns-enabled`.
!!! example "Example enode URL using a domain name"
@ -122,7 +122,7 @@ To use domain names in enode URLs:
`--Xdns-enabled` and `--Xdns-update-enabled` options to ensure that Besu can connect to a container after
restarting even if the IP address of the container changes.
Use the [`--Xhelp`](../reference/cli/options.md#xhelp) command line option to view experimental options and their
Use the [`--Xhelp`](../reference/cli/options.md#xhelp) command line option to view early access options and their
descriptions.
If nodes are not connecting as expected, set the [log level to TRACE](../reference/api/index.md#admin_changeloglevel) to

@ -35,7 +35,7 @@ To reduce the maximum number of peers, use the
option to the same value or lower.
For example, if you decrease `--max-peers` to 20, set `--Xp2p-peer-lower-bound` to 20 or lower.
Note, `Xp2p-peer-lower-bound` is an experimental option.
Note, `Xp2p-peer-lower-bound` is an early access option.
## Limit remote connections

@ -85,8 +85,8 @@ You can observe the `besu_synchronizer_fast_sync_*` and `besu_synchronizer_world
!!! important
Snap sync is an experimental feature.
However, we recommend using snap sync over fast sync even in certain production environments (for example, staking),
Snap sync is an early access feature.
We recommend using snap sync over fast sync even in certain production environments (for example, staking),
because snap sync can be faster by several days.
If your snap sync completes successfully, you have the correct world state.
@ -107,7 +107,7 @@ deleting the data directory, and starting over using `--sync-mode=X_SNAP`.
!!! important
Checkpoint sync is an experimental feature.
Checkpoint sync is an early access feature.
Enable checkpoint sync using [`--sync-mode=X_CHECKPOINT`](../../reference/cli/options.md#sync-mode).
You need Besu version 22.4.3 or later to use checkpoint sync.

@ -4,8 +4,7 @@ tags:
- public networks
---
If you've run Besu on mainnet several times with `X_SNAP` option enabled
([see experimental options](../../reference/cli/options.md#xhelp)),
If you've run Besu on mainnet several times with `X_SNAP` option enabled,
you may have noticed graphical patterns that stand out in different metrics charts.
These patterns are related to the Besu sync process.

@ -24,7 +24,7 @@ To enable API access, use the
!!! caution
`--Xrpc-ipc-enabled` is an experimental option.
`--Xrpc-ipc-enabled` is an early access option.
## Service hosts
@ -64,7 +64,7 @@ The default path is `besu.ipc` in the Besu data directory.
!!! caution
`--Xrpc-ipc-path` is an experimental option.
`--Xrpc-ipc-path` is an early access option.
## Host allowlist

@ -15,7 +15,7 @@ To enable JSON-RPC over an [IPC socket](index.md#socket-path), use the
!!! caution
`--Xrpc-ipc-enabled` is an experimental option.
`--Xrpc-ipc-enabled` is an early access option.
--8<-- "global/Postman.md"
@ -244,7 +244,7 @@ To enable the `ADMIN`, `CLIQUE`, `DEBUG`, `EEA`, `IBFT`, `MINER`, `PERM`, `PLUGI
!!! caution
`--Xrpc-ipc-api` is an experimental option.
`--Xrpc-ipc-api` is an early access option.
## Block parameter

@ -479,7 +479,7 @@ The default is `true`.
!!! note
You can override the default DNS server if it's unreliable or doesn't serve TCP DNS requests, using the
[experimental option](#xhelp) `--Xp2p-dns-discovery-server=<HOST>`.
[early access option](#xhelp) `--Xp2p-dns-discovery-server=<HOST>`.
### `engine-host-allowlist`
@ -1039,13 +1039,12 @@ The maximum number of P2P connections you can establish. The default is 25.
!!! caution
The minimum number of peers is set by the `--Xp2p-peer-lower-bound` option, which also has a default of 25.
The minimum number of peers is set by the early access option `--Xp2p-peer-lower-bound`, which
also has a default of 25.
If you reduce the `--max-peers` from the default, you must also set the `--Xp2p-peer-lower-bound`
option to the same value or lower.
For example, if you decrease `--max-peers` to 20, set `--Xp2p-peer-lower-bound` to 20 or lower.
Note, `Xp2p-peer-lower-bound` is an experimental option.
### `metrics-category`
=== "Syntax"
@ -3190,7 +3189,7 @@ Use `FAST` for [fast sync](../../how-to/connect/sync-node.md#fast-synchronizatio
!!! important
Snap sync and checkpoint sync are experimental features.
Snap sync and checkpoint sync are early access features.
We recommend using snap sync over fast sync even in certain production environments (for example, staking), because
snap sync can be faster by several days.
@ -3361,7 +3360,7 @@ The maximum period, in hours, to hold pending transactions in the transaction po
-X, --Xhelp
```
Displays the experimental options and their descriptions, and exit.
Displays the early access options and their descriptions, and exit.
!!! warning

Loading…
Cancel
Save