Permalink
Browse files

Allow RAMForDefaultBucket to be 0 to not create a default bucket

  • Loading branch information...
1 parent 1cf9679 commit 6435fb8cfb332c83034f42f0f41b2c03804b6ae8 @steveyen steveyen committed Jul 18, 2011
View
@@ -1,24 +1,22 @@
CloudFormation templates for Couchbase software
-= Usage
+= Using the Membase server templates
-When launching an Amazon CloudFormation stack, choose one of the
-pre-generated "N-pack" templates in the ./packs subdirectory tree.
+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, auto-joined
-cluster of Membase Server nodes.
+template, then you would be launching a six machine ("six pack"),
+auto-joined cluster of Membase Server nodes.
-== Template inputs
-
-Many of the input parameters for the templates have default values.
-
-=== Membase server template inputs
+== Membase server template inputs
Some of the more important launch input values that you'll have to
-supply or will want to override when launching a Membase N-pack...
+specify or will want to override when launching an N-pack of Membase
+servers...
-* REST password - for the Administrator user and REST API.
+* 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
@@ -29,33 +27,44 @@ supply or will want to override when launching a Membase N-pack...
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 bucket
- on port 11211, with no password, will be automatically created by
- the Membase CloudFormation templates with this given RAM quota (in
- MB) per server node. You can delete this bucket later if you want.
+* 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.
-= Growing a cluster
+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 a 2-pack. When launching the next pack, provide the HOST:PORT of
-some public IP/network address of 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 (in 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.
+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
@@ -64,10 +73,10 @@ you're ready to do so.
= License
-MIT - this was made for you.
+MIT - these templates were made for you.
= TODO
-* EBS configuration - highest priority
+* EBS configuration
* Alerts configuration - nice to have
* Elastic Load Balancer - nice to have
View
@@ -28,7 +28,7 @@
"MinValue" : "200"
},
"RAMForDefaultBucket" : {
- "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer",
+ "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer. Set to 0 for no default bucket.",
"Type" : "Number",
"Default" : "500",
"MinValue" : "0"
@@ -124,13 +124,15 @@
" --cluster-init-username=Administrator",
" --cluster-init-password=", { "Ref" : "RESTPassword" },
" --cluster-init-ramsize=", { "Ref" : "RAMPerServer" },"\n",
- " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
- " -u Administrator -p ", { "Ref" : "RESTPassword" },
- " --bucket=default",
- " --bucket-type=membase",
- " --bucket-password=",
- " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
- " --bucket-replica=1","\n",
+ " if [ \"0\" != \"", { "Ref" : "RAMForDefaultBucket" }, "\" ]; then","\n",
+ " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
+ " -u Administrator -p ", { "Ref" : "RESTPassword" },
+ " --bucket=default",
+ " --bucket-type=membase",
+ " --bucket-password=",
+ " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
+ " --bucket-replica=1","\n",
+ " fi","\n",
<% else %>
" /opt/membase/bin/membase server-add",
" -u Administrator -p ", { "Ref" : "RESTPassword" },
@@ -28,7 +28,7 @@
"MinValue" : "200"
},
"RAMForDefaultBucket" : {
- "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer",
+ "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer. Set to 0 for no default bucket.",
"Type" : "Number",
"Default" : "500",
"MinValue" : "0"
@@ -116,13 +116,15 @@
" --cluster-init-username=Administrator",
" --cluster-init-password=", { "Ref" : "RESTPassword" },
" --cluster-init-ramsize=", { "Ref" : "RAMPerServer" },"\n",
- " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
- " -u Administrator -p ", { "Ref" : "RESTPassword" },
- " --bucket=default",
- " --bucket-type=membase",
- " --bucket-password=",
- " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
- " --bucket-replica=1","\n",
+ " if [ \"0\" != \"", { "Ref" : "RAMForDefaultBucket" }, "\" ]; then","\n",
+ " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
+ " -u Administrator -p ", { "Ref" : "RESTPassword" },
+ " --bucket=default",
+ " --bucket-type=membase",
+ " --bucket-password=",
+ " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
+ " --bucket-replica=1","\n",
+ " fi","\n",
"fi","\n"
@@ -28,7 +28,7 @@
"MinValue" : "200"
},
"RAMForDefaultBucket" : {
- "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer",
+ "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer. Set to 0 for no default bucket.",
"Type" : "Number",
"Default" : "500",
"MinValue" : "0"
@@ -116,13 +116,15 @@
" --cluster-init-username=Administrator",
" --cluster-init-password=", { "Ref" : "RESTPassword" },
" --cluster-init-ramsize=", { "Ref" : "RAMPerServer" },"\n",
- " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
- " -u Administrator -p ", { "Ref" : "RESTPassword" },
- " --bucket=default",
- " --bucket-type=membase",
- " --bucket-password=",
- " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
- " --bucket-replica=1","\n",
+ " if [ \"0\" != \"", { "Ref" : "RAMForDefaultBucket" }, "\" ]; then","\n",
+ " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
+ " -u Administrator -p ", { "Ref" : "RESTPassword" },
+ " --bucket=default",
+ " --bucket-type=membase",
+ " --bucket-password=",
+ " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
+ " --bucket-replica=1","\n",
+ " fi","\n",
"fi","\n"
@@ -28,7 +28,7 @@
"MinValue" : "200"
},
"RAMForDefaultBucket" : {
- "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer",
+ "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer. Set to 0 for no default bucket.",
"Type" : "Number",
"Default" : "500",
"MinValue" : "0"
@@ -116,13 +116,15 @@
" --cluster-init-username=Administrator",
" --cluster-init-password=", { "Ref" : "RESTPassword" },
" --cluster-init-ramsize=", { "Ref" : "RAMPerServer" },"\n",
- " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
- " -u Administrator -p ", { "Ref" : "RESTPassword" },
- " --bucket=default",
- " --bucket-type=membase",
- " --bucket-password=",
- " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
- " --bucket-replica=1","\n",
+ " if [ \"0\" != \"", { "Ref" : "RAMForDefaultBucket" }, "\" ]; then","\n",
+ " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
+ " -u Administrator -p ", { "Ref" : "RESTPassword" },
+ " --bucket=default",
+ " --bucket-type=membase",
+ " --bucket-password=",
+ " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
+ " --bucket-replica=1","\n",
+ " fi","\n",
"fi","\n"
@@ -28,7 +28,7 @@
"MinValue" : "200"
},
"RAMForDefaultBucket" : {
- "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer",
+ "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer. Set to 0 for no default bucket.",
"Type" : "Number",
"Default" : "500",
"MinValue" : "0"
@@ -116,13 +116,15 @@
" --cluster-init-username=Administrator",
" --cluster-init-password=", { "Ref" : "RESTPassword" },
" --cluster-init-ramsize=", { "Ref" : "RAMPerServer" },"\n",
- " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
- " -u Administrator -p ", { "Ref" : "RESTPassword" },
- " --bucket=default",
- " --bucket-type=membase",
- " --bucket-password=",
- " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
- " --bucket-replica=1","\n",
+ " if [ \"0\" != \"", { "Ref" : "RAMForDefaultBucket" }, "\" ]; then","\n",
+ " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
+ " -u Administrator -p ", { "Ref" : "RESTPassword" },
+ " --bucket=default",
+ " --bucket-type=membase",
+ " --bucket-password=",
+ " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
+ " --bucket-replica=1","\n",
+ " fi","\n",
"fi","\n"
@@ -28,7 +28,7 @@
"MinValue" : "200"
},
"RAMForDefaultBucket" : {
- "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer",
+ "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer. Set to 0 for no default bucket.",
"Type" : "Number",
"Default" : "500",
"MinValue" : "0"
@@ -116,13 +116,15 @@
" --cluster-init-username=Administrator",
" --cluster-init-password=", { "Ref" : "RESTPassword" },
" --cluster-init-ramsize=", { "Ref" : "RAMPerServer" },"\n",
- " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
- " -u Administrator -p ", { "Ref" : "RESTPassword" },
- " --bucket=default",
- " --bucket-type=membase",
- " --bucket-password=",
- " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
- " --bucket-replica=1","\n",
+ " if [ \"0\" != \"", { "Ref" : "RAMForDefaultBucket" }, "\" ]; then","\n",
+ " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
+ " -u Administrator -p ", { "Ref" : "RESTPassword" },
+ " --bucket=default",
+ " --bucket-type=membase",
+ " --bucket-password=",
+ " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
+ " --bucket-replica=1","\n",
+ " fi","\n",
"fi","\n"
@@ -28,7 +28,7 @@
"MinValue" : "200"
},
"RAMForDefaultBucket" : {
- "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer",
+ "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer. Set to 0 for no default bucket.",
"Type" : "Number",
"Default" : "500",
"MinValue" : "0"
@@ -116,13 +116,15 @@
" --cluster-init-username=Administrator",
" --cluster-init-password=", { "Ref" : "RESTPassword" },
" --cluster-init-ramsize=", { "Ref" : "RAMPerServer" },"\n",
- " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
- " -u Administrator -p ", { "Ref" : "RESTPassword" },
- " --bucket=default",
- " --bucket-type=membase",
- " --bucket-password=",
- " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
- " --bucket-replica=1","\n",
+ " if [ \"0\" != \"", { "Ref" : "RAMForDefaultBucket" }, "\" ]; then","\n",
+ " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
+ " -u Administrator -p ", { "Ref" : "RESTPassword" },
+ " --bucket=default",
+ " --bucket-type=membase",
+ " --bucket-password=",
+ " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
+ " --bucket-replica=1","\n",
+ " fi","\n",
"fi","\n"
@@ -28,7 +28,7 @@
"MinValue" : "200"
},
"RAMForDefaultBucket" : {
- "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer",
+ "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer. Set to 0 for no default bucket.",
"Type" : "Number",
"Default" : "500",
"MinValue" : "0"
@@ -116,13 +116,15 @@
" --cluster-init-username=Administrator",
" --cluster-init-password=", { "Ref" : "RESTPassword" },
" --cluster-init-ramsize=", { "Ref" : "RAMPerServer" },"\n",
- " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
- " -u Administrator -p ", { "Ref" : "RESTPassword" },
- " --bucket=default",
- " --bucket-type=membase",
- " --bucket-password=",
- " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
- " --bucket-replica=1","\n",
+ " if [ \"0\" != \"", { "Ref" : "RAMForDefaultBucket" }, "\" ]; then","\n",
+ " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
+ " -u Administrator -p ", { "Ref" : "RESTPassword" },
+ " --bucket=default",
+ " --bucket-type=membase",
+ " --bucket-password=",
+ " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
+ " --bucket-replica=1","\n",
+ " fi","\n",
"fi","\n"
@@ -28,7 +28,7 @@
"MinValue" : "200"
},
"RAMForDefaultBucket" : {
- "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer",
+ "Description" : "RAM quota in MB for each node for the default bucket. Should be <= RAMPerServer. Set to 0 for no default bucket.",
"Type" : "Number",
"Default" : "500",
"MinValue" : "0"
@@ -116,13 +116,15 @@
" --cluster-init-username=Administrator",
" --cluster-init-password=", { "Ref" : "RESTPassword" },
" --cluster-init-ramsize=", { "Ref" : "RAMPerServer" },"\n",
- " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
- " -u Administrator -p ", { "Ref" : "RESTPassword" },
- " --bucket=default",
- " --bucket-type=membase",
- " --bucket-password=",
- " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
- " --bucket-replica=1","\n",
+ " if [ \"0\" != \"", { "Ref" : "RAMForDefaultBucket" }, "\" ]; then","\n",
+ " /opt/membase/bin/membase bucket-create -c 127.0.0.1",
+ " -u Administrator -p ", { "Ref" : "RESTPassword" },
+ " --bucket=default",
+ " --bucket-type=membase",
+ " --bucket-password=",
+ " --bucket-ramsize=", { "Ref" : "RAMForDefaultBucket" },
+ " --bucket-replica=1","\n",
+ " fi","\n",
"fi","\n"
Oops, something went wrong.

0 comments on commit 6435fb8

Please sign in to comment.