Cloud scripts and cloud script templates
Summarize
Summary of Cloud scripts and cloud script templates
In the Cloud Provisioning and Governance application within ServiceNow, script execution is categorized into cloud scripts and cloud script templates. These scripts enable automation and customization in blueprints, resource blocks, OS profiles, and policy scripts. Cloud scripts are JavaScript-based and make use of platform features, while cloud script templates are executable scripts (such as Shell, PowerShell, or CloudInit) designed for execution on virtual machines.
Show less
Cloud Scripts
- Cloud scripts are simple JavaScript functions that use the built-in templateResolver object to fetch and manipulate templates dynamically.
- They contain parameters with names, default values, and override values, allowing flexible customization of script behavior.
- Parameters can be static values, resource block parameters, or complex script expressions.
- Scripts can be customized by modifying templateAttributes to change parameter values before template execution.
- The sample code demonstrates how to override parameters and query data to dynamically set values used in a template.
Cloud Script Templates
- Cloud script templates are the actual executable scripts that run on target virtual machines.
- They support multiple script types depending on the execution environment, including Shell, PowerShell, and CloudInit.
- To use cloud scripts effectively, you first create a cloud template and then associate it with a cloud script.
Using Cloud Scripts as CloudInit
- CloudInit scripts enable execution of scripts at virtual machine boot time and can be assigned at different levels:
- Image level: Associate a cloud script with a specific VM image to run the script automatically when that image is selected in an OS profile.
- OS profile level: Map cloud scripts to OS profiles, allowing scripts to run regardless of the underlying image. OS profile mappings take precedence over image-level associations.
- Resource blocks: Cloud scripts can be executed for specific resource blocks and resource aliases within blueprints by mapping scripts accordingly.
- Overrides to script parameters can be configured in the OS Profile Mapping Overrides section for finer control.
Using Cloud Scripts as Postinit
- Cloud scripts can be executed as Postinit scripts within resource blocks after VM provisioning.
- This is done by adding an ExecuteScript operation that selects a cloud script from a script pool.
- Script parameters can be overridden using the ScriptParameters attribute, supplied as a JSON map to customize script execution dynamically.
- All expressions supported by Cloud Management are valid in the ScriptParameters attribute, enabling flexible parameterization.
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.