From c927b9ccc8728c9a4251e0b3701a86d64e73c4c3 Mon Sep 17 00:00:00 2001 From: amela Date: Tue, 15 Oct 2024 09:24:55 +0200 Subject: [PATCH] docs: Rename registration.entity to registration.entity_id --- .../run-your-node/keymanager-node/README.md | 6 ++--- .../maintenance/refreshing-certificates.md | 6 ++--- docs/node/run-your-node/paratime-node.mdx | 6 ++--- docs/node/run-your-node/sentry-node.md | 7 +++--- docs/node/run-your-node/validator-node.mdx | 25 +++++++++++-------- 5 files changed, 28 insertions(+), 22 deletions(-) diff --git a/docs/node/run-your-node/keymanager-node/README.md b/docs/node/run-your-node/keymanager-node/README.md index d8045c8a2c..63c65a45f4 100644 --- a/docs/node/run-your-node/keymanager-node/README.md +++ b/docs/node/run-your-node/keymanager-node/README.md @@ -90,9 +90,8 @@ runtime: worker: registration: - # In order for the node to register itself, the entity.json of the entity - # used to provision the node must be available on the node. - entity: /node/etc/entity.json + # In order for the node to register itself, the entity ID must be set. + entity_id: {{ entity_id }} keymanager: runtime: @@ -122,6 +121,7 @@ Before using this configuration you should collect the following information to * 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 Network Parameters page ([Mainnet], [Testnet]). +* `{{ entity_id }}`: The node's entity ID from the `entity.json` file. * `{{ keymanager_runtime_id }}`: Runtime identified for the key manager ParaTime. * 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`. diff --git a/docs/node/run-your-node/maintenance/refreshing-certificates.md b/docs/node/run-your-node/maintenance/refreshing-certificates.md index 3d41cb45c4..29f99591fd 100644 --- a/docs/node/run-your-node/maintenance/refreshing-certificates.md +++ b/docs/node/run-your-node/maintenance/refreshing-certificates.md @@ -131,6 +131,7 @@ After generating a new TLS private key and certificate on the sentry node, set t Before using the below validator node configuration snippet, replace the following variables: +* `{{ entity_id }}`: The node's entity ID from the `entity.json` file. * `{{ sentry_node_grpc_public_key }}`: The sentry node's new TLS public key encoded in Base64-encoding (e.g. `1dA4/NuYPSWXYaKpLhaofrZscIb2FDKtJclCMnVC0Xc=`). * `{{ sentry_node_private_ip }}`: The private IP address of the sentry node over which sentry node should be accessible to the validator. @@ -139,9 +140,8 @@ Before using the below validator node configuration snippet, replace the followi worker: registration: - # In order for the node to register itself the entity.json of the entity - # used to provision the node must be available on the node. - entity: /node/etc/entity.json + # In order for the node to register itself, the entity ID must be set. + entity_id: {{ entity_id }} sentry: address: - "{{ sentry_node_grpc_public_key }}@{{ sentry_node_private_ip }}:9009" diff --git a/docs/node/run-your-node/paratime-node.mdx b/docs/node/run-your-node/paratime-node.mdx index b4b91b5952..3b9f34792f 100644 --- a/docs/node/run-your-node/paratime-node.mdx +++ b/docs/node/run-your-node/paratime-node.mdx @@ -310,9 +310,8 @@ p2p: - {{ seed_node_address }} registration: - # In order for the node to register itself, the entity.json of the entity - # used to provision the node must be available on the node. - entity: /node/entity/entity.json + # In order for the node to register itself, the entity ID must be set. + entity_id: {{ entity_id }} runtime: paths: @@ -328,6 +327,7 @@ 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 page ([Mainnet], [Testnet]). +* `{{ entity_id }}`: The node's entity ID from the `entity.json` file. * `{{ 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 Parameters page ([Mainnet], [Testnet]). * `{{ ias_proxy_address }}`: The IAS proxy address in the form `ID@HOST:port`. diff --git a/docs/node/run-your-node/sentry-node.md b/docs/node/run-your-node/sentry-node.md index 11e3bbc665..4a3bf6f2f8 100644 --- a/docs/node/run-your-node/sentry-node.md +++ b/docs/node/run-your-node/sentry-node.md @@ -182,6 +182,8 @@ Before using this configuration you should collect the following information to on the sentry node. +* `{{ entity_id }}`: This is node's entity ID from `entity.json`. + ```yaml mode: validator common: @@ -210,9 +212,8 @@ genesis: file: /node/etc/genesis.json registration: - # In order for the node to register itself the entity.json of the entity - # used to provision the node must be available on the node. - entity: /node/etc/entity.json + # In order for the node to register itself, the entity ID must be set. + entity_id: {{ entity_id }} sentry: address: diff --git a/docs/node/run-your-node/validator-node.mdx b/docs/node/run-your-node/validator-node.mdx index e0790ad14b..4fda873eb9 100644 --- a/docs/node/run-your-node/validator-node.mdx +++ b/docs/node/run-your-node/validator-node.mdx @@ -132,8 +132,17 @@ Create a JSON file containing the **public key** of your entity by executing oasis account entity init -o /localhostdir/entity/entity.json --account my_entity ``` -Now, we can move on to configuring our Oasis node with the freshly generated -`entity.json`. +Now, we can move on to configuring our Oasis node with the information from +freshly generated `entity.json`. + +:::info + +You can obtain your entity ID by running the command: `cat entity.json`, or +alternatively, by using the Oasis CLI with the following command: +`oasis wallet show my_entity`. If you use the Oasis CLI, your entity ID will be +displayed in the `Public Key` field. + +::: [Ledger]: ../../general/manage-tokens/holding-rose-tokens/ledger-wallet.md [offline/air-gapped machine]: https://en.wikipedia.org/wiki/Air_gap_\(networking\) @@ -142,11 +151,6 @@ Now, we can move on to configuring our Oasis node with the freshly generated [`oasis wallet import-file`]: ../../general/manage-tokens/cli/wallet.md#import-file [`oasis account entity init`]: ../../general/manage-tokens/cli/account.md#entity-init -### Copy the Public Entity File Descriptor to `server` - -The Oasis node needs access to the public key of your entity. Copy your -`entity.json` to `/node/etc/entity.json` on the `server`. - ## Configuration There are a variety of options available when running an Oasis node. The @@ -171,6 +175,8 @@ of that machine. You can find the current Oasis Seed Node address in the Network Parameters page ([Mainnet], [Testnet]). +* `{{ entity_id }}`: The node's entity ID from `entity.json`. + To use this configuration, save it in the `/node/etc/config.yml` file: [Mainnet]: ../mainnet/README.md @@ -224,9 +230,8 @@ p2p: - {{ seed_node_address }} registration: - # In order for the node to register itself, the entity.json of the entity - # used to provision the node must be available on the node. - entity: /node/etc/entity.json + # In order for the node to register itself, the entity ID must be set. + entity_id: {{ entity_id }} ``` :::caution