Customize the Development and Test Macro
Objective
Customize a Deployment that was originally created by running one of the "Development and Test Solution Pack" Macros.
Table of Contents
Prerequisites
- A deployment that was created using one of RightScale's Development and Test Solution Pack Macros.
- 'actor' user role privileges are required to run the macro
- 'designer' user role privileges are required for editing the ServerTemplates
Overview
Once you've run the Dev & Test Macro to create a functional test you'll most likely want to customize it to be more specific for your application environment.
Common Customizations
Below are some common ways that you can modify your Deployment for your own purposes. Later, you can also create a Macro of all your changes so that another user will be able to run your custom Macro.
Retrieving your Application
The published Macros from RightScale are designed to retrieve a tarball of your application code and a MySQL dump file from an S3 bucket. However, you can also customize it to pull your application from an SVN repository. Some inputs are defined at the ServerTemplate level, while others are defined at the Deployment level, which overwrite values set at the ServerTemplate level. See Understanding Inputs.
From an S3 bucket
If you want to retrieve your application from an S3 bucket, simply define the required inputs below accordingly. You can either define the inputs at the ServerTemplate or Deployment levels. If you choose to follow the format defined by the macro, you can define the following inputs at the Deployment level. Hover your mouse of the blue Info icons next to the Input name for helpful descriptions and suggested values. Under the ServerTemplate or Deployment's Inputs tab, click Edit and specify your custom input parameters.
- APPLICATION
- APPLICATION_CODE_BUCKET
- APPLICATION_CODE_PACKAGE
- DBADMIN_PASSWORD
- DBADMIN_USER
- DB_MYSQLDUMP_BUCKET
- DB_MYSQLDUMP_PREFIX
- DB_SCHEMA_NAME
- DBAPPLICATION_PASSWORD
- DBAPPLICATION_USER
From an SVN Repository
In order to pull your application code from an SVN repository instead of an S3 bucket, you must modify the ServerTemplate's scripts.
You must Clone a ServerTemplate in order to make modifications to its scripts. Find the ServerTemplate that is being used to serve your application (e.g. LAMP AIO or PHP App Server).
Go to the cloned ServerTemplate's Scripts tab and click Edit. Before you make any edits to the ServerTemplate, create a committed revision. This way you can always go back to [rev1] and reference the original version. Click the Commit button. Enter a comment like "original version" for the commit message. Note: Once you commit the ServerTemplate, you will still be viewing the editable HEAD version.
Replace the "WEB app s3 code checkout" script with the latest version of the "WEB app svn code checkout" script. Click the Add Script button and use the selector tool to find and add the script. (Tip: RightScale is the publisher) If you cannot find the script, you will need to add it to the RightScale account from the MultiCloud Marketplace. (Design -> MultiCloud Marketplace -> RightScripts)
It's important that you add the script as a boot script and place the script in the same location as the previous script. See screenshot below.
As a result of adding the new script, you may need to specify the following inputs that will be used by the script in order to get your application code from the SVN repository.
- APPLICATION
- OPT_SVN_CHECKOUT_MODE
- OPT_SVN_PASSWORD
- OPT_SVN_USERNAME
- SVN_APP_REPOSITORY
Hover your mouse of the blue Info icons next to the Input name for helpful descriptions and suggested values.
Launch a New Server
The next step is to launch a Server using the revised ServerTemplate. Go back to your Dev & Test Deployment. Manage -> Deployments -> YourDeployment. If you haven't already shutdown the first server that you launched, terminate it now. Once the server is stopped, you can launch a new server. Remember, the server that's defined in the Deployment should still referencing the HEAD version, so if you launch the server again, it will launch a fresh new server, but this time it will use the new input parameters that you just defined.
Test and Repeat
You will most likely have to repeat the process of making edits to the HEAD ServerTemplate's inputs and launching/terminating servers until you've configured your ServerTemplate to launch a custom server that can be used for your development and test purposes.
Once you're satisfied with the ServerTemplate's configuration, commit the ServerTemplate once again. Going forward, you will want to use this committed revision of the ServerTemplate to launch future development and test servers.
Next Steps
Once you've properly configured your Dev & Test Deployment there are a couple of different steps you can take next depending on if and how you want to share it with other users.
- Create a Custom Macro that can be used to create an custom Dev & Test Deployment within the same RightScale account
- Create and Share a Custom Macro with other RightScale accounts
- Clone the Deployment for another user
- © Copyright 2015 RightScale Technical Support