You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 29, 2023. It is now read-only.
*[modules](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules): This folder contains the
37
-
main implementation code for this Module, broken down into multiple standalone submodules.
38
-
*[examples](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/examples): This folder contains
39
-
examples of how to use the submodules.
40
-
*[test](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/test): Automated tests for the submodules
41
-
and examples.
42
61
62
+
### Repo organization
43
63
64
+
Check out [How to use this repo](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/core-concepts.md#how-to-use-this-repo):
65
+
for an overview.
44
66
67
+
*[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.
68
+
*[examples](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/examples): This folder contains working examples of how to use the submodules.
69
+
*[test](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/test): Automated tests for the modules and examples.
70
+
*[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.
45
71
46
-
## How to use this repo
47
72
48
-
The general idea is to:
49
73
50
-
1. Use the scripts in the
51
-
[install-couchbase-server](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/install-couchbase-server) and
See the [examples folder](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/examples) for working
67
-
sample code.
77
+
### Non-production deployment (quick start for learning)
68
78
79
+
If you just want to try this repo out for experimenting and learning, check out the following resources:
69
80
81
+
*[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).
82
+
*[quick start](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/core-concepts.md#quick-start): A quick
83
+
start guide for this repo.
70
84
85
+
### Production deployment
71
86
72
-
## What's a Module?
87
+
If you want to deploy this repo in production, check out the following resources:
73
88
74
-
A Module is a canonical, reusable, best-practices definition for how to run a single piece of infrastructure, such
75
-
as a database or server cluster. Each Module is written using a combination of [Terraform](https://www.terraform.io/)
76
-
and scripts (mostly bash) and include automated tests, documentation, and examples. It is maintained both by the open
77
-
source community and companies that provide commercial support.
* Setup, customization, and support for this Module.
93
-
* Modules for other types of infrastructure, such as VPCs, Docker clusters, databases, and continuous integration.
94
-
* Modules that meet compliance requirements, such as HIPAA.
95
-
* Consulting & Training on AWS, Terraform, and DevOps.
102
+
## Manage
96
103
104
+
### Day-to-day operations
97
105
106
+
*[How to connect to Sync Gateway](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/modules/couchbase-cluster/README.md#connecting-to-sync-gateway)
107
+
*[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)
108
+
*[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)
98
109
110
+
### Major changes
99
111
100
-
## How do I contribute to this Module?
112
+
*[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)
101
113
102
-
Contributions are very welcome! Check out the
103
-
[Contribution Guidelines](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/CONTRIBUTING.md) for instructions.
104
114
105
115
106
116
107
-
## How is this Module versioned?
117
+
## Support
108
118
109
-
This Module follows the principles of [Semantic Versioning](http://semver.org/). You can find each new release,
110
-
along with the changelog, in the [Releases Page](../../releases).
119
+
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]).
120
+
121
+
122
+
123
+
124
+
## Contributions
125
+
126
+
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.
127
+
128
+
Please see [CONTRIBUTING.md](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/CONTRIBUTING.md) for instructions.
111
129
112
-
During initial development, the major version will be 0 (e.g., `0.x.y`), which indicates the code does not yet have a
113
-
stable API. Once we hit `1.0.0`, we will make every effort to maintain a backwards compatible API and use the MAJOR,
114
-
MINOR, and PATCH versions on each release to indicate any incompatibilities.
115
130
116
131
117
132
118
133
## License
119
134
120
-
This code is released under the Apache 2.0 License. Please see
121
-
[LICENSE](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/LICENSE) and
122
-
[NOTICE](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/NOTICE) for more details.
135
+
Please see [LICENSE](https://github.com/hashicorp/terraform-aws-couchbase/tree/master/LICENSE) for details on how the code in this repo is licensed.
0 commit comments