A newer version of this documentation is available.

View Latest

Deploying Couchbase from AWS Marketplace

Prerequisites

  • You must have an Amazon Web Services (AWS) account. If not, create one here before proceeding. For information on how to do so, see the AWS documentation for Creating an AWS Account.

The command line examples that begin with $ are run in a standard Linux shell.

Deploying Couchbase Enterprise

The CloudFormation templates are provided for testing purposes only and should not be used in production. They are not officially supported by Couchbase.
  1. Log in to your account on the Amazon Web Services Marketplace, search for Couchbase and select Couchbase Enterprise Edition. Alternately, you can click here to go to the Couchbase Enterprise Edition product page directly.

  2. The Couchbase Enterprise product page provides a quick overview of the product offering and useful links. Click Continue to Subscribe.

    aws marketplace couchbase ee
  3. On the Subscribe screen, accept the terms and conditions for this software.

    aws marketplace couchbase terms conditions
  4. Once your request is processed, you’ll be able to proceed by clicking Continue to Configuration.

    aws marketplace couchbase ee subscription public terms
  5. Configure the software by selecting the how you wish to deploy the software, and providing information required to configure the deployment. Then click Continue to Launch.

    aws marketplace couchbase ee configure 5
  6. Review your configuration and then choose Launch CloudFormation to launch your configuration through the AWS CloudFormation console.

    These templates are provided for testing purposes only and should not be used in production. They are not officially supported by Couchbase.
    aws marketplace couchbase ee launch action
  7. You will be redirected to the AWS CloudFormation Console where you must create a stack. A stack is a group of related resources that you manage as a single unit. Select the Amazon S3 template URL and then click Next.

    aws marketplace couchbase ee create stack select template
  8. Enter the stack name and parameter values. You can choose to use the default values defined in the AWS CloudFormation template or edit them. Then click Next.

    The user name and password will be required to log in to the Couchbase Server Web Console later.
    aws marketplace couchbase ee create stack parameters
  9. Optionally, you can specify tags for resources in your stack and the required permissions. Click Next.

    aws marketplace couchbase ee create stack options
  10. Acknowledge that AWS CloudFormation may create IAM resources that provide entities access to make changes to your AWS account and click Create.

    aws marketplace couchbase ee create stack review options ack
  11. The stack creation takes a short while to complete and the status is displayed on the screen. After the process is completed, you should see a CREATE_COMPLETE status.

    aws marketplace couchbase ee create stack complete

Logging in to Your Couchbase Cluster

After the deployment is completed, you can explore the resources created from the AWS EC2 dashboard.

aws console ec2 dashboard

Click Running Instances under Resources to view the running instances of Couchbase Server and Sync Gateway. You can select a particular instance to view details such as the instance ID, state, IPv4 Public IP, and so on.

aws console ec2 instances
  1. This step describes how to log in to the Couchbase Server Web Console.

    1. From the AWS EC2 console, select a running Couchbase Server Instance and copy the IPv4 Public IP.

      aws console ec2 couchbase server instance public ip
    2. Open a browser tab and enter the copied IPv4 Public IP along with port 8091 as <ipv4-public-ip>:8091 to open the Couchbase Server Web Console.

    3. Enter the Administrator user name and password you configured when creating the stack to sign in.

      aws couchbase ee login
    4. Once you log in successfully, you can see the status of your Couchbase Server cluster on the dashboard.

      aws couchbase web console dashboard

      Click the Servers tab to explore the sever nodes that have been created.

      aws couchbase web console servers
  2. This step describes how to log in to the Sync Gateway Admin portal.

    1. From the AWS EC2 console, select a running Couchbase Sync Gateway instance and copy the IPv4 Public IP.

      aws console ec2 sync gateway instance public ip
    2. Open a browser tab and enter the copied IPv4 Public IP along with port 4984 as <ipv4-public-ip>:4984. This opens the interface for Couchbase Sync Gateway which is already setup and configured to connect to an empty bucket on the cluster.

      aws couchbase sync gateway connection
    3. Open another browser tab and enter <ipv4-public-ip>:4984/_admin/ to open the Couchbase Sync Gateway Admin Portal.

      aws couchbase sync gateway admin portal

Scaling Your Couchbase Cluster

This section describes how to scale up your cluster in three simple steps.

  1. Log in to the AWS EC2 Console and select Instances in the left navigation to list all the available instances. Select the Couchbase Server instance you wish to scale up.

    aws ec2 network interfaces couchbase server instance
  2. On left navigation, select Auto Scaling Groups.

    aws ec2 couchbase server auto scaling options
  3. Edit the selected Auto Scaling Group and then Save. In the following screen captures, you’ll see that the number of server instances has been updated from 4 to 8.

    aws ec2 couchbase server auto scaling group edit
    aws ec2 couchbase server auto scaling group save
    aws ec2 couchbase server auto scaling group updated
  4. On a different browser tab, you can log in to the Couchbase Server Web Console to see the additional server nodes that were added to your cluster.

    aws couchbase web console servers after scaling