This repository has been archived by the owner on Mar 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #53 from gruntwork-io/readme-updates
Update the README to the new format
- Loading branch information
Showing
5 changed files
with
119 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| repos: | ||
| - repo: git@github.com:gruntwork-io/module-ci.git | ||
| sha: v0.7.1 | ||
| - repo: https://github.com/gruntwork-io/pre-commit | ||
| rev: v0.0.2 | ||
| hooks: | ||
| - id: terraform-fmt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,23 @@ | ||
| [](https://gruntwork.io/?ref=repo_aws_couchbase) | ||
|  | ||
| <!-- | ||
| :type: service | ||
| :name: Couchbase | ||
| :description: Deploy a Couchbase cluster. Supports automatic bootstrapping, Sync Gateway, Web Console UI, cross-region replication, and auto healing. | ||
| :icon: /_docs/couchbase-icon.png | ||
| :category: other-data-stores | ||
| :cloud: aws | ||
| :tags: nosql | ||
| :license: open-source | ||
| :built-with: terraform, bash | ||
| --> | ||
|
|
||
| # Couchbase AWS Module | ||
|
|
||
| This repo contains a Module for deploying [Couchbase](https://www.couchbase.com/) on [AWS](https://aws.amazon.com/) | ||
| using [Terraform](https://www.terraform.io/) and [Packer](https://www.packer.io/). Couchbase is a distributed NoSQL | ||
| document database. This module supports running Couchbase as a single cluster: | ||
| [](https://gruntwork.io/?ref=repo_aws_couchbase) | ||
|  | ||
|
|
||
| This repo contains a set of modules for deploying [Couchbase](https://www.couchbase.com/) on | ||
| [AWS](https://aws.amazon.com/) using [Terraform](https://www.terraform.io/) and [Packer](https://www.packer.io/). | ||
| Couchbase is a distributed NoSQL document database. This module supports running Couchbase as a single cluster: | ||
|
|
||
|  | ||
|
|
||
|
|
@@ -15,110 +27,112 @@ Or as multiple clusters for the various Couchbase services (data, management, se | |
|
|
||
|
|
||
|
|
||
| ## Quick start | ||
|
|
||
| If you want to quickly spin up a Couchbase cluster, you can run the simple example that is in the root of this repo. | ||
| Check out [couchbase-cluster-simple example | ||
| documentation](https://github.com/gruntwork-io/terraform-aws-couchbase/blob/master/examples/couchbase-cluster-simple) | ||
| for instructions. | ||
| ## 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](https://www.gruntwork.io), and follows the same patterns as [the Gruntwork | ||
| Infrastructure as Code Library](https://gruntwork.io/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](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library/) for an overview | ||
| of how to use modules maintained by Gruntwork! | ||
|
|
||
| ## What's in this repo | ||
| ### Core concepts | ||
|
|
||
| This repo has the following folder structure: | ||
| * [Couchbase documentation](https://docs.couchbase.com/home/index.html): The core documentation for Couchbase, inculding | ||
| guides for administrators, developers, SQL developers, and mobile developers. | ||
| * [Couchbase tutorials](https://docs.couchbase.com/tutorials/index.html): hands-on guides for getting started with | ||
| Couchbase. | ||
| * [Couchbase Security](https://docs.couchbase.com/server/6.0/learn/security/security-overview.html): overview of how to | ||
| secure your Couchbase clusters. | ||
|
|
||
| * [root](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master): The root folder contains an example | ||
| of how to deploy Couchbase as a single-cluster. See | ||
| [couchbase-cluster-simple](https://github.com/gruntwork-io/terraform-aws-couchbase/blob/master/examples/couchbase-cluster-simple) | ||
| for the documentation. | ||
| * [modules](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules): This folder contains the | ||
| main implementation code for this Module, broken down into multiple standalone submodules. | ||
| * [examples](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/examples): This folder contains | ||
| examples of how to use the submodules. | ||
| * [test](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/test): Automated tests for the submodules | ||
| and examples. | ||
|
|
||
| ### Repo organization | ||
|
|
||
| Check out [How to use this repo](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/core-concepts.md#how-to-use-this-repo): | ||
| for an overview. | ||
|
|
||
| * [modules](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/modules): the main implementation code for this repo, broken down into multiple standalone, orthogonal submodules. | ||
| * [examples](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/examples): This folder contains working examples of how to use the submodules. | ||
| * [test](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/test): Automated tests for the modules and examples. | ||
| * [root](https://github.com/hashicorp/terraform-aws-couchbase/tree/master): 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](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/modules) directly. | ||
|
|
||
| ## How to use this repo | ||
|
|
||
| The general idea is to: | ||
|
|
||
| 1. Use the scripts in the | ||
| [install-couchbase-server](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/install-couchbase-server) and | ||
| [install-sync-gateway](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/install-sync-gateway) | ||
| modules to create an AMI with Couchbase and Sync Gateway installed. | ||
|
|
||
| 1. Deploy the AMI across one or more Auto Scaling Groups (ASG) using the [couchbase-cluster | ||
| module](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/couchbase-cluster). | ||
|
|
||
| 1. Configure each server in the ASGs to execute the | ||
| [run-couchbase-server](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/run-couchbase-server) and/or | ||
| [run-sync-gateway](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/run-sync-gateway) | ||
| script during boot. | ||
|
|
||
| 1. (Optional): Deploy a load balancer in front of the ASGs using the [load-balancer | ||
| module](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/load-balancer). | ||
| ## Deploy | ||
|
|
||
| See the [examples folder](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/examples) for working | ||
| sample code. | ||
| ### 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](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/examples): The `examples` folder contains sample code optimized for learning, experimenting, and testing (but not production usage). | ||
| * [quick start](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/core-concepts.md#quick-start): A quick | ||
| start guide for this repo. | ||
|
|
||
| ### Production deployment | ||
|
|
||
| ## What's a Module? | ||
| If you want to deploy this repo in production, check out the following resources: | ||
|
|
||
| A Module is a canonical, reusable, best-practices definition for how to run a single piece of infrastructure, such | ||
| as a database or server cluster. Each Module is written using a combination of [Terraform](https://www.terraform.io/) | ||
| and scripts (mostly bash) and include automated tests, documentation, and examples. It is maintained both by the open | ||
| source community and companies that provide commercial support. | ||
| * [Couchbase deployment guidelines](https://docs.couchbase.com/server/6.0/install/install-production-deployment.html): | ||
| A guide on how to configure Couchbase for production. All of these settings are exposed by the modules in the | ||
| `modules` folder. | ||
| * [Security options](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/modules/couchbase-cluster/README.md#security): | ||
| The security options you can configure using these modules. | ||
| * [Credentials](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/modules/run-couchbase-server/README.md#passing-credentials-securely): | ||
| How to pass credentials securely to your Couchbase server. | ||
| * [Memory settings](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/modules/run-couchbase-server/README.md#memory-settings): | ||
| How to configure memory settings in your Couchbase server. | ||
|
|
||
|
|
||
| Instead of figuring out the details of how to run a piece of infrastructure from scratch, you can reuse | ||
| existing code that has been proven in production. And instead of maintaining all that infrastructure code yourself, | ||
| you can leverage the work of the Module community to pick up infrastructure improvements through | ||
| a version number bump. | ||
|
|
||
|
|
||
|
|
||
| ## Who maintains this Module? | ||
|
|
||
| This Module is maintained by [Gruntwork](http://www.gruntwork.io/). If you're looking for help or commercial | ||
| support, send an email to [[email protected]](mailto:[email protected]?Subject=Couchbase%20for%20AWS%20Module). | ||
| Gruntwork can help with: | ||
|
|
||
| * Setup, customization, and support for this Module. | ||
| * Modules for other types of infrastructure, such as VPCs, Docker clusters, databases, and continuous integration. | ||
| * Modules that meet compliance requirements, such as HIPAA. | ||
| * Consulting & Training on AWS, Terraform, and DevOps. | ||
| ## Manage | ||
|
|
||
| ### Day-to-day operations | ||
|
|
||
| * [How to connect to Sync Gateway](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/modules/couchbase-cluster/README.md#connecting-to-sync-gateway) | ||
| * [How to connect to the Couchbase Web Console](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/modules/couchbase-cluster/README.md#connecting-to-the-couchbase-server-web-console) | ||
| * [How to connect to the Couchbase Server via SDK](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/modules/couchbase-cluster/README.md#connecting-to-couchbase-server-via-the-sdk) | ||
|
|
||
| ### Major changes | ||
|
|
||
| ## How do I contribute to this Module? | ||
| * [How to upgrade a Couchbase cluster](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/modules/couchbase-cluster/README.md#how-do-you-roll-out-updates) | ||
|
|
||
| Contributions are very welcome! Check out the | ||
| [Contribution Guidelines](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/CONTRIBUTING.md) for instructions. | ||
|
|
||
|
|
||
|
|
||
| ## How is this Module versioned? | ||
| ## Support | ||
|
|
||
| This Module follows the principles of [Semantic Versioning](http://semver.org/). You can find each new release, | ||
| along with the changelog, in the [Releases Page](../../releases). | ||
| If you need help with this repo or anything else related to infrastructure or DevOps, Gruntwork offers [Commercial Support](https://gruntwork.io/support/) via Slack, email, and phone/video. If you're already a Gruntwork customer, hop on Slack and ask away! If not, [subscribe now](https://www.gruntwork.io/pricing/). If you're not sure, feel free to email us at [[email protected]](mailto:[email protected]). | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## 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](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/CONTRIBUTING.md) for instructions. | ||
|
|
||
| During initial development, the major version will be 0 (e.g., `0.x.y`), which indicates the code does not yet have a | ||
| stable API. Once we hit `1.0.0`, we will make every effort to maintain a backwards compatible API and use the MAJOR, | ||
| MINOR, and PATCH versions on each release to indicate any incompatibilities. | ||
|
|
||
|
|
||
|
|
||
| ## License | ||
|
|
||
| This code is released under the Apache 2.0 License. Please see | ||
| [LICENSE](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/LICENSE) and | ||
| [NOTICE](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/NOTICE) for more details. | ||
| Please see [LICENSE](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/LICENSE) for details on how the code in this repo is licensed. | ||
|
|
||
|
|
||
| Copyright © 2018 Gruntwork, Inc. | ||
| Copyright © 2019 Gruntwork, Inc. | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Core concepts | ||
|
|
||
| ## Quick start | ||
|
|
||
| If you want to quickly spin up a Couchbase cluster, you can run the simple example that is in the root of this repo. | ||
| Check out [couchbase-cluster-simple example | ||
| documentation](https://github.com/gruntwork-io/terraform-aws-couchbase/blob/master/examples/couchbase-cluster-simple) | ||
| for instructions. | ||
|
|
||
| ## How to use this repo | ||
|
|
||
| The general idea is to: | ||
|
|
||
| 1. Use the scripts in the | ||
| [install-couchbase-server](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/install-couchbase-server) and | ||
| [install-sync-gateway](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/install-sync-gateway) | ||
| modules to create an AMI with Couchbase and Sync Gateway installed. | ||
|
|
||
| 1. Deploy the AMI across one or more Auto Scaling Groups (ASG) using the [couchbase-cluster | ||
| module](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/couchbase-cluster). | ||
|
|
||
| 1. Configure each server in the ASGs to execute the | ||
| [run-couchbase-server](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/run-couchbase-server) and/or | ||
| [run-sync-gateway](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/run-sync-gateway) | ||
| script during boot. | ||
|
|
||
| 1. (Optional): Deploy a load balancer in front of the ASGs using the [load-balancer | ||
| module](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/load-balancer). |