Skip to content

Commit

Permalink
[Updated] Deploy Couchbase One-Click Cluster through the Linode Marke…
Browse files Browse the repository at this point in the history
…tplace (#7086)

* [Updated] Couchbase One-Click guide cluster limits

* fixed URL error

* re-fix URL error
  • Loading branch information
jddocs authored Aug 22, 2024
1 parent bb100bf commit eaa7532
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 12 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 35 additions & 12 deletions docs/marketplace-docs/guides/couchbase-cluster/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Deploy Couchbase Enterprise Server One-Click Cluster on Akamai Con
keywords: ['database','nosql','high availability','data','cluster']
tags: ["marketplace", "linode platform", "cloud manager"]
published: 2024-06-10
updated: 2024-08-13
external_resources:
- '[Couchbase](https://www.couchbase.com/)'
aliases: ['/products/tools/marketplace/guides/couchbase-cluster/']
Expand All @@ -12,56 +13,78 @@ contributors: ["Akamai"]
license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)'
---

[Couchbase](https://www.couchbase.com/) is an enterprise class NoSQL database designed with memory-first architecture, built-in cache and workload isolation. The Couchbase One-Click cluster deploys five connected Couchbase Enterprise Server nodes, split between data, index and query services. This starting configuration allows quick deployment and rapid cluster expansion with Couchbase's multi-dimensional scaling.
[Couchbase](https://www.couchbase.com/) is an enterprise class NoSQL database designed with memory-first architecture, built-in cache and workload isolation. The Couchbase One-Click cluster deploys three, five, or seven connected Couchbase Enterprise Server nodes split between Data, Index, and Query services. This initial configuration allows quick deployment and cluster expansion with Couchbase's multi-dimensional scaling.

{{< note title="Couchbase Enterprise Server License" >}}
Couchbase Enterprise Server is not free to use in production. Contact [Couchbase Support](https://www.couchbase.com/pricing/) to activate your license on Akamai Connected Cloud and enable [Couchbase application support](https://support.couchbase.com/hc/en-us/articles/360043247551-Accessing-Couchbase-Support).
{{< /note >}}

![Couchbase Enterprise Server Cluster Architecture](couchbase_ref_arch_white.png)

## Deploying a Marketplace App

{{% content "deploy-marketplace-apps-shortguide" %}}

{{% content "marketplace-verify-standard-shortguide" %}}

{{< note >}}
**Estimated deployment time:** Couchbase should be fully installed within 10-20 minutes after the Linode has finished provisioning.
{{< note title="Estimated deployment time" >}}
Couchbase should be fully installed within 10-20 minutes after the Linode has finished provisioning.
{{< /note >}}

## Configuration Options

- **Supported distributions:** Ubuntu 22.04 LTS
- **Minimum plan:** Couchbase Enterprise Server requires 8GB of RAM.
- **Suggested Plan:** 16GB of RAM is suggested for production deployments.
- **Minimum plan:** Couchbase Enterprise Server requires 8GB of RAM
- **Suggested Plan:** 16GB of RAM is suggested for production deployments

{{< note type="warning" title="Minimum RAM Requirements" >}}
**Minimum RAM Requirements:** Deploying the Couchbase Enterprise Server One-Click Cluster on a plan with less than 8GB of RAM will fail. Use caution, your account will be billed for any failed instances deployed with less than 8GB of RAM.
Deploying the Couchbase Enterprise Server One-Click Cluster on a plan with less than 8GB of RAM will fail. Your account will be billed for any failed instances deployed with less than 8GB of RAM.
{{< /note >}}

### Couchbase Options

{{% content "marketplace-special-character-limitations-shortguide" %}}

- **API Token** *(required)*: A valid API token with grants to deploy Linodes.

- **Email address** *(required)*: Enter the email address to use for generating the SSL certificates.
- **Email address** *(required)*: The email address to use for generating the SSL certificates.

- **Couchbase Server Count** *(required)*: The number of Couchbase Enterprise Servers deployed. Choose between 3, 5, or 7 instances.

{{% content "marketplace-required-limited-user-fields-shortguide" %}}

{{% content "marketplace-special-character-limitations-shortguide" %}}
### Self Signed SSl Options

- **Country or Region:** The country or region for you or your organization

- **State or Province:** The state or province for you or your organization

### Getting Started after Deployment
- **Locality:** The town or other locality for you or your organization

## Accessing the Couchbase Server
- **Organization:** The name of your organization

Access Couchbase's web UI by launching your preferred web browser and navigating to either the reverse DNS address of the *cluster provisioner*. This is the instance labeled `couchbase-occ-1-$region-$uuid`. If you need assistance in finding your instance's IP addresses and rDNS information, refer to the [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/) guide for detailed instructions.
## Getting Started after Deployment

Provide the username Administrator and generated password included in `/home/$sudo_username/.credentials` to access the Dashboard.
### Accessing the Couchbase Server

Access Couchbase's web UI by launching your preferred web browser and navigating to either the reverse DNS address of the *cluster provisioner*. This is the instance labeled `couchbase-occ-1-$region-$uuid`. Refer to the [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/) guide for instructions on how to find your instance's IP addresses and rDNS information.

To access the Dashboard, use the username "Administrator" along with the generated password located in `/home/$sudo_username/.credentials`.

![Couchbase Dashboard](couchbase_dashboard.png)

While there are no buckets yet configured on this new cluster, you can see all five nodes marked ready on the bottom status bar, and verify the status of the cluster members from the Servers tab.

![Couchbase Servers Status](couchbase_servers.png)

### Managing Firewall and Security

The Couchbase 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 Couchbase Enterprise Server Cluster Marketplace App manages these UFW configurations with `application profile` files in the `/etc/ufw/appplications.d` directory. See [Configure a Firewall with UFW](/docs/guides/configure-firewall-with-ufw/) for more details on using UFW.

## Next Steps

Now that your Couchbase Enterprise Server One-Click Cluster has been deployed, contact [Couchbase Support](https://www.couchbase.com/pricing/) to activate your license on this newly deployed cluster before using the cluster for testing, quality assurance, or in production. An active Enterprise License is required for any use other than solely for internal development use or evaluation of the software.
Expand Down

0 comments on commit eaa7532

Please sign in to comment.