バックアップのダウンロードとアップロード¶
DXP Cloudのバックアップサービスでは、環境のデータベースと LIFERAY_HOME/data フォルダの全コンテンツのバックアップを作成します。 このコンテンツはアーカイブファイル（.gz 、 .tgz ）として保存されており、DXP Cloudのコンソールからダウンロードすることができます。
また、ユーザーはDXP Cloudコンソール、または バックアップAPI を使用して、環境のバックアップをダウンロードまたはアップロードすることができます 。
注釈
バックアップページは、バックアップサービスのバージョンが4.3.5よりも古い場合、実稼働環境でのみ利用できます。
コンソールによるバックアップのダウンロード¶
以下の手順で、選択した環境の ［バックアップ］ ページからバックアップをダウンロードします：
ダウンロードしたいバックアップの Actions ボタン( ⋮ )をクリックします。
［ダウンロード］ をクリックします。
Database(
.gz) または Liferay(.tgz) のファイルをクリックすると、ダウンロードが始まります。 これらのZIPアーカイブを合わせて、環境のバックアップとします。注釈
バックアップサービスがまだバージョン4.2以上にアップデートされていない場合、データベースボリュームは gz
ではなく.tgz` アーカイブとしてダウンロードされます。
注釈
選択した環境の管理者のみが、バックアップページからバックアップをダウンロードできます。
コンソールによるバックアップのアップロード¶
また、 選択した環境の [バックアップ] ページから、プロジェクトにバックアップをアップロードすることもできます。
DXP Cloudにバックアップをアップロードする前に、データベースダンプとドキュメントライブラリを別々のアーカイブに圧縮する必要があります。 オンプレミス環境でのアップロードの準備については、 データベースとドキュメント・ライブラリーのアップロードの準備 を参照してください。
警告
アップロードが開始されると、アップロードが完了するまで、バックアップサービスは他のバックアップの生成やリストアに利用できません。
バックアップ のページから以下の手順を行います。
画面上部の 「バックアップをアップロード...」をクリックします。画面上部の をクリックします。
バックアップのアップロードページで、該当する環境を展開し、データベースとドキュメントライブラリの両方の
［+］アイコンをクリックしてアップロードします。
データベース・ダンプとドキュメント・ライブラリの両方がアップロードされたら、 ［アップロードの開始］ をクリックします。
DXP Cloudはアップロードしたファイルを使用してバックアップの生成を開始し、環境にリストアできるリストに追加します。 バックアップが生成されている間は、他のバックアップの生成や復元はできません。
バックアップが生成されると、ページに成功のメッセージが表示され、サービスが正常に動作するようになります。
バックアップサービスのAPI¶
バックアップサービスにはAPIが用意されており、バックアップのダウンロードやアップロードにも利用できます。 これらのAPIは、 curlのようなコマンドラインツールを使って呼び出すことができます。
ホスト名の取得¶
バックアップAPIを呼び出すには、バックアップサービスのホスト名が必要です。 これは、 サービス のページにあります。
バックアップサービスのホスト名は、サービス名、プロジェクト名、環境名を組み合わせたものです。
次の例を考えてみましょう：
サービス名：
backupプロジェクト名：
lfrjoebloggs環境名：
prdホスト名：
backup-lfrjoebloggs-prd.lfr.cloud
認証¶
ベーシック認証やユーザーアクセストークンを使って、リクエストを認証することができます。
SSOが有効な場合、トークン認証が必要であることに注意してください。 このトークンをcookie access_token から取得し、 dxpcloud-authorization ヘッダーで使用できます。
アップロードAPIでトークン認証を使用する例を次に示します。
curl -X POST \
https://backup-<PROJECT-NAME>-<ENV>.lfr.cloud/backup/upload \
-H 'Content-Type: multipart/form-data' \
-H 'dxpcloud-authorization: Bearer <USER_TOKEN>' \
-F '[email protected]/my-folder/database.gz' \
-F '[email protected]/my-folder/volume.tgz'
注釈
注：ヘッダー dxpcloud-authorization にユーザートークンを渡すことは、バックアップサービスのバージョン 3.2.0 以降でのみ機能します。 それ以前のバージョンは、少なくとも .2.0にアップグレードする必要があります。 以前のバージョンへのリクエストには Authorization.Bearer を使用します。 プロジェクトマスタートークンは、Liferay DXP Cloudコンソールの任意のシェルで env | grep LCP_PROJECT_MASTER_TOKEN` コマンドを実行することで見つけることができます。
データベースAPIのダウンロード¶
データベースをダウンロードするAPIには、 .gz ファイルを返すエンドポイントがあります。 id パラメータはバックアップIDを表しており、これは「バックアップ」ページで確認できます。 このIDは、2つのダッシュで区切られた3つの文字列で設定 されています（例： dxpcloud-lqgqnewltbexuewymq-201910031723）。
パラメーター¶
名前 |
タイプ |
必須 |
|---|---|---|
|
|
はい |
curlの例¶
curl -X GET \
https://backup-<PROJECT-NAME>-<ENV>.lfr.cloud/backup/download/database/id \
-u [email protected]:password \
--output database.gz
注釈
バックアップサービスがまだバージョン4.2以上にアップデートされていない場合、データベースボリュームは gzではなく.tgz` アーカイブとしてダウンロードされます。
Data Volume APIのダウンロード¶
データボリュームをダウンロードするAPIには、 .tgz ファイルを返すエンドポイントがあります。 id パラメータはバックアップIDを表しており、これは「バックアップ」ページで確認できます。 このIDは、2つのダッシュで区切られた3つの文字列で設定 されています（例： dxpcloud-lqgqnewltbexuewymq-201910031723）。
パラメーター¶
名前 |
タイプ |
必須 |
|---|---|---|
|
|
はい |
カールの例¶
curl -X GET \
https://backup-<PROJECT-NAME>-<ENV>.lfr.cloud/backup/download/volume/id \
-u [email protected]:password \
--output volume.tgz
バックアップAPIのアップロード¶
アップロードバックアップAPIを使ってDXP Cloudにバックアップをアップロードするには、以下の手順に従ってください。
データベースとボリュームのファイルを使って、 バックアップAPIを起動します。
アップロードAPIを使用する前に、データベースダンプとドキュメントライブラリを別々のアーカイブに圧縮する必要があります。 オンプレミス環境でのアップロードの準備については、 データベースとドキュメント・ライブラリーのアップロードの準備 を参照してください。
バックアップAPIの呼び出し¶
パラメーター
名前 |
タイプ |
必須 |
|---|---|---|
|
|
はい |
|
|
はい |
curlの例
curl -X POST \
https://backup-<PROJECT-NAME>-<ENV>.lfr.cloud/backup/upload \
-H 'Content-Type: multipart/form-data' \
-F '[email protected]/my-folder/database.gz' \
-F '[email protected]/my-folder/volume.tgz' \
-u [email protected]:password
データベースとドキュメントライブラリのアップロード準備¶
お客様の環境のバックアップをDXP Cloudにアップロードするためには、その環境のデータベースとドキュメントライブラリが別々のアーカイブファイルとして準備されている必要があります。
データベースファイルの作成¶
MySQLのダンプを（ .sql スクリプトとして）作成し、それを .gz アーカイブに圧縮するには、以下のコマンドを実行します。
mysqldump -uroot -ppassword --add-drop-database --databases lportal | gzip -c | cat > database.gz
注釈
お使いのBackupサービスが少なくともバージョン にアップデートされていない場合には、以下のコマンドを実行して、アーカイブを .tgz ファイルに変換する必要があります。tar zcvf database.tgz database.gz. そして、出来上がった［.tgz`］のアーカイブを使ってアップロードします。
データベース および add-drop-database オプションは、バックアップの復元が正しく機能するために必要です。 また、 /backup/download APIを使用して、バックアップサービスがどのようにMySQLのダンプファイルを作成するかを確認することができます。
これらのオプションを指定した場合、作成されるダンプファイルには、create tableステートメントの直前に以下のコードが含まれます。
--
-- Current Database: `lportal`
--
/*!40000 DROP DATABASE IF EXISTS `lportal`*/;
CREATE DATABASE /*!32312 IF NOT EXISTS*/ `lportal` /*!40100 DEFAULT CHARACTER SET utf8 */;
USE `lportal`;
ボリュームファイルの作成¶
このコマンドを実行すると、データボリュームが圧縮されます。
cd $LIFERAY_HOME/data && tar -czvf volume.tgz document_library