3.13.1 Back up volumes
Function
This service template backs up volumes in a KVM environment 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 a project or tenant
- Volume
Displayed as a volume or block storage device
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
The following is an overview of the processing:
(1) Create temporary volumes from the backup-source volumes.
a) Specify names for the temporary volumes. Optionally, you can also specify instance names and volume names.
- Temporary volumes are created for volumes that are managed by Cinder and that satisfy at least one of the conditions below. Temporary volumes cannot be created for instances or server images.
i. The volume is allocated to the instance specified by the property openstack.instanceName.
ii. The volume is specified by the property openstack.volumeNames.
b) The created temporary volumes are of the same type as the backup-source volumes.
c) If you specify a TO address, an email message is sent when the creation of temporary volumes finishes. Optionally, you can also specify CC and BCC addresses, as well as the subject, body, and encoding of the email message.
(2) Back up the temporary volumes.
a) Specify a container for storing the temporary volumes, temporary volume names, and temporary volume IDs.
b) Information about the backed-up temporary volumes is output to the specified remote CSV file. The character 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.
(3) Delete the temporary volumes.
a) Specify the temporary volume names and IDs.
Note the following when specifying properties:
(1) 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)
(2) During the creation of temporary volumes, a volume status check is performed for the number of times specified by the property openstack.checkVolumeCreationCount, at intervals specified (in seconds) by the property openstack.checkVolumeCreationInterval. Adjust the values of these properties based on your environmental requirements.
(3) During the backup of volumes, a volume status check is performed for the number of times specified by the property openstack.checkVolumeBackupStateCount, at intervals specified (in seconds) by the property openstack.checkVolumeBackupStateInterval. Adjust the values of these properties based on your environmental requirements.
(4) During the deletion of temporary volumes, a volume status check is performed for the number of times specified by the property openstack.checkVolumeDeletionCount, at intervals specified (in seconds) by the property openstack.checkVolumeDeletionInterval. Adjust the values of these properties based on your environmental requirements.
Prerequisites
For the most recent support statuses for the prerequisite products in the system, the prerequisite products in the service-template execution system, and the OS for the prerequisite products in the service-template execution system, see the Release Notes.
Prerequisite products in the system:
JP1/Automatic Operation 12-00 or later
Prerequisite products in the service-template execution system:
(1) Prerequisite products 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
OSs for the prerequisite products in the service-template execution system:
(1) 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)
(2) Prerequisite OS for the OpenStack control server
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter
Environments where Server Core is installed are excluded.
Conditions for using the prerequisite products in the service-template execution system:
(1) Condition related to the OpenStack server
- The service cinder-backup must be running.
(2) Condition related to instances
- Each instance name must be unique within a single project.
(3) Condition related to volumes
- Each volume name must be unique within a single project.
(4) Condition related to containers
- Each container name must be unique within a single project.
Cautions
(1) Make sure to specify either the instance name or volume name. If you do not specify either of them, the task ends abnormally.
(2) This service can be executed for an instance that is currently running. In such a case, if an I/O operation is performed on the guest OS, inconsistencies between the guest OS and the backup might occur. For this reason, make sure to stop I/O operations on the guest OS, or stop the guest OS itself, before executing this service. After the temporary volumes are created, you can restart the I/O operations of the instance. To receive notification when the creation of temporary volumes finishes, enable email notification for that purpose.
(3) A maximum of 27 volumes can be backed up concurrently. If you specify 28 or more volumes, the task ends abnormally.
(4) The folder or container where temporary volumes are created or stored must have enough free space for the volumes to be backed up. If the folder or container does not have enough free space, the task ends abnormally.
(5) Depending on the volume statuses and types, the task might not be able to create or back up temporary volumes and might end abnormally. Before starting the task, 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.
(6) If you backed up multiple volumes, the statuses of some backups might become "Error", causing the task to end abnormally 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 execute this service again. 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
03.00.00
Tags
Control VM,OpenStack
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
Cloud platform environment information |
Specify OpenStack information. |
Y |
|
Backup information |
Specify information about the backup. |
Y |
|
Email notification information |
If you use email notification, specify the notification information. |
N |
|
Run-time option |
This property is used to check statuses before backups are created. If necessary, change the value of this property. |
N |
The following shows the list of the properties to be displayed in the "Service Definition" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
openstack.targetHost |
Host name of the OpenStack control server |
Specify the host name or IP address of the OpenStack control server. Make sure that you do not specify an IPv6 address. |
Input |
Disabled |
R |
Cloud platform environment information |
|
openstack.identityServerHostName |
Host name of the Identity server |
Specify the host name or IP address of the Identity server. Make sure that you do not specify an IPv6 address. |
Input |
Disabled |
R |
Cloud platform environment information |
|
openstack.userName |
User name for logging in to the Identity server |
Specify the user name for logging in to the Identity server. |
Input |
Disabled |
R |
Cloud platform environment information |
|
openstack.password |
Password for logging in to the Identity server |
Specify the password for logging in to the Identity server. |
Input |
Disabled |
R |
Cloud platform environment information |
|
openstack.protocol |
Identity server connection protocol |
Specify the protocol that is used to connect to the Identity server. |
Input |
Disabled |
R |
Cloud platform environment information |
|
openstack.portNumber |
Port number for connecting to the Identity server |
Specify the port number for logging in to the Identity server. |
Input |
Disabled |
R |
Cloud platform environment information |
|
openstack.projectName |
Project name |
Specify the project name. |
Input |
Disabled |
R |
Backup information |
|
openstack.tempVolumeName |
Temporary volume name |
Specify the name of the temporary volume created during the backup of a volume. |
Input |
Disabled |
R |
Backup information |
|
common.toAddress |
TO addresses |
Specify the TO addresses for email notifications. To specify multiple addresses, use a comma (,) as a separator. Example: mailA,mailB |
Input |
Disabled |
O |
Email notification information |
|
common.ccAddress |
CC addresses |
Specify the CC addresses for email notifications. To specify multiple addresses, use a comma (,) as a separator. Example: mailA,mailB |
Input |
Disabled |
O |
Email notification information |
|
common.bccAddress |
BCC addresses |
Specify the BCC addresses for email notifications. To specify multiple addresses, use a comma (,) as a separator. Example: mailA,mailB |
Input |
Disabled |
O |
Email notification information |
|
common.mailSubject |
Email subject |
Specify the email subject for email notifications. |
Input |
Disabled |
O |
Email notification information |
|
common.mailBody |
Email body |
Specify the message body for the email notification. For example, if you include the name of the volume to be backed up in the message, you can easily identify the volume for which a temporary volume was created. |
Input |
Disabled |
O |
Email notification information |
|
common.encodeType |
Encoding type |
Specify the encoding type used for email notifications. Specifiable encoding names are us-ascii, iso-2022-jp, shift_jis, euc-jp, or utf-8. If specification is omitted, utf-8 is used. |
Input |
Disabled |
O |
Email notification information |
|
openstack.checkVolumeCreationCount |
Temporary-volume creation check count |
Specify the number of times the check for temporary-volume creation is to be performed. This value and the temporary-volume creation check interval determine the maximum wait time. |
Input |
Disabled |
R |
Run-time option |
|
openstack.checkVolumeCreationInterval |
Temporary-volume creation check interval |
Specify the interval (in seconds) at which the check for temporary-volume creation is to be performed. |
Input |
Disabled |
R |
Run-time option |
|
openstack.checkVolumeBackupStateCount |
Volume backup check count |
Specify the number of times to check whether the backup of a volume has been completed. This value and the volume backup check interval determine the maximum wait time. |
Input |
Disabled |
R |
Run-time option |
|
openstack.checkVolumeBackupStateInterval |
Volume backup check interval |
Specify in seconds the interval at which to check whether the backup of a volume has been completed. |
Input |
Disabled |
R |
Run-time option |
|
openstack.checkVolumeDeletionCount |
Temporary-volume deletion check count |
Specify the number of times the check for temporary-volume deletion is to be performed. This value and the temporary-volume deletion check interval determine the maximum wait time. |
Input |
Disabled |
R |
Run-time option |
|
openstack.checkVolumeDeletionInterval |
Temporary-volume deletion check interval |
Specify the interval (in seconds) at which the check for temporary-volume deletion is to be performed. |
Input |
Disabled |
R |
Run-time option |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
openstack.containerName |
Container name |
Specify the name of the container in which to store backups. |
Input |
Disabled |
R |
Backup information |
|
openstack.instanceName |
Instance name |
Specify the instance name. Note that the name you specify here is the display name of the instance in OpenStack, and is different from a host name in the OS. |
Input |
Disabled |
O |
Backup information |
|
openstack.volumeNames |
Volume names |
Specify the volume names. To specify multiple names, use a comma (,) as a separator. You can specify a maximum of 27 volume names. |
Input |
Disabled |
O |
Backup information |
|
openstack.backupOutputFilePath |
Backup information output file path (remote) |
Specify a full path of the file to which backup information is to be output on the OpenStack control server. |
Input |
Disabled |
R |
Backup information |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:
|
Property key |
Characters that can be input |
|---|---|
|
openstack.targetHost |
A string that has 256 or fewer single-byte alphanumeric characters, including periods (.) and hyphens (-) |
|
openstack.identityServerHostName |
A string that has 256 or fewer single-byte alphanumeric characters, including periods (.) and hyphens (-) |
|
openstack.userName |
A string that has 64 or fewer single-byte alphanumeric characters |
|
openstack.password |
A string that has 256 or fewer single-byte alphanumeric characters |
|
openstack.protocol |
Select one of the following values: http,https |
|
openstack.portNumber |
An integer in the range from 1 to 65,535 |
|
openstack.projectName |
A string that has 80 or fewer characters. The following symbols cannot be used: < > | ; & ' " * ? [ ] ` % \ |
|
openstack.tempVolumeName |
A string that has 255 or fewer characters. The following symbols cannot be used: < > | ; & ' " * ? [ ] ` % \ |
|
common.toAddress |
A string that has 1,024 or fewer single-byte alphanumeric characters and symbols |
|
common.ccAddress |
A string that has 1,024 or fewer single-byte alphanumeric characters and symbols |
|
common.bccAddress |
A string that has 1,024 or fewer single-byte alphanumeric characters and symbols |
|
common.mailSubject |
A string that has 256 or fewer characters |
|
common.mailBody |
A string that has 1,024 or fewer characters |
|
common.encodeType |
Select one of the following values: us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8 |
|
openstack.checkVolumeCreationCount |
An integer in the range from 1 to 2,147,483,647 |
|
openstack.checkVolumeCreationInterval |
An integer in the range from 1 to 60 |
|
openstack.checkVolumeBackupStateCount |
An integer in the range from 1 to 2,147,483,647 |
|
openstack.checkVolumeBackupStateInterval |
An integer in the range from 1 to 60 |
|
openstack.checkVolumeDeletionCount |
An integer in the range from 1 to 2,147,483,647 |
|
openstack.checkVolumeDeletionInterval |
An integer in the range from 1 to 60 |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Characters that can be input |
|---|---|
|
openstack.containerName |
A string that has 255 or fewer characters. The following symbols cannot be used: < > | ; & ' " * ? [ ] ` % \ |
|
openstack.instanceName |
A string that has 80 or fewer characters. The following symbols cannot be used: < > | ; & ' " * ? [ ] ` % \ |
|
openstack.volumeNames |
A string that has 255 or fewer characters. The following symbols cannot be used: < > | ; & ' " * ? [ ] ` % \ |
|
openstack.backupOutputFilePath |
A string that has 256 or fewer characters, does not end with a backslash (\), and does not include the following symbols: < > | ; & * ? " % / |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
||
|---|---|---|---|---|
|
Plug-in name |
Description |
Error recovery method |
||
|
1 |
openstackCreateTempVolume |
Flow Plug-in |
Creates a temporary volume. |
After checking the task log and removing the cause of the error, read the notes, and then run this service again. If a temporary volume was created, delete it, and then run the service again. |
|
1-1 |
Create temporary volume |
Creates a volume based on another volume. |
After checking the task log and removing the cause of the error, read the notes, and then run this service again. If a temporary volume was created, delete it, and then run the service again. |
|
|
1-2 |
Judge Value Plug-in |
Judges whether the TO email address is specified. |
After checking the task log and removing the cause of the error, read the notes, and then run this service again. Delete the temporary volume before running the service again. |
|
|
1-3 |
Email Notification Plug-in |
Sends notification by email. |
After checking the task log and removing the cause of the error, read the notes, and then run this service again. Delete the temporary volume before running the service again. |
|
|
2 |
openstackBackupVolume |
Back up volume |
Backs up a volume. |
After checking the task log and removing the cause of the error, read the notes, and then run this service again. Then, delete the temporary volume. If a backup was created, delete it, and then run this service again. |
|
3 |
openstackDeletetempVolume |
Delete temporary volume |
Deletes a temporary volume. |
After checking the task log and removing the cause of the error, read the notes, and then run this service again. If a temporary volume was created, delete it. |