コマンドラインツール
CLI ツールを使用して、Liferay Cloud サービスを表示および管理できます。 インストール後、ターミナルで lcp --help を実行すると、利用可能なアクションが表示されます。
追加のログと情報を表示するには、任意の lcp コマンドの最後に -v または --verbose オプションを実行します。 任意の lcp コマンドの最後に --help フラグを実行すると、使用できるフラグが表示されます。
- 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 インストーラーをダウンロードし、ウィザードの手順に従います。
CLIツールのバージョン2から3へのアップグレード
バージョン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 分前"、 "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>
ドキュメントを開く
公式ドキュメント、ヘルプセンターのコンテンツなど、Liferay Cloud のリソースにアクセスするには、 lcp docs コマンドを使用します。
CLIツールのバージョン3のアンインストール
Mac および Linux の場合は、次のコマンドを実行します。
curl https://cdn.liferay.cloud/lcp/stable/latest/uninstall.sh -fsSL | bash
Windows 7 および 8 の場合は、 [コントロール パネル] → [プログラムの追加と削除]に移動します。 Windows 10 では、 コントロール パネル → プログラム → プログラムのアンインストールに移動します。 次に、 プログラムの一覧からLCP CLIを探し、［アンインストール］をクリックします。 ウィザードの手順に従います。