Skip to content

Commit 6cd009b

Browse files
committed
Merge pull request #2990 from theaboutbox/update-ec2-cluster-docs
docs(ec2): Document update_ec2_cluster.sh
2 parents f281f8b + db7a930 commit 6cd009b

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

docs/installing_deis/aws.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,23 @@ Install Deis Platform
172172
Now that you've finished provisioning a cluster, please refer to :ref:`install_deis_platform` to
173173
start installing the platform.
174174

175+
CloudFormation Updates
176+
----------------------
177+
178+
To use CloudFormation to perform update operations to your stack, there is another script:
179+
`update_ec2_cluster.sh`_. Depending on the parameters that you have changed, CloudFormation
180+
may replace the EC2 instances in your stack.
181+
182+
The following parameters can be changed without replacing all instances in a stack:
183+
184+
- ``ClusterSize`` - Number of nodes in the cluster. This may launch new instances or terminate
185+
existing instances. If you are scaling down, this may interrupt service. If a container
186+
was running on an instance that was terminated, it will have to be rebalanced onto another
187+
node which will cause some downtime.
188+
- ``SSHFrom`` - Locks down SSH access to the Deis hosts. This will update the security
189+
group for the Deis hosts.
190+
191+
Please reference the AWS documentation for `more information about CloudFormation stack updates`_.
175192

176193
.. _`#1758`: https://github.com/deis/deis/issues/1758
177194
.. _`awscli`: https://github.com/aws/aws-cli
@@ -180,3 +197,6 @@ start installing the platform.
180197
.. _`etcd`: https://github.com/coreos/etcd
181198
.. _`etcd disaster recovery`: https://github.com/coreos/etcd/blob/master/Documentation/admin_guide.md#disaster-recovery
182199
.. _`PyYAML`: http://pyyaml.org/
200+
.. _`update_ec2_cluster.sh`: https://github.com/deis/deis/blob/master/contrib/ec2/update-ec2-cluster.sh
201+
.. _`More information about CloudFormation stack updates`: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html
202+

0 commit comments

Comments
 (0)