Skip to content

Commit 88a2de2

Browse files
committed
docs(ec2): Document update_ec2_cluster.sh
Add a section to the installing_deis/aws page describing the behavior of the update_ec2_cluster script including the parameters that can be changed without replacing the resources in the CloudFormation stack and a link to the pertinent AWS documentation.
1 parent f281f8b commit 88a2de2

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

docs/installing_deis/aws.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,21 @@ 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 any resources:
183+
184+
- ``ClusterSize`` - Number of nodes in the cluster. This may launch new instances or terminate
185+
existing ones, but service will not be interrupted.
186+
- ``SSHFrom`` - Locks down SSH access to the Deis hosts. This will update the security
187+
group for the Deis hosts.
188+
189+
Please reference the AWS documentation for `more information about CloudFormation stack updates`_.
175190

176191
.. _`#1758`: https://github.com/deis/deis/issues/1758
177192
.. _`awscli`: https://github.com/aws/aws-cli
@@ -180,3 +195,6 @@ start installing the platform.
180195
.. _`etcd`: https://github.com/coreos/etcd
181196
.. _`etcd disaster recovery`: https://github.com/coreos/etcd/blob/master/Documentation/admin_guide.md#disaster-recovery
182197
.. _`PyYAML`: http://pyyaml.org/
198+
.. _`update_ec2_cluster.sh`: https://github.com/deis/deis/blob/master/contrib/ec2/update-ec2-cluster.sh
199+
.. _`More information about CloudFormation stack updates`: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html
200+

0 commit comments

Comments
 (0)