Naming
3 minute read
To learn more about this OneFuse module, refer to the Naming configuration section.
Prerequisites
- Configure OneFuse Property Set(s) and OneFuse Module Policies.
- Install OneFuse XUI per CloudBolt CMP.
- Review an overview on OneFuse Modules with CloudBolt CMP.
- Create a new Blueprint (if none exist) or determine which existing Blueprint(s) will utilize this OneFuse Module. Resource: Blueprints.
Configure the Blueprint
- Know the name of the OneFuse Connection Info created via OneFuse XUI initial setup.
- Determine which OneFuse Naming Policy to run for this Blueprint.
- Update the Blueprint to add in necessary parameters to invoke a OneFuse Naming Policy.
- Deploy the Blueprint to provision a deployment and generate a name.
- Destroy the Deployment to destroy the name for resource(s).
Update the Blueprint
- Log in to CloudBolt CMP.
- If not already on the Catalog page, select Catalog from the main menu.
- Search and find the desired CloudBolt Blueprint.
- Edit the Blueprint by selecting the gear icon on the bottom-right of the Catalog Item.
Add in necessary parameters
The following parameters need to exist on the Blueprint.
Learn more about CloudBolt Parameters for: Blueprints, Environments, and Groups.
Call a Naming Policy:
| Parameter name format | Parameter value format |
|---|---|
OneFuse_NamingPolicy |
<OneFuse Connection Info Name>:<Naming Policy Name> |
Example parameter:
# Parameter Name (in blue) is separated from the Parameter value (in black) with the first colon (:)
# -- Parameter Value
# <OneFuse Connection Info Name> is onefuse
# <OneFuse Naming Policy Name> is global
# Example
OneFuse_NamingPolicy: onefuse:global
Additional helpful properties passed to OneFuse module
Purpose: Relate OneFuse Policy executions from different OneFuse Modules together with a Tracking ID.
| Property and Parameter | Value Format |
|---|---|
OneFuse_Tracking_Id |
A GUID (globally unique identifier) that links OneFuse Policy Executions and the resulting Managed Objects together for a given resource on a deployment. The first OneFuse Module Policy execution will populate this Parameter and it will be passed into other OneFuse Modules automatically. Learn more about OneFuse Tracking ID. |
When a Tracking ID is not provided, a Tracking ID gets generated for the Policy execution.
Purpose: Reference a specific NIC’s values to get hostname, IP Address, etc.
| Property Format | Example |
|---|---|
OneFuse_VmNic<#>.<value> |
See examples below |
Replace <#> with a number from 0 to 9, one for each NIC.
Replace <value> with an appropriate key: assignment, dnsServers, dnsSuffix, fqdn, gateway, hostname, ipAddress, label, mac, network, nicLabel, target
For most use cases, NIC 0 is the primary network interface and the target hostname is a Fully Qualified Domain Name (FQDN).
Examples:
OneFuse_VmNic0.dnsSuffixOneFuse_VmNic0.fqdnOneFuse_VmNic0.hostnameOneFuse_VmNic0.ipAddressOneFuse_VmNic0.target: when DNS Suffix is provided, will be the FQDN; otherwise, will be the hostname (without domain).
Purpose: Reference VM hardware information: cpu, memory, etc.
| Property Format | Example |
|---|---|
OneFuse_VmHardware.<value> |
See examples below |
Replace <value> with an appropriate key: cpuCount, memoryGB, memoryMB, platformUuid, powerState, totalStorageGB
Examples:
OneFuse_VmHardware.cpuCountOneFuse_VmHardware.memoryGBOneFuse_VmHardware.platformUuidOneFuse_VmHardware.powerStateOneFuse_VmHardware.totalStorageGB
Provision
Deploy a Blueprint with OneFuse Naming Policy configured. A unique name will generate for the resource(s).
Outputs
The following parameter will have the generated OneFuse Name Managed Object as a JSON string on the resource.
| Parameter name | Parameter value format |
|---|---|
OneFuse_Naming |
JSON string of OneFuse Name Managed Object |
Deprovision
Destroy an existing resource with OneFuse Naming Policy configured. The name will be removed from OneFuse Managed Names inventory.
Trigger points
| Job / process | Trigger point name | Run sequence | Plugin action name |
|---|---|---|---|
| Provision Server | Generated Hostname Overwrite | 1150 | OneFuse - Provision Naming |
| Delete Server | Post-Delete | 1500 | OneFuse - De-Provision Naming |