Deploy Your First Cluster

  • tutorial
    After signing up for a Couchbase Capella account and creating an organization, you can deploy your first cluster and begin testing out Couchbase Cloud features.

    Unresolved include directive in modules/get-started/pages/deploy-first-cluster.adoc - include::partial$invpc.adoc[]

    If you’ve selected to let Capella install Couchbase Server in Your Cloud Account, rather than in Couchbase’s Cloud Account, then you’ll need to follow a few extra steps. After creating an account, you’re ready to sign in to your account.

    Your Deployment Choice

    After signing in, you’ll be brought to a Getting Started page where you will have a choice of deployment options.

    1. For the fastest, easiest, and most affordable way to get started, choose the Couchbase’s Cloud Account option.

    2. Select your preferred region for the trial and leave the CIDR block to the default.

    3. Click Deploy Now.

    4. You will now be taken to the Getting Started with Your Free Trial page.

    Should you choose to try Capella with Your Cloud Account rather than using a fully-hosted solution with Couchbase’s Cloud Account, then you’ll need to follow additional steps later, to connect your Cloud.

    Create an Account

    After signing in, you’ll be brought to your organization’s Dashboard tab.

    Your organization’s dashboard with the "Start Trial" button
    1. Click Start Trial, the Get Started fly-out appears.

      1. Note: If you are starting a Sales Assisted or Proof-of-Concept account, and you have been provided an Activation ID, click the “Add your Activation ID” link.

      2. Add your Activation ID in the appropriate box.

    Connect a Cloud

    Couchbase Capella needs to establish a connection to your cloud provider in order to create a virtual private cloud (VPC) within your cloud provider account — in Azure this VPC is caled a Virtual Network (VNet). These VPCs are referred to as Clouds, and they are leveraged by Capella to provision and manage clusters in your cloud provider account. Review the Cloud Provider Requirements before continuing.

    Select a Cloud Provider
    1. Enter the cloud connection details.

      Service Provider

      Select your cloud provider from the drop-down list.

      Cloud Name

      Enter a name for the connected cloud.

      Available Regions

      Select a cloud provider region from the drop-down list. This is the region in your cloud provider where Couchbase Capella will set up a VPC environment. All clusters that use this connected cloud will be deployed in the selected region.

      CIDR Block

      Enter an IP range in CIDR notation. In most cases, you can accept the default CIDR block.

    2. Once you’ve configured the required fields, click Connect Cloud.

      Your cloud provider’s console will open in a new browser tab. If the console doesn’t open, make sure that your browser is configured to allow pop-up windows from Couchbase Capella and then try clicking the button again.

    3. Log into your cloud provider using an account that has sufficient privileges and capabilities for deploying Couchbase Cloud resources.

      Deploying Capella to Microsoft Azure? Make sure to complete the Azure account prerequisites HERE before continuing!
    4. Deploy the stack template.

      After logging into your cloud provider’s console, a pre-configured resource template will be displayed in the region that you specified. This template contains the necessary configuration for Couchbase Capella to be able to connect to your cloud provider and deploy a VPC under your account.

      • AWS

      • Azure

      For AWS, the resource template will be in the form of a CloudFormation template:

      AWS 'Quick create stack' template showing several pre-filled fields, a required IAM acknowledgment checkbox, and buttons at the bottom to 'Create change set' or 'Create stack'.

      For Azure, the resource template will be in the form of a Custom Deployment template:

      The Azure resource template will be in the form of a custom deployment template
    5. You must deploy the template to continue.

      • AWS

      • Azure

      In AWS, deploy the template by checking the box labeled I acknowledge that AWS CloudFormation might create IAM resources with custom names and then clicking Create stack.

      In Azure, click Review + create, then on the next screen deploy the template by clicking Create.

      Once the stack begins to deploy, return to the Couchbase Capella UI. (It’s safe to close your cloud provider console.) The connection details in the Get Started fly-out menu will indicate that Capella is waiting for your cloud provider. Once the basic stack deployment is complete, and the initial connection is established, a series of status bars will appear, each representing a different step in the VPC deployment process.

      You’ll know that the entire VPC or VNet deployment was successful once all of the steps are complete, and the Connection Status changes to Connected.

      You’ll know that the entire VPC deployment was successful once all of the steps are complete

    Name your Project and Cluster

    Each cluster must be created within a project. Projects are the logical mechanism for grouping and managing clusters within your organization.

    Name your project and cluster
    1. Enter a name for the project in the Project Name field.

    2. Enter a name for your cluster in the Cluster Name field. (Note that this isn’t the cluster’s hostname, and can be changed at any time.)

    3. Once you’ve entered names for your project and cluster, click Create Project & Cluster.

    Configure and Deploy the Cluster

    Now that you’ve connected a cloud, created a project, and given a name to your cluster, the next step is to configure and deploy the cluster.

    The Cluster Sizing screen provides pre-defined cluster templates to make getting started easy. (You can read more about configuring a custom deployment in Cluster Sizing.)

    The Cluster Sizing screen provides pre-defined cluster templates to make getting started easy.
    1. Under Cluster Sizing, select the "Quick Start 30-Day Trial" cluster template.

      The Free Trial account is limited to setting up a single cluster with 3 nodes. Other sizing templates and/or custom configurations require an activation code.

    2. Click Next.

      This brings you to the Deploy Cluster screen.

      The Deploy Cluster screen

      The Deploy Cluster screen shows a summary of the configuration details. Review the configuration to ensure that it meets your expectations. You can click the Prev button at the bottom of the page to go back and make any necessary changes.

      Further down the page, in the Select Support Plan section, you must select a Support Plan for the cluster.

      Select a Support Plan for the cluster
    3. Select “30-Day Trial”. Click Deploy.

      Couchbase Capella will proceed with automatically deploying the cluster on your connected cloud.

      Once you click Deploy, Couchbase Cloud will proceed with automatically deploying the cluster on your connected cloud

      A cluster will generally take up to 15 minutes to deploy.

    Next Steps

    Now that you’ve connected a cloud, created a project, and deployed your first cluster, you can move on to the next step: Configure Access to Your Cluster.