Skip to content

Commit

Permalink
docs/validator-node: Use oasis-node identity init instead of running …
Browse files Browse the repository at this point in the history 
…full node
  • Loading branch information
@matevz
matevz committed Nov 24, 2023
1 parent f28cfbf commit 3a5296b
Show file tree
Hide file tree
Showing 2 changed files with 132 additions and 114 deletions.
100 changes: 78 additions & 22 deletions docs/node/run-your-node/prerequisites/oasis-node.md
View file
Original file line number Diff line number Diff line change
@@ -1,65 +1,121 @@
# Install Oasis Node Binary
# Install the Oasis Node

The Oasis Node is a binary that is created from the [Oasis Core](https://github.com/oasisprotocol/oasis-core) repository's `go/` path.

It contains both the logic for running an Oasis node and also provides a CLI for handling registry, staking and other operations.
The Oasis node is a binary that is created from the [Oasis Core] repository's
[`go/`] directory. It is a single executable that contains the logic for running
your node in various [roles].

:::caution

The Oasis Node is currently only supported on x86_64 Linux systems.

:::

## Downloading a Binary Release
[Oasis Core]: https://github.com/oasisprotocol/oasis-core
[`go/`]: https://github.com/oasisprotocol/oasis-core/tree/master/go
[roles]: ../../README.mdx#node-roles

:::tip
## Set up the Oasis Node's Working Directory

Before we install the Oasis node we need to ensure that we have a place to
store necessary files.

We suggest that you build Oasis Node from source yourself for a production deployment of an Oasis node.
:::info

We will reference the working directory on the server as `/node`
throughout the documentation.

:::

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]).
### Setting Up the the `/node` Directory

In the `/node` directory, create the following subdirectories:

* `etc/`: this is to store the configuration and `entity.json`
* `data/`: this is to store the node's data
* `bin/`: this is to store the `oasis-node` binary
* `runtimes/`: this is to store the ParaTime `.orc` bundles

You can make this directory structure with the **corresponding permissions** by
executing the following command:

```shell
mkdir -m700 -p /node/{etc,bin,runtimes,data}
```

### Copying the Genesis File to the server

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 `/node/etc/genesis.json` on the `server`.

[Mainnet]: ../../mainnet/README.md
[Testnet]: ../../testnet/README.md

## Building From Source
## Obtain the `oasis-node` Binary

### Downloading a Binary Release

Although highly suggested, building from source is currently beyond the scope of this documentation.
:::tip

We suggest that you build Oasis Node from source yourself for a production
deployment of an Oasis node.

:::

See [Oasis Core's Build Environment Setup and Building](../../../core/development-setup/build-environment-setup-and-building) documentation for more details.
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]).

:::danger
[Mainnet]: ../../mainnet/README.md
[Testnet]: ../../testnet/README.md

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.
### Building From Source

Make sure to use the version specified in the Network Parameters page ([Mainnet], [Testnet]).
Although highly suggested, building from source is currently beyond the scope of
this documentation.

See [Oasis Core's Build Environment Setup and Building][oasis-core-build]
documentation for more details.

:::caution

The code in the current [`master`] branch may be incompatible with the code used
by other nodes on the network. Make sure to use the version specified on the
Network Parameters page ([Mainnet], [Testnet]).

:::

## Adding `oasis-node` Binary to `PATH`
[oasis-core-build]: ../../../core/development-setup/build-environment-setup-and-building
[`master`]: https://github.com/oasisprotocol/oasis-core/tree/master/

### 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 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 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`.
To install the `oasis-node` binary for all users of the system, copy it to
`/usr/local/bin`.

## Running ParaTimes

If you intend to [run a ParaTime node](../paratime-node.mdx) you will need to additionally install the following software packages:
If you intend to [run a ParaTime node](../paratime-node.mdx) you will need to
additionally install the following software packages:

* [Bubblewrap](https://github.com/projectatomic/bubblewrap) 0.4.1+, needed for creating process sandboxes.
* [Bubblewrap](https://github.com/projectatomic/bubblewrap) 0.4.1+, needed for
creating process sandboxes.

On Ubuntu 20.04+, you can install it with:

```text
```shell
sudo apt install bubblewrap
```

On Fedora, you can install it with:

```text
```shell
sudo dnf install bubblewrap
```

146 changes: 54 additions & 92 deletions docs/node/run-your-node/validator-node.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,6 @@ use a [hardware wallet] as a secure storage, such as [Ledger].
[Start the Oasis Node](#starting-the-oasis-node). The server needs to meet
the hardware requirements and have access to the internet.

[create your entity]: #creating-your-entity
[set up the server in order to start the Oasis node]:
#running-an-oasis-node-on-the-server

3. Finally, we will [stake assets to your entity, register it on the network,
and attach the unique ID](#staking-and-registering) of the
Oasis Node instance running on your server.
Expand Down Expand Up @@ -146,53 +142,12 @@ 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

## Starting the Oasis Node

### Setting up the Oasis Node's Working Directory

Before we run the node on the `server` we need to ensure that we have a place to
store necessary files for the node.

:::info

We will reference the working directory on the `server` as `/node`
throughout the documentation.

:::

#### Setting Up the the `/node` Directory

We will reference the working directory on the `server` as `/node` (with
subdirectories `/node/{etc,bin,runtimes,data}`) throughout the documentation.
In the `/node` directory, create the following subdirectories:

* `etc/`: this is to store the configuration and `entity.json`
* `data/`: this is to store the node's data
* `bin/`: this is to store the `oasis-node` binary
* `runtimes/`: this is to store the ParaTime `.orc` bundles

You can make this directory structure by executing the following command:

```shell
mkdir -m700 -p /node/{etc,bin,runtimes,data}
```
### Copy the Public Entity File Descriptor to `server`

#### Copying the Public Entity Artifacts from `/localhostdir`
The Oasis node needs access to the public key of your entity. Copy your
`entity.json` to `/node/etc/entity.json` on the `server`.

We will also need to have the public entity artifacts from the `/localhostdir`
present on the `server`. Copy the `/localhostdir/entity/entity.json` file on
`localhost` to `/node/etc/entity.json` on the `server`.

#### Copying the Genesis File to the server

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 `/node/etc/genesis.json` on the `server`.

[Mainnet]: ../mainnet/README.md
[Testnet]: ../testnet/README.md

#### Configuring the Oasis Node
## Configuration

There are a variety of options available when running an Oasis node. The
following YAML file is a basic configuration for a validator node on the
Expand Down Expand Up @@ -294,16 +249,31 @@ consensus:
- "{{ seed_node_address }}"
```
#### Starting Oasis Node for the First Time
## Starting the Oasis Node
Execute the Oasis node and pass the config file above by invoking:
You can start the node by simply running the command:
```shell
oasis-node --config /node/etc/config.yml
```

After the node starts, it will automatically register itself to the peer-to-peer
network. The following files will be generated in your `/node/data` folder:
:::tip

The Oasis node is configured to run in the foreground by default.

We recommend that you configure and use it with a process manager like
[systemd](https://github.com/systemd/systemd) or
[Supervisor](http://supervisord.org). Check out the [System Configuration]
page for examples.

:::

### Node Keys

The Oasis node requires **node keys** in order to register itself and to
securely communicate with other nodes in the peer-to-peer network. The following
keys will automatically be generated and stored in your `/node/data` folder
as `.pem` files:

* `consensus.pem`: The node's consensus private key. **DO NOT SHARE**
* `consensus_pub.pem`: The node's consensus public key.
Expand All @@ -316,59 +286,51 @@ network. The following files will be generated in your `/node/data` folder:
* `sentry_client_tls_identity_cert.pem`: The node's TLS certificate for
communicating with sentry nodes.

#### Ensuring Proper Permissions

Only the owner of the process that runs the Oasis node should have access to the
files in the `/node/data` directory. The `oasis-node` binary ensures that
the files used by the node are as least privileged as possible so that you don't
accidentally shoot yourself in the foot while operating a node.

To ensure proper permissions are set, we suggest running the following to remove
all non-owner read/write/execute permissions:

```shell
chmod -R go-r,go-w,go-x /node
```

:::info

Just so it's clear, the following permissions are expected by the `oasis-node`
binary:

* `700` for the `/node/data` directory
* `700` for the `/node/etc` directory
* `600` for all `/node/data/*.pem` files
If the node keys do not exist, they will be automatically generated when you
launch the Oasis node. Otherwise, the existing ones will be used.

:::

:::caution

You may have noticed that some of these files were listed as **DO NOT SHARE** in
the [Initializing a Node](#initializing-a-node) section.
You may have noticed that some files above are listed as **DO NOT SHARE**.

In the future, these keys should be generated and referenced from an HSM.
However, until HSM support is implemented, these keys should be kept as secure
as possible on the `server`.
Ideally, the node keys should be stored on a separate device such as a
[hardware wallet] or a [remote signer]. However, until the support is
fully implemented, keep the keys on the `server` as secure as possible.

:::

### Starting the Oasis Node
[System Configuration]: prerequisites/system-configuration.mdx#change-to-non-root

You can start the node by running the following command:
### Ensuring Proper Permissions

```shell
oasis-node --config /node/etc/config.yml
```
Only the owner of the process that runs the Oasis node should have access to the
files in the `/node/data` directory. The `oasis-node` binary ensures that
the files used by the node are as least privileged as possible so that you don't
accidentally shoot yourself in the foot while operating a node.

:::tip
If you followed the steps described in the
[Install the Oasis Node][Oasis node binary] chapter, then the proper permissions
are already set:

The Oasis node is configured to run in the foreground by default.
* `700` for the `/node/data` directory
* `700` for the `/node/etc` directory
* `700` for the `/node/runtimes` directory
* `600` for all `/node/data/*.pem` files

We recommend you configure and use it with a process manager like [systemd](https://github.com/systemd/systemd) or [Supervisor](http://supervisord.org).
Otherwise, run the following to remove all non-owner read/write/execute
permissions:

:::
```shell
chmod -R go-r,go-w,go-x /node
```

[remote signer]: advanced/remote-signer.mdx

### Obtaining the node ID
### Obtain the Node ID

Now that the Oasis node is running, you can obtain your unique node ID which is
needed in order to associate your node with your entity in the network registry.
Expand All @@ -381,7 +343,7 @@ oasis-node control status -a unix:/node/data/internal.sock | jq .identity.node
"5MsgQwijUlpH9+0Hbyors5jwmx7tTmKMA4c9leV3prI="
```

### Check that your node is synced
### Check that your Node is Synced

Before you can become a validator, you will have to make sure that your node is
synced. To do so call this command on the server:
Expand Down Expand Up @@ -433,10 +395,10 @@ oasis account delegate 200 my_entity --no-paratime --account my_funding_account

[`oasis account delegate`]: ../../general/manage-tokens/cli/account.md#delegate

### Adding your Node ID to the Entity Descriptor
### Add your Node ID to the Entity Descriptor

Now we can register our entity on the network and associate it with the node ID
obtained in the [section above](#obtaining-the-node-id). Open the `entity.json`
obtained in the [section above](#obtain-the-node-id). Open the `entity.json`
file we initially generated and add the ID inside the `nodes` block. Your
entity descriptor file should now look like this:

Expand All @@ -461,7 +423,7 @@ oasis account entity register entity.json --account my_entity

[`oasis account entity register`]: ../../general/manage-tokens/cli/account.md#entity-register

### Checking that Your Node is Properly Registered
### Check that Your Node is Properly Registered

To ensure that your node is properly connected as a validator on the network,
invoke the following command on your `server`:
Expand Down

0 comments on commit 3a5296b

Please sign in to comment.