Code Engine CLI の概説

IBM Cloud® Code Engine API を使用して、Code Engine エンティティーを作成して管理できます。

CLI環境のセットアップ

CLI を使用して Code Engine エンティティーを作成および管理するには、CLI 環境をセットアップします。 IBM Cloud CLI の最新バージョンがインストールされていることを確認してください。

開始前に

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

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

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

    1. IBM Cloud CLI にログインします。
        ibmcloud login
        ```
    2. アカウントを複数お持ちの場合、使用するアカウントを選択するよう求めるプロンプトが表示されます。 プロンプトの指示に従うか、**`target`** コマンドを使用して IBM Cloud アカウントを選択します。
    
    ```txt {: pre}
        ibmcloud target -c <account_id>
        ```
    3. 地域を指定します。  **`target`** コマンドを使用して、対象領域を指定または変更します。
    
    ```txt {: pre}
        ibmcloud target -r <region>
        ```
    4. リソース・グループを指定します。 リソース・グループのリストを取得するには、以下のコマンドを実行します。
    
    ```txt {: pre}
        ibmcloud resource groups
        ```
        出力例
    
        ```txt {: screen}
        Retrieving all resource groups under account <account_id> as email@ibm.com...
        OK
        Name      ID                                 Default Group   State   
        default   a8a12accd63b437bbd6d58fb8b462ca7   true            ACTIVE
        test      a8a12abbbd63b437cca6d58fb8b462ca7  false           ACTIVE
        ```
    5. 以下のコマンドを実行して、リソース・グループをターゲットに設定します。
    
    ```txt {: pre}
        ibmcloud target -g <resource_group>
        ```
        出力例
    
        ```txt {: screen}
        Targeted resource group default
        ```
    
    
  3. Code Engine CLI プラグインをインストールします。

    ibmcloud plugin install code-engine
    
  4. Code Engine CLIプラグインがインストールされていることを確認してください。 ibmcloud code-engine version コマンドまたは ibmcloud plugin list コマンドを使用して、プラグインがインストールされていることを確認できます。

    ibmcloud code-engine version
    

    出力例

    OK
    version:  v1.54.2
    commit:   e4800be63b1077563bdbaee9e656ce1f81c3e08d
    
  5. ibmcloud ce help コマンドを実行して、 Code Engine CLI のコマンドを表示します。 以下に例を示します。

    ibmcloud ce help
    

Code Engine CLI の操作

これで Code Engine CLI 環境がセットアップされたので、CLI でアプリケーション、関数、ジョブなどの Code Engine リソースを操作する準備ができました。

Code Engine リソースを操作する前に、プロジェクトのコンテキスト内で作業する必要があります。

プロジェクトとは、アプリケーション、関数、ジョブ、フリート、ビルドといった Code Engine のエンティティをまとめたものです。 プロジェクトの基盤は Kubernetes 名前空間です。 プロジェクトの名前は、IBM Cloud® リソース・グループ、ユーザー・アカウント、およびリージョン内で固有でなければなりません。 プロジェクトは、リソースを管理し、そのエンティティへのアクセスを提供するために使用されます。

このプロジェクトでは、以下の機能を提供します:

  • エンティティ名用の固有の名前空間。
  • プロジェクトリソースへの外部からのアクセス管理。
  • バッキングサービス、レジストリ、およびリポジトリへの外部アクセス管理。
  • トランスポート層サービス( TLS )用の自動生成証明書。

Code Engine プロジェクトについて詳しくは、 プロジェクトの管理 を参照してください。

  1. project create コマンドでプロジェクトを作成します。 リージョンで固有のプロジェクト名を使用してください。

    ibmcloud ce project create --name PROJECT_NAME
    

    出力例

    Creating project 'myproject'...
    OK
    
  2. project get コマンドを使用して、プロジェクトに関する詳細を表示します。

    ibmcloud ce project get --name PROJECT_NAME
    

    出力例

    Getting project 'myproject'...
    OK
    Name:                       myproject
    ID:                         01234567-abcd-abcd-abcd-abcdabcd1111
    Status:                     active
    Selected:                   true
    Region:                     us-south
    Resource Group:             default
    Service Binding Service ID: ServiceId-1234abcd-abcd-abcd-1111-1a2b3c4d5e6f
    Age:                        52d
    Created:                    Fri, 15 Jan 2021 13:32:30 -0500
    Updated:                    Fri, 15 Jan 2021 13:32:45 -0500
    Quotas:
    Category                                  Used      Limit
    App revisions                             1         100
    Apps                                      1         100
    Build runs                                0         100
    Builds                                    0         100
    Configmaps                                2         100
    CPU                                       1.025     64
    Ephemeral storage                         902625Ki  256G
    Instances (active)                        1         250
    Instances (total)                         2         2500
    Job runs                                  1         100
    Jobs                                      1         100
    Memory                                    4400M     256G
    Secrets                                   5         100
    Subscriptions (cron)                      0         100
    Subscriptions (IBM Cloud Object Storage)  0         100
    

あるいは、 project list コマンドを使用して、作成したプロジェクトのリストを表示することもできます。

CLI でプロジェクトを扱うときには、そのプロジェクトが現行コンテキストとして選択されている必要があります。 プロジェクトが作成されると、--no-select オプションを指定した場合を除き、そのプロジェクトが現行コンテキストとして自動的に選択されます。 現在ターゲットになっていないプロジェクトを選択する場合は、project select コマンドを使用します。

プロジェクトの処理について詳しくは、プロジェクトの管理を参照してください。

次のステップ

CLI 環境をセットアップし、 Code Engine プロジェクトのコンテキスト内で作業していることを確認するための最初のステップを実行したので、 Code Engine CLI を使用してアプリ、機能、およびジョブを操作できます。

CLI を使用して Code Engine コンポーネントの操作を開始するには、以下のトピックを参照してください。

Code Engine CLI について詳しくは、 CLI 環境のセットアップ を参照してください。

Code Engine CLI 環境での作業について詳しくは、 Code Engine CLI コマンド・リファレンス資料 を参照してください。

CLI の各バージョンの変更の要約については、 CLI のバージョン履歴 を参照してください。 使用可能なすべてのコマンドとそのオプションを使用できるように、CLI を最新の状態に保つようにしてください。