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

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

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の場合はパスカルケース)を使用してください。詳細については、 「表の正しい大文字小文字の区別を確保する」を参照してください。

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

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

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

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

データベースとドキュメントライブラリをアップロード用に準備する

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

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

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

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

ヒント

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

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

LCPツールを使用してバックアップをアップロードする場合、ボリュームファイルは不要です。ツールがドキュメントライブラリのファイルを自動的に圧縮するためです。

クラウドコンソールの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ツールを使用してください。

(管理者として)以下の手順に従って、選択した環境のバックアップページからバックアップをダウンロードしてください。

  1. ダウンロードしたいバックアップの「アクション」 (⋮)をクリックしてください。

  2. ダウンロードをクリックしてください。

     [Actions] ボタンをクリックして、[Download] をクリックします。

  3. ダウンロードを開始するには、データベース( .gz )ファイルまたはLiferay ( .tgz )ファイルをクリックしてください。これらのZIPアーカイブをまとめて、環境バックアップを構成します。

    注記

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

    クリックすると、データベースとLiferayのデータボリュームファイルをダウンロードできます。

コンソール経由でバックアップをアップロードする

警告

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

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

警告

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

バックアップページから以下の手順に従ってください。

  1. 画面上部付近にある「バックアップをアップロード」…をクリックします。

  2. バックアップのアップロードページで、該当する環境を展開し、データベースとドキュメントライブラリの両方の [+] アイコンをクリックしてアップロードします。

    アイコンをクリックすると、データベースとドキュメントライブラリの両方が.gz形式のアーカイブとしてアップロードされます。

  3. データベースダンプとドキュメントライブラリの両方がアップロードされたら、 「アップロードを開始」をクリックします。

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

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

バックアップが環境内のリストに追加されると、成功メッセージが表示されます。

バックアップサービスAPI

バックアップサービスには、バックアップのダウンロードやアップロードに使用できるAPIも用意されています。 curlなどのコマンドラインツールを使用して、これらのAPIを呼び出すことができます。バックアップサービスのバージョンで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 [Project master token]を使用する必要があります。 Liferay Cloudコンソールの任意のシェルで、コマンドenv | grep LCP_PROJECT_MASTER_TOKENを実行すると、プロジェクトマスタートークンを見つけることができます。

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

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

パラメータ

名前種類必須
idStringはい

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アーカイブとしてダウンロードされます。

データボリュームAPIをダウンロード

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

パラメータ

名前種類必須
idStringはい

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にバックアップをアップロードするには、以下の手順に従ってください。

  1. データベースファイル作成します。

  2. ボリュームファイル作成します。

  3. データベースとボリュームのファイルを使って、バックアップAPIを起動します。

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

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

パラメータ

名前種類必須
databaseFileはい
volumeFileはい

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