This folder contains a script for installing Couchbase server and its dependencies. Use this script to create a
Couchbase Amazon Machine Image (AMI) that can be
deployed in AWS across an Auto Scaling Group using the couchbase-cluster
module.
This script has been tested on the following operating systems:
Ubuntu 16.04
Amazon Linux 2
There is a good chance it will work on other flavors of Debian, CentOS, and RHEL as well.
Quick start
This module depends on bash-commons, so you must install that project
first as documented in its README.
To install Couchbase, use git to clone this repository at a specific tag (see the releases
page for all available tags) and run the
install-couchbase-server script:
The install-couchbase-server script will install Couchbase, its dependencies, and the run-couchbase-server
script.
You can execute the run-couchbase-server script when the server is booting to start Couchbase and configure it to
automatically join other nodes to form a cluster.
Run install-couchbase-server --help to see all available arguments.
Usage: install-couchbase-server [options]
This script can be used to install Couchbase Server and its dependencies. This script has been tested with Ubuntu 16.04 and Amazon Linux 2.
Options:
--edition The edition of Couchbase to install. Must be one of: enterprise, community. Default: enterprise.
--version The version of Couchbase to install. Default: 5.1.0.
--checksum The checksum of the Couchbase package. Required if --version is specified. You can get it from the downloads page of the Couchbase website.
--checksum-type The type of checksum in --checksum. Required if --version is specified. Must be one of: sha256, md5.
--swappiness The OS swappiness setting to use. Couchbase recommends setting this to 0. Default: 0.
Example:
install-couchbase-server --edition enterprise
How it works
The install-couchbase-server script does the following:
We needed an easy way to install these scripts that satisfied a number of requirements, including working on a variety
of operating systems and supported versioning. Our current solution is to use git, but this may change in the future.
See Package Managers
Questions? Ask away.
We're here to talk about our services, answer any questions, give advice, or just to chat.
{"treedata":{"name":"root","toggled":true,"children":[{"name":".circleci","children":[{"name":"config.yml","path":".circleci/config.yml","sha":"87392693fe410ce6ac2b08b5c6cb9b7ac39c88f0"},{"name":"publish-amis.sh","path":".circleci/publish-amis.sh","sha":"abb6cf0e36e53f65074d47170f147d06036f5797"}]},{"name":".gitignore","path":".gitignore","sha":"38390636ad1e30ba24026044c2b522a136d2ac05"},{"name":".pre-commit-config.yaml","path":".pre-commit-config.yaml","sha":"44db7180c9a5078b7831e82e5d1bafe12c4ec131"},{"name":".pre-commit-hooks.yaml","path":".pre-commit-hooks.yaml","sha":"92462242c5c4a3aa0f5d5f5b19a81811c71e4b49"},{"name":"CODEOWNERS","path":"CODEOWNERS","sha":"4be01a6334d39aa5bf6abe6baae701f5e2a8c5ac"},{"name":"CONTRIBUTING.md","path":"CONTRIBUTING.md","sha":"de3aa54eede67b6eddf1776e08f8441973f57fc1"},{"name":"LICENSE","path":"LICENSE","sha":"7a4a3ea2424c09fbe48d455aed1eaa94d9124835"},{"name":"NOTICE","path":"NOTICE","sha":"77030eb8f10190ffd42c28bb41922f8c91b089a1"},{"name":"README.md","path":"README.md","sha":"c0b9f5e9559314187df44dcea1970579118373d1"},{"name":"_docs","children":[{"name":"couchbase-icon.png","path":"_docs/couchbase-icon.png","sha":"8b6ac8f2921f00beb92494b378e6157a7e51a53f"},{"name":"couchbase-multi-cluster-architecture.png","path":"_docs/couchbase-multi-cluster-architecture.png","sha":"60ec0e7cca94e2400662b7ed8565833b84f142be"},{"name":"couchbase-multi-datacenter-replication-architecture.png","path":"_docs/couchbase-multi-datacenter-replication-architecture.png","sha":"d19384e42f436e9a96ae112853e679208d8cc513"},{"name":"couchbase-multi-datacenter-replication-architecture.psd","path":"_docs/couchbase-multi-datacenter-replication-architecture.psd","sha":"9750878217d877c6fed0d70c57d4e4f1ed732a4a"},{"name":"couchbase-single-cluster-architecture.png","path":"_docs/couchbase-single-cluster-architecture.png","sha":"448144c58bddc5bf46c096289344d66733bc7592"}]},{"name":"core-concepts.md","path":"core-concepts.md","sha":"b7f0a27396f54937b1e7b870499f9956fb06778c"},{"name":"examples","children":[{"name":"couchbase-ami","children":[{"name":"README.md","path":"examples/couchbase-ami/README.md","sha":"db19908786e1f925f14a63e9f74e12be68ecea41"},{"name":"couchbase.json","path":"examples/couchbase-ami/couchbase.json","sha":"eb2149a36f5109a069856a4770f3a3395e2d68c9"},{"name":"sync_gateway_community.json","path":"examples/couchbase-ami/sync_gateway_community.json","sha":"1ecd7f323b059a2712dabb040c1d1ff31ffe59a3"},{"name":"sync_gateway_enterprise.json","path":"examples/couchbase-ami/sync_gateway_enterprise.json","sha":"39821acb92842d53d772c7afc7af904f478ebced"}]},{"name":"couchbase-cluster-mds","children":[{"name":"README.md","path":"examples/couchbase-cluster-mds/README.md","sha":"ad316fdc85a5687e6310614d1d48f6fa9dcc33bc"},{"name":"local-test","children":[{"name":".env","path":"examples/couchbase-cluster-mds/local-test/.env","sha":"fb429afef6ea74aa33abe5e4319b3538a2bd7263"},{"name":"docker-compose.yml","path":"examples/couchbase-cluster-mds/local-test/docker-compose.yml","sha":"791983d4ac39cc4ff6f7f613e1d78976287f6dbf"}]},{"name":"main.tf","path":"examples/couchbase-cluster-mds/main.tf","sha":"19b8b466931352b75c0ec2c94c728487cda09a0e"},{"name":"outputs.tf","path":"examples/couchbase-cluster-mds/outputs.tf","sha":"4a60475339777bdbf95b6045d7d2e956c2dbe927"},{"name":"user-data","children":[{"name":"user-data-couchbase-data-nodes.sh","path":"examples/couchbase-cluster-mds/user-data/user-data-couchbase-data-nodes.sh","sha":"94150c1fef696dc9d19508ecf614cdffbae19778"},{"name":"user-data-couchbase-index-query-search-nodes.sh","path":"examples/couchbase-cluster-mds/user-data/user-data-couchbase-index-query-search-nodes.sh","sha":"c13d780c95601b1bfa157d65329312866a18f3ff"},{"name":"user-data-sync-gateway.sh","path":"examples/couchbase-cluster-mds/user-data/user-data-sync-gateway.sh","sha":"99aa5e77cfff2774bd0020d51ea6ba77a49a3674"}]},{"name":"variables.tf","path":"examples/couchbase-cluster-mds/variables.tf","sha":"779b652d4ae2bee64e852131b9ca85f39f0bdfd8"}]},{"name":"couchbase-cluster-simple-dns-tls","children":[{"name":"README.md","path":"examples/couchbase-cluster-simple-dns-tls/README.md","sha":"d2e537222684a472713c29292f4160f811b3ed62"},{"name":"local-test","children":[{"name":".env","path":"examples/couchbase-cluster-simple-dns-tls/local-test/.env","sha":"fb429afef6ea74aa33abe5e4319b3538a2bd7263"},{"name":"docker-compose.yml","path":"examples/couchbase-cluster-simple-dns-tls/local-test/docker-compose.yml","sha":"e8980454ea06f365ee92df93aaf6b007c20437cf"}]},{"name":"main.tf","path":"examples/couchbase-cluster-simple-dns-tls/main.tf","sha":"97951cea3f303d8e70f4344d43e5620b781d7db9"},{"name":"outputs.tf","path":"examples/couchbase-cluster-simple-dns-tls/outputs.tf","sha":"bf8c18b332125a2e0e68e210b26fa48dd6594039"},{"name":"user-data","children":[{"name":"user-data.sh","path":"examples/couchbase-cluster-simple-dns-tls/user-data/user-data.sh","sha":"a680fa225fc4f256978e297ffc374c5407858625"}]},{"name":"variables.tf","path":"examples/couchbase-cluster-simple-dns-tls/variables.tf","sha":"c4b4418dc839693bd8dbde269a82ac31ef03ce7c"}]},{"name":"couchbase-cluster-simple","children":[{"name":"README.md","path":"examples/couchbase-cluster-simple/README.md","sha":"e4126f146380b68bca8e2075b3579c32d564a2f5"},{"name":"local-test","children":[{"name":".env","path":"examples/couchbase-cluster-simple/local-test/.env","sha":"fb429afef6ea74aa33abe5e4319b3538a2bd7263"},{"name":"docker-compose.yml","path":"examples/couchbase-cluster-simple/local-test/docker-compose.yml","sha":"e8980454ea06f365ee92df93aaf6b007c20437cf"}]},{"name":"user-data","children":[{"name":"user-data.sh","path":"examples/couchbase-cluster-simple/user-data/user-data.sh","sha":"17ada71f8daf8158a817d9cffdcb94bd41bece61"}]}]},{"name":"couchbase-multi-datacenter-replication","children":[{"name":"README.md","path":"examples/couchbase-multi-datacenter-replication/README.md","sha":"e7b299a03d14f1ff713fc57363d6c9e250bbc1ed"},{"name":"local-test","children":[{"name":".env","path":"examples/couchbase-multi-datacenter-replication/local-test/.env","sha":"6112e2bcb38259397b81257ebbf422ebaccec068"},{"name":"docker-compose.yml","path":"examples/couchbase-multi-datacenter-replication/local-test/docker-compose.yml","sha":"12db84e3008f3498f58fe6bb64afcf4d69448410"}]},{"name":"main.tf","path":"examples/couchbase-multi-datacenter-replication/main.tf","sha":"ec47c50f5f04bb68af0dbba0e890b043a5044957"},{"name":"outputs.tf","path":"examples/couchbase-multi-datacenter-replication/outputs.tf","sha":"b176beecefad8213f0c8d953cb1451deb827dba8"},{"name":"user-data","children":[{"name":"user-data-primary.sh","path":"examples/couchbase-multi-datacenter-replication/user-data/user-data-primary.sh","sha":"b96c71bf427c724d367842c25133bb18fc2f0819"},{"name":"user-data-replica.sh","path":"examples/couchbase-multi-datacenter-replication/user-data/user-data-replica.sh","sha":"34d9aa87f51666fa50147dcf411ed758bed1978d"}]},{"name":"variables.tf","path":"examples/couchbase-multi-datacenter-replication/variables.tf","sha":"99c18d0b5dcda11b3999a3cae808f80944be9255"}]},{"name":"local-mocks","children":[{"name":"README.md","path":"examples/local-mocks/README.md","sha":"4c6d80b3998e1027f5c2a4c71715772b81830b31"},{"name":"aws.sh","path":"examples/local-mocks/aws.sh","sha":"20408cfe23eb7a3cf2451fbb7d8214a0b746b1cc"},{"name":"entrypoint.sh","path":"examples/local-mocks/entrypoint.sh","sha":"51c897ba4b159e58381eb23b760c84696dc9b681"},{"name":"mount-volume.sh","path":"examples/local-mocks/mount-volume.sh","sha":"c9fa0b283e7ce1a0b1652dc4565bfe2740dcc820"}]}]},{"name":"main.tf","path":"main.tf","sha":"c16c6f90bfb0d981f1c9cc913db76d8fedf708c8"},{"name":"modules","children":[{"name":"couchbase-cluster","children":[{"name":"README.md","path":"modules/couchbase-cluster/README.md","sha":"bb1edabb679a103375a61ed16fa0ad6f63991a50"},{"name":"main.tf","path":"modules/couchbase-cluster/main.tf","sha":"8e26202b322c6027ed9f80154369780a049daf40"},{"name":"outputs.tf","path":"modules/couchbase-cluster/outputs.tf","sha":"43f4b8d33b580deface276e3f49680e26daf7b7c"},{"name":"variables.tf","path":"modules/couchbase-cluster/variables.tf","sha":"188c2383e0211961663d26d98216ac3dd0a76418"}]},{"name":"couchbase-commons","children":[{"name":"README.md","path":"modules/couchbase-commons/README.md","sha":"f1367ace90480981e5dceba2c7cb84f6878a1fb8"},{"name":"couchbase-common.sh","path":"modules/couchbase-commons/couchbase-common.sh","sha":"6ef25a60dabe4182d0805d115a6fed1cba5422a0"},{"name":"couchbase-rally-point","path":"modules/couchbase-commons/couchbase-rally-point","sha":"103bc2dbc4b2a7d51b56f08eb186ce2f00b323c7"},{"name":"mount-volume.sh","path":"modules/couchbase-commons/mount-volume.sh","sha":"3767b9a3ea78e4fa1f48f29866dcef430a5fa9fe"}]},{"name":"couchbase-iam-policies","children":[{"name":"README.md","path":"modules/couchbase-iam-policies/README.md","sha":"922154296ebbb41e9343b0ead8fb469007944048"},{"name":"main.tf","path":"modules/couchbase-iam-policies/main.tf","sha":"9494a59509ef92c6b63f6133225be32eea123575"},{"name":"variables.tf","path":"modules/couchbase-iam-policies/variables.tf","sha":"26ac224bac34cf635bff250be92515b7b6f97070"}]},{"name":"couchbase-server-security-group-rules","children":[{"name":"README.md","path":"modules/couchbase-server-security-group-rules/README.md","sha":"208e46d7c9647c61941dd77b212009fab3d16fd5"},{"name":"main.tf","path":"modules/couchbase-server-security-group-rules/main.tf","sha":"420704f9d5b10568e306b58204b12bfcc2d57e46"},{"name":"outputs.tf","path":"modules/couchbase-server-security-group-rules/outputs.tf","sha":"4c5c8af8a2fb065200fdc7090a9c1b5cd226d5d6"},{"name":"variables.tf","path":"modules/couchbase-server-security-group-rules/variables.tf","sha":"1f00f38fc9e89210f0ca8bc2189d6615a9e4481b"}]},{"name":"install-couchbase-server","children":[{"name":"README.md","path":"modules/install-couchbase-server/README.md","sha":"68ca11d74a46fd45a1de30b4f0091301224a6df7","toggled":true},{"name":"disable-thp","path":"modules/install-couchbase-server/disable-thp","sha":"2ead9b6e580a16712375f207ba4261884157f88e"},{"name":"install-couchbase-server","path":"modules/install-couchbase-server/install-couchbase-server","sha":"61789cec5eaf222fbc55b7790b1a7f9176429080"}],"toggled":true},{"name":"install-sync-gateway","children":[{"name":"README.md","path":"modules/install-sync-gateway/README.md","sha":"e33f83a43b7ded3ab89c5a632bb6a2392540b209"},{"name":"install-sync-gateway","path":"modules/install-sync-gateway/install-sync-gateway","sha":"2d78163fa6a7bc1aebeb8de6d8063160e626ad18"}]},{"name":"load-balancer-target-group","children":[{"name":"README.md","path":"modules/load-balancer-target-group/README.md","sha":"b71f21e4aa7c506b9a4df23919e2e844609c6b73"},{"name":"main.tf","path":"modules/load-balancer-target-group/main.tf","sha":"0aeb54720dde3c88438a9570929a395bd04c5f13"},{"name":"outputs.tf","path":"modules/load-balancer-target-group/outputs.tf","sha":"c66bcfb9097a75d942502aa134cdc1809e108e28"},{"name":"variables.tf","path":"modules/load-balancer-target-group/variables.tf","sha":"df893f09fbe414468958fc9bd5b53283ba062bf6"}]},{"name":"load-balancer","children":[{"name":"README.md","path":"modules/load-balancer/README.md","sha":"c3e457f41ef1b3797e96bd395931b4b86d8763f7"},{"name":"main.tf","path":"modules/load-balancer/main.tf","sha":"47eb1d887e688f84afd123866cf94f9f7fe8dcb4"},{"name":"outputs.tf","path":"modules/load-balancer/outputs.tf","sha":"eac906678815f7b26d3628ab6b0cfd8dfde9f25b"},{"name":"variables.tf","path":"modules/load-balancer/variables.tf","sha":"990d99f7ef2bc15d0656b66c8640e01393f9d10b"}]},{"name":"run-couchbase-server","children":[{"name":"README.md","path":"modules/run-couchbase-server/README.md","sha":"22171cb07dcfc6a8dfb20b48cf69fb8f79175704"},{"name":"run-couchbase-server","path":"modules/run-couchbase-server/run-couchbase-server","sha":"b13e7804ea29db862025ac9a20fc222fae6444ec"}]},{"name":"run-replication","children":[{"name":"README.md","path":"modules/run-replication/README.md","sha":"70b7aa50e06d1c390b2f7921e8293c4e45de4fae"},{"name":"run-replication","path":"modules/run-replication/run-replication","sha":"419c2f1cca183fd2f1fd9a94a11ba587609edded"}]},{"name":"run-sync-gateway","children":[{"name":"README.md","path":"modules/run-sync-gateway/README.md","sha":"1a18541741641f75d8d7c4d70e37683e498845c6"},{"name":"run-sync-gateway","path":"modules/run-sync-gateway/run-sync-gateway","sha":"8f827839afe57bd36a4a6c35ef2a169fa6992054"}]},{"name":"sync-gateway-security-group-rules","children":[{"name":"README.md","path":"modules/sync-gateway-security-group-rules/README.md","sha":"f5e50b67844506d15a277e3578105dc3a1225c95"},{"name":"main.tf","path":"modules/sync-gateway-security-group-rules/main.tf","sha":"da63fba581298cd819dc205f60aa8111fda3145f"},{"name":"outputs.tf","path":"modules/sync-gateway-security-group-rules/outputs.tf","sha":"20655ee9c7729f093241ec28e31b197e7d4fbdca"},{"name":"variables.tf","path":"modules/sync-gateway-security-group-rules/variables.tf","sha":"cf39a81712ec01fc36b9f83dd7e62226b1d08a60"}]}],"toggled":true},{"name":"outputs.tf","path":"outputs.tf","sha":"4138cc3c41b0d5ebf4ce088431332550eb503e10"},{"name":"test","children":[{"name":"README.md","path":"test/README.md","sha":"36e97d94c441e302871e22126004113f3ffb84d1"},{"name":"couchbase_helpers.go","path":"test/couchbase_helpers.go","sha":"5018b0767b3f3cbf9699176973de60c1da90d32c"},{"name":"couchbase_multi_cluster_test.go","path":"test/couchbase_multi_cluster_test.go","sha":"b6e1c54d93202536c1e96af2d7ed26d81e1c0329"},{"name":"couchbase_multi_datacenter_replication_test.go","path":"test/couchbase_multi_datacenter_replication_test.go","sha":"bbd1fda849ddfd29f742202a9daba93715d9cfd9"},{"name":"couchbase_single_cluster_dns_tls_test.go","path":"test/couchbase_single_cluster_dns_tls_test.go","sha":"84f76d8719de66fda0786ede6eae23345865a476"},{"name":"couchbase_single_cluster_test.go","path":"test/couchbase_single_cluster_test.go","sha":"3465f2dd0f554df0db8f914aabf51168ca36b9e2"},{"name":"docker_compose_test.go","path":"test/docker_compose_test.go","sha":"873d9abfd29eeb1772306803676d5b3c07de4270"},{"name":"go.mod","path":"test/go.mod","sha":"887eea5726b826039bb214aff92b80343f0a9b7b"},{"name":"go.sum","path":"test/go.sum","sha":"4e935bc43226626199f4856dff620bdd46c841b6"},{"name":"terratest_helpers.go","path":"test/terratest_helpers.go","sha":"73566d7f43f3f31b87871d2f7a684a19223acb84"},{"name":"validation","children":[{"name":"validate_all_modules_and_examples_test.go","path":"test/validation/validate_all_modules_and_examples_test.go","sha":"74c928d0cbc2914e5cd708277bd857cb2375b660"}]}]},{"name":"variables.tf","path":"variables.tf","sha":"e463cef71c94336b5f14de9f3ddc1cdf7d4edaec"}]},"detailsContent":"<h1 class=\"preview__body--title\" id=\"couchbase-server-install-script\">Couchbase Server Install Script</h1><div class=\"preview__body--border\"></div><p>This folder contains a script for installing Couchbase server and its dependencies. Use this script to create a\nCouchbase <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html\" class=\"preview__body--description--blue\" target=\"_blank\">Amazon Machine Image (AMI)</a> that can be\ndeployed in <a href=\"https://aws.amazon.com/\" class=\"preview__body--description--blue\" target=\"_blank\">AWS</a> across an Auto Scaling Group using the <a href=\"/repos/v0.6.0/terraform-aws-couchbase/modules/couchbase-cluster\" class=\"preview__body--description--blue\">couchbase-cluster\nmodule</a>.</p>\n<p>This script has been tested on the following operating systems:</p>\n<ul>\n<li>Ubuntu 16.04</li>\n<li>Amazon Linux 2</li>\n</ul>\n<p>There is a good chance it will work on other flavors of Debian, CentOS, and RHEL as well.</p>\n<h2 class=\"preview__body--subtitle\" id=\"quick-start\">Quick start</h2>\n<p>This module depends on <a href=\"/repos/bash-commons\" class=\"preview__body--description--blue\">bash-commons</a>, so you must install that project\nfirst as documented in its README.</p>\n<p>To install Couchbase, use <code>git</code> to clone this repository at a specific tag (see the <a href=\"#open_modal\" class=\"preview__body--description--blue\">releases\npage</a> for all available tags) and run the\n<code>install-couchbase-server</code> script:</p>\n<pre>git clone --branch <VERSION> https://github.com/gruntwork-io/<span class=\"hljs-keyword\">terraform</span>-aws-couchbase.git\n<span class=\"hljs-keyword\">terraform</span>-aws-couchbase/modules/install-couchbase-server/install-couchbase-server\n</pre>\n<p>The <code>install-couchbase-server</code> script will install Couchbase, its dependencies, and the <a href=\"/repos/v0.6.0/terraform-aws-couchbase/modules/run-couchbase-server\" class=\"preview__body--description--blue\">run-couchbase-server\nscript</a>.\nYou can execute the <code>run-couchbase-server</code> script when the server is booting to start Couchbase and configure it to\nautomatically join other nodes to form a cluster.</p>\n<p>We recommend running the <code>install-couchbase-server</code> script as part of a <a href=\"https://www.packer.io/\" class=\"preview__body--description--blue\" target=\"_blank\">Packer</a> template to\ncreate a Couchbase <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html\" class=\"preview__body--description--blue\" target=\"_blank\">Amazon Machine Image (AMI)</a> (see the\n<a href=\"/repos/v0.6.0/terraform-aws-couchbase/examples/couchbase-ami\" class=\"preview__body--description--blue\">couchbase-ami example</a> for\nfully-working sample code). You can then deploy the AMI across an Auto Scaling Group using the <a href=\"/repos/v0.6.0/terraform-aws-couchbase/modules/couchbase-cluster\" class=\"preview__body--description--blue\">couchbase-cluster\nmodule</a> (see the\n<a href=\"/repos/v0.6.0/terraform-aws-couchbase/examples\" class=\"preview__body--description--blue\">examples folder</a> for fully-working\nsample code).</p>\n<h2 class=\"preview__body--subtitle\" id=\"command-line-arguments\">Command line Arguments</h2>\n<p>Run <code>install-couchbase-server --help</code> to see all available arguments.</p>\n<pre><span class=\"hljs-attribute\">Usage</span>: install-couchbase-server [options]\n\n<span class=\"routeros\">This<span class=\"hljs-built_in\"> script </span>can be used <span class=\"hljs-keyword\">to</span> install Couchbase<span class=\"hljs-built_in\"> Server </span><span class=\"hljs-keyword\">and</span> its dependencies. This<span class=\"hljs-built_in\"> script </span>has been tested with Ubuntu 16.04 <span class=\"hljs-keyword\">and</span> Amazon Linux 2.\n\nOptions:\n\n --edition\t\tThe edition of Couchbase <span class=\"hljs-keyword\">to</span> install. Must be one of: enterprise, community. Default: enterprise.\n --version\t\tThe version of Couchbase <span class=\"hljs-keyword\">to</span> install. Default: 5.1.0.\n --checksum\t\tThe checksum of the Couchbase package. Required <span class=\"hljs-keyword\">if</span> --version is specified. You can <span class=\"hljs-builtin-name\">get</span> it <span class=\"hljs-keyword\">from</span> the downloads<span class=\"hljs-built_in\"> page </span>of the Couchbase website.\n --checksum-type\tThe<span class=\"hljs-built_in\"> type </span>of checksum <span class=\"hljs-keyword\">in</span> --checksum. Required <span class=\"hljs-keyword\">if</span> --version is specified. Must be one of: sha256, md5.\n --swappiness\t\tThe OS swappiness setting <span class=\"hljs-keyword\">to</span> use. Couchbase recommends setting this <span class=\"hljs-keyword\">to</span> 0. Default: 0.\n\nExample:\n\n install-couchbase-server --edition enterprise\n</span></pre>\n<h2 class=\"preview__body--subtitle\" id=\"how-it-works\">How it works</h2>\n<p>The <code>install-couchbase-server</code> script does the following:</p>\n<ol>\n<li><a href=\"#install-couchbase-binaries-and-scripts\" class=\"preview__body--description--blue\">Install Couchbase binaries and scripts</a></li>\n<li><a href=\"#update-swap-settings\" class=\"preview__body--description--blue\">Update swap settings</a></li>\n<li><a href=\"#disable-transparent-huge-pages\" class=\"preview__body--description--blue\">Disable transparent huge pages</a></li>\n</ol>\n<h3 class=\"preview__body--subtitle\" id=\"install-couchbase-binaries-and-scripts\">Install Couchbase binaries and scripts</h3>\n<p>Install the following:</p>\n<ul>\n<li><code>Couchbase</code>: Install Couchbase using the appropriate <a href=\"https://developer.couchbase.com/documentation/server/5.1/install/install-linux.html\" class=\"preview__body--description--blue\" target=\"_blank\">Linux\ninstaller</a>.</li>\n<li><code>run-couchbase-server</code>: Copy the <a href=\"/repos/v0.6.0/terraform-aws-couchbase/modules/run-couchbase-server\" class=\"preview__body--description--blue\">run-couchbase-server\nscript</a> into\n<code>/opt/couchbase/bin</code>.</li>\n</ul>\n<h3 class=\"preview__body--subtitle\" id=\"update-swap-settings\">Update swap settings</h3>\n<p>Set the "swappiness" setting on your OS to 0. See <a href=\"https://developer.couchbase.com/documentation/server/current/install/install-swap-space.html\" class=\"preview__body--description--blue\" target=\"_blank\">Swap Space and Kernel\nSwappiness</a> for details.</p>\n<h2 class=\"preview__body--subtitle\" id=\"disable-transparent-huge-pages\">Disable transparent huge pages</h2>\n<p>Disable transparent huge pages on your OS. See <a href=\"https://developer.couchbase.com/documentation/server/current/install/thp-disable.html\" class=\"preview__body--description--blue\" target=\"_blank\">Disabling Transparent Huge Pages\n(THP)</a> for details.</p>\n<h2 class=\"preview__body--subtitle\" id=\"why-use-git-to-install-this-code\">Why use Git to install this code?</h2>\n<p>We needed an easy way to install these scripts that satisfied a number of requirements, including working on a variety\nof operating systems and supported versioning. Our current solution is to use <code>git</code>, but this may change in the future.\nSee <a href=\"/repos/terraform-aws-consul/_docs/package-managers.md\" class=\"preview__body--description--blue\">Package Managers</a></p>\n","repoName":"terraform-aws-couchbase","repoRef":"v0.6.1","serviceDescriptor":{"serviceName":"Couchbase","serviceRepoName":"terraform-aws-couchbase","serviceRepoOrg":"gruntwork-io","cloudProviders":["aws"],"description":"Deploy a Couchbase cluster. Supports automatic bootstrapping, Sync Gateway, Web Console UI, cross-region replication, and auto healing.","imageUrl":"couchbase.png","licenseType":"open-source","technologies":["Terraform","Bash"],"compliance":[],"tags":[""]},"serviceCategoryName":"NoSQL","fileName":"README.md","filePath":"/modules/install-couchbase-server","title":"Repo Browser: Couchbase","description":"Browse the repos in the Gruntwork Infrastructure as Code Library."}