Cloud scripts and cloud script templates
Summarize
Summary of Cloud scripts and cloud script templates
In the Cloud Provisioning and Governance application, script execution is categorized into cloud scripts and cloud script templates. These scripts enable automation and customization during provisioning and configuration of cloud resources such as virtual machines. Cloud scripts are JavaScript-based and interact with platform features, while cloud script templates are executable scripts executed on target VMs in various formats (Shell, PowerShell, CloudInit) depending on the environment.
Show less
Cloud Scripts
Cloud scripts are simple JavaScript functions that utilize the built-in templateResolver object to fetch and customize cloud script templates. They include parameters with names, default values, and override values that can be literals, resource block parameters, or script expressions. Cloud scripts are used in blueprints, resource blocks, OS profiles, and policy scripts to set request form attributes (though policy scripts cannot override user data).
Customers can customize script behavior by modifying templateAttributes. For example, parameter values such as developer names or node names can be dynamically set via GlideRecord queries within the script before resolving the template.
Cloud Script Templates
Cloud script templates are the actual executable scripts delivered to virtual machines for execution. They must be created separately and then associated with cloud scripts. Templates can be written in Shell, PowerShell, CloudInit, or other formats appropriate to the target environment.
Using Cloud Scripts as CloudInit
- Image Level: Assign cloudinit scripts to specific images so that when an OS profile including that image is selected, the script runs automatically.
- OS Profile Level: Map cloud scripts to OS profiles for specific cloud providers or images. OS profile mappings override image-level scripts. Parameters can be overridden per mapping.
- Resource Blocks: Enable execution of cloud scripts tied to specific resource blocks or resource aliases within blueprints, providing fine-grained control over script execution contexts.
Using Cloud Scripts as Postinit
Cloud scripts can be executed as Postinit scripts within resource blocks by adding an ExecuteScript operation. This operation allows selection from a pool of cloud scripts and supports overriding script parameters using a JSON map in the ScriptParameters attribute. All expressions supported by Cloud Management are valid for parameter overrides, enabling dynamic and flexible script customization after VM provisioning.
In the Cloud Provisioning and Governance application, script execution is divided into cloud scripts and cloud script templates. Use scripts in blueprints, resource blocks, OS profiles, and use policy scripts to set request form attributes. Policy scripts cannot override user data.
Cloud scripts
function evaluateTemplate() {
// Template Resolver is a helper function which we will use to fetch a template and replace its parameters,
// var templateResolver=new TemplateResolver(); this comes inbuild
// templateAttributes below will passed from the user.
var listDir=templateResolver.getTemplate('Install',templateAttributes);
return listDir;
}
Each cloud script contains certain parameters. Parameters are the attributes that you want to access. A parameter contains a name, a default value, and an override value. The default value can be a string literal, a resource block parameter or a complex script expression used in resource blocks.
A cloud script, by default, has access to the templateResolver object. The templateResolver object has, by default, a getTemplate method, whose first parameter is the cloud script template name. templateAttributes are the cloud script parameters created as part of a cloud script. If needed, customizations can be done in templateAttributes. As an example, see the following code snippet if the value of DevName parameter needs to be changed from John to Emily.
function evaluateTemplate() {
// Template Resolver is a helper function which we will use to fetch a template and replace its parameters,
// var templateResolver=new TemplateResolver(); this comes inbuild
// templateAttributes below will passed from the user.
templateAttributes['DevName'] = 'Emily';
var customNodeName;
var now_GR = new GlideRecord('some_custom_table_to_query');
gr.addQuery('some_parameter','some_value');
gr.query();
if(gr.next())
customNodeName=gr.getValue('some_custom_node_name');
templateAttributes['NodeName'] = customNodeName;
var listDir=templateResolver.getTemplate('Install',templateAttributes);
return listDir;
}
evaluateTemplate();
Cloud script templates
Cloud script templates are actual executables which are passed to target a virtual machine for execution. Cloud templates can be of any type (Shell/PowerShell/CloudInit) depending on the execution context. You need to create a cloud template first and then associate it with a cloud script.
Cloud scripts as CloudInit
- Image level: At the time of creating a cloud script, you can specify an image against
which this script should be executed. Once an OS profile which contains this specific
image gets selected, the default cloud script against this image is executed. In the
example below, an Apache cloud script is associated with a particular image.
- OS profile level: You can run a cloudinit against a specific cloud provider and
against a specific AMI/image. You can also be generic and associate a cloudinit to an OS
profile, irrespective of the underlying image. In the following example, multiple images
are associated with the OS profile. You can map any cloud script to the OS profile in
the Cloud Script OS Profile Mappings tab. The mapping of a cloud script with an OS
profile takes precedence over the image-level cloud script association.
In this example, the Apache cloud script is mapped to the Centos OS profile. If needed, you can override the script parameters in the OS Profile Mapping Overrides section. - Resource blocks: While mapping a cloud script to an OS profile, you can choose whether to execute the cloud script for a specific resource block used in a blueprint and against a particular resource alias. See Create an OS profile.
Cloud scripts as Postinit
You can use cloud scripts as Postinit scripts in a resource block. Once you create a resource block with a virtual machine to be provisioned, you can add an ExecuteScript operation. The ExecuteScript operation takes a script parameter (a pool of cloud scripts) and you can select any script to execute. Use the ScriptParameters attribute in the ExecuteScript operation to override any script parameter. You can provide a JSON map of script parameter and its override value. All expressions that are supported by Cloud Management work in the ScriptParamters attribute.