From a788c98b6f6a5e0440ebdef0698f8c1705bb14ba Mon Sep 17 00:00:00 2001 From: gw0 Date: Wed, 22 Nov 2023 16:28:29 +0100 Subject: [PATCH] docs/node: Improve links to Network Parameters page --- .../advanced/install-oasis-remote-signer-binary.md | 9 +++++++-- docs/node/run-your-node/keymanager-node/README.md | 13 ++++++++----- docs/node/run-your-node/non-validator-node.md | 7 +++++-- docs/node/run-your-node/paratime-client-node.mdx | 11 +++++++---- docs/node/run-your-node/paratime-node.mdx | 11 +++++++---- docs/node/run-your-node/prerequisites/oasis-node.md | 11 +++++++---- docs/node/run-your-node/seed-node.md | 5 ++++- docs/node/run-your-node/sentry-node.md | 6 +++++- docs/node/run-your-node/troubleshooting.md | 2 +- docs/node/run-your-node/validator-node.mdx | 2 +- 10 files changed, 52 insertions(+), 25 deletions(-) diff --git a/docs/node/run-your-node/advanced/install-oasis-remote-signer-binary.md b/docs/node/run-your-node/advanced/install-oasis-remote-signer-binary.md index 82644620e1..372ab3e490 100644 --- a/docs/node/run-your-node/advanced/install-oasis-remote-signer-binary.md +++ b/docs/node/run-your-node/advanced/install-oasis-remote-signer-binary.md @@ -26,7 +26,10 @@ We suggest that you build Oasis Remote Signer from source yourself for a product ::: -For convenience, we provide binaries that have been built by the Oasis Protocol Foundation. Links to the binaries are provided in the [Network Parameters](../../mainnet/README.md) page. +For convenience, we provide binaries that have been built by the Oasis Protocol Foundation. Links to the binaries are provided in the Network Parameters page ([Mainnet], [Testnet]). + +[Mainnet]: ../../mainnet/README.md +[Testnet]: ../../testnet/README.md ## Building From Source @@ -38,12 +41,14 @@ See [Oasis Core's Build Environment Setup and Building](../../../core/developmen The code in the [`master` branch](https://github.com/oasisprotocol/oasis-core/tree/master/) might be incompatible with the code used by other nodes in the Mainnet. -Make sure to use the version specified in the [Network Parameters](../../mainnet/README.md). +Make sure to use the version specified in the Network Parameters page ([Mainnet], [Testnet]). ::: ## Adding `oasis-remote-signer` Binary to `PATH` +To install the `oasis-node` binary next to your Oasis node data directory, copy/symlink it to e.g. `/node/bin`. + To install the `oasis-remote-signer` binary for the current user, copy/symlink it to `~/.local/bin`. To install the `oasis-remote-signer` binary for all users of the system, copy it to `/usr/local/bin`. diff --git a/docs/node/run-your-node/keymanager-node/README.md b/docs/node/run-your-node/keymanager-node/README.md index c98c369e0c..e13abbae92 100644 --- a/docs/node/run-your-node/keymanager-node/README.md +++ b/docs/node/run-your-node/keymanager-node/README.md @@ -24,13 +24,16 @@ Before following this guide, make sure you've followed the [Prerequisites](../pr * `data`: This will store the data directory needed by Oasis Node, including your node identity and the blockchain state. The directory permissions should be `rwx------`. * `bin`: This will store binaries needed by Oasis Node for running the ParaTimes. * `runtimes`: This will store the ParaTime bundles. -* Downloaded or compiled the correct versions of everything according to [Mainnet Network Parameters](../../mainnet/README.md): +* Downloaded or compiled the correct versions of everything according to Network Parameters page ([Mainnet], [Testnet]). * The genesis file copied to `/node/etc/genesis.json`. * The binaries needed by Oasis Node for running the ParaTimes copied to `/node/bin/`. * The key manager ParaTime bundle (`.orc` extension) copied to `/node/runtimes/`. * Initialized a new node and updated your entity registration by following the [Register a New Entity or Update Your Entity Registration](../paratime-node.mdx#register-a-new-entity-or-update-your-entity-registration) instructions. * The entity descriptor file copied to `/node/etc/entity.json`. +[Mainnet]: ../../mainnet/README.md +[Testnet]: ../../testnet/README.md + :::tip Reading the rest of the [validator node setup instructions](../validator-node.mdx) and [ParaTime node setup instructions](../paratime-node.mdx) may also be useful. @@ -116,13 +119,13 @@ Before using this configuration you should collect the following information to * `{{ external_address }}`: The external IP you used when registering this node. * `{{ seed_node_address }}`: The seed node address in the form `ID@IP:port`. - * You can find the current Oasis Seed Node address in the [Network Parameters](../../mainnet/README.md). + * You can find the current Oasis Seed Node address in the Network Parameters page ([Mainnet], [Testnet]). * `{{ keymanager_runtime_orc_path }}`: Path to the key manager [ParaTime bundle](../paratime-node.mdx#the-paratime-bundle) of the form `/node/runtimes/foo-paratime.orc`. - * You can find the current Oasis-supported key manager ParaTime in the [Mainnet Network Paramers](../../mainnet/README.md#paratimes). + * You can find the current Oasis-supported key manager ParaTime in the Network Parameters page ([Mainnet], [Testnet]). * `{{ keymanager_runtime_id }}`: Runtime identified for the key manager ParaTime. - * You can find the current Oasis-supported key manager ParaTime identifiers in the [Mainnet Network Paramers](../../mainnet/README.md#paratimes). + * You can find the current Oasis-supported key manager ParaTime identifiers in the Network Parameters page ([Mainnet], [Testnet]). * `{{ ias_proxy_address }}`: The IAS proxy address in the form `ID@HOST:port`. - * You can find the current Oasis IAS proxy address in the [Mainnet Network Parameters](../../mainnet/README.md#cipher-paratime). + * You can find the current Oasis IAS proxy address in the Network Parameters page ([Mainnet], [Testnet]). * If you want, you can also [run your own IAS proxy](../ias-proxy.md). :::caution diff --git a/docs/node/run-your-node/non-validator-node.md b/docs/node/run-your-node/non-validator-node.md index fc90860dcf..2431da42d0 100644 --- a/docs/node/run-your-node/non-validator-node.md +++ b/docs/node/run-your-node/non-validator-node.md @@ -29,7 +29,10 @@ mkdir -m700 -p /node/{etc,data} ### Copying the Genesis File -The latest genesis file can be found in [Network Parameters](../mainnet/README.md). You should download the latest `genesis.json` file and copy it to the `/node/etc` directory we just created. +The latest genesis file can be found in the Network Parameters page ([Mainnet], [Testnet]). You should download the latest `genesis.json` file and copy it to the `/node/etc` directory we just created. + +[Mainnet]: ../mainnet/README.md +[Testnet]: ../testnet/README.md ## Configuration @@ -68,7 +71,7 @@ Before using this configuration you should collect the following information to * `{{ seed_node_address }}`: The seed node address in the form `ID@IP:port`. - You can find the current Oasis Seed Node address in the [Network Parameters](../mainnet/README.md). + You can find the current Oasis Seed Node address in the Network Parameters page ([Mainnet], [Testnet]). ## Starting the Oasis Node diff --git a/docs/node/run-your-node/paratime-client-node.mdx b/docs/node/run-your-node/paratime-client-node.mdx index 0f457639f5..410b4bab60 100644 --- a/docs/node/run-your-node/paratime-client-node.mdx +++ b/docs/node/run-your-node/paratime-client-node.mdx @@ -74,12 +74,15 @@ For example, running a ParaTime client node for an SGX-enabled ParaTime like Cip ### The ParaTime Bundle -In order to run a ParaTime node you need to obtain the ParaTime bundle that -needs to come from a trusted source. The bundle (usually with an `.orc` +In order to run a ParaTime node you need to obtain an active ParaTime bundle, +see the Network Parameters page ([Mainnet], [Testnet]). The bundle (`.orc` extension that stands for Oasis Runtime Container) contains all the needed ParaTime binaries together with the identifier and version metadata to ease deployment. +[Mainnet]: ../mainnet/README.md +[Testnet]: ../testnet/README.md + When the ParaTime is running in a trusted execution environment (TEE) the bundle will also contain all the required artifacts (e.g. SGXS version of the binary and any enclave signatures). @@ -207,9 +210,9 @@ runtime: Before using this configuration you should collect the following information to replace the variables present in the configuration file:. * `{{ seed_node_address }}`: The seed node address in the form `ID@IP:port`. - * You can find the current Oasis Seed Node address in the [Network Parameters](../mainnet/README.md). + * You can find the current Oasis Seed Node address in the Network Parameters page ([Mainnet], [Testnet]). * `{{ runtime_orc_path }}`: Path to the [ParaTime bundle](paratime-client-node.mdx#the-paratime-bundle) of the form `/node/runtimes/foo-paratime.orc`. - * You can find the current Oasis-supported ParaTimes in the [Network Paramers](../mainnet/README.md#paratimes). + * You can find the current Oasis-supported ParaTimes in the Network Parameters page ([Mainnet], [Testnet]). ## Starting the Oasis Node diff --git a/docs/node/run-your-node/paratime-node.mdx b/docs/node/run-your-node/paratime-node.mdx index d6667e6674..d16f2a3ad8 100644 --- a/docs/node/run-your-node/paratime-node.mdx +++ b/docs/node/run-your-node/paratime-node.mdx @@ -177,10 +177,13 @@ in the consensus layer will not work and will be rejected by the network. For ParaTimes running inside [Intel SGX trusted execution environment](paratime-node.mdx#setting-up-trusted-execution-environment-tee), you will need to install the Oasis Core Runtime Loader. -The Oasis Core Runtime Loader binary (`oasis-core-runtime-loader`) is part of Oasis Core binary releases, so make sure you download the appropriate version specified the [Network Parameters](../mainnet/README.md) page. +The Oasis Core Runtime Loader binary (`oasis-core-runtime-loader`) is part of Oasis Core binary releases, so make sure you download the appropriate version specified the Network Parameters page ([Mainnet], [Testnet]). Install it to `bin` subdirectory of your node's working directory, e.g. `/node/bin/oasis-core-runtime-loader`. +[Mainnet]: ../mainnet/README.md +[Testnet]: ../testnet/README.md + ### Install ParaTime Bundle For each ParaTime, you need to obtain its bundle and install it to the @@ -327,11 +330,11 @@ Before using this configuration you should collect the following information to * `{{ external_address }}`: The external IP you used when registering this node. * `{{ seed_node_address }}`: The seed node address in the form `ID@IP:port`. - * You can find the current Oasis Seed Node address in the [Network Parameters](../mainnet/README.md). + * You can find the current Oasis Seed Node address in the Network Parameters page ([Mainnet], [Testnet]). * `{{ runtime_orc_path }}`: Path to the [ParaTime bundle](paratime-node.mdx#the-paratime-bundle) of the form `/node/runtimes/foo-paratime.orc`. - * You can find the current Oasis-supported ParaTimes in the [Network Paramers](../mainnet/README.md#paratimes). + * You can find the current Oasis-supported ParaTimes in the Network Parameters page ([Mainnet], [Testnet]). * `{{ ias_proxy_address }}`: The IAS proxy address in the form `ID@HOST:port`. - * You can find the current Oasis IAS proxy address in the [Network Parameters](../mainnet/README.md#cipher-paratime). + * You can find the current Oasis IAS proxy address in the Network Parameters page ([Mainnet], [Testnet]). * If you want, you can also [run your own IAS proxy](ias-proxy.md). :::caution diff --git a/docs/node/run-your-node/prerequisites/oasis-node.md b/docs/node/run-your-node/prerequisites/oasis-node.md index 354d937ca5..eec7a067fd 100644 --- a/docs/node/run-your-node/prerequisites/oasis-node.md +++ b/docs/node/run-your-node/prerequisites/oasis-node.md @@ -18,7 +18,10 @@ We suggest that you build Oasis Node from source yourself for a production deplo ::: -For convenience, we provide binaries that have been built by the Oasis Protocol Foundation. Links to the binaries are provided in the [Network Parameters](../../mainnet/README.md) page. +For convenience, we provide binaries that have been built by the Oasis Protocol Foundation. Links to the binaries are provided in the Network Parameters page ([Mainnet], [Testnet]). + +[Mainnet]: ../../mainnet/README.md +[Testnet]: ../../testnet/README.md ## Building From Source @@ -30,12 +33,14 @@ See [Oasis Core's Build Environment Setup and Building](../../../core/developmen The code in the [`master` branch](https://github.com/oasisprotocol/oasis-core/tree/master/) might be incompatible with the code used by other nodes in the Mainnet. -Make sure to use the version specified in the [Network Parameters](../../mainnet/README.md). +Make sure to use the version specified in the Network Parameters page ([Mainnet], [Testnet]). ::: ## Adding `oasis-node` Binary to `PATH` +To install the `oasis-node` binary next to your Oasis node data directory, copy/symlink it to e.g. `/node/bin`. + To install the `oasis-node` binary for the current user, copy/symlink it to `~/.local/bin`. To install the `oasis-node` binary for all users of the system, copy it to `/usr/local/bin`. @@ -46,8 +51,6 @@ If you intend to [run a ParaTime node](../paratime-node.mdx) you will need to ad * [Bubblewrap](https://github.com/projectatomic/bubblewrap) 0.4.1+, needed for creating process sandboxes. - - On Ubuntu 20.04+, you can install it with: ```text diff --git a/docs/node/run-your-node/seed-node.md b/docs/node/run-your-node/seed-node.md index d6c8e173f7..e5d6932824 100644 --- a/docs/node/run-your-node/seed-node.md +++ b/docs/node/run-your-node/seed-node.md @@ -23,7 +23,10 @@ mkdir -m700 -p /node/{etc,data} ### Copying the Genesis File -The latest genesis file can be found in [Network Parameters](../mainnet/README.md). You should download the latest `genesis.json` file and copy it to the `/node/etc` directory we just created. +The latest genesis file can be found in the Network Parameters page ([Mainnet], [Testnet]). You should download the latest `genesis.json` file and copy it to the `/node/etc` directory we just created. + +[Mainnet]: ../mainnet/README.md +[Testnet]: ../testnet/README.md ## Configuration diff --git a/docs/node/run-your-node/sentry-node.md b/docs/node/run-your-node/sentry-node.md index 2c80fc03e8..3d9e70daa8 100644 --- a/docs/node/run-your-node/sentry-node.md +++ b/docs/node/run-your-node/sentry-node.md @@ -33,7 +33,11 @@ An example of full `YAML` configuration of a sentry node is below. Before using this configuration you should collect the following information to replace the variables present in the configuration file: * `{{ external_address }}`: This is the external IP on which sentry node will be reachable. -* `{{ seed_node_address }}`: This the seed node address of the form `ID@IP:port`. You can find the current Oasis Seed Node address in the [Network Parameters](../mainnet/README.md). +* `{{ seed_node_address }}`: This the seed node address of the form `ID@IP:port`. You can find the current Oasis Seed Node address in the Network Parameters page ([Mainnet], [Testnet]). + +[Mainnet]: ../mainnet/README.md +[Testnet]: ../testnet/README.md + * `{{ validator_tendermint_id }}`: This is the Tendermint ID (address) of the Oasis validator node that will be protected by the sentry node. This address can be obtained by running: ```bash diff --git a/docs/node/run-your-node/troubleshooting.md b/docs/node/run-your-node/troubleshooting.md index c509a167dd..b5ba7b5807 100644 --- a/docs/node/run-your-node/troubleshooting.md +++ b/docs/node/run-your-node/troubleshooting.md @@ -4,7 +4,7 @@ Before you begin troubleshooting we suggest you check all of the following: -* Check that your current binary version is the latest listed on the [Current Network Parameters](../mainnet/README.md) +* Check that your current binary version is the latest listed on the Network Parameters page ([Mainnet](../mainnet/README.md), [Testnet](../testnet/README.md)) * Check the version on your localhost using `oasis-node --version` * Check the version on your server using `oasis-node --version` * If upgrading, make sure that you've wiped state (unless that is explicitly not required) diff --git a/docs/node/run-your-node/validator-node.mdx b/docs/node/run-your-node/validator-node.mdx index b8f254cc50..a79658adb3 100644 --- a/docs/node/run-your-node/validator-node.mdx +++ b/docs/node/run-your-node/validator-node.mdx @@ -214,7 +214,7 @@ of that machine. * `{{ seed_node_address }}`: The seed node address in the form `ID@IP:port`. You can find the current Oasis Seed Node address in the Network Parameters - ([Mainnet], [Testnet]). + page ([Mainnet], [Testnet]). To use this configuration, save it in the `/node/etc/config.yml` file: