Create a Custom RightImage (AMI)

Objective

To create a custom RightImage (AMI) that functions similar to a RightImage published by RightScale. 

Warning!

Customized images are not fully supported by RightScale. We encourage you to use our ServerTemplates and RightImages. However, if you do create custom images and would like to RightLink-enable them, please see Creating RightScale-enabled Images with RightLink.

Table of Contents

Overview

RightScale regularly publishes updated RightImages for CentOS and Ubuntu.  If possible, we recommend using one of our published RightImages.   However, we do realize that we can't create and support a RightImage that satisfies the requirements for every type of application.  As a result, we've provided a way to create your own custom "RightImage" where you can specify different combinations of operating systems or software package versions.  Although this document is best suited for making minor modifications to a CentOS or Ubuntu image, you can also use it as a model for creating other types of images. 

Important!
The following steps apply to creating v4 RightImages.
To create v5 RightImages (with RightLink installed), see Creating RightScale-enabled Images with RightLink.

Disclaimer

RightScale is not responsible for supporting custom RightImages.   In theory, you should be able to use a custom RightImage that was created following this tutorial with ServerTemplates published by RightScale, but we cannot make any guarantees.    If you choose to create a custom RightImage using this method, you are responsible for properly testing its functionality.

Prerequisites

• 'actor' and 'library' user role privileges
• This feature is reserved for advanced users. 

Steps

1. Go to Design -> Library -> ServerTemplates.   Use the filter tool to find the following ServerTemplates:
   • RightImage Creator - CentOS (Beta)
   • RightImage Creator - Ubuntu (Beta)
2. Import the ServerTemplate that will best suit your needs.
3. Create an S3 bucket that will be used to store the files for the custom AMI.  It will be easier to find the files if you create a new S3 bucket, but if you want to use an existing S3 bucket instead, you can proceed to the next step.
4. Create a new Deployment (e.g. Image Creator)
5. Clone the ServerTemplate if you wish to add scripts to the boot sequence to install/configure additional components for the image
6. Add a Server into the Deployment using the ServerTemplate (imported or cloned). Be sure to add the Server in the AWS region (e.g. AWS US-East) where you want to create the AMI.  Remember, images are region-specific.
7. If you cloned the template to add customization, add any scripts before the last script in the boot scripts of the template for any modifications.
   When running commands to modify the image, ensure you use chroot with the location of the image. Here is an example that installs an additional package (Ubuntu):
   
   #!/bin/sh
chroot "$ROOT" apt-get -y install joe
    
8. Launch the Server.
9. Specify the following Input parameters:
   • AWS _BUCKET - Enter the name of the S3 bucket where the image files will be stored.
   • IMAGE_NAME - Enter the name of the custom AMI that you are about to create.
   • ARCH - Select either i386 for a 32-bit architecture or x86_64 for a 64-bit architecture.
10. If the Server becomes operational, the custom AMI was created successfully.   You will find the new AMI in the specified S3 bucket.
11. To test its functionality, see Test a Custom RightImage (AMI).

See also

• Creating RightScale-enabled Images with RightLink
• Create a custom RightImage for faster boot times