IBM Cloud Docs
CLI のセットアップ

CLI のセットアップ

必要な CLI をインストール、更新、および削除し、IBM Cloud® Code Engine を使用するように環境をセットアップします。

Code Engine CLI でサポートされる環境

Code Engine CLI は、以下の環境をサポートします。

  • Linux 64 ビット
  • Linux 64 ビット ARM
  • Linux 32 ビット
  • Mac OS X 64 ビット
  • Mac OS X M1/ARM
  • Windows 64 ビット
  • Windows 32 ビット

IBM Cloud CLI のインストール

IBM Cloud CLI の最新バージョンをインストールします。

開始前に

IBM Cloud アカウントを作成する必要があります。

  1. IBM Cloud CLI をダウンロードしてインストールします。

    このインストールには、以下のファイルが含まれています。

    • IBM Cloud Functions プラグイン
    • IBM Cloud Object Storage プラグイン
    • IBM Cloud Container Registry プラグイン
    • IBM Cloud Kubernetes Service プラグイン

    詳しくは、IBM Cloud CLI を参照してください。

  2. IBM Cloud CLI にログインします。

    ibmcloud login
    
  3. アカウントを複数お持ちの場合、使用するアカウントを選択するよう求めるプロンプトが表示されます。 プロンプトの指示に従うか、target コマンドを使用して IBM Cloud アカウントを選択します。

    ibmcloud target -c <account_id>
    
  4. リージョンを指定する必要もあります。 target コマンドを使用して、リージョンをターゲットに設定するか、リージョンを変更します。

    ibmcloud target -r <region>
    
  5. リソース・グループを指定しなければなりません。 リソース・グループのリストを取得するには、以下のコマンドを実行します。

    ibmcloud resource groups
    

    出力例

    Retrieving all resource groups under account <account_name> as email@ibm.com...
    OK
    Name      ID                                 Default Group   State   
    default   a8a12accd63b437bbd6d58fb8b462ca7   true            ACTIVE
    test      a8a12abbbd63b437cca6d58fb8b462ca7  false           ACTIVE
    
  6. 以下のコマンドを実行して、リソース・グループをターゲットに設定します。

    ibmcloud target -g <resource_group>
    

    出力例

    Targeted resource group default
    

Code Engine CLI プラグインのインストール

Code Engine CLI の最新バージョンをインストールします。

必ず、IBM Cloud CLI の最新バージョンがインストールされるようにします。 そうしないと、Code Engine CLI のインストールが失敗し、Could not find compatible binary to install for plug-in code-engine のようなメッセージが表示される可能性があります。

  1. Code Engine プラグインをインストールします。

    ibmcloud plugin install code-engine
    
  2. ibmcloud plugin show code-engine コマンドを使用して、プラグインがインストールされていることを確認します。

    ibmcloud plugin show code-engine
    

    出力例

    Plugin Name                              code-engine[ce]
    Plugin Version                           1.31.0
    Plugin SDK Version                       0.9.0
    Minimal IBM Cloud CLI version required   1.0.0
    Private endpoints supported              true
    
    Commands:
    code-engine,ce                    Manage Code Engine components.
    [...]
    
  3. Code Engine コマンドを実行するには、**ibmcloud code-engineまたはibmcloud ce**を使用します。 Code Engine プラグインで実行できることをすべて表示するには、引数なしで ibmcloud ce を実行します。

    ibmcloud ce
    

オプションで、 jq パッケージをインストールできます。 多くの Code Engine コマンドには、JSON 出力を作成するためのオプション (--output JSON) が用意されています。 このパッケージを使用すると、コマンド・ラインから JSON 応答を表示したり解析したりすることができます。

Code Engine コマンドについて詳しくは、ibmcloud ce コマンドを参照してください。

Code Engine CLI の更新

新規フィーチャーを利用できるよう、CLI を定期的に更新してください。

  1. ibmcloud plugin list コマンドを実行して、現在のプラグイン・リストを表示します。

    ibmcloud plugin list
    

    出力例

    Listing installed plug-ins...
    
    Plugin Name                                  Version   Status             Private endpoints supported
    code-engine[ce]                              1.31.0                       true
    container-registry                           0.1.571                      true
    container-service[kubernetes-service]        1.0.408                      false
    
  2. 更新を利用できる場合は、ibmcloud plugin update コマンドを実行します。

    ibmcloud plugin update code-engine
    

CLI のアンインストール

不要になった CLI はアンインストールできます。

  1. インストールされているプラグインをリストします。

    ibmcloud plugin list
    
  2. プラグインをアンインストールします。 例えば、Code Engine CLI プラグインをアンインストールするには、次のようにします。

    ibmcloud plugin uninstall code-engine
    
  3. 次のコマンドを実行し、インストールされているプラグインのリストを確認することで、プラグインがアンインストールされたことを検証します。

    ibmcloud plugin list
    

削除したプラグインは、結果に表示されません。

Web ブラウザーでの IBM Cloud Shell へのアクセス

IBM® Cloud Shellでは、 IBM Cloud CLI およびその他の CLI プラグインを Web ブラウザーから直接使用できます。

IBM Cloud Shell は、ベース IBM Cloud CLI (ibmcloud) および Code Engine を含むいくつかの プラグインおよびツールで有効になります。

Cloud Shellを使用する場合は、以下の制限事項に留意してください。

  • 最大 5 つの並行セッションを開くことができます。これらのセッションは独立して作動するので、さまざまなリソース、リージョン、アカウントを一度に処理できます。
  • YAML ファイルなどの、ローカルにダウンロードして編集したファイルは、Cloud Shell に一時的に保管されますが、複数セッションをまたいでは持続しません。
  • Cloud Shell には、1 週間に最大 50 時間という使用量の割り当てがあります。

IBM Cloud Shellを起動して使用するには、 IBM Cloud コンソール メニュー・バーで Cloud Shell アイコン IBM Cloud Shell アイコンをクリックします。 セッションが開始し、現在のアカウント資格情報で自動的に IBM Cloud CLI にログインします。