OneFuse custom resources

How to enable and use OneFuse Custom Resources as drag-and-drop elements on the VMware Aria Automation 8.2+ Cloud Template canvas

To learn more, refer to VMware Docs: Custom Resources.

VMware Aria Automation version OneFuse version
8.2+ 1.2+

Introduction

Aria Automation 8.2+ allows you to create Custom Resources that can be treated as drag-and-drop elements directly onto a Cloud Template canvas.

For each of the OneFuse modules, you now have the capability to drag-and-drop any of the OneFuse modules directly onto the vRA Cloud Template canvas.

In addition, every OneFuse Custom Resource is capable of leveraging the Property Toolkit to consume integrations and drive dynamic outcomes in a standardized way.

Enable OneFuse Custom Resources

  1. Log in to vRealize Orchestrator web client.
  2. Select Workflows > Custom Resources > Configuration.
  3. Run the Configure OneFuse Custom Resources workflow to create the required elements for the Custom Resources feature in Cloud Assembly.

Available OneFuse Custom Resources

Each of the listed available OneFuse Custom Resource types is able to be consumed directly from the vRealize Automation Canvas.

  1. Log in to vRealize Automation Cloud Assembly
  2. Go to Design > Custom Resources to see a list of available OneFuse Custom Resources:

Adding OneFuse Custom Resources to a Cloud Template

You can use Custom Resources on a new or existing Cloud Template.

  1. In Cloud Assembly, go to Design > Cloud Templates.

  2. Create a new Template, or modify an existing Template.

  3. In the component pane on the left, scroll to the bottom to see all the available OneFuse Custom Resources.

  4. Drag and drop the desired OneFuse:<Module/Feature> element onto the canvas.

  5. For each OneFuse component added to the canvas, fill out the values for the required Properties in the YAML code.

    Parameter name Required? Notes
    endpointName Required OneFuse Endpoint Name in vRA. Refer to Managing endpoints.
    policyName Required OneFuse Module Policy Name (string).
    templateProperties Optional Additional properties that are referenced within the Policy. JSON format.
    trackingId Optional Tracking ID (string) to link multiple OneFuse Policy Executions and resulting OneFuse Managed Objects together. If none is passed, one gets generated by OneFuse for that specific Policy Execution.

Best practices

Learn about recommendations when using OneFuse Custom Resources in Aria Automation 8.2+

OneFuse Custom Resources with virtual machine elements

  • OneFuse Custom Resources should not be used to influence outcomes (Naming, IPAM, etc.) for Virtual Machine types (Cloud Machine, vSphere Machine, etc.) on the Cloud Template canvas.
  • Aria Automation 8 does not respect dependencies for machine elements, therefore you must use the property-driven method to invoke OneFuse for machine elements.
  • Custom Resources can be included on the same canvas as a machine element if the output of the Custom Resource is not referenced in the machine element itself.

OneFuse Custom Resources with other Resource Types

  • When leveraging any of the Resource Types in Aria Automation 8 (other than machines), OneFuse Custom Resources should be leveraged where possible.

For example:

Name vRA Deployments

Every Cloud Template should include the OneFuse:DeploymentName_v1 Custom Resource to standardize vRA Deployment Names.

To add the Custom Resource for OneFuse vRA Deployment Name:

  • From the Resource Types navigation and expand Custom Resources

  • Drag-and-drop OneFuse:DeploymentName_v1 to the Cloud Template canvas

  • In the Code tab, provide values for the following properties:

    Parameter name Required? Notes
    endpointName Required OneFuse Endpoint Name in vRA. Refer to Managing endpoints.
    policyName Required OneFuse Module Policy Name (string).
    templateProperties Optional Additional properties that are referenced within the Policy. JSON format.
    trackingId Optional Tracking ID (string) to link multiple OneFuse Policy Executions and resulting OneFuse Managed Objects together. If none is passed, one gets generated by OneFuse for that specific Policy Execution.
  • Provide a OneFuse Naming Policy name for policyName.