You are viewing the documentation for a prerelease version.

View Latest

enable-developer-preview

Enable developer preview mode in target cluster

SYNOPSIS

couchbase-cli enable-developer-preview [--cluster <url>] [--username <user>]
    [--password <password>] [--enable] [--list]

DESCRIPTION

This command enables developer preview in the target cluster. Once enabled it can not be disabled and the cluster will not be able to upgrade. Do not use developer preview mode in production clusters. This command will prompt for user confirmation.

OPTIONS

-c
--cluster

Specifies the hostname of a node in the cluster. See the HOST FORMATS section for more information on specifying a hostname.

-u
--user <username>

Specifies the username of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error.

-p
--password <password>

Specifies the password of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error. If this argument is specified, but no password is given then the command will prompt the user for a password through non-echoed stdin. You may also specify your password by using the environment variable CB_REST_PASSWORD.

--enable

Will set the cluster into developer preview mode after user confirmation that they want to set the cluster in developer preview mode.

--list

Specifies if the cluster is in developer preview mode.

HOST FORMATS

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

  • couchbase://<addr>

  • <addr>:<port>

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

It is recommended to use the couchbase://<addr> format for standard installations. The other two 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.

EXAMPLES

To enable developer preview mode on:

$ couchbase-cli enable-developer-preview -c 192.168.1.5:8091 -u Administrator \
 -p password --enable
$ Developer preview cannot be disabled once it is enabled. If you enter
  developer preview mode you will not be able to upgrade.
  DO NOT USE IN PRODUCTION.
  Are you sure [y/n]: y
  SUCCESS: Cluster is in developer preview mode

To check cluster mode:

$ couchbase-cli enable-developer-preview -c localhost:9000 -u Administrator \
  -p password --list
$ Cluster is in developer preview mode

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.

COUCHBASE-CLI

Part of the couchbase-cli suite