Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

cluster-init

    Initializes an Operational Insights cluster

    SYNOPSIS

    couchbase-cli cluster-init [--cluster <url>] [--cluster-username <username>] [--cluster-password <password>]
    [--client-cert <path>] [--client-cert-password <password>] [--client-key <path>]
    [--client-key-password <password>] [--cluster-port <port>]
    [--cluster-ramsize <mebibytes>] [--cluster-name <name>]
    [--cluster-analytics-ramsize <mebibytes>]
    [--update-notifications <1|0>]
    [--ip-family <ipv4|ipv6|ipv4-only|ipv6-only>] [--node-to-node-encryption <on|off>]

    DESCRIPTION

    Initializes the first node in an Operational Insights cluster. Before you initialize the cluster, configure its object storage with the setting-operational-insights command. If you have not configured the object storage, cluster-init fails. Memory quotas are global settings, and apply to each node added to the cluster.

    OPTIONS

    -c
    --cluster

    Specifies the hostname of the cluster to initialize. By default, this parameter is set to localhost:8091 for this command. See the HOST FORMATS section for more information about specifying a hostname.

    --cluster-username

    When starting a new cluster you need to create the Operational Insights built-in administrator user for the cluster. This user will be able to access the Operational Insights Administration Console as well as be used for data access and future configuration. This option specifies the username for the administrator user.

    --cluster-password

    When starting a new cluster you need to create the Operational Insights built-in administrator user for the cluster. This user will be able to access the Operational Insights Administration Console as well as be used for data access and future configuration. This option specifies the password for the administrator user.

    --cluster-ramsize

    Sets a memory quota (in MiB). Operational Insights fixes this quota at 100MiB, so always set it to 100.

    --cluster-analytics-ramsize

    Sets the Analytics memory quota (in MiB). This quota is assigned to all future nodes added to the cluster.

    --cluster-name

    Sets the name for this cluster. Naming clusters is useful when you have multiple Operational Insights clusters in your deployment.

    --cluster-port

    Specifies the port for the Couchbase Administration Console. Defaults to port 8091.

    --update-notifications

    Specifies whether or not software update notifications and sharing of system performance information should be enabled. To enable notifications set this flag to "1". To disable notifications set this flag to "0". By default it’s enabled and notifications will be displayed in the Couchbase web console when a new version of Operational Insights is available. This system also collects information about use and experience with the product every time an administrator interacts with the administrator user interface. It collects configuration, usage and performance data, including cluster information (such as settings and configuration, software version, cluster ID, load levels, and resource quotas), and browser and network information (such as IP address, inferred geolocation only at the city level, and browser type). This does not allow Couchbase to track your specific interactions or usage of Operational Insights. Couchbase, Inc never accesses or collects any data stored within Operational Insights. This feature can be disabled at any time by using 'couchbase-cli-setting-notification.' For more information about this feature, please see the “Couchbase Server Privacy FAQ” in the product documentation, which supplements the Couchbase Privacy Policy available online. This feature is only available in Couchbase Enterprise Edition.

    --ip-family

    Specifies what IP family the cluster should used. The default option is 'ipv4'. When 'ipv4-only' or 'ipv6-only' is used the cluster will only listen on that address.

    --node-to-node-encryption

    Specifies if node to node encryption should be used. The default option is 'off'. When set to 'on' all communications between nodes will be over a encrypted connection.

    HOST FORMATS

    When specifying a host for the couchbase-cli command the following formats are expected:

    • couchbase://<addr> or couchbases://<addr>

    • http://<addr>:<port> or https://<addr>:<port>

    • <addr>:<port>

    It is recommended to use the couchbase://<addr> or couchbases://<addr> format for standard installations. The other formats allow an option to take a port number which is needed for non-default installations where the admin port has been set up on a port other that 8091 (or 18091 for https).

    CERTIFICATE AUTHENTICATION (MTLS AUTHENTICATION)

    This tool supports authenticating against a Couchbase Cluster by using certificate based authentication (mTLS authentication). To use certificate based authentication a certificate/key must be supplied, there a currently multiple ways this may be done.

    PEM ENCODED CERTIFICATE/KEY

    An unencrypted PEM encoded certificate/key may be supplied by using: - --client-cert <path> - --client-key <path>

    The file passed to --client-cert must contain the client certificate, and an optional chain required to authenticate the client certificate.

    The file passed to --client-key must contain at most one private key, the key can be in one of the following formats: - PKCS#1 - PKCS#8

    Currently, only the following key types are supported: - RSA - DSA

    PEM ENCODED CERTIFICATE/PEM OR DER ENCRYPTED PKCS#8 KEY

    An encrypted PKCS#8 formatted key may be provided using: - --client-cert <path> - --client-key <path> - --client-key-password <password>

    The file passed to --client-cert must contain the client certificate, and an optional chain required to authenticate the client certificate.

    Currently, only the following key types are supported: - RSA - DSA

    ENCRYPTED PKCS#12 CERTIFICATE/KEY

    An encrypted PKCS#12 certificate/key may be provided using: - --client-cert <path> - --client-cert-password <password>

    The file passed to --client-cert must contain the client certificate and exactly one private key. It may also contain the chain required to authenticate the client certificate.

    Currently, only the following key types are supported: - RSA - DSA

    EXAMPLES

    To initialize an Operational Insights cluster with an Analytics memory quota of 4096MiB, run the following command.

    $ couchbase-cli cluster-init -c 127.0.0.1 --cluster-username Administrator \
 --cluster-password password --cluster-ramsize 100 \
 --cluster-analytics-ramsize 4096

    To set the port number, use the --cluster-port option. The following example sets up a cluster on port 5000.

    $ couchbase-cli cluster-init -c 127.0.0.1 --cluster-username Administrator \
 --cluster-password password --cluster-ramsize 100 \
 --cluster-analytics-ramsize 4096 --cluster-port 5000

    DISCUSSION

    The cluster-init subcommand sets up the first node of an Operational Insights cluster. To set per-node settings such as the data storage directories or the hostname, see the node-init command. To add nodes to an initialized cluster, use the server-add command. Some cluster settings can be changed after a cluster is initialized. Use the setting-cluster command to edit these settings.

    ENVIRONMENT AND CONFIGURATION VARIABLES

    CB_REST_USERNAME

    Specifies the username to use when executing the command. This environment variable allows you to specify a default argument for the -u/--username argument on the command line.

    CB_REST_PASSWORD

    Specifies the password of the user executing the command. This environment variable allows you to specify a default argument for the -p/--password argument on the command line. It also allows the user to ensure that their password are not cached in their command line history.

    CB_CLIENT_CERT

    The path to a client certificate used to authenticate when connecting to a cluster. May be supplied with CB_CLIENT_KEY as an alternative to the CB_USERNAME and CB_PASSWORD variables. See the CERTIFICATE AUTHENTICATION section for more information.

    CB_CLIENT_CERT_PASSWORD

    The password for the certificate provided to the CB_CLIENT_CERT variable, when using this variable, the certificate/key pair is expected to be in the PKCS#12 format. See the CERTIFICATE AUTHENTICATION section for more information.

    CB_CLIENT_KEY

    The path to the client private key whose public key is contained in the certificate provided to the CB_CLIENT_CERT variable. May be supplied with CB_CLIENT_CERT as an alternative to the CB_USERNAME and CB_PASSWORD variables. See the CERTIFICATE AUTHENTICATION section for more information.

    CB_CLIENT_KEY_PASSWORD

    The password for the key provided to the CB_CLIENT_KEY variable, when using this variable, the key is expected to be in the PKCS#8 format. See the CERTIFICATE AUTHENTICATION section for more information.

    SEE ALSO

    cluster-edit, setting-operational-insights, node-init, server-add

    COUCHBASE-CLI

    Part of the couchbase-cli suite