Skip to content

Commit

Permalink
docs: Rename registration.entity to registration.entity_id
Browse files Browse the repository at this point in the history
  • Loading branch information
amela committed Oct 18, 2024
1 parent 3819b86 commit c927b9c
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 22 deletions.
6 changes: 3 additions & 3 deletions docs/node/run-your-node/keymanager-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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"
Expand Down
6 changes: 3 additions & 3 deletions docs/node/run-your-node/paratime-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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`.
Expand Down
7 changes: 4 additions & 3 deletions docs/node/run-your-node/sentry-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
25 changes: 15 additions & 10 deletions docs/node/run-your-node/validator-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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\)
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit c927b9c

Please sign in to comment.