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

バックアップサービス

定期的なバックアップを維持することは、プロジェクトのデータ保護に不可欠です。 Liferay Cloudのバックアップサービスでは、環境データの反復を保存し、必要に応じて環境の復元に使用できます。これらのバックアップには、Liferay DXP データベースと [LIFERAY_HOME]/data フォルダの完全な内容が含まれます。

バックアップサービスは、Liferay Cloudで利用可能ないくつかのサービスのうちの1つです。

どの環境のバックアップページからでも、バックアップの作成、保持されたバックアップの表示またはダウンロード、そしてバックアップから環境を復元することができます。

Liferay Cloudコンソールまたはバックアップサービスの LCP.json ファイルを使用して、プロジェクトのニーズを満たすようにバックアップサービスを構成することもできます。

詳細については、バックアップサービスの制限セクションを参照してください。

バックアップページ

どの環境のバックアップページからでも、バックアップサービスの情報や保持されているバックアップの確認、手動でバックアップを作成したりすることができます。

注

バックアップページは、バックアップサービスのバージョンが4.3.5よりも古い場合、実稼働環境でのみ利用できます。

以下の手順で、バックアップページにアクセスします。

どの環境からでも、左側のメニューで バックアップ をクリックします。

どの環境でも、バックアップページからバックアップ履歴を表示したり、手動バックアップを作成したりできます。

ここから、以下の作業を行います。

バックアップ情報の表示：選択した環境のバックアップサービス情報をすばやく表示できます。これには、自動バックアップの頻度、バックアップの保持期間、次回のスケジュールされたバックアップ、最新の作成されたバックアップ、最も古い保持されたバックアップのタイムスタンプ情報が含まれます。
バックアップ履歴の表示：選択した環境で保持されているバックアップの完全なリストを表示できます。各エントリには、バックアップの名前、サイズ、タイプ (自動、 手動、または アップロード)、および作成時刻が表示されます。赤色のバックアップアイコンは、バックアップに失敗したことを示します。その横には、Backup failedというメッセージとサポートに連絡するためのリンクが表示されます。
手動バックアップの作成：選択した環境のバックアップを手動で作成できます。詳細については、手動バックアップの作成を参照してください。

注

バックアップのタイムスタンプはブラウザの場所に基づいて自動的に表示されますが、バックアップスケジュールは UTC±00 タイムゾーンに基づいています。

環境管理者は、［バックアップ］ページからアクションボタン(⋮)にアクセスし、保持しているバックアップのダウンロードや環境の復元を行うことができます。

管理者は、バックアップページからバックアップをダウンロードしたり、環境を復元したりできます。

また、画面上部の2つのセレクターから、バックアップのリストをステータス（失敗または成功）でフィルタリングしたり、関連するディザスタリカバリ（dr）環境（現在の環境に設定されている場合）からバックアップを表示したりすることもできます。

ディザスターリカバリーのバックアップを表示したり、ドロップダウンメニューからバックアップのステータスでフィルタリングしたりすることができます。

これらのアクションを実行する方法の詳細と手順については、「バックアップのダウンロードとアップロード」および「バックアップからのデータの復元」を参照してください。

手動バックアップの作成

バックアップページから環境を手動でバックアップするには、 今すぐバックアップをクリックします。このプロセスは、サービスの規模に応じて数分から数時間かかります。

起動すると、バックアップサービスのアイコンはバックアップ中であることを示し、画面上部にメッセージが表示されます。新しいバックアップは、［Backup History］にも表示されます。

画面上部のバックアップサービスのアイコンとメッセージは、バックアップ中であることを示します。

警告

Liferayインスタンス上でデータが能動的に変更されている間に作成されたバックアップは、一貫性のないデータを作成する危険性があります。完全に一貫したバックアップを行うためには、データベース管理者と調整して、手動バックアップを行っている間は更新をフリーズするようにしてください。

［View logs］をクリックすると［Logs］ページにリダイレクトされ、リアルタイムでバックアップステージを確認することができます。バックアップログは、バックアップサービスページのログタブでも表示できます。

サービスログの表示の詳細については、 Liferay Cloud サービスログの読み取りを参照してください。

バックアップサービスの設定

Liferay Cloudコンソールまたはバックアップサービスの LCP.json ファイルを使用して、プロジェクトのニーズを満たすようにバックアップサービスを設定できます。

バックアップサービスを構成するために使用できる変数のリストについては、環境変数リファレンスを参照してください。

重要

バックアップサービスは再構成されるたびに再起動され、数分間リクエストの受信が停止したり、構成に応じて異なる動作をしたりすることがあります。

Liferay Cloudコンソールによるバックアップサービスの設定

バックアップサービスが導入されている環境に移動します。
環境メニューの ［Services］ をクリックします。
バックアップサービスの環境変数を表示するには、 バックアップ サービスをクリックします。

環境の概要ページで バックアップ をクリックして、バックアップサービスのページにアクセスすることもできます。
バックアップサービスを構成するには、環境変数リファレンスリストから変数を追加します。
変更を保存をクリックします。

通常の環境変数とは別に、Liferay Cloudコンソールからシークレット変数を設定することができます。詳細については、 Secret を使用した安全な環境変数の管理を参照してください。

バックアップ`LCP.json`ファイルによるバックアップサービスの設定

テキストエディターを使って、以下のパスにあるバックアップLCP.jsonファイルを開きます。 /{your_project_name}/backup/LCP.json

環境セクションまでスクロールします。

"env": {
  "LCP_BACKUP_FOLDER": "/opt/liferay/data",
  "LCP_DATABASE_SERVICE": "mydatabase",
  "LCP_MASTER_USER_PASSWORD": "mypassword"
},

バックアップサービスを構成するには、環境変数リファレンスリストから変数を追加します。
ファイルを保存し、プロジェクトにデプロイして構成を実装します。

環境サービスを LCP.json ファイル経由で構成する方法の詳細については、 LCP.json 経由の構成を参照してください。

自動バックアップとクリーンアップのスケジューリング

バックアップの作成と削除の頻度を決定することは、データの保護とストレージの最適化に役立ちます。

警告

Liferay インスタンスでデータがアクティブに変更されている間にバックアップを作成すると、データの不整合が生じるリスクがあります。データの不整合のリスクを軽減するために、アクティビティが減少した時間帯にバックアップスケジュールが開始されるように構成します。完全に一貫性のあるバックアップを確実に行うには、データベース管理者と連携して、手動バックアップの実行中に更新を凍結し、クリーンアップスケジュール (LCP_BACKUP_CLEANUP_SCHEDULE) とは 異なる時刻 に実行するように設定します。

自動バックアップのスケジュールを設定するには、2つの方法があります。

コンソール経由
環境変数の利用

コンソールでスケジュールを設定する

選択した環境から、［Backup］サービスに移動し、［Configuration］タブをクリックします。

注

この環境にバックアップがない場合は、[バックアップサービス] ページの [定期的なバックアップを設定する] リンクをクリックしても、[構成] タブが表示されます。
[バックアップの作成] ドロップダウンメニューで利用可能なオプションから、希望するバックアップ頻度を選択します。
- Daily：毎日バックアップが作成され、作成時刻を設定できます（UTC±00のタイムゾーン）。実稼働環境では毎日のバックアップが推奨されます。
- Weekly：毎週バックアップが作成され、曜日と作成時刻を設定できます（UTC±00タイムゾーン）。
- 詳細: より複雑な頻度を設定するには、 cron スケジュール値を設定します。
- 未設定 (手動): 自動バックアップは作成されません。すべてのバックアップを手動で作成する必要があります。これは非本番環境のデフォルト設定です。
［Remove backups older than］セレクターから目的の保存期間を選択します。
変更を保存をクリックします。

バックアップサービスが再起動し、サービスが完全に再起動した時点で変更内容が適用されます。

環境変数でスケジュールを設定する

バックアップが作成および削除されるタイミングをカスタマイズするには、環境ごとに次の変数を使用します。

自動バックアップ: 自動バックアップの頻度を設定するには、 LCP_BACKUP_CREATE_SCHEDULE 変数に cron スケジュール値を追加します。
自動クリーンアップ: 自動バックアップクリーンアップの頻度を設定するには、 LCP_BACKUP_CLEANUP_SCHEDULE 変数に cron スケジュール値を追加します。
保存期間：LCP_BACKUP_RETENTION_PERIOD変数に数値（0～30の間）を追加して、自動クリーンアップで削除される前にバックアップを保持する日数を設定します。

注

標準と非標準の両方の cron スケジュール構文は、UTC±00 タイムゾーンに基づいています。非標準のcron構文を使用する場合、自動バックアップとクリーンアップは指定された値の先頭で実行されます。たとえば、 @daily は毎日 00:00 UTC にバックアップを実行します。

これらの環境変数は、 Liferay Cloud コンソール（バックアップサービス内）で設定するか、プロジェクトリポジトリの backup/LCP.json ファイルで設定し、バックアップサービスを環境にデプロイすることで使用できます。

警告

Liferay Cloudコンソールで環境変数を設定し、その後、 backup/LCP.jsonで異なる設定を使用してリポジトリからバックアップサービスをデプロイすると、リポジトリの設定によってコンソールで設定された環境変数が上書きされます。

この backup/LCP.json の例では、12 時間ごとに (つまり、UTC の 00:00 と 12:00) バックアップを作成し、30 日以上経過したバックアップを削除する月次クリーンアップを実行します。

"env": {
  "LCP_BACKUP_FOLDER": "/opt/liferay/data",
  "LCP_DATABASE_SERVICE": "mydatabase",
  "LCP_MASTER_USER_PASSWORD": "mypassword",
  "LCP_BACKUP_CREATE_SCHEDULE": "0 0,12 * * *",
  "LCP_BACKUP_CLEANUP_SCHEDULE": "@monthly",
  "LCP_BACKUP_RETENTION_PERIOD": "30"
},

バックアップサービスのパフォーマンスの向上

バックアップサービスを構成すると、バックアップのサイズを縮小したり、バックアップの作成および復元プロセスを高速化してパフォーマンスを向上させることができます。

バックアップからアダプティブメディアを除外する

Liferay SaaS Liferay PaaS + Google Cloud Storage Liferay DXP 2024.Q3+ バックアップサービス 5.17.0+

バックアップを作成および復元するときに、アダプティブメディアを除外することを選択できます。 Liferay は必要に応じて適応型メディアを生成できるため、バックアップする必要はありません。この機能を有効にするには、 LCP_BACKUP_EXCLUDE_GENERATED_DL_FILES_ON_BACKUP_CREATE と LCP_BACKUP_EXCLUDE_GENERATED_DL_FILES_ON_BACKUP_RESTORE の値を trueに設定します。バックアップされるデータの量を減らすことで、バックアップはより高速かつ軽量になります。

移転戦略の発見

Google Cloud Storage Liferay DXP 2024.Q1.6+ バックアップサービス 5.17.0+

GCS (Google Cloud Storage) でバックアップを復元する場合、バックアップサービスで転送戦略を使用する必要があります。 Liferay Cloud は、ドキュメントライブラリの 2 つの転送戦略をサポートしています: gsutil と rclone。

バックアップサービスログを通じて、どの転送戦略が使用されているかを確認できます。 GCS でバックアップを復元すると、次のようなメッセージが表示されます。

Spawning [TRANSFER_STRATEGY] process to transfer files from [SOURCE] to [DESTINATION]

[TRANSFER_STRATEGY] に記述されているコマンドは、 gsutil または rcloneのいずれかです。

LCP_DOCUMENT_LIBRARY_GCS_TRANSFER_STRATEGY 環境変数を使用して転送戦略を選択できます。デフォルトでは、バックアップサービスはgsutilを使用し、rcloneをサポートしていないLiferay DXPのバージョンでもバックアップがスムーズに実行されるようにしています。

注

バックアップ転送戦略として、rclone は gsutil よりも高速、軽量、エラーが発生しにくくなります。上記のように、Liferay DXP バージョンがサポートしている場合は、常に rclone を使用してください。

バックアップサービスのバージョン管理

Liferay Cloud は、バックアップサービスの最小バージョンを設定します。これは通常、他のサービスが古いバックアップサービスと互換性がなくなった場合、または新しいバージョンで重要な修正や機能強化が導入された場合に行われます。

Liferay Cloudが最小バージョンを上げると、バックアップサービスが新しい最小要件を満たしていない場合、自動的にアップグレードします。 Liferay Cloud が下位バージョンのデプロイメントを上書きすると、ログと概要ページにメッセージが表示されます。

サービスがアップグレードされたことを通知するメッセージが概要ページに表示されます。

注

Liferay Cloud が最小バージョンを下げても、バックアップサービスは影響を受けません。新しい要件を満たす古いバージョンを手動でデプロイできます。

主要な展開ディレクトリ

ファイルタイプ	パス	説明
SQLスクリプト	バックアップ/configs/[ENV]/scripts/	ここでの `.sql` スクリプトは、各バックアップの復元後に自動的に実行されます。

環境変数リファレンス

名前	デフォルト値	説明
`LCP_BACKUP_CLEANUP_SCHEDULE`	`0 1 * * *`	cron スケジュール構文を使用して自動クリーンアップをスケジュールします。クリーンアップでは、バックアップ保持期間を超えたバックアップをすべて削除します。 `LCP_BACKUP_CREATE_SCHEDULE`と競合してはなりません。
`LCP_BACKUP_CREATE_SCHEDULE`	`[5-55][0-1] * * *`	cron スケジュール構文を使用して自動バックアップをスケジュールします。 `LCP_BACKUP_CLEANUP_SCHEDULE`と競合してはなりません。バックアップサービスのバージョン `3.2.1` 以上では、値が指定されていない場合はランダムなデフォルトが作成されます。
`LCP_BACKUP_EXCLUDE_GENERATED_DL_FILES_ON_BACKUP_CREATE`	`false`	バックアップを作成するときに、ドキュメントライブラリからアダプティブメディアを除外します。詳細については、「バックアップからアダプティブメディアを除外する」を参照してください。
`LCP_BACKUP_EXCLUDE_GENERATED_DL_FILES_ON_BACKUP_RESTORE`	`false`	バックアップを復元するときに、ドキュメントライブラリからアダプティブメディアを除外します。詳細については、「バックアップからアダプティブメディアを除外する」を参照してください。
`LCP_BACKUP_RESTORE_SCHEDULE`	該当なし	cron スケジュール構文を使用して自動復元をスケジュールします。災害復旧環境で使用することを目的としています。
`LCP_BACKUP_RESTORE_DL_DOWNLOAD_AND_EXTRACT_STRATEGY`	`download-then-extract`	ドキュメントライブラリのダウンロードおよび抽出戦略を決定します。頻繁に変更されない静的データのバックアップには`download-then-extractを`使用し、頻繁に変更されるデータパイプラインには`stream-pipelineを`使用し、迅速なリカバリーが必要です。
`LCP_BACKUP_RETENTION_PERIOD`	`30`	スケジュールされたクリーンアップ中に削除されるバックアップを決定します。クリーンアップによって削除される前にバックアップを保持する日数を選択します。 0 から 30 までの値のみが許可されます。
`LCP_DATABASE_SERVICE`	`database`	データベースサービスの ID。
`LCP_DBNAME`	`lportal`	データベース名。
`LCP_DEBUG_LOG`	`false`	Backupサービスのデバッグログを有効にします。 `true` または `false`に設定します。
`LCP_DOCUMENT_LIBRARY_GCS_TRANSFER_STRATEGY`	`gsutil`	ドキュメントライブラリの転送戦略を決定します。 `rclone` には最低限の Liferay バージョンが必要ですが、パフォーマンスが向上します。
`LCP_GCP_STORAGE_UPLOAD_MAX_RETRIES`	`6`	バックアップのアップロードに失敗した場合に再試行する最大回数です。この制限を超えると、アップロードは中断され、完全にやり直しになることがあります（最大2回まで）。
`LCP_GCP_STORAGE_UPLOAD_MAX_RETRY_DELAY`	`64`	`LCP_GCP_STORAGE_UPLOAD_MAX_RETRIES`によって設定される各再試行間の遅延 (秒単位)。
`LCP_GCP_STORAGE_UPLOAD_RETRY_DELAY_MULTIPLIER`	`3`	以降の再試行ごとに`LCP_GCP_STORAGE_UPLOAD_MAX_RETRY_DELAY`で設定された遅延時間を乗算します。
`LCP_GCP_STORAGE_UPLOAD_TIMEOUT`	`6000`	バックアップアップロードリクエスト（または再試行）間の最大遅延時間（秒）。 `LCP_GCP_STORAGE_UPLOAD_RETRY_DELAY_MULTIPLIER` が遅延時間を増加できる量の上限を設定します。
`LCP_MASTER_USER_NAME`	`dxpcloud`	マスターユーザー名。
`LCP_MASTER_USER_PASSWORD`	`LCP_PROJECT_MASTER_TOKEN`	マスターパスワード。
`LCP_SERVICE_LOG_LEVEL`	`INFO`	表示するログメッセージの最低優先度レベル。ログレベルの名前または数値を設定します。詳細については、ログレベルを参照してください。