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.

General Settings

      +
      General settings allow configuration of cluster name, blob storage, memory quotas, storage modes, and node availability for the cluster.

      Examples on This Page

      Full and Cluster Administrators can configure general settings by means of Enterprise Analytics Web Console, the CLI, or the REST API.

      Configure General Settings with the UI

      The General screen provides access to various cluster configuration options organized into several panels. Each panel contains specific settings that can be modified to customize your Enterprise Analytics deployment.

      The panels and their UI elements are described in the following sections.

      Cluster Name

      The Cluster Name is the name that was given during initial setup. This name can be changed at any time using the interactive text field in this section.

      Blob Storage Settings

      The Blob Storage Settings panel displays the object storage configuration that was established during cluster initialization. Some settings can be modified here after initialization.

      The following fields are read-only and cannot be changed after cluster initialization:

      • Storage Scheme — The configured storage provider, shown as one of: AWS S3, S3-Compatible Storage, or Azure Blob Storage.

      • Bucket Name (or Container Name for Azure Blob Storage) — The name of the bucket or container used by Enterprise Analytics for persistent storage.

      • Bucket Region — The AWS region of the bucket. Displayed only when the storage scheme is AWS S3.

      • Bucket Path Prefix (or Container Path Prefix for Azure Blob Storage) — The path prefix within the bucket or container where Enterprise Analytics stores its data.

      The editable fields in this panel depend on the configured storage scheme, as described in the following sections:

      • AWS S3

      • S3-Compatible Storage

      • Azure Blob Storage

      Authentication — Specifies how Enterprise Analytics authenticates with AWS S3. Select one of the following options:

      • Standard Credential Chain — Uses the default AWS provider chain to obtain credentials automatically. This includes instance profiles, environment variables, and other standard AWS credential sources.

      • Static Credentials — Allows you to supply credentials directly. When selected, the following fields appear:

        • Access Key ID — The AWS access key ID.

        • Secret Access Key — The AWS secret access key. If a key is already configured, the field displays the placeholder Enter new value to change. Leave the field empty to retain the existing key.

      • Anonymous — Accesses the bucket without credentials. Use this only for publicly accessible buckets.

      • Storage Endpoint — The URL of the S3-compatible storage endpoint. For example: https://my-object-storage:18082. This field is editable.

      • Use Path Style Addressing — When checked, requests use path-style URLs of the form https://s3.example.com/bucket-name/key, instead of virtual-hosted-style URLs of the form https://bucket-name.s3.example.com/key. Enable this for storage services that do not support virtual-hosted-style addressing.

      • Disable SSL Verification — When checked, disables certificate verification for SSL/TLS connections to the storage endpoint. Displayed only when the endpoint URL uses HTTPS.

        Disabling SSL verification is not recommended for production environments. It exposes the connection to Man-in-the-Middle (MITM) attacks.

      • Storage Endpoint Certificate(s) — One or more PEM-encoded certificates to trust when connecting to the storage endpoint. Provide multiple certificates to support certificate rotation. Displayed only when the endpoint uses HTTPS and Disable SSL Verification is unchecked.

      • Blob Storage Endpoint — The URL of the Azure Blob Storage account endpoint. For example: https://mycompany.blob.core.windows.net/). You can edit this field.

      • Disable SSL Verification — When checked, disables certificate verification for SSL/TLS connections to the Azure endpoint. Displayed only when the endpoint URL uses HTTPS.

        Disabling SSL verification is not recommended for production environments. It exposes the connection to Man-in-the-Middle (MITM) attacks.

      Current Version

      This panel displays the current version of Enterprise Analytics and provides an option to manage update notifications.

      The Current Version panel shows the installed version number and includes a checkbox labeled Share usage information with Couchbase and get software update notifications. This checkbox is checked by default, meaning that Enterprise Analytics Web Console will display adjacent notifications whenever a new version of Enterprise Analytics is available. If the checkbox is unchecked, notifications are not provided.

      Additionally, if the checkbox is checked, Enterprise Analytics Web Console communicates with Enterprise Analytics to ascertain the following information, which is then transmitted to Couchbase:

      • The server-version of the current installation.

      • Information about data-size and performance.

      • The cluster-configuration, including which services are deployed.

      Data is transmitted to Couchbase from the browser accessing the Enterprise Analytics Web Console, not from the cluster itself. The update-notification process works anonymously: data cannot be tracked. No identifiable information is transmitted.

      Node Availability

      The options in the Node Availability panel control whether and how Automatic Failover is applied. For detailed information about policy and constraints, see Automatic Failover.

      The Node Availability panel provides several checkboxes and input fields to configure auto-failover behavior.

      The following checkboxes are provided:

      • Auto-failover after x seconds for up to y node: After the timeout period set here as x seconds has elapsed, an unresponsive or malfunctioning node is failed over, provided that the limit on actionable events set here as y (with the default value of 1) has not yet been reached. Data replicas are promoted to active on other nodes, as appropriate. This feature can only be used when three or more nodes are present in the cluster. The number of seconds to elapse is configurable: the default is 120; the minimum permitted is 5; the maximum 3600. This option is selected by default.

      • Auto-failover for sustained data disk read/write failures after z seconds: After the timeout period set here as z seconds has elapsed, a node is failed over if it has experienced sustained data disk read/write failures. The timeout period is configurable: the default length is 120 seconds; the minimum permitted is 5; the maximum 3600. This checkbox can only be checked if Auto-failover after x seconds for up to y node has also been checked. This option is unchecked by default.

      • Preserve durable writes: If this checkbox is checked, a node is not failed over if this might result in the loss of durably written data. The default is that the checkbox is unchecked. For information, see server:learn:data/durability.adoc#preserving-durable-writes[Preserving Durable Writes].

      The Node Availability panel also contains a For Ephemeral Buckets option. When opened, this provides an Enable auto-reprovisioning checkbox, with a configurable number of nodes. Checking this ensures that if a node containing active Ephemeral buckets becomes unavailable, its replicas on the specified number of other nodes are promoted to active status as appropriate, to avoid data-loss. Note, however, that this may leave the cluster in an unbalanced state, requiring a rebalance.

      Auto-Failover and Durability

      Enterprise Analytics provides durability, which ensures the greatest likelihood of data-writes surviving unexpected anomalies, such as node-outages. The auto-failover maximum should be established to support guarantees of durability. See Durability, for information.

      Rebalance Settings

      Rebalance redistributes data, indexes, event processing, and query processing among available nodes. For an overview, see Rebalance.

      The Rebalance Settings panel provides options to configure rebalance behavior.

      The Retry rebalance option allows rebalance to be retried, in cases where it has failed. Check the checkbox, to enable. The specifiable, maximum number of retries must be in the range of 1 to 3, inclusive. The specifiable, maximum number of seconds must be in the range of 5 to 3600, inclusive.

      Note that this option should not be enabled if the cluster is managed by Couchbase Autonomous Operator, or if custom scripts are already being used to trigger rebalance.

      Note also that no administrative tasks should be attempted when rebalance-retries are pending.

      However, pending rebalance-retries can be cancelled: see Automated Rebalance-Failure Handling, for information.

      Saving Settings

      To save any changes made in the panels, click on the Save button, located at the lower left of the screen.

      Alternatively, to discard recently entered values and revert to the previous settings, click on Cancel/Reset.

      Configure General Settings with the CLI

      To configure name and memory, index storage, and auto-failover via CLI, use the appropriate CLI command; as described below. Note that no CLI support is provided for configuring query settings. As an alternative, see Configure General Settings with the REST API, below. Additionally, For information about URL access lists via the SQL++ CURL() function, see CURL Function.

      Name and Memory Settings via CLI

      Name and memory settings are established with the setting-cluster command.

      /opt/enterprise-analytics/bin/couchbase-cli
--cluster 10.143.192.101:8091 \
--username Administrator \
--password password \
--cluster-ramsize 256 \
--cluster-name 10.143.192.101 \

      This establishes the cluster-name as 10.143.192.101, the memory allocation for Data Services each as 256 megabytes, and the memory allocation for each other service as zero.

      If successful, the call produces the following output:

      SUCCESS: Cluster settings modified

      Note that settings for an individual server may be retrieved with the server-info command, the output for which can be filtered, as appropriate, by grep:

      /opt/enterprise-analytics/bin/couchbase-cli
-c 10.143.192.101 -u Administrator -p password | grep data

      This returns the setting for data in the cluster:

      "path": "/data",
"dataStatus": "unknown",
"dataStatus": "encrypted",
"dataStatus": "unencrypted",
"/opt/enterprise-analytics/var/lib/couchbase/data"
"path": "/opt/enterprise-analytics/var/lib/couchbase/data"

      If successful, the call produces the following output:

      SUCCESS: Indexer settings modified

      Software-Update Settings via CLI

      You can enable and disable software update notifications in Enterprise Analytics Enterprise Edition using the setting-notification command.

      /opt/enterprise-analytics/bin/couchbase-cli
-c 10.143.192.101 -u Administrator -p password \
--enable-notifications 1

      Setting value of 1 for --enable-notifications enables update-notifications. A value of 0 disables notifications. If successful, the command produces the following output:

      SUCCESS: Notification settings updated
      You cannot disable software update notifications in Enterprise Analytics Community Edition.

      Auto-Failover Settings via CLI

      Auto-failover can be configured with the setting-autofailover command.

      /opt/enterprise-analytics/bin/couchbase-cli
-c 10.143.192.101:8091 \
-u Administrator \
-p password \
--enable-auto-failover 1 \
--auto-failover-timeout 120 \
--max-failovers 2

      This enables auto-failover, with a timeout of 120 seconds, and an event-maximum of 2.

      If successful, the command returns the following output:

      SUCCESS: Auto-failover settings modified

      For a detailed description of auto-failover settings, policy, and constraints, see Automatic Failover.

      Rebalance Settings via CLI

      To obtain the cluster’s current rebalance settings by means of the CLI, use the setting-rebalance command, with the --get option:

      /opt/enterprise-analytics/bin/couchbase-cli
-c 10.143.192.101 \
-u Administrator \
-p password \
--get

      If successful, the command returns the current rebalance settings:

      Automatic rebalance retry disabled
Retry wait time: 300
Maximum number of retries: 2

      To modify the current rebalance settings, use the --set option; and specify appropriate values for the --max-attempts and --wait-for flags:

      /opt/enterprise-analytics/bin/couchbase-cli
-c 10.143.192.101 \
-u Administrator \
-p password \
--set \
--max-attempts 3 \
--wait-for 200

      If successful, the command displays the following success message:

      SUCCESS: Automatic rebalance retry settings updated

      For more information, see the reference page Configure Rebalance Retries.

      Configure General Settings with the REST API

      Multiple REST API methods are provided to support configuration of general settings. These are described below.

      Name and Memory Settings via REST

      To establish name and memory settings, use the /pools/default method.

      curl -v -X POST -u Administrator:password \
http://10.143.192.101:8091/pools/default \
-d clusterName=10.143.192.101 \
-d cbasMemoryQuota=1024 \

      This establishes the cluster’s IP address as its name, and assigns memory-quotas for each node.

      Note that when used with GET, /pools/default returns configuration-settings. The output can be filtered, by means of a tool such as jq:

      curl -s -u Administrator:password \
http://10.143.192.101:8091/pools/default | jq '.cbasMemoryQuota'

      If successful, this returns the value of the key cbasMemoryQuota:

      256

      Update Notification and Statistics Settings via REST

      In Enterprise Analytics Enterprise Edition, you can use the /setting/stats endpoint to turn off notifications about new server versions and reporting of cluster statistics back to Couchbase:

      curl -v -X POST -u Administrator:password \
http://10.143.192.101:8091/settings/stats \
-d sendStats=false

      You cannot change this setting in Enterprise Analytics Community Edition. The sendStats setting is always true in this edition.

      See the update-notifications option in the cluster-init command line interface reference for details of what sendStats shares.

      Node Availability Settings via REST

      To establish node availability settings, use the /settings/autoFailover method.

      curl -v -X POST -u Administrator:password \
http://10.143.192.101:8091/settings/autoFailover \
-d enabled=true \
-d timeout=120 \
-d failoverOnDataDiskIssues[enabled]=false \
-d failoverOnDataDiskIssues[timePeriod]=120 \
-d maxCount=2 \
-d failoverPreserveDurabilityMajority=true

      This enables auto-failover, with a timeout of 120 seconds, and a maximum failover-count of 2. Auto-failover is enabled in the event of suboptimal disk responsiveness, with a time-period of 120 seconds specified. Auto-failover is prohibited in cases where this might result in the loss of durably written data.

      For more information about these options, see the descriptions provided above, for the UI.

      Additionally, the /settings/autoReprovision method can be used; to specify that if a node containing active Ephemeral buckets becomes unavailable, its replicas on the specified number of other nodes are promoted to active status as appropriate, to avoid data-loss.

      curl -v -X POST -u Administrator:password \
http://10.143.192.101:8091/settings/autoReprovision \
-d enabled=true \
-d maxNodes=1

      This enables auto-reprovisioning, specifying 1 as the maximum number of nodes.

      Rebalance Settings via REST

      By means of the REST API, both rebalance retries and maximum concurrent moves per node can be configured.

      Rebalance Retries via REST

      To obtain the cluster’s current settings for rebalance retries by means of the REST API, use the GET /settings/retryRebalance HTTP method and URI, as follows:

      curl -X GET -u Administrator:password \
http://10.143.192.101:8091/settings/retryRebalance

      If successful, the command returns the following object:

      {"enabled":true,"afterTimePeriod":200,"maxAttempts":3}

      This output shows that rebalance retry is enabled, with 200 seconds required to elapse before a retry is attempted, and a maximum of 3 retries possible.

      To change the rebalance settings, use the POST method with the same URI, specifying appropriate values:

      curl -X POST -u Administrator:password \
http://10.143.192.101:8091/settings/retryRebalance \
-d enabled=false \
-d afterTimePeriod=100 \
-d maxAttempts=2

      If successful, the command returns the following object:

      {"enabled":false,"afterTimePeriod":100,"maxAttempts":2}

      This verifies that rebalance retry is disabled, the required period between retries changed to 100 seconds, and the maximum number of retries changed to 2.

      For more information about getting and setting the rebalance retry status, see the following: