Configure general settings, create properties, and write custom action scripts to install, configure, update, or uninstall your Software component on provisioned machines.

As a software architect, click Design > Software components and click the Add icon to create a new Software component.

New Software General Settings

Apply general settings to your Software component.

Table 1. New Software General Settings

Setting

Description

Name

Enter a name for your Software component.

ID

Using the name you specified for your Software component, vRealize Automation creates an ID for the Software component that is unique within your tenant. You can edit this field now, but after you save the blueprint you can never change it. Because IDs are permanent and unique within your tenant, you can use them to programmatically interact with blueprints and to create property bindings.

Description

Summarize your Software component for the benefit of other architects.

Container

Select a container type for your Software component. For example, selecting Software Component restricts architects from placing your Software component directly on a machine without nesting it within another Software component.

New Software Properties

Software component properties are used to parameterize scripts to pass defined properties as environment variables to scripts running in a machine. Before running your scripts, the Software agent in the provisioned machine communicates with vRealize Automation to resolve the properties. The agent then creates script-specific variables from these properties and passes them to the scripts.

Table 2. New Software Properties

Setting

Description

Name

Enter a name for your Software property. Property names are case-sensitive and can contain only alphabetic, numeric, hyphen (-), or underscore (_) characters.

Description

For the benefit of other users, summarize your property and any requirements for the value.

Type

Software supports string, array, content, boolean, integer, and double properties. For a detailed explanation of supported property types, see Property Types and Setting Options.

Value

Select a container for your software component. For example, selecting Software Component restricts architects from placing your software component on a machine instead of nesting it within another software component.

Encrypted

Mark properties as encrypted to mask the value and display as asterisks in vRealize Automation. If you change a property from encrypted to unencrypted, vRealize Automation resets the property value. For security, you must set a new value for the property.

Important:

If secured properties are printed in the script using the echo command or other similar commands, these values appear in plain text in the log files. The values in the log files are not masked.

Overridable

Allow architects to edit the value of this property when they are assembling an application blueprint. If you enter a value, it displays as a default.

Required

Require architects to provide a value for this property, or to accept the default value you supply.

Computed

Values for computed properties are assigned by the INSTALL, CONFIGURE, or START life cycle scripts. The assigned value is propagated to the subsequent available life cycle stages and to components that bind to these properties in a blueprint. If select Computed for a property that is not a string property, the property type is changed to string.

New Software Actions

You must provide a custom Bash, Windows CMD, or PowerShell script as the action for at least one of the predefined life cycle stages: Install, Configure, Start, or Uninstall.

You can parameterize a script by declaring, for example, the installer location, installation path, or environment variables as properties in the script. The parameters render the scripts generic. You can deploy the service on different environments without modifying these generic scripts. You can also modify parameter values from the action script. These modified properties can be referred to as property values for other components.

When you author an action script, the exit and return codes vary between script types. You must set proper exit codes in the script that are applicable to the application deployment. If the script lacks exit and return codes, the last command that ran in the script becomes the exit status.

Table 3. New Software Actions

Setting

Description

Bash

You can use return 0 or exit 0 codes in action scripts to indicate success status. To indicate error status, you can use return non-zero or exit non-zero.

cmd

Do not use exit 0 and exit non-zero codes in the action script. If you use these codes in the script, the computed properties task processing is stopped prematurely. Use exit /b 0 to indicate success status and exit /b non-zero for error status.

powershell

You can use exit 0 to indicate success status and exit non-zero for error status.

Reboot

You can configure your Software component to reboot the machine at the end of any life cycle stage.