コマンドラインツール
CLIツールを使用すると、Liferay Cloudサービスを表示および管理できます。 インストール後、ターミナルで lcp --help を実行すると、利用可能なアクションが表示されます。
任意のlcpコマンドの末尾に-vまたは--verboseオプションを指定すると、追加のログや情報を表示できます。 --help フラグを lcp コマンドの最後に実行して、使用できるフラグを確認してください。
- CLIツールのインストール
- ダウンロードの確認
- CLIツールのバージョン2から3へのアップグレード
- CLIリモートの設定
- サービスログの表示
- サービスインスタンスの数の変更
- プロジェクトまたはサービスの一覧表示
- サービスの再起動
- Liferayクラウド環境へのデプロイ
- Liferayサービスからファイルをダウンロードする
- サービスのシェルへのアクセス
- CLIツールのバージョン3のアンインストール
CLIツールのインストール
*nixシステム
ターミナルを開いて、以下のコマンドを実行してください。
curl https://cdn.liferay.cloud/lcp/stable/latest/install.sh -fsSL | bash
権限エラーが発生した場合は、コマンドを再度実行し、 bash を sudo bash に置き換えてみてください。
Windowsシステム
Windows インストーラーの最新バージョンをダウンロードし、ウィザードの手順に従ってください。
ダウンロードの確認
各リリースには、各インストーラーおよびバイナリのSHA-256チェックサムが含まれています。 以下の手順で新しいコピーをダウンロードし、その整合性を確認してください。
インストーラースクリプト(LinuxおよびmacOS)
-
スクリプトとそのチェックサムをダウンロードしてください。
curl -fsSLO https://cdn.liferay.cloud/lcp/stable/latest/install.sh curl -fsSLO https://cdn.liferay.cloud/lcp/stable/latest/install.sh.checksum -
ハッシュ値を比較してください。
Linux:
[ "$(sha256sum install.sh | awk '{print $1}')" = "$(tr -d '[:space:]' < install.sh.checksum)" ] \ && echo "OK" || echo "Checksum mismatch — do not run."macOS:
[ "$(shasum -a 256 install.sh | awk '{print $1}')" = "$(tr -d '[:space:]' < install.sh.checksum)" ] \ && echo "OK" || echo "Checksum mismatch — do not run."
出力が OKの場合は、 インストール に進んでください。 チェックサムの不一致が表示された場合は、ダウンロードしたファイルを削除して再度試してください。
アンインストーラースクリプト(LinuxおよびmacOS対応)
-
スクリプトとそのチェックサムをダウンロードしてください。
curl -fsSLO https://cdn.liferay.cloud/lcp/stable/latest/uninstall.sh curl -fsSLO https://cdn.liferay.cloud/lcp/stable/latest/uninstall.sh.checksum -
ハッシュ値を比較してください。
Linux:
[ "$(sha256sum uninstall.sh | awk '{print $1}')" = "$(tr -d '[:space:]' < uninstall.sh.checksum)" ] \ && echo "OK" || echo "Checksum mismatch — do not run."macOS:
[ "$(shasum -a 256 uninstall.sh | awk '{print $1}')" = "$(tr -d '[:space:]' < uninstall.sh.checksum)" ] \ && echo "OK" || echo "Checksum mismatch — do not run."
出力が OKの場合は、 アンインストール に進みます。 チェックサムの不一致が表示された場合は、ダウンロードしたファイルを削除して再度試してください。
Linuxバイナリ
-
バイナリファイルとそのチェックサムをダウンロードしてください。
curl -fsSLO https://cdn.liferay.cloud/lcp/stable/latest/lcp-linux.tgz curl -fsSLO https://cdn.liferay.cloud/lcp/stable/latest/lcp-linux.tgz.checksum -
ハッシュ値を比較してください。
[ "$(sha256sum lcp-linux.tgz | awk '{print $1}')" = "$(tr -d '[:space:]' < lcp-linux.tgz.checksum)" ] \ && echo "OK" || echo "Checksum mismatch — do not install."
出力が OKの場合は、 インストール に進んでください。 チェックサムの不一致が表示された場合は、ダウンロードしたファイルを削除して再度試してください。
macOSバイナリ
-
バイナリファイルとそのチェックサムをダウンロードしてください。
curl -fsSLO https://cdn.liferay.cloud/lcp/stable/latest/lcp-macos.tgz curl -fsSLO https://cdn.liferay.cloud/lcp/stable/latest/lcp-macos.tgz.checksum -
ハッシュ値を比較してください。
[ "$(shasum -a 256 lcp-macos.tgz | awk '{print $1}')" = "$(tr -d '[:space:]' < lcp-macos.tgz.checksum)" ] \ && echo "OK" || echo "Checksum mismatch — do not install."
出力が OKの場合は、 インストール に進んでください。 チェックサムの不一致が表示された場合は、ダウンロードしたファイルを削除して再度試してください。
Windowsバイナリ
Windows インストーラー (lcp-install.exe) には公開されたチェックサムがありません。 バイナリアーカイブを使用して検証するには:
-
PowerShellを開きます。
-
バイナリファイルとそのチェックサムをダウンロードしてください。
curl.exe -fsSLO https://cdn.liferay.cloud/lcp/stable/latest/lcp-win.tgz curl.exe -fsSLO https://cdn.liferay.cloud/lcp/stable/latest/lcp-win.tgz.checksum -
ハッシュ値を比較してください。
if ((Get-FileHash lcp-win.tgz -Algorithm SHA256).Hash.ToLower() -eq (Get-Content lcp-win.tgz.checksum).Trim()) { Write-Host "OK" } else { Write-Host "Checksum mismatch — do not install." }
出力が OKであれば、アーカイブは検証済みです。 チェックサムの不一致が表示された場合は、ダウンロードしたファイルを削除して再度試してください。
CLIツールのバージョン2から3へのアップグレード
バージョン3をインストールして使用するには、まず現在のバージョンをアンインストールする必要があります。 これにより、同じバイナリ名との競合が防止されます。
この手順は、CLI バージョン 2 のアンインストールに関するものであり、CLI ツール バージョン 3 のアンインストール手順とは異なります。
MacOSまたはLinuxでのバージョン2のアンインストール
-
ターミナルを開いて
lcp uninstallを実行します。 -
コマンド
lcp実行して、アンインストールが完了したことを確認します。
Windowsでのバージョン2のアンインストール
-
Windows 10 では、 コントロール パネル → プログラム → プログラムのアンインストール に移動します。
または、Windows 7 および 8 の場合は、 コントロール パネル → プログラムの追加と削除 に移動します。
-
lcp amd64-installer-0.3を選択します。 -
アンインストール をクリックしてから確認してください。
-
lcpまたはlcp.exeコマンドを実行して、アンインストールが完了したことを確認してください。
バージョン3をインストールする前に、CLIバージョン2がアンインストールされていることを確認してください。
バージョン3のインストール
バージョン 2 をアンインストールしたら、上記の手順に従ってCLI ツールのバージョン 3 をインストールしてください。
CLIリモートの設定
CLI ツールを介して Liferay Cloud サービスにアクセスするには、Liferay Cloud のリモート URL を指すように構成する必要があります: liferay.cloud。
CLIのリモートを一覧表示するには、次のコマンドを実行します。
lcp remote
以下のコマンドを使用して、CLIツールに新しいリモートを追加できます。
lcp remote set <remote-alias> <remote-url>
必要に応じて、デフォルトのリモートを変更できます:
lcp remote default <remote-alias>
または、リモートインラインを指定することもできます:
lcp shell -p <project-id> --service <service-id> --remote <remote-alias>
バックアップのダウンロード
ID を使用して特定のバックアップをダウンロードするには、 lcp backup コマンドを使用します。
データベースとドキュメントライブラリを同時にダウンロードするには、以下のコマンドを実行してください。
lcp backup download --backupId <ID>
または、 --database または --doclib フラグを追加して、指定したものだけをダウンロードします。
lcp backup download <type> --backupId <ID>
サービスログの表示
特定のプロジェクト、サービス、およびインスタンスのログを表示するには、 lcp log コマンドを使用します。 以下に一般的なコマンドを示しますが、 lcp log --help を実行すると、使用可能なコマンドオプションを確認できます。
プロジェクト環境のすべてのサービスログを表示します:
lcp log -p <project>-<environment>
プロジェクト環境における単一のサービスのログを表示します:
lcp log -p <project>-<environment> -s <service>
または、サービスの完全なURLを使ってログを表示することもできます:
lcp log --url <service>-<project>-<environment>.lfr.cloud
デフォルトでは、 lcp log コマンドは、ネットワークへの影響を減らすために10,000行のみを返します。 ただし、 --since および --until パラメータを使用して期間を指定することで、この制限を回避できます (例: 昨日、 "昨日午後 9 時"、 "10 分12日前"、 "mm/dd/YYYY HH:mm:ss")。
プロジェクト環境の特定の時間から現在までのすべてのサービスログを表示します:
lcp log -p <project>-<environment> --since <start_time>
特定の期間のプロジェクト環境のすべてのサービスログを表示します:
lcp log --since "<start_time>" --until "<end_time>"
lcp log コマンドの出力をファイルにパイプするには、コマンドの末尾に >> "<new-file.txt>" を追加します。 実行すると、新しいファイルが端末の現在のパスに作成されます。
lcp log -p <project>-<environment> -s <service> --since "<start_time>" --until "<end_time>" >> "<new-file.txt>"
サービスインスタンスの数の変更
環境サービスを個別に拡張するには、 lcp scale コマンドを使用します。 これらの例には一般的なコマンドが含まれていますが、 lcp scale --help を実行すると、使用可能なコマンドオプションを確認できます。
このコマンドは非推奨です。 代わりに、ダッシュボードでサービスインスタンスの最小数と最大数を設定できます。 スケーリングの詳細については、 Liferay サービスのスケーリング を参照してください。
プロジェクト環境のすべてのサービスとそのインスタンスを表示して、スケールするサービスを選択します:
lcp scale -p <project>-<environment>
その後、端末の指示に従ってサービスを選択し、そのインスタンス数を決定します。
また、 lcp scale コマンドの一部として、対象となるサービスと必要なインスタンス数を指定することもできます:
lcp scale -p <project>-<environment> -s <service> <instances>
また、完全なURLを使用してインスタンスをスケーリングすることもできます:
lcp scale --url <service>-<project>-<environment>.lfr.cloud <instances>
プロジェクトまたはサービスの一覧表示
lcp list コマンドを使用すると、プロジェクトのサービスが、それぞれのイメージとステータスとともに表示されます。 これらの例には一般的なコマンドが含まれていますが、 lcp list --help を実行すると、使用可能なコマンドオプションを確認できます。
自分が所有または関わっているプロジェクト、サービス、インスタンスの全リストを表示します:
lcp list
環境に応じたサービスのイメージとステータスを表示します:
lcp list -p <project>-<environment>
特定のサービスのイメージとステータスを確認します:
lcp list -p <project>-<environment> --service <serviceID>
また、 lcp listに完全なURLを渡して、サービスをチェックすることもできます:
lcp list --url <service>-<project>-<environment>.lfr.cloud
サービスの再起動
lcp restart コマンドを使用して、環境サービスを再起動します。 これらの例には一般的なコマンドが含まれていますが、 lcp restart --help を実行すると、使用可能なコマンドオプションを確認できます。
すべてのプロジェクトの環境とサービスを表示して、再起動する環境サービスを選択します:
lcp restart
プロジェクトの特定のサービスを再起動します:
lcp restart -p <project>-<environment> -s <service>
または、完全なURLを lcp restart渡してサービスを再起動します:
lcp restart --url <serviceID>-<projectID>.lfr.cloud
Liferayクラウド環境へのデプロイ
lcp deploy コマンドを使用して、特定のサービスまたはすべてのサービスをいずれかの環境にデプロイします:
lcp deploy
リポジトリのルートディレクトリから lcp deploy を実行すると、適用可能なすべてのサービスが選択した環境にデプロイされます。 1つのサービスのフォルダ(サービスのLCP.json ファイルがあるフォルダ)からコマンドを実行して、そのサービスを環境にデプロイします。
-r をつけてコマンドを実行すると、デフォルト以外のリモート(ID)を指定することができます。
lcp deploy -r <remote-id>
詳細については、 CLIツールによる変更のデプロイ を参照してください。
Liferayサービスからファイルをダウンロードする
Liferay サービスからファイルをダウンロードするには、 files download コマンドを使用します。 ファイルは、Liferay サービスの永続ストレージディレクトリ (/mnt/persistent-storage/ ) 内に配置する必要があります。
例えば、
lcp files download --prefix path/to/files --dest destination
このコマンドは、Liferay サービスの /mnt/persistent-storage/path/to/files/ ディレクトリからすべてのファイルを destination/ フォルダにダウンロードします。
--concurrency フラグを使用して、並列ダウンロードするファイルの数を変更します(デフォルトは 100)。
例えば、以下のコマンドは、 /mnt/persistent-storage/path/to/files/ ディレクトリからすべてのファイルを現在の作業ディレクトリにダウンロードします。一度に最大 600 ファイルまでダウンロードできます。
lcp files download --prefix path/to/files --concurrency 600
lcp files download --help を実行して、利用可能なすべてのコマンドオプションを確認してください。
サービスのシェルへのアクセス
サービスコンテナのシェルにアクセスするには、次のコマンドを実行します。
lcp shell
これにより、コンテナ内のすべてのサービスがリストアップされ、どのサービスにアクセスするかを選択するよう促されます。
または、サービスのプロジェクトIDとサービスIDをlcp shellコマンドに追加して、特定のサービスのコンテナのシェルにアクセスします:
lcp shell -p <project>-<environment> -s <service>
ドキュメントを開く
lcp docs コマンドを使用して、公式ドキュメント、ヘルプセンターのコンテンツなど、Liferay Cloud のリソースにアクセスします。
CLIツールのバージョン3のアンインストール
MacとLinuxの場合は、次のコマンドを実行してください。
curl https://cdn.liferay.cloud/lcp/stable/latest/uninstall.sh -fsSL | bash
Windows 7 および 8 の場合は、 コントロール パネル → プログラムの追加と削除 に移動します。 Windows 10 では、 コントロール パネル → プログラム → プログラムのアンインストール に移動します。 次に、 プログラムの一覧からLCP CLIを探し、[アンインストール]をクリックします。 ウィザードの手順に従います。