tina openstack agent

Tina for OpenStack Documentation

Tina 2021

Publication Number: ATN-GVA-PDF-EN-0521-REV1

Publication Date: May 2021

©2021 Atempo SAS. All rights reserved.

All names and products contained herein are the trademarks or registered trademarks of their respective holders.

The information contained herein is the confidential and proprietary information of Atempo SAS. Unauthorized use of this information and disclosure to third parties is expressly prohibited. This technical publication may not be reproduced in whole or in part, by any means, without the express written consent of Atempo SAS.

Atempo SAS23 Avenue Carnot91300 Massy - France

ContentsCHAPTER 1 - About Tina OpenStack Agent 1

Components 1Main Features 1

CHAPTER 2 - Configure the OpenStack Agent Application 2

CHAPTER 3 - Environment Variables 4

CHAPTER 4 - Restore & Archive Manager 6

CHAPTER 5 - Back Up 8Configure Backup Destinations 8Configure Virtual Machine Backups 8

Configure Infrastructure Backups 8Backup of Database Applications 8Backup Limitations 8Backup Selections 8

Perform a Backup 9

CHAPTER 6 - Restore 11Restore Combinations 11Perform a Restore 11

Tina OpenStack Agent i

CHAPTER 1 - About Tina OpenStack AgentThe OpenStack Agent is an application that runs on a host configured as a Tina agent or server. It allows Tina to backup and restore virtual machines from an OpenStack infrastructure. This can be useful for administrators who want to centralize backups without having to install a Tina agent on each virtual machine (VM).

This document contains all the information to create the OpenStack application necessary to communicate with the virtualization infrastructure.

ComponentsThe OpenStack application consists of the following components: • A Generic Virtualization Agent (GVA). • An adapter to allow the GVA to communicate with the virtualization infrastructure.

The following diagram illustrates the mechanism (Figure 1):

Figure 1: Tina for OpenStack architecture

Main FeaturesThe main features of the Tina OpenStack Agent are:• Backup and restore of complete VMs (vault backup and restore).• Restore of individual components (e.g. a disk) of a VM to a file on the Tina agent.• Restore of individual components of the infrastructure (e.g. networks, images, and flavors).

1 Tina OpenStack Agent

About Tina OpenStack Agent

CHAPTER 2 - Configure the OpenStack Agent ApplicationThe OpenStack Agent application runs on a host configured as a Tina server or agent. No installation is required on either the virtualization infrastructure or the VMs.

Step 1: Create the OpenStack application

1. In the Tina admin console, select the host. 2. Select Platform > New > Application. The list of supported applications is displayed. 3. Select the OpenStack Virtualization Agent and click OK. The application properties are displayed

(Figure 2).

Figure 2: OpenStack application properties

4. Select the host name of the Tina server or agent to run the application.5. Enter the application name to identify the application.6. Enter the name or IP address of the virtualization server.7. Identify the virtualization server:

a. Type the virtualization username. This user must have administrator privileges on the virtualization infrastructure.

b. Enter and confirm the virtualization password.

Tina OpenStack Agent 2

Configure the OpenStack Agent Application

8. Identify the host that runs the application: a. Enter the local username.b. Enter and confirm the password.

9. Configure mandatory and, if needed, optional environment variables (Table 1).10. If your OpenStack server listens on a port other than the default (5000), specify the port number in

TINA_GVA_PORT.11. OpenStack supports a wide range of filters, documented under https://docs.openstack.org/api-

ref/compute/?expanded=list-servers-detail#list-servers. Use TINA_GVA_FILTER_VM to set any combination of those filters, formatted as a Python dict.

Example: Select running VMs whose name includes the string "compta"

TINA_GVA_FILTER_VM={ "name" : "compta", "vm_state" : "ACTIVE" }

As a special case, if the variable contains a simple string, it is used as the name filter. TINA_GVA_FILTER_VM=compta will select all VMs whose name includes the string "compta". This is equivalent to TINA_GVA_FILTER_VM={ "name" : "compta" }.

Note that, as described in the OpenStack documentation, this string is a regular expression, not a fixed string. It obeys the rules of the underlying database (typically MySQL or PostgreSQL).

12. Click OK to create the OpenStack Agent application.


Configure the OpenStack Agent Application

https://docs.openstack.org/api-ref/compute/?expanded=list-servers-detail#list-servers

https://docs.openstack.org/api-ref/compute/?expanded=list-servers-detail#list-servers

CHAPTER 3 - Environment VariablesThis list (Table 1) contains the mandatory and optional environment variables supported by the OpenStack Agent.

Environment Variable Description Status

TINA_APP_LIB_PATH

Automatically filled in by Tina when the application is created. Mandatory

TINA_GVA_OPENSTACK_PROJECT_ID

Specifies the OpenStack Project ID to be used for the connection. Mandatory

TINA_GVA_OPENSTACK_DOMAIN

Specifies the OpenStack Domain to be used for the connection. Mandatory

TINA_GVA_OPENSTACK_PROTOCOL

Specifies the OpenStack protocol. Possible values [Default] are http or [https]. If the protocol is set to https, you must also complete the variable OS_CACERT with the certificate file path.

Mandatory

TINA_GVA_PORT

If required, specifies the port number for communication between Tina and the virtualization infrastructure.

Optional

TINA_GVA_VIEW

Specifies the display format of the list of VMs. The only currently supported value is the default flat.

Optional

TINA_GVA_FILTER_VM

Selects only VMs that match the given filter. By default, all VMs are selected. The format depends on the virtualization infrastructure; details are given in the documentation for each Adapter.

Optional

TINA_GVA_REQUEST_SHORT_TIMEOUT

Specifies the maximum time allowed for the adapter to reply to a request which should complete rapidly (e.g. obtaining the list of VMs). The default time is 5 minutes.

Optional

TINA_GVA_REQUEST_LONG_TIMEOUT

Specifies the maximum time allowed for the adapter to reply to a request which may take longer to complete (e.g. snapshot creation). The default time is 2 hours.

Optional

TINA_GVA_ADAPTER_SHORT_TIMEOUT

Specifies the maximum time allowed for the virtualization infrastructure to reply to a request which should complete rapidly (e.g. obtaining the list of VMs). The default time is 30 seconds.

Optional

Table 1: Supported environment variables


Environment Variables

Environment Variable Description Status

TINA_GVA_ADAPTER_LONG_TIMEOUT

Specifies the maximum time allowed for the virtualization infrastructure to reply to a request which may take longer to complete (e.g. snapshot creation). The default time is 10 minutes.

Optional

TINA_GVA_ADAPTER_VERIFY_SSL

Set to true if the adapter should enforce SSL checking, or false to ignore SSL errors.

Optional

TINA_GVA_CRYPTO_ENABLED

Enables or disables encrypted communications with the adapter. Possible values [Default] are [yes] or no.

Optional

Table 1: Supported environment variables


Environment Variables

CHAPTER 4 - Restore & Archive ManagerOnce you have created the application, you should test the connection and parameters by launching Restore & Archive Manager. 1. Open Restore & Archive Manager. The authentication window is displayed.2. Enter your credentials and click OK.3. In the Restore & Archive Manager, click the + button. A meta-tree is displayed showing the Information

node and a list of VMs in the virtualization infrastructure. 4. Click the + button beside the Information node.

The information about the installation is displayed (Figure 3).

Figure 3: The Information node is expanded

The list of VMs is displayed as a “flat” or simple list. The Time Navigation displays in the present only the information node and the VMs (Figure 4).

Figure 4: VM list displayed in Restore & Archive Manager


Restore & Archive Manager

If you have performed backups and if you set the Time Navigator to display the past, the individual components of each VM will also be displayed (Figure 5):

Figure 5: VM components displayed in Restore & Archive Manager


Restore & Archive Manager

CHAPTER 5 - Back UpThis chapter explains how to back up a VM using Tina OpenStack Agent. Only full backups are supported.

Configure Backup DestinationsThe first step in setting up a backup configuration is to define a backup destination by adding a storage.

Configure Virtual Machine BackupsTo configure a new backup, you must declare a backup strategy on the agent and define a backup selection and schedule.

A strategy defines when Tina performs a backup of a system or application. There are up to 4 associated strategies, indicated by the letters A, B, C, and D.

Backup selections specify the directories to be backed up, as well as time phases and conditions under which directories are backed up. If no backup selection is defined, Tina cannot perform any backup.

To plan backups, the strategy includes a scheduler to define the day and time of full backups.

Configure Infrastructure BackupsYou can set a backup selection on the /Infrastructure node. This is useful if you want to back up the Flavors, Keypairs and Networks defined in the OpenStack infrastructure, independently of the VMs.

Backup of Database ApplicationsTo protect applications running on VMs, you must ensure that: • The application needs to be quiesced for the backup to succeed.• Any restore will be a complete restore of the VM. Indeed the backup of a third party database is a vault

backup. This means that if you back up an Exchange server located on a VM you cannot restore individual databases; you must restore the entire content of the VM. In addition, the Exchange databases will not receive the information that they have backed up, so log truncation may become an issue. If you need such features, you should use the Tina for Exchange Server application to back up your Exchange Server, or the Tina agent corresponding to your Windows Database application.

Backup LimitationsBefore backing up a VM, check the following limitations: • VSS Aware Applications on Virtual Machines The OpenStack environment backs up only the VM,

it does not perform any specific actions for the VSS aware applications inside a VM.• Virtual Machine Templates Backups of VM templates are not supported.• Synthetic Backups Synthetic backups are not supported.

Backup SelectionsBy default, a backup selection is set at the root of the application (i.e., /). Such a selection:• is associated with all the backup strategies.


Back Up

• is not filtered.• does not contain time phase exclusion.• does not compress nor encode data.

You may use the default backup selection to back up all the VMs in your virtualization infrastructure.

If you do not need to back up all the VMs, browse the meta-tree of the OpenStack Agent application and define your backup selection(s) on them individually.

Perform a BackupPerforming backups does not require the VM to be halted. Besides from the Backup Wizard that enables you to schedule the backups, you can manually start a backup at any time.

Step 1: Create backup strategies

1. In the Tina Admin Console, right-click an unused strategy for the GVA platform (Figure 6).

Figure 6: New standard backup strategy

2. Select New > Standard Strategy. The New Strategy window is displayed.3. In the Full tab, click Main to select a media pool for the backup. You can select additional pools in the

Multiple Writing Pools section.4. In the Incremental tab, repeat Step 3.5. If needed, define a backup schedule and set additional options in the Options and Advanced tabs. 6. Click OK to confirm your choices.

Step 2: Define backup selections and associate them with the appropriate strategies

1. Open Restore & Archive Manager to see the list of VMs. A green ball appears to the left of any directory which is already defined as a backup selection. Tina automatically places a backup selection at the root of the tree.

2. Right-click your VM from the list and select Backup Selection > New. The New Backup Selection window is displayed. An asterisk indicates the backup strategies which have been configured. By default, the selection is associated with all the backup strategies.

3. Clear the strategies you do not want to use. In this example (Figure 7), strategy B is used.

Figure 7: Strategy selection


Back Up

4. If needed, set other parameters, such as filters, time phases or properties. 5. Click OK to validate the selection. A green ball appears beside the VM name.

Step 3: Run the backup

If you have defined a backup schedule, Tina will launch backups automatically. Only full backups are possible.1. In the Tina Admin Console, right-click the strategy you created. 2. Select Full Session Now to launch the backup.


Back Up

CHAPTER 6 - RestoreOnce you have performed a backup, you can restore the following objects: • A VM. • One or more components of a VM (e.g. volumes, networks).• One or more components of the infrastructure (e.g. volumes, networks).

Restore CombinationsNot all combinations of object and destination are supported. These combinations are disabled in the restore options dialog (Figure 10).

To restore: • a single VM, no restrictions are applied.• multiple VMs, rename is not allowed.• a component of a VM, restore to the infrastructure is not allowed.• one or more infrastructure components, rename and auto-rename are not allowed. • from two or more of the above groups, all corresponding restrictions apply.• to the infrastructure, rename and auto-rename are not allowed.

Perform a RestoreStep 1: Select the components to restore

1. Open the Restore & Archive Manager.2. In the file meta-tree, select the VM you want to restore.3. Right-click the VM or the Infrastructure node and select Versions. The available versions are displayed

(Figure 8).

Figure 8: Available versions in time

4. Select the desired backup and click Synchronize. The file tree is updated. The list of all the objects required for the restore is displayed.

5. To check the list of components to be restored, click the + button beside the VM name (Figure 9).


Restore

Figure 9: List of components

6. Select the components to restore:• To restore the VM, select the box beside the VM name. It will automatically select all the files

required for the restore.Or • To restore individual components of the virtualization infrastructure, select the box beside those

components. You must also specify the destination path in the restore options dialog.7. Select Restore > Run. The restore options dialog is displayed (Figure 10).

Figure 10: Restore options dialog

Step 2: Configure the restore parameters

1. Click the Parameters tab and choose a restore destination: • Original location Restore the VM or the components to the infrastructure. This option is

available if you are restoring a component of a VM.Or • Local filesystem Restore the entire VM or individual components to a directory on the Tina host.

You must specify the destination path in the text box.


Restore

2. Select a restore option:• Cancel restore if VM exists.• Overwrite existing VM If a VM of the same name already exists, it will be overwritten.• Automatically rename VM If a VM of the same name already exists, Tina will attempt to find a

different name by appending a number to the name. You should set the maximum number of attempts. If Tina cannot find a new name, the restore will fail.

• Rename restored VM Restores the VM under a different name, specified in the text box.3. Enter a cache path for restore. If Tina needs to use a cache directory for the restore, it will use the path

specified here. By default, Tina will use TINA_HOME/Tmp.4. Click the Behavior tab to specify how Tina should react if a component cannot be restored:

• Skip this component and continue with the others.• Cancel the entire restore operation.• Ask the user what to do for each component. If you are restoring an entire VM to the virtualization infrastructure, you should choose Cancel, as all the components are required.

5. Specify what Tina should do if cartridges required for the restore are not available:• Issue an operator request to supply each cartridge. • Ignore files stored on cartridges which are not available.• Cancel the restore operation.• Display the list of cartridges which are offline.If you are restoring an entire VM to the virtualization infrastructure, you should either cancel the operation or bring the required cartridges online, as all the components are required.

6. Click the Security tab and, if required, specify a directory which contains security certificates.7. Click OK to start the restore process.


Restore

tina openstack agent

Documents