コマンドラインツール
CLIツールは、Liferay Cloudのサービスを表示・管理するために使用することができます。 インストール後、ターミナルで lcp --help を実行すると、利用可能なアクションが表示されます。
すべての 「lcp」コマンドの最後に 「-v」 または 「–verbose」オプションを実行すると、追加のログや情報を見ることができます。 すべての 「lcp」コマンドの最後に 「–help」フラグを実行すると、そのコマンドで使用できるフラグが表示されます。
- CLIツールのインストール
- CLIツールのバージョン2から3へのアップグレード
- CLIリモートの設定
- サービスログを表示する
- サービスインスタンスの数の変更
- プロジェクトまたはサービスの一覧表示
- サービスの再起動
- Liferayクラウド環境へのデプロイメント
- サービスのシェルへのアクセス
- CLIツールのバージョン3のアンインストール
CLIツールのインストール
*nix Systems
ターミナルを開き、以下のコマンドを実行します：
curl https://cdn.liferay.cloud/lcp/stable/latest/install.sh -fsSL | bash
パーミッションのエラーが出た場合は、もう一度コマンドを実行し、 bash を sudo bashに置き換えてみてください。
Windowsシステム
Windowsインストーラー の最新バージョンをダウンロードし、ウィザードの手順に従います。
CLIツールのバージョン2から3へのアップグレード
バージョン3をインストールして使用するには、まず現在のバージョンをアンインストールする必要があります。 これにより、同じバイナリ名との競合が防止されます。
以下の手順は、CLIバージョン2のアンインストールに固有のものであり、 CLIツールのバージョン3をアンインストールする の手順とは同じではありません。
MacOSまたはLinuxでのバージョン2のアンインストール
ターミナルを開いて
lcp uninstallを実行します。コマンド
lcp実行して、アンインストールが完了したことを確認します。
Windowsでのバージョン2のアンインストール
Windows 10では、 ［コントロールパネル］ → ［プログラム］ → ［プログラムのアンインストール］ に移動します。 また、Windows 7および8の場合は、 ［コントロールパネル］ → ［Add or Remove Programs］ に進みます。
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>
サービスログを表示する
特定のプロジェクト、サービス、およびインスタンスのログを表示するには、 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 パラメータを使って期間を指定することで、（例： yesterday、yesterday at 9pm、10 minutes ago、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を実行することで確認できます。
プロジェクト環境のすべてのサービスとそのインスタンスを表示して、スケールするサービスを選択します：
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ツールによる変更点のデプロイ を参照してください。
サービスのシェルへのアクセス
サービスコンテナのシェルにアクセスするには、次のコマンドを実行します：
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の場合は、 ［コントロールパネル］ → ［Add or Remove Programs］ に進みます。 Windows 10では、 ［コントロールパネル］ → ［プログラム］ → ［プログラムのアンインストール］ に移動します。 次に、 プログラムの一覧から LCP CLI を探し、［アンインストール］をクリックします。 ウィザードの手順に従います。