Couchbase (cluster)

Deploy Couchbase, an enterprise-class NoSQL database built with a memory-first architecture, built-in caching, and workload isolation. The Couchbase cluster deploys three, five, or seven connected Enterprise Server nodes split between Data, Index, and Query services, allowing quick deployment and cluster expansion through Couchbase's multi-dimensional scaling.

📘

Couchbase Enterprise Server license

Couchbase Enterprise Server is not free to use in production. Contact Couchbase Support to activate your license on Akamai Cloud and enable Couchbase application support.

1. Deploy Couchbase cluster

 Estimated deployment time: 10–20 minutes

Base distribution and plan

• Supported distribution: Ubuntu 24.04 LTS
• Minimum plan: Couchbase Enterprise Server requires 8GB of RAM.
• Suggested plan: Use 16GB of RAM for production deployments.

🚧

Minimum RAM requirements

Deploying the Couchbase Enterprise Server cluster on a plan with less than 8GB of RAM fails. Your account is billed for any failed instances deployed with less than 8GB of RAM.

Configuration options

StackScript ID: 1366191

Note: After the app deployment completes, the password for your limited sudo user is generated and stored in the .credentials file in the home directory, along with application-specific passwords. Log in to your instance as root through the Lish console or SSH, then run cat /home/$USERNAME/.credentials to view its contents.

Use API, CLI, or Terraform

curl --location 'https://api.linode.com/v4/linode/instances' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer abc123def456hij789klm' \
    --data-raw '{
        "region": "us-east",
        "type": "g6-standard-8",
        "image": "linode/ubuntu24.04",
        "label": "my-couchbase-cluster-one-click-app",
        "root_pass": "@C0mpl3x#P@ssw0rd",
        "stackscript_id": 1366191,
        "stackscript_data": {
            "token_password": "abc123def456hij789klm",
            "sudo_username": "jsmith",
            "email_address": "jsmith@example.com",
            "country_name": "US",
            "state_or_province_name": "Massachusetts",
            "locality_name": "Cambridge",
            "organization_name": "Akamai Technologies"
        }
    }'

linode-cli linodes create \
    --region us-east \
    --type g6-standard-8 \
    --label my-couchbase-cluster-one-click-app \
    --image linode/ubuntu24.04 \
    --root_pass @C0mpl3x#P@ssw0rd \
    --stackscript_id 1366191 \
    --stackscript_data '{"token_password":"abc123def456hij789klm", "sudo_username":"jsmith", "email_address":"jsmith@example.com", "country_name":"US", "state_or_province_name":"Massachusetts", "locality_name":"Cambridge", "organization_name":"Akamai Technologies"}'

resource "linode_instance" "my-linode" {
    region         = "us-east"
    type           = "g6-standard-8"
    label          = "my-couchbase-cluster-one-click-app"
    image          = "linode/ubuntu24.04"
    root_pass      = "@C0mpl3x#P@ssw0rd"
    stackscript_id = 1366191
    stackscript_data = {
        "token_password"         = "abc123def456hij789klm"
        "sudo_username"          = "jsmith"
        "email_address"          = "jsmith@example.com"
        "country_name"           = "US"
        "state_or_province_name" = "Massachusetts"
        "locality_name"          = "Cambridge"
        "organization_name"      = "Akamai Technologies"
    }
}

2. Access the Couchbase server

1. Open your web browser and navigate to the rDNS address of the cluster provisioner. This is the instance labeled couchbase-occ-1-[region]-[uuid].

   See Manage IP addresses on a Linode for details on viewing your instance’s IP addresses and rDNS.

2. Sign in to the dashboard using the username Administrator and the generated password located in /home/$sudo_username/.credentials.

3. Once logged in, you can view the status of all cluster nodes from the Servers tab and start configuring buckets.

Manage firewall and security

The cluster deploys with preconfigured UFW firewall rules. These rules limit allowed traffic on node-to-node and cluster-to-cluster Couchbase ports to IP addresses within the cluster.

Only the cluster provisioner has firewall access configured for web and client ports.

The cluster manages these UFW configurations with application profile files in the /etc/ufw/applications.d directory. See Configure a Firewall with UFW for details on using UFW.

Activate your license

Contact Couchbase Support to activate your license on the newly deployed cluster before using it for testing, quality assurance, or in production. An active enterprise license is required for any use other than internal development or software evaluation.

Additional resources

For more information about the installed packages, see their official documentation.

• Couchbase Documentation