Installation and setup
6 minute read
New install requirements
Perform once for first initial install. Upgrading? Skip to Upgrade to the latest.
- Review Getting started for prerequisites.
- Create a OneFuse service account for vRealize Automation 8x with least permissions
- Log in to
https://{MY-VRA-INSTANCE}/csp/gateway/portal/#/consumer/usermgmt/ad-groups/assign-roles - Select the Enterprise Groups tab.
- Select Assign Roles.
- Search and select the AD group containing the service account to be used for the OneFuse integration.
- Designate the group at minimum: Organizational Member.
- Select the [+ Add Service Access] button twice.
- Assign the following VMware Service Roles to the user:
- Orchestrator with roles Orchestrator Administrator
- Cloud Assembly with roles Cloud Assembly Administrator
- *To learn more, visit vRealize Orchestrator Roles and Groups.
- Log in to
- If using vRA Cloud, generate the vRA Cloud API Token with least permissions:
- Log in to vRA Cloud Assembly.
- Select your name in the top-right menu > select My Account (under User Settings).
- Select the API Tokens tab.
- Select Generate a New API Token.
- In the Generate a New API Token form:
- Enter the token name and define the token TTL.
- For Define Scopes, two roles are required:
- The role Organization Member is required:
- In the Organization Roles column on the right, scroll down and expand All Organization Roles.
- Check the checkbox for Organization Member.
- The role Cloud Assembly Administrator is required:
- In the Service Roles column on the right, scroll down and expand VMware Cloud Assembly.
- Check the checkbox for Cloud Assembly Administrator.
- The role Organization Member is required:
- Select Generate.
- Save the API Token to be used later during Run the OneFuse Configuration Workflow.
- Follow instructions below to:
Upgrade to the latest
Follow instructions below to get the latest features for OneFuse + VMware’s vRealize Automation.
- Download the latest OneFuse vRealize Orchestrator Workflow Package
- Import the OneFuse vRealize Orchestrator Workflow Package
- Run the OneFuse Configuration Workflow
Download the latest OneFuse vRealize Orchestrator workflow package
OneFuse integration with VMware’s vRealize Automation is distributed as a vRealize Orchestrator Package for easy install and upgrades.
Access CloudBolt’s Download Article for CMP/OneFuse 2023.5.
The article will always contain the latest OneFuse vRO Package download link.
- Log in with your CloudBolt Connect account.
- Download the OneFuse vRO Package.
Import the OneFuse vRealize Orchestrator workflow package
For a new install and upgrades, perform the following to import the latest OneFuse vRealize Orchestrator Workflow Package.
If the OneFuse vRealize Orchestrator Plug-in was previously installed for OneFuse v1.0/1.0.1, remove the plugin before installing the OneFuse vRO Package.
VMware Docs: Delete a Plugin for vRA 8x and Uninstall a Plug-in for vRA 7.6.
- Log in to vRealize Orchestrator.
- Select Assets > Packages.
- Select Import:
-
Select Browse.
-
Select the OneFuse vRealize Orchestrator Workflow Package (
.package) to upload. -
Select Open.
-
Review the imported package information.
You might be prompted to indicate that you trust the publisher certificate of the source vRealize Orchestrator instance before you can import the file.
-
Select Import.
-
- Verify the OneFuse vRealize Orchestrator Workflow Package successfully imported:
io.cloudbolt.onefuseis listed in the list of Packages under Assets > Packages.
Resource: Import a Package in the vRealize Orchestrator Client
Run the OneFuse Configuration Workflow
Create the vRA Endpoint, OneFuse Endpoint, and Event Broker Subscriptions for OneFuse quickly in one workflow.
- Log in to vRealize Orchestrator.
- Select Library > Workflows from the left menu.
- Go to the following workflow via treeview: Workflows > OneFuse > Configuration > OneFuse Configuration.
- Select the Workflow: OneFuse Configuration > select Run.
- Fill out the form fields.
- Select the [Run] button.
- Verify the workflow completed successfully.
OneFuse Configuration form fields
| Field label | Description |
|---|---|
| vRA Endpoint | |
| vRA Version | Select the appropriate vRA Version. |
| vRA Appliance FQDN | (Shown when vRA Version is vra7 or vra8) Enter the vRealize Automation host in FQDN format. |
| vRA Cloud API FQDN | (Shown when vRA Version is vrac) Enter the vRealize Automation Cloud in FQDN format. |
| vRA Username | (Shown when vRA Version is vra7 or vra8) Username for OneFuse service account for vRA in UPN format. |
| vRA Password | (Shown when vRA Version is vra7 or vra8) Password for user account. |
| vRA Appliance Port | (Shown when vRA Version is vra7 or vra8) Enter the port number for this vRA Endpoint. |
| vRA 7.x Tenant | (Shown when vRA Version is vra7) vRA Tenant Name is case sensitive. Enter the vRA 7.6 Tenant Name. |
| vRA Cloud API Token | (Shown when vRA Version is vrac) Enter the vRA Cloud API Token. |
| vRA Endpoint - Settings | |
| Ignore Certificate Warnings? | Check yes to silently accept the certificate. |
| Verify whether the target hostname matches the names stored inside the server’s X.509 certificate | Check yes if the target hostname matches the names stored inside the server’s X.509 certificate. |
| Use Proxy? | Check yes if using a proxy. |
| Proxy Host FQDN / IP | (Shown when Use Proxy? is Yes) Enter the proxy host in FQDN or IP address format. |
| Proxy Port | (Shown when Use Proxy? is Yes) Enter the port number for this proxy host. |
| Create a new OneFuse Endpoint | |
| Create OneFuse Endpoint? | Select yes if running this workflow for the first time. |
| OneFuse Endpoint Name | Friendly label or name for this OneFuse Endpoint. |
| OneFuse FQDN | Enter the OneFuse instance host in FQDN or IP address format. |
| OneFuse Username | Username with Workspace Admin or Member role. |
| OneFuse Password | Password for user account. |
| OneFuse Port | Enter the port number for this OneFuse Endpoint. |
| Ignore Certificate Warnings? | Check yes to silently accept the certificate. |
| Verify whether the target hostname matches the names stored inside the server’s X.509 certificate | Check yes if the target hostname matches the names stored inside the server’s X.509 certificate. |
| Use Proxy? | Check yes if using a proxy. |
| Proxy Host FQDN / IP | (Shown when Use Proxy? is Yes) Enter the proxy host in FQDN or IP address format. |
| Proxy Port | (Shown when Use Proxy? is Yes) Enter the port number for this proxy host. |
- Go to: Library > Workflows > OneFuse > Endpoints.
- Within the OneFuse and vRA folders, there is a Manual folder.
- Run the respective Verify [OneFuse|vRA] Endpoint Connection workflow.
- Verify the workflow ran successfully.
If any failures occur, verify the credentials provided and/or turn on Verbose Logging and re-run the workflow(s).
Managing endpoints
When credentials and/or endpoints are updated, use the workflows below to update endpoints previously configured.
vRA Endpoint
Only one vRA Endpoint may exist at a given time.
To update the existing vRA Endpoint, run the OneFuse Configuration Workflow and select Update vRA Endpoint.
- The OneFuse Configuration workflow can run multiple times.
OneFuse Endpoints
Multiple OneFuse Endpoints may exist at any given time.
- Go to: Library > Workflows > OneFuse > Endpoints > OneFuse.
- Run the appropriate workflows as desired: Create OneFuse Endpoint, Update OneFuse Endpoint, and Delete OneFuse Endpoint.
Configure timeouts for OneFuse modules
Module timeouts in VMware vRealize Orchestrator allow the user to set a time limit on asynchronous task execution. This type of timeout communicates between vRealize Orchestrator and OneFuse.
-
In the vRealize Automation console, select to open Orchestrator.
-
From the left menu, select Assets > Configurations.
-
From the Configurations page, search for Timeouts and select to open the configuration.
-
Select the Variables tab.
-
Select a Variable from the list and edit the Timeout value.
The timeout length for EBS should be greater than the module timeouts to ensure best performance.
“Other” is the default value if vRO cannot determine an appropriate module for the value.
Next steps
Start integrating with OneFuse modules.