Documentation

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

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

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

注釈

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

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

以下の手順で、選択した環境の [バックアップ] ページからバックアップをダウンロードします:

  1. ダウンロードしたいバックアップの Actions ボタン( ⋮ )をクリックします。

  2. ダウンロード] をクリックします。

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

  3. Database(.gz) または Liferay(.tgz) のファイルをクリックすると、ダウンロードが始まります。 これらのZIPアーカイブを合わせて、環境のバックアップとします。

    注釈

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

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

注釈

選択した環境の管理者のみが、バックアップページからバックアップをダウンロードできます。

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

また、 選択した環境の [バックアップ] ページから、プロジェクトにバックアップをアップロードすることもできます。

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

警告

アップロードが開始されると、アップロードが完了するまで、バックアップサービスは他のバックアップの生成やリストアに利用できません。

バックアップ のページから以下の手順を行います。

  1. 画面上部の 「バックアップをアップロード...」をクリックします。画面上部の をクリックします。

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

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

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

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

バックアップが生成されると、ページに成功のメッセージが表示され、サービスが正常に動作するようになります。

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

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

バックアップサービスにはAPIが用意されており、バックアップのダウンロードやアップロードにも利用できます。 これらのAPIは、 curlのようなコマンドラインツールを使って呼び出すことができます。

ホスト名の取得

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

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

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

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

  • サービス名 バックアップサービス名:` バックアップ

  • プロジェクト名です。 lfrjoebloggs`です。 * 環境名です。 `prd`となります。 * ホスト名です。 `backup-lfrjoebloggs-prd.lfr.cloud`
  • 認証

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

    なお、SSOが有効な場合は、トークン認証が必要です。 このトークンをクッキー access_token から取得し、 dxpcloud-authorization headerと一緒に使用することができます。

    以下は、upload 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 以降でのみ機能します。 以前のバージョンは、少なくとも 3.2.0 にアップグレードする必要があります。 それ以前のバージョンへのリクエストはヘッダ Authorization.Bearer' を使用する必要があります。Bearer . プロジェクトマスタートークンは、Liferay Cloud コンソールの任意のシェルで env | grep LCP_PROJECT_MASTER_TOKEN コマンドを実行することで見つけることができます。

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

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

    パラメーター

    名称

    Type (Automatic Copy)

    必須

    id

    文字列

    はい

    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)。

    パラメーター

    名称

    Type (Automatic Copy)

    必須

    id

    文字列

    はい

    curlの例

    curl -X GET \
      https://backup-<PROJECT-NAME>-<ENV>.lfr.cloud/backup/download/volume/id \
      -u [email protected]:password \
      --output volume.tgz
    

    バックアップAPIをアップロードする

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

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

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

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

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

    Backup APIの起動

    パラメーター

    名称

    Type (Automatic Copy)

    必須

    データベース

    ファイル

    はい

    体積

    ファイル

    はい

    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
    

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

    お客様の環境のバックアップをLiferay Cloudにアップロードするためには、その環境のデータベースとドキュメントライブラリが別々のアーカイブファイルとして準備されている必要があります。

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

    MySQLのダンプを( .sql スクリプトとして)作成し、それを .gz アーカイブに圧縮するには、以下のコマンドを実行します。

    mysqldump -uroot -ppassword --add-drop-database --databases lportal | gzip -c | cat > database.gz
    

    注釈

    バックアップサービスが少なくともバージョン 4.2 に更新されていない場合、以下のコマンドを実行してアーカイブを .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`;
    

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

    また、ドキュメントライブラリは、アップロード可能な形式に圧縮されている必要があります。

    Tip

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

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

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

    追加情報