For AI agents: the complete documentation index is available at https://docs.us.ovhcloud.com/en/llms.txt, the full documentation bundle is available at https://docs.us.ovhcloud.com/en/llms-full.txt, and this page is available as Markdown at https://docs.us.ovhcloud.com/en/hosted-private-cloud/nutanix-on-ovhcloud/hycu-backup.md.
  • English

Configuring HYCU backup

View as Markdown
Warning

NOTE: OVHcloud provides services for which you are responsible for their configuration and management. You are therefore responsible for their proper functioning.

This tutorial is designed to help you as much as possible with common tasks. If you are having difficulty performing these actions, please contact a specialized service provider. OVHcloud cannot provide you with technical support in this regard.

 

Requirements

 

Topics

 

Instructions

Install and configure HYCU

Adding the HYCU installation image

Log in to Prism Central (see this guide for instructions).

From the main menu ☰, under Compute & Storage click Images menu.

Then, click Add Image.

HYCU backup - step 1

  1. Choose URL as the source type, enter the download URL for the latest version, and click Upload file.

    Warning

    NOTE: The latest version can be found on the HYCU support page in the Downloads section. If you do not have access to this area, you can create a ticket for the OVHcloud Support team, who will retrieve the image for you.

  1. In the Name field, remove the .qcow2 extension behind the name, but leave hycu-X.X.X-XXXX. Enter a description and click Next.

    Warning

    NOTE: It is important to remove the extension in the name to facilitate the HYCU configuration process.

  1. Click Save to import the image.

    HYCU backup - step 2

 

Configure the Data Services IP

Click the gear icon [action]⚙️[/action] in the upper-right corner.

-image-

Select [action]Cluster Details[/action] from the left navigation menu.

-image-

Enter an unused private IP address in the Data Services IP field and click [action]Save[/action].

-image-

Confirm your choice in the pop-up window.

-image-

 

Adding a user account in Prism Element for HYCU

New local users can be added from the Prism Element interface.

Click here for full instructions.

On the Prism Central dashboard, click the cluster name in the Cluster Quick Access section to go to the Prism Element.

HYCU backup - step 6

Click the gear ⚙️ to go to Settings.

HYCU backup - step 12

Scroll down the menu and click Local User Management.

Click + New User.

HYCU backup - step 5

Enter these values:

  • Username: svc_hycu
  • First Name: HYCU
  • Last Name: HYCU
  • Email: hycu@example.com
  • Password: password
Info

This information is provided as an example; the email address is mandatory but is not used.

Select the Cluster Admin checkbox and click Save.

HYCU backup - step 15

You will see your newly created user on the Local User Management screen.

HYCU backup - step 16

 

Creating the virtual machine for HYCU

You can create a virtual machine for HYCU from the Prism Central interface.

Click here for full instructions.

From the main menu ☰, under Compute & Storage, click VMs.

Then, click Create VM.

HYCU backup - step 8

Name the virtual machine and change the properties of the virtual machine with these settings:

  • CPU: 4 vCPU
  • Cores Per CPU: 2 Cores
  • Memory: 8GB

Click Next.

HYCU backup - step 19

Click Attach Disk.

HYCU backup - step 20

Enter these values:

  • Type: Disk
  • Operation: Clone from Image
  • Image: hycu-X.X.X-XXXX
  • Capacity: 20 GB

Click Save.

HYCU backup - step 11

Click Attach Disk.

HYCU backup - step 22

Choose these options:

  • Type: Disk
  • Operation: Allocate on Storage Container
  • Image: storage-container
  • Capacity: 50GB

Click Save.

HYCU backup - step 13

Click Attach to Subnet.

HYCU backup - step 24

Select the infra network from the Subnet drop-down menu, and select Connected in the Network Connection State drop-down menu. Then click Save.

HYCU backup 15 - HYCU backup - step 2

Click Next.

HYCU backup - step 26

Create a yaml file by editing these values:

  • <IP address>: An unused IP address with the subnet mask, in the format: [code]XX.XX.XX.XX/XX[/code].
  • <GATEWAY>: Local gateway for the virtual machine to access the Internet.

[primary]You can find this in your list of virtual machines. Hover over the IP Address of your OVHgateway VM and use the second address listed, ending in [code].254[/code].

  • <DNS>: DNS used on the Internet, such as 8.8.8.8
#cloud-config
bootcmd:
- /opt/grizzly/bin/cloud_init_setup.sh hycubc <IP address> <GATEWAY> <DNS> `hycu.local,ntnx.local`

Modify Guest Customization options by selecting Cloud-init (Linux) in the Script Type drop-down menu. Select Custom Script in the Configuration Method drop-down menu.

Copy the contents of the yaml script and paste it into the field below Clear Script. Then click Next.

HYCU backup - step 27

Click Create VM.

HYCU backup - step 28

Select the virtual machine created by using the checkbox ☑️ to the right of the virtual machine.

HYCU backup - step 29

ClickActions and select Power On.

HYCU backup - step 30

The virtual machine is started and has the IP address defined in cloud-init.

HYCU backup - step 31

 

Configuring HYCU URL redirection to public network

In this section, we will configure a redirection so that you can configure HYCU using the web interface from outside your cluster.

Click here for full instructions.

In the OVHcloud Control Panel, navigate to your Load Balancer via the Network menu.

Info

If you are not using the beta version of the OVHcloud Control Panel, you can find the Load Balancer area through the Bare Metal Cloud or Hosted Private Cloud sections.

In the Server clusters tab, click Add a server cluster.

Server cluster tab empty

Name your server cluster, then select TCP and enter this information:

  • Port: 8443
  • Datacenter: ALL

Click Add to confirm the server farm creation.

Tutorial add server cluster

Click Add a server.

Tutorial server list

Enter these values:

  • Name (optional): VM-HYCU
  • IPv4 address: The IP address of the VM you created in the previous step.
  • Port: 8443

Click Add to confirm the cluster creation.

Tutorial add server

Next, click on the Front-ends tab, and Add a front-end.

Frontends empty - HYCU backup

Name your front-end, choose the TCP protocol, and modify these values:

  • Port: 8443
  • Datacenter: ALL
  • Default server cluster: HYCU (TCP)

Click Add.

Tutorial add frontend

Click Apply configuration in the yellow banner at the top of the page.

Select the checkbox for your datacenter and click Apply configuration.

Apply configuration page

In the Tasks tab, you can track the progress of applying the changes.

Tasks - HYCU backup

 

Configuring HYCU

Connect with a web browser to the HYCU administration interface using the IP address of the Load Balancer service you just configured and the port for your server cluster, which should be similar to XXX.XXX.XXX.XXX:8443. The fqdn variable corresponds to the URL provided when the Nutanix cluster was created.

Click here for full instructions.

Enter the default password (admin) and click Sign In.

HYCU backup 31 - HYCU backup - step 2

Change the login password for more security.

Click Change Password in the admin menu in the top right-hand corner of the interface.

Enter the default password in the OLD PASSWORD field, and the new password in the PASSWORD and CONFIRM PASSWORD fields.

Then click Save.

HYCU backup - step 32

We will now connect HYCU to the Nutanix cluster.

Click the Settings ⚙️ icon in the top right corner and choose Sources.

HYCU backup - step 44

Enter information about Prism Element:

  • URL: https://url_prism_element_local:9440
  • USERNAME: Prism Element user
  • PASSWORD: Prism Element user password

Click Next.

HYCU backup - step 34

Enter this information about Prism Central:

  • URL: https://url_prism_central_local:9440
  • USERNAME: Prism Central user
  • PASSWORD: Prism Central password

Click Next.

HYCU backup - step 35

The VALIDATION SUCCESSFUL information appears to indicate that the entered information is correct. Click Save.

HYCU backup - step 36

Click Close.

HYCU backup - step 37

Select Targets from the left-hand menu and click + Add at the top of the interface.

HYCU backup - step 38

Enter the configuration settings and authentication keys for your Object Storage user with read/write access to the Object Storage bucket used as explained below:

  • name Name
  • Size: Storage size
  • Type: AWS S3/Compatible*
Warning

NOTE: OVHcloud High Performance Object Storage service has no storage limits and is billed on a per-use basis. In the HYCU software configuration, it is necessary to set a size as in the example below. You can choose another value.

Turn ENABLE COMPRESSION on and scroll down through the window.

HYCU backup - step 50

Complete the information:

  • SERVICE ENDPOINT: Object Storage Storage URL
  • BUCKET NAME: Bucket name
  • ACCESS KEY ID: Object Storage User Access Key
  • SECRET ACCESS KEY: Object Storage User Secret Key

Enable TARGET ENCRYPTION and click Save.

HYCU backup - step 40

The target is enabled for Nutanix cluster backups.

HYCU backup - step 41

 

Updating HYCU

HYCU regularly provides updates, for which we detail the process below.

Adding sources for a new version of HYCU

Click here for full instructions.

From the Prism Central main menu ☰, under Compute & Storage, click Images.

Then, click Add Image.

HYCU backup - step 42

Select URL.

Enter the URL for the qcow2 image of the latest version of HYCU, such as:

  • https://download.hycu.com/ec/v4.X.X/hotfixes/4.X.X-XXXX/hycu-4.X.X-XXXX.qcow2
Info

The URL used for the download is the latest version available on the HYCU website.

Click Upload file.

HYCU backup - step 43

Remove the extension .qcow2 behind the name hycu-'4.X.X-XXXX, enter a description, and click Next.

Warning

NOTE: It is important to remove the extension in the name to facilitate the HYCU update process.

HYCU backup 44 - HYCU backup - step 2

Click Save to import the image.

HYCU backup - step 45

 

Running the update from HYCU

Click here for full instructions.

Log in via the URL provided when you created the Nutanix cluster, replacing the port https://fqdnclusternutanix:8443.

Go to the HYCU configuration by clicking the Settings ⚙️ icon and choose Power Options.

Select Suspend All, check AUTO RESUME AFTER and leave the Hours field at 1, then click Save.

HYCU backup - step 46

Click Software Upgrade from the Settings ⚙️ menu .

Choose the latest version from the AVAILABLE VERSIONS drop-down menu and click Software Upgrade.

Click Yes to start the update process.

HYCU backup - step 47

A backup copy is made during the update process so that it can be restored if there are any issues.

HYCU backup - step 63

Click the Settings ⚙️ icon and click Power Options.

Uncheck 🔲 Suspend All and click Save.

HYCU backup - step 49

 

Configuring backups in HYCU

Setting up VM login passwords

Virtual machine login passwords enable backup of applications, such as a Microsoft SQL database or Exchange server.

Click here for full instructions.

Log in via the Virtual Machines menu on the left and click the Credentials 🔑 button at the top right of the interface.

HYCU backup - step 70

Click the Add + button.

HYCU backup - step 51

Enter these values:

  • NAME: password storage name
  • PROTOCOL: AUTOMATIC
  • USERNAME: virtual machine user account
  • PASSWORD: password

Click Save.

HYCU backup - step 52

Click the Add + button to add another account.

HYCU backup - step 53

Enter these values:

  • NAME: password storage name
  • PROTOCOL: AUTOMATIC
  • USERNAME: virtual machine user account
  • PASSWORD: password

Click Save.

HYCU backup - step 54

Click Close.

HYCU backup - step 55

Select the virtual machines that will use a password by ticking the box to the right of the virtual machine, then click the Credentials 🔑 button.

HYCU backup - step 56

Select the password you want to use and click Assign.

HYCU backup - step 57

Select another virtual machine that will use a password by ticking the box to the right of the virtual machine, then click the Credentials 🔑 button.

HYCU backup - step 58

Select the password you want to use and click Assign.

HYCU backup - step 60

 

Creating backup policies

Click here for full instructions.

Go to the Policies menu on the left and click the Add + button in the top right corner.

HYCU backup - step 61

Enter this information:

  • NAME: HYCU VM
  • BACKUP EVERY: 4 hours
  • BACKUP THRESHOLD: 42

Leave the BACKUP option checked and use the scroll bar on the right.

Click Save.

HYCU backup - step 62

This policy is created for the HYCU virtual machine.

In the Policies menu, click the Add + button in the top right corner.

HYCU backup 63 - HYCU backup - step 2

Set the policy name BACKUP to Object Storage OVHcloud and local SNAPSHOTS in the NAME field.

Check ☑️ the FAST RESTORE option and leave the BACKUP option checked.

Change the backup options in Backup and change the BACKUP THRESHOLD value to 25. Then scroll down the page.

HYCU backup - step 64

Edit the Fast restore option with your settings and click Save.

HYCU backup - step 65

This strategy makes a backup on OVHcloud Object Storage and also takes snapshots inside the Nutanix cluster, allowing for faster recovery.

 

Assigning backup policies

Click here for full instructions.

Select all VMs via the check box next to NAME, then click the shield-shaped Policies button in the top right to assign a policy to all VMs.

HYCU backup - step 66

Choose the Exclude policy and click Assign.

HYCU backup - step 67

Select the HYCU virtual machine by selecting the check box next to it, then click the Policies button to assign a policy to this virtual machine.

HYCU backup - step 88

Choose the HYCU VM policy and click Assign.

HYCU backup - step 69

Select four virtual machines and click the Policies button to assign a policy.

HYCU backup - step 90

Choose the BACKUP to Object Storage OVHcloud and local SNAPSHOTS policy and click Assign.

HYCU backup - step 71

 

Monitoring backup status

Go to the Dashboard menu on the left to view the dashboard and view the backup status.

HYCU backup - step 92

Open the Jobs menu on the left to view the job status.

HYCU backup - step 93

 

Restoring from HYCU

Use the Virtual Machines menu and click a backed-up virtual machine.

HYCU backup - step 74

 

Restoring a virtual machine

Click here for full instructions.

Click the Restore VM button in the bottom right-hand corner.

HYCU backup - step 75

Select Restore VM and click Next.

HYCU backup - step 76

Leave the default options and click Restore.

HYCU backup - step 77

The virtual machine is fully restored.

 

Retrieving a file

Click here for full instructions.

Click the Restore files button in the bottom right-hand corner.

HYCU backup - step 78

Leave AUTOMATIC in the RESTORE FROM drop-down menu and click Next.

HYCU backup - step 79

Select the file to restore and click Next.

HYCU backup - step 80

Leave the default options and click Next.

HYCU backup - step 81

Choose Rename restored and click Restore.

HYCU backup - step 82

The restored file is located inside the virtual machine with a new name so as not to delete the old file.

 

Restoring an application

Click here for full instructions.

Click the Applications menu and then choose an application to restore by clicking an application below Name.

HYCU backup - step 103

Click the Restore button in the bottom right-hand corner.

HYCU backup - step 104

Select Restore databases and click Next.

HYCU backup - step 85

Choose a database and click Next.

HYCU backup - step 86

Disable OVERWRITE EXISTING DATABASES and click Restore.

HYCU backup - step 87

The database is restored into a new database.

 

Go further

Browse all the Nutanix guides.

Browse the rest of the OVHcloud US documentation for guides on our other products and services.

Learn more about Nutanix on OVHcloud on the OVHcloud US website.

If you need training or technical assistance to implement our solutions, contact your sales representative or click on this link to get a quote and ask our Professional Services experts for a custom analysis of your project.

*S3 is a trademark filed by Amazon Technologies, Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies, Inc.