5.8.1 Backup Volume
Function
This service template backs up volumes managed by OpenStack.
The terms related to OpenStack that are used in this document are names displayed in the OpenStack Dashboard. These terms are explained below.
- Identity
Displayed as "Identity" or "KeyStone"
- Project
Displayed as "Project" or "Tenant"
- Volume
Displayed as "Volume" or "Block storage"
This service template requires the following servers:
- OpenStack server
A server on which OpenStack is installed
- KVM server
A server on which a Kernel-based Virtual Machine is installed
- OpenStack control server
A server that executes REST-API functions on the OpenStack server
- Instance
An instance of a general virtual server managed by the OpenStack server and KVM
(1) Volumes that can be backed up are those that are managed by Cinder and that meet at least one of the following conditions:
a. The volume is specified by the property openstack.volumeNames.
b. The volume is specified by the property openstack.volumeIds.
(2) Information about backed up volumes is output to the specified remote CSV file. The charactering encoding for this file is the default character encoding used on the OpenStack control server.
- If the CSV file specified by the property openstack.backupOutputFilePath exists, backup information is added to that file.
- If the CSV file specified by the property openstack.backupOutputFilePath does not exist, that file is created.
- If the property openstack.backupOutputFilePath is omitted, backup information is not output.
- If the volume to be backed up was created from another volume and if the property openstack.flagTempVol is set to "true", information about the source volume is output as the volume information (volume ID and name).
(3) The following items are output to the file in CSV (comma-separated value) format:
a) Date and time when the backup was created (Header name: Backup time, format: yyyy/MM/dd HH:mm:ss)
b) Project name (Header name: Project name)
c) Instance name (Header name: Instance name)
d) Volume ID (Header name: Volume ID)
e) Volume name (Header name: Volume name)
f) Backup ID (Header name: Backup ID)
Use situation
After a volume is created, this plug-in can be used to back up the volume for system maintenance.
Prerequisites
For the most recent support statuses for the prerequisite products in the system, the prerequisite products on the execution-target server, and the OSs for the prerequisite products on the execution-target server, see the Release Notes.
Prerequisite products in the system:
JP1/Automatic Operation 11-00 or later
Prerequisite products on the execution-target server:
(1) Prerequisite product on the OpenStack server
- OpenStack
(2) Virtualization environment that manages the instance
- Kernel-based Virtual Machine
- VMware vCenter Server
- VMware vSphere ESXi
(3) OpenStack control server
- Microsoft .Net Framework 3.5 or later
(4) Prerequisite OS for the instance
- Red Hat Enterprise Linux Server 6 (32-bit x86) or Red Hat Enterprise Linux Server 6 (64-bit x86_64)
- Red Hat Enterprise Linux Server 7 (64-bit x86_64)
OSs for the prerequisite products on the execution-target server:
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter
- Windows Server 2012 R2 Standard/Datacenter
Environments where Server Core is installed are excluded.
Conditions for using the prerequisite products in the execution-target system:
(1) Condition related to the OpenStack server
- Cinder-backup must be running.
(2) Condition related to volumes
- Each volume name must be unique within a single project.
(3) Condition related to containers
- Each container name must be unique within a single project.
Cautions
(1) Make sure to specify either the volume name or the instance ID. If you do not specify either of these, this plug-in fails.
(2) The container where backup data is to be saved must have enough free space for the volumes to be backed up. If the container does not have enough free space, this plug-in fails.
(3) Depending on the volume statuses and types, this plug-in might not be able to create backups and might fail. Before starting this plug-in, check the volume statuses and types and read the documentation for the Cinder driver you are using to see whether such a problem might occur.
(4) If you backed up multiple volumes, the statuses of some backups to become "Error", causing this plug-in to end in error with the message KNAE06389-E. If this occurs, check the settings on the OpenStack server, perform the procedure for recovery from a job error, and then re-execute this service. If the same error occurs repeatedly, use the data collection tool to collect the necessary data, and then contact the system administrator.
Execution privilege
(1) Users who log in to the OpenStack server must have the following permission:
admin
Version
02.00.00
Plug-in tags
Control VM,OpenStack
Plug-in name displayed in the task log
openstackBackupVolume
Return code
0: Normal
12: Error (Mistake by user) Invalid property
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check with the task log about the error detail) Unidentified error
41: Error (An error has been detected in the component) Property not entered (An error has been detected in the component script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
openstack.identityServerHostName |
Identity server host name |
Specifies the Identity server host name or IP address. Does not support IPv6 addresses. |
-- |
Input |
R |
|
openstack.userName |
Identity server login username |
Specifies the username to log into the Identity server. |
-- |
Input |
R |
|
openstack.password |
Identity server login password |
Specifies the password to log into the Identity server. |
-- |
Input |
R |
|
openstack.protocol |
Identity server connection protocol |
Specifies the protocol used to connect to the Identity server. |
-- |
Input |
R |
|
openstack.portNumber |
Identity server connection port number |
Specifies the port number to connect to the Identity server. |
-- |
Input |
R |
|
openstack.projectName |
Project name |
Specify the name of the project. |
-- |
Input |
R |
|
openstack.containerName |
Storage Destination Container Name |
Specify the name of the container of the backup storage destination. |
-- |
Input |
R |
|
openstack.volumeNames |
Volume Name |
Specify the name of the volume. Separate entries with a comma when specifying multiple volumes. |
-- |
Input |
O |
|
openstack.volumeIds |
Volume ID |
Specify the ID of the volume. Separate entries with a comma when specifying multiple volumes. |
-- |
Input |
O |
|
openstack.backupOutputFilePath |
Backup Information Output File Path (Remote) |
Specify the full path of the file path to output the backup information output file to the OpenStack operated server. |
-- |
Input |
O |
|
openstack.flagTempVol |
Whether Volume to be Backed Up is Temporary Volume |
Specify "true" if the volume to be backed up is a temporary volume, and "false" if it is not a temporary volume. |
false |
Input |
R |
|
openstack.checkVolumeBackupStateCount |
Number of Times to Check Volume Backups |
Specify the number of times to check to see if a volume was backed up. This, combined with the interval to check the volume backups will be the maximum waiting time. |
-- |
Input |
R |
|
openstack.checkVolumeBackupStateInterval |
Interval to Check Volume Backups |
Specify the number of seconds to be used as the interval for checks to see if a volume was backed up. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |