:warning: As of February, 2022, we are putting this repo on hold and will not be investing in further improvements to it. :warning:

This is because:

• Maintaining the code for a complicated, distributed, stateful system like Couchbase is very time consuming.
• We’ve had very little customer usage / interest in a self-managed Couchbase offering, so it does not make sense to continue to make a large investment in it.

Therefore, for the time being, if you need to use Couchbase, we strongly recommend using one of the following alternatives:

• Couchbase in AWS marketplace
• Couchbase Capella

If you have questions or concerns, please contact us at support@gruntwork.io.

Couchbase AWS Module

This repo contains a set of modules for deploying Couchbase on AWS using Terraform and Packer. Couchbase is a distributed NoSQL document database. This module supports running Couchbase as a single cluster:

Or as multiple clusters for the various Couchbase services (data, management, search, index, query) and Sync Gateway:

Features

• Deploy Couchbase and Sync Gateway.
• Automatic bootstrapping.
• Cross-region replication
• Multi-dimensional scaling, allowing you to separately scale data, management, search, index, query, and Sync

Gateway nodes.

• Auto healing.
• Web console UI.

Learn

This repo is maintained by Gruntwork, and follows the same patterns as the Gruntwork Infrastructure as Code Library, a collection of reusable, battle-tested, production ready infrastructure code. You can read How to use the Gruntwork Infrastructure as Code Library for an overview of how to use modules maintained by Gruntwork!

Core concepts

• Couchbase documentation: The core documentation for Couchbase, inculding

guides for administrators, developers, SQL developers, and mobile developers.

• Couchbase tutorials: hands-on guides for getting started with

Couchbase.

• Couchbase Security: overview of how to

secure your Couchbase clusters.

Repo organization

Check out How to use this repo: for an overview.

• modules: the main implementation code for this repo, broken down into multiple standalone, orthogonal submodules.
• examples: This folder contains working examples of how to use the submodules.
• test: Automated tests for the modules and examples.

root: The root folder is an example* of how to use the submodules to deploy a Couchbase cluster. The Terraform Registry requires the root of every repo to contain Terraform code, so we've put one of the examples there. This example is great for learning and experimenting, but for production use, please use the underlying modules in the modules folder directly.

Deploy

Non-production deployment (quick start for learning)

If you just want to try this repo out for experimenting and learning, check out the following resources:

• examples folder: The examples folder contains sample code optimized for learning, experimenting, and testing (but not production usage).
• quick start: A quick

start guide for this repo.

Production deployment

If you want to deploy this repo in production, check out the following resources:

• Couchbase deployment guidelines:

A guide on how to configure Couchbase for production. All of these settings are exposed by the modules in the modules folder.

• Security options:

The security options you can configure using these modules.

• Credentials:

How to pass credentials securely to your Couchbase server.

• Memory settings:

How to configure memory settings in your Couchbase server.

Manage

Day-to-day operations

• How to connect to Sync Gateway
• How to connect to the Couchbase Web Console
• How to connect to the Couchbase Server via SDK

Major changes

• How to upgrade a Couchbase cluster

Support

If you need help with this repo or anything else related to infrastructure or DevOps, Gruntwork offers Commercial Support via Slack, email, and phone/video. If you're already a Gruntwork customer, hop on Slack and ask away! If not, subscribe now. If you're not sure, feel free to email us at support@gruntwork.io.

Contributions

Contributions to this repo are very welcome and appreciated! If you find a bug or want to add a new feature or even contribute an entirely new module, we are very happy to accept pull requests, provide feedback, and run your changes through our automated test suite.

Please see CONTRIBUTING.md for instructions.

License

Please see LICENSE for details on how the code in this repo is licensed.

Copyright © 2019 Gruntwork, Inc.