Node Bootstrapping Reference - Ocient Documentation

Bootstrap a Node

Connect to the Node

To bootstrap an Ocient® node, connect to the node with your server username and password and the IP address of your node.For example, connect as administrator admin to the IP Address 10.10.10.10.

Shell

ssh admin@10.10.10.10

Configure the Bootstrap Configuration File

Use your preferred text editor with sudo to create the /var/opt/ocient/bootstrap.conf file as root.For a list of bootstrapping options, see Supported Options.Option 1: Bootstrap the initial node in a systemUse these bootstrap.conf settings to create the initial node in a system./var/opt/ocient/bootstrap.conf example

YAML

initialSystem: true

Option 2: Bootstrap a new node on a system with an initial nodeUse these bootstrap.conf settings to create another node in a system, replacing the IP Address 10.10.10.10 with the IP address or hostname of the initial node./var/opt/ocient/bootstrap.conf example (recommended)

YAML

adminHost: 10.10.10.10
nodeToken: <token_from_GET_NODE_TOKEN>

Generate the token value by executing the GET NODE TOKEN SQL statement on an existing node.

You can also use adminUserName and adminPassword instead of nodeToken, but this approach is deprecated. Use node tokens for improved security.

Start the Node

Start the database.

Shell

sudo systemctl start rolehostd

Verify that the node and the service are active by running this status command.

Shell

systemctl status rolehostd

rolehostd.service - Rolehostd daemon startup
     Loaded: loaded (/etc/systemd/system/rolehostd.service; enabled; vendor preset: enabled)
     Active: active (running) since Wed 2022-01-26 23:31:36 UTC; 7s ago
     ...

You have bootstrapped the node.

Supported Options

You can edit the /var/opt/ocient/bootstrap.conf file to include a number of other options for advanced system configurations. The Ocient bootstrap.conf file can also include these optional parameters. For examples of these options, see the Example bootstrap.conf file.

Option	Description
`name`	The default name of the node in the database is the hostname. If that name is not appropriate, you can assign a different name.
`nodeAddress`	The default address of this node is the hostname of the node, or the IP address if the `useDns` setting is `false`. If the system has multiple interfaces or you want an alternative setup, then you can specify the node address. This address is the address that all the other nodes in the cluster use to contact this node.
`externalAddress`	It might be desirable to have the SQL Nodes listen on a different external address than the system uses internally. The `externalAddress` parameter can either be a single address or a list of addresses. Example of single address: `externalAddress: 10.10.10.1` Example of a list of addresses: `externalAddress: ["10.10.10.1","20.20.20.2"]` ℹ️This option applies to REST endpoints only. For REST endpoints, see System Information REST Endpoints.
`nodeToken`	A single-use token for authenticating the node to the cluster during bootstrap. Generate this value with `GET NODE TOKEN` on any existing node. When you set this parameter, the system authenticates the joining node without requiring administrator credentials. After a successful bootstrap, the system overwrites the token value in `bootstrap.conf` with `REDACTED` and then renames the file to `bootstrap.completed`, so the plaintext secret never persists on disk. If the redaction fails, the system deletes `bootstrap.conf` outright instead of preserving it. The rewrite performs a YAML round-trip, so the system does not preserve any comments from the original file. For details, see GET NODE TOKEN.
`adminUserName`	Deprecated. The default user, specified as `admin@system`, when you create an Ocient System. If a different administrator user should be used to add this node to an existing system, use this option to indicate the user. Use `nodeToken` instead when possible.
`adminPassword`	Deprecated. If the administrator password is not the default, then use this option to specify the password. Use `nodeToken` instead when possible.
`logLevel`	The logging level for the system. Defaults to DEBUG.
`connectivityPools`	The configuration of SQL Nodes in a connectivity pool. You can use this configuration to configure the connectivity pool for the first SQL Node in a cluster. Other nodes cannot use this option. If there are no entries in the `bootstrap.conf` file, then the Ocient System adds the SQL Node to a new connectivity pool with a default name. Example of the connectivity pool named `test_pool` configuration: connectivityPools: test_pool: sourceAddress: 1.2.3.4/12 sourcePort: 1 # optional priority: 1 listenAddress: 111.1.1.1 listenPort: 4050 advertisedAddress: localhost advertisedPort: 4050 # optional
`systemStorageSpace`	The configuration for storage space has width and parity width for the Ocient System. If you do not configure the storage space, the system sets the width to 3 and parity to 2, the default values. For details about width and parity width, see Core Elements of an Ocient System. To set these options using SQL syntax, see CREATE STORAGESPACE.
`useOpal`	When you set this value to `false`, this option prevents the `rolehostd` service from taking ownership of and enabling Opal locking on all NVMe drives that support it. Bootstrap with this setting using an external Key Management System (KMS).
`pageReplication`	The number of page replicas the system writes before a page is available, unless you enable degraded loading. The fault tolerance is `(pageReplication - 1)`. The calculation for the default value is `min(width, parityWidth+1)`. For the system storage space, the default value is 3.

Example bootstrap.conf File

This example shows a bootstrap.conf file that you can use as a template.

YAML

## initialSystem: true           # Uncomment for the first node in a
                                # multi-cluster system.
                                # Defaults to false. Cannot be
                                # true if initialSingleClusterSystem
                                # is also true.

## initialSingleClusterSystem: true  # Uncomment for the first node in a
                                # single-cluster system.
                                # Defaults to false. Cannot be
                                # true if initialSystem is also true.

## systemName: productionSystem  # The name of the Ocient System. This
                                # configuration applies only when the
                                # initialSystem or initialSingleClusterSystem
                                # configuration is set to true.

## adminHost: sql.example.com    # Hostname or IP address of an administrator
                                # node, generally the first node. Not
                                # required for the initial node, but required
                                # for all other nodes.

## name: elmo                    # The name of this node.
                                # Defaults to hostname.

## nodeAddress: sql1.example.com # The Hostname or IP address of this node.
                                # Defaults to hostname, and if that does not
                                # work, the bootstrapping process uses the IP
                                # address of the system.

## externalAddress: ["10.10.10.1", "20.20.20.2"]

## useDns: false                 # Use DNS to determine the hostname of this
                                # node. Defaults to true. When you set this
                                # configuration to false, the bootstrapping
                                # process uses the IP address of the system.

## nodeToken: <token>            # A single-use bootstrap token generated
                                # by GET NODE TOKEN. Preferred over
                                # adminUserName/adminPassword.

## adminUserName: bert@system    # Deprecated. A system administrator username.
                                # Defaults to "admin@system".
## adminPassword: ernie          # Deprecated. The password for the
                                # administrator user. Defaults to "admin".

## logLevel: info                # Log level for the system.
                                # Defaults to debug.

## connectivityPools:            # Define connectivity pool named test_pool.
##    test_pool:
##      sourceAddress: 1.2.3.4/12 # The source IP address, which is
                                 # the IP address in CIDR notation of
                                 # the client that connects to the SQL Node.

## 	   sourcePort: 1             # The optional source port number, which is the
                                 # port number of the client. This parameter
                                 # defaults to none, which means any port number.
#	   priority: 1               # The priority of the connection. A higher number
                                 # indicates a higher priority.
#	   listenAddress: 111.1.1.1  # The IP address for listening.
#	   listenPort: 4050             # The port number for listening.
#	   advertisedAddress: localhost # The IP address to return to the client.
#	   advertisedPort: 4050      # The optional port number to return to the client.
                                 # If you specify NULL for this parameter, then the
                                 # database uses the value of the listen_port parameter.

## systemStorageSpace:            # Define the system storage space.
##    width: 3                    # The width is the total number of segments to use in
                                 # each segment group.
##    parityWidth: 2              # The parity width is the number of parity coding bits
                                 # to use for each segment group, or the fault tolerance.
##    pageReplication: min(width, parityWidth+1)   # Override default page replication.

Checking System Configuration Before Bootstrapping Configure the Operating System Cluster and Node Management GET NODE TOKEN REVOKE NODE TOKEN

​Bootstrap a Node

​Supported Options

​Example bootstrap.conf File

​Related Links

Bootstrap a Node

Supported Options

Example bootstrap.conf File

Related Links