Skip to content
This repository has been archived by the owner on Jul 5, 2021. It is now read-only.

Commit

Permalink
EC2 Image Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Trishna committed Aug 23, 2016
1 parent a0aca6b commit 9be4650
Show file tree
Hide file tree
Showing 3 changed files with 156 additions and 0 deletions.
60 changes: 60 additions & 0 deletions docs/ec2_creation.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
EC2 Creation
============

Introduction
------------

Creating your own custom images for EC2 is a quick and easy process. While there are many ways to create an EC2 image, this page will walk you through using `boxgrinder <http://boxgrinder.org/>`_. Boxgrinder is chosen here because the packages are in Fedora, and it is a simple process that anyone can use. The Cloud SIG maintains basic appliance definition files in the `cloud-kickstarts git repository <http://git.fedorahosted.org/git/?p=cloud-kickstarts.git/>`_ on fedorahosted.org.

Local creation or EC2 based creation
------------------------------------

For boxgrinder to generate images, you will need to have boxgrinder installed somewhere. Simple enough, though you have a couple of options here. Boxgrinder can be installed on your existing Fedora host by running:

.. code-block:: bash
dnf install rubygem-boxgrinder-core rubygem-boxgrinder-build
Or, if you would rather have the image creation and publish happen on AMI hosts and save the upload time, you can run boxgrinder in one of the project supported `meta-appliances <http://boxgrinder.org/download/boxgrinder-build-meta-appliance/>`_.

Configuration
-------------

Whichever route you choose, a little bit of configuration is required. First, you will need a config file with a little information about your Amazon AWS account. Put the following BoxGrinder config into a file named: ``/root/.boxgrinder/config``. Insert appropriate values, see: http://boxgrinder.org/tutorials/boxgrinder-build-plugins/#S3_Delivery_Plugin, for more information.

.. code-block:: bash
plugins:
s3:
access_key: AWS_ACCESS_KEY # (required)
secret_access_key: AWS_SECRET_ACCESS_KEY # (required)
bucket: stormgrind-test # (required)
account_number: 0000-0000-0000 # (required)
path: /images # default: /
cert_file: /home/a/cert-ABCD.pem # required only for ami type
key_file: /home/a/pk-ABCD.pem # required only for ami type
ebs:
access_key: AWS_ACCESS_KEY # required
secret_access_key: AWS_SECRET_ACCESS_KEY # required
account_number: AWS_ACCOUNT_NUMBER # required
delete_on_termination: false # default: true
Creation
--------

Actual image creation requires an appliance definition file to get started. The Cloud SIG maintains basic configuration files for current Fedora releases in `cloud-kickstarts git repository <http://git.fedorahosted.org/git/?p=cloud-kickstarts.git/>`_ on fedorahosted.org. You can grab the configuration file from the boxgrinder directory here, and modify it add packages as necessary for your application. More advanced configuration instructions, including post install scripting, are available on the `boxgrinder website <http://boxgrinder.org/tutorials/appliance-definition/>`_. Once you have the configuration file you want, it is as simple as running a single command:

For an S3 backed image:

.. code-block:: bash
boxgrinder-build /path/to/your/fedora.appl -p ec2 -d ami
For an EBS backed image:

.. code-block:: bash
boxgrinder-build /path/to/your/fedora.appl -p ec2 -d ebs
This will build your image, upload it, and register the AMI, though you will have to make it public yourself. Note that boxgrinder works through plugins, and everything is done in steps. If you want both S3 and EBS based images, run the commands in order, and the EBS image will use the output from the S3 backed to save considerable time. If you require any assistance, people are always willing to help on irc.freenode.net at `#fedora-cloud <irc://irc.freenode.net/fedora-cloud/>`_, or on the `fedora cloud sig email list <https://admin.fedoraproject.org/mailman/listinfo/cloud/>`_.
94 changes: 94 additions & 0 deletions docs/ec2_image.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
Amazon Elastic Compute Cloud (EC2)
==================================

Fedora's EC2 images follow the standard EC2 login conventions, meaning that root login is disabled, but sudo access is granted.

**The default username for the images is ec2-user.**

Full documentation for interacting with EC2 is available from `Amazon Web Services <http://docs.amazonwebservices.com/AWSEC2/latest/GettingStartedGuide/>`_.

Currently supported EC2 Images
------------------------------

**Fedora 24**

+-------------------+----------------+---------------------+-------------+----------------+
| Region | Architecture | Virtualization Type | Volume Type | AMI IDs |
+===================+================+=====================+=============+================+
| EC2 (us-west-1) | x86_64 | paravirtual | standard | ami-806722e0 |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (sa-east-1) | x86_64 | paravirtual | standard | ami-819319ed |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (us-west-2) | x86_64 | paravirtual | standard | ami-2945bf49 |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (eu-west-1) | x86_64 | paravirtual | standard | ami-aaa43bd9 |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (eu-central-1)| x86_64 | paravirtual | standard | ami-51db323e |
+-------------------+----------------+---------------------+-------------+----------------+
|EC2(ap-southeast-2)| x86_64 | paravirtual | standard | ami-95f7def6 |
+-------------------+----------------+---------------------+-------------+----------------+
|EC2(ap-southeast-1)| x86_64 | paravirtual | standard | ami-a2d102c1 |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (sa-east-1) | x86_64 | hvm | standard | ami-c1961cad |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (us-west-1) | x86_64 | hvm | standard | ami-c06025a0 |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (us-west-2) | x86_64 | hvm | standard | ami-2a45bf4a |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (eu-west-1) | x86_64 | hvm | standard | ami-415ec132 |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (eu-central-1)| x86_64 | hvm | standard | ami-2ed83141 |
+-------------------+----------------+---------------------+-------------+----------------+
|EC2(ap-southeast-2)| x86_64 | hvm | standard | ami-f7f6df94 |
+-------------------+----------------+---------------------+-------------+----------------+
|EC2(ap-southeast-1)| x86_64 | hvm | standard | ami-21d60542 |
+-------------------+----------------+---------------------+-------------+----------------+
|EC2(ap-northeast-1)| x86_64 | paravirtual | standard | ami-3a779c5b |
+-------------------+----------------+---------------------+-------------+----------------+
|EC2(ap-northeast-1)| x86_64 | hvm | standard | ami-84709be5 |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (us-west-2) | x86_64 | hvm | gp2 | ami-af47bdcf |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (sa-east-1) | x86_64 | paravirtual | gp2 | ami-c3961caf |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (us-west-2) | x86_64 | paravirtual | gp2 | ami-2c4ab04c |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (us-west-1) | x86_64 | paravirtual | gp2 | ami-7e67221e |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (eu-west-1) | x86_64 | paravirtual | gp2 | ami-5fa33c2c |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (eu-central-1)| x86_64 | paravirtual | gp2 | ami-28d83147 |
+-------------------+----------------+---------------------+-------------+----------------+
|EC2(ap-southeast-2)| x86_64 | paravirtual | gp2 | ami-66f6df05 |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (sa-east-1) | x86_64 | hvm | gp2 | ami-67971d0b |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (us-west-1) | x86_64 | hvm | gp2 | ami-2c67224c |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (eu-west-1) | x86_64 | hvm | gp2 | ami-1ca03f6f |
+-------------------+----------------+---------------------+-------------+----------------+
|EC2(ap-southeast-2)| x86_64 | hvm | gp2 | ami-96f7def5 |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (eu-central-1)| x86_64 | hvm | gp2 | ami-b6d930d9 |
+-------------------+----------------+---------------------+-------------+----------------+
|EC2(ap-southeast-1)| x86_64 | hvm | gp2 | ami-9fd003fc |
+-------------------+----------------+---------------------+-------------+----------------+
|EC2(ap-northeast-1)| x86_64 | hvm | gp2 | ami-ba759edb |
+-------------------+----------------+---------------------+-------------+----------------+
|EC2(ap-southeast-1)| x86_64 | paravirtual | gp2 | ami-24d60547 |
+-------------------+----------------+---------------------+-------------+----------------+
|EC2(ap-northeast-1)| x86_64 | paravirtual | gp2 | ami-a8769dc9 |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (us-east-1) | x86_64 | paravirtual | standard | ami-cbf430a6 |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (us-east-1) | x86_64 | hvm | standard | ami-72eb2f1f |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (us-east-1) | x86_64 | paravirtual | gp2 | ami-3ae92d57 |
+-------------------+----------------+---------------------+-------------+----------------+
| EC2 (us-east-1) | x86_64 | hvm | gp2 | ami-f0ea2e9d |
+-------------------+----------------+---------------------+-------------+----------------+

Custom Image Creation
---------------------

Visit `Cloud_SIG/EC2Creation <https://fedoracloud.readthedocs.io/en/latest/ec2_creation.html/>`_ for instructions on how to build custiom versions of these images.
2 changes: 2 additions & 0 deletions docs/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Contents:
atomiccommandcheatsheet
base
docker
ec2_image
ec2_creation
contribute


Expand Down

0 comments on commit 9be4650

Please sign in to comment.