ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

バックアップのダウンロードとアップロード

Liferay Cloudのバックアップサービスでは、環境のデータベースとLiferayインスタンスのLIFERAY_HOME/dataフォルダのすべてのコンテンツのバックアップを作成します。このコンテンツはアーカイブファイル（それぞれ.gzと.tgz）として保存されており、Liferay Cloudコンソールからダウンロードすることができます。

ユーザーは、Liferay Cloud Consoleまたはバックアップ APIを使用して、環境のバックアップをダウンロードまたはアップロードすることもできます。

CLIツールによるバックアップのダウンロード

CLIツールバージョン3.12.0以降とLiferayサービスバージョン5.3.0以降が必要です

CLI ツールを使用して、データベースとドキュメントライブラリボリュームの両方を含むバックアップを直接ダウンロードできます。

特定のバックアップの ID を使用してこのコマンドを実行し、データベースとドキュメントライブラリを同時にダウンロードします。

lcp backup download --backupId [ID]

オプションのコマンドラインスイッチが 3 つあります。

--database はデータベースのみをダウンロードすることを指定します。

--doclib はドキュメントライブラリのみをダウンロードすることを指定します。

--concurrency は、並行してダウンロードするファイルの数を定義します (最大 10,000)。

複数のスイッチを使用する例を次に示します。

lcp backup download --backupId [ID] --doclib --concurrency 500

同時にダウンロードする最適なファイル数は、システムとネットワークの仕様によって異なります。 --concurrency フラグは、データベースが単一のファイルとしてダウンロードされるため、ドキュメントライブラリのダウンロードにのみ影響します。

CLIツールによるバックアップのアップロード

CLIツールバージョン3.12.0以降とLiferayサービスバージョン5.3.0以降が必要です

警告

Liferay Cloudでは、データベースのテーブルとカラムの名前は大文字と小文字が区別されます。テーブル名で大文字と小文字が正しく使用されていることを確認します (PostgreSQL の場合は小文字、MySQL の場合は Pascal 形式)。詳細については、「表の大文字/小文字の正しい使用方法の確認」を参照してください。

データベースとドキュメントライブラリの両方を含むバックアップをアップロードするには、次のコマンドを実行します。

lcp backup upload --project [Project name] --environment [Environment] --doclib [Path to document library folder] --database [Path to database .gz file]

アップロードするには、データベースダンプを作成して圧縮し、 .gz アーカイブにする必要があります。

並行してアップロードするストリームの数 (最大 10,000) を指定した --concurrency フラグを追加することもできます。

データベースとドキュメントライブラリのアップロード準備

環境のバックアップを Liferay Cloud にアップロードするには、データベースを独自のアーカイブファイルに準備しておく必要があります。バックアップサービスバージョン 5.9.0 より前のバージョンでは、ドキュメントライブラリを別のアーカイブファイルに圧縮する必要もあります。

データベースファイルの作成

データベースダンプを作成するには、PostgreSQL データベースと MySQL データベースで異なるコマンドが必要です。データベースの種類に固有の詳細な手順については、「データベースダンプの作成」を参照してください。

これらの手順により、データベースがダンプされ、結果として得られる database.gz ファイルに圧縮されます。

ヒント

ダンプを作成するときにデータベースを無視するには、 LCP_DUMP_DATABASES_TO_IGNORE 変数を使用します。

ボリュームファイルの作成

LCP ツールを使用してバックアップをアップロードする場合、ツールによってドキュメントライブラリのファイルが自動的に圧縮されるため、ボリュームファイルは必要ありません。

Cloud コンソールの UI または API 経由でバックアップをアップロードするには、ドキュメントライブラリを圧縮してアップロードする必要があります。

ヒント

バックアップをアップロードするときに Liferay Cloud の権限がまだ設定されていない場合は、後でバックアップを環境に復元すると、完了するまでに時間がかかることがあります。復元時間が長くならないようにするには、ドキュメントライブラリを圧縮する前に、 LIFERAY_HOME フォルダに移動し、次のコマンドを実行します: chown -R 1000:1000 data/document_library/。

このコマンドを実行すると、データボリュームが圧縮されます。

cd $LIFERAY_HOME/data && tar -czvf volume.tgz document_library

コンソールによるバックアップのダウンロード

重要

GCS をドキュメントライブラリストアとして使用していない場合にのみ、コンソール経由でバックアップをダウンロードできます。もしそうなら、代わりに CLI ツールを使用してください。

選択した環境の バックアップ ページからバックアップをダウンロードするには、次の手順に従います (管理者として)。

ダウンロードするバックアップの アクション ( ⋮ ) をクリックします。
ダウンロードをクリックします。
データベース (.gz) または Liferay (.tgz) ファイルをクリックしてダウンロードを開始します。これらのZIPアーカイブを合わせて、環境のバックアップとします。

注

バックアップサービスがまだバージョン 4.2 以上に更新されていない場合、データベースボリュームは .gzではなく .tgz アーカイブとしてダウンロードされます。

コンソールによるバックアップのアップロード

警告

ドキュメントライブラリストアが GCS の場合は、CLIを使用してバックアップをアップロードします。

Liferay Cloudにバックアップをアップロードする前に、データベースダンプとドキュメントライブラリを別々のアーカイブに圧縮する必要があります。オンプレミス環境向けに準備する方法の詳細については、「アップロード用のデータベースとドキュメントライブラリの準備」を参照してください。

警告

Liferay Cloudでは、データベースのテーブルとカラムの名前は大文字と小文字が区別されます。データベースをアップロードする前に、テーブル名がパスカルケースであることを確認してください。詳細については、「表の大文字/小文字の正しい使用方法の確認」を参照してください。

バックアップページから次の手順に従います。

画面上部の「 バックアップのアップロード… 」をクリックします。
バックアップのアップロードページで、該当する環境を展開し、データベースとドキュメントライブラリの両方の ［+］ アイコンをクリックしてアップロードします。
データベース・ダンプとドキュメント・ライブラリの両方がアップロードされたら、 ［アップロードの開始］ をクリックします。

Liferay Cloud は、アップロードしたファイルを使用してバックアップを生成し、環境に復元できるリストに追加します。バックアップが生成されている間は、他のバックアップの生成や復元はできません。

バックアップが生成されるとページに成功メッセージが表示され、サービスは通常の操作を再開します。

お使いの環境でバックアップのリストへの追加が完了すると、成功メッセージが表示されます。

バックアップサービスのAPI

バックアップサービスにはAPIが用意されており、バックアップのダウンロードやアップロードにも利用できます。これらのAPIは、 curlのようなコマンドラインツールを使って呼び出すことができます。バックアップサービスのバージョンで CLI を使用したアップロードが利用できない場合、または次のエラーが発生する場合にのみ、バックアップ API を使用してください。

Project [projectId] does not have GCS enabled for Document Library Store.

ホスト名の取得

バックアップAPIを呼び出すには、バックアップサービスのホスト名が必要です。これは、 サービス のページにあります。

サービス」ページから、バックアップサービスのホスト名を表示します。

バックアップサービスのホスト名は、サービス名、プロジェクト名、環境名を組み合わせたものです。

この例を考えてみましょう。

サービス名： backup
プロジェクト名： lfrjoebloggs
環境名： prd
ホスト名： backup-lfrjoebloggs-prd.lfr.cloud

認証

ベーシック認証やユーザーアクセストークンを使って、リクエストを認証することができます。

SSOが有効な場合、トークン認証が必要であることに注意してください。このトークンをcookie access_token から取得し、 dxpcloud-authorization ヘッダーで使用できます。

アップロードAPIでトークン認証を利用した例をご紹介します。

curl -X POST \
  https://backup-[Project name]-[Environment].lfr.cloud/backup/upload \
  -H 'Content-Type: multipart/form-data' \
  -H 'dxpcloud-authorization: Bearer [User token]' \
  -F 'database=@/my-folder/database.gz' \
  -F 'volume=@/my-folder/volume.tgz'

注

ヘッダー dxpcloud-authorization でユーザートークンを渡すことは、バックアップサービスのバージョン 3.2.0 以上でのみ機能します。以前のバージョンは少なくとも 3.2.0にアップグレードする必要があります。以前のバージョンへのリクエストでは、ヘッダー Authorization: Bearer [プロジェクトマスタートークン]を使用する必要があります。 Liferay Cloud コンソールの任意のシェルでコマンド env | grep LCP_PROJECT_MASTER_TOKEN を実行すると、プロジェクトマスタートークンを見つけることができます。

データベースAPIのダウンロード

データベースをダウンロードするAPIには、 .gz ファイルを返すエンドポイントがあります。 id パラメータはバックアップIDを表しており、これは「バックアップ」ページで確認できます。このIDは、2つのダッシュで区切られた3つの文字列で設定　されています(例： dxpcloud-lqgqnewltbexuewymq-201910031723)。

パラメーター

名前	種類	必須
`id`	`String`	はい

curlの例

curl -X GET \
  https://backup-[Project name]-[Environment].lfr.cloud/backup/download/database/[ID] \
  -u user@domain.com:password \
  --output database.gz

注

バックアップサービスがまだバージョン 4.2 以上に更新されていない場合、データベースボリュームは .gzではなく .tgz アーカイブとしてダウンロードされます。

Data Volume APIのダウンロード

データボリュームをダウンロードするAPIには、 .tgz ファイルを返すエンドポイントがあります。 id パラメータはバックアップIDを表しており、これは「バックアップ」ページで確認できます。このIDは、2つのダッシュで区切られた3つの文字列で設定　されています(例： dxpcloud-lqgqnewltbexuewymq-201910031723)。

パラメーター

名前	種類	必須
`id`	`String`	はい

curlの例

curl -X GET \
  https://backup-[Project name]-[Environment].lfr.cloud/backup/download/volume/[ID] \
  -u user@domain.com:password \
  --output volume.tgz

バックアップAPIのアップロード

アップロードバックアップAPIを使ってLiferay Cloudにバックアップをアップロードするには、以下の手順に従ってください。

データベースファイルを作成します。
ボリュームファイルを作成します。
データベースとボリュームファイルを使用してバックアップ API を呼び出します。

アップロードAPIを使用する前に、データベースダンプとドキュメントライブラリを別々のアーカイブに圧縮する必要があります。オンプレミス環境へのアップロードの準備の詳細については、「アップロード用のデータベースとドキュメントライブラリの準備」を参照してください。

バックアップAPIの呼び出し

パラメーター

名前	種類	必須
`database`	`File`	はい
`volume`	`File`	はい

curlの例

curl -X POST \
  https://backup-[Project name]-[Environment].lfr.cloud/backup/upload \
  -H 'Content-Type: multipart/form-data' \
  -F 'database=@/my-folder/database.gz' \
  -F 'volume=@/my-folder/volume.tgz' \
  -u user@domain.com:password

Capability:

Cloud

Resource Type:

Official Documentation

Deployment Approach:

Liferay PaaS

Feature:

Cloud Platform Services