Note: Please go to docs.rightscale.com to access the current RightScale documentation set. Also, feel free to Chat with us!
Home > Reference Info > Dashboard Help Text > Macros

Macros

Table of Contents

Note: Macros are available only in LCP. Macros have been deprecated and are not available in the Unified Cloud Platform.
 

New

To create a Macro, select a Deployment, Server Array, Server or existing macro that you would like to snapshot and save as a macro. When a macro is created, it will append a timestamp to the filename. To see the saved code that will be used to create the Deployment, Array, Server or existing macro when the macro is run, click the Commands tab. Once a macro has been created, you can edit its underlying code. You can also use the Create New option to create a blank macro instead of specifying a Deployment, Array, Server or an existing macro. If you are creating a macro of a deployment that contains a "private" ServerTemplate and then share that macro with another account, they will need to have access to use all of the referenced ServerTemplates and RightScripts. Since there is no version control for macros, it must be "locked" before it can be shared/published. Once a macro is "locked" it cannot be deleted.

Design > Macros > New

Index

A Macro is an executable snapshot or description of a configured component that you can later run to recreate it. You can create a macro of a deployment, array, server, or something else that you define. For example, if you create a macro of an existing deployment, it will include all of the added servers' attributes, as well as input parameters and cloud-specific attributes that are either set at the deployment or server level. Macros are useful for creating a "snapshot" of a deployment that you can later run in order to recreate that same deployment. Macros are especially useful for sharing purposes where you can share a macro with sub-accounts. For example, you could create a macro of your developer's "beta" deployment and share it with the QA and Marketing team so that they can recreate the "beta" deployment in their own account for testing purposes. Since there is no version control for macros, it must be "locked" before it can be shared/published.

The macro language supports the creation and modification of Deployments, Servers, EBS Volumes, SSH Keys, Security Groups, Elastic IPs, and Server Alerts. A private macro is also editable so you can modify and customize its behavior. All normal Javascript syntax and control structures are available in macros. For security reasons, Elastic IPs, EC2 SSH Keys, and EC2 Security Groups are not carried over when a macro is created. When you run a macro you will need to either select existing ones or let it create new ones for you.

Design > Macros > Index

- -

Show

When you run (execute) a macro, you are executing the macro's code (Commands tab). Unless the code was modified, you will be creating a copy of the deployment/server/array that the macro was created from, including any defined input parameters and attributes. When a macro is run, you will be taken through a series of JavaScript prompts where you will be asked to define new Security Groups, SSH Keys, and create new Elastic IPs (if necessary). Since there is no version control for macros you should keep it locked. Once a macro is locked it cannot be deleted and its underlying code (Commands tab) cannot be modified.

Note: You must have 'admin' role privileges within the current account in order to generate a deployment from a macro.

Design > Macros > Show

Note: Macros are available only in LCP. Macros have been deprecated and are not available in the Unified Cloud Platform.

Commands tab

The Commands tab defines the executable code of the macro. You can edit a macro's commands, but be careful as there is no changelog or revision history to capture your changes.

Design > Macros > Show > Commands tab

Note: Macros are available only in LCP. Macros have been deprecated and are not available in the Unified Cloud Platform.

Info tab

The Info tab shows basic information about your macro. If a macro is locked, its underlying code cannot be edited. As a best practice you should always keep a macro locked and only unlock it when you need to modify it. Although you can share an 'unlocked' macro, it is not recommended.

Design > Macros > Show > Info tab

You must to post a comment.
Last modified
11:35, 22 Jan 2014

Tags

This page has no custom tags.

Classifications

This page has no classifications.

Announcements

None


© 2006-2014 RightScale, Inc. All rights reserved.
RightScale is a registered trademark of RightScale, Inc. All other products and services may be trademarks or servicemarks of their respective owners.