You use these options to create an XaaS blueprint that runs a vRealize Orchestrator workflow when the blueprint is deployed. The workflow changes a target system in your environment.

For the steps that you follow to create the blueprint, see Add an XaaS Blueprint.

To use this wizard, select Design > XaaS > XaaS Blueprints.

Workflow Tab

Select the workflow that runs when the blueprint provisions the resource.

This tab is not available if you are editing a blueprint.

In the following figure, the workflow tree is on the left and the parameters are on the right.

Figure 1. Workflow Tab in the XaaS Blueprint Wizard
Workflow Tab in the XaaS Blueprint Wizard

Review the input and output parameters to ensure that you or your service catalog users can provide the correct values under the following circumstances:

  • If you customize the blueprint form in this wizard or in the blueprint design canvas.

  • If you leave all the input parameters blank, the service catalog users can set the values.

General Tab

Configure the metadata about and the behavior of the blueprint.

Table 1. General Tab Options

Option

Description

Name

The name of the blueprint as you want it to appear in the following locations:

  • Design canvas. If you select Make available as a component in the design canvas, this value is the name that appears in the categories list.

  • Services. If you use this blueprint as a standalone blueprint, this value is the name that you see when you add catalog items to service.

  • Entitlements. If you entitle the blueprint as an individual item, this value is the name that you see in the Add Items list.

Description

Provide a verbose description that helps you differentiate between similar items.

Hide catalog request information page

Select the check box when you do not want to require the service catalog consumers to provide a description and reason when they request the item. The check box is selected by default.

Version

The supported format extends to major.minor.micro-revision.

Make available as a component in the design canvas

If you plan to use the blueprint as a component in a design canvas blueprint, select this option.

When it is published, the blueprint is available in the category you selected when you configured the custom resource.

If you do not select this option, the blueprint does not appear in the design canvas. However, you can still add it to a service and entitle users to deploy it as a standalone blueprint.

Blueprint Form Tab

The fields that appear on this page of the wizard are the workflow input parameters. You can make one or more of the following changes:

  • Add fields to the form.

  • Modify existing fields by deleting or rearranging the fields.

  • Provide default values as the input parameters.

Any changes affect the form that is presented to:

  • The application architect working in the design canvas when this XaaS blueprint is used as a blueprint component.

  • The service catalog user if this blueprint is published as a standalone blueprint.

For more information about configuring the forms, see Designing an XaaS Blueprint Form.

Provisioned Resource

The provisioned resource links the blueprint to a relevant XaaS custom resource that you configured on the Custom Resource page at Design > XaaS > Custom Resource .

Table 2. Provisioned Resource Options

Option

Description

A custom resource that you previously created

Select the custom resource that defines the vRealize Orchestrator resource type required to run the provisioning blueprint.

A provisioning blueprint runs a vRealize Orchestrator workflow to provision resources on the target endpoint using the vRealize Orchestrator plug-in API for the endpoint. For example, add virtual NICs to a network device in vSphere.

You can define post-provisioning operations for this type of provisioned resources. You can also make the blueprint scalable, by adding or removing instances when needed.

Results

  • The blueprint is eligible to for scaling.

  • The blueprint appears in the design canvas in the category specified for the selected custom resource.

  • The blueprint is displayed on the Items tab when you deploy a blueprint that includes it, and you can run any actions on the item after deployment.

No provisioning

A non-provisioning blueprint runs a vRealize Orchestrator workflow to perform a task that does not require the API to make changes to an endpoint. For example, build a report and email or post it to a target communication system.

Results

  • The blueprint is not eligible for scaling. You can use non-provisioning blueprints as supporting workflows in scalable blueprints. For example, you can create a blueprint to update a high availability load balancer.

  • The blueprint appears in the XaaS category in the design canvas.

  • The blueprint is not displayed on the Items tab when you deploy a blueprint that includes it, nor can you run any actions on the item after deployment.

Component Lifecycle Tab

The Component Lifecycle tab is available if you selected Make available as a component in the design canvas on the General tab.

You use these options to define how this blueprint behaves post-deployment during scale-in and scale-out operations when it is used as a component in a composite blueprint.

The availability of the different options depends on the blueprint. Not all blueprint workflows support or require all the options. Because your XaaS might be used in a composite blueprint, you should configure the update and destroy options, as well as allocate and decallocate, if they are available for the blueprint so that the blueprint scales correctly.

Table 3. Component Lifecycle Options

Option

Description

Scalable

Select the option to allow the service catalog user to change the number of instances of this blueprint component after it is deployed as part of a scale-in or scale-out operation.

This option is available if you selected a custom resource on the Provisioned Resource tab. It is not available if you selected the No provisioning option.

If you make this blueprint scalable, the Instances option is added to the General tab in the design canvas. See the example below. If you do not select Scalable, the Instances option is not available in the design canvas.

Example of minimum and maximum instances in the design canvas.

Provisioning workflow

The workflow that runs during a provisioning or scale-out operation. This workflow was selected when you created this blueprint, and you cannot edit the value.

Allocation workflow

Select the workflow that runs before any initial provisioning or scale-out operation.

This life cycle workflow type is available for Azure allocations. If you create an allocation workflow for a scale operation, it must include the following values:

  • Input parameters

    • Parameter name is requestData and the parameter type is Properties.

    • Parameter name is subtenant and the parameter type is Properties.

    • reservations and the parameter type is Arrays/Properties.

  • Output parameter

    • Must include a parameter where the parameter type is Properties.

Update workflow

Select the workflow that runs during update operations, including scale-in or scale out where a component is not scalable, but it can be updated.

For example, a load balancer is updated with the new configuration created with the scale-in or scale-out operation for any of the components in the composite blueprint.

The update workflow might apply to a component that is bound to the scaled component, but which is not itself scalable. This update workflow can change the non-scalable component based on an update operation.

If you create an update workflow for a scale operation, it must include the following values:

  • Input parameters.

    • Must include a parameter, regardless of the parameter name, that matches the output parameter type of the provisioning workflow.

    • Parameter name is data and the parameter type is Properties.

Destroy workflow

Select the workflow that runs during a scale-in or destroy operation.

If you create a destroy workflow for a scale operation, it must include the following value:

  • Input parameter.

    • Must include a parameter, regardless of the parameter name, that matches the output parameter type of the provisioning workflow.

      For example, if the Create simple virtual machine provisioning workflow includes the output parameter VC:VirtualMachine, the destroy workflow must include an input parameter where the type is VC:VirtualMachine.

Deallocation workflow

Select the workflow that runs after any destroy or scale-in operation. If the deallocation fails during the operation, the destroy workflow still runs as expected.

Deallocation is the final process when you scale-in or destroy a composite blueprint. It runs after to the destroy operation, releasing resources.

This life cycle workflow type is available for Azure allocations. If you create an deallocation workflow for a scale operation, it must include the following value:

  • Input parameter.

    • Parameter name is data and the parameter type is Properties.

Category

To specify where the XaaS blueprint appears in the design canvas, select a value in the Design canvas category drop-down menu.

If you do not select a category, the blueprint is added to the XaaS category when it is published.