Skip to content

Commit da3aa2e

Browse files
committed
Created AMI customization documentation.
1 parent 4587a76 commit da3aa2e

File tree

3 files changed

+41
-2
lines changed

3 files changed

+41
-2
lines changed

docs/source/ami_customization.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. _ami_customization:
2+
3+
.. toctree::
4+
:maxdepth: 2
5+
6+
################################
7+
Building a custom CfnCluster AMI
8+
################################
9+
10+
.. warning::
11+
Building a custom AMI is not the recomended approach for customizing CfnCluster.
12+
13+
Once you build your own AMI, you will no longer receive updates or bug fixes with future releases of CfnCluster. You will need to repeat the steps used to create your custom AMI with each new CfnCluster release.
14+
15+
Before reading any further, take a look at the :doc:`pre_post_install` section of the documentation to determine if the modifications you wish to make can be scripted and supported with future CfnCluster releases
16+
17+
While not ideal, there are a number of scenarios where building a custom AMI for CfnCluster is necessary. This tutorial will guide you through the process.
18+
19+
How to customize the CfnCluster AMI
20+
===================================
21+
22+
The base CfnCluster AMI is often updated with new releases. This AMI has all of the components required for CfnCluster to function installed and configured. If you wish to customize an AMI for CfnCluster, you must start with this as the base.
23+
24+
#. Find the AMI which corresponds with the region you will be utilizing in the list here: https://github.com/awslabs/cfncluster/blob/master/amis.txt.
25+
#. Within the EC2 Console, choose "Launch Instance".
26+
#. Navigate to "Community AMIs", and enter the AMI id for your region into the search box.
27+
#. Select the AMI, choose your instance type and properties, and launch your instance.
28+
#. Log into your instance using the ec2-user and your SSH key.
29+
#. Customize your instance as required
30+
#. Run the following command to prepare your instance for AMI creation::
31+
32+
sudo /usr/local/sbin/ami_cleanup.sh
33+
34+
#. Stop the instance
35+
#. Create a new AMI from the instance
36+
#. Enter the AMI id in the :ref:`custom_ami_section` field within your cluster configuration.

docs/source/configuration.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,8 @@ If cluster_type is set to spot, the maximum spot price for the ComputeFleet. ::
153153

154154
spot_price = 0.00
155155

156+
.. _custom_ami_section:
157+
156158
custom_ami
157159
""""""""""
158160
ID of a Custom AMI, to use instead of default published AMI's. ::
@@ -303,8 +305,8 @@ See :ref:`EBS Section <ebs_section>`. ::
303305

304306
ebs_settings = custom
305307

306-
scaling
307-
"""""""
308+
scaling_settings
309+
""""""""""""""""
308310
Settings section relation to scaling
309311

310312
See :ref:`Scaling Section <scaling_section>`. ::

docs/source/tutorials.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ Here you can find tutorials for best practices guides for getting started with C
88
.. toctree::
99

1010
hello_world
11+
ami_customization

0 commit comments

Comments
 (0)