Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Templates for Couchbase software for the Amazon AWS CloudFormation
JavaScript
tree: 6435fb8cfb

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
packs
Makefile
README.md
gen-pack
membase.erb

README.md

CloudFormation templates for Couchbase software

= Using the Membase server templates

When launching an Amazon CloudFormation stack, okease choose one of the pre-generated "N-pack" templates in the ./packs subdirectory tree.

For example, if you chose the packs/membase-1.7.0-32bit/6-pack-membase template, then you would be launching a six machine ("six pack"), auto-joined cluster of Membase Server nodes.

== Membase server template inputs

Some of the more important launch input values that you'll have to specify or will want to override when launching an N-pack of Membase servers...

  • REST password - for the Administrator user for the Membase web management console UI and REST API.

  • SSH key name - allows you to remotely ssh onto each launched server node. To get a named SSH key pair, please pre-create/register one using the AWS/EC2 web management console.

  • RAM quota per server node - maximum amount of RAM (in MB) that Membase server processes are allowed to use on a server. Be sure to leave enough extra RAM "unused" headroom for O/S requirements and to avoid swap.

  • RAM quota per server node for the default bucket. A default membase-type bucket on port 11211, with no password, will be created by the Membase CloudFormation templates with this given RAM quota amount (in MB) per server node. You can specify 0 to not have this default bucket created.

  • InstanceType - for example, "m1.small". You'll need to choose an AWS EC2 instance type that's appropriately 32-bit or 64-bit compatible, depending on what pack template that you choose. Also, your RAM quota input values should be less than the instance type's actual RAM.

For production deployments, proper sizing of your Membase cluster is very important. Please see http://couchbase.org for more technical information.

== Growing a Membase cluster

For example, you might already have launched and be running a 3-pack cluster of Membase server nodes, and it's finally time to add more capacity (more nodes) to the cluster.

To grow that cluster, you could launch another N-pack of Membase, such as an additional 2-pack. When launching the next pack, provide the HOST:REST_PORT of some public IP/network address of some node in the original pack (eg, the 3-pack) as input via the ExistingClusterHostPort parameter. For example, this might be something like "10.50.22.21:8091". The Membase server template will then auto-join its newly launched nodes (from the 2-pack) to the existing cluster, but will not auto-Rebalance the newly expanded 5-node cluster. You can use the Membase web management console UI to kick off the Rebalance operation yourself, when you're ready to do so. Or, if you change your mind, you can also easily remove the added server nodes (using the "Remove Server" feature).

If you specify an ExistingClusterHostPort, then newly launched nodes will inherit the configuration of the existing cluster, and the RAM quota input parameters will be ignored.

= More info

= License

MIT - these templates were made for you.

= TODO

  • EBS configuration
  • Alerts configuration - nice to have
  • Elastic Load Balancer - nice to have
Something went wrong with that request. Please try again.