Installation and setup on CloudBolt Documentation

Install OneFuse from OVA

Mon, 01 Jan 0001 00:00:00 +0000

Download the latest OneFuse OVA

OneFuse is distributed as a CloudBolt OVA file, which is an open standard for packaging VM images for easy installation.

Access CloudBolt’s Download Article for CMP/OneFuse 2023.5.

The article will always contain the latest Appliance link.

Log in with your CloudBolt Connect account.
Download CloudBolt OVA.

Requirements

Obtain and download the OneFuse license key.
- Purchase Key: Reach out to your CloudBolt Account Manager or our Customer Success team
Optionally, obtain SSL Certificate(s) for OneFuse.
Ensure your environment meets the following base requirements:
- A Virtualization Manager
  - VMware vSphere 6.0+
  - Citrix XenServer 6+
- Virtual Capacity for the Virtual Machine (VM)
  - 2 CPUs minimum
  - 8GB memory minimum
  - 50GB storage minimum
  - The initial VM will use 3GB if Thin Provisioned or 50GB if Thick Provisioned (recommended).

Deploy the OneFuse VM from OVA

Log in to your virtualization manager (for example VMware vSphere, Citrix XenServer).
Deploy the OVA as a Virtual Machine (VM).
- Resources: the VMware vSphere documentation on deploying an OVA, or Import VMs from OVA via Citrix XenCenter
Power on the newly created OneFuse VM.

Configure the OneFuse VM

OneFuse needs a few configuration items before you can access the web portal to continue your setup.

Setup and license OneFuse

Mon, 01 Jan 0001 00:00:00 +0000

Access the OneFuse UI

Once OneFuse is installed from OVA and deployed, verify the VM is running. A web user interface (UI) will be available.

Open a web browser (for example, Google Chrome).
Type in the OneFuse VM’s IP address or Fully Qualified Domain Name (FQDN) in the URL.
- For example, https://my-onefuse-instance-name.domain.com
When accessing the OneFuse UI for the first time, you will be prompted to License OneFuse.

License OneFuse

If you do not have a license key, contact your Account Manager or our Customer Success team.

Extend session timeout

Mon, 01 Jan 0001 00:00:00 +0000

For security purposes, the default timeout of API Tokens in OneFuse is 5 minutes.

When an API call is invoked in OneFuse UI, the session automatically extends. However, when the user remains on a particular page in OneFuse UI, the default timeout setting may be too short (for example, when creating or updating OneFuse Policies, Property Sets, and so on). Follow the instructions below to extend the session timeout for OneFuse API Tokens.

Upgrade OneFuse

Mon, 01 Jan 0001 00:00:00 +0000

Before you begin

Read the Release notes.
Back up your OneFuse instance by cloning the VM or taking a snapshot.

Upgrade OneFuse

There are two methods to upgrade OneFuse:

Option 1: Command Line
Option 2: Yum Repository

Option 1: Upgrade via the command line

OneFuse upgraders are distributed as .tgz archives.

The upgrader is designed to save customizations you have made and not lose information, but be sure to review the Release Notes for any changes that may affect your OneFuse instance.

Reference architecture

Mon, 01 Jan 0001 00:00:00 +0000

OneFuse and CloudBolt CMP are deployed together on the same CloudBolt appliance. Refer to the CloudBolt CMP documentation for appliance architecture details:

CloudBolt appliance reference architecture: overall appliance design
Appliance security: security hardening guidance
Hardware guidelines: CPU, memory, and storage sizing recommendations
Network connectivity: required network ports and connectivity
SSL with External PostgreSQL: configuring SSL when using an external database

High availability

Mon, 01 Jan 0001 00:00:00 +0000

OneFuse and CloudBolt CMP are deployed together on the same CloudBolt appliance. Refer to the CloudBolt CMP documentation for high-availability configuration:

Set up high availability
Upgrade with high availability

Backup and restore

Mon, 01 Jan 0001 00:00:00 +0000

Back up the OneFuse appliance

The steps below assume a single OVA instance. If you use an HA setup, adapt these steps to restore the necessary files and database to the appropriate locations.

Any backup tool or strategy of the Enterprise can be used for the OneFuse appliance.

The critical data needed from the appliance are as follows:

Create a backup of the cloudbolt database:

PostgreSQL:

# Execute the following command on the appliance
# Replace '/tmp/' with the desired directory

export PGPASSWORD=${postgresql_pass}
pg_dump -h localhost -p 5432 -U cb_dba -w --clean -F t -f /tmp/cloudbolt.tar cloudbolt

# The database will get backed up to the /tmp folder as file name: cloudbolt.tar

Create a backup of the following directories:

Path	Location (for non-monolithic installs)
`/var/opt/cloudbolt`	All nodes
`/var/log/cloudbolt/jobs`	All nodes running Job Engine role
`/var/www/html/cloudbolt/static`	All nodes running Web Server role