3.13.1 ボリュームのバックアップ
機能
このサービステンプレートは，OpenStack管理下のKVM環境で，ボリュームのバックアップを取得します。
このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。
・Identity
IdentityまたはKeyStoneと記載されています。
・プロジェクト
プロジェクトまたはテナントと記載されています。
・ボリューム
ボリュームまたはブロックストレージと記載されています。
このサービステンプレートが前提とするサーバを次に示します。
・OpenStackサーバ
OpenStackがインストールされているサーバです。
・KVMサーバ
Kernel-based Virtual Machineがインストールされているサーバです。
・OpenStack操作サーバ
OpenStackサーバにREST-APIを実行するサーバです。
・インスタンス
OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。
処理の概要を次に示します。
(1)ボリュームから一時ボリュームを作成します。
1.一時ボリューム名を設定します。オプションとして，インスタンス名，ボリューム名を設定できます。
・次の条件のどれか，または両方を満たすCinderによって管理されているボリュームを一時ボリューム作成対象とします。インスタンスおよびイメージは対象にできません。
①openstack.instanceNameプロパティに指定されたインスタンスに割り当たっているボリューム
②openstack.volumeNamesプロパティに指定されたボリューム
2.一時ボリュームはバックアップ元のボリュームと同一ボリューム種別に作成されます。
3.TOメールアドレスが指定されている場合に，一時ボリュームの作成完了をメール通知します。オプションとして，CCメールアドレス，BCCメールアドレス，メール件名，メール本文，エンコード種別を設定できます。
(2)一時ボリュームのバックアップを取得します。
1.格納先コンテナー，一時ボリューム名，一時ボリュームIDを設定します。
2.バックアップの情報をCSV形式で指定されたリモートのファイルに出力します。出力ファイルのエンコード形式は，OpenStack操作サーバのデフォルトエンコーディングです。
・バックアップの情報はopenstack.backupOutputFilePathプロパティに指定されたCSVファイルに追記します。
・openstack.backupOutputFilePathプロパティに指定したファイルが存在しない場合は新規にファイルを作成します。
(3)一時ボリュームを削除します。
1.一時ボリューム名，一時ボリュームIDを設定します。
プロパティ設定の留意点を次に示します。
(1)出力するCSVファイルの項目を次に示します。
項目はコンマ区切りで出力します。
(a) バックアップ取得日時 (ヘッダー名：Backup time)(出力形式：yyyy/MM/dd HH:mm:ss)
(b) プロジェクト名 (ヘッダー名：Project name)
(c) インスタンス名 (ヘッダー名：Instance name)
(d) ボリュームID (ヘッダー名：Volume ID)
(e) ボリューム名 (ヘッダー名：Volume name)
(f) バックアップID (ヘッダー名：Backup ID)
(2)一時ボリュームを作成する際には，openstack.checkVolumeCreationIntervalプロパティに指定した秒数待ち合わせ，ボリュームの状態を確認する動作を，openstack.checkVolumeCreationCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。
(3)ボリュームのバックアップを取得する際には，openstack.checkVolumeBackupStateIntervalプロパティに指定した秒数待ち合わせ，バックアップの状態を確認する動作を，openstack.checkVolumeBackupStateCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。
(4)一時ボリュームを削除する際には，openstack.checkVolumeDeletionIntervalプロパティに指定した秒数待ち合わせ，ボリュームの状態を確認する動作を，openstack.checkVolumeDeletionCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。
前提条件
【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 12-00以降
【サービステンプレート実行システム内前提製品】
(1)OpenStackサーバの前提製品
・OpenStack
(2)インスタンスを管理する仮想化環境
・Kernel-based Virtual Machine
・VMware vCenter Server
・VMware vSphere ESXi
(3)OpenStack操作サーバ
・Microsoft .Net Framework 3.5以降
【サービステンプレート実行システム内前提製品の稼働OS】
(1)インスタンスの前提OS
・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)
・Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(2)OpenStack操作サーバの前提OS
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
ただし，Server Coreインストール環境は除く。
【サービステンプレート実行システム内前提製品の使用条件】
(1)Openstackサーバに関する条件
・cinder-backupが起動していること。
(2)インスタンスに関する条件
・同一プロジェクト内でインスタンス名が重複しないこと。
(3)ボリュームに関する条件
・同一プロジェクト内でボリューム名が重複しないこと。
(4)コンテナーに関する条件
・同一プロジェクト内でコンテナー名が重複しないこと。
注意事項
(1)インスタンス名，ボリューム名はどちらかもしくは両方を指定してください。どちらの指定も無い場合，タスクが異常終了します。
(2)このサービスは稼働中のインスタンスに対しても実行できます。その際，ゲストOS上でI/Oが発生していると，ゲストOSとバックアップ間に不整合が発生する場合があります。そのため，ゲストOS上のI/Oを停止しておくかゲストOS自体を事前に停止してください。一時ボリューム作成終了後は，インスタンスのI/Oを再開できます。一時ボリューム作成終了の通知が必要な場合は，メール通知を行ってください。
(3)一度にバックアップ取得可能なボリュームの最大数は，27ボリュームまでです。28ボリューム以上指定された場合は，タスクが異常終了します。
(4)一時ボリューム作成先および格納先コンテナーには，バックアップ元ボリュームと同じ容量またはそれ以上の空き容量を確保してください。一時ボリューム作成先または格納先コンテナーに十分な空き容量が無い場合，タスクが異常終了します。
(5)ボリュームの状態や種別によっては，一時ボリュームの作成やバックアップの取得ができずタスクが異常終了します。事前に，ボリュームの状態や種別，および使用しているCinderドライバのマニュアルを確認してください。
(6)複数ボリュームのバックアップを取得した場合に，いくつかのバックアップの状態がErrorになりKNAE06389-Eのメッセージを出力して，タスクが異常終了する場合があります。OpenStackサーバの設定を確認しジョブエラー時の回復方法を確認したのち，このサービスを再実行してください。同じエラーが何度も発生する場合，資料採取ツールで資料を採取し，システム管理者に連絡してください。
実行権限
(1)OpenStackサーバにログインするユーザーに次の権限が必要です。
admin権限
バージョン
03.00.00
タグ
Control VM,OpenStack
プロパティ一覧
プロパティに設定されているプロパティグループの一覧を次に示します。
|
プロパティグループ |
説明 |
初期表示 |
|---|---|---|
|
クラウド基盤環境情報 |
OpenStackの情報を指定してください。 |
表示されます。 |
|
バックアップ情報 |
バックアップの情報を指定してください。 |
表示されます。 |
|
メール通知情報 |
メールを通知する場合に通知情報を指定してください。 |
表示されません。 |
|
実行時オプション |
バックアップを取得する際の状態確認に関するプロパティです。必要に応じて変更してください。 |
表示されません。 |
［サービス設定］画面に表示されるプロパティの一覧を次に示します。
- （凡例）
-
○：プロパティの指定は必須です。
△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
|---|---|---|---|---|---|---|
|
openstack.targetHost |
OpenStack操作サーバのホスト名 |
OpenStack操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
入力 |
無効 |
○ |
クラウド基盤環境情報 |
|
openstack.identityServerHostName |
Identityサーバのホスト名 |
Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
入力 |
無効 |
○ |
クラウド基盤環境情報 |
|
openstack.userName |
Identityサーバにログインするためのユーザー名 |
Identityサーバにログインするためのユーザー名を指定します。 |
入力 |
無効 |
○ |
クラウド基盤環境情報 |
|
openstack.password |
Identityサーバにログインするためのパスワード |
Identityサーバにログインするためのパスワードを指定します。 |
入力 |
無効 |
○ |
クラウド基盤環境情報 |
|
openstack.protocol |
Identityサーバ接続用プロトコル |
Identityサーバに接続するためのプロトコルを指定します。 |
入力 |
無効 |
○ |
クラウド基盤環境情報 |
|
openstack.portNumber |
Identityサーバ接続用ポート番号 |
Identityサーバに接続するためのポート番号を指定します。 |
入力 |
無効 |
○ |
クラウド基盤環境情報 |
|
openstack.projectName |
プロジェクト名 |
プロジェクトの名称を指定します。 |
入力 |
無効 |
○ |
バックアップ情報 |
|
openstack.tempVolumeName |
一時ボリューム名 |
バックアップを取得する際の一時ボリューム名を指定します。 |
入力 |
無効 |
○ |
バックアップ情報 |
|
common.toAddress |
TOメールアドレス |
メール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB |
入力 |
無効 |
△ |
メール通知情報 |
|
common.ccAddress |
CCメールアドレス |
メール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB |
入力 |
無効 |
△ |
メール通知情報 |
|
common.bccAddress |
BCCメールアドレス |
メール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB |
入力 |
無効 |
△ |
メール通知情報 |
|
common.mailSubject |
メール件名 |
メール通知のメールの件名を指定します。 |
入力 |
無効 |
△ |
メール通知情報 |
|
common.mailBody |
メール本文 |
メール通知のメール本文を指定します。例えば，メッセージ内にバックアップ対象としたボリューム名を指定すると，一時ボリュームの作成が完了したボリュームが識別しやすくなります。 |
入力 |
無効 |
△ |
メール通知情報 |
|
common.encodeType |
エンコード種別 |
メール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。 |
入力 |
無効 |
△ |
メール通知情報 |
|
openstack.checkVolumeCreationCount |
一時ボリュームの作成完了の確認回数 |
一時ボリュームが作成されたことを確認する際の，確認回数を指定します。一時ボリュームの作成完了の確認間隔と組み合わせて最大待ち時間となります。 |
入力 |
無効 |
○ |
実行時オプション |
|
openstack.checkVolumeCreationInterval |
一時ボリュームの作成完了の確認間隔 |
一時ボリュームが作成されたことを確認する際の，確認間隔を秒単位で指定します。 |
入力 |
無効 |
○ |
実行時オプション |
|
openstack.checkVolumeBackupStateCount |
ボリュームのバックアップ完了の確認回数 |
ボリュームのバックアップ完了を確認する際の，バックアップの確認回数を指定します。ボリュームのバックアップ完了の確認間隔と組み合わせて最大待ち時間となります。 |
入力 |
無効 |
○ |
実行時オプション |
|
openstack.checkVolumeBackupStateInterval |
ボリュームのバックアップ完了の確認間隔 |
ボリュームのバックアップ完了を確認する際の，バックアップの確認間隔を秒単位で指定します。 |
入力 |
無効 |
○ |
実行時オプション |
|
openstack.checkVolumeDeletionCount |
一時ボリュームの削除完了の確認回数 |
一時ボリュームが削除されたことを確認する際の，確認回数を指定します。一時ボリュームの削除完了の確認間隔と組み合わせて最大待ち時間となります。 |
入力 |
無効 |
○ |
実行時オプション |
|
openstack.checkVolumeDeletionInterval |
一時ボリュームの削除完了の確認間隔 |
一時ボリュームが削除されたことを確認する際の，確認間隔を秒単位で指定します。 |
入力 |
無効 |
○ |
実行時オプション |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
|---|---|---|---|---|---|---|
|
openstack.containerName |
格納先コンテナー名 |
バックアップ格納先のコンテナーの名称を指定します。 |
入力 |
無効 |
○ |
バックアップ情報 |
|
openstack.instanceName |
インスタンス名 |
インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。 |
入力 |
無効 |
△ |
バックアップ情報 |
|
openstack.volumeNames |
ボリューム名 |
ボリュームの名称を指定します。複数指定する場合はコンマで区切ってください。27個まで指定できます。 |
入力 |
無効 |
△ |
バックアップ情報 |
|
openstack.backupOutputFilePath |
バックアップ情報出力ファイルパス(リモート) |
OpenStack操作サーバへバックアップ情報出力ファイルを出力するファイルパスをフルパスで指定します。 |
入力 |
無効 |
○ |
バックアップ情報 |
［サービス設定］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
openstack.targetHost |
256文字以内の半角英数字および「.」，「-」。 |
|
openstack.identityServerHostName |
256文字以内の半角英数字および「.」，「-」。 |
|
openstack.userName |
64文字以内の半角英数字。 |
|
openstack.password |
256文字以内の半角英数字。 |
|
openstack.protocol |
次の値のどれかを選択する。 http,https |
|
openstack.portNumber |
1〜65535の整数値。 |
|
openstack.projectName |
80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。 |
|
openstack.tempVolumeName |
255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。 |
|
common.toAddress |
1024文字以内の半角英数字および半角記号。 |
|
common.ccAddress |
1024文字以内の半角英数字および半角記号。 |
|
common.bccAddress |
1024文字以内の半角英数字および半角記号。 |
|
common.mailSubject |
256文字以内の文字列。 |
|
common.mailBody |
1024文字以内の文字列。 |
|
common.encodeType |
次の値のどれかを選択する。 us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8 |
|
openstack.checkVolumeCreationCount |
1〜2147483647の整数値。 |
|
openstack.checkVolumeCreationInterval |
1〜60の整数値。 |
|
openstack.checkVolumeBackupStateCount |
1〜2147483647の整数値。 |
|
openstack.checkVolumeBackupStateInterval |
1〜60の整数値。 |
|
openstack.checkVolumeDeletionCount |
1〜2147483647の整数値。 |
|
openstack.checkVolumeDeletionInterval |
1〜60の整数値。 |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
openstack.containerName |
255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。 |
|
openstack.instanceName |
80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。 |
|
openstack.volumeNames |
255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。 |
|
openstack.backupOutputFilePath |
256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」および末尾の「¥」を除く。 |
フロー仕様詳細
フロー仕様詳細を次の表に示します。
|
階層 |
[タスク詳細]画面での表示名 |
ステップ名 |
部品 |
||
|---|---|---|---|---|---|
|
部品名 |
説明 |
エラー時の回復方法 |
|||
|
1 |
一時ボリュームの作成 |
一時ボリュームの作成 |
階層フロー部品 |
一時ボリュームを作成します。 |
タスクログを確認し，エラーの原因を取り除いたあと，注意事項を確認し，このサービスを再実行してください。 一時ボリュームが作成されている場合は，一時ボリュームを削除したあと，このサービスを再実行してください。 |
|
1-1 |
一時ボリュームの作成 |
ボリュームを元にボリュームを作成します。 |
タスクログを確認し，エラーの原因を取り除いたあと，注意事項を確認し，このサービスを再実行してください。 一時ボリュームが作成されている場合は，一時ボリュームを削除したあと，このサービスを再実行してください。 |
||
|
1-2 |
値判定分岐部品 |
TOメールアドレスが設定されているか判定します。 |
タスクログを確認し，エラーの原因を取り除いたあと，注意事項を確認し，このサービスを再実行してください。 一時ボリュームを削除したあと，このサービスを再実行してください。 |
||
|
1-3 |
メール通知部品 |
メール通知をします。 |
タスクログを確認し，エラーの原因を取り除いたあと，注意事項を確認し，このサービスを再実行してください。 一時ボリュームを削除したあと，このサービスを再実行してください。 |
||
|
2 |
ボリュームのバックアップ |
ボリュームのバックアップ |
ボリュームのバックアップ |
ボリュームのバックアップを取得します。 |
タスクログを確認し，エラーの原因を取り除いたあと，注意事項を確認し，このサービスを再実行してください。 一時ボリュームを削除し，バックアップが作成されている場合は，バックアップを削除したあと，このサービスを再実行してください。 |
|
3 |
一時ボリュームの削除 |
一時ボリュームの削除 |
一時ボリュームの削除 |
一時ボリュームを削除します。 |
タスクログを確認し，エラーの原因を取り除いたあと，注意事項を確認し，このサービスを再実行してください。 一時ボリュームが作成されている場合は，一時ボリュームを削除してください。 |