Pluggable modules

To learn more about this OneFuse feature, refer to Pluggable modules.

Prerequisites

1. Configure OneFuse Property Set(s) and OneFuse Module Policies.
2. Run OneFuse Configuration per Cloud Assembly Organization.
3. Review an overview on OneFuse modules with Aria Automation 8.1+/Cloud.
4. Create a new Cloud Template (if none exist) or determine which existing Cloud Template(s) will utilize this OneFuse Module.
   • Resource: Designing your vRealize Automation Cloud Assembly deployments

Steps

1. Know the name of the OneFuse Endpoint created via OneFuse Configuration.
2. Determine which OneFuse Pluggable Module Policies to run for this Cloud Template.
3. Determine when to run each OneFuse Pluggable Module Policy for the deployment provisioning lifecycle with vRA’s EBS'.
4. Update the Cloud Template to add in necessary vRA Properties and/or add in the Custom Resource to invoke OneFuse Pluggable Module Policies.
5. Deploy the Cloud Template to provision a vRA Deployment and run provisioning scenarios for the Pluggable Module Policy.
6. Destroy the vRA Deployment to run deprovision for the Pluggable Module Policy, if any.

Update the Cloud Template

1. Log in to vRA > Cloud Assembly
2. Select the Design tab from the top menu bar
3. Select the Cloud Templates tab from the left menu
4. Edit the Cloud Template and perform the below:

Option 1: add in necessary vRA properties

The following vRA Properties need to be added to the Cloud Template’s Code section under the Resource(s) of interest.

1. Trigger vRA EBS for Pluggable Module:

Option 1. Trigger only specific individual EBS state(s):

• OneFuse_PluggableModulePolicy_Trigger_<EBSExecutionString>
• Replace <EBSExecutionString> with an appropriate Event Broker Subscription

OR:

Option 2. Trigger all EBS state(s):

(This overrides the individual EBS Execution triggers if they are present.):

• OneFuse_PluggableModulePolicy_Trigger

Example YAML:

# <EBSExecutionString> is replaced with ComputeProvisionPostLate

# -- Property Name
# <CustomID> is replaced with 001F5

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <Pluggable Module Policy Name> is prod
# <Pluggable Module Label> is F5

name: Simple Example
resources:
  Cloud_Machine_1:
    type: Cloud.Machine
    properties:
      image: CentOS7
      flavor: small
      count: 1
      OneFuse_PluggableModulePolicy_Trigger_ComputeProvisionPostLate: 'true' # Trigger Property
      OneFuse_PluggableModulePolicy_ComputeProvisionPostLate_001F5: 'onefuse:prod:F5'

2. Call Pluggable Module Policy for a vRA EBS:

• Replace <EBSExecutionString> with an appropriate Event Broker Subscription
• Replace <CustomID> with a unique, user-defined friendly label
• <Pluggable Module Label> is a friendly label for the Pluggable Module
  • Format is alphanumeric characters only A-Z, a-z, 0-9. No spaces, underscores, hyphens nor special characters.
  • Does not need to match the actual Pluggable Module’s name.

Example YAML:

# Example CustomID with sorting

001Apache
002WebApp
003BackupClient

Pluggable Module EBS Execution states

EBSExecutionString refers to a specific vRA EBS State for the OneFuse Module’s policy to execute on.

Replace <EBSExecutionString> with one of the following EBS Execution State values:

List of vRA EBS Trigger Properties:

# <EBSExecutionString> is replaced with ComputeProvisionPostLate

# -- Property Name
# <CustomID> is replaced with 001F5

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <Pluggable Module Policy Name> is prod
# <Pluggable Module Label> is F5

name: Simple Example
resources:
  Cloud_Machine_1:
    type: Cloud.Machine
    properties:
      image: CentOS7
      flavor: small
      count: 1
      OneFuse_PluggableModulePolicy_Trigger_ComputeProvisionPostLate: 'true' # Trigger Property
      OneFuse_PluggableModulePolicy_ComputeProvisionPostLate_001F5: 'onefuse:prod:F5'

CustomID

CustomID refers to a user-specified text string to identify and can set an order of precedence for execution when calling multiple Policies for the OneFuse Module in the same vRA EBS State.

Replace <CustomID> with a unique custom identifier:

• Format is alphanumeric characters only A-Z, a-z, 0-9. No spaces, underscores, hyphens nor special characters.
• Must be unique across all EBS Execution Strings for the OneFuse Module on the specific VM for the Blueprint/Cloud Template.
• Is reusable either between different VM components of the Blueprint/Cloud Template canvas or between different Blueprints/Cloud Templates.

# <EBSExecutionString> is replaced with ComputeProvisionPostLate

# -- Property Name
# <CustomID> is replaced with 001F5

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <Pluggable Module Policy Name> is prod
# <Pluggable Module Label> is F5

name: Simple Example
resources:
  Cloud_Machine_1:
    type: Cloud.Machine
    properties:
      image: CentOS7
      flavor: small
      count: 1
      OneFuse_PluggableModulePolicy_Trigger_ComputeProvisionPostLate: 'true' # Trigger Property
      OneFuse_PluggableModulePolicy_ComputeProvisionPostLate_001F5: 'onefuse:prod:F5'

Specify sorting with CustomID:

When executing multiple different OneFuse Module’s Policies in the same EBS State, prefix the <CustomID> with a numeric value (for example 001, 002, etc).

The <CustomID> is sorted prior to executing the OneFuse module’s policies.

# Example CustomID with sorting

001Apache
002WebApp
003BackupClient

Additional helpful vRA Properties

Purpose: Relate OneFuse Policy executions from different OneFuse Modules together with a Tracking ID.

Purpose: Reference a specific NIC’s values to get hostname, IP Address, etc.

• Replace <#> with a number from 0 to 9, one for each NIC. For most use cases, NIC 0 is the primary network interface.
• Replace <value> with an appropriate key: dnsSuffix, fqdn, gateway, hostname, ipAddress, macAddress, netmask, network, subnet, target
• target will be the FQDN when a DNS Suffix is provided; otherwise, it will be the hostname without domain.

Example Cloud Template YAML

# <EBSExecutionString> is replaced with ComputeProvisionPostLate

# -- Property Name
# <CustomID> is replaced with 001F5

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <Pluggable Module Policy Name> is prod
# <Pluggable Module Label> is F5

name: Simple Example
resources:
  Cloud_Machine_1:
    type: Cloud.Machine
    properties:
      image: CentOS7
      flavor: small
      count: 1
      OneFuse_PluggableModulePolicy_Trigger_ComputeProvisionPostLate: 'true' # Trigger Property
      OneFuse_PluggableModulePolicy_ComputeProvisionPostLate_001F5: 'onefuse:prod:F5'

Option 2: Add in Custom Resource for OneFuse Pluggable Module

• From the Resource Types navigation, expand Custom Resources
• Drag-and-drop OneFuse:PluggableModule_v1 to the canvas
• In the Code tab, provide values for the following properties:

Pluggable Module specific parameters:

Provision

Deploy a Cloud Template with OneFuse Pluggable Module Policy configured. Pluggable Module’s provisioning scenarios will run.

Outputs

The following vRA Property will have the generated OneFuse Pluggable Module Managed Object as a JSON string on the Deployment.

Deprovision

Destroy an existing deployment with OneFuse Pluggable Module Policy configured. The Pluggable Module Policy’s deprovisioning scenarios (if any) will run.

vRA EBS

List of vRA EBS Trigger Properties:

# <EBSExecutionString> is replaced with ComputeProvisionPostLate

# -- Property Name
# <CustomID> is replaced with 001F5

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <Pluggable Module Policy Name> is prod
# <Pluggable Module Label> is F5

name: Simple Example
resources:
  Cloud_Machine_1:
    type: Cloud.Machine
    properties:
      image: CentOS7
      flavor: small
      count: 1
      OneFuse_PluggableModulePolicy_Trigger_ComputeProvisionPostLate: 'true' # Trigger Property
      OneFuse_PluggableModulePolicy_ComputeProvisionPostLate_001F5: 'onefuse:prod:F5'

Troubleshooting

Troubleshoot in vRealize Orchestrator.

1. Log in to vRealize Orchestrator.
2. Turn on Verbose Logging and try again to see additional log messages in vRO Workflows:
   • Select Library > Workflows from the left menu
   • Go to: OneFuse > Pluggable Module > vRA8 to find corresponding workflow runs and view logs
   • Optionally, run the workflows in the Manual folder to manually test
3. Optionally, configure timeouts for EBS and/or Configure timeouts for OneFuse modules.

Additional resources:

• Review Troubleshooting in OneFuse
• Review VMware troubleshooting resources