Note: If you cannot find a topic, go to where all RightScale documentation will soon be located. Also, feel free to Chat with us!
Home > Partners > CloudPassage > Documentation > Asset Runbook for CloudPassage Halo

Asset Runbook for CloudPassage Halo


To understand how to use all of the scripts, inputs, and operational procedures required to run the CloudPassage Solution.

Table of Contents


  • 'library' user role privilege to import a ServerTemplate from the MultiCloud Marketplace
  • 'actor' user role privilege to launch/terminate/manage cloud resources
  • 'designer' user privilege to create a Credential.


CloudPassage provides a RightScript that can be used to download and install the CloudPassage Halo daemon on your servers.

Setup Guide

Import the RightScript

Go to Design -> MultiCloud Marketplace -> RightScripts.  Use the search tool to find and import the most recent revision of the "CloudPassage Halo" RightScript.  A copy of the script will be saved in your RightScale account's local collection. (Design -> RightScripts)

Create a Credential for the CloudPassage Daemon Registration Key

In order to run the imported RightScript on a Server, you will need to provide your CloudPassage Daemon Registration Key for authorization purposes.

Note: If you do not have access to your CloudPassage Daemon Registration Key, you will need to sign-up and register for a new CloudPassage account.  See Register for CloudPassage.  Upon completing registration, you will receive an email with your CloudPassage login credentials and further instructions.

To retrieve the CloudPassage API Key, log into the CloudPassage Portal and navigate to Settings -> Site Administration -> Daemon Settings. 


As a best practice, you'll want to create a new Credential for storing the Daemon Registration Key. This way you will not have to enter the CloudPassage Daemon Registration key each time the script is run. Instead, the created Credential will be used to pass the key to the Halo daemon when the script is executed. 

Go to Design -> Credentials and create a new Credential.  Name the new Credential "CLOUDPASSAGE_DAEMON_KEY" so that it will match the name of the Input.  See Create a New Credential.


Common Runbook Operations

Run the Script

The script can be run as either a Boot or Operational Script.  If you run the script as a Boot Script, it's recommended that you add it as the last script in the list.  To run the script on a running server, you can also use the 'Any' script option.

It installs the CloudPassage Halo daemon under the /opt/cloudpassage/ directory. It will then activate and initialize the Halo daemon using the CLOUDPASSAGE_DAEMON_KEY input to pass the daemon registration key for authentication purposes. Once activated, the server will automatically connect to the CloudPassage Halo grid. Log into the CloudPassage Portal to monitor its configuration and security.

Required Inputs

Input Name
Example Values
 CLOUDPASSAGE_DAEMON_KEY The Daemon Registration key of your CloudPassage account.  You can either pass the value with a Credential (recommended) or as simple Text.


Text: 123------xyz


The CloudPassage Halo script is "reboot safe" and is skipped when the Server is rebooted. When the server reboots, the CloudPassage Halo daemon restarts automatically and connects to the CloudPassage Halo grid.

You must to post a comment.
Last modified
23:39, 16 May 2013


This page has no custom tags.


This page has no classifications.



© 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.