Naming
4 minute read
To learn more about this OneFuse module, refer to Naming.
Prerequisites
- Configure OneFuse Property Set(s) and OneFuse Module Policies.
- Run OneFuse Configuration per Cloud Assembly Organization.
- Review an overview on OneFuse modules with Aria Automation 8.1+/Cloud.
- Create a new Cloud Template (if none exist) or determine which existing Cloud Template(s) will utilize this OneFuse Module.
Steps
- Know the name of the OneFuse Endpoint created via OneFuse Configuration.
- Determine which OneFuse Naming Policy to run for this Cloud Template.
- Update the Cloud Template to add in the necessary vRA Property and/or add in the Custom Resource to invoke a OneFuse Naming Policy.
- Deploy the Cloud Template to provision a vRA Deployment and generate a name.
- Destroy the vRA Deployment to destroy the vRA Deployment and name.
Update the Cloud Template
- Log in to vRA > Cloud Assembly
- Select the Design tab from the top menu bar
- Select the Cloud Templates tab from the left menu
- Edit the Cloud Template and perform the below:
Option 1: Add in necessary vRA property
The following vRA Property needs to be added to the Cloud Template’s Code section under the Resource(s) of interest.
Call a Naming Policy:
| Property Name Format | Property Value Format |
|---|---|
OneFuse_NamingPolicy |
'<OneFuse Endpoint Name>:<Naming Policy Name>' |
Example YAML:
# Execute OneFuse Naming Policy
# -- Property Value
# <OneFuse Endpoint Name> is onefuse
# <Naming Policy Name> is global
name: Simple Example
resources:
Cloud_Machine_1:
type: Cloud.Machine
properties:
image: CentOS7
flavor: small
count: 1
OneFuse_NamingPolicy: 'onefuse:global'
Optional. Request additional names (2022.0.0 Build 17166779)
Support for requesting Additional Naming objects from one VM (for example, naming installed components in the VM or naming the additional IPAM and DNS objects being requested alongside them). The additional Names are reserved and stored in both OneFuse and vRA Machine Properties for future reference in vRA lifecycles.
| Property Name Format | Property Value Format |
|---|---|
OneFuse_NamingPolicy_Additional_<CustomID> |
'<OneFuse Endpoint Name>:<Naming Policy Name>' |
- Replace
<CustomID>with a unique, user-defined friendly label. - To name the additional IPAM and/or DNS objects being requested with the VM, replace
<CustomID>with the matching value for<niclabel>defined for IPAM and/or DNS Additional properties.
Example vRA Custom Property (in key: value pair format)
# -- Property Value
# <OneFuse Endpoint Name> is onefuse
# <OneFuse Naming Policy Name> is global
# Will name Component 01 with Naming Policy 'component'
# Will name additional IPAM and DNS objects that have <niclabel> = 'xyz' with Naming Policy 'xyz'
# Example
OneFuse_NamingPolicy: onefuse:global
OneFuse_NamingPolicy_Additional_xyz: onefuse:xyz
OneFuse_NamingPolicy_Additional_component01: onefuse:component
Example Cloud Template YAML code
# Execute OneFuse Naming Policy
# -- Property Value
# <OneFuse Endpoint Name> is onefuse
# <Naming Policy Name> is global
name: Simple Example
resources:
Cloud_Machine_1:
type: Cloud.Machine
properties:
image: CentOS7
flavor: small
count: 1
OneFuse_NamingPolicy: 'onefuse:global'
Option 2: Add in Custom Resource for OneFuse Naming
Review OneFuse custom resources before using this method.
- From the Resource Types navigation, expand Custom Resources
- Drag-and-drop
OneFuse:Name_v1to the 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. |
Provision
Deploy a Cloud Template with OneFuse Naming Policy configured. A unique name will generate for the resource(s).
Outputs
The following vRA Property will have the generated OneFuse Name Managed Object as a JSON string on the Deployment.
| Property Name | Property Value Format |
|---|---|
OneFuse_Naming |
JSON string of OneFuse Name Managed Object |
Deprovision
Destroy an existing deployment with OneFuse Naming Policy configured. The name will be removed from OneFuse Managed Names inventory.
vRA EBS
| EBS Execution | Subscription State | EBS Priority | EBS Name |
|---|---|---|---|
| Provision | |||
| ComputeAllocationPre | Early | 1150 | OneFuse_Provision_Naming |
| Deprovision | |||
| ComputePostRemoval | - | 1500 | OneFuse_De-Provision_Naming |
Troubleshooting
Troubleshoot in vRealize Orchestrator.
- Log in to vRealize Orchestrator.
- 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 > Naming > vRA8 to find corresponding workflow runs and view logs
- Optionally, run the workflows in the Manual folder to manually test
- Optionally, configure timeouts for EBS and/or Configure timeouts for OneFuse modules.
Additional Resources:
- Review Troubleshooting in OneFuse
- Review VMware troubleshooting resources