New in v1.1: This page explains the cockroach init command, which you use to perform a one-time initialization of a new multi-node cluster. For a full walk-through of the cluster startup and initialization process, see one of the Manual Deployment tutorials.

Note:
When starting a single-node cluster, you don't need to use the cockroach init command. You can simply run the cockroach start command without the --join flag to start and initialize the single-node cluster.

Synopsis

# Perform a one-time initialization of a cluster:
$ cockroach init <flags>

# View help:
$ cockroach init --help

Flags

The cockroach init command supports the following client connection and logging flags.

Client Connection

Flag Description
--host The server host to connect to. This can be the address of any node in the cluster.

Env Variable: COCKROACH_HOST
Default:localhost
--port
-p
The server port to connect to.

Env Variable: COCKROACH_PORT
Default: 26257
--user
-u
The SQL user that will own the client session.

Env Variable: COCKROACH_USER
Default: root
--insecure Use an insecure connection.

Env Variable: COCKROACH_INSECURE
Default: false
--certs-dir The path to the certificate directory containing the CA and client certificates and client key.

Env Variable: COCKROACH_CERTS_DIR
Default: ${HOME}/.cockroach-certs/

See Client Connection Parameters for details.

Logging

By default, the init command logs errors to stderr.

If you need to troubleshoot this command's behavior, you can change its logging behavior.

Examples

These examples assume that nodes have already been started with cockroach start but are waiting to be initialized as a new cluster. For a more detailed walk-through, see one of the Manual Deployment tutorials.

Initialize a Cluster on a Node's Machine

  1. SSH to the machine where the node has been started.

  2. Make sure the client.root.crt and client.root.key files for the root user are on the machine.

  3. Run the cockroach init command with the --certs-dir flag set to the directory containing the ca.crt file and the files for the root user, and with the --host flag set to the address of the current node:

    $ cockroach init --certs-dir=certs --host=<address of this node>
    

    At this point, all the nodes complete startup and print helpful details to the standard output, such as the CockroachDB version, the URL for the admin UI, and the SQL URL for clients.

  1. SSH to the machine where the node has been started.

  2. Run the cockroach init command with the --host flag set to the address of the current node:

    $ cockroach init --insecure --host=<address of this node>
    

    At this point, all the nodes complete startup and print helpful details to the standard output, such as the CockroachDB version, the URL for the admin UI, and the SQL URL for clients.

Initialize a Cluster from Another Machine

  1. Install the cockroach binary on a machine separate from the node.

  2. Create a certs directory and copy the CA certificate and the client certificate and key for the root user into the directory.

  3. Run the cockroach init command with the --certs-dir flag set to the directory containing the ca.crt file and the files for the root user, and with the --host flag set to the address of any node:

    $ cockroach init --certs-dir=certs --host=<address of any node>
    

    At this point, all the nodes complete startup and print helpful details to the standard output, such as the CockroachDB version, the URL for the admin UI, and the SQL URL for clients.

  1. Install the cockroach binary on a machine separate from the node.

  2. Run the cockroach init command with the --host flag set to the address of any node:

    $ cockroach init --insecure --host=<address of any node>
    

    At this point, all the nodes complete startup and print helpful details to the standard output, such as the CockroachDB version, the URL for the admin UI, and the SQL URL for clients.

See Also



Yes No