IBM Cloud Code Engine CLI
以下のコマンドを実行して、IBM Cloud® Code Engineを構成するエンティティーを管理できます。 Code Engine について詳しくは、Code Engine の紹介を参照してください。
IBM Cloud Code Engine コマンドを実行するには、ibmcloud code-engine または ibmcloud ce を使用します。
前提条件
-
IBM Cloud CLI をインストールします。
-
次のコマンドを実行して、Code Engine CLI をインストールします。
ibmcloud plugin install code-engine
アプリケーションのコマンド
アプリケーション (アプリ) は、HTTP 要求を処理するコードを実行します。 IBM Cloud® Code Engine は、従来型の HTTP 要求に加えて、通信プロトコルとして WebSocket を使用するアプリケーションもサポートします。 アプリの実行中のインスタンス数は、入ってくるリクエストとコンフィギュレーション設定に基づいて自動的にスケールアップまたはスケールダウン(ゼロに)されます。 アプリには、1 つ以上のリビジョンが含まれています。 リビジョンとは、アプリの構成プロパティーの変更不可能なバージョンの 1 つを表します。 アプリの構成プロパティーが更新されるたびに、アプリの新規リビジョンが作成されます。
コマンドは、プロジェクトapplicationのコンテキスト内で使用する必要があります。
アプリの処理について詳しくは、アプリケーションのデプロイを参照してください。
applicationコマンドでは、applicationまたはappのいずれかを使用できます。 application コマンドの CLI ヘルプを表示するには、ibmcloud ce app -h を実行してください。
アプリケーション・リビジョンを管理する方法については、ibmcloud ce revision コマンドを参照してください。
ibmcloud ce application bind
IBM Cloud サービス・インスタンスをアプリケーションにバインドします。
ibmcloud ce application bind --name APP_NAME (--service-instance SI_NAME | --service-instance-id SI_ID) [--no-wait] [--prefix PREFIX] [--quiet] [--role ROLE] [--service-credential SERVICE_CREDENTIAL] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--name,-n- バインドするアプリケーションの名前。 この値は必須です。
--no-wait,--nw- サービス・インスタンスをバインドし、サービス・バインディングが準備完了になるのを待機しません。
no-waitオプションを指定した場合は、サービス・バインディングの作成が開始して、コマンドは作成の完了を待機せずに終了します。app getコマンドを使用して、アプリケーションのバインド状況を確認します。 この値はオプション です。 デフォルト値はfalseです。 --prefix,-p- このサービス・バインディング用に作成される環境変数の接頭部。 使用できるのは大文字、数字、および下線 (_) だけです。また、先頭を数字にすることはできません。 この値はオプション です。
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --role,-r- このサービス・バインディング用に作成される新しいサービス資格情報のサービス役割の名前。 有効な値には、
Reader、Writer、Manager、またはサービス固有の役割があります。 デフォルトではこのオプションはManagerに設定されます。Managerがサポートされない場合には、サービスから最初に指定された役割に設定されます。--service-credentialを指定した場合、このオプションは無視されます。 この値はオプション です。 --service-credential,--sc- このサービス・バインディングで使用する既存のサービス資格情報の名前。 サービス・インスタンス資格情報を指定しない場合は、バインディング操作時に新規の資格情報が生成されます。 この値はオプション です。
--service-instance,--si- アプリケーションにバインドする既存の IBM Cloud サービス・インスタンスの名前。 この値はオプション です。
--service-instance-id,--siid- アプリケーションにバインドする既存のIBM Cloudサービス・インスタンスの GUID。 この値はオプション です。
--wait,-w- サービス・インスタンスをバインドし、サービス・バインディングが準備完了になるまで待機します。
--waitオプションを指定した場合、アプリケーション・バインドは、アプリケーション・バインドが正常に完了するまで、--wait-timeoutオプションで設定された最大時間 (秒単位) 待機します。 アプリ・バインドが正常に完了しない場合、または--wait-timeoutで指定された期間内に失敗した場合、このコマンドは失敗します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- サービス・バインディングの準備が完了するまで待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は300です。
例
この例では、 my-object-storage という IBM Cloud Object Storage サービスインスタンスを、 myapp というアプリケーションにバインドします。
ibmcloud ce application bind --name myapp --service-instance my-object-storage
出力例
Binding service instance...
Waiting for service binding to become ready...
Status: Pending (Processing Resource)
Status: Pending (Processing Resource)
Status: Creating service binding
Status: Creating service binding
Status: Ready
Waiting for application revision to become ready...
Traffic is not yet migrated to the latest revision.
Ingress has not yet been reconciled.
Waiting for load balancer to be ready
OK
ibmcloud ce application create
アプリケーションを作成します。
ibmcloud ce application create --name APP_NAME ((--image IMAGE_REF | (--build-source SOURCE [--image IMAGE_REF])) [--argument ARGUMENT] [--build-commit BUILD_COMMIT] [--build-context-dir BUILD_CONTEXT_DIR] [--build-dockerfile BUILD_DOCKERFILE] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-size BUILD_SIZE] [--build-strategy BUILD_STRATEGY] [--build-timeout BUILD_TIMEOUT] [--cluster-local] [--command COMMAND] [--concurrency CONCURRENCY] [--concurrency-target CONCURRENCY_TARGET] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--max-scale MAX_SCALE] [--memory MEMORY] [--min-scale MIN_SCALE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-secret MOUNT_SECRET] [--no-cluster-local] [--no-wait] [--output OUTPUT] [--port PORT] [--probe-live PROBE_LIVE] [--probe-ready PROBE_READY] [--quiet] [--registry-secret REGISTRY_SECRET] [--request-timeout REQUEST_TIMEOUT] [--revision-name REVISION_NAME] [--scale-down-delay SCALE_DOWN_DELAY] [--service-account SERVICE_ACCOUNT] [--trusted-profiles-enabled] [--user USER] [--visibility VISIBILITY] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
-n,--name- アプリケーションの名前。 プロジェクト内で固有の名前を使用します。
- 名前の先頭は小文字でなければなりません。
- 名前の末尾は小文字の英数字でなければなりません。
- 名前は 63 文字以下でなければならず、使用できるのは小文字、数字、ハイフン (-) です。
この値は必須です。
--argument,--arg,-a- アプリケーションの引数を設定します。 引数は
--argumentオプション 1 つにつき 1 つ指定します (例:-a argA -a argB)。 この値は、コンテナー・イメージ内に指定されているデフォルトの値をオーバーライドします。 この値はオプション です。 --build-commit,--commit,--bcm,--cm,--revision- プルするソース・リポジトリー内のコミット、タグ、またはブランチ。 ビルド・コミット・オプションは、
--build-sourceオプションが設定されている場合にのみ許可されます。 この値はオプション です。 --build-context-dir,--context-dir,--bcdr,--cdr- buildpacks ファイルまたは Dockerfile を含むリポジトリー内のディレクトリー。 ビルド・コンテキスト・ディレクトリー・オプションは、
--build-sourceオプションが設定されている場合にのみ許可されます。 この値はオプション です。 --build-dockerfile,--dockerfile,--bdf,--df- Dockerfile のパス。 このオプションは、名前が
Dockerfileでない場合にのみ指定します。 build dockerfile オプションは、--build-sourceオプションが設定されている場合にのみ許可されます。 この値はオプション です。 デフォルト値はDockerfileです。 --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- SSH シークレットの名前。これには、コンテナー・イメージをビルドするためのソース・コードを含むプライベート・リポジトリーにアクセスするための資格情報が含まれています。 この SSH 秘密を作成するには、
secret create --format SSHコマンドを使用します。 SSH シークレットは、 Git リポジトリー・アクセス・シークレットとしても使用されます。 このオプションは、--build-sourceオプションが URL の Git リポジトリに設定されている場合にのみ許可されます。 この値はオプション です。 --build-size,--size,--bsz,--sz- ビルドのサイズ。使用するリソースの量を決定します。 有効な値は
small、medium、large、xlarge、xxlarge。 詳しくは、ビルドのサイズの決定を参照してください。 ビルド・サイズ・オプションは、--build-sourceオプションが設定されている場合にのみ許可されます。 この値はオプション です。 デフォルト値はmediumです。 --build-source,--source,--bsrc,--src- Git リポジトリーの URL、またはソース・コードを含むローカル・ソースへのパス (例えば、
https://github.com/IBM/CodeEngineまたは.)。 この値はオプション です。 --build-strategy,--strategy,--bstr,--str- イメージのビルドに使用する戦略。 有効な値は
dockerfileおよびbuildpacksです。 ビルド・ストラテジー・オプションは、--build-sourceオプションが設定されている場合にのみ許可されます。 指定されていない場合、--build-sourceが指定され、ソースがローカル・マシンにあれば、ビルド戦略は Code Engine によって決定される。 この値はオプション です。 デフォルト値はdockerfileです。 --build-timeout,--bto- ビルドの成功/失敗が決まるまで許容する時間 (秒単位)。 ビルド・タイムアウト・オプションは、
--build-sourceオプションが設定されている場合にのみ許可されます。 この値はオプション です。 デフォルト値は600です。 --cluster-local,--cl- プロジェクト専用エンドポイントを使用してアプリケーションをデプロイします。 プロジェクト専用エンドポイントを設定すると、パブリック・インターネットからアプリにアクセスできなくなり、同じプロジェクトで実行されている他の Code Engine コンポーネントからのみネットワーク・アクセスが可能になります。 この値はオプション です。 デフォルト値は
falseです。 --command,--cmd,-c- アプリケーションのコマンドを設定します。 コマンドは
--commandオプション 1 つにつき 1 つ指定します (例:--cmd cmdA --cmd cmdB)。 この値は、コンテナー・イメージ内に指定されているデフォルトのコマンドをオーバーライドします。 この値はオプション です。 --concurrency,--cn- 1 つのインスタンスで同時に処理できる要求の最大数。 この値はオプション です。 デフォルト値は
100です。 --concurrency-target,--ct- インスタンスあたりの同時要求数のしきい値。この値に達すると、1 つ以上の追加インスタンスが作成されます。 同時要求の数に基づいてインスタンスをスケールアップするときにこの値を使用します。
--concurrency-targetを指定しない場合、このオプションはデフォルトで--concurrencyオプションの値に設定されます。 この値はオプション です。 デフォルト値は0です。 --cpu- アプリケーションのインスタンスのために設定する CPU の量。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 デフォルト値は
1です。 --env,-e- アプリケーションに環境変数を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の環境変数を追加するか、または既存の環境変数をオーバーライドします。 環境変数は--envオプション 1 つにつき 1 つ指定します (例:--env envA=A --env envB=B)。 この値はオプション です。 --env-cm,--env-from-configmap- 以下のいずれかの方法を使用して、この構成マップに保管されているキーと値のペアから環境変数を設定します。
configmapNameという名前の構成マップ内のすべてのキーに対応する環境変数を追加するには、値configmapNameを使用します。 構成マップを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=CONFIGMAP_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>です。 例えば、構成マップconfigmapName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=configmapNameを使用します。 構成マップconfigmapNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、key1という名前の構成マップ内の 1 つのキーconfigmapNameに対応する環境変数を追加するには、値configmapName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、configmapNameという名前の構成マップ内の単一キーkey1にmyKeyという名前の環境変数を追加するには、値configmapName:myKey=key1を使用します。
この値はオプション です。
--env-sec,--env-from-secret- 以下のいずれかの方法で、シークレットに格納されているキーと値のペアから環境変数を設定する:
secretNameという名前のシークレット内のすべてのキーに対応する環境変数を追加するには、値secretNameを使用します。 シークレットを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=SECRET_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_SECRET>です。 例えば、シークレットsecretName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=secretNameを使用します。 シークレットsecretNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、secretNameという名前のシークレットに単一キーkey1の環境変数を追加するには、値secretName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、secretNameという名前のシークレット内の単一キーkey1に対してmyKeyという名前の環境変数を追加するには、値secretName:myKey=key1を使用します。
この値はオプション です。
--ephemeral-storage,--es- アプリケーションのインスタンスのために設定する一時ストレージの量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 この値はオプション です。 デフォルト値は400Mです。 --force,-f- 指定された構成マップおよびシークレットの参照の存在を検証しません。 構成マップ参照は、
--env-from-configmapまたは--mount-configmapオプションを使用して指定します。 シークレット参照は、--env-from-secret、--mount-secret、または--registry-secretオプションを使用して指定します。 この値はオプション です。 デフォルト値はfalseです。 --image,-i- このアプリケーションに使用するイメージの名前。 形式は
REGISTRY/NAMESPACE/REPOSITORY:TAGです。REGISTRYとTAGはオプションです。REGISTRYを指定しない場合、そのデフォルトはdocker.ioです。TAGを指定しない場合、そのデフォルトはlatestです。--build-sourceオプションが指定されていない場合は、イメージ・オプションが必要です。 この値はオプション です。 --max-scale,--max,--maxscale- このアプリケーションに使用できるインスタンスの最大数。 この値を
0に設定すると、アプリケーションは必要に応じてスケーリングされます。 アプリケーションのスケーリングは、アプリケーションのプロジェクトのリソース割り当て量ごとのインスタンスによってのみ制限されます。 Code Engine の制限と割り当て量を参照してください。 この値はオプション です。 デフォルト値は10です。 --memory,-m- アプリケーションのインスタンスに設定するメモリーの量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 デフォルト値は4Gです。 --min-scale,--min,--minscale- このアプリケーションに使用できるインスタンスの最小数。 このオプションは、必要がないときにはインスタンスを 1 つも実行しないようにする場合に役に立ちます。 この値はオプション です。 デフォルト値は
0です。 --mount-configmap,--mount-cm- マウント・ディレクトリーと構成マップの名前を
MOUNT_DIRECTORY=CONFIGMAP_NAMEの形式で指定して、アプリケーション・コンテナーのファイル・システムに構成マップの内容を追加します。 マウントされる構成マップはそれぞれ、固有のマウント・ディレクトリーを使用しなければなりません。 構成マップ内のキー/値のペアごとに、指定したマウント・ディレクトリーにファイルが追加されます。このとき、キー/値のペアのキーがそのファイル名になり、値がそのファイルの内容になります。 1 つの--mount-configmapオプションにつき 1 つのマウント構成を指定します (例:--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b)。 この値はオプション です。 --mount-data-store,--mount-ds- 永続データ・ストアをマウントします。 フォーマットは、MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH] である。 SUBPATHはオプションである。 このオプションは、複数回指定できます。 この値はオプション です。
--mount-secret,--mount-sec- マウント・ディレクトリーとシークレットの名前を
MOUNT_DIRECTORY=SECRET_NAMEの形式で指定して、アプリケーション・コンテナーのファイル・システムにシークレットの内容を追加します。 マウントされるシークレットはそれぞれ、固有のマウント・ディレクトリーを使用しなければなりません。 シークレット内のキー/値のペアごとに、指定したマウント・ディレクトリーにファイルが追加されます。このとき、キー/値のペアのキーがそのファイル名になり、値がそのファイルの内容になります。 1 つの--mount-secretオプションにつき 1 つのマウント構成を指定します (例:--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b)。 この値はオプション です。 --no-cluster-local,--ncl- パブリック・エンドポイントを使用してアプリケーションをデプロイします。 アプリケーションは、パブリック・インターネットまたはCode Engineプロジェクト内のコンポーネントから要求を受信できるようにデプロイされます。 この値はオプション です。 デフォルト値は
trueです。 --no-wait,--nw- アプリケーションを作成し、アプリケーションの準備完了を待機しません。
--no-waitオプションを指定した場合は、アプリケーションの作成が開始され、待機は行われません。 アプリケーションの状況を確認するには、app getコマンドを使用してください。 この値はオプション です。 デフォルト値はfalseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、jsonpath-as-json=JSONPATH_EXPRESSION、url、およびproject-urlです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --port,-p- アプリケーションが listen するポート。 形式は
[NAME:]PORTです。[NAME:]はオプションです。[NAME:]を指定する場合、有効な値はh2cまたはhttp1です。[NAME:]を指定しないか、http1と指定した場合、ポートでは HTTP/1.1 が使用されます。[NAME:]がh2cの場合、ポートでは暗号化されない HTTP/2 が使用されます。 Code Engine は、デフォルトではアプリが着信接続をポート8080で listen するという前提で機能します。 アプリケーションがポート8080以外のポートで listen する必要がある場合は、--portを使用してそのポートを指定してください。 この値はオプション です。 --probe-live,--pl- このアプリケーションの活性プローブを NAME=VALUE 形式で構成します。 NAME の有効なオプションは、
type、port、path、interval、initial-delay、timeout、failure-thresholdです。 このオプションは複数回指定できます。typeプロパティーは必須で、有効な値はtcpおよびhttpです。 例えば、 --probe-liveタイプ=TCP --probe-liveport=8080。 プローブの操作について詳しくは、「 アプリ用のプローブの構成」を参照してください。 この値はオプション です。 --probe-ready,--pr- このアプリケーションの作動可能プローブを NAME=VALUE 形式で構成します。 NAME の有効なオプションは、
type、port、path、interval、initial-delay、timeout、failure-thresholdです。 このオプションは複数回指定できます。typeプロパティーは必須で、有効な値はtcpおよびhttpです。 例えば、 --probe-readyタイプ=TCP --probe-readyport=8080。 プローブの操作について詳しくは、「 アプリ用のプローブの構成」を参照してください。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --registry-secret,--rs- レジストリー・シークレットの名前。 レジストリー・シークレットは、コンテナー・イメージのダウンロード時にプライベート・レジストリーでの認証に使用されます。 この値はオプション です。
--request-timeout,--rt,--timeout,-t- アプリケーションに対して行われた要求の成功/失敗までにかけられる時間 (秒単位)。 この値はオプション です。 デフォルト値は
300です。 --rn,--revision-name- リビジョンの名前。 アプリケーション内で固有の名前を使用します。
- 名前に使用できるのは、小文字、数字、ハイフン (-) です。
- 名前の末尾は小文字の英数字でなければなりません。
- 完全修飾リビジョン名は、
Name_of_application-Name of revisionの形式でなければなりません。 - 完全修飾リビジョン名は 63 文字以下でなければなりません。
この値はオプション です。
--scale-down-delay,--sdd- 並行性が低下した状態で、アプリケーションがスケールダウンされる前に経過する時間 (秒単位)。 同時要求の数が増えると、アプリケーションが拡大します。 要求の数が減少 (並行性の低下) した場合、このオプションに指定された時間によって、アプリケーションがスケールダウンされる前に、削減された並行性を保持する必要がある期間が決定されます。 デフォルトでは、並行性の低下が検出されると、アプリケーションは即時にスケールダウンされます。 この値はオプション です。
デフォルト値は
0です。 --service-account,--sa- サービス・アカウントの名前。 サービス・アカウントは、インスタンスで実行されるプロセスの ID を提供します。 組み込みサービス・アカウントの場合、短縮名
manager、none、reader、およびwriterを使用できます。 接頭部Kubernetes Config Contextが付いたフルネームを使用することもできます。これは、project currentコマンドで判別できます。 この値はオプション です。 --trusted-profiles-enabled,--trusted,--tpe- このアプリケーションのコンテナーへの計算リソース・トークンのマウントを有効にします。 この値はオプション です。 デフォルト値は
falseです。 --user,-u- アプリケーションを実行するために使用するユーザー ID (UID)。 この値は、アプリケーションの Dockerfile に設定されているユーザー ID をオーバーライドします。 コンテナーのオペレーティング・システム要件に準拠した ID でなければなりません。 この値はオプション です。 デフォルト値は
0です。 --visibility,-v- アプリケーションの表示設定。 有効な値は
public、private、project。 可視性をpublicに設定することは、アプリがパブリック・インターネットから、またはCode Engineプロジェクト内のコンポーネントから要求を受信できることを意味します。 可視性をprivateに設定すると、パブリック・インターネットからアプリにアクセスできなくなり、同じプロジェクトで実行されている仮想プライベート・エンドポイント (VPE) またはCode Engineコンポーネントを使用する他のIBM Cloudからのみネットワーク・アクセスが可能になります。 可視性をprivateにできるのは、プロジェクトがアプリケーションのプライベート可視性をサポートしている場合のみです。 可視性をprojectに設定すると、パブリック・インターネットからアプリにアクセスできなくなり、同じプロジェクトで実行されている他のCode Engineコンポーネントからのみネットワーク・アクセスが可能になります。 この値はオプション です。 --wait,-w- アプリケーションを作成し、アプリケーションの準備完了を待機します。
--waitオプションを指定した場合、アプリケーション作成コマンドは、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、アプリケーションの準備完了を待機します。 指定したwait-timeoutの期間内にアプリケーションの準備が完了しない場合、アプリケーション作成コマンドは失敗します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- アプリケーションの準備が完了するまで待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は600です。
例
ibmcloud ce application create --name myapp --image icr.io/codeengine/hello
出力例
Creating application 'myapp'...
[...]
Run `ibmcloud ce application get -n 'myapp'` to check the application status.
OK
https://myapp.4svg40kna19.us-south.codeengine.appdomain.cloud
アプリケーションの状態を確認するために ibmcloud ce application get -n 'myapp' を実行すると、アプリケーションの URL が表示されます。
ibmcloud ce application delete
アプリケーションを削除します。
ibmcloud ce application delete --name APPLICATION_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--name,-n- アプリケーションの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --no-wait,--nw- アプリケーションを削除し、このアプリケーションが削除されるのを待機しません。
no-waitオプションを指定した場合は、アプリケーションの削除が開始され、待機は行われません。 アプリケーションの状況を確認するには、app getコマンドを使用してください。 この値はオプション です。 デフォルト値はtrueです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- アプリケーションを削除し、このアプリケーションが削除されるのを待機します。
--waitオプションを指定した場合、アプリケーション削除コマンドは、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、アプリケーションの削除を待機します。 指定した--wait-timeoutの期間内にアプリケーションが削除されない場合、アプリケーション削除コマンドは失敗します。 この値はオプション です。 デフォルト値はfalseです。 --wait-timeout,--wto- アプリケーションが削除されるまで待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は600です。
例
ibmcloud ce application delete --name myapp -f
出力例
Deleted application 'myapp'
ibmcloud ce application events
アプリケーション・インスタンスのシステム・イベントを表示します。 システム・イベントは最大で60分保持されます。
ibmcloud ce application events (--instance APP_INSTANCE | --application APP_NAME) [--output OUTPUT] [--quiet]
コマンド・オプション
--application,--app,-a,--name,-n- 指定されたアプリケーションのすべてのインスタンスのイベントを表示します。
--instanceを指定しない場合は、この値が必須です。 --instance,-i- 特定のアプリケーション・インスタンスの名前。 インスタンス名を確認するには、
app getコマンドを使用してください。--applicationを指定しない場合は、この値が必須です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
以下の例は、指定されたアプリケーションのすべてのインスタンスに関するシステム・イベント情報を表示します。
ibmcloud ce application events --application myapp
出力例
Getting events for all instances of application 'myapp'...
OK
myapp-atfte-1-deployment-6b49c5fb85-kf4m2:
Type Reason Age Source Messages
Normal Scheduled 31s default-scheduler Successfully assigned 4svg40kna19/myapp-atfte-1-deployment-6b49c5fb85-kf4m2 to 10.240.0.15
Normal Pulling 29s kubelet, 10.240.0.15 Pulling image "icr.io/codeengine/hello@sha256:f0dc03250736a7b40a66ee70fee94fc470e08c864197aa2140054fee6ca9f9d6"
Normal Pulled 24s kubelet, 10.240.0.15 Successfully pulled image "icr.io/codeengine/hello@sha256:f0dc03250736a7b40a66ee70fee94fc470e08c864197aa2140054fee6ca9f9d6" in 4.907426108s
Normal Created 24s kubelet, 10.240.0.15 Created container user-container
Normal Started 24s kubelet, 10.240.0.15 Started container user-container
Normal Pulled 24s kubelet, 10.240.0.15 Container image "icr.io/obs/codeengine/knative-serving/queue-39be6f1d08a095bd076a71d288d295b6:v0.20.0-rc1@sha256:8988bea781130827b3e1006e6e5e7f49094343a5505c1927bb832be3470455f6" already present on machine
Normal Created 23s kubelet, 10.240.0.15 Created container queue-proxy
Normal Started 23s kubelet, 10.240.0.15 Started container queue-proxy
アプリの指定されたインスタンスのシステム・イベント情報の例
以下の例は、アプリの指定されたインスタンスに関するシステム・イベント情報を表示します。 アプリに関する詳細 (アプリの実行中インスタンスを含む) を表示するには、app get コマンドを使用します。
ibmcloud ce application events --instance myapp-li17x-1-deployment-69fd57bcb6-sr9tl
アプリの指定されたインスタンスに関するシステム・イベント情報の出力例
Getting events for application instance 'myapp-li17x-1-deployment-69fd57bcb6-sr9tl'...
OK
myapp-li17x-1-deployment-69fd57bcb6-sr9tl:
Type Reason Age Source Messages
Normal Scheduled 6m40s default-scheduler Successfully assigned 4svg40kna19/myapp-li17x-1-deployment-69fd57bcb6-sr9tl to 10.240.64.6
Normal Pulling 6m39s kubelet, 10.240.64.6 Pulling image "icr.io/codeengine/hello@sha256:f0dc03250736a7b40a66ee70fee94fc470e08c864197aa2140054fee6ca9f9d6"
Normal Pulled 6m36s kubelet, 10.240.64.6 Successfully pulled image "icr.io/codeengine/hello@sha256:f0dc03250736a7b40a66ee70fee94fc470e08c864197aa2140054fee6ca9f9d6"
Normal Created 6m34s kubelet, 10.240.64.6 Created container user-container
Normal Started 6m33s kubelet, 10.240.64.6 Started container user-container
Normal Pulled 6m33s kubelet, 10.240.64.6 Container image "icr.io/obs/codeengine/knative-serving/queue-39be6f1d08a095bd076a71d288d295b6:v0.19.0-rc3@sha256:9cb525af53896afa6b5210b5ac56a893cf85b6cd013a61cb6503a005e40c5c6f" already present on machine
Normal Created 6m33s kubelet, 10.240.64.6 Created container queue-proxy
Normal Started 6m32s kubelet, 10.240.64.6 Started container queue-proxy
[...]
ibmcloud ce application get
アプリケーションの詳細を表示します。
ibmcloud ce application get --name APPLICATION_NAME [--output OUTPUT] [--quiet] [--show-all-revisions]
コマンド・オプション
--name,-n- アプリケーションの名前。 この値は必須です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、jsonpath-as-json=JSONPATH_EXPRESSION、url、およびproject-urlです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --show-all-revisions,-r- このアプリケーションのすべてのリビジョンを表示します。 指定しない場合、トラフィックを受信するように構成されているリビジョンのみが表示されます。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce application get --name myapp
出力例
Run 'ibmcloud ce application events -n myapp' to get the system events of the application instances.
Run 'ibmcloud ce application logs -f -n myapp' to follow the logs of the application instances.
OK
Name: myapp
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 31m
Created: 2021-09-09T14:01:02-04:00
URL: https://myapp.abcdabcdabc.us-south.codeengine.appdomain.cloud
Cluster Local URL: http://myapp.abcdabcdabc.svc.cluster.local
Console URL: https://cloud.ibm.com/codeengine/project/us-south/01234567-abcd-abcd-abcd-abcdabcd1111/application/myapp/configuration
Status Summary: Application deployed successfully
Environment Variables:
Type Name Value
Literal CE_API_BASE_URL https://api.private.us-south.codeengine.cloud.ibm.com
Literal CE_APP myapp
Literal CE_DOMAIN us-south.codeengine.appdomain.cloud
Literal CE_PROJECT_ID abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Literal CE_REGION us-south
Literal CE_SUBDOMAIN abcdabcdab
Image: icr.io/codeengine/helloworld
Resource Allocation:
CPU: 1
Ephemeral Storage: 400M
Memory: 4G
Revisions:
myapp-00001:
Age: 42s
Latest: true
Traffic: 100%
Image: icr.io/codeengine/helloworld (pinned to 1cee99)
Running Instances: 1
Runtime:
Concurrency: 100
Maximum Scale: 10
Minimum Scale: 0
Scale Down Delay: 0
Timeout: 300
Conditions:
Type OK Age Reason
ConfigurationsReady true 25s
Ready true 12s
RoutesReady true 12s
Events:
Type Reason Age Source Messages
Normal Created 44s service-controller Created Configuration "myapp"
Normal Created 43s service-controller Created Route "myapp"
Instances:
Name Revision Running Status Restarts Age
myapp-00001-deployment-d59b87654-xkqh7 myapp-00001 3/3 Running 0 43s
ibmcloud ce application list
プロジェクト内のすべてのアプリケーションをリスト表示します。
ibmcloud ce application list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce app list --sort-by age
出力例
Listing all applications...
OK
Name Status URL Latest Age Conditions Reason
myapptestapp2 Ready https://myapptestapp2.4svg40kna19.us-south.codeengine.appdomain.cloud myapptestapp2-emy0q-1 52s 3 OK / 3
myapptestapp1 Ready https://myapptestapp1.4svg40kna19.us-south.codeengine.appdomain.cloud myapptestapp1-ps4ca-1 104s 3 OK / 3
myapp-e Ready https://myapp-e.4svg40kna19.us-south.codeengine.appdomain.cloud myapp-e-gx6xa-1 12m 3 OK / 3
myappd Ready https://myappd.4svg40kna19.us-south.codeengine.appdomain.cloud myappd-lxjxm-1 13m 3 OK / 3
myappc Ready https://myappc.4svg40kna19.us-south.codeengine.appdomain.cloud myappc-qffan-1 14m 3 OK / 3
myappb Ready https://myappb.4svg40kna19.us-south.codeengine.appdomain.cloud myappb-i3hw3-1 15m 3 OK / 3
myapp Ready https://myapp.4svg40kna19.us-south.codeengine.appdomain.cloud myapp-jmxwd-1 17m 3 OK / 3
ibmcloud ce application logs
アプリケーション・インスタンスのログを表示します。
ibmcloud ce application logs (--instance APP_INSTANCE | --application APP_NAME) [--all-containers] [--follow] [--output OUTPUT] [--quiet] [--raw] [--tail TAIL] [--timestamps]
コマンド・オプション
--all-containers,--all- 指定されたアプリケーション・インスタンスのすべてのコンテナーのログを表示します。 この値はオプション です。 デフォルト値は
falseです。 --application,--app,-a,--name,-n- 指定されたアプリケーションのすべてのインスタンスのログを表示します。
--instanceを指定しない場合は、この値が必須です。 --follow,-f- アプリケーション・インスタンスのログを監視します。 アプリケーション・インスタンスのログをストリーミングするには、このオプションを使用します。
--followオプションを指定する場合、このログ・コマンドを終了するにはCtrl+Cを入力しなければなりません。 この値はオプション です。 デフォルト値はfalseです。 --instance,-i- 特定のアプリケーション・インスタンスの名前。 インスタンス名を確認するには、
app getコマンドを使用してください。--applicationを指定しない場合は、この値が必須です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --raw,-r- インスタンスとコンテナー・ラベルなしでログを表示します。 この値はオプション です。 デフォルト値は
falseです。 --tail,-t- 指定されたアプリケーション・インスタンスのコンテナーについて、ログの最新の行をコンテナーごとに最大で何行表示するかを制限します。 例えば、指定したアプリケーション・インスタンスのコンテナーのログの最後の
3行を表示するには、--tail 3と指定します。 このオプションが指定されない場合、指定されたアプリケーション・インスタンスのコンテナーのログのすべての行が表示されます。 この値はオプション です。 デフォルト値は-1です。 --timestamps,--ts- ログ出力の各行にタイム・スタンプを含めます。 この値はオプション です。 デフォルト値は
falseです。
例
以下の例は、アプリの特定のインスタンスのログを表示します。 アプリ・インスタンスの名前は、app get コマンドで確認できます。
ibmcloud ce application logs --instance myapp-zhk9x-1-deployment-6f955f5cc5-abcde
出力例
Getting logs for application instance 'myapp-zhk9x-1-deployment-6f955f5cc5-abcde'...
OK
myapp-zhk9x-1-deployment-6f955f5cc5-abcde:
Server running at http://0.0.0.0:8080/
アプリのすべてのインスタンスのログの例
以下の例では、アプリのすべてのインスタンスのログを表示します。
ibmcloud ce application logs --app myapp
アプリのすべてのインスタンスのログの出力例
Getting application 'myapp'...
Getting revisions for application 'myapp'...
Getting instances for application 'myapp'...
Getting logs for all instances of application 'myapp'...
OK
myapp-zhk9x-1-deployment-6f955f5cc5-abcde:
Server running at http://0.0.0.0:8080/
ibmcloud ce application restart
実行中のアプリケーション・インスタンスを再始動します。
ibmcloud ce application restart (--instance APP_INSTANCE | --application APP_NAME) [--quiet]
コマンド・オプション
--application,--app,-a,--name,-n- 指定したアプリケーションの実行中のインスタンスをすべて再始動します。
--instanceを指定しない場合は、この値が必須です。 --instance,-i- 特定のアプリケーション・インスタンスの名前。 インスタンス名を確認するには、
app getコマンドを使用してください。--applicationを指定しない場合は、この値が必須です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce application restart --name myapp
出力例
Restarting all running instances of application 'myapp'...
OK
ibmcloud ce application unbind
アプリケーションから IBM Cloud サービス・インスタンスをアンバインドします。
ibmcloud ce application unbind --name APP_NAME (--binding BINDING_NAME | --all) [--quiet]
コマンド・オプション
--name,-n- アンバインドするアプリケーションの名前。 この値は必須です。
--all,-A- このアプリケーションのすべてのサービス・インスタンスをアンバインドします。
--bindingを指定しない場合は、この値が必須です。 デフォルト値はfalseです。 --binding,-b- アンバインドするバインディングの名前。 バインディング名を参照するには、
ibmcloud ce app get -n APP_NAMEを実行します。--allを指定しない場合は、この値が必須です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
この例では、myapp というアプリケーションからすべてのバインディングを削除します。
ibmcloud ce application unbind --name myapp --all
出力例
Removing service bindings...
OK
ibmcloud ce application update
アプリケーションを更新します。 アプリケーションを更新すると、リビジョンが作成されます。 アプリケーションを呼び出すと、トラフィックはそのリビジョンに転送されます。
ibmcloud ce application update --name APP_NAME [--argument ARGUMENT] [--arguments-clear] [--build-clear] [--build-commit BUILD_COMMIT] [--build-commit-clear] [--build-context-dir BUILD_CONTEXT_DIR] [--build-dockerfile BUILD_DOCKERFILE] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-git-repo-secret-clear] [--build-size BUILD_SIZE] [--build-source BUILD_SOURCE] [--build-strategy BUILD_STRATEGY] [--build-timeout BUILD_TIMEOUT] [--cluster-local] [--command COMMAND] [--commands-clear] [--concurrency CONCURRENCY] [--concurrency-target CONCURRENCY_TARGET] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-configmap-rm ENV_FROM_CONFIGMAP_RM] [--env-from-secret ENV_FROM_SECRET] [--env-from-secret-rm ENV_FROM_SECRET_RM] [--env-rm ENV_RM] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--image IMAGE] [--max-scale MAX_SCALE] [--memory MEMORY] [--min-scale MIN_SCALE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-rm MOUNT_RM] [--mount-secret MOUNT_SECRET] [--no-cluster-local] [--no-wait] [--output OUTPUT] [--port PORT] [--probe-live PROBE_LIVE] [--probe-live-clear] [--probe-ready PROBE_READY] [--probe-ready-reset] [--quiet] [--rebuild] [--registry-secret REGISTRY_SECRET] [--registry-secret-clear] [--request-timeout REQUEST_TIMEOUT] [--revision-name REVISION_NAME] [--scale-down-delay SCALE_DOWN_DELAY] [--service-account SERVICE_ACCOUNT] [--service-account-clear] [--trusted-profiles-enabled] [--user USER] [--visibility VISIBILITY] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--name,-n- アプリケーションの名前。 この値は必須です。
--argument,--arg,-a- アプリケーションの引数を設定します。 引数は
--argumentオプション 1 つにつき 1 つ指定します (例:-a argA -a argB)。 この値はオプション です。 --arguments-clear,--ac- アプリケーションの引数をクリアします。 この値はオプション です。 デフォルト値は
falseです。 --build-clear,--bc- このアプリケーションからビルドの関連付けを削除します。 ビルドクリアオプションは、アプリに現在関連するビルドがある場合にのみ許可されます。 この値はオプション です。 デフォルト値は
falseです。 --build-commit,--commit,--bcm,--cm,--revision- プルするソース・リポジトリー内のコミット、タグ、またはブランチ。 ビルドコミットオプションは、この
app updateコマンドで Git リポジトリの URL に--build-sourceオプションが設定されている場合、または現在アプリケーションに Git リポジトリソースからの関連ビルドがある場合にのみ許可されます。 この値はオプション です。 --build-commit-clear,--commit-clear,--bcmc,--cmc- プルするソース・リポジトリー内のコミット、タグ、またはブランチをクリアします。 コミットクリアオプションは、アプリケーションに現在関連するビルドがある場合に使用できます。 この値はオプション です。 デフォルト値は
falseです。 --build-context-dir,--context-dir,--bcdr,--cdr- buildpacks ファイルまたは Dockerfile を含むリポジトリー内のディレクトリー。 この
app updateコマンドに--build-sourceオプションが設定されている場合、またはアプリケーションに現在関連付けられたビルドがある場合は、ビルド・コンテキスト・ディレクトリー・オプションが許可されます。 この値はオプション です。 --build-dockerfile,--dockerfile,--bdf,--df- Dockerfile のパス。 このオプションは、名前が
Dockerfileでない場合にのみ指定します。 build dockerfile オプションは、このapp updateコマンドに--build-sourceオプションが設定されているか、アプリケーションに現在関連するビルドがある場合にのみ許可されます。 この値はオプション です。 デフォルト値はDockerfileです。 --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- SSH シークレットの名前。これには、コンテナー・イメージをビルドするためのソース・コードを含むプライベート・リポジトリーにアクセスするための資格情報が含まれています。 この SSH 秘密を作成するには、
secret create --format SSHコマンドを使用します。 SSH シークレットは、 Git リポジトリー・アクセス・シークレットとしても使用されます。 このオプションは、このapplication updateコマンドで--build-sourceオプションが Git リポジトリの URL に設定されているか、アプリケーションに Git リポジトリ・ソースからの関連ビルドが現在ある場合にのみ許可されます。 この値はオプション です。 --build-git-repo-secret-clear,--git-repo-secret-clear,--bgrsc,--grsc- SSH シークレットをクリアします。 このオプションは、アプリケーションに現在関連するビルドがある場合に許可されます。 この値はオプション です。 デフォルト値は
falseです。 --build-size,--size,--bsz,--sz- ビルドのサイズ。使用するリソースの量を決定します。 有効な値は
small、medium、large、xlarge、xxlarge。 詳しくは、ビルドのサイズの決定を参照してください。 ビルド・サイズ・オプションは、このapp updateコマンドで--build-sourceオプションが設定されているか、アプリケーションに現在関連するビルドがある場合にのみ許可されます。 この値はオプション です。 デフォルト値はmediumです。 --build-source,--source,--bsrc,--src- Git リポジトリーの URL、またはソース・コードを含むローカル・ソースへのパス (例えば、
https://github.com/IBM/CodeEngineまたは.)。 この値はオプション です。 --build-strategy,--strategy,--bstr,--str- イメージのビルドに使用する戦略。 有効な値は
dockerfileおよびbuildpacksです。 ビルド戦略オプションは、このapp updateコマンドで--build-sourceオプションが設定されているか、アプリケーションに現在関連するビルドがある場合にのみ許可されます。 指定しない場合、--build-sourceが指定され、ソースがローカル・マシン上にある場合、ビルド・ストラテジーは Code Engine によって決定されます。 この値はオプション です。 デフォルト値はdockerfileです。 --build-timeout,--bto- ビルドの成功/失敗が決まるまで許容する時間 (秒単位)。 ビルド・タイムアウト・オプションは、この
app update・コマンドに--build-source・オプションが設定されているか、アプリケーションに現在関連するビルドがある場合にのみ許可される。 この値はオプション です。 デフォルト値は600です。 --cluster-local,--cl- プロジェクト専用エンドポイントを使用してアプリケーションをデプロイします。 プロジェクト専用エンドポイントを設定すると、パブリック・インターネットからアプリにアクセスできなくなり、同じプロジェクトで実行されている他の Code Engine コンポーネントからのみネットワーク・アクセスが可能になります。 この値はオプション です。 デフォルト値は
falseです。 --command,--cmd,-c- アプリケーションのコマンドを設定します。 コマンドは
--commandオプション 1 つにつき 1 つ指定します (例:--cmd cmdA --cmd cmdB)。 この値は、コンテナー・イメージ内に指定されているデフォルトのコマンドをオーバーライドします。 この値はオプション です。 --commands-clear,--cc- アプリケーションのコマンドをクリアします。 この値はオプション です。 デフォルト値は
falseです。 --concurrency,--cn- 1 つのインスタンスで同時に処理できる要求の最大数。 この値はオプション です。 デフォルト値は
0です。 --concurrency-target,--ct- インスタンスあたりの同時要求数のしきい値。この値に達すると、1 つ以上の追加インスタンスが作成されます。 同時要求の数に基づいてインスタンスをスケールアップするときにこの値を使用します。
--concurrency-targetを指定しない場合、このオプションはデフォルトで--concurrencyオプションの値に設定されます。 この値はオプション です。 デフォルト値は0です。 --cpu- アプリケーションのインスタンスのために設定する CPU の量。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 デフォルト値は
0です。 --env,-e- アプリケーションに環境変数を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の環境変数を追加するか、または既存の環境変数をオーバーライドします。 環境変数は--envオプション 1 つにつき 1 つ指定します (例:--env envA=A --env envB=B)。 この値はオプション です。 --env-cm,--env-from-configmap- 以下のいずれかの方法を使用して、この構成マップに保管されているキーと値のペアから環境変数を設定します。
configmapNameという名前の構成マップ内のすべてのキーに対応する環境変数を追加するには、値configmapNameを使用します。 構成マップを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=CONFIGMAP_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>です。 例えば、構成マップconfigmapName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=configmapNameを使用します。 構成マップconfigmapNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、key1という名前の構成マップ内の 1 つのキーconfigmapNameに対応する環境変数を追加するには、値configmapName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、configmapNameという名前の構成マップ内の単一キーkey1にmyKeyという名前の環境変数を追加するには、値configmapName:myKey=key1を使用します。
この値はオプション です。
--env-from-configmap-rm,--env-cm-rm- 構成マップ名を使用して、構成マップ全体に対する環境変数の参照を削除します。 構成マップに対する個々のキー参照を削除するには、
--env-rmオプションを使用します。 このオプションは、複数回指定できます。 この値はオプション です。 --env-sec,--env-from-secret- 以下のいずれかの方法で、シークレットに格納されているキーと値のペアから環境変数を設定する:
secretNameという名前のシークレット内のすべてのキーに対応する環境変数を追加するには、値secretNameを使用します。 シークレットを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=SECRET_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_SECRET>です。 例えば、シークレットsecretName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=secretNameを使用します。 シークレットsecretNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、secretNameという名前のシークレットに単一キーkey1の環境変数を追加するには、値secretName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、secretNameという名前のシークレット内の単一キーkey1に対してmyKeyという名前の環境変数を追加するには、値secretName:myKey=key1を使用します。
この値はオプション です。
--env-from-secret-rm,--env-sec-rm- シークレット名を使用して、シークレット全体に対する環境変数の参照を削除します。 シークレットに対する個々のキー参照を削除するには、
--env-rmオプションを使用します。 このオプションは、複数回指定できます。 この値はオプション です。 --env-rm- 構成マップまたはシークレットのキー/値のペアのキーに対する環境変数の参照を削除します。 個々のキー参照およびリテラル値を削除するには、キーの名前を指定します。 このオプションは、複数回指定できます。 この値はオプション です。
--ephemeral-storage,--es- アプリケーションのインスタンスのために設定する一時ストレージの量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 この値はオプション です。 --force,-f- 指定された構成マップおよびシークレットの参照の存在を検証しません。 構成マップ参照は、
--env-from-configmapまたは--mount-configmapオプションを使用して指定します。 シークレット参照は、--env-from-secret、--mount-secret、または--registry-secretオプションを使用して指定します。 この値はオプション です。 デフォルト値はfalseです。 --image,-i- このアプリケーションに使用するイメージの名前。 形式は
REGISTRY/NAMESPACE/REPOSITORY:TAGです。REGISTRYとTAGはオプションです。REGISTRYを指定しない場合、そのデフォルトはdocker.ioです。TAGを指定しない場合、そのデフォルトはlatestです。 この値はオプション です。 --max-scale,--max,--maxscale- このアプリケーションに使用できるインスタンスの最大数。 この値を
0に設定すると、アプリケーションは必要に応じてスケーリングされます。 アプリケーションのスケーリングは、アプリケーションのプロジェクトのリソース割り当て量ごとのインスタンスによってのみ制限されます。 Code Engine の制限と割り当て量を参照してください。 この値はオプション です。 デフォルト値は10です。 --memory,-m- アプリケーションのインスタンスに設定するメモリーの量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 --min-scale,--min,--minscale- このアプリケーションに使用できるインスタンスの最小数。 この値はオプション です。 デフォルト値は
0です。 --mount-configmap,--mount-cm- マウント・ディレクトリーと構成マップの名前を
MOUNT_DIRECTORY=CONFIGMAP_NAMEの形式で指定して、アプリケーション・コンテナーのファイル・システムに構成マップの内容を追加します。 マウントされる構成マップはそれぞれ、固有のマウント・ディレクトリーを使用しなければなりません。 構成マップ内のキー/値のペアごとに、指定したマウント・ディレクトリーにファイルが追加されます。このとき、キー/値のペアのキーがそのファイル名になり、値がそのファイルの内容になります。 1 つの--mount-configmapオプションにつき 1 つのマウント構成を指定します (例:--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b)。 この値はオプション です。 --mount-data-store,--mount-ds- 永続データ・ストアをマウントします。 フォーマットは、MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH] である。 SUBPATHはオプションである。 このオプションは、複数回指定できます。 この値はオプション です。
--mount-rm- 構成マップまたはシークレットがマウントされているディレクトリーを指定して、アプリケーション・コンテナーのファイル・システムから構成マップまたはシークレットの内容を削除します。 1 つの
--mount-rmオプションにつき 1 つのマウント・ディレクトリーを指定します (例:--mount-rm /etc/configmap-a --mount-rm /etc/secret-b)。 この値はオプション です。 --mount-secret,--mount-sec- マウント・ディレクトリーとシークレットの名前を
MOUNT_DIRECTORY=SECRET_NAMEの形式で指定して、アプリケーション・コンテナーのファイル・システムにシークレットの内容を追加します。 マウントされるシークレットはそれぞれ、固有のマウント・ディレクトリーを使用しなければなりません。 シークレット内のキー/値のペアごとに、指定したマウント・ディレクトリーにファイルが追加されます。このとき、キー/値のペアのキーがそのファイル名になり、値がそのファイルの内容になります。 1 つの--mount-secretオプションにつき 1 つのマウント構成を指定します (例:--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b)。 この値はオプション です。 --no-cluster-local,--ncl- パブリック・エンドポイントを使用してアプリケーションをデプロイします。 アプリケーションは、パブリック・インターネットまたはCode Engineプロジェクト内のコンポーネントから要求を受信できるようにデプロイされます。 この値はオプション です。 デフォルト値は
trueです。 --no-wait,--nw- アプリケーションを更新し、アプリケーションの準備完了を待機しません。
no-waitオプションを指定した場合は、アプリケーションの更新が開始され、待機は行われません。 アプリケーションの状況を確認するには、app getコマンドを使用してください。 この値はオプション です。 デフォルト値はfalseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、jsonpath-as-json=JSONPATH_EXPRESSION、url、およびproject-urlです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --port,-p- アプリケーションが listen するポート。 形式は
[NAME:]PORTです。[NAME:]はオプションです。[NAME:]を指定する場合、有効な値はh2cまたはhttp1です。[NAME:]を指定しないか、http1と指定した場合、ポートでは HTTP/1.1 が使用されます。[NAME:]がh2cの場合、ポートでは暗号化されない HTTP/2 が使用されます。 Code Engine は、デフォルトではアプリが着信接続をポート8080で listen するという前提で機能します。 アプリケーションがポート8080以外のポートで listen する必要がある場合は、--portを使用してそのポートを指定してください。 この値はオプション です。 --probe-live,--pl- このアプリケーションの活性プローブを NAME=VALUE 形式で構成します。 NAME の有効なオプションは、
type、port、path、interval、initial-delay、timeout、failure-thresholdです。 このオプションは複数回指定できます。typeプロパティーは必須で、有効な値はtcpおよびhttpです。 例えば、 --probe-liveタイプ=TCP --probe-liveport=8080。 プローブの操作について詳しくは、「 アプリ用のプローブの構成」を参照してください。 この値はオプション です。 --probe-live-clear,--plr- 活性プローブを削除します。 このオプションは、アプリに現在 Liveness プローブがある場合にのみ許可されます。 この値はオプション です。 デフォルト値は
falseです。 --probe-ready,--pr- このアプリケーションの作動可能プローブを NAME=VALUE 形式で構成します。 NAME の有効なオプションは、
type、port、path、interval、initial-delay、timeout、failure-thresholdです。 このオプションは複数回指定できます。typeプロパティーは必須で、有効な値はtcpおよびhttpです。 例えば、 --probe-readyタイプ=TCP --probe-readyport=8080。 プローブの操作について詳しくは、「 アプリ用のプローブの構成」を参照してください。 この値はオプション です。 --probe-ready-reset,--prr- 作動可能プローブをデフォルト構成にリセットします。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --rebuild- ソースからイメージを再構築します。 再ビルド・オプションは、アプリケーションに現在関連付けられたビルドがある場合に許可されます。 この値はオプション です。 デフォルト値は
falseです。 --registry-secret,--rs- レジストリー・シークレットの名前。 レジストリー・シークレットは、コンテナー・イメージのダウンロード時にプライベート・レジストリーでの認証に使用されます。 この値はオプション です。
--registry-secret-clear,--rsc- レジストリー・シークレットをクリアします。 この値はオプション です。 デフォルト値は
falseです。 --request-timeout,--rt,--timeout,-t- アプリケーションに対して行われた要求の成功/失敗までにかけられる時間 (秒単位)。 この値はオプション です。 デフォルト値は
0です。 --rn,--revision-name- リビジョンの名前。 アプリケーション内で固有の名前を使用します。
- 名前に使用できるのは、小文字、数字、ハイフン (-) です。
- 名前の末尾は小文字の英数字でなければなりません。
- 完全修飾リビジョン名は、
Name_of_application-Name of revisionの形式でなければなりません。 - 完全修飾リビジョン名は 63 文字以下でなければなりません。
この値はオプション です。
--scale-down-delay,--sdd- 並行性が低下した状態で、アプリケーションがスケールダウンされる前に経過する時間 (秒単位)。 同時要求の数が増えると、アプリケーションが拡大します。 要求の数が減少 (並行性の低下) した場合、このオプションに指定された時間によって、アプリケーションがスケールダウンされる前に、削減された並行性を保持する必要がある期間が決定されます。 デフォルトでは、並行性の低下が検出されると、アプリケーションは即時にスケールダウンされます。 この値はオプション です。
デフォルト値は
0です。 --service-account,--sa- サービス・アカウントの名前。 サービス・アカウントは、インスタンスで実行されるプロセスの ID を提供します。 組み込みサービス・アカウントの場合、短縮名
manager、none、reader、およびwriterを使用できます。 接頭部Kubernetes Config Contextが付いたフルネームを使用することもできます。これは、project currentコマンドで判別できます。 この値はオプション です。 --service-account-clear,--sac- サービス・アカウントをクリアします。 この値はオプション です。 デフォルト値は
falseです。 --trusted-profiles-enabled,--trusted,--tpe- このアプリケーションのコンテナーへの計算リソース・トークンのマウントを有効にします。 この値はオプション です。 デフォルト値は
falseです。 --user,-u- アプリケーションを実行するために使用するユーザー ID (UID)。 この値は、アプリケーションの Dockerfile に設定されているユーザー ID をオーバーライドします。 コンテナーのオペレーティング・システム要件に準拠した ID でなければなりません。 この値はオプション です。 デフォルト値は
0です。 --visibility,-v- アプリケーションの表示設定。 有効な値は
public、private、project。 可視性をpublicに設定することは、アプリがパブリック・インターネットから、またはCode Engineプロジェクト内のコンポーネントから要求を受信できることを意味します。 可視性をprivateに設定すると、パブリック・インターネットからアプリにアクセスできなくなり、同じプロジェクトで実行されている仮想プライベート・エンドポイント (VPE) またはCode Engineコンポーネントを使用する他のIBM Cloudからのみネットワーク・アクセスが可能になります。 可視性をprivateにできるのは、プロジェクトがアプリケーションのプライベート可視性をサポートしている場合のみです。 可視性をprojectに設定すると、パブリック・インターネットからアプリにアクセスできなくなり、同じプロジェクトで実行されている他のCode Engineコンポーネントからのみネットワーク・アクセスが可能になります。 この値はオプション です。 --wait,-w- アプリケーションを更新し、アプリケーションの準備完了を待機します。
--waitオプションを指定した場合、アプリケーション更新コマンドは、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、アプリケーションの準備完了を待機します。 指定した--wait-timeoutの期間内にアプリケーションの準備が完了しない場合、アプリケーション作成コマンドは失敗します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- アプリケーションが更新されるまで待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は600です。
例
ibmcloud ce application update --name myapp --image icr.io/codeengine/hello
出力例
Updating application 'myapp' to latest revision.
[...]
Run 'ibmcloud ce application get -n myapp' to check the application status.
OK
https://myapp.4svg40kna19.us-south.codeengine.appdomain.cloud
ベータ・コマンド
Code Engine ベータ版のコマンドは一般的には利用できない。 このコマンドグループは、選択されたアーリーアダプターが簡単に探索できるように、将来的な機能へのアクセスを提供する。
コマンドは、プロジェクトbetaのコンテキスト内で使用する必要があります。
beta コマンドのCLIヘルプを見るには、 ibmcloud ce beta -h を実行する。
ibmcloud ce beta
Code Engine ベータ版のコマンドは一般的には利用できない。 このコマンドグループは、選択されたアーリーアダプターが簡単に探索できるように、将来的な機能へのアクセスを提供する。
コマンドは、プロジェクトbetaのコンテキスト内で使用する必要があります。
beta コマンドのCLIヘルプを見るには、 ibmcloud ce beta -h を実行する。
ibmcloud ce beta COMMAND
例
ibmcloud ce beta help
出力例
NAME:
ibmcloud code-engine beta - Beta Code Engine commands
USAGE:
ibmcloud code-engine beta command [arguments...] [command options]
COMMANDS:
help, h Show help
Enter 'ibmcloud code-engine beta help [command]' for more information about a command.
ビルドのコマンド
ビルド (イメージ・ビルド) は、ソース・コードからコンテナー・イメージを作成するために使用できるメカニズムです。 Code Engineは、Dockerfile および Cloud Native Buildpacks からのビルドをサポートしています。 build コマンドを使用して、ビルド構成の作成、詳細表示、更新、および削除を行うことができます。 ビルド構成を作成した後に、そのビルド構成に基づいて 1 つ以上の buildrun コマンドを実行できます。
コマンドは、プロジェクトbuildのコンテキスト内で使用する必要があります。
ビルドの使用について詳しくは、コンテナー・イメージのビルドを参照してください。
buildコマンドでは、buildまたはbdのいずれかを使用できます。 build コマンドの CLI ヘルプを表示するには、ibmcloud ce build -h を実行してください。
ibmcloud ce build create
ビルドを作成します。
ibmcloud ce build create --name BUILD_NAME [--build-type BUILD_TYPE] [--commit COMMIT] [--context-dir CONTEXT_DIR] [--dockerfile DOCKERFILE] [--force] [--git-repo-secret GIT_REPO_SECRET] [--image IMAGE] [--output OUTPUT] [--quiet] [--registry-secret REGISTRY_SECRET] [--size SIZE] [--source SOURCE] [--strategy STRATEGY] [--timeout TIMEOUT]
コマンド・オプション
-n,--name- ビルドの名前。 プロジェクト内で固有の名前を使用します。
- 名前の先頭と末尾は小文字の英数字でなければなりません。
- 名前は 63 文字以下でなければなりません。使用できるのは小文字の英数字とハイフン (-) です。
この値は必須です。
--build-type,--bt- ビルドのタイプ。 有効な値は
gitおよびlocalです。 ビルドのタイプがlocalの場合、--source、--commit、および--git-repo-secretの各オプションは無効です。 この値はオプション です。 デフォルト値はgitです。 --commit,--cm,--revision- プルするソース・リポジトリー内のコミット、タグ、またはブランチ。 コミット・オプションは、
--build-typeオプションがgitの場合は許可され、--build-typeオプションがlocalの場合は許可されません。 この値はオプション です。 --context-dir,--cdr- buildpacks ファイルまたは Dockerfile を含むリポジトリー内のディレクトリー。 この値はオプション です。
--dockerfile,--df- Dockerfile のパス。 このオプションは、名前が
Dockerfileでない場合にのみ指定します。 この値はオプション です。 デフォルト値はDockerfileです。 --force,-f- 指定されたシークレットの参照の存在を検証しません。 シークレット参照は、
--get-repo-secretまたは--registry-secretオプションを使用して指定します。 この値はオプション です。 デフォルト値はfalseです。 --git-repo-secret,--grs,--repo,-r- SSH シークレットの名前。これには、コンテナー・イメージをビルドするためのソース・コードを含むプライベート・リポジトリーにアクセスするための資格情報が含まれています。 この SSH 秘密を作成するには、
secret create --format SSHコマンドを使用します。 SSH シークレットは、 Git リポジトリー・アクセス・シークレットとしても使用されます。 このオプションは、--build-typeオプションがgitの場合は許可され、--build-typeオプションがlocalの場合は許可されません。 この値はオプション です。 --image,-i- イメージ・レジストリーのロケーション。 形式は
REGISTRY/NAMESPACE/REPOSITORY:TAGです。TAGはオプションです。TAGを指定しない場合、そのデフォルトはlatestです。 この値はオプション です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --registry-secret,--rs- レジストリへのアクセスに使用されるレジストリ秘密。
registry createコマンドを実行すれば、レジストリにシークレットを追加できる。 この値はオプション です。 --size,--sz- ビルドのサイズ。使用するリソースの量を決定します。 有効な値は
small、medium、large、xlarge、xxlarge。 詳しくは、ビルドのサイズの決定を参照してください。 この値はオプション です。 デフォルト値はmediumです。 --source,--src- ソース・コードが格納されている Git リポジトリーの URL (例:
https://github.com/IBM/CodeEngine)。 ソース・オプションは、--build-typeオプションがgitの場合は必須で、--build-typeオプションがlocalの場合は許可されません。 この値はオプション です。 --strategy,--str- イメージのビルドに使用する戦略。 アプリケーションとジョブの場合、有効な値は
dockerfileとbuildpacksです。 関数の場合、有効な値の形式はcodebundle-[RUNTIME-ID]。 例えば、ランタイム IDnodejs-20を使用して関数のコード・バンドルをビルドする場合は、ビルド戦略としてcodebundle-nodejs-20を使用します。ibmcloud ce fn runtimesコマンドを実行すると、サポートされている関数ランタイムの ID を確認できます。 この値はオプション です。 デフォルト値はdockerfileです。 --timeout,--to- ビルドの成功/失敗が決まるまで許容する時間 (秒単位)。 この値はオプション です。 デフォルト値は
600です。
例
以下の例では、helloworld-build にある https://github.com/IBM/CodeEngine ブランチ内の hello ディレクトリー内にあるソース Dockerfile から、main ストラテジーおよび dockerfile サイズを指定して、medium という名前のビルド構成ファイルを作成します。
このビルドを実行依頼すると、ビルドされるコンテナー・イメージは、us.icr.io/mynamespace/codeengine-helloworld というイメージ・レジストリー・シークレットを使用してアクセスする、myregistry にある Container Registry インスタンスに格納されます。
ibmcloud ce build create --name helloworld-build --source https://github.com/IBM/CodeEngine --context-dir /hello --commit main --strategy dockerfile --size medium --image us.icr.io/mynamespace/codeengine-helloworld --registry-secret myregistry
出力例
Creating build helloworld-build...
OK
ibmcloud ce build delete
ビルドを削除します。
ibmcloud ce build delete --name BUILD_NAME [--force] [--ignore-not-found] [--quiet]
コマンド・オプション
--name,-n- ビルドの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce build delete --name helloworld-build
出力例
Are you sure you want to delete build helloworld-build? [y/N]> y
Deleting build 'helloworld-build'...
OK
ibmcloud ce build get
ビルドの詳細を表示します。
ibmcloud ce build get --name BUILD_NAME [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- ビルドの名前。 この値は必須です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce build get --name helloworld-build
出力例
Getting build 'helloworld-build'
OK
Name: helloworld-build
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 15s
Created: 2021-03-14T14:48:19-05:00
Status: Succeeded
Reason: all validations succeeded
Last Build Run:
Name: helloworld-build-run
Age: 39d
Created: 2021-09-30T15:19:33-04:00
Image: us.icr.io/mynamespace/codeengine-helloworld
Registry Secret: myregistry
Build Strategy: dockerfile-medium
Timeout: 10m0s
Source: https://github.com/IBM/CodeEngine
Commit: main
Context Directory: /hello
Dockerfile: Dockerfile
Build Runs:
Name Status Image Age
helloworld-build-run All Steps have completed executing us.icr.io/mynamespace/codeengine-helloworld 39d
ibmcloud ce build list
プロジェクト内のすべてのビルドをリスト表示します。
ibmcloud ce build list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce build list
出力例
Listing builds...
OK
Name Status Reason Image Build Strategy Age Last Build Run Name Last Build Run Age
myhellobuild Succeeded all validations succeeded us.icr.io/mynamespace/codeengine-codeengine-200 dockerfile-medium 160d myhellobuild-run-4xdnb 160d
hello-build-5ckgs Succeeded all validations succeeded us.icr.io/mynamespace/codeengine-codeengine-51 dockerfile-medium 39d helloapp3-build-5ckgs-run-210803-2129500 39d
hello-build-pmg6v Succeeded all validations succeeded us.icr.io/mynamespace/codeengine-codeengine-4f dockerfile-medium 40d hellooapp2-build-pmg6v-run-210802-2112310 40d
helloworld-build Succeeded all validations succeeded us.icr.io/mynamespace/codeengine-helloworld dockerfile-medium 39d helloworld-build-run 39d
ibmcloud ce build update
ビルドを更新します。
ibmcloud ce build update --name BUILD_NAME [--commit COMMIT] [--commit-clear] [--context-dir CONTEXT_DIR] [--dockerfile DOCKERFILE] [--force] [--git-repo-secret GIT_REPO_SECRET] [--git-repo-secret-clear] [--image IMAGE] [--output OUTPUT] [--quiet] [--registry-secret REGISTRY_SECRET] [--size SIZE] [--source SOURCE] [--strategy STRATEGY] [--timeout TIMEOUT]
コマンド・オプション
--name,-n- ビルドの名前。 この値は必須です。
--commit,--cm,--revision- プルするソース・リポジトリー内のコミット、タグ、またはブランチ。 この値はオプション です。
--commit-clear,--cmc- プルするソース・リポジトリー内のコミット、タグ、またはブランチをクリアします。 この値はオプション です。 デフォルト値は
falseです。 --context-dir,--cdr- buildpacks ファイルまたは Dockerfile を含むリポジトリー内のディレクトリー。 この値はオプション です。
--dockerfile,--df- Dockerfile のパス。 このオプションは、名前が
Dockerfileでない場合にのみ指定します。 この値はオプション です。 デフォルト値はDockerfileです。 --force,-f- 指定されたシークレットの参照の存在を検証しません。 シークレット参照は、
--get-repo-secretまたは--registry-secretオプションを使用して指定します。 この値はオプション です。 デフォルト値はfalseです。 --git-repo-secret,--grs,--repo,-r- SSH シークレットの名前。これには、コンテナー・イメージをビルドするためのソース・コードを含むプライベート・リポジトリーにアクセスするための資格情報が含まれています。 この SSH 秘密を作成するには、
secret create --format SSHコマンドを使用します。 SSH シークレットは、 Git リポジトリー・アクセス・シークレットとしても使用されます。 この値はオプション です。 --git-repo-secret-clear,--grsc- SSH シークレットをクリアします。 この値はオプション です。 デフォルト値は
falseです。 --image,-i- イメージ・レジストリーのロケーション。 形式は
REGISTRY/NAMESPACE/REPOSITORY:TAGです。TAGはオプションです。TAGを指定しない場合、そのデフォルトはlatestです。 この値はオプション です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --registry-secret,--rs- レジストリー・シークレットの名前。 レジストリー・シークレットは、コンテナー・イメージのダウンロード時にプライベート・レジストリーでの認証に使用されます。 この値はオプション です。
--size,--sz- ビルドのサイズ。使用するリソースの量を決定します。 有効な値は
small、medium、large、xlarge、xxlarge。 詳しくは、ビルドのサイズの決定を参照してください。 この値はオプション です。 --source,--src- ソース・コードが格納されている Git リポジトリーの URL (例:
https://github.com/IBM/CodeEngine)。 この値はオプション です。 --strategy,--str- イメージのビルドに使用する戦略。 アプリケーションとジョブの場合、有効な値は
dockerfileとbuildpacksです。 関数の場合、有効な値の形式はcodebundle-[RUNTIME-ID]。 例えば、ランタイム IDnodejs-20を使用して関数のコード・バンドルをビルドする場合は、ビルド戦略としてcodebundle-nodejs-20を使用します。ibmcloud ce fn runtimesコマンドを実行すると、サポートされている関数ランタイムの ID を確認できます。 この値はオプション です。 --timeout,--to- ビルドの成功/失敗が決まるまで許容する時間 (秒単位)。 この値はオプション です。 デフォルト値は
600です。
例
ibmcloud ce build update --name helloworld-build --source https://github.com/IBM/CodeEngine --context-dir /hello --commit main --timeout 900
出力例
Updating build helloworld-build...
OK
ビルド実行のコマンド
ビルド (イメージ・ビルド) は、ソース・コードからコンテナー・イメージを作成するために使用できるメカニズムです。 Code Engineは、Dockerfile および Cloud Native Buildpacks からのビルドをサポートしています。 buildrun コマンドを使用して、ビルド実行の実行、詳細表示、および削除を行うことができます。
コマンドは、プロジェクトbuildrunのコンテキスト内で使用する必要があります。
ビルドおよびビルド実行の使用について詳しくは、コンテナー・イメージのビルドを参照してください。
buildrunコマンドでは、buildrunまたはbrのいずれかを使用できます。 buildrun コマンドの CLI ヘルプを表示するには、ibmcloud ce br -h を実行してください。
ibmcloud ce buildrun cancel
ビルド実行をキャンセルします。
ibmcloud ce buildrun cancel --name BUILDRUN_NAME [--quiet]
コマンド・オプション
--name,-n- ビルド実行の名前。 この値は必須です。
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce buildrun cancel --name mybuildrun
出力例
Cancelling build run 'mybuildrun'...
OK
ibmcloud ce buildrun delete
ビルド実行を削除します。
ibmcloud ce buildrun delete (--name BUILDRUN_NAME | --build BUILD_NAME) [--force] [--ignore-not-found] [--quiet]
コマンド・オプション
--build,-b- このオプションは、指定されたビルドからすべてのビルド実行を削除する場合に使用します。
--build値を指定しない場合は、--nameオプションが必須です。 この値はオプション です。 --force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --name,-n- ビルド実行の名前。
--name値を指定しない場合は、--buildオプションが必須です。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce buildrun delete --name mybuildrun
出力例
Are you sure you want to delete build run mybuildrun? [y/N]> y
Deleting build run 'mybuildrun'...
OK
ibmcloud ce buildrun events
ビルド実行のシステム・イベントを表示します。 システム・イベントは最大で60分保持されます。
ibmcloud ce buildrun events --buildrun BUILDRUN_NAME [--output OUTPUT] [--quiet]
コマンド・オプション
--buildrun,-b,--br,--name,-n- ビルド実行の名前。 この値は必須です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
この例は、ビルド実行に関するシステム・イベント情報を表示します。
ibmcloud ce buildrun events --buildrun mybuildrun
出力例
Getting build run 'mybuildrun'...
Getting instances of build run 'mybuildrun'...
Getting events for build run 'mybuildrun'...
OK
mybuildrun-l4mr2-pod-89z4t:
Type Reason Age Source Messages
Normal Scheduled 33s default-scheduler Successfully assigned 4svg40kna19/mybuildrun-l4mr2-pod-89z4t to 10.240.128.97
Normal Pulled 31s kubelet, 10.240.128.97 Container image "gcr.io/distroless/base@sha256:92720b2305d7315b5426aec19f8651e9e04222991f877cae71f40b3141d2f07e" already present on machine
Normal Created 31s kubelet, 10.240.128.97 Created container working-dir-initializer
Normal Started 31s kubelet, 10.240.128.97 Started container working-dir-initializer
Normal Pulled 30s kubelet, 10.240.128.97 Container image "icr.io/obs/codeengine/tekton-pipeline/entrypoint-bff0a22da108bc2f16c818c97641a296:v0.20.1-rc2@sha256:19ec0672b5e84a4c5939c6ece6fa69efbce0d38479baf35ce894cf1c67f7e435" already present on machine
Normal Created 30s kubelet, 10.240.128.97 Created container place-tools
Normal Started 29s kubelet, 10.240.128.97 Started container place-tools
Normal Pulled 28s kubelet, 10.240.128.97 Container image "gcr.io/distroless/base@sha256:92720b2305d7315b5426aec19f8651e9e04222991f877cae71f40b3141d2f07e" already present on machine
Normal Created 28s kubelet, 10.240.128.97 Created container step-create-dir-image-l7lf2
Normal Created 25s kubelet, 10.240.128.97 Created container step-git-source-source-46fm7
Normal Pulled 25s kubelet, 10.240.128.97 Container image "icr.io/obs/codeengine/tekton-pipeline/git-init-4874978a9786b6625dd8b6ef2a21aa70:v0.20.1-rc2@sha256:5febfb32459a114b7beafdc593770a0f692a09d874ac6b59ce85507844641cdf" already present on machine
Normal Started 25s kubelet, 10.240.128.97 Started container step-create-dir-image-l7lf2
Normal Started 24s kubelet, 10.240.128.97 Started container step-git-source-source-46fm7
Normal Pulled 24s kubelet, 10.240.128.97 Container image "icr.io/obs/codeengine/kaniko/executor:v1.3.0-rc1" already present on machine
Normal Created 24s kubelet, 10.240.128.97 Created container step-build-and-push
Normal Started 24s kubelet, 10.240.128.97 Started container step-build-and-push
Normal Pulled 24s kubelet, 10.240.128.97 Container image "icr.io/obs/codeengine/tekton-pipeline/imagedigestexporter-6e7c518e6125f31761ebe0b96cc63971:v0.20.1-rc2@sha256:21b3120ce9b930b4eb1359eb20a3109e3a6643e9d2777ef9694efb033367e57c" already present on machine
Normal Created 24s kubelet, 10.240.128.97 Created container step-image-digest-exporter-gnbrp
Normal Started 23s kubelet, 10.240.128.97 Started container step-image-digest-exporter-gnbrp
ibmcloud ce buildrun get
ビルド実行の詳細を表示します。
ibmcloud ce buildrun get --name BUILDRUN_NAME [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- ビルド実行の名前。 この値は必須です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce buildrun get --name mybuildrun
出力例
Getting build run 'mybuildrun'...
Run 'ibmcloud ce buildrun events -n mybuildrun' to get the system events of the build run.
Run 'ibmcloud ce buildrun logs -f -n mybuildrun' to follow the logs of the build run.
OK
Name: mybuildrun
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 21m
Created: 2021-03-14T14:50:13-05:00
Summary: Succeeded
Status: Succeeded
Reason: All Steps have completed executing
Source:
Commit Branch: main
Commit SHA: abcdeb88263442e28af6ae26d2082dea1d6abcde
Commit Author: myauthor
Image Digest: sha256:522488ca3b54eb65f8c1e609a7b27c08558d08166fe062e7dde6838d4a609d61
Image: us.icr.io/mynamespace/test
ibmcloud ce buildrun list
プロジェクト内のすべてのビルド実行をリスト表示します。
ibmcloud ce buildrun list [--build BUILD] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--build,-b- このオプションは、指定されたビルドのビルド実行のみを表示する場合に使用します。 この値はオプション です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce buildrun list
出力例
Listing builds...
OK
Name Status Build Name Age
helloworld-build-run Succeeded helloworld-build 5d22h
mybuildrun Succeeded helloworld-build 7m23s
mybuildrun2 Succeeded helloworld-build 3m4s
ibmcloud ce buildrun logs
ビルド実行のログを表示します。
ibmcloud ce buildrun logs --buildrun BUILDRUN_NAME [--follow] [--output OUTPUT] [--quiet] [--raw] [--tail TAIL] [--timestamps]
コマンド・オプション
--buildrun,-b,--br,--name,-n- ビルド実行の名前。 この値は必須です。
--follow,-f- ビルド実行のログを監視します。 ビルド実行のログをストリーミングするには、このオプションを使用します。
--followオプションを指定する場合、このログ・コマンドを終了するにはCtrl+Cを入力しなければなりません。 この値はオプション です。 デフォルト値はfalseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --raw,-r- インスタンスとコンテナー・ラベルなしでログを表示します。 この値はオプション です。 デフォルト値は
falseです。 --tail,-t- 指定されたビルド実行のコンテナーについて、ログの最新の行をコンテナーごとに最大で何行表示するかを制限します。 例えば、指定されたビルド実行のコンテナーのログの最後の
3行を表示するには、--tail 3と指定します。 このオプションが指定されない場合、指定されたビルド実行のコンテナーのログのすべての行が表示されます。 この値はオプション です。 デフォルト値は-1です。 --timestamps,--ts- ログ出力の各行にタイム・スタンプを含めます。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce buildrun logs --name mybuildrun
出力例
Getting build run 'mybuildrun'...
Getting instances of build run 'mybuildrun'...
Getting logs for build run 'mybuildrun'...
OK
mybuildrun-v2mb8-pod-tlzdx/step-git-source-source-g2kbf:
{"level":"info","ts":1614089507.7123275,"caller":"git/git.go:165","msg":"Successfully cloned https://github.com/IBM/CodeEngine @ 433e2b8d6529e4a55f5e0f72d3772a79602a5ee8 (grafted, HEAD, origin/main) in path /workspace/source"}
{"level":"info","ts":1614089509.0128207,"caller":"git/git.go:203","msg":"Successfully initialized and updated submodules in path /workspace/source"}
mybuildrun-v2mb8-pod-tlzdx/step-build-and-push:
INFO[0000] Retrieving image manifest node:12-alpine
INFO[0000] Retrieving image node:12-alpine
INFO[0001] Retrieving image manifest node:12-alpine
INFO[0001] Retrieving image node:12-alpine
INFO[0001] Built cross stage deps: map[]
INFO[0001] Retrieving image manifest node:12-alpine
INFO[0001] Retrieving image node:12-alpine
INFO[0002] Retrieving image manifest node:12-alpine
INFO[0002] Retrieving image node:12-alpine
INFO[0002] Executing 0 build triggers
INFO[0002] Unpacking rootfs as cmd RUN npm install requires it.
INFO[0006] RUN npm install
INFO[0006] Taking snapshot of full filesystem...
INFO[0008] cmd: /bin/sh
INFO[0008] args: [-c npm install]
INFO[0008] Running: [/bin/sh -c npm install]
npm WARN saveError ENOENT: no such file or directory, open '/package.json'
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN enoent ENOENT: no such file or directory, open '/package.json'
npm WARN !invalid#2 No description
npm WARN !invalid#2 No repository field.
npm WARN !invalid#2 No README data
npm WARN !invalid#2 No license field.
up to date in 0.27s
found 0 vulnerabilities
INFO[0010] Taking snapshot of full filesystem...
INFO[0010] COPY server.js .
INFO[0010] Taking snapshot of files...
INFO[0010] EXPOSE 8080
INFO[0010] cmd: EXPOSE
INFO[0010] Adding exposed port: 8080/tcp
INFO[0010] CMD [ "node", "server.js" ]
mybuildrun-v2mb8-pod-tlzdx/step-image-digest-exporter-hcvmf:
2021/02/23 14:11:43 warning: unsuccessful cred copy: ".docker" from "/tekton/creds" to "/tekton/home": unable to open destination: open /tekton/home/.docker/config.json: permission denied
{"severity":"INFO","timestamp":"2021-02-23T14:12:05.65581098Z","caller":"logging/config.go:115","message":"Successfully created the logger.","logging.googleapis.com/labels":{},"logging.googleapis.com/sourceLocation":{"file":"github.com/tektoncd/pipeline/vendor/knative.dev/pkg/logging/config.go","line":"115","function":"github.com/tektoncd/pipeline/vendor/knative.dev/pkg/logging.newLoggerFromConfig"}}
{"severity":"INFO","timestamp":"2021-02-23T14:12:05.655937558Z","caller":"logging/config.go:116","message":"Logging level set to: info","logging.googleapis.com/labels":{},"logging.googleapis.com/sourceLocation":{"file":"github.com/tektoncd/pipeline/vendor/knative.dev/pkg/logging/config.go","line":"116","function":"github.com/tektoncd/pipeline/vendor/knative.dev/pkg/logging.newLoggerFromConfig"}}
ibmcloud ce buildrun submit
ビルド実行を実行依頼します。
ibmcloud ce buildrun submit (--build BUILD_NAME [--name NAME]) | (--name NAME [--commit COMMIT] [--context-dir CONTEXT_DIR] [--dockerfile DOCKERFILE] [--git-repo-secret GIT_REPO_SECRET] [--registry-secret REGISTRY_SECRET] [--size SIZE] [--strategy STRATEGY]) [--image IMAGE] [--no-wait] [--output OUTPUT] [--quiet] [--service-account SERVICE_ACCOUNT] [--source SOURCE] [--timeout TIMEOUT] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--build,-b,--bd- 使用するビルド構成の名前。 この値はオプション です。
--commit,--cm,--revision- プルするソース・リポジトリー内のコミット、タグ、またはブランチ。 ビルド・コミット・オプションは、
--sourceオプションが Git リポジトリーの URL に設定されている場合は許可され、--sourceオプションが Git リポジトリーの URL に設定されていない場合は許可されません。 この値はオプション です。 --context-dir,--cdr- buildpacks ファイルまたは Dockerfile を含むリポジトリー内のディレクトリー。 ビルド・コンテキスト・ディレクトリー・オプションは、
--buildオプションが設定されていない場合は許可され、--buildオプションが設定されている場合は許可されません。 この値はオプション です。 --dockerfile,--df- Dockerfile のパス。 このオプションは、名前が
Dockerfileでない場合にのみ指定します。--buildオプションが設定されていない場合はビルド Dockerfile オプションが許可され、--buildオプションが設定されている場合は許可されません。 この値はオプション です。 デフォルト値はDockerfileです。 --git-repo-secret,--grs,--repo,-r- SSH シークレットの名前。これには、コンテナー・イメージをビルドするためのソース・コードを含むプライベート・リポジトリーにアクセスするための資格情報が含まれています。 この SSH 秘密を作成するには、
secret create --format SSHコマンドを使用します。 SSH シークレットは、 Git リポジトリー・アクセス・シークレットとしても使用されます。 このオプションは、--build-sourceオプションが URL の Git リポジトリに設定されている場合にのみ許可されます。 この値はオプション です。 --image,-i- イメージ・レジストリーのロケーション。 形式は
REGISTRY/NAMESPACE/REPOSITORY:TAGです。TAGはオプションです。TAGを指定しない場合、そのデフォルトはlatestです。 この値はオプション です。 -n,--name- ビルド実行の名前。 プロジェクト内で固有の名前を使用します。
--buildオプションが設定されている場合、name オプションはオプションです。--buildオプションが設定されていない場合は、name オプションが必要です。
- 名前の先頭と末尾は小文字の英数字でなければなりません。
- 名前は 63 文字以下でなければなりません。使用できるのは小文字の英数字とハイフン (-) です。
この値はオプション です。
--no-wait,--nw- ビルド実行を実行依頼し、このビルド実行が完了するのを待機しません。
--no-waitオプションを指定した場合は、ビルド実行の実行依頼が開始して、待機は行われません。 ビルド実行状況を確認するには、buildrun getコマンドを使用します。 この値はオプション です。 デフォルト値はtrueです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --registry-secret,--rs- レジストリー・シークレットの名前。 レジストリー・シークレットは、コンテナー・イメージのダウンロード時にプライベート・レジストリーでの認証に使用されます。 レジストリのsecretオプションは、
--buildオプションが設定されていない場合は許可され、--buildオプションが設定されている場合は許可されない。 この値はオプション です。 --service-account,--sa- サービス・アカウントの名前。 サービス・アカウントは、インスタンスで実行されるプロセスの ID を提供します。 組み込みサービス・アカウントの場合、短縮名
manager、none、reader、およびwriterを使用できます。 接頭部Kubernetes Config Contextが付いたフルネームを使用することもできます。これは、project currentコマンドで判別できます。 この値はオプション です。 --size,--sz- ビルドのサイズ。使用するリソースの量を決定します。 有効な値は
small、medium、large、xlarge、xxlarge。 詳しくは、ビルドのサイズの決定を参照してください。 ビルド・サイズ・オプションは、--buildオプションが設定されていない場合は許可され、--buildオプションが設定されている場合は許可されない。 この値はオプション です。 デフォルト値はmediumです。 --source,--src- Git リポジトリーの URL、またはソース・コードを含むローカル・ソースへのパス (例えば、
https://github.com/IBM/CodeEngineまたは.)。--buildオプションが設定されている場合、関連ビルドの--build-typeオプションがlocalであればソース・オプションが必須であり、関連ビルドの--build-typeオプションがgitであればないが許可されます。--buildオプションが設定されていない場合、ソース・オプションはオプションです。 この値はオプション です。 デフォルト値は.です。 --strategy,--str- イメージのビルドに使用する戦略。 アプリケーションとジョブの場合、有効な値は
dockerfileとbuildpacksです。 関数の場合、有効な値の形式はcodebundle-[RUNTIME-ID]。 例えば、ランタイム IDnodejs-20を使用して関数のコード・バンドルをビルドする場合は、ビルド戦略としてcodebundle-nodejs-20を使用します。ibmcloud ce fn runtimesコマンドを実行すると、サポートされている関数ランタイムの ID を確認できます。 ビルド戦略オプションは、--buildオプションが設定されていない場合は許可され、--buildオプションが設定されている場合は許可されない。 指定されていない場合、--sourceが指定され、ソースがローカル・マシンにあれば、ビルド戦略は Code Engine によって決定される。 この値はオプション です。 デフォルト値はdockerfileです。 --timeout,--to- ビルド実行の成功/失敗が決まるまで許容する時間 (秒単位)。 この値はオプション です。 デフォルト値は
600です。 --wait,-w- ビルド実行を実行依頼し、このビルド実行が完了するのを待機します。
--waitオプションを指定した場合、ビルド実行の実行依頼の際に、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、ビルド実行の完了を待機します。 ビルド実行が--wait-timeoutで指定された期間内に完了しない場合、ビルド実行の実行依頼は失敗します。 この値はオプション です。 デフォルト値はfalseです。 --wait-timeout,--wto- このビルド実行が完了するまでに待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は600です。
例
以下のコマンドでは、mybuildrun というビルド実行を実行し、helloworld-build というビルド構成ファイルを使用しています。
ibmcloud ce buildrun submit --name mybuildrun --build helloworld-build
出力例
Submitting build run 'mybuildrun'...
Run 'ibmcloud ce buildrun get -n mybuildrun' to check the build run status.
OK
構成マップのコマンド
構成マップにより、非機密データ情報をデプロイメントに含めることができます。 configmapの値を環境変数として参照することで、特定の情報をデプロイメントから切り離し、アプリ、ジョブ、または関数をポータブルに保つことができます。 構成マップには、キーと値のペアで情報が格納されます。 configmap コマンドを使用して、構成マップの作成、詳細表示、更新、および削除を行うことができます。
コマンドは、プロジェクトconfigmapのコンテキスト内で使用する必要があります。
構成マップの操作について詳しくは、 構成マップの操作 を参照してください。
configmapコマンドでは、configmapまたはcmのいずれかを使用できます。 configmap コマンドの CLI ヘルプを表示するには、ibmcloud ce configmap -h を実行してください。
ibmcloud ce configmap create
構成マップを作成します。
ibmcloud ce configmap create --name CONFIGMAP_NAME (--from-env-file FILE | --from-file FILE | --from-file KEY=FILE | --from-literal KEY=VALUE) [--output OUTPUT] [--quiet]
コマンド・オプション
-n,--name- 構成マップの名前。 プロジェクト内で固有の名前を使用します。
- 名前の先頭と末尾は小文字の英数字でなければなりません。
- 名前は 253 文字以下でなければならず、使用できるのは小文字、数字、ピリオド (.)、ハイフン (-) です。
この値は必須です。
--from-env-file,-eKEY=VALUEの形式と一致する行が 1 つ以上含まれるファイルから構成マップを作成します。 ファイルのパスを値として指定する必要があります。 指定したファイルにある各行が、キー/値のペアとして追加されます。 指定されたファイル内の、空または#で始まる行はすべて無視されます。--from-literalまたは--from-fileを指定しない場合は、この値が必須です。--from-file,-f- ファイルから構成マップを作成します。 ファイルのパスを値として指定する必要があります。
--from-literalまたは--from-env-fileを指定しない場合は、この値が必須です。 --from-literal,-l- キー/値のペアから構成マップを作成します。 形式は
KEY=VALUEでなければなりません。--from-fileまたは--from-env-fileを指定しない場合は、この値が必須です。 このオプションは、複数回指定できます。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
以下の例では、2 組のキー/値のペア (configmap-fromliteral および color=blue) を使用して、size=large という名前の構成マップを作成しています。
ibmcloud ce configmap create --name configmap-fromliteral --from-literal color=blue --from-literal size=large
出力例
Creating Configmap 'configmap-fromliteral'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromliteral' to see more details.
複数のファイルからの値を持つ構成マップの例
以下の例では、複数のファイルに含まれている値を使用して、configmap-fromfile という名前の構成マップを作成しています。
ibmcloud ce configmap create --name configmap-fromfile --from-file ./color.txt --from-file ./size.txt
複数のファイルからの値を持つ構成マップの出力例
Creating configmap 'configmap-fromfile'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromfile' to see more details.
ibmcloud ce configmap delete
構成マップを削除します。
ibmcloud ce configmap delete --name CONFIGMAP_NAME [--force] [--ignore-not-found] [--quiet]
コマンド・オプション
--name,-n- 構成マップの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce configmap delete --name configmap-fromliteral -f
出力例
Deleting Configmap 'configmap-fromliteral'...
OK
ibmcloud ce configmap get
構成マップの詳細を表示します。
ibmcloud ce configmap get --name CONFIGMAP_NAME [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- 構成マップの名前。 この値は必須です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce configmap get --name configmap-fromliteral
出力例
Getting configmap 'configmap-fromliteral'...
OK
Name: configmap-fromliteral
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 21s
Created: 2021-03-01T13:50:56-05:00
Data:
---
color: blue
size: large
ibmcloud ce configmap list
プロジェクト内のすべての構成マップをリスト表示します。
ibmcloud ce configmap list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce configmap list
出力例
Listing Configmaps...
Name Data Age
configmap-fromfile 2 19m13s
configmap-fromliteral 2 16m12s
ibmcloud ce configmap update
構成マップを更新します。
ibmcloud ce configmap update --name CONFIGMAP_NAME (--from-env-file FILE | --from-file FILE | --from-file KEY=FILE | --from-literal KEY=VALUE | --rm KEY) [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- 構成マップの名前。 この値は必須です。
--from-env-file,-eKEY=VALUEの形式と一致する行が 1 つ以上含まれるファイルで構成マップを更新します。 ファイルのパスを値として指定する必要があります。 指定したファイルにある各行が、キー/値のペアとして追加されます。 指定されたファイル内の、空または#で始まる行はすべて無視されます。--from-literalまたは--from-fileを指定しない場合は、この値が必須です。 このオプションは、複数回指定できます。--from-file,-f- ファイルから構成マップを更新します。 ファイルのパスを値として指定する必要があります。
--from-literalまたは--from-env-fileを指定しない場合は、この値が必須です。 このオプションは、複数回指定できます。 --from-literal,-l- キー/値のペアから構成マップを更新します。 形式は
KEY=VALUEでなければなりません。--from-fileまたは--from-env-fileを指定しない場合は、この値が必須です。 このオプションは、複数回指定できます。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --rm- キーの名前を指定して、構成マップの個々のキー/値のペアを削除します。 このオプションは、複数回指定できます。 この値はオプション です。
例
以下の例では、ユーザー名とパスワードの値のペアを使用して、configmap-fromliteral という名前の構成マップを更新しています。
ibmcloud ce configmap update --name configmap-fromliteral --from-literal username=devuser --from-literal password='A!B99c$D1Def'
出力例
Updating configmap 'configmap-fromliteral'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromliteral' to see more details.
ファイルからの値を含む構成マップの例
以下の例では、ファイルに含まれている値を使用して、configmap-fromfile という名前の構成マップを更新しています。
ibmcloud ce configmap update --name configmap-fromfile --from-file ./username.txt --from-file ./password.txt
ファイルからの値を含む構成マップの出力例
Updating configmap 'configmap-fromfile'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromfile' to see more details.
接続コマンド
IBM Cloud® Code Engine アウトバウンド接続機能は、 Code Engine プロジェクトの到達可能なエンドポイントの定義をサポートします。
- アウトバウンド接続には、CIDR表記で許可された宛先IPアドレス範囲を使用する。 許可された宛先は、アウトバウンド・トラフィックが安全であると定義したアドレスに制限されることを保証する。 そのため、インターネットへの不要なアクセスを防ぎ、コンプライアンスとセキュリティを強化することができます。
- Code Engine CLI を使用して、 Code Engine プロジェクトと IBM Cloud VPC Private Path サービスを 接続します。 Private Pathは、 Code Engine のような IBM Cloud サービスとVPC間の接続を、セキュリティを損なったりVPCを危険にさらすことなく可能にします。 IBM Cloud サービスがプロバイダーの VPC に接続できるようにする 」を参照してください。
CIDR範囲の指定は、プロジェクト内部通信、プライベートパス接続、プライベートサービス接続には影響しない。 結果として、CIDR範囲に基づいてアウトバウンドトラフィックを制限しても、 Code Engine プロジェクト内のアプリケーション同士の通信や、接続されたプライベートパスサービスとの通信、 IBM Cloud サービスAPIのプライベートエンドポイントとの通信を妨げることはありません。
コマンドは、プロジェクトconnectivityのコンテキスト内で使用する必要があります。
アウトバウンド接続コマンドの操作の詳細については、 Code Engine のアウトバウンド接続の操作を 参照してください。
connectivityコマンドでは、connectivityまたはconnのいずれかを使用できます。 connectivity コマンドの CLI ヘルプを表示するには、ibmcloud ce connectivity -h を実行してください。
ibmcloud ce connectivity outbound
アウトバウンド接続コマンドの管理
ibmcloud ce connectivity outbound COMMAND
ibmcloud ce connectivity outbound create
許可された送信先を作成する。
ibmcloud ce connectivity outbound create --name OUTBOUND_DESTINATION_NAME (--cidr CIDR_IP_ADDRESS | --pps-crn PPS_CRN) [--force] [--format FORMAT] [--quiet]
コマンド・オプション
--n,--cidr-name,--name- 必須。 許可された送信先の名前。 この値は必須です。
--cidr,-c- 有効なIPアドレス範囲をCIDR形式(例: 1.2.3.0/24)で指定します。 この値はオプション です。
--force,-f- 確認を求めずに作成を強制します。 この値はオプション です。 デフォルト値は
falseです。 --format,--fo- 許可された送信先のフォーマット。 有効な値は [
cidr、cidr_block、pps、private_path_gateway_service]指定しない場合は、デフォルトはcidr。 この値はオプション です。 デフォルト値はcidr_blockです。 --pps-crn,--private-path-service-crn- 接続先のプライベートパスサービスの CRN を指定する。 この値はオプション です。
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce connectivity outbound create --name allow-to-subnet-a --cidr 5.6.7.8/29
出力例
Creating allowed destination IP address range 'allow-to-subnet-a'...
OK
プライベート・パスのアウトバウンド接続を作成する例
ibmcloud ce connectivity outbound create --name my-pps-connection --format pps --pps-crn crn:v1:bluemix:public:is:eu-de:a/abcdefabcdefabcdefabcd1234567890::private-path-service-gateway:r010-2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
プライベート・パスのアウトバウンド接続を作成する出力例
Creating allowed outbound destination 'my-pps-connection'...
Successfully created allowed outbound destination 'my-pps-connection'. Current status is 'deploying'
Run 'ibmcloud ce connectivity outbound get --name my-pps-connection' to see more details.
OK
ibmcloud ce connectivity outbound delete
許可された送信先を削除する。
ibmcloud ce connectivity outbound delete --name OUTBOUND_DESTINATION_NAME [--force] [--ignore-not-found] [--quiet]
コマンド・オプション
--n,--cidr-name,--name- 必須。 許可された送信先の名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce connectivity outbound delete --name allow-to-subnet-a
出力例
Are you sure you want to delete allowed outbound destination 'allow-to-subnet-a'? [y/N]> y
Deleting allowed outbound destination 'allow-to-subnet-a'...
OK
ibmcloud ce connectivity outbound get
許可された送信先の詳細を表示する。
ibmcloud ce connectivity outbound get --name OUTBOUND_DESTINATION_NAME [--output OUTPUT] [--quiet]
コマンド・オプション
--n,--cidr-name,--name- 必須。 許可された送信先の名前。 この値は必須です。
--output,-o- 出力フォーマット。 有効な値は「json」、「yaml」、「jsonpath=JSONPATH_EXPRESSION」、「jsonpath-as-json=JSONPATH_EXPRESSION」である。 この値はオプション です。
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce connectivity outbound get --name allow-to-subnet-a
出力例
Getting allowed outbound destination 'allow-to-subnet-a'...
OK
Project name: myproj
Name: allow-to-subnet-a
Format: cidr_block
IP address range: 5.6.7.8/29
プライベート・パスのアウトバウンド接続を取得する例
ibmcloud ce connectivity outbound get --name my-pps-connection
プライベート・パスのアウトバウンド接続を取得するための出力例
Getting allowed outbound destination 'my-pps-connection'...
OK
Project name: myproj
Name: my-pps-connection
Format: private_path_service_gateway
Private path service:
CRN: crn:v1:bluemix:public:is:eu-de:a/abcdefabcdefabcdefabcd1234567890::private-path-service-gateway:r010-2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
Status: ready
Name: my-private-path--is-vpc-pps
Endpoints:
api.ce-1a2b3c4d5e6f.intra
VPE gateway:
Name: code-engine-prod-eu-de-1234ab
IP addresses:
192.168.12.48
192.168.24.60
192.168.36.72
ibmcloud ce connectivity outbound list
許可されたすべての送信先をリストする。
ibmcloud ce connectivity outbound list [--format FORMAT] [--output OUTPUT] [--quiet]
コマンド・オプション
--format- 許可された送信先の表示を、指定された形式に制限する。 1つ以上のフォーマットをカンマ区切りのリストで指定する。 有効な値は [
cidr、cidr_block、pps、private_path_gateway_service]この値はオプションです。 設定されていない場合、すべてのフォーマットで許可された送信先がレンダリングされる。 --output,-o- 出力フォーマット。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce connectivity outbound list
出力例
Listing allowed outbound destinations...
OK
CIDR ranges:
Name IP address range
allow-to-subnet-a 5.6.7.8/29
allow-to-subnet-b 11.12.13.0/24
Private path connections:
Name Status Service endpoints
broken-connection failed
my-pps-connection ready api.ce-1a2b3c4d5e6f.intra
ibmcloud ce connectivity outbound update
許可された送信先IPアドレス範囲を更新する。
ibmcloud ce connectivity outbound update --name OUTBOUND_DESTINATION_NAME --cidr CIDR_IP_ADDRESS [--force] [--quiet]
コマンド・オプション
--cidr,-c- 必須。 有効なIPアドレス範囲をCIDR形式(例: 1.2.3.0/24)で指定します。 この値は必須です。
--n,--cidr-name,--name- 必須。 許可された送信先の名前。 この値は必須です。
--force,-f- 確認なしで更新を強制します。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce connectivity outbound update --name allow-to-subnet-a --cidr 5.6.7.0/27
出力例
Updating allowed destination IP address range 'allow-to-subnet-a'...
OK
Domainmapping コマンド
ドメインマッピングは、プロジェクト内の Code Engine アプリケーションへの URL ルートを提供します。 Code Engine を使用すると、アプリケーションをデプロイするたびに、これらのマッピングがデフォルトで自動的に作成されます。 しかし、 Code Engine アプリケーションに独自のカスタムドメインをマッピングして、カスタム URL からのリクエストを Code Engine のアプリケーションにルーティングすることができます。 ドメインマッピングの作成、詳細表示、更新、削除には、
domainmapping コマンドを使用する。
Code Engineでカスタム・ドメイン・マッピングを設定する場合、プロジェクト内の完全修飾ドメイン・ネーム (FQDN) と Code Engine アプリケーションの間の 1-to-1 マッピングを定義します。 CLI でカスタム・ドメイン・マッピングを構成して操作するには、 domainmapping コマンドを使用します。
コマンドは、プロジェクトdomainmappingのコンテキスト内で使用する必要があります。
ドメイン・マッピングの操作について詳しくは、 アプリのカスタム・ドメイン・マッピングの構成 を参照してください。
domainmappingコマンドでは、domainmappingまたはdmのいずれかを使用できます。 domainmapping コマンドの CLI ヘルプを表示するには、ibmcloud ce domainmapping -h を実行してください。
ibmcloud ce domainmapping create
カスタム・ドメイン・マッピングを作成します。
ibmcloud ce domainmapping create --domain-name DOMAIN_NAME [--target-type TARGET_TYPE] --tls-secret SECRET_NAME [--quiet]
コマンド・オプション
--domain-name,--dn,-n,--name- ドメイン・マッピングの名前を指定します。 この名前は、有効な完全修飾ドメイン名 (FQDN) でなければなりません。 例えば、
www.example.comです。 この値は必須です。 --target,-t- ターゲット・アプリケーションまたは関数の名前。 この値は必須です。
--target-type,--type- ターゲットのタイプです。 有効な値は
applicationまたはfunctionです。 この値は必須です。 --tls-secret,--secret,--tls- すべての中間証明書を含む証明書と、ドメインマッピングに対応する秘密鍵を含むTLSシークレットを指定する。 証明書は、信頼できる公開認証局 (CA) によって署名されている必要があります。 自己署名証明書はサポートされていません。 この値は必須です。
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
以下の例では、 Code Engine myapp アプリケーションとカスタム・ドメイン www.example.com の間のカスタム・ドメイン・マッピングを作成し、TLS シークレット mytlssecret を使用します。
ibmcloud ce domainmapping create --domain-name www.example.com --target myapp --tls-secret mytlssecret
出力例
OK
Domain mapping successfully created.
ibmcloud ce domainmapping delete
カスタム・ドメイン・マッピングを削除します。
ibmcloud ce domainmapping delete --domain-name DOMAIN_NAME [--force] [--ignore-not-found] [--quiet]
コマンド・オプション
--domain-name,--dn,-n,--name- ドメイン・マッピングの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce domainmapping delete --name www.example.com -f
出力例
Deleting domain mapping 'www.example.com'...
OK
ibmcloud ce domainmapping get
カスタム・ドメイン・マッピングの詳細を表示します。
ibmcloud ce domainmapping get --domain-name DOMAIN_NAME [--output OUTPUT] [--quiet]
コマンド・オプション
--domain-name,--dn,-n,--name- ドメイン・マッピングの名前。この値は 必須です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce domainmapping get --name www.example.com
出力例
Getting domainmapping 'www.example.com'...
OK
Domain Name: www.example.com
CNAME: custom.abcdabcdabc.us-south.codeengine.appdomain.cloud
Target Name: myapp
Target Type: app
TLS Secret: mytlssecret
Status: ready
ibmcloud ce domainmapping list
プロジェクト内のドメイン・マッピングをリストします。
ibmcloud ce domainmapping list [--all] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--all,-a- プロジェクト内のすべてのドメイン・マッピング (カスタム・ドメイン・マッピングやシステム・ドメイン・マッピングなど) を表示します。 この値はオプション です。 デフォルト値は
falseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
以下の例では、すべてのカスタム・ドメイン・マッピングのリストを表示します。
ibmcloud ce domainmapping list
出力例
Listing domain mappings...
OK
Name CNAME Target Target-Type Status Secret Name Age
www.example.com custom.abcdabcdabc.us-south.codeengine.appdomain.cloud myapp app ready mytlssecret 36m
カスタム・ドメイン・マッピングと自動生成されたシステム・ドメイン・マッピングの両方を含む、アプリケーションのすべてのドメイン・マッピングのリストを表示するには、 ibmcloud ce domainmapping list コマンドで --all オプションを指定します。
ibmcloud ce domainmapping update
カスタム・ドメイン・マッピングを更新します。
ibmcloud ce domainmapping update --domain-name DOMAIN_NAME --target TARGET_NAME --tls-secret SECRET_NAME [--quiet] [--target-type TARGET_TYPE]
コマンド・オプション
--domain-name,--dn,-n,--name- ドメイン・マッピングの名前。 この値は必須です。
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --target,-t- ターゲット・アプリケーションまたは関数の名前。 この値はオプション です。
--target-type,--type- ターゲットのタイプです。 有効な値は
applicationまたはfunctionです。 この値はオプション です。 --tls-secret,--secret,--tls- すべての中間証明書を含む証明書と、ドメインマッピングに対応する秘密鍵を含むTLSシークレットを指定する。 証明書は、信頼できる公開認証局 (CA) によって署名されている必要があります。 自己署名証明書はサポートされていません。 この値はオプション です。
例
以下の例では、 mytlssecret の代わりに mytlssecret2 を使用するように www.example.com ドメイン・マッピングを更新します。
ibmcloud ce domainmapping update --domain-name www.example.com --tls-secret mytlssecret2
出力例
Updating domainmapping 'www.example.com'...
実験コマンド
Code Engine 実験的なコマンドは一般には利用できない。 このコマンドグループは、選択されたアーリーアダプターが簡単に探索できるように、将来的な機能へのアクセスを提供する。
コマンドは、プロジェクトexperimentalのコンテキスト内で使用する必要があります。
experimentalコマンドでは、experimentalまたはexpのいずれかを使用できます。 experimental コマンドの CLI ヘルプを表示するには、ibmcloud ce exp -h を実行してください。
ibmcloud ce experimental
Code Engine 実験的なコマンドは一般には利用できない。 このコマンドグループは、選択されたアーリーアダプターが簡単に探索できるように、将来的な機能へのアクセスを提供する。
コマンドは、プロジェクトexperimentalのコンテキスト内で使用する必要があります。
experimentalコマンドでは、experimentalまたはexpのいずれかを使用できます。 experimental コマンドの CLI ヘルプを表示するには、ibmcloud ce exp -h を実行してください。
ibmcloud ce experimental COMMAND
例
ibmcloud ce experimental help
出力例
NAME:
ibmcloud code-engine experimental - Experimental Code Engine commands
USAGE:
ibmcloud code-engine experimental command [arguments...] [command options]
COMMANDS:
help, h Show help
Enter 'ibmcloud code-engine experimental help [command]' for more information about a command.
艦隊司令部
サーバーレスのフリート管理
ibmcloud ce fleet cancel
サーバーレス艦隊をキャンセルする
ibmcloud ce fleet cancel --id FLEET_ID [--force] [--hard] [--quiet]
コマンド・オプション
--id,--fid,--fleet-id- 必須。 サーバーレスフリートのID。 この値は必須です。
--force,-f- 確認なしの強制キャンセル。 この値はオプション です。 デフォルト値は
falseです。 --hardrunning状態のタスクを含むサーバーレスフリートを即座にキャンセルする。hardオプションを指定しない場合、running状態のタスクの処理は、最終状態に達するまで継続され、そのときだけ艦隊はcanceled状態に変わる。 この値はオプション です。 デフォルト値はfalseです。--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce fleet cancel --force --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
出力例
Canceling serverless fleet...
Run 'ibmcloud ce fleet get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e' to check the fleet status.
OK
Name: fleet-0123456789
ID: 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Status: canceled
Created: 39m
Project region: eu-de
Project name: myproj
Tasks status:
Failed: 0
Canceled: 0
Successful: 0
Running: 0
Pending: 1
Total: 1
ibmcloud ce fleet create
サーバーレス・フリートを起動します。
ibmcloud ce fleet create [--argument ARGUMENT] [--command COMMAND] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--gpu GPU] [--image IMAGE] [--max-scale MAX_SCALE] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mount-data-store MOUNT_DATA_STORE] [--name NAME] [--quiet] [--registry-secret REGISTRY_SECRET] [--retrylimit RETRYLIMIT] [--task-indexes TASK_INDEXES] [--tasks TASKS] [--tasks-from-cos-bucket TASKS_FROM_COS_BUCKET] [--tasks-from-cos-object TASKS_FROM_COS_OBJECT] [--tasks-from-local-file TASKS_FROM_LOCAL_FILE] [--tasks-state-store TASKS_STATE_STORE] [--worker-profile WORKER_PROFILE]
コマンド・オプション
--image,-i- 必須。 タスク処理に使用するコンテナ・イメージの名前。 形式は
REGISTRY/NAMESPACE/REPOSITORY:TAGです。REGISTRYとTAGはオプションです。REGISTRYを指定しない場合、そのデフォルトはdocker.ioです。TAGを指定しない場合、そのデフォルトはlatestです。 この値は必須 です。 --tasks-state-store,--ts-state- 必須。 船団のタスクの状態を保存するCOSバケットを指定する。 この値は必須です。
--argument,--arg,-a- タスクで実行するコマンドに必要なコマンド引数を設定する。 このオプションは、複数回指定できます。 この値はオプション です。
--command,--cmd,-c- タスクで実行するコマンドを設定する。 このオプションは、複数回指定できます。 この値はオプション です。
--cpu,--cp- タスクに設定するCPUの量。 この値はオプション です。 デフォルト値は
1です。 --env,-e- タスクに渡す環境変数を設定する。 NAME=VALUE 形式にする必要があります。 このオプションは、複数回指定できます。 この値はオプション です。
--env-from-configmap,--env-cm- この configmap に保管されているキーと値のペアから環境変数を設定します。 完全な configmap を参照するには NAME を指定し、各キーの接頭部が PREFIX である完全な configmap を参照するには PREFIX=NAME を指定し、個々のキーを参照するには NAME:KEY_A,KEY_B を指定します。 参照されるキーに新しい名前を指定するには、NAME:NEW_KEY_NAME=KEY_A の形式を使用します。 このオプションは、複数回指定できます。 この値はオプション です。
--env-from-secret,--env-sec- このシークレットに保管されているキーと値のペアから環境変数を設定します。 完全なシークレットを参照するには NAME を指定し、各キーの接頭部が PREFIX である完全なシークレットを参照するには PREFIX=NAME を指定し、個々のキーを参照するには NAME:KEY_A,KEY_B を指定します。 参照されるキーに新しい名前を指定するには、NAME:NEW_KEY_NAME=KEY_A の形式を使用します。 このオプションは、複数回指定できます。 この値はオプション です。
--gpu,--gp- リソースに割り当てるGPUの数。 フォーマットはGPU_FAMILY:NUMBER_OF_GPUSです。 NUMBER_OF_GPUSのデフォルトは1であり、小数も可能である。 例:
h100:0.5この値は任意である。 --max-scale,--maxscale,--max- 並列に実行するタスクインスタンスの最大数。 この値はオプション です。 デフォルト値は
1です。 --maxexecutiontime,--met- タスクの最大実行時間(秒)。 この値はオプション です。 デフォルト値は
0です。 --memory,-m- タスクに設定するメモリーの量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 この値はオプション です。 デフォルト値は2Gです。 --mount-data-store,--mount-ds- 永続データ・ストアをマウントします。 フォーマットは、MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH] である。 SUBPATHはオプションである。 このオプションは、複数回指定できます。 この値はオプション です。
--name,-n- フリートの名前。 この値はオプション です。
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --registry-secret,--rs- レジストリー・シークレットの名前。 レジストリー・シークレットは、コンテナー・イメージのダウンロード時にプライベート・レジストリーでの認証に使用されます。
ibmcloud ce registry createを実行してレジストリ秘密を作成する。 この値はオプション です。 --retrylimit,-r- タスクを失敗としてマークする前に再実行する回数。 この値はオプション です。 デフォルト値は
3です。 --task-indexes,--ti0,3,6,9,1-5,7-8,10のように、処理するタスクインデックスを指定する。 インデックス・エントリーは1000個以下とする。--tasksが指定されている場合、このオプションは指定できない。 この値はオプション です。--tasks,--ts- フリートが処理するタスク数を指定する。 この値はオプション です。 デフォルト値は
0です。 --tasks-from-cos-bucket,--ts-bucket- COSバケット内のファイルの場所を指定する。 それぞれのファイルに対して、タスクがフリートによって処理される。 この値はオプション です。
--tasks-from-cos-object,--ts-cos- COSバケットに存在するJSONLファイルの場所を指定する。 このファイルには、フリートが処理するタスクが定義されている。 この値はオプション です。
--tasks-from-local-file,--ts-file- ローカルのJSONLファイルの場所を指定します。 このファイルには、フリートが処理するタスクが定義されている。 この値はオプション です。
--worker-profile,--profile,--prof- 支援対象者のプロフィール希望を記入する。 この値はオプション です。
例
ibmcloud ce fleet cancel create --image icr.io/codeengine/helloworld --tasks-state-store mytaskstore --tasks 1
出力例
Successfully created fleet with name 'fleet-0123456789' and ID '1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e'
Run 'ibmcloud ce fleet get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e' to check the fleet status.
Run 'ibmcloud ce fleet worker list --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e' to retrieve a list of provisioned workers.
Run 'ibmcloud ce fleet task list --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e' to retrieve a list of tasks.
OK
ibmcloud ce fleet delete
サーバーレスフリートを削除する。
ibmcloud ce fleet delete --id FLEET_ID [--force] [--ignore-not-found] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--id,--fid,--fleet-id- 必須。 サーバーレスフリートのID。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- サーバーレスフリートを削除し、フリートが削除されるのを待つ。 この値はオプション です。 デフォルト値は
falseです。 --wait-timeout,--wto- サーバーレスフリートが削除されるまでの待ち時間(秒)。 この値はオプション です。 デフォルト値は
180です。
例
ibmcloud ce fleet delete --force --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
出力例
Deleting serverless fleet...
OK
ibmcloud ce fleet get
サーバーレス・フリートの詳細を表示します。
ibmcloud ce fleet get --id FLEET_ID [--output OUTPUT] [--quiet]
コマンド・オプション
--id,--fid,--fleet-id- 必須。 サーバーレスフリートのID。 この値は必須です。
--output,-o- 出力フォーマット。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce fleet get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
出力例
Getting fleet '1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e'...
OK
Name: fleet-0123456789
ID: 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Status: running
Created: 2025-09-26T10:46:02Z
Project region: eu-de
Project name: myproj
Tasks status:
Pending: 893
Running: 12
Failed: 0
Canceled: 0
Successful: 96
Total: 1001
Code:
Container image reference: icr.io/codeengine/helloworld
Tasks specification:
Task state store: mytaskstore
Indexes: 0-1000
Resources and scaling:
CPU per instance: 1
Memory per instance: 2G
Max number of instances: 12
Max retries per task: 3
Network placement:
Subnet CRN 0: crn:v1:bluemix:public:is:eu-de-1:a/abcdefabcdefabcdefabcd1234567890::subnet:1a1a-2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
ibmcloud ce fleet list
プロジェクト内のすべてのサーバーレス・フリートをリストします。
ibmcloud ce fleet list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--output,-o- 出力フォーマット。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は、
name、status、およびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce fleet list
出力例
Listing fleets...
OK
Name ID Status Tasks finished Tasks total Instances Created
fleet-a123456789 0a0a0a0a-2b2b-3c3c-4d4d-5e5e5e5e5e5e successful 300 300 0 2025-09-26T12:11:28Z
fleet-b123456789 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e running 778 1001 12 2025-09-26T12:43:11Z
fleet-c123456789 2a2a2a2a-2b2b-3c3c-4d4d-5e5e5e5e5e5e canceled 1 1 0 2025-09-26T10:46:02Z
ibmcloud ce fleet task
サーバーレスフリートタスクの管理
ibmcloud ce fleet task COMMAND [--quiet]
コマンド・オプション
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
ibmcloud ce fleet task get
サーバーレス・フリート・タスクの詳細を表示します。
ibmcloud ce fleet task get --task-id TASK_ID --fleet-id FLEET_ID [--output OUTPUT] [--quiet]
コマンド・オプション
--fleet-id,--fid- 必須。 タスクが属するフリートのUUID。 この値は必須です。
--task-id,--tid,--id- 必須。 タスクのUUID。 この値は必須です。
--output,-o- 出力フォーマット。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce fleet task get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e --task-id 2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
出力例
Getting serverless fleet task '2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f'...
OK
ID: 2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
Task index: 226
Created: 2025-09-26T12:45:58Z
Finished: 2025-09-26T12:47:03Z
Fleet ID: 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Project name: myproj
Project ID: 3c3c3c3c-4d4d-5e5e-6f6f-7g7g7g7g7g7g
State information:
Status: successful
Retries: 0
Worker name: fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-1
ibmcloud ce fleet task list
サーバーレスフリートの全タスクをリストアップする。
ibmcloud ce fleet task list --fleet-id FLEET_ID [--output OUTPUT] [--pagination-token PAGINATION_TOKEN] [--quiet] [--sort-by SORT_BY] [--status STATUS]
コマンド・オプション
--fleet-id,--fid- 必須。 タスクが属するフリートのUUID。 この値は必須です。
--output,-o- 出力フォーマット。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。 この値はオプション です。 --pagination-token,--pt- このページネーショントークンで始まるタスクの次のページを表示する。 この値はオプション です。
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,--sb- リストのソート基準とする列を指定します。 有効な値は、
id、index、およびstatusです。 この値はオプション です。 デフォルト値はindexです。 --status,--st- 指定したステータスのタスクを表示する。 有効な値は
failed、canceled、pending、running、successful。 この値はオプション です。
例
ibmcloud ce fleet task list --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
出力例
Listing serverless fleet tasks...
OK
Task index ID Status Result code Worker name
0 5b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f successful 0 fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-0
1 4b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f running fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-1
2 3b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f pending
3 2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f running fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-1
4 1b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f successful 0 fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-0
ibmcloud ce fleet worker
サーバーレスのフリートワーカーを管理
ibmcloud ce fleet worker COMMAND [--quiet]
コマンド・オプション
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
ibmcloud ce fleet worker delete
サーバーレス・フリート・ワーカーを削除します。
ibmcloud ce fleet worker delete --name WORKER_NAME --fleet-id FLEET_ID [--force] [--hard] [--ignore-not-found] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--fleet-id,--fid- 必須。 ワーカーが所属するフリートのID。 この値は必須です。
--name,-n,--worker-name- 必須。 サーバーレス・フリート・ワーカーの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --hard- サーバーレスフリートワーカーを直ちに削除する。 hard' オプションを指定しなかった場合、このワーカーによって処理された 'running' タスクの処理は、それらのタスクが最終状態に達するまで継続され、その時初めてワーカーは削除されます。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- サーバーレス・フリート・ワーカーを削除し、ワーカーが削除されるのを待ちます。 この値はオプション です。 デフォルト値は
falseです。 --wait-timeout,--wto- サーバーレス・フリート・ワーカーが削除されるまでの待ち時間(秒)。 この値はオプション です。 デフォルト値は
180です。
例
ibmcloud ce fleet worker delete --force --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e --worker-name fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-42
出力例
Deleting serverless fleet worker...
OK
ibmcloud ce fleet worker get
サーバーレス・フリート・ワーカーの詳細を表示します。
ibmcloud ce fleet worker get --name WORKER_NAME --fleet-id FLEET_ID [--output OUTPUT] [--quiet]
コマンド・オプション
--fleet-id,--fid- 必須。 ワーカーが所属するフリートのID。 この値は必須です。
--name,-n,--worker-name- 必須。 サーバーレス・フリート・ワーカーの名前。 この値は必須です。
--output,-o- 出力フォーマット。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce fleet worker get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e --worker-name fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-42
出力例
Getting serverless fleet worker...
OK
Name: fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-42
ID: 2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
Created: 2025-09-26T20:05:33Z
Status: running
Version: v1.0.15
Fleet ID: 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Project name: myproj
Project ID: 3c3c3c3c-4d4d-5e5e-6f6f-7g7g7g7g7g7g
Network placement:
IP address: 10.242.0.42
Network zone: eu-de-1
Subnet CRN: crn:v1:bluemix:public:is:eu-de-1:a/abcdefabcdefabcdefabcd1234567890::subnet:1a1a-2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
Profile information:
Profile: cx2-2x4
vCPUs: 2
Memory (GiB): 4
ibmcloud ce fleet worker list
サーバーレスフリートのすべてのワーカーを一覧表示します。
ibmcloud ce fleet worker list --fleet-id FLEET_ID [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--fleet-id,--fid,--id- 必須。 ワーカーが所属するフリートのID。 この値は必須です。
--output,-o- 出力フォーマット。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびstatusです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce fleet worker list --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
出力例
Listing serverless fleet workers...
OK
Name ID Status Profile IP Zone Version
fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-0 2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f running cx2-2x4 10.242.0.42 eu-de-1 v1.0.15
fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-1 3c3c3c3c-4d4d-5e5e-6f6f-7g7g7g7g7g7g initializing cx2-8x16 10.242.0.43 eu-de-1 v1.0.15
機能コマンド
ファンクションとは、 HTTP リクエストによって呼び出されるとタスクを実行する、ステートレスなコードの断片です。 IBM Code Engine 機能により、スケーラブルでサーバーレスな方法でビジネスロジックを実行できます。 IBM Code Engine 機能は、低レイテンシと迅速なスケールアウトのシナリオをサポートする最適化された実行環境を提供します。 お客様の関数コードは、特定の Node.js または Python バージョンを含むマネージドランタイムに書き込むことができます。
コマンドは、プロジェクトfunctionのコンテキスト内で使用する必要があります。
関数の操作について詳しくは、 関数の操作 を参照してください。
ibmcloud ce function bind
IBM Cloud サービスインスタンスを関数にバインドする。
ibmcloud ce function bind --name FUNCTION_NAME (--service-instance SI_NAME | --service-instance-id SI_ID) [--no-wait] [--prefix PREFIX] [--quiet] [--role ROLE] [--service-credential SERVICE_CREDENTIAL] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--name,-n- バインドする関数の名前です。 この値は必須です。
--no-wait,--nw- サービス・インスタンスをバインドし、サービス・バインディングが準備完了になるのを待機しません。
no-waitオプションを指定した場合は、サービス・バインディングの作成が開始して、コマンドは作成の完了を待機せずに終了します。 ファンクションのバインドステータスを確認するには、function getコマンドを使用する。 この値はオプション です。 デフォルト値はfalseです。 --prefix,-p- このサービス・バインディング用に作成される環境変数の接頭部。 使用できるのは大文字、数字、および下線 (_) だけです。また、先頭を数字にすることはできません。 この値はオプション です。
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --role,-r- このサービス・バインディング用に作成される新しいサービス資格情報のサービス役割の名前。 有効な値には、
Reader、Writer、Manager、またはサービス固有の役割があります。 デフォルトではこのオプションはManagerに設定されます。Managerがサポートされない場合には、サービスから最初に指定された役割に設定されます。--service-credentialを指定した場合、このオプションは無視されます。 この値はオプション です。 --service-credential,--sc- このサービス・バインディングで使用する既存のサービス資格情報の名前。 サービス・インスタンス資格情報を指定しない場合は、バインディング操作時に新規の資格情報が生成されます。 この値はオプション です。
--service-instance,--si- 関数にバインドする既存の IBM Cloud サービスインスタンス名。 この値はオプション です。
--service-instance-id,--siid- 関数にバインドする既存の IBM Cloud サービスインスタンスの GUID。 この値はオプション です。
--wait,-w- サービス・インスタンスをバインドし、サービス・バインディングが準備完了になるまで待機します。
--waitオプシ ョ ン を指定す る と、 関数バ イ ン ド は、--wait-timeoutオプシ ョ ン で設定 さ れた最大時間 (秒)、 関数バ イ ン ド が正常に完了する ま で待機 し ます。 指定された--wait-timeout期間内に関数バインドが正常に完了しなかったり、失敗した場合、コマンドは失敗する。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- サービス・バインディングの準備が完了するまで待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は300です。
例
ibmcloud ce fn bind --name myfunction --service-instance my-object-storage
出力例
Binding service instance...
Status: Done
OK
ibmcloud ce function create
機能を作成します。
ibmcloud ce function create --name FUNCTION_NAME [--build-commit BUILD_COMMIT] [--build-context-dir BUILD_CONTEXT_DIR] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-source BUILD_SOURCE] [--build-timeout BUILD_TIMEOUT] [--code-bundle CODE_BUNDLE] [--code-bundle-secret CODE_BUNDLE_SECRET] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--force] [--inline-code INLINE_CODE] [--main MAIN] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--no-wait] [--output OUTPUT] [--quiet] [--runtime RUNTIME] [--scale-down-delay SCALE_DOWN_DELAY] [--trusted-profiles-enabled] [--visibility VISIBILITY] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
-n,--name- 関数の名前。 プロジェクト内で固有の名前を使用します。
- 名前の先頭は小文字でなければなりません。
- 名前の末尾は小文字の英数字でなければなりません。
- 名前は 63 文字以下でなければならず、使用できるのは小文字、数字、ハイフン (-) です。
この値は必須です。
--runtime,-r- この関数に使用するランタイム。 この領域でサポートされるランタイムを見つけるには、
ibmcloud ce function runtimesを実行します。 ランタイム を参照してください。 この値は必須です。 --build-commit,--commit,--bcm,--cm,--revision- プルするソース・リポジトリー内のコミット、タグ、またはブランチ。 この値はオプション です。
--build-context-dir,--context-dir,--bcdr,--cdr- 関数のソース・コードが格納されているリポジトリー内のディレクトリー。 この値はオプション です。
--build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- SSHシークレットの名前。これには、コード・バンドル・イメージをビルドするためのソース・コードを含むプライベート・リポジトリーにアクセスするための資格情報が含まれてます。 この SSH 秘密を作成するには、
secret create --format SSHコマンドを使用します。 SSH シークレットは、 Git リポジトリー・アクセス・シークレットとしても使用されます。 このオプションは、--build-sourceオプションが URL の Git リポジトリに設定されている場合にのみ許可されます。 この値はオプション です。 --build-source,--source,--bsrc,--src- Git リポジトリーの URL、またはソース・コードを含むローカル・ソースへのパス (例えば、
https://github.com/IBM/CodeEngineまたは.)。 この値はオプション です。 --build-timeout,--bto- ビルドの成功/失敗が決まるまで許容する時間 (秒単位)。 この値はオプション です。 デフォルト値は
600です。 --code-bundle,--cb- この機能のために使用する
code-bundleイメージの名前。build-sourceが指定された場合、この値はビルド・プッシュによって生成された出力画像へのパスとなる。build-sourceが指定されていない場合、この値は既存のコード・バンドル・イメージへのパスになります。 形式はREGISTRY/NAMESPACE/REPOSITORY:TAGです。TAGはオプションです。TAGを指定しない場合、そのデフォルトはlatestです。 この値はオプション です。 --code-bundle-secret,--cs,--cbs- プライベート・レジストリーでの認証に使用されるレジストリー・シークレットの名前。
registry createコマンドを実行すれば、レジストリにシークレットを追加できる。 この値はオプション です。 --cpu- 機能のインスタンスに設定されたCPUの量。 有効な値については、 サポートされるメモリとCPUの 組み合わせを参照のこと。 この値はオプション です。 デフォルト値は
1です。 --env,-e- 関数に環境変数を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の環境変数を追加するか、または既存の環境変数をオーバーライドします。 環境変数は--envオプション 1 つにつき 1 つ指定します (例:--env envA=A --env envB=B)。 この値はオプション です。 --env-cm,--env-from-configmap- このconfigmapに格納されているキーと値のペアから、以下のいずれかの方法で環境変数を設定する。
configmapNameという名前の構成マップ内のすべてのキーに対応する環境変数を追加するには、値configmapNameを使用します。 構成マップを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=CONFIGMAP_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>です。 例えば、構成マップconfigmapName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=configmapNameを使用します。 構成マップconfigmapNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、key1という名前の構成マップ内の 1 つのキーconfigmapNameに対応する環境変数を追加するには、値configmapName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、configmapNameという名前の構成マップ内の単一キーkey1にmyKeyという名前の環境変数を追加するには、値configmapName:myKey=key1を使用します。
この値はオプション です。
--env-sec,--env-from-secret- 以下のいずれかの方法で、シークレットに格納されているキーと値のペアから環境変数を設定する。
secretNameという名前のシークレット内のすべてのキーに対応する環境変数を追加するには、値secretNameを使用します。 シークレットを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=SECRET_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_SECRET>です。 例えば、シークレットsecretName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=secretNameを使用します。 シークレットsecretNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、secretNameという名前のシークレットに単一キーkey1の環境変数を追加するには、値secretName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、secretNameという名前のシークレット内の単一キーkey1に対してmyKeyという名前の環境変数を追加するには、値secretName:myKey=key1を使用します。
この値はオプション です。
--force,-f- 指定された構成マップおよびシークレットの参照の存在を検証しません。 この値はオプション です。 デフォルト値は
falseです。 --inline-code- 関数のソースコードを含むファイルへのパスを指定します。 コードは関数と一緒にインラインで格納される。 この値はオプション です。
--main,--fn-main- 提供されたソース・コードに主要機能の名前を指定します。 名前が
mainでない場合、このオプションは必須です。 この値はオプション です。 デフォルト値はmainです。 --maxexecutiontime,--met- この関数が実行を完了するまでの最大時間 (秒)。 この値はオプション です。 デフォルト値は
60です。 --memory,-m- 機能に設定されているメモリ量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 デフォルト値は4Gです。 --no-wait,--nw- ビルド実行が完了するのを待ちません。 この値はオプション です。 デフォルト値は
falseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --scale-down-delay,--sdd- 呼び出しの完了後にインスタンスがアクティブになっている時間 (秒)。 このオプションにより、コールド・スタートの回数を減らすことができます。 詳しくは、 機能インスタンスの存続期間を長くすることはできますか? を参照してください。 この値はオプション です。 デフォルト値は
1です。 --trusted-profiles-enabled,--trusted,--tpe- 関数の実行に対する計算リソース・トークンのマウントを有効にします。 この値はオプション です。 デフォルト値は
falseです。 --visibility,-v- 関数の可視性。 有効な値は
public、private、project。 プロジェクトがファンクション・プライベート・ビジビリティをサポートしている場合のみ、ビジビリティはprivate。 この値はオプション です。 デフォルト値はpublicです。 --wait,-w- ビルド実行が完了するまで待ちます。 この値はオプション です。 デフォルト値は
trueです。 --wait-timeout,--wto- 関数が準備完了になるまでの待ち時間(秒)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は600です。
例
ibmcloud ce fn create --name myfunction --build-source main.js --runtime nodejs
出力例
Preparing function 'myfunction' for build push...
Creating function 'myfunction'...
Packaging files to upload from source path 'main.js'...
Submitting build run 'myfunction-run-111111-12345678'...
Creating image 'private.stg.icr.io/ce--1a1a1-11c22def3rhz/function-myfunction:12345678-1111-dexla'...
Waiting for build run to complete...
Build run status: 'Running'
Build run completed successfully.
Run 'ibmcloud ce buildrun get -n myfunction-run-111111-12345678' to check the build run status.
Waiting for function 'myfunction' to become ready...
Function 'myfunction' is ready.
OK
Run 'ibmcloud ce function get -n myfunction' to see more details.
https://myfunction.11c22def3rhz.us-south.codeengine.appdomain.cloud
ファンクションのステータスをチェックするために ibmcloud ce fn get -n 'myfunction' を実行すると、ファンクションの URL が表示されます。
ibmcloud ce function delete
機能を削除します。
ibmcloud ce function delete --name FUNCTION_NAME [--force] [--ignore-not-found] [--quiet]
コマンド・オプション
--name,-n- 関数の名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce fn delete --name myfunction
出力例
Are you sure you want to delete function 'myfunction'? [y/N]> y
Deleting function 'myfunction'...
OK
ibmcloud ce function get
機能の詳細を表示します。
ibmcloud ce function get --name FUNCTION_NAME [--output OUTPUT] [--quiet] [--save SAVE]
コマンド・オプション
--name,-n- 関数の名前。 この値は必須です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --save,-s- 関数のソースコードをローカルファイルシステムに保存する。 このオプションは、インライン・コードで作成された関数に対してのみサポートされます。 この値はオプション です。
例
ibmcloud ce fn get --name myfunction
出力例
Getting function 'myfunction'...
OK
Name: myfunction
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 6m8s
Created: 2023-06-22T19:59:51Z
URL: https://myfunction.11c22def3rhz.us-south.codeengine.appdomain.cloud
Status: Ready
Resources:
CPU: 0.25
Memory: 500M
Max Execution Time: 60 seconds
Build Information:
Build Run Name: myfunction-run-111111-12345678
Build Type: local
Build Strategy: codebundle-nodejs-20
Timeout: 600
Source: main.js
Build Run Summary: Succeeded
Build Run Status: Succeeded
Build Run Reason: All Steps have completed executing
Run 'ibmcloud ce buildrun get -n myfunction-run-111111-12345678' for details.
Function Code:
Runtime: nodejs-20 (managed)
Bundle Secret: ce-auto-icr-private-us-south
Code Bundle: cr://icr.io/ce--1a1a1-11c22def3rhz/function-myfunction:12345678-1111-dexla
Main: main()
ibmcloud ce function list
プロジェクト内のすべての機能をリストします。
ibmcloud ce function list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce fn delete --name myfunction
出力例
Name Status URL CPU Memory Age
hellofunction Ready https://hellofunction.4svg40kna19.us-south.codeengine.appdomain.cloud 0.25 500M 25h
myfunction Ready https://myfun1.4svg40kna19.us-south.codeengine.appdomain.cloud 0.25 1G 8d
helloworld Ready https://myfunction1.4svg40kna19.us-south.codeengine.appdomain.cloud 0.25 1G 16d
myfunction1 Ready https://myfunction111.4svg40kna19.us-south.codeengine.appdomain.cloud 0.25 500M 25h
myfunction3 Ready https://myfunction41.4svg40kna19.us-south.codeengine.appdomain.cloud 0.25 500M 25h
ibmcloud ce function runtimes
使用可能な関数ランタイムをリストします。
ibmcloud ce function runtimes [--all] [--output OUTPUT] [--quiet]
コマンド・オプション
--all,-A- 非推奨のランタイムを含めて、すべてのランタイムを表示します。 この値はオプション です。 デフォルト値は
falseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce fn runtimes
出力例
Name ID Family Default
Python 3.11 python-3.11 python true
Node.js 20 nodejs-20 nodejs true
Node.js 22 nodejs-22 nodejs false
Python 3.13 python-3.13 python false
ibmcloud ce function unbind
関数から IBM Cloud サービスインスタンスのバインドを解除します。
ibmcloud ce function unbind --name FUNCTION_NAME (--binding BINDING_NAME | --all) [--quiet]
コマンド・オプション
--name,-n- アンバインドする関数の名前です。 この値は必須です。
--all,-A- この機能のすべてのサービス・インスタンスをアンバインドします。
--bindingを指定しない場合は、この値が必須です。 デフォルト値はfalseです。 --binding,-b- アンバインドするバインディングの名前。 バインディング名を参照するには、
ibmcloud ce function get -n FUNCTION_NAMEを実行します。--allを指定しない場合は、この値が必須です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce fn unbind --name myfunction --all
出力例
Removing bindings from 'myfunction'...
OK
ibmcloud ce function update
関数を更新します。
ibmcloud ce function update --name FUNCTION_NAME [--build-clear] [--build-commit BUILD_COMMIT] [--build-commit-clear] [--build-context-dir BUILD_CONTEXT_DIR] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-git-repo-secret-clear] [--build-source BUILD_SOURCE] [--build-timeout BUILD_TIMEOUT] [--code-bundle CODE_BUNDLE] [--code-bundle-secret CODE_BUNDLE_SECRET] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-configmap-rm ENV_FROM_CONFIGMAP_RM] [--env-from-secret ENV_FROM_SECRET] [--env-from-secret-rm ENV_FROM_SECRET_RM] [--env-rm ENV_RM] [--force] [--inline-code INLINE_CODE] [--main MAIN] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--no-wait] [--output OUTPUT] [--quiet] [--rebuild] [--runtime RUNTIME] [--scale-down-delay SCALE_DOWN_DELAY] [--trusted-profiles-enabled] [--visibility VISIBILITY] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--name,-n- 必須。 関数の名前。 この値は必須です。
--build-clear,--bc- この関数からビルドの関連付けを削除します。 ビルドクリアオプションは、あなたの関数が現在関連するビルドを持っている場合にのみ許可されます。 この値はオプション です。 デフォルト値は
falseです。 --build-commit,--commit,--bcm,--cm,--revision- プルするソース・リポジトリー内のコミット、タグ、またはブランチ。 この値はオプション です。
--build-commit-clear,--commit-clear,--bcmc,--cmc- プルするソース・リポジトリー内のコミット、タグ、またはブランチをクリアします。 コミット・クリア・オプションは、機能に現在関連付けられたビルドがある場合にのみ許可されます。 この値はオプション です。 デフォルト値は
falseです。 --build-context-dir,--context-dir,--bcdr,--cdr- 関数のソース・コードが格納されているリポジトリー内のディレクトリー。 このオプションは、
--build-sourceオプションが設定されている場合にのみ許可されます。 この値はオプション です。 --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- あなたのイメージをビルドするためのソースコードを含むプライベートリポジトリにアクセスするための認証情報を含むSSHシークレットの名前。 この値はオプション です。
--build-git-repo-secret-clear,--git-repo-secret-clear,--bgrsc,--grsc- SSH シークレットをクリアします。 このオプションは、機能に現在関連付けられたビルドがある場合にのみ許可されます。 この値はオプション です。 デフォルト値は
falseです。 --build-source,--source,--bsrc,--src- Git リポジトリーの URL、またはソース・コードを含むローカル・ソースへのパス (例えば、
https://github.com/IBM/CodeEngineまたは.)。 この値はオプション です。 --build-timeout,--bto- ビルドの成功/失敗が決まるまで許容する時間 (秒単位)。 この値はオプション です。 デフォルト値は
600です。 --code-bundle,--cb- この機能のために使用する
code-bundleイメージの名前。build-sourceが指定された場合、この値はビルド・プッシュによって生成された出力画像へのパスとなる。build-sourceが指定されていない場合、この値は既存のコード・バンドル・イメージへのパスになります。 形式はREGISTRY/NAMESPACE/REPOSITORY:TAGです。TAGはオプションです。TAGを指定しない場合、そのデフォルトはlatestです。 この値はオプション です。 --code-bundle-secret,--cs,--cbs- プライベート・レジストリーでの認証に使用されるレジストリー・シークレットの名前。
registry createコマンドを実行すれば、レジストリにシークレットを追加できる。 この値はオプション です。 --cpu- 機能のインスタンスに設定されたCPUの量。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 デフォルト値は
1です。 --env,-e- 関数に環境変数を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の環境変数を追加するか、または既存の環境変数をオーバーライドします。 環境変数は--envオプション 1 つにつき 1 つ指定します (例:--env envA=A --env envB=B)。 この値はオプション です。 --env-cm,--env-from-configmap- 以下のいずれかの方法を使用して、この構成マップに保管されているキーと値のペアから環境変数を設定します。
configmapNameという名前の構成マップ内のすべてのキーに対応する環境変数を追加するには、値configmapNameを使用します。 構成マップを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=CONFIGMAP_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>です。 例えば、構成マップconfigmapName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=configmapNameを使用します。 構成マップconfigmapNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、key1という名前の構成マップ内の 1 つのキーconfigmapNameに対応する環境変数を追加するには、値configmapName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、configmapNameという名前の構成マップ内の単一キーkey1にmyKeyという名前の環境変数を追加するには、値configmapName:myKey=key1を使用します。
この値はオプション です。
--env-from-configmap-rm,--env-cm-rm- 構成マップ名を使用して、構成マップ全体に対する環境変数の参照を削除します。 構成マップに対する個々のキー参照を削除するには、
--env-rmオプションを使用します。 このオプションは、複数回指定できます。 この値はオプション です。 --env-sec,--env-from-secret- 以下のいずれかの方法で、シークレットに格納されているキーと値のペアから環境変数を設定する:
secretNameという名前のシークレット内のすべてのキーに対応する環境変数を追加するには、値secretNameを使用します。 シークレットを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=SECRET_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_SECRET>です。 例えば、シークレットsecretName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=secretNameを使用します。 シークレットsecretNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、secretNameという名前のシークレットに単一キーkey1の環境変数を追加するには、値secretName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、secretNameという名前のシークレット内の単一キーkey1に対してmyKeyという名前の環境変数を追加するには、値secretName:myKey=key1を使用します。
この値はオプション です。
--env-from-secret-rm,--env-sec-rm- シークレット名を使用して、シークレット全体に対する環境変数の参照を削除します。 シークレットに対する個々のキー参照を削除するには、
--env-rmオプションを使用します。 このオプションは、複数回指定できます。 この値はオプション です。 --env-rm- 構成マップまたはシークレットのキー/値のペアのキーに対する環境変数の参照を削除します。 個々のキー参照およびリテラル値を削除するには、キーの名前を指定します。 このオプションは、複数回指定できます。 この値はオプション です。
--force,-f- 指定された構成マップおよびシークレットの参照の存在を検証しません。 構成マップ参照は、
--env-from-configmapまたは--mount-configmapオプションを使用して指定します。 シークレット参照は、--env-from-secret、--mount-secret、または--registry-secretオプションを使用して指定します。 この値はオプション です。 デフォルト値はfalseです。 --inline-code- 関数のソース・コードを含むファイルへのパスを指定します。 コードは関数と一緒にインラインで格納される。 この値はオプション です。
--main,--fn-main- 提供されたソース・コードに主要機能の名前を指定します。 名前が
mainでない場合、このオプションは必須です。 この値はオプション です。 デフォルト値はmainです。 --maxexecutiontime,--met- この関数が実行を完了するまでの最大実行時間(秒)。 この値はオプション です。 デフォルト値は
60です。 --memory,-m- 機能に設定されているメモリ量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 デフォルト値は4Gです。 --no-wait,--nw- ビルド実行を実行依頼し、このビルド実行が完了するのを待機しません。
--no-waitオプションを指定した場合は、ビルド実行の実行依頼が開始して、待機は行われません。 ビルド実行状況を確認するには、buildrun getコマンドを使用します。 この値はオプション です。 デフォルト値はfalseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --rebuild- ソースからイメージを再構築する。 リビルドオプションは、その関数が現在関連するビルドを持っている場合にのみ許可されます。 この値はオプション です。 デフォルト値は
falseです。 --runtime,-r- この関数に使用するランタイム。 この領域でサポートされるランタイムを見つけるには、
ibmcloud ce function runtimesを実行します。 ランタイム を参照してください。 この値はオプション です。 --scale-down-delay,--sdd- 呼び出しの完了後にインスタンスがアクティブになっている時間 (秒)。 このオプションにより、コールド・スタートの回数を減らすことができます。 詳しくは、 機能インスタンスの存続期間を長くすることはできますか? を参照してください。 この値はオプション です。 デフォルト値は
1です。 --trusted-profiles-enabled,--trusted,--tpe- 関数の実行に対する計算リソース・トークンのマウントを有効にします。 この値はオプション です。 デフォルト値は
falseです。 --visibility,-v- 関数の可視性。 有効な値は
public、private、project。 プロジェクトがファンクション・プライベート・ビジビリティをサポートしている場合のみ、ビジビリティはprivate。 この値はオプション です。 --wait,-w- ビルド実行が完了するまで待ちます。 この値はオプション です。 デフォルト値は
trueです。 --wait-timeout,--wto- 関数が準備完了になるまでの待ち時間(秒)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は600です。
例
ibmcloud ce fn update --name myfunction --runtime nodejs-20 --build-source main.js
出力例
Preparing function 'myfunction' for build push...
Updating function 'myfunction'...
Packaging files to upload from source path 'main.js'...
Submitting build run 'myfunction-run-111111-12345678'...
Creating image 'icr.io/ce--1a1a1-11c22def3rhz/function-myfunction:12345678-1111-dexla'...
Waiting for build run to complete...
Build run status: 'Running'
Build run completed successfully.
Run 'ibmcloud ce buildrun get -n myfunction-run-111111-12345678' to check the build run status.
Waiting for function 'myfunction' to become ready...
Function 'myfunction' is ready.
OK
Run 'ibmcloud ce function get -n myfunction' to see more details.
https://myfunction.11c22def3rhz.us-south.codeengine.appdomain.cloud
ファンクションのステータスをチェックするために ibmcloud ce fn get -n 'myfunction' を実行すると、ファンクションの URL が表示されます。
help コマンド
Code Engine helpコマンドは、コマンドグループごとに利用可能なコマンドに関する情報を提供する。
ibmcloud ce help
Code Engine helpコマンドは、コマンドグループごとに利用可能なコマンドに関する情報を提供する。
ibmcloud ce help COMMAND
例
ibmcloud ce help
出力例
NAME:
code-engine, ce - Manage Code Engine components
USAGE:
ibmcloud ce command [arguments...] [options...]
COMMANDS:
application, app Manage applications.
binding Manage bindings.
build, bd, b Manage configurations for generating images from source code.
buildrun, br Generate images from a build.
configmap, cm Manage configmaps.
domainmapping, dm Manage domain mappings.
experimental, exp Experimental Code Engine commands
function, fn Manage functions.
help, h Show help.
job Manage jobs to configure tasks.
jobrun, jr Manage instances of a job.
connectivity, conn Manage connectivity commands
project, proj Manage Code Engine projects.
reclamation, recl Manage Code Engine project reclamations.
registry Manage image registry access secrets.
repo Manage Git repository access secrets.
revision, rev Manage application revisions.
secret Manage secrets.
serviceaccess Manage service access secrets.
subscription, sub Manage event subscriptions.
version, v Display the 'code-engine' command-line interface version.
Enter 'ibmcloud ce help command' for more information about a command.
ジョブ・コマンド
ジョブは、あなたの実行コードの1つ以上のインスタンスを並列に実行します。 HTTP 要求を処理するアプリケーションとは異なり、ジョブは一度実行したら終了するように設計されています。 ジョブを作成するときには、ジョブの実行時に毎回使用するワークロードの構成情報を指定できます。 ジョブの構成を作成するには、job コマンドを使用します。
コマンドは、プロジェクトjobのコンテキスト内で使用する必要があります。
ジョブの処理について詳しくは、アプリケーションのデプロイを参照してください。
job コマンドのCLIヘルプを見るには、 ibmcloud ce job -h を実行する。
ibmcloud ce job bind
IBM Cloud サービス・インスタンスをジョブにバインドします。
ibmcloud ce job bind --name JOB_NAME (--service-instance SI_NAME | --service-instance-id SI_ID) [--no-wait] [--prefix PREFIX] [--quiet] [--role ROLE] [--service-credential SERVICE_CREDENTIAL] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--name,-n- バインドするジョブの名前。 この値は必須です。
--no-wait,--nw- サービス・インスタンスをバインドし、サービス・バインディングが準備完了になるのを待機しません。
--no-waitオプションを指定した場合は、サービス・バインディングの作成が開始して、コマンドは作成の完了を待機せずに終了します。 ジョブのバインド状況を確認するには、job getコマンドを使用します。 この値はオプション です。 デフォルト値はfalseです。 --prefix,-p- このサービス・バインディング用に作成される環境変数の接頭部。 使用できるのは大文字、数字、および下線 (_) だけです。また、先頭を数字にすることはできません。 この値はオプション です。
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --role,-r- このサービス・バインディング用に作成される新しいサービス資格情報のサービス役割の名前。 有効な値には、
Reader、Writer、Manager、またはサービス固有の役割があります。 デフォルトではこのオプションはManagerに設定されます。Managerがサポートされない場合には、サービスから最初に指定された役割に設定されます。--service-credentialを指定した場合、このオプションは無視されます。 この値はオプション です。 --service-credential,--sc- このサービス・バインディングで使用する既存のサービス資格情報の名前。 サービス・インスタンス資格情報を指定しない場合は、バインディング操作時に新規の資格情報が生成されます。 この値はオプション です。
--service-instance,--si- ジョブにバインドする既存の IBM Cloud サービス・インスタンスの名前。 この値はオプション です。
--service-instance-id,--siid- ジョブにバインドする既存のIBM Cloudサービス・インスタンスの GUID。 この値はオプション です。
--wait,-w- サービス・インスタンスをバインドし、サービス・バインディングが準備完了になるまで待機します。
--waitオプションを指定した場合、ジョブ・バインドの際に、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、ジョブ・バインドの正常完了を待機します。 ジョブ・バインドが正常に完了しない場合、または--wait-timeoutで指定された期間内に失敗した場合、このコマンドは失敗します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- サービス・バインディングの準備が完了するまで待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は300です。
例
この例では、my-object-storage という名前のサービス・インスタンスを、hello という名前のジョブにバインドしています。
ibmcloud ce job bind --name hello --service-instance my-object-storage
出力例
Binding service instance...
Waiting for service binding to become ready...
Status: Pending (Processing Resource)
Status: Pending (Processing Resource)
Status: Creating service binding
Status: Creating service binding
Status: Ready
OK
ibmcloud ce job create
ジョブを作成します。
ibmcloud ce job create --name JOB_NAME ((--image IMAGE_REF | (--build-source SOURCE [--image IMAGE_REF])) [--argument ARGUMENT] [--array-indices ARRAY_INDICES] [--array-size ARRAY_SIZE] [--build-commit BUILD_COMMIT] [--build-context-dir BUILD_CONTEXT_DIR] [--build-dockerfile BUILD_DOCKERFILE] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-size BUILD_SIZE] [--build-strategy BUILD_STRATEGY] [--build-timeout BUILD_TIMEOUT] [--command COMMAND] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-secret MOUNT_SECRET] [--no-wait] [--output OUTPUT] [--quiet] [--registry-secret REGISTRY_SECRET] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
-n,--name- ジョブの名前。 プロジェクト内で固有の名前を使用します。
- 名前の先頭と末尾は小文字の英数字でなければなりません。
- 名前は 63 文字以下でなければならず、使用できるのは小文字、数字、ハイフン (-) です。
この値は必須です。
--argument,--arg,-a- ジョブの実行のための引数を設定します。 引数は
--argumentオプション 1 つにつき 1 つ指定します (例:-a argA -a argB)。 この値はオプション です。 --array-indices,--ai- ジョブの実行に使用する配列インデックスを指定します。 ハイフン (-) またはコンマ (,) で区切ったインデックスのリストまたは範囲を指定します (例:
0,3,6,9や1-5,7-8,10など)。 最大値は999999です。 このオプションは、--array-sizeオプションが指定されていない場合にのみ指定できる。 この値はオプション です。 デフォルト値は0です。 --array-size,--as,--instances,--is- ジョブの実行に使用するインスタンス数を指定します。 このオプションを使用すると、システムが配列インデックスに変換します。 例えば、
instancesを5に指定すると、システムがarray-indicesを0 - 4に変換します。 このオプションを指定できるのは、--array-indicesオプションが指定されていない場合のみです。 この値はオプション です。 デフォルト値は1です。 --build-commit,--commit,--bcm,--cm,--revision- プルするソース・リポジトリー内のコミット、タグ、またはブランチ。 ビルドコミットオプションは、
--build-sourceオプションが URL の Git リポジトリに設定されている場合にのみ許可されます。 この値はオプション です。 --build-context-dir,--context-dir,--bcdr,--cdr- buildpacks ファイルまたは Dockerfile を含むリポジトリー内のディレクトリー。 ビルド・コンテキスト・ディレクトリー・オプションは、
--build-sourceオプションが設定されている場合にのみ許可されます。 この値はオプション です。 --build-dockerfile,--dockerfile,--bdf,--df- Dockerfile のパス。 このオプションは、名前が
Dockerfileでない場合にのみ指定します。 build dockerfile オプションは、--build-sourceオプションが設定されている場合にのみ許可されます。 この値はオプション です。 デフォルト値はDockerfileです。 --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- SSH シークレットの名前。これには、コンテナー・イメージをビルドするためのソース・コードを含むプライベート・リポジトリーにアクセスするための資格情報が含まれています。 この SSH 秘密を作成するには、
secret create --format SSHコマンドを使用します。 SSH シークレットは、 Git リポジトリー・アクセス・シークレットとしても使用されます。 このオプションは、--build-sourceオプションが URL の Git リポジトリに設定されている場合にのみ許可されます。 この値はオプション です。 --build-size,--size,--bsz,--sz- ビルドのサイズ。使用するリソースの量を決定します。 有効な値は
small、medium、large、xlarge、xxlarge。 詳しくは、ビルドのサイズの決定を参照してください。 ビルド・サイズ・オプションは、--build-sourceオプションが設定されている場合にのみ許可されます。 この値はオプション です。 デフォルト値はmediumです。 --build-source,--source,--bsrc,--src- Git リポジトリーの URL、またはソース・コードを含むローカル・ソースへのパス (例えば、
https://github.com/IBM/CodeEngineまたは.)。 この値はオプション です。 --build-strategy,--strategy,--bstr,--str- イメージのビルドに使用する戦略。 有効な値は
dockerfileおよびbuildpacksです。 ビルド・ストラテジー・オプションは、--build-sourceオプションが設定されている場合にのみ許可されます。 指定されていない場合、--build-sourceが指定され、ソースがローカル・マシンにあれば、ビルド戦略は Code Engine によって決定される。 この値はオプション です。 デフォルト値はdockerfileです。 --build-timeout,--bto- ビルドの成功/失敗が決まるまで許容する時間 (秒単位)。 ビルド・タイムアウト・オプションは、
--build-sourceオプションが設定されている場合にのみ許可されます。 この値はオプション です。 デフォルト値は600です。 --command,--cmd,-c- ジョブの実行のためのコマンドを設定します。 コマンドは
--commandオプション 1 つにつき 1 つ指定します (例:--cmd cmdA --cmd cmdB)。 この値は、コンテナー・イメージ内に指定されているデフォルトのコマンドをオーバーライドします。 この値はオプション です。 --cpu- ジョブの実行のために設定する CPU の量。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 デフォルト値は
1です。 --env,-e- ジョブの実行のための環境変数を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の環境変数を追加するか、または既存の環境変数をオーバーライドします。 環境変数は--envオプション 1 つにつき 1 つ指定します (例:--env envA=A --env envB=B)。 この値はオプション です。 --env-cm,--env-from-configmap- 以下のいずれかの方法を使用して、この構成マップに保管されているキーと値のペアから環境変数を設定します。
configmapNameという名前の構成マップ内のすべてのキーに対応する環境変数を追加するには、値configmapNameを使用します。 構成マップを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=CONFIGMAP_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>です。 例えば、構成マップconfigmapName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=configmapNameを使用します。 構成マップconfigmapNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、key1という名前の構成マップ内の 1 つのキーconfigmapNameに対応する環境変数を追加するには、値configmapName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、configmapNameという名前の構成マップ内の単一キーkey1にmyKeyという名前の環境変数を追加するには、値configmapName:myKey=key1を使用します。
この値はオプション です。
--env-sec,--env-from-secret- 以下のいずれかの方法で、シークレットに格納されているキーと値のペアから環境変数を設定する:
secretNameという名前のシークレット内のすべてのキーに対応する環境変数を追加するには、値secretNameを使用します。 シークレットを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=SECRET_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_SECRET>です。 例えば、シークレットsecretName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=secretNameを使用します。 シークレットsecretNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、secretNameという名前のシークレットに単一キーkey1の環境変数を追加するには、値secretName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、secretNameという名前のシークレット内の単一キーkey1に対してmyKeyという名前の環境変数を追加するには、値secretName:myKey=key1を使用します。
この値はオプション です。
--ephemeral-storage,--es- ジョブの実行のために設定する一時ストレージの量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 この値はオプション です。 デフォルト値は400Mです。 --force,-f- 指定された構成マップおよびシークレットの参照の存在を検証しません。 構成マップ参照は、
--env-from-configmapオプションを使用して指定します。 シークレット参照は、--env-from-secretまたは--registry-secretオプションを使用して指定します。 この値はオプション です。 デフォルト値はfalseです。 --image,-i- ジョブの実行に使用するイメージの名前。 形式は
REGISTRY/NAMESPACE/REPOSITORY:TAGです。REGISTRYとTAGはオプションです。REGISTRYを指定しない場合、そのデフォルトはdocker.ioです。TAGを指定しない場合、そのデフォルトはlatestです。--build-sourceオプションが指定されていない場合は、イメージ・オプションが必要です。 この値はオプション です。 --maxexecutiontime,--met- ジョブの実行のための最長実行時間 (秒単位)。 このオプションは
modeがtaskの場合のみ指定できる。 この値はオプション です。 デフォルト値は7200です。 --memory,-m- ジョブの実行のために設定するメモリーの量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 デフォルト値は4Gです。 --mode- ジョブを実行するためのモード。 有効な値は
taskおよびdaemonです。taskモードでは、maxexecutiontimeとretrylimitのオプションが適用される。daemonモードでは、タイムアウトがなく、失敗したインスタンスは無期限に再起 動されるため、--maxexecutiontimeと--retrylimitオプションは使用できない。 この値はオプション です。 デフォルト値はtask。 --mount-configmap,--mount-cm- 構成マップの内容をジョブの実行のファイル・システムに追加します。これを行うには、マウント・ディレクトリーと構成マップの名前を
MOUNT_DIRECTORY=CONFIGMAP_NAMEという形式で指定します。 マウントされる構成マップはそれぞれ、固有のマウント・ディレクトリーを使用しなければなりません。 構成マップ内のキー/値のペアごとに、指定したマウント・ディレクトリーにファイルが追加されます。このとき、キー/値のペアのキーがそのファイル名になり、値がそのファイルの内容になります。 1 つの--mount-configmapオプションにつき 1 つのマウント構成を指定します (例:--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b)。 この値はオプション です。 --mount-data-store,--mount-ds- 永続データ・ストアをマウントします。 フォーマットは、MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH] である。 SUBPATHはオプションである。 このオプションは、複数回指定できます。 この値はオプション です。
--mount-secret,--mount-sec- マウント・ディレクトリーとシークレットの名前を
MOUNT_DIRECTORY=SECRET_NAMEの形式で指定して、シークレットの内容をジョブの実行のファイル・システムに追加します。 マウントされるシークレットはそれぞれ、固有のマウント・ディレクトリーを使用しなければなりません。 シークレット内のキー/値のペアごとに、指定したマウント・ディレクトリーにファイルが追加されます。このとき、キー/値のペアのキーがそのファイル名になり、値がそのファイルの内容になります。 1 つの--mount-secretオプションにつき 1 つのマウント構成を指定します (例:--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b)。 この値はオプション です。 --no-wait,--nw- ビルド実行が完了するのを待ちません。
--no-waitオプションを指定すると、ビルド実行が開始され、待機しません。 ビルド実行状況を確認するには、buildrun getコマンドを使用します。 待機なしオプションは、--build-sourceオプションが設定されている場合にのみ許可されます。 この値はオプション です。 デフォルト値はfalseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --registry-secret,--rs- レジストリー・シークレットの名前。 レジストリー・シークレットは、コンテナー・イメージのダウンロード時にプライベート・レジストリーでの認証に使用されます。 この値はオプション です。
--retrylimit,-r- ジョブに失敗のマークを付けるまでに、ジョブのインスタンスを再実行する回数。 ゼロ以外の終了コードを返したジョブの配列インデックスは、再実行されます。 このオプションは
modeがtaskの場合のみ指定できる。 この値はオプション です。 デフォルト値は3です。 --service-account,--sa- サービス・アカウントの名前。 サービス・アカウントは、インスタンスで実行されるプロセスの ID を提供します。 組み込みサービス・アカウントの場合、短縮名
manager、none、reader、およびwriterを使用できます。 接頭部Kubernetes Config Contextが付いたフルネームを使用することもできます。これは、project currentコマンドで判別できます。 この値はオプション です。 --trusted-profiles-enabled,--trusted,--tpe- ジョブの実行に対する計算リソース・トークンのマウントを有効にします。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- ビルド実行が完了するまで待ちます。
--waitオプションを指定すると、ビルド実行は、--wait-timeoutオプションで設定された最大時間(秒単位)、ビルド実行の完了を待機します。 指定された--wait-timeout期間内にビルド実行が完了しない場合、ビルド実行は失敗します。 待機オプションは、--build-sourceオプションが設定されている場合にのみ許可されます。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- ビルド実行が完了するのを待機する時間 (秒) 。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 wait-timeout オプションは、--build-sourceオプションが設定されている場合にのみ許可されます。 デフォルト値は600です。
例
以下の例では、コンテナー・イメージicr.io/codeengine/firstjobを使用し、2G MB をメモリーおよび 1 CPU としてコンテナーに割り当てます。 有効なメモリーと CPU の値の選択方法について詳しくは、サポートされるメモリーと CPU の組み合わせを参照してください。
ibmcloud ce job create --image icr.io/codeengine/firstjob --name hellojob --memory 2G --cpu 1
出力例
Creating job 'hellojob'...
OK
ibmcloud ce job delete
ジョブおよび関連するジョブ実行を削除します。
ibmcloud ce job delete --name JOB_NAME [--force] [--ignore-not-found] [--orphan-job-runs] [--quiet]
コマンド・オプション
--name,-n- ジョブの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --orphan-job-runs,-o- このジョブ構成に関連付けられているジョブ実行を保持することを指定します。 後で、孤立したそれらのジョブ実行を別途削除する必要があります。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce job delete --name hello
出力例
Are you sure you want to delete job hello? [y/N]> y
Deleting job 'hello'...
OK
ジョブを削除するために ibmcloud ce job delete コマンドを実行してジョブを削除すると、このジョブを参照しているすべてのサブミットされたジョブの実行も削除されます。
ibmcloud ce job get
ジョブの詳細を表示します。
ibmcloud ce job get --name JOB_NAME [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- ジョブの名前。 この値は必須です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce job get --name hellojob
出力例
Getting job 'hellojob'...
OK
Name: hellojob
ID: abcdabcd-abcd-abcd-abcd-abcdabcd1111
Project Name: myproj
Project ID: 01234567-abcd-abcd-abcd-abcdabcd2222
Age: 59s
Created: 2021-03-01T15:33:30-05:00
Last Job Run:
Name: hellojob-jobrun-abcde
Age: 32d
Created: 2021-06-06T13:52:42-04:00
Image: icr.io/codeengine/firstjob
Resource Allocation:
CPU: 1
Memory: 4G
Runtime:
Mode: task
Array Indices: 0
Array Size: 1
Max Execution Time: 7200
Retry Limit: 3
ibmcloud ce job list
プロジェクト内のすべてのジョブをリスト表示します。
ibmcloud ce job list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce job list
出力例
Name Age Last Job Run Name Last Job Run Age
demo 110d demo-jobrun-hkkmx 108d
myjob-envvar 107d
hellojob 7s
myjob 60d myjob-977v7 58d
testjob 88d testjob-jobrun-kzxlp 72d
ibmcloud ce job unbind
既存のサービス・バインディングを削除するには、IBM Cloud サービス・インスタンスをジョブからアンバインドします。
ibmcloud ce job unbind --name JOB_NAME (--binding BINDING_NAME | --all) [--quiet]
コマンド・オプション
--name,-n- アンバインドするジョブの名前。 この値は必須です。
--all,-A- このジョブのすべてのサービス・インスタンスをアンバインドします。
--bindingを指定しない場合は、この値が必須です。 デフォルト値はfalseです。 --binding,-b- アンバインドするバインディングの名前。 バインディング名を参照するには、
ibmcloud ce job get -n JOB_NAMEを実行します。--allを指定しない場合は、この値が必須です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
この例では、hello という名前のジョブからすべてのバインディングを削除しています。
ibmcloud ce job unbind --name hello --all
出力例
Removing service bindings...
OK
ibmcloud ce job update
ジョブを更新します。
ibmcloud ce job update --name JOB_NAME [--argument ARGUMENT] [--arguments-clear] [--array-indices ARRAY_INDICES] [--array-size ARRAY_SIZE] [--build-clear] [--build-commit BUILD_COMMIT] [--build-commit-clear] [--build-context-dir BUILD_CONTEXT_DIR] [--build-dockerfile BUILD_DOCKERFILE] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-git-repo-secret-clear] [--build-size BUILD_SIZE] [--build-source BUILD_SOURCE] [--build-strategy BUILD_STRATEGY] [--build-timeout BUILD_TIMEOUT] [--command COMMAND] [--commands-clear] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-configmap-rm ENV_FROM_CONFIGMAP_RM] [--env-from-secret ENV_FROM_SECRET] [--env-from-secret-rm ENV_FROM_SECRET_RM] [--env-rm ENV_RM] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--image IMAGE] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-rm MOUNT_RM] [--mount-secret MOUNT_SECRET] [--no-wait] [--output OUTPUT] [--quiet] [--rebuild] [--registry-secret REGISTRY_SECRET] [--registry-secret-clear] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--service-account-clear] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--name,-n- ジョブの名前。 この値は必須です。
--argument,--arg,-a- ジョブの実行のための引数を設定します。 引数は
--argumentオプション 1 つにつき 1 つ指定します (例:-a argA -a argB)。 この値はオプション です。 --arguments-clear,--ac- ジョブの引数をクリアします。 この値はオプション です。 デフォルト値は
falseです。 --array-indices,--ai- ジョブの実行に使用する配列インデックスを指定します。 ハイフン (-) またはコンマ (,) で区切ったインデックスのリストまたは範囲を指定します (例:
0,3,6,9や1-5,7-8,10など)。 最大値は999999です。 このオプションは、--array-sizeオプションが指定されていない場合にのみ指定できる。 この値はオプション です。 --array-size,--as,--instances,--is- ジョブの実行に使用するインスタンス数を指定します。 このオプションを使用すると、システムが配列インデックスに変換します。 例えば、
instancesを5に指定すると、システムがarray-indicesを0 - 4に変換します。 このオプションを指定できるのは、--array-indicesオプションが指定されていない場合のみです。 この値はオプション です。 デフォルト値は0です。 --build-clear,--bc- このジョブからビルドの関連付けを削除します。 ビルドクリアオプションは、ジョブに現在ビルドが関連付けられている場合にのみ使用できます。 この値はオプション です。 デフォルト値は
falseです。 --build-commit,--commit,--bcm,--cm,--revision- プルするソース・リポジトリー内のコミット、タグ、またはブランチ。 ビルドコミットオプションは、この
job updateコマンドで Git リポジトリの URL に--build-sourceオプションが設定されている場合、またはジョブが現在 Git リポジトリソースからの関連ビルドを持っている場合にのみ許可されます。 この値はオプション です。 --build-commit-clear,--commit-clear,--bcmc,--cmc- プルするソース・リポジトリー内のコミット、タグ、またはブランチをクリアします。 コミットクリアオプションは、ジョブが現在関連するビルドを持っている場合にのみ許可されます。 この値はオプション です。 デフォルト値は
falseです。 --build-context-dir,--context-dir,--bcdr,--cdr- buildpacks ファイルまたは Dockerfile を含むリポジトリー内のディレクトリー。 ビルド・コンテキスト・ディレクトリ・オプションは、この
job updateコマンドで--build-sourceオプションが設定されている場合、またはジョブが現在関連するビルドを持っている場合にのみ許可されます。 この値はオプション です。 --build-dockerfile,--dockerfile,--bdf,--df- Dockerfile のパス。 このオプションは、名前が
Dockerfileでない場合にのみ指定します。 ビルド Dockerfile オプションは、--build-sourceオプションがこのjob updateコマンドに設定されている場合、またはジョブに現在関連付けられているビルドがある場合に許可されます。 この値はオプション です。 デフォルト値はDockerfileです。 --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- SSH シークレットの名前。これには、コンテナー・イメージをビルドするためのソース・コードを含むプライベート・リポジトリーにアクセスするための資格情報が含まれています。 この SSH 秘密を作成するには、
secret create --format SSHコマンドを使用します。 SSH シークレットは、 Git リポジトリー・アクセス・シークレットとしても使用されます。 このオプションは、このjob updateコマンドで--build-sourceオプションが Git リポジトリの URL に設定されている場合、またはジョブが現在 Git リポジトリ・ソースからの関連ビルドを持っている場合にのみ許可されます。 この値はオプション です。 --build-git-repo-secret-clear,--git-repo-secret-clear,--bgrsc,--grsc- SSH シークレットをクリアします。 このオプションは、ジョブが現在関連するビルドを持っている場合に許可されます。 この値はオプション です。 デフォルト値は
falseです。 --build-size,--size,--bsz,--sz- ビルドのサイズ。使用するリソースの量を決定します。 有効な値は
small、medium、large、xlarge、xxlarge。 詳しくは、ビルドのサイズの決定を参照してください。 ビルド・サイズ・オプションは、このjob updateコマンドで--build-sourceオプションが設定されている場合、または現在ジョブに関連するビルドがある場合にのみ許可されます。 この値はオプション です。 デフォルト値はmediumです。 --build-source,--source,--bsrc,--src- Git リポジトリーの URL、またはソース・コードを含むローカル・ソースへのパス (例えば、
https://github.com/IBM/CodeEngineまたは.)。 この値はオプション です。 --build-strategy,--strategy,--bstr,--str- イメージのビルドに使用する戦略。 有効な値は
dockerfileおよびbuildpacksです。 ビルド戦略オプションは、このjob updateコマンドで--build-sourceオプションが設定されている場合、またはジョブが現在関連するビルドを持っている場合にのみ許可されます。 指定しない場合、--build-sourceが指定され、ソースがローカル・マシン上にある場合、ビルド・ストラテジーは Code Engine によって決定されます。 この値はオプション です。 デフォルト値はdockerfileです。 --build-timeout,--bto- ビルドの成功/失敗が決まるまで許容する時間 (秒単位)。 ビルド・タイムアウト・オプションは、この
job update・コマンドで--build-source・オプションが設定されているか、ジョブに現在ビルドが関連付けられている場合にのみ許可されます。 この値はオプション です。 デフォルト値は600です。 --command,--cmd,-c- ジョブの実行のためのコマンドを設定します。 コマンドは
--commandオプション 1 つにつき 1 つ指定します (例:--cmd cmdA --cmd cmdB)。 この値は、コンテナー・イメージ内に指定されているデフォルトのコマンドをオーバーライドします。 この値はオプション です。 --commands-clear,--cc- ジョブのコマンドをクリアします。 この値はオプション です。 デフォルト値は
falseです。 --cpu- ジョブの実行のために設定する CPU の量。 この値は、ジョブに割り当てられている
--cpu値を更新します。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 デフォルト値は0です。 --env,-e- ジョブの実行のための環境変数を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の環境変数を追加するか、または既存の環境変数をオーバーライドします。 環境変数は--envオプション 1 つにつき 1 つ指定します (例:--env envA=A --env envB=B)。 この値はオプション です。 --env-cm,--env-from-configmap- 以下のいずれかの方法を使用して、この構成マップに保管されているキーと値のペアから環境変数を設定します。
configmapNameという名前の構成マップ内のすべてのキーに対応する環境変数を追加するには、値configmapNameを使用します。 構成マップを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=CONFIGMAP_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>です。 例えば、構成マップconfigmapName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=configmapNameを使用します。 構成マップconfigmapNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、key1という名前の構成マップ内の 1 つのキーconfigmapNameに対応する環境変数を追加するには、値configmapName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、configmapNameという名前の構成マップ内の単一キーkey1にmyKeyという名前の環境変数を追加するには、値configmapName:myKey=key1を使用します。
この値はオプション です。
--env-from-configmap-rm,--env-cm-rm- 構成マップ名を使用して、構成マップ全体に対する環境変数の参照を削除します。 構成マップに対する個々のキー参照を削除するには、
--env-rmオプションを使用します。 このオプションは、複数回指定できます。 この値はオプション です。 --env-sec,--env-from-secret- 以下のいずれかの方法で、シークレットに格納されているキーと値のペアから環境変数を設定する:
secretNameという名前のシークレット内のすべてのキーに対応する環境変数を追加するには、値secretNameを使用します。 シークレットを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=SECRET_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_SECRET>です。 例えば、シークレットsecretName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=secretNameを使用します。 シークレットsecretNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、secretNameという名前のシークレットに単一キーkey1の環境変数を追加するには、値secretName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、secretNameという名前のシークレット内の単一キーkey1に対してmyKeyという名前の環境変数を追加するには、値secretName:myKey=key1を使用します。
この値はオプション です。
--env-from-secret-rm,--env-sec-rm- シークレット名を使用して、シークレット全体に対する環境変数の参照を削除します。 シークレットに対する個々のキー参照を削除するには、
--env-rmオプションを使用します。 このオプションは、複数回指定できます。 この値はオプション です。 --env-rm- 構成マップまたはシークレットのキー/値のペアのキーに対する環境変数の参照を削除します。 個々のキー参照およびリテラル値を削除するには、キーの名前を指定します。 このオプションは、複数回指定できます。 この値はオプション です。
--ephemeral-storage,--es- ジョブの実行のために設定する一時ストレージの量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 この値はオプション です。 --force,-f- 指定された構成マップおよびシークレットの参照の存在を検証しません。 構成マップ参照は、
--env-from-configmapオプションを使用して指定します。 シークレット参照は、--env-from-secretまたは--registry-secretオプションを使用して指定します。 この値はオプション です。 デフォルト値はfalseです。 --image,-i- ジョブの実行に使用するイメージの名前。 形式は
REGISTRY/NAMESPACE/REPOSITORY:TAGです。REGISTRYとTAGはオプションです。REGISTRYを指定しない場合、そのデフォルトはdocker.ioです。TAGを指定しない場合、そのデフォルトはlatestです。 この値はオプション です。 --maxexecutiontime,--met- ジョブの実行のための最長実行時間 (秒単位)。 このオプションは
modeがtaskの場合のみ指定できる。 この値はオプション です。 デフォルト値は7200です。 --memory,-m- ジョブの実行のために設定するメモリーの量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 --mode- ジョブを実行するためのモード。 有効な値は
taskおよびdaemonです。taskモードでは、maxexecutiontimeとretrylimitのオプションが適用される。daemonモードでは、タイムアウトがなく、失敗したインスタンスは無期限に再起 動されるため、--maxexecutiontimeと--retrylimitオプションは使用できない。 この値はオプション です。 --mount-configmap,--mount-cm- 構成マップの内容をジョブの実行のファイル・システムに追加します。これを行うには、マウント・ディレクトリーと構成マップの名前を
MOUNT_DIRECTORY=CONFIGMAP_NAMEという形式で指定します。 マウントされる構成マップはそれぞれ、固有のマウント・ディレクトリーを使用しなければなりません。 構成マップ内のキー/値のペアごとに、指定したマウント・ディレクトリーにファイルが追加されます。このとき、キー/値のペアのキーがそのファイル名になり、値がそのファイルの内容になります。 1 つの--mount-configmapオプションにつき 1 つのマウント構成を指定します (例:--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b)。 この値はオプション です。 --mount-data-store,--mount-ds- 永続データ・ストアをマウントします。 フォーマットは、MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH] である。 SUBPATHはオプションである。 このオプションは、複数回指定できます。 この値はオプション です。
--mount-rm- 構成マップまたはシークレットがマウントされているディレクトリーを指定して、ジョブの実行のファイル・システムから構成マップまたはシークレットの内容を削除します。 1 つの
--mount-rmオプションにつき 1 つのマウント・ディレクトリーを指定します (例:--mount-rm /etc/configmap-a --mount-rm /etc/secret-b)。 この値はオプション です。 --mount-secret,--mount-sec- マウント・ディレクトリーとシークレットの名前を
MOUNT_DIRECTORY=SECRET_NAMEの形式で指定して、シークレットの内容をジョブの実行のファイル・システムに追加します。 マウントされるシークレットはそれぞれ、固有のマウント・ディレクトリーを使用しなければなりません。 シークレット内のキー/値のペアごとに、指定したマウント・ディレクトリーにファイルが追加されます。このとき、キー/値のペアのキーがそのファイル名になり、値がそのファイルの内容になります。 1 つの--mount-secretオプションにつき 1 つのマウント構成を指定します (例:--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b)。 この値はオプション です。 --no-wait,--nw- ビルド実行が完了するのを待ちません。
--no-waitオプションを指定すると、ビルド実行が開始され、待機しません。 ビルド実行状況を確認するには、buildrun getコマンドを使用します。 no-waitオプションは、このjob updateコマンドで--build-sourceオプションが設定されているか、ジョブに現在関連するビルドがある場合にのみ許可されます。 この値はオプション です。 デフォルト値はfalseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --rebuild- ソースからイメージを再構築します。 再構築オプションは、ジョブに現在関連するビルドがある場合に使用できます。 この値はオプション です。 デフォルト値は
falseです。 --registry-secret,--rs- レジストリー・シークレットの名前。 レジストリー・シークレットは、コンテナー・イメージのダウンロード時にプライベート・レジストリーでの認証に使用されます。 この値はオプション です。
--registry-secret-clear,--rsc- レジストリー・シークレットをクリアします。 この値はオプション です。 デフォルト値は
falseです。 --retrylimit,-r- ジョブに失敗のマークを付けるまでに、ジョブのインスタンスを再実行する回数。 ゼロ以外の終了コードを返したジョブの配列インデックスは、再実行されます。 このオプションは
modeがtaskの場合のみ指定できる。 この値はオプション です。 デフォルト値は3です。 --service-account,--sa- サービス・アカウントの名前。 サービス・アカウントは、インスタンスで実行されるプロセスの ID を提供します。 組み込みサービス・アカウントの場合、短縮名
manager、none、reader、およびwriterを使用できます。 接頭部Kubernetes Config Contextが付いたフルネームを使用することもできます。これは、project currentコマンドで判別できます。 この値はオプション です。 --service-account-clear,--sac- サービス・アカウントをクリアします。 この値はオプション です。 デフォルト値は
falseです。 --trusted-profiles-enabled,--trusted,--tpe- ジョブの実行に対する計算リソース・トークンのマウントを有効にします。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- ビルド実行が完了するまで待ちます。
--waitオプションを指定すると、ビルド実行は、--wait-timeoutオプションで設定された最大時間(秒単位)、ビルド実行の完了を待機します。 指定された--wait-timeout期間内にビルド実行が完了しない場合、ビルド実行は失敗します。 waitオプションは、このjob updateコマンドに--build-sourceオプションが設定されているか、ジョブに現在関連するビルドがある場合にのみ使用できる。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- ビルド実行が完了するのを待機する時間 (秒) 。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 待機タイムアウト・オプションは、--build-sourceオプションがこのjob updateコマンドに設定されている場合、またはジョブに現在関連ビルドがある場合に許可されます。 デフォルト値は600です。
例
ibmcloud ce job update --name hellojob --cpu 2
出力例
Updating job 'hellojob'...
OK
ジョブ実行のコマンド
ジョブは、あなたの実行コードの1つ以上のインスタンスを並列に実行します。 HTTP 要求を処理するアプリケーションとは異なり、ジョブは一度実行したら終了するように設計されています。 ジョブを作成するときには、ジョブの実行時に毎回使用するワークロードの構成情報を指定できます。 ジョブのインスタンスを実行するには、jobrun コマンドを使用します。
コマンドは、プロジェクトjobrunのコンテキスト内で使用する必要があります。
ジョブおよびジョブ実行の使用について詳しくは、ジョブの実行を参照してください。
jobrun コマンドのCLIヘルプを見るには、 ibmcloud ce jobrun -h を実行する。
ibmcloud ce jobrun delete
ジョブ実行を削除します。
ibmcloud ce jobrun delete (--name JOBRUN_NAME | --job JOB_NAME) [--force] [--ignore-not-found] [--quiet]
コマンド・オプション
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --job,-j- このオプションは、指定されたジョブからすべてのジョブ実行を削除する場合に使用します。
--job値を指定しない場合は、--nameオプションが必須です。 この値はオプション です。 --name,-n- 削除するジョブ実行の名前。
--name値を指定しない場合は、--jobオプションが必須です。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce jobrun delete --name myjobrun -f
出力例
Deleting job run 'myjobrun'...
OK
ibmcloud ce jobrun events
ジョブ実行インスタンスのシステム・イベントを表示します。 システム・イベントは最大で60分保持されます。
ibmcloud ce jobrun events (--instance JOBRUN_INSTANCE | --jobrun JOBRUN_NAME) [--output OUTPUT] [--quiet]
コマンド・オプション
--instance,-i- 特定のジョブ実行インスタンスの名前。 インスタンス名を確認するには、
jobrun getコマンドを使用してください。--jobrunを指定しない場合は、この値が必須です。 --jobrun,-j,--name,-n- 指定されたジョブ実行のすべてのインスタンスのイベントを表示します。
--instanceを指定しない場合は、この値が必須です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
以下の例は、指定されたジョブ実行のすべてのインスタンスに関するシステム・イベント情報を表示します。
ibmcloud ce jobrun events --jobrun myjobrun
出力例
Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
Getting events for all instances of job run 'myjobrun'...
OK
myjobrun-1-0:
Type Reason Age Source Messages
Normal Scheduled 49s default-scheduler Successfully assigned 4svg40kna19/myjobrun-1-0 to 10.240.64.136
[...]
Normal Pulling 34s kubelet, 10.240.64.136 Pulling image "icr.io/codeengine/testjob"
myjobrun-2-0:
Type Reason Age Source Messages
Normal Scheduled 50s default-scheduler Successfully assigned 4svg40kna19/myjobrun-2-0 to 10.240.64.131
Normal Pulling 48s kubelet, 10.240.64.131 Pulling image "icr.io/codeengine/testjob"
ジョブ実行の指定されたインスタンスのシステム・イベント情報の例
ibmcloud ce jobrun eventsコマンドで--instanceオプションを使用して、ジョブ実行の指定されたインスタンスのシステム・イベント情報を表示することもできます。 **jobrun get**コマンドを使用して、ジョブ実行に関する詳細
(ジョブ実行の実行中インスタンスを含む) を表示します。
ibmcloud ce jobrun events --instance myjobrun-2-0
ジョブ実行の指定されたインスタンスに関するシステム・イベント情報の出力例
Getting events for job run instance 'myjobrun-2-0'...
OK
myjobrun-2-0:
Type Reason Age Source Messages
Normal Scheduled 3m39s default-scheduler Successfully assigned 4svg40kna19/myjobrun-2-0 to 10.240.64.131
Normal Pulling 3m37s kubelet, 10.240.64.131 Pulling image "icr.io/codeengine/testjob"
Normal Pulled 2m42s kubelet, 10.240.64.131 Successfully pulled image "icr.io/codeengine/testjob"
Normal Created 2m42s kubelet, 10.240.64.131 Created container myjobrun
Normal Started 2m41s kubelet, 10.240.64.131 Started container myjobrun
ibmcloud ce jobrun get
ジョブ実行の詳細を表示します。
ibmcloud ce jobrun get --name JOBRUN_NAME [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- ジョブ実行の名前。 この値は必須です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce jobrun get --name myjobrun
出力例
Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
Getting events of jobrun 'myjobrun'...
Run 'ibmcloud ce jobrun events -n myjobrun' to get the system events of the job run instances.
Run 'ibmcloud ce jobrun logs -f -n myjobrun' to follow the logs of the job run instances.
OK
Name: myjobrun
[...]
Created: 2021-03-02T10:31:13-05:00
Image: icr.io/codeengine/firstjob
Resource Allocation:
CPU: 1
Ephemeral Storage: 400M
Memory: 4G
Runtime:
Mode: task
Array Indices: 1-5
Array Size: 5
JOP_ARRAY_SIZE Value: 5
Max Execution Time: 7200
Retry Limit: 3
Status:
Completed: 2m58s
Instance Statuses:
Succeeded: 5
Conditions:
Type Status Last Probe Last Transition
Pending True 3m55s 3m55s
Running True 3m51s 3m51s
Complete True 2m58s 2m58s
Events:
Type Reason Age Source Messages
[...]
Normal Updated 3m38s (x23 over 3m56s) batch-job-controller Updated JobRun "myjobrun"
Normal Updated 3m38s (x22 over 3m56s) batch-job-controller Updated JobRun "myjobrun"
Instances:
Name Running Status Restarts Age
myjobrun-1-0 0/1 Succeeded 0 3m58s
myjobrun-2-0 0/1 Succeeded 0 3m58s
myjobrun-3-0 0/1 Succeeded 0 3m57s
myjobrun-4-0 0/1 Succeeded 0 3m58s
myjobrun-5-0 0/1 Succeeded 0 3m58s
ibmcloud ce jobrun list
プロジェクト内のすべてのジョブ実行をリスト表示します。
ibmcloud ce jobrun list [--job JOB] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--job,-j- このオプションは、指定されたジョブのジョブ実行のみを表示する場合に使用します。 この値はオプション です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce jobrun list
出力例
Listing job runs...
OK
Name Failed Pending Requested Running Succeeded Unknown Age
firstjob-jobrun-shnj5 0 0 0 0 1 0 11d
myjob-jobrun-fji48 0 0 0 0 5 0 11d
myjob-jobrun-xeqc8 0 0 0 0 5 0 12d
myjobrun 0 0 0 0 5 0 7m47s
mytestjob-jobrun-el0o8 0 0 0 0 1 0 11d
testjobrun 0 0 0 0 5 0 11d
リスト表示されたジョブ実行の名前に、ジョブ実行の名前と現行リビジョンが示されています。
ibmcloud ce jobrun logs
ジョブ実行インスタンスのログを表示します。
ibmcloud ce jobrun logs (--instance JOBRUN_INSTANCE | --jobrun JOBRUN_NAME) [--follow] [--output OUTPUT] [--quiet] [--raw] [--tail TAIL] [--timestamps]
コマンド・オプション
--follow,-f- ジョブ実行インスタンスのログを監視します。 ジョブ実行インスタンスのログをストリーミングするには、このオプションを使用します。
--followオプションを指定する場合、このログ・コマンドを終了するにはCtrl+Cを入力しなければなりません。 この値はオプション です。 デフォルト値はfalseです。 --instance,-i- 特定のジョブ実行インスタンスの名前。 インスタンス名を確認するには、
jobrun getコマンドを使用してください。--jobrunを指定しない場合は、この値が必須です。 --jobrun,-j,--name,-n- 指定されたジョブ実行のすべてのインスタンスのログを表示します。
--instanceを指定しない場合は、この値が必須です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --raw,-r- インスタンスとコンテナー・ラベルなしでログを表示します。 この値はオプション です。 デフォルト値は
falseです。 --tail,-t- 指定されたジョブ実行インスタンスについて、ログの最新の行を最大で何行表示するかを制限します。 例えば、指定したジョブ実行インスタンスのログの最後の
3行を表示するには、--tail 3と指定します。 このオプションが指定されない場合、指定されたジョブ実行インスタンスのログのすべての行が表示されます。 この値はオプション です。 デフォルト値は-1です。 --timestamps,--ts- ログ出力の各行にタイム・スタンプを含めます。 この値はオプション です。 デフォルト値は
falseです。
例
以下の例は、ジョブ実行の特定のインスタンスのログを表示します。 ジョブ実行インスタンスの名前は、jobrun get コマンドで確認できます。
ibmcloud ce jobrun logs --instance myjobrun-3-0
出力例
Getting logs for job run instance 'myjobrun-3-0'...
OK
myjobrun-3-0/myjobrun:
Hi from a batch job! My index is: 3
ジョブ実行のすべてのインスタンスのログの例
以下の例では、ジョブ実行のすべてのインスタンスのログを表示します。
ibmcloud ce jobrun logs --jobrun myjobrun
ジョブ実行のすべてのインスタンスのログの出力例
Getting logs for all instances of job run 'myjobrun'...
Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
OK
myjobrun-1-0/myjobrun:
Hi from a batch job! My index is: 1
myjobrun-2-0/myjobrun:
Hi from a batch job! My index is: 2
myjobrun-3-0/myjobrun:
Hi from a batch job! My index is: 3
myjobrun-4-0/myjobrun:
Hi from a batch job! My index is: 4
myjobrun-5-0/myjobrun:
Hi from a batch job! My index is: 5
ibmcloud ce jobrun restart
実行中のジョブ実行インスタンスを再始動します。
ibmcloud ce jobrun restart (--instance JOBRUN_INSTANCE | --jobrun JOBRUN_NAME) [--quiet]
コマンド・オプション
--instance,-i- 特定のジョブ実行インスタンスの名前。 インスタンス名を確認するには、
jobrun getコマンドを使用してください。--jobrunを指定しない場合は、この値が必須です。 --jobrun,-j,--name,-n- 指定したジョブ実行の実行中のインスタンスをすべて再始動します。
--instanceを指定しない場合は、この値が必須です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce jobrun restart --name myjobrun
出力例
Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
Restarting all running instances of job run 'myjobrun'...
OK
ibmcloud ce jobrun resubmit
前回のジョブ実行の構成に基づいて、ジョブ実行を再実行します。
ibmcloud ce jobrun resubmit --jobrun REFERENCED_JOBRUN_NAME [--argument ARGUMENT] [--arguments-clear] [--array-indices ARRAY_INDICES] [--array-size ARRAY_SIZE] [--array-size-var-override ARRAY_SIZE_VAR_OVERRIDE] [--command COMMAND] [--commands-clear] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-configmap-rm ENV_FROM_CONFIGMAP_RM] [--env-from-secret ENV_FROM_SECRET] [--env-from-secret-rm ENV_FROM_SECRET_RM] [--env-rm ENV_RM] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-rm MOUNT_RM] [--mount-secret MOUNT_SECRET] [--name NAME] [--no-wait] [--output OUTPUT] [--quiet] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--service-account-clear] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--jobrun,-j- このジョブ実行の基にする過去のジョブ実行の名前。 この値は必須です。
--argument,--arg,-a- このジョブ実行の引数を設定します。 引数は
--argumentオプション 1 つにつき 1 つ指定します (例:-a argA -a argB)。 この値はオプション です。 --arguments-clear,--ac- ジョブ実行の引数をクリアします。 この値はオプション です。 デフォルト値は
falseです。 --array-indices,--ai- このジョブ実行に使用する配列インデックスを指定します。 ハイフン (-) またはコンマ (,) で区切ったインデックスのリストまたは範囲を指定します (例:
0,3,6,9や1-5,7-8,10など)。 最大値は999999です。 このオプションは、--array-sizeオプションが指定されていない場合にのみ指定できる。 この値はオプション です。 --array-size,--as,--instances,--is- このジョブ実行に使用するインスタンス数を指定します。 このオプションを使用すると、システムが配列インデックスに変換します。 例えば、
instancesを5に指定すると、システムがarray-indicesを0 - 4に変換します。 このオプションを指定できるのは、--array-indicesオプションが指定されていない場合のみです。 この値はオプション です。 デフォルト値は0です。 --array-size-var-override,--array-size-variable-override,--asvoJOB_ARRAY_SIZE環境変数のカスタム値を指定する。 デフォルトでは、JOB_ARRAY_SIZE環境変数には、array-sizeの値か、array-indicesで指定されたインデックスの数が設定される。JOB_ARRAY_SIZE環境変数の値は、構成された配列サイズには影響しません。 このオプションを使用して、一部のジョブ・インスタンスのみがサブミットまたは再サブミットされるジョブ再実行シナリオに対して、一定の配列サイズ値を適用します。 この値はオプション です。--command,--cmd,-c- このジョブ実行のコマンドを設定します。 コマンドは
--commandオプション 1 つにつき 1 つ指定します (例:--cmd cmdA --cmd cmdB)。 この値は、コンテナー・イメージ内に指定されているデフォルトのコマンドをオーバーライドします。 この値はオプション です。 --commands-clear,--cc- ジョブ実行のコマンドをクリアします。 この値はオプション です。 デフォルト値は
falseです。 --cpu- このジョブ実行の各配列インデックスのために設定する CPU の量。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 デフォルト値は
0です。 --env,-e- このジョブ実行の環境変数を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の環境変数を追加するか、または既存の環境変数をオーバーライドします。 環境変数は--envオプション 1 つにつき 1 つ指定します (例:-e envA -e envB)。 この値はオプション です。 --env-cm,--env-from-configmap- 以下のいずれかの方法を使用して、この構成マップに保管されているキーと値のペアから環境変数を設定します。
configmapNameという名前の構成マップ内のすべてのキーに対応する環境変数を追加するには、値configmapNameを使用します。 構成マップを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=CONFIGMAP_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>です。 例えば、構成マップconfigmapName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=configmapNameを使用します。 構成マップconfigmapNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、key1という名前の構成マップ内の 1 つのキーconfigmapNameに対応する環境変数を追加するには、値configmapName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、configmapNameという名前の構成マップ内の単一キーkey1にmyKeyという名前の環境変数を追加するには、値configmapName:myKey=key1を使用します。
この値はオプション です。
--env-from-configmap-rm,--env-cm-rm- 構成マップ名を使用して、構成マップ全体に対する環境変数の参照を削除します。 構成マップに対する個々のキー参照を削除するには、
--env-rmオプションを使用します。 この値はオプション です。 --env-sec,--env-from-secret- 以下のいずれかの方法で、シークレットに格納されているキーと値のペアから環境変数を設定する:
secretNameという名前のシークレット内のすべてのキーに対応する環境変数を追加するには、値secretNameを使用します。 シークレットを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=SECRET_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_SECRET>です。 例えば、シークレットsecretName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=secretNameを使用します。 シークレットsecretNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、secretNameという名前のシークレットに単一キーkey1の環境変数を追加するには、値secretName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、secretNameという名前のシークレット内の単一キーkey1に対してmyKeyという名前の環境変数を追加するには、値secretName:myKey=key1を使用します。
この値はオプション です。
--env-from-secret-rm,--env-sec-rm- シークレット名を使用して、シークレット全体に対する環境変数の参照を削除します。 シークレットに対する個々のキー参照を削除するには、
--env-rmオプションを使用します。 このオプションは、複数回指定できます。 この値はオプション です。 --env-rm- 構成マップまたはシークレットのキー/値のペアのキーに対する環境変数の参照を削除します。 個々のキー参照およびリテラル値を削除するには、キーの名前を指定します。 このオプションは、複数回指定できます。 この値はオプション です。
--ephemeral-storage,--es- このジョブ実行のための一時ストレージの量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 この値はオプション です。 --force,-f- 指定された構成マップおよびシークレットの参照の存在を検証しません。 構成マップ参照は、
--env-from-configmapオプションを使用して指定します。 シークレット参照は、--env-from-secretオプションを使用して指定します。 この値はオプション です。 デフォルト値はfalseです。 --maxexecutiontime,--met- このジョブ実行の最長実行時間 (秒単位)。 このオプションは
modeがtaskの場合のみ指定できる。 この値はオプション です。 デフォルト値は7200です。 --memory,-m- このジョブ実行に割り当てるメモリーの量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 --mode- ジョブ実行のモード。 有効な値は
taskおよびdaemonです。taskモードでは、maxexecutiontimeとretrylimitのオプションが適用される。daemonモードでは、タイムアウトがなく、失敗したインスタンスは無期限に再起 動されるため、maxexecutiontimeとretrylimitオプションは使用できない。 この値はオプション です。 --mount-configmap,--mount-cmMOUNT_DIRECTORY=CONFIGMAP_NAMEの形式でマウント・ディレクトリーと構成マップの名前を指定して、このジョブ実行のファイル・システムに構成マップの内容を追加します。 マウントされる構成マップはそれぞれ、固有のマウント・ディレクトリーを使用しなければなりません。 構成マップ内のキー/値のペアごとに、指定したマウント・ディレクトリーにファイルが追加されます。このとき、キー/値のペアのキーがそのファイル名になり、値がそのファイルの内容になります。 1 つの--mount-configmapオプションにつき 1 つのマウント構成を指定します (例:--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b)。 この値はオプション です。--mount-data-store,--mount-ds- 永続データ・ストアをマウントします。 フォーマットは、MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH] である。 SUBPATHはオプションである。 このオプションは、複数回指定できます。 この値はオプション です。
--mount-rm- 構成マップまたはシークレットがマウントされているディレクトリーを指定して、このジョブ実行のファイル・システムから構成マップまたはシークレットの内容を削除します。 1 つの
--mount-rmオプションにつき 1 つのマウント・ディレクトリーを指定します (例:--mount-rm /etc/configmap-a --mount-rm /etc/secret-b)。 この値はオプション です。 --mount-secret,--mount-sec- シークレットの内容をこのジョブ実行のファイル・システムに追加します。そのためには、マウント・ディレクトリーとシークレットの名前を
MOUNT_DIRECTORY=SECRET_NAMEという形式で指定します。 マウントされるシークレットはそれぞれ、固有のマウント・ディレクトリーを使用しなければなりません。 シークレット内のキー/値のペアごとに、指定したマウント・ディレクトリーにファイルが追加されます。このとき、キー/値のペアのキーがそのファイル名になり、値がそのファイルの内容になります。 1 つの--mount-secretオプションにつき 1 つのマウント構成を指定します (例:--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b)。 この値はオプション です。 -n,--name- このジョブ実行の名前。 参照されているジョブに関連するジョブ構成がない場合、この値は必須です。 プロジェクト内で固有の名前を使用します。
- 名前の先頭と末尾は小文字の英数字でなければなりません。
- 名前は 53 文字以下でなければならず、使用できるのは小文字、数字、ハイフン (-) です。
この値はオプション です。
--no-wait,--nw- ジョブ実行を再実行依頼し、このジョブ実行のインスタンスが完了するのを待機しません。
--no-waitオプションを指定した場合は、ジョブ実行の再実行依頼が開始して、待機は行われません。 ジョブ実行状況を確認するには、jobrun getコマンドを使用します。 この値はオプション です。 デフォルト値はtrueです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --retrylimit,-r- このジョブ実行に失敗のマークを付けるまでに、ジョブ実行のインスタンスを再実行する回数。 ゼロ以外の終了コードを返したジョブ実行の配列インデックスは、再実行されます。 このオプションは
modeがtaskの場合のみ指定できる。 この値はオプション です。 デフォルト値は3です。 --service-account,--sa- サービス・アカウントの名前。 サービス・アカウントは、インスタンスで実行されるプロセスの ID を提供します。 組み込みサービス・アカウントの場合、短縮名
manager、none、reader、およびwriterを使用できます。 接頭部Kubernetes Config Contextが付いたフルネームを使用することもできます。これは、project currentコマンドで判別できます。 この値はオプション です。 --service-account-clear,--sac- サービス・アカウントをクリアします。 この値はオプション です。 デフォルト値は
falseです。 --trusted-profiles-enabled,--trusted,--tpe- このジョブ実行のインスタンスに対する計算リソース・トークンのマウントを有効にします。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- ジョブ実行を再実行依頼し、このジョブ実行のインスタンスが完了するのを待機します。
--waitオプションを指定した場合、ジョブ実行の再実行依頼の際に、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、ジョブ実行の完了を待機します。 ジョブ実行が--wait-timeoutで指定された期間内に完了しない場合、ジョブ実行の再実行依頼は失敗します。 この値はオプション です。 デフォルト値はfalseです。 --wait-timeout,--wto- インスタンスがこのジョブ実行を完了するまで待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は600です。
例
以下の例では、インスタンス myjobrun について 4-5 ジョブ実行を再実行しています。 再実行されるジョブ実行の名前は myjobresubmit です。
ibmcloud ce jobrun resubmit --name myjobresubmit --jobrun myjobrun --array-indices 4-5
出力例
Getting job run 'myjobrun'...
Rerunning job run 'myjobresubmit'...
Run 'ibmcloud ce jobrun get -n myjobresubmit' to check the job run status.
OK
ibmcloud ce jobrun submit
ジョブに基づいてジョブ実行を実行します。
ibmcloud ce jobrun submit ((--name JOBRUN_NAME --image IMAGE) | (--job JOB_NAME [--name JOBRUN_NAME])) [--argument ARGUMENT] [--array-indices ARRAY_INDICES] [--array-size ARRAY_SIZE] [--array-size-var-override ARRAY_SIZE_VAR_OVERRIDE] [--command COMMAND] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-secret MOUNT_SECRET] [--no-wait] [--output OUTPUT] [--quiet] [--registry-secret REGISTRY_SECRET] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--argument,--arg,-a- このジョブ実行の引数を設定します。 引数は
--argumentオプション 1 つにつき 1 つ指定します (例:-a argA -a argB)。 この値はオプション です。 --array-indices,--ai- このジョブ実行に使用する配列インデックスを指定します。 ハイフン (-) またはコンマ (,) で区切ったインデックスのリストまたは範囲を指定します (例:
0,3,6,9や1-5,7-8,10など)。 最大値は999999です。 このオプションは、--array-sizeオプションが指定されていない場合にのみ指定できる。 この値はオプション です。 デフォルト値は0です。 --array-size,--as,--instances,--is- このジョブ実行に使用するインスタンス数を指定します。 このオプションを使用すると、システムが配列インデックスに変換します。 例えば、
instancesを5に指定すると、システムがarray-indicesを0 - 4に変換します。 このオプションを指定できるのは、--array-indicesオプションが指定されていない場合のみです。 この値はオプション です。 デフォルト値は1です。 --array-size-var-override,--array-size-variable-override,--asvoJOB_ARRAY_SIZE環境変数のカスタム値を指定する。 デフォルトでは、JOB_ARRAY_SIZE環境変数には、array-sizeの値か、array-indicesで指定されたインデックスの数が設定される。JOB_ARRAY_SIZE環境変数の値は、構成された配列サイズには影響しません。 このオプションを使用して、一部のジョブ・インスタンスのみがサブミットまたは再サブミットされるジョブ再実行シナリオに対して、一定の配列サイズ値を適用します。 この値はオプション です。--command,--cmd,-c- このジョブ実行のコマンドを設定します。 コマンドは
--commandオプション 1 つにつき 1 つ指定します (例:--cmd cmdA --cmd cmdB)。 この値は、コンテナー・イメージ内に指定されているデフォルトのコマンドをオーバーライドします。 この値はオプション です。 --cpu- このジョブ実行の各配列インデックスのために設定する CPU の量。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 デフォルト値は
1です。 --env,-e- このジョブ実行の環境変数を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の環境変数を追加するか、または既存の環境変数をオーバーライドします。 環境変数は--envオプション 1 つにつき 1 つ指定します (例:-e envA -e envB)。 この値はオプション です。 --env-cm,--env-from-configmap- 以下のいずれかの方法を使用して、この構成マップに保管されているキーと値のペアから環境変数を設定します。
configmapNameという名前の構成マップ内のすべてのキーに対応する環境変数を追加するには、値configmapNameを使用します。 構成マップを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=CONFIGMAP_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>です。 例えば、構成マップconfigmapName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=configmapNameを使用します。 構成マップconfigmapNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、key1という名前の構成マップ内の 1 つのキーconfigmapNameに対応する環境変数を追加するには、値configmapName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、configmapNameという名前の構成マップ内の単一キーkey1にmyKeyという名前の環境変数を追加するには、値configmapName:myKey=key1を使用します。
この値はオプション です。
--env-sec,--env-from-secret- 以下のいずれかの方法で、シークレットに格納されているキーと値のペアから環境変数を設定する:
secretNameという名前のシークレット内のすべてのキーに対応する環境変数を追加するには、値secretNameを使用します。 シークレットを参照するときに接頭部を指定することにより、環境変数名を変更できます。 接頭部を指定するには、値PREFIX=SECRET_NAMEを使用します。 結果の各環境変数の形式は、<PREFIX><NAME_OF_KEY_IN_SECRET>です。 例えば、シークレットsecretName内のキーのすべての変数名の接頭部をCUSTOM_に設定するには、値CUSTOM_=secretNameを使用します。 シークレットsecretNameに KEY_A が含まれている場合、環境変数名はCUSTOM_KEY_Aです。- 個々のキーの環境変数を追加するには、
NAME:KEY_A,KEY_Bという形式を使用します。 例えば、secretNameという名前のシークレットに単一キーkey1の環境変数を追加するには、値secretName:key1を使用します。 参照されるキーに別の名前を割り当てるには、NAME:NEW_NAME=KEY_Aという形式を使用します。 例えば、secretNameという名前のシークレット内の単一キーkey1に対してmyKeyという名前の環境変数を追加するには、値secretName:myKey=key1を使用します。
この値はオプション です。
--ephemeral-storage,--es- このジョブ実行のための一時ストレージの量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 この値はオプション です。 デフォルト値は400Mです。 --force,-f- 指定された構成マップおよびシークレットの参照の存在を検証しません。 構成マップ参照は、
--env-from-configmapオプションを使用して指定します。 シークレット参照は、--env-from-secretまたは--registry-secretオプションを使用して指定します。 この値はオプション です。 デフォルト値はfalseです。 --image,-i- このジョブ実行に使用するイメージの名前。 形式は
REGISTRY/NAMESPACE/REPOSITORY:TAGです。REGISTRYとTAGはオプションです。REGISTRYを指定しない場合、そのデフォルトはdocker.ioです。TAGを指定しない場合、そのデフォルトはlatestです。--jobオプションを指定しない場合は、--nameと--imageの値が必須となります。 この値はオプション です。 --job,-j- ジョブ構成の名前。 ジョブ構成を表示するには、
job listコマンドを使用します。--job値を指定する場合は、オプションで--name値を指定できます。--job値を指定しない場合は、--name値と--image値を指定しなければなりません。 この値はオプション です。 --maxexecutiontime,--met- このジョブ実行の最長実行時間 (秒単位)。 このオプションは
modeがtaskの場合のみ指定できる。 この値はオプション です。 デフォルト値は7200です。 --memory,-m- このジョブ実行に割り当てるメモリーの量。 メガバイトの場合は
M、ギガバイトの場合はGを使用します。 有効な値については、サポートされるメモリーと CPU の組み合わせを参照してください。 この値はオプション です。 デフォルト値は4Gです。 --mode- ジョブ実行のモード。 有効な値は
taskおよびdaemonです。taskモードでは、maxexecutiontimeとretrylimitのオプションが適用される。daemonモードでは、タイムアウトがなく、失敗したインスタンスは無期限に再起 動されるため、maxexecutiontimeとretrylimitオプションは使用できない。 この値はオプション です。 デフォルト値はtask。 --mount-configmap,--mount-cmMOUNT_DIRECTORY=CONFIGMAP_NAMEの形式でマウント・ディレクトリーと構成マップの名前を指定して、このジョブ実行のファイル・システムに構成マップの内容を追加します。 マウントされる構成マップはそれぞれ、固有のマウント・ディレクトリーを使用しなければなりません。 構成マップ内のキー/値のペアごとに、指定したマウント・ディレクトリーにファイルが追加されます。このとき、キー/値のペアのキーがそのファイル名になり、値がそのファイルの内容になります。 1 つの--mount-configmapオプションにつき 1 つのマウント構成を指定します (例:--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b)。 この値はオプション です。--mount-data-store,--mount-ds- 永続データ・ストアをマウントします。 フォーマットは、MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH] である。 SUBPATHはオプションである。 このオプションは、複数回指定できます。 この値はオプション です。
--mount-secret,--mount-sec- シークレットの内容をこのジョブ実行のファイル・システムに追加します。そのためには、マウント・ディレクトリーとシークレットの名前を
MOUNT_DIRECTORY=SECRET_NAMEという形式で指定します。 マウントされるシークレットはそれぞれ、固有のマウント・ディレクトリーを使用しなければなりません。 シークレット内のキー/値のペアごとに、指定したマウント・ディレクトリーにファイルが追加されます。このとき、キー/値のペアのキーがそのファイル名になり、値がそのファイルの内容になります。 1 つの--mount-secretオプションにつき 1 つのマウント構成を指定します (例:--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b)。 この値はオプション です。 -n,--name- このジョブ実行の名前。
--jobの値を指定しない場合、--nameと--imageの値が必須です。 プロジェクト内で固有の名前を使用します。
- 名前の先頭と末尾は小文字の英数字でなければなりません。
- 名前は 53 文字以下でなければならず、使用できるのは小文字、数字、ハイフン (-) です。
この値はオプション です。
--no-wait,--nw- ジョブ実行を実行依頼し、このジョブ実行のインスタンスが完了するのを待機しません。
--no-waitオプションを指定した場合は、ジョブ実行の実行依頼が開始して、待機は行われません。 ジョブ実行状況を確認するには、jobrun getコマンドを使用します。 この値はオプション です。 デフォルト値はtrueです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --registry-secret,--rs- レジストリー・シークレットの名前。 レジストリー・シークレットは、コンテナー・イメージのダウンロード時にプライベート・レジストリーでの認証に使用されます。 この値はオプション です。
--retrylimit,-r- このジョブ実行に失敗のマークを付けるまでに、ジョブ実行のインスタンスを再実行する回数。 ゼロ以外の終了コードを返したジョブ実行の配列インデックスは、再実行されます。 このオプションは
modeがtaskの場合のみ指定できる。 この値はオプション です。 デフォルト値は3です。 --service-account,--sa- サービス・アカウントの名前。 サービス・アカウントは、インスタンスで実行されるプロセスの ID を提供します。 組み込みサービス・アカウントの場合、短縮名
manager、none、reader、およびwriterを使用できます。 接頭部Kubernetes Config Contextが付いたフルネームを使用することもできます。これは、project currentコマンドで判別できます。 この値はオプション です。 --trusted-profiles-enabled,--trusted,--tpe- このジョブ実行のインスタンスに対する計算リソース・トークンのマウントを有効にします。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- ジョブ実行を実行依頼し、このジョブ実行のインスタンスが完了するのを待機します。
--waitオプションを指定した場合、ジョブ実行の実行依頼の際に、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、ジョブ実行の完了を待機します。 ジョブ実行が--wait-timeoutで指定された期間内に完了しない場合、ジョブ実行の実行依頼は失敗します。 この値はオプション です。 デフォルト値はfalseです。 --wait-timeout,--wto- インスタンスがこのジョブ実行を完了するまで待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は600です。
例
ibmcloud ce jobrun submit --name myjobrun --image icr.io/codeengine/firstjob --array-indices 1-5
出力例
Submitting job run 'myjobrun'...
Run 'ibmcloud ce jobrun get -n myjobrun' to check the job run status.
OK
Persistentdatastore コマンド
永続データストアを管理する。
ibmcloud ce persistentdatastore create
永続的なデータストアを作成する。
ibmcloud ce persistentdatastore create --name NAME --cos-access-secret SECRET_NAME --cos-bucket-name BUCKET_NAME [--cos-bucket-location BUCKET_LOCATION] [--quiet]
コマンド・オプション
--cos-access-secret,--cos-sec- 必須。 COS インスタンスにアクセスするための認証情報を含む秘密の名前。 この値は必須です。
--cos-bucket-name,--cos-bucket- 必須。 COSバケツの名前。 この値は必須です。
--name,-n- 必須。 永続データストアの名前。 プロジェクト内で固有の名前を使用します。 この値は必須です。
--cos-bucket-location,--cos-loc- COSバケットの場所。 この値はオプション です。
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce persistentdatastore create --name my-pds-2 --cos-bucket-name my-test-bucket-2 --cos-access-secret my-hmac-secret-2
出力例
Successfully created persistent data store named 'my-pds-2'.
OK
ibmcloud ce persistentdatastore delete
永続データストアを削除する。
ibmcloud ce persistentdatastore delete --name PERSISTENT_DATA_STORE_NAME [--force] [--ignore-not-found] [--quiet]
コマンド・オプション
--name,-n- 必須。 永続データストアの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce persistentdatastore delete --name my-pds-3 -f
出力例
Deleting persistent data store 'my-pds-3'...
OK
ibmcloud ce persistentdatastore get
永続データストアの詳細を表示する。
ibmcloud ce persistentdatastore get --name NAME [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- 必須。 永続データストアの名前。 この値は必須です。
--output,-o- 出力フォーマット。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce persistentdatastore get --name my-pds-2
出力例
Getting persistent data store 'my-pds-2'...
OK
Name: my-pds-2
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Type: object_storage
Created: Fri, 11 Jul 2025 13:52:30 +0200
Age: 103s
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Data:
COS bucket: my-test-bucket-2
Access secret: my-hmac-secret-2
Bucket region: eu-de
ibmcloud ce persistentdatastore list
プロジェクト内のすべての永続データ・ストアをリストします。
ibmcloud ce persistentdatastore list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--output,-o- 出力フォーマット。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
このコマンドは、プロジェクト内のすべての永続データストアを一覧表示します。
ibmcloud ce persistentdatastore list
出力例
Listing persistent data stores...
OK
Name COS bucket Access secret Bucket region Age
my-pds-1 my-test-bucket-1 my-hmac-secret-1 eu-gb 36d
my-pds-2 my-test-bucket-2 my-hmac-secret-2 eu-de 86s
my-pds-3 my-test-bucket-3 my-hmac-secret-3 us-south 6m30s
プロジェクトのコマンド
project コマンドを使用すると、プロジェクトを作成、リスト、削除したり、現行コンテキストとして選択したりできます。
プロジェクトとは、アプリケーション、ジョブ、ビルドなどの Code Engine エンティティーをグループにまとめるものです。 プロジェクトの基盤は Kubernetes 名前空間です。 プロジェクトの名前は、IBM Cloud® リソース・グループ、ユーザー・アカウント、およびリージョン内で固有でなければなりません。 プロジェクトを使用することで、リソースを管理してエンティティーへのアクセスを提供できます。
プロジェクトは、以下の項目を提供します。
- エンティティー名のために固有の名前空間を提供します。
- プロジェクトのリソースへのアクセス (インバウンド・アクセス) を管理します。
- バッキング・サービス、レジストリー、およびリポジトリーへのアクセス (アウトバウンド・アクセス) を管理します。
- Transport Layer Service (TLS) 用の証明書が自動的に生成されます。
プロジェクトの処理について詳しくは、プロジェクトの管理を参照してください。
projectコマンドでは、projectまたはprojのいずれかを使用できます。 project コマンドの CLI ヘルプを表示するには、ibmcloud ce proj -h を実行してください。
ibmcloud ce project create
プロジェクトを作成します。
ibmcloud ce project create --name PROJECT_NAME [--endpoint ENDPOINT] [--no-select] [--no-wait] [--output OUTPUT] [--quiet] [--tag TAG] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
-n,--name- プロジェクトの名前。 リージョンで固有の名前を使用します。 この名前は 128 文字以下でなければならず、次の文字を使用できます。
- すべての Unicode 文字または英数字。
- 次の特殊文字: スペース ( )、ピリオド (.)、コロン (:)、アンダースコアー (_)、ハイフン (-)。
この値は必須です。
--endpoint,-e- プロジェクトのエンドポイント。 有効な値は
publicおよびprivateです。--endpointオプションが明示的に指定されていない場合、動作はシステムによって決定されます。 IBM Cloud CLI がprivate.cloud.ibm.comに接続されている場合、Code Engineプロジェクトは--endpointがprivateであるかのように動作します。 IBM Cloud CLI がcloud.ibm.comに接続されている場合、Code Engineプロジェクトは--endpointがpublicであるかのように動作します。 この値はオプション です。 --no-select,--ns- プロジェクトが作成された後、そのプロジェクトを現行コンテキストとして選択しないでください。 このオプションを選択しない場合は、自動的にプロジェクトが選択されます。 この値はオプション です。 デフォルト値は
falseです。 --no-wait,--nw- プロジェクトを作成し、このプロジェクトが作成されるのを待機しません。
no-waitオプションを指定した場合は、プロジェクトの作成が開始され、待機は行われません。 プロジェクトの状況を確認するには、project getコマンドを使用します。 この値はオプション です。 デフォルト値はfalseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --tag,-t- プロジェクトに割り当てるラベル。 ラベルは 128 文字以下でなければならず、文字、数字、スペース ()、ピリオド (.)、コロン (:)、下線 (_)、およびハイフン (-) を使用できます。
--tagオプションごとに 1 つのラベルを指定します (例:--tag tagA --tag tagB)。 この値はオプション です。 --wait,-w- プロジェクトを作成し、このプロジェクトが作成されるのを待機します。
--waitオプションを指定した場合、プロジェクトの作成の際に、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、プロジェクトが作成されるのを待機します。 指定した--wait-timeoutの期間内にプロジェクトが作成されない場合、プロジェクトの作成は失敗します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- プロジェクトが作成されるまで待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は600です。
例
ibmcloud ce project create --name myproject
出力例
Creating project 'myproject'...
OK
ibmcloud ce project current
現在ターゲットにしているプロジェクトの詳細を表示します。
ibmcloud ce project current [--output OUTPUT] [--quiet]
コマンド・オプション
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce project current
出力例
Getting the current project context...
OK
Name: myproject
ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Subdomain: aabon2dfwa0
Domain: us-south.codeengine.appdomain.cloud
Region: us-south
Kubectl Context: 4svg40kna19
Kubernetes Config:
Context: aabon2dfwa0
Environment Variable: export KUBECONFIG=/user/myusername/.bluemix/plugins/code-engine/myproject-01234567-abcd-abcd-abcd-abcdabcd1111.yaml
ibmcloud ce project delete
プロジェクトを削除します。
ibmcloud ce project delete (--name PROJECT_NAME | --id PROJECT_ID) [--force] [--hard] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --hard- プロジェクトをただちに削除します。
--hardオプションを指定しない場合、7 日以内であればproject restoreコマンドまたはreclamation restoreコマンドを使用してプロジェクトを復元できます。 この値はオプション です。 デフォルト値はfalseです。 --id,--guid- プロジェクトの ID。
--nameを指定しない場合は、この値が必須です。 --name,-n- プロジェクトの名前。
--idを指定しない場合は、この値が必須です。 --no-wait,--nw- プロジェクトを削除し、このプロジェクトが削除されるのを待機しません。
no-waitオプションを指定した場合は、プロジェクトの削除が開始され、待機は行われません。 プロジェクトの状況を確認するには、project getコマンドを使用します。 この値はオプション です。 デフォルト値はfalseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- プロジェクトを削除し、このプロジェクトが削除されるのを待機します。
--waitオプションを指定した場合、プロジェクトの削除の際に、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、プロジェクトが削除されるのを待機します。 指定した--wait-timeoutの期間内にプロジェクトが削除されない場合、プロジェクトの削除は失敗します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- プロジェクトが削除されるまで待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は600です。
例
ibmcloud ce project delete --name myproject -f
出力例
Deleting project 'myproject'...
OK
ibmcloud ce project get
単一プロジェクトの詳細を表示します。
ibmcloud ce project get (--name PROJECT_NAME | --id PROJECT_ID) [--output OUTPUT] [--quiet]
コマンド・オプション
--id,--guid- プロジェクトの ID。
--nameを指定しない場合は、この値が必須です。 --name,-n- プロジェクトの名前。
--idを指定しない場合は、この値が必須です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce project get --name myproject
出力例
Getting project 'myproject'...
OK
Name: myproject
ID: abcdabcd-abcd-abcd-abcd-f1de4aab5d5d
Status: active
Selected: true
Tags: tag1, tag2
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
ibmcloud ce project list
すべてのプロジェクトをリスト表示します。
ibmcloud ce project list [--all-resource-groups] [--output OUTPUT] [--quiet] [--regions REGIONS] [--sort-by SORT_BY]
コマンド・オプション
--all-resource-groups,--all- すべてのリソース・グループのプロジェクトを表示します。 デフォルトでは、プロジェクトは現在のリソース・グループからのみ表示されます。 この値はオプション です。 デフォルト値は
falseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --regions,-r- 表示するプロジェクトを指定のリージョンに制限します。 1 つ以上のリージョン名を指定してください (例:
us-south,eu-de)。 この値はオプション です。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce project list
出力例
Getting projects...
OK
Name ID Status Selected Tags Region Resource Group Age
myproj-eude 09768af4-abcd-abcd-abcd-24674ba90db0 active false eu-de default 27d
myproject cd09cfe1-abcd-abcd-abcd-0f8a8a1d0ddf active true us-south default 52d
ibmcloud ce project restore
プロジェクトを復元します。
ibmcloud ce project restore (--name PROJECT_NAME | --id PROJECT_ID) [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--id,--guid- プロジェクトの ID。
--nameを指定しない場合は、この値が必須です。 --name,-n- プロジェクトの名前。
--idを指定しない場合は、この値が必須です。 --no-wait,--nw- プロジェクトを復元し、このプロジェクトが復元されるのを待機しません。
no-waitオプションを指定した場合は、プロジェクトの復元が開始され、待機は行われません。 プロジェクトの状況を確認するには、project getコマンドを使用します。 この値はオプション です。 デフォルト値はfalseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- プロジェクトを復元し、このプロジェクトが復元されるのを待機します。
--waitオプションを指定した場合、プロジェクトの復元の際に、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、プロジェクトが復元されるのを待機します。 指定した--wait-timeoutの期間内にプロジェクトが復元されない場合、プロジェクトの復元は失敗します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- プロジェクトが復元されるまで待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は600です。
例
この例では、myprojectされた状況の soft deleted プロジェクトをアクティブ状態に復元します。 project list コマンドを使用すると、すべてのプロジェクトと状況のリストを表示できます。
ibmcloud ce project restore --name myproject
出力例
Restoring project 'myproject'...
OK
ibmcloud ce project select
プロジェクトを現行コンテキストとして選択します。 active状況でないプロジェクトは選択できません。
ibmcloud ce project select (--name PROJECT_NAME | --id PROJECT_ID) [--endpoint ENDPOINT] [--kubecfg] [--quiet]
コマンド・オプション
--endpoint,-e- プロジェクトのエンドポイント。 有効な値は
publicおよびprivateです。--endpointオプションが明示的に指定されていない場合、動作はシステムによって決定されます。 IBM Cloud CLI がprivate.cloud.ibm.comに接続されている場合、Code Engineプロジェクトは--endpointがprivateであるかのように動作します。 IBM Cloud CLI がcloud.ibm.comに接続されている場合、Code Engineプロジェクトは--endpointがpublicであるかのように動作します。 この値はオプション です。 --id,--guid- プロジェクトの ID。
--nameを指定しない場合は、この値が必須です。 --kubecfg,-k- プロジェクトを Kubernetes 構成ファイルに追加します。
KUBECONFIG環境変数を設定することで、デフォルトの Kubernetes 構成ファイルをオーバーライドできます。 この値はオプション です。 デフォルト値はfalseです。 --name,-n- プロジェクトの名前。
--idを指定しない場合は、この値が必須です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce project select --name myproject
出力例
Selecting project 'myproject'...
OK
ibmcloud ce project tag
単一プロジェクトのタグを管理します。
ibmcloud ce project tag (--name PROJECT_NAME | --id PROJECT_ID) [--quiet] [--tag TAG] [--tag-rm TAG_RM]
コマンド・オプション
--id,--guid- プロジェクトの ID。
--nameを指定しない場合は、この値が必須です。 --name,-n- プロジェクトの名前。
--idを指定しない場合は、この値が必須です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --tag,-t- プロジェクトに割り当てるラベル。 ラベルは 128 文字以下でなければならず、文字、数字、スペース ()、ピリオド (.)、コロン (:)、下線 (_)、およびハイフン (-) を使用できます。
--tagオプションごとに 1 つのラベルを指定します (例:--tag tagA --tag tagB)。 この値はオプション です。 --tag-rm,--trm- プロジェクトに割り当てられたラベルを削除します。 ラベルは
--tag-rmオプション 1 つにつき 1 つ指定します (例:--tag-rm tagA --tag-rm tagB)。 この値はオプション です。
例
ibmcloud ce project tag --name myproject --tag tag1 --tag tag2
出力例
Getting project 'myproject'...
OK
ibmcloud ce project update
選択したプロジェクトを更新します。
ibmcloud ce project update (--binding-service-id SERVICE_ID_ID | --binding-resource-group RESOURCE_GROUP_NAME | --binding-resource-group-id RESOURCE_GROUP_ID) [--quiet]
コマンド・オプション
--binding-resource-group,--brg- このプロジェクトのサービス・バインディングの認証で使用するリソース・グループの名前。 サービス ID は、このリソース・グループ内のすべてのサービスに対する
Operator役割およびManager役割を使用して作成されます。 このアカウント内のすべてのリソース・グループを指定するには、"*"を使用します。 この値はオプション です。 --binding-resource-group-id,--brgid- このプロジェクトのサービス・バインディングの認証に使用するリソース・グループの ID。 サービス ID は、このリソース・グループ内のすべてのサービスに対する
Operator役割およびManager役割を使用して作成されます。 この値はオプション です。 --binding-service-id,--bsid- このプロジェクトのサービス・バインディングの認証で使用するサービス ID の ID。 このサービス ID には、
Operator役割と 1 つ以上のサービス・インスタンス、サービス・タイプ、またはリソース・グループに対する適切なサービス役割が付与されている必要があります。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce project update --binding-service-id ServiceId-1234abcd-abcd-abcd-1111-1a2b3c4d5e6f
出力例
Configuring your project for service bindings...
Creating service binding API key 'my-project-api-key' for service ID 'my-custom-service-id'...
OK
回収のコマンド
Code Engine プロジェクトの再利用を管理します。 論理削除されたプロジェクトは、7 日以内であれば reclamation restore コマンドを使用して復元できます。
ibmcloud ce reclamation delete
プロジェクト回収を削除します。
ibmcloud ce reclamation delete (--name PROJECT_NAME | --id PROJECT_ID) [--force] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --id,--guid- プロジェクトの ID。
--nameを指定しない場合は、この値が必須です。 --name,-n- プロジェクトの名前。
--idを指定しない場合は、この値が必須です。 --no-wait,--nw- プロジェクト回収を削除し、このプロジェクト回収が削除されるのを待機しません。
no-waitオプションを指定した場合は、プロジェクト回収の削除が開始され、待機は行われません。 プロジェクト回収の状況を確認するには、reclamation getコマンドを使用します。 この値はオプション です。 デフォルト値はfalseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- プロジェクト回収を削除し、このプロジェクト回収が削除されるのを待機します。
--waitオプションを指定した場合、プロジェクト回収の削除の際に、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、プロジェクト回収が削除されるのを待機します。 指定した--wait-timeoutの期間内にプロジェクト回収が削除されない場合、プロジェクト回収の削除は失敗します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- プロジェクト回収が削除されるまで待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は600です。
例
この例では、myproject 状況の soft deleted プロジェクトを永久に削除します。 このコマンドで --force オプションを使用すると、確認なしで削除が強制されます。 reclamation list コマンドを使用して、soft deleted 状態のすべてのプロジェクトのリストを表示できます。
ibmcloud ce reclamation delete --name myproject --f
出力例
Hard deleting project 'myproject'...
OK
ibmcloud ce reclamation get
単一プロジェクト回収の詳細を表示します。
ibmcloud ce reclamation get (--name PROJECT_NAME | --id PROJECT_ID) [--output OUTPUT] [--quiet]
コマンド・オプション
--id,--guid- プロジェクトの ID。
--nameを指定しない場合は、この値が必須です。 --name,-n- プロジェクトの名前。
--idを指定しない場合は、この値が必須です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce reclamation get --name myproject
出力例
Getting project reclamation
OK
Name: myproject
Reclamation ID: abcdabcd-abcd-abcd-abcd-f1de4aab5d5d
Status: soft deleted
Region: us-south
Resource Group: default
Age: 27m
Created: Thu, 09 Sep 2021 13:24:15 -0400
Updated: Thu, 09 Sep 2021 13:33:45 -0400
Time to Hard Deletion: 6d23h
ibmcloud ce reclamation list
すべてのプロジェクト回収をリスト表示します。
ibmcloud ce reclamation list [--all-resource-groups] [--output OUTPUT] [--quiet] [--regions REGIONS] [--sort-by SORT_BY]
コマンド・オプション
--all-resource-groups,--all- すべてのリソース・グループのプロジェクト回収を表示します。 デフォルトでは、プロジェクト回収は現在のリソース・グループからのみ表示されます。 この値はオプション です。 デフォルト値は
falseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --regions,-r- 表示するプロジェクト回収を指定のリージョンに制限します。 1 つ以上のリージョン名を指定してください (例:
us-south,eu-de)。 この値はオプション です。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce reclamation list
出力例
Getting project reclamations...
OK
Name ID Reclamation ID Status Region Resource Group Age Time to Hard Deletion
myproject def218c5-abcd-abcd-abcd-97854c288d76 48e3d7a2-abcd-abcd-abcd-99db7152b8fe soft deleted us-south default 40h 6d23h
myproject2 01f0bc66-abcd-abcd-abcd-3ef7e99f6f69 af2cd017-abcd-abcd-abcd-d32e2bb79136 soft deleted jp-osa default 8m58s 2d11h
ibmcloud ce reclamation restore
プロジェクト回収を復元します。 論理削除されたプロジェクトは、7 日以内であれば reclamation restore コマンドを使用して復元できます。
ibmcloud ce reclamation restore (--name PROJECT_NAME | --id PROJECT_ID) [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--id,--guid- プロジェクトの ID。
--nameを指定しない場合は、この値が必須です。 --name,-n- プロジェクトの名前。
--idを指定しない場合は、この値が必須です。 --no-wait,--nw- プロジェクト回収を復元し、このプロジェクト回収が復元されるのを待機しません。
no-waitオプションを指定した場合は、プロジェクト回収の復元が開始され、待機は行われません。 プロジェクト回収の状況を確認するには、reclamation getコマンドを使用します。 この値はオプション です。 デフォルト値はfalseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- プロジェクト回収を復元し、このプロジェクト回収が復元されるのを待機します。
--waitオプションを指定した場合、プロジェクト回収の復元の際に、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、プロジェクト回収が復元されるのを待機します。 指定した--wait-timeoutの期間内にプロジェクト回収が復元されない場合、プロジェクト回収の復元は失敗します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- プロジェクト回収が復元されるまで待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は600です。
例
この例では、myprojectされた状況の soft deleted プロジェクトをアクティブ状態に復元します。 reclamation list コマンドを使用して、soft deleted 状態のすべてのプロジェクトのリストを表示できます。
ibmcloud ce reclamation restore --name myproject
出力例
Restoring project 'myproject'...
OK
レジストリーのコマンド
コンテナー・レジストリー (レジストリー) は、コンテナー・イメージを保管するサービスです。 例えば、IBM Cloud Container Registryと Docker Hub はコンテナー・レジストリーです。 コンテナー・レジストリーは、パブリックにすることもプライベートにすることもできます。 パブリックであるコンテナー・レジストリーには、アクセスするための資格情報は必要ありません。 これに対して、プライベート・レジストリーへのアクセスには資格情報が必要です。
コマンドは、プロジェクトregistryのコンテキスト内で使用する必要があります。
レジストリーにアクセスする方法について詳しくは、プライベート・コンテナー・レジストリーへのアクセス権限の追加を参照してください。
registry コマンドのCLIヘルプを見るには、 ibmcloud ce registry -h を実行する。
CLI バージョン 1.42.0 以降、CLI でのシークレットの定義と操作は secret コマンドグループに統一されました。 ibmcloud ce secret コマンドを参照してください。 basic_auth,
generic, hmac, ssh, tls, registry のように秘密のカテゴリーを指定するには --format オプションを使用する。 を使い続けることができる。 registry コマンドグループを使い続けることもできるが、統一された secret コマンドグループ コンテナ・レジストリにアクセスするためのシークレットを作成するには ibmcloud ce secret create --format registry コマンドを使う。 Code Engine におけるシークレットの扱いについて詳しくは、 シークレットの扱いを 参照してください。
ibmcloud ce registry create
イメージのレジストリー・アクセス権限のシークレットを作成します。
ibmcloud ce registry create --name NAME (--password PASSWORD | --password-from-file PASSWORD_FILE | --password-from-json-file) [--email EMAIL] [--output OUTPUT] [--quiet] [--server SERVER] [--username USERNAME]
コマンド・オプション
-n,--name- イメージのレジストリー・アクセス権限のシークレットの名前。 プロジェクト内で固有の名前を使用します。
- 名前の先頭と末尾は小文字の英数字でなければなりません。
- 名前は 253 文字以下でなければならず、使用できるのは小文字、数字、ピリオド (.)、ハイフン (-) です。
この値は必須です。
--email,-e- レジストリー・サーバーにアクセスするための E メール・アドレス。 この値はオプション です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --password,-p- レジストリー・サーバーにアクセスするためのパスワード。
--passwordオプション、--password-from-fileオプション、--password-from-json-fileオプションがいずれも指定されていない場合は、パスワードの入力を求めるプロンプトが出されます。 この値はオプション です。 --password-from-file,--pf- レジストリー・サーバーにアクセスするためのパスワードが入っているファイルのパス。 ファイルの最初の行がパスワードに使用されます。
--passwordオプション、--password-from-fileオプション、--password-from-json-fileオプションがいずれも指定されていない場合は、パスワードの入力を求めるプロンプトが出されます。 この値はオプション です。 --password-from-json-file,--pfj- レジストリー・サーバーにアクセスするためのパスワードが入っている JSON ファイルのパス。
apikeyフィールドはパスワード用に使用されます。--passwordオプション、--password-from-fileオプション、--password-from-json-fileオプションがいずれも指定されていない場合は、パスワードの入力を求めるプロンプトが出されます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --server,-s- レジストリー・サーバーの URL。 この値はオプション です。 デフォルト値は
us.icr.ioです。 --username,-u- レジストリー・サーバーにアクセスするためのユーザー名。 この値はオプション です。 デフォルト値は
iamapikeyです。
例
以下の例では、myregistry にある Container Registry インスタンスへのイメージ・レジストリー・アクセス権限 us.icr.io を作成し、ユーザー名 iamapikey および IAM の API キー (パスワード) を使用しています。
ibmcloud ce registry create --name myregistry --server us.icr.io --username iamapikey --password API_KEY
出力例
Creating image registry access secret myregistry...
OK
ibmcloud ce registry delete
イメージのレジストリー・アクセス権限のシークレットを削除します。
ibmcloud ce registry delete --name NAME [--force] [--ignore-not-found] [--quiet]
コマンド・オプション
--name,-n- イメージのレジストリー・アクセス権限のシークレットの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce registry delete --name myregistry -f
出力例
Deleting image registry access secret myregistry...
OK
ibmcloud ce registry get
イメージのレジストリー・アクセス権限のシークレットの詳細を表示します。
ibmcloud ce registry get --name NAME [--decode] [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- イメージのレジストリー・アクセス権限のシークレットの名前。 この値は必須です。
--decode,-dData出力をデコードして詳細に示します。 このオプションを指定しない場合、Data詳細は base64 でエンコードされます。 この値はオプション です。 デフォルト値はfalseです。--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce registry get --name myregistry
出力例
Getting image registry access secret myregistry...
OK
Name: myregistry
Project: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Created: 2021-02-23T09:10:01-05:00
Data:
---
.dockerconfigjson: abcdabcdabcdabcdabcdnVzZXJuYW1lIjoiaWFtYXBpa2V5IiwicGFzc3dvcmQiOiJoQllTSTc5Uk8yQUIxSDV3RUs2UzhScV9uNzE4NkQ1eWt1M1FOUk85aFpfaCIsImVtYWlsIjoiYUBiLmMiLCabcdabcdabcdabcdabcdT21oQ1dWTkpOemxTVHpKQlFqRklOWGRGU3paVE9GSnhYMjQzTVRnMlJEVjabcdabcdabcdabcdabcdbG9XbDlvIn19fQ==
ibmcloud ce registry list
プロジェクト内のすべてのイメージのレジストリー・アクセス権限のシークレットをリスト表示します。
ibmcloud ce registry list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce registry list
出力例
Listing image registry access secrets...
OK
Name Age
myregistry 19m22s
ibmcloud ce registry update
イメージ・レジストリーのアクセス・シークレットを更新します。
ibmcloud ce registry update --name NAME [--email EMAIL] [--output OUTPUT] [--password PASSWORD] [--password-from-file PASSWORD_FROM_FILE] [--password-from-json-file PASSWORD_FROM_JSON_FILE] [--quiet] [--server SERVER] [--username USERNAME]
コマンド・オプション
--name,-n- イメージのレジストリー・アクセス権限のシークレットの名前。 この値は必須です。
--email,-e- レジストリー・サーバーにアクセスするための E メール・アドレス。 この値はオプション です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --password,-p- レジストリー・サーバーにアクセスするためのパスワード。 この値はオプション です。
--password-from-file,--pf- レジストリー・サーバーにアクセスするためのパスワードが入っているファイルのパス。 ファイルの最初の行がパスワードに使用されます。 この値はオプション です。
--password-from-json-file,--pfj- レジストリー・サーバーにアクセスするためのパスワードが入っている JSON ファイルのパス。
apikeyフィールドはパスワード用に使用されます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --server,-s- レジストリー・サーバーの URL。 この値はオプション です。
--username,-u- レジストリー・サーバーにアクセスするためのユーザー名。 この値はオプション です。
例
以下の例では、myregistry というイメージ・レジストリーにアクセスするためのパスワードを更新します。
ibmcloud ce registry update --name myregistry --password NEW_API_KEY
出力例
Getting image registry access secret 'myregistry'...
Updating image registry access secret 'myregistry'...
OK
リポジトリーのコマンド
ソース・コードは、GitHub や GitLab などのコード・リポジトリーに保管します。 Code Engine では、プライベート・コード・リポジトリーへのアクセスを追加し、そのリポジトリーをビルドから参照することができます。
コマンドは、プロジェクトrepoのコンテキスト内で使用する必要があります。
リポジトリーへのアクセスについて詳しくは、プライベート・コード・リポジトリーへのアクセスを参照してください。
repo コマンドのCLIヘルプを見るには、 ibmcloud ce repo -h を実行する。
CLI バージョン 1.42.0 以降、CLI でのシークレットの定義と操作は secret コマンドグループに統一されました。 ibmcloud ce secret コマンドを参照してください。 basic_auth,
generic, hmac, ssh, tls, registry のように秘密のカテゴリーを指定するには --format オプションを使用する。 を使い続けることができる。 repo コマンドグループを使い続けることもできるが、統一された secret コマンドグループ SSHキーでサービスにアクセスするためのシークレットを作成するには、例えば GitHub や GitLab, のような Git リポジトリに認証するために ibmcloud ce secret create --format ssh コマンドを使う。 SSH
シークレットは、 Git リポジトリー・アクセス・シークレットとしても使用されます。 Code Engine におけるシークレットの扱いについて詳しくは、 シークレットの扱いを 参照してください。
ibmcloud ce repo create
Git リポジトリー・アクセス・シークレットを作成します。
ibmcloud ce repo create --name SECRET_NAME --key-path SSH_KEY_PATH --host HOST_ADDRESS [--known-hosts-path KNOWN_HOSTS_PATH] [--output OUTPUT] [--quiet]
コマンド・オプション
--host,--ho- ホストのアドレス (例:
github.com)。 この値は必須です。 --key-path,--kp- 暗号化されていない SSH 秘密鍵ファイルのパス。 個人用の SSH 秘密鍵を使用する場合、このファイルは通常
$HOME/.ssh/id_rsa(Mac OS または Linux) または%HOMEPATH%\.ssh\id_rsa(Windows) にあります。 この値は必須です。 -n,--name- Git リポジトリー・アクセス・シークレットの名前。 プロジェクト内で固有の名前を使用します。
- 名前の先頭と末尾は小文字の英数字でなければなりません。
- 名前は 253 文字以下でなければならず、使用できるのは小文字、数字、ピリオド (.)、ハイフン (-) です。
この値は必須です。
--known-hosts-path,--khp- 既知のホストのファイルのパス。 この値は、過去にアクセスしたホスト、具体的には GitHub ホストまたは GitLab ホストでの認証にのみ秘密鍵を使用するようにするためのセキュリティー機能です。 このファイルは通常、
$HOME/.ssh/known_hosts(Mac OS または Linux) または%HOMEPATH%\.ssh\known_hosts(Windows) にあります。 この値はオプション です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
以下のコマンドは、ホストgithub.com用にgithubという Git アクセス・シークレットを作成し、/<filepath>/.ssh/id_rsaにある SSH 鍵を使用して認証します。ここで、<filepath>はシステム上のパスです。
ibmcloud ce repo create -n github --key-path /<filepath>/.ssh/id_rsa --host github.com
出力例
Creating Git access secret github...
OK
ibmcloud ce repo delete
Git リポジトリー・アクセス・シークレットを削除します。
ibmcloud ce repo delete --name NAME [--force] [--ignore-not-found] [--quiet]
コマンド・オプション
--name,-n- Git リポジトリー・アクセス・シークレットの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce repo delete --name github
出力例
Are you sure you want to delete the Git access secret github? [y/N]> y
Deleting Git access secret github...
OK
ibmcloud ce repo get
Git リポジトリー・アクセス・シークレットの詳細を表示します。
ibmcloud ce repo get --name NAME [--decode] [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- Git リポジトリー・アクセス・シークレットの名前。 この値は必須です。
--decode,-dData出力をデコードして詳細に示します。 このオプションを指定しない場合、Data詳細は base64 でエンコードされます。 この値はオプション です。 デフォルト値はfalseです。--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce repo get -n github
出力例
Getting Git access secret github...
OK
Name: github
Project: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 30s
Created: 2021-03-14T14:05:56-05:00
Host: github.com
Data:
---
ssh-privatekey:
ABCDABCDABCDABCDABCDU1NIIFBSSVZBVEUgS0VZLS0tLS0KYjABCDABCDABCDABCDhrdGRqRUFBQUFBQ21GbGN6STFOaABCDABCDABCDABCDABCDABCDE
...
ibmcloud ce repo list
プロジェクト内のすべての Git リポジトリー・アクセス・シークレットをリスト表示します。
ibmcloud ce repo list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce repo list
出力例
Listing Git access secrets...
OK
Name Age
github 13m0s
ibmcloud ce repo update
Git リポジトリーのアクセス・シークレットを更新します。
ibmcloud ce repo update --name SECRET_NAME [--host HOST] [--key-path KEY_PATH] [--known-hosts-path KNOWN_HOSTS_PATH] [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- Git リポジトリー・アクセス・シークレットの名前。 この値は必須です。
--host,--ho- ホストのアドレス (例:
github.com)。 この値はオプション です。 --key-path,--kp- 暗号化されていない SSH 秘密鍵ファイルのパス。 個人用の SSH 秘密鍵を使用する場合、このファイルは通常
$HOME/.ssh/id_rsa(Mac OS または Linux) または%HOMEPATH%\.ssh\id_rsa(Windows) にあります。 この値はオプション です。 --known-hosts-path,--khp- 既知のホストのファイルのパス。 この値は、過去にアクセスしたホスト、具体的には GitHub ホストまたは GitLab ホストでの認証にのみ秘密鍵を使用するようにするためのセキュリティー機能です。 このファイルは通常、
$HOME/.ssh/known_hosts(Mac OS または Linux) または%HOMEPATH%\.ssh\known_hosts(Windows) にあります。 この値はオプション です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
以下のコマンドは、新規ホストを使用するように、github という Git アクセス・シークレットを更新します。
ibmcloud ce repo update -n github --host NEW_HOST
出力例
Getting Git access secret 'github'...
Updating Git access secret 'github'...
OK
リビジョン・コマンド
アプリケーション (アプリ) は、HTTP 要求を処理するコードを実行します。 IBM Cloud® Code Engine は、従来型の HTTP 要求に加えて、通信プロトコルとして WebSocket を使用するアプリケーションもサポートします。 アプリには 1 つ以上のリビジョン が含まれます。 リビジョンとは、アプリの構成プロパティーの変更不可能なバージョンの 1 つを表します。 アプリの構成プロパティーが更新されるたびに、アプリの新規リビジョンが作成されます。
revision コマンドを使用して、アプリケーション・リビジョンを管理します。
コマンドは、プロジェクトrevisionのコンテキスト内で使用する必要があります。
アプリのリビジョンの処理について詳しくは、アプリケーションのデプロイを参照してください。
revisionコマンドでは、revisionまたはrevのいずれかを使用できます。 revision コマンドの CLI ヘルプを表示するには、ibmcloud ce revision -h を実行してください。
ibmcloud ce revision delete
アプリケーション・リビジョンを削除します。
ibmcloud ce revision delete --name REVISION_NAME [--force] [--ignore-not-found] [--quiet]
コマンド・オプション
--name,-n- アプリケーション・リビジョンの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce revision delete -n newapp-mytest-00004 -f
出力例
Deleting application revision 'newapp-mytest-00004'...
OK
ibmcloud ce revision events
アプリケーション・リビジョン・インスタンスのシステム・イベントを表示します。 システム・イベントは最大で60分保持されます。
ibmcloud ce revision events (--instance REVISION_INSTANCE | --revision REVISION_NAME) [--output OUTPUT] [--quiet]
コマンド・オプション
--instance,-i- 特定のアプリケーション・インスタンスの名前。 インスタンス名を確認するには、
rev getコマンドを使用してください。--revisionを指定しない場合は、この値が必須です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --revision,--rev,-r,--name,-n- 指定されたアプリケーション・リビジョンのすべてのインスタンスのイベントを表示します。
--instanceを指定しない場合は、この値が必須です。
例
ibmcloud ce revision events -n myapp-00001
出力例
Code Engine がアクティブなアプリケーション・リビジョンの他に保持するのは、アクティブでない最新のアプリ・リビジョンのみです。 古いリビジョンは保持されません。
Getting application revision 'newapp-mytest-00002'...
Getting events for all instances of application revision 'newapp-mytest-00002'...
OK
newapp-mytest-00002-deployment-7c87cfbf66-xnwkp:
Type Reason Age Source Messages
Normal Scheduled 65s default-scheduler Successfully assigned bz8i2yh012p/newapp-mytest-00002-deployment-7c87cfbf66-xnwkp to 10.243.0.60
Normal Pulling 63s kubelet, 10.243.0.60 Pulling image "icr.io/codeengine/codeengine@sha256:b3150372958ab68eea5356a8cab31069ca5293c45959d64f6aaabbccddeeff123"
Normal Created 60s kubelet, 10.243.0.60 Created container queue-proxy
Normal Created 60s kubelet, 10.243.0.60 Created container user-container
Normal Started 60s kubelet, 10.243.0.60 Started container user-container
Normal Pulled 60s kubelet, 10.243.0.60 Container image "icr.io/obs/codeengine/knative-serving/knative.dev/serving/cmd/queue:v0.20.0-rc11@sha256:3fedfa9d9cdd74e85d11d4167043f13902074946caf415d16ff537620f04931a" already present on machine
Normal Pulled 60s kubelet, 10.243.0.60 Successfully pulled image "icr.io/codeengine/codeengine@sha256:b3150372958ab68eea5356a8cab31069ca5293c45959d64f6aaabbccddeeff123" in 2.67237432s
Normal Started 60s kubelet, 10.243.0.60 Started container queue-proxy
Normal Pulling 60s kubelet, 10.243.0.60 Pulling image "icr.io/obs/codeengine/istio/proxyv2:1.9.1-rc7"
Normal Pulled 59s kubelet, 10.243.0.60 Successfully pulled image "icr.io/obs/codeengine/istio/proxyv2:1.9.1-rc7" in 666.211288ms
Normal Created 59s kubelet, 10.243.0.60 Created container istio-proxy
Normal Started 59s kubelet, 10.243.0.60 Started container istio-proxy
ibmcloud ce revision get
アプリケーション・リビジョンの詳細を表示します。
ibmcloud ce revision get --name REVISION_NAME [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- アプリケーション・リビジョンの名前。 この値は必須です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce revision get --name newapp-mytest-00002
出力例
Getting application revision 'newapp-mytest-00002'...
Getting application 'newapp-mytest'...
OK
Name: newapp-mytest-00002
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 27d
Created: 2021-05-05T11:50:00-04:00
Status Summary: Revision is ready
Environment Variables:
Type Name Value
ConfigMap full reference mycolorconfigmap
Literal TARGET Sunshine
Image: icr.io/codeengine/codeengine
Resource Allocation:
CPU: 1
Ephemeral Storage: 400M
Memory: 4G
Port: 8080
Runtime:
Concurrency: 100
Maximum Scale: 10
Minimum Scale: 0
Timeout: 300
Conditions:
Type OK Age Reason
Active false 5d22h NoTraffic : The target is not receiving traffic.
ContainerHealthy true 5d22h
Ready true 5d22h
ResourcesAvailable true 5d22h
ibmcloud ce revision list
プロジェクト内のすべてのアプリケーション・リビジョンをリスト表示します。
ibmcloud ce revision list [--application APPLICATION] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--application,--app,-a- このオプションは、指定されたアプリケーションのリビジョンのみを表示する場合に使用します。 この値はオプション です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce revision list
出力例
Code Engine がアクティブなアプリケーション・リビジョンの他に保持するのは、アクティブでない最新のアプリ・リビジョンのみです。 古いリビジョンは保持されません。
Listing all application revisions...
OK
Name Application Status URL Latest Tag Traffic Age Conditions Reason
myapp-hc3u8-2 myapp Ready 16d 3 OK / 4
myapp-hc3u8-3 myapp Ready true 100% 2d8h 3 OK / 4
newapp-mytest-00004 newapp-mytest Ready 4d20h 3 OK / 4
newapp-mytest-00005 newapp-mytest Ready true 100% 2d20h 3 OK / 4
ibmcloud ce revision logs
アプリケーション・リビジョン・インスタンスのログを表示します。
ibmcloud ce revision logs (--instance REVISION_INSTANCE | --revision REVISION_NAME) [--all-containers] [--follow] [--output OUTPUT] [--quiet] [--tail TAIL] [--timestamps]
コマンド・オプション
--all-containers,--all- 指定されたアプリケーション・リビジョン・インスタンスのすべてのコンテナーのログを表示します。 この値はオプション です。 デフォルト値は
falseです。 --follow,-f- アプリケーション・リビジョン・インスタンスのログを監視します。 アプリケーション・リビジョン・インスタンスのログをストリーミングするには、このオプションを使用します。
--followオプションを指定する場合、このログ・コマンドを終了するにはCtrl+Cを入力しなければなりません。 この値はオプション です。 デフォルト値はfalseです。 --instance,-i- 特定のアプリケーション・リビジョン・インスタンスの名前。 インスタンス名を確認するには、
revision getコマンドを使用してください。--revisionを指定しない場合は、この値が必須です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --revision,--rev,-r,--name,-n- 指定されたアプリケーション・リビジョンのすべてのインスタンスのログを表示します。
--instanceを指定しない場合は、この値が必須です。 --tail,-t- 指定されたアプリケーション・リビジョン・インスタンスのコンテナーについて、ログの最新の行をコンテナーごとに最大で何行表示するかを制限します。 例えば、指定したアプリケーション・リビジョン・インスタンスのコンテナーのログの最後の
3行を表示するには、--tail 3と指定します。 このオプションが指定されない場合、指定されたアプリケーション・リビジョン・インスタンスのコンテナーのログのすべての行が表示されます。 この値はオプション です。 デフォルト値は-1です。 --timestamps,--ts- ログ出力の各行にタイム・スタンプを含めます。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce revision logs -n myapp-00001
出力例
Code Engine がアクティブなアプリケーション・リビジョンの他に保持するのは、アクティブでない最新のアプリ・リビジョンのみです。 古いリビジョンは保持されません。
Getting logs for all instances of application revision 'newapp-mytest-00002'...
Getting application revision 'newapp-mytest-00002'...
OK
newapp-mytest-00002-deployment-7c87cfbf66-xnwkp/user-container:
2021-07-15 20:40:56 Listening on port 8080
シークレットのコマンド
シークレットを使用して、機密性の高い構成情報 (パスワードや SSH 鍵など) をデプロイメントに含めることができます。 シークレットから値を参照することで、デプロイメントから機密情報を切り離し、アプリ、関数、ジョブの移植性を保つことができます。 プロジェクトに対する権限が与えられていれば、どのユーザーもシークレットを表示することができます。したがって、それらのユーザーとシークレット情報が共有される可能性があることを知っておいてください。 シークレットには、キーと値のペアで情報が格納されます。
コマンドは、プロジェクトsecretのコンテキスト内で使用する必要があります。
シークレットの操作について詳しくは、 シークレットの操作 を参照してください。
secret コマンドのCLIヘルプを見るには、 ibmcloud ce secret -h を実行する。
CLI バージョン 1.42.0 以降、CLI でのシークレットの定義と操作は secret コマンドグループに統一されました。 basic_auth, generic, hmac, ssh, tls, registry のように秘密のカテゴリーを指定するには --format オプションを使用する。 --format オプションのデフォルト値は generic。
ibmcloud ce secret create
シークレットを作成します。
ibmcloud ce secret create --name SECRET_NAME (--from-env-file FILE | --from-file FILE | --from-file KEY=FILE | --from-literal KEY=VALUE) [--access-key-id ACCESS_KEY_ID] [--access-key-id-prompt] [--cert-chain-file CERT_CHAIN_FILE] [--email EMAIL] [--format FORMAT] [--from-json-file FROM_JSON_FILE] [--key-path KEY_PATH] [--known-hosts-path KNOWN_HOSTS_PATH] [--output OUTPUT] [--password PASSWORD] [--password-from-file PASSWORD_FROM_FILE] [--password-from-json-file PASSWORD_FROM_JSON_FILE] [--private-key-file PRIVATE_KEY_FILE] [--quiet] [--secret-access-key SECRET_ACCESS_KEY] [--secret-access-key-prompt] [--server SERVER] [--username USERNAME]
コマンド・オプション
--access-key-id,--akid- HMAC資格情報のaccess_key_idを指定します。 この値はオプション です。
--access-key-id-prompt- HMAC資格情報のaccess_key_idを要求するプロンプトを表示します。 この値はオプション です。 デフォルト値は
falseです。 --cert-chain-file,--ccf- TLSシークレット用に認証局から提供された証明書チェーンを含むファイルを指定する。 ファイルのパスを値として指定する必要があります。 この値は、
tlsシークレットの場合は必須です。 この値はオプション です。 --email,--em- レジストリー・シークレットのレジストリー・サーバーにアクセスするための E メール・アドレス。 この値は、
registryシークレットにのみ適用されます。 この値はオプション です。 --format,--fo- シークレットの形式。 有効な値は
basic_auth,generic,hmac,registry,ssh, またはtlsです。 この値はオプション です。 デフォルト値はgenericです。 --from-env-file,-eKEY=VALUEの形式と一致する行が 1 つ以上含まれるファイルから汎用シークレットを作成します。 ファイルのパスを値として指定する必要があります。 指定したファイルにある各行が、キー/値のペアとして追加されます。 指定されたファイル内の、空または#で始まる行はすべて無視されます。--from-literalまたは--from-fileを指定しない場合は、この値が必須です。 このオプションは、複数回指定できます。 この値は、genericシークレットにのみ適用されます。--from-file,-f- ファイルから汎用シークレットを作成します。 ファイルのパスを値として指定する必要があります。
--from-literalまたは--from-env-fileを指定しない場合は、この値が必須です。 このオプションは、複数回指定できます。 この値は、genericシークレットにのみ適用されます。 --from-json-file,--json- JSON形式のシークレット値を含むファイルへのパス。 このオプションはシークレットフォーマットでサポートされている
hmacこの値はオプションである。 --from-literal,-l- キー/値のペアから汎用シークレットを作成します。 形式は
KEY=VALUEでなければなりません。--from-fileまたは--from-env-fileを指定しない場合は、この値が必須です。 このオプションは、複数回指定できます。 この値は、genericシークレットにのみ適用されます。 --key-path,--kp- SSH シークレットの暗号化されていない SSH 秘密鍵ファイルへのパス。 個人用の SSH 秘密鍵を使用する場合、このファイルは通常
$HOME/.ssh/id_rsa(Mac OS または Linux) または%HOMEPATH%\.ssh\id_rsa(Windows) にあります。 この値は、sshシークレットの場合は必須です。 この値はオプション です。 --known-hosts-path,--khp- SSH シークレットの既知の hosts ファイルへのパス。 この値は、過去にアクセスしたホスト、具体的には GitHub ホストまたは GitLab ホストでの認証にのみ秘密鍵を使用するようにするためのセキュリティー機能です。 このファイルは通常、
$HOME/.ssh/known_hosts(Mac OS または Linux) または%HOMEPATH%\.ssh\known_hosts(Windows) にあります。 この値は、sshシークレットにのみ適用されます。 この値はオプション です。 -n,--name- シークレットの名前。 プロジェクト内で固有の名前を使用します。
- 名前の先頭と末尾は小文字の英数字でなければなりません。
- 名前は 253 文字以下でなければならず、使用できるのは小文字、数字、ピリオド (.)、ハイフン (-) です。
この値はオプション です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --password,--pw- 基本認証またはレジストリー・シークレットのパスワード。
--passwordオプション、--password-from-fileオプション、--password-from-json-fileオプションがいずれも指定されていない場合は、パスワードの入力を求めるプロンプトが出されます。 この値は、basic_authシークレットおよびregistryシークレットの場合は必須です。 この値はオプション です。 --password-from-file,--spf- 基本認証またはレジストリー・シークレットのパスワードを含むファイルへのパス。 ファイルの最初の行がパスワードに使用されます。
--passwordオプション、--password-from-fileオプション、--password-from-json-fileオプションがいずれも指定されていない場合は、パスワードの入力を求めるプロンプトが出されます。 ファイルのパスを値として指定する必要があります。 この値は、basic_authシークレットおよびregistryシークレットの場合は必須です。 この値はオプション です。 --password-from-json-file,--spfj- 基本認証またはレジストリー・シークレットのパスワードを含む JSON ファイルへのパス。
apikeyフィールドはパスワード用に使用されます。--passwordオプション、--password-from-fileオプション、--password-from-json-fileオプションがいずれも指定されていない場合は、パスワードの入力を求めるプロンプトが出されます。 ファイルのパスを値として指定する必要があります。 この値は、basic_authシークレットおよびregistryシークレットの場合は必須です。 この値はオプション です。 --private-key-file,--pkfcert-chain-fileオプションで指定した証明書チェーンにマッチする TLS シークレットの秘密鍵を含むファイルを指定する。 ファイルのパスを値として指定する必要があります。 この値は、tlsシークレットの場合は必須です。 この値はオプション です。--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 このオプションは、
basic_auth、generic、registry、ssh、およびtlsの各シークレットに適用されます。 この値はオプション です。 デフォルト値はfalseです。 --secret-access-key,--sak- HMAC資格情報のsecret_access_keyを指定します。 この値はオプション です。
--secret-access-key-prompt- HMAC資格情報のsecret_access_keyを要求するプロンプトを表示します。 この値はオプション です。 デフォルト値は
falseです。 --server,-s- レジストリシークレットのレジストリサーバーの URL。 このオプションは、
registryシークレットの場合は必須です。 この値はオプション です。 デフォルト値はus.icr.ioです。 --username,-u- 基本認証用のユーザー名、あるいはレジストリ・シークレット。 このオプションは、
basic_authシークレットおよびregistryシークレットの場合は必須です。 この値はオプション です。
基本認証シークレットの例
Basic認証の秘密には、 username と password のキーが含まれており、Basic認証( HTTP )が必要なサービスにアクセスする際に使用されます。
基本認証シークレットを作成するための CLI ヘルプを表示するには、 ibmcloud ce secret create --format basic_auth を実行します。
以下の例では、 mysecret-basicauth という名前の基本認証シークレットを作成します。 このシークレットにはユーザー名 myusername が含まれ、パスワード値はローカル・マシン上のファイルから取得されます。 パスワードがファイルまたは JSON ファイルから提供されない場合は、パスワード値の入力を求めるプロンプトが出されます。
ibmcloud ce secret create --name mysecret-basicauth --format basic_auth --username myusername --password-from-file ./password.txt
基本認証シークレットの出力例
Creating basic_auth secret 'mysecret-basicauth'...
OK
汎用シークレットの例
汎用シークレットは、単純なキーと値のペアを保管し、 Code Engine は、定義されたキーと値のペアについても、シークレットの用途についても想定しません。
汎用シークレットの作成に関する CLI ヘルプを表示するには、 ibmcloud ce secret create または ibmcloud ce secret create --format generic を実行します。
CLI で secret create コマンドを使用してシークレットを作成する場合、 --format generic がデフォルトであることに注意してください。
以下の例では、 mysecret-generic という名前の汎用シークレットを作成します。このシークレットの値は、 --from-literal オプションを使用してキーと値のペアに指定します。
ibmcloud ce secret create --name mysecret-generic --format generic --from-literal "TARGET=My literal secret"
汎用シークレットの出力例
Creating generic secret 'mysecret-generic'...
OK
ファイルからの値を使った一般的な秘密の例
以下の例では、ファイルに含まれている値を使用して、mysecret-fromfile という名前のシークレットを作成しています。 --from-file オプションを使用してファイルを指すことにより、ファイルのすべての内容がキーと値のペアの値になります。
ibmcloud ce secret create --name mysecret-genericfromfile --from-file ./value1.txt --from-file ./value2.txt
ファイルからの値を使った一般的な秘密の出力例
Creating secret mysecret-genericfromfile...
OK
HMAC秘密の例
HMACシークレットは、 access_key_id と secret_access_key キーを含み、 S3-compatible 認証を必要とするが、 IBM Cloud® Identity and Access Management APIキーをサポートしていないツールやライブラリで使用される。
HMACシークレットを作成するCLIヘルプを見るには、 ibmcloud ce secret create --format hmac.
次の例では、 mysecret-hmac という名前の HMAC 秘密を作成します。 このシークレットには、プロンプトが表示されたときに指定された access_key_id と secret_access_key の値が含まれる。 この2つのオプションのいずれかが、コマンドまたはJSONファイルから提供されていない場合、それらの値を入力するようプロンプトが表示される。
ibmcloud ce secret create --name mysecret-hmac --format hmac --access-key-id-prompt --secret-access-key-prompt
HMACシークレットの出力例
Creating hmac_auth secret 'mysecret-hmac'...
OK
レジストリー・シークレットの例
レジストリー・シークレットは、コンテナー・レジストリーにアクセスするための資格情報を保管します。
レジストリー・シークレットの作成に関する CLI ヘルプを表示するには、 ibmcloud ce secret create --format registry を実行します。
以下の例では、 us.icr.io レジストリー・サーバー上の IBM Cloud Container Registry インスタンスに対して mysecret-registry という名前のレジストリー・シークレットを作成し、 username および password の資格情報を指定します。
ibmcloud ce secret create --name mysecret-registry --format registry --server us.icr.io --username iamapikey --password API_KEY
レジストリー・シークレットの出力例
Creating registry secret `mysecret-registry`...
OK
SSH シークレットの例
SSH 秘密鍵は、SSH 鍵を使用してサービスに対して認証するための資格情報を保管します。例えば、 GitHub や GitLabなどの Git リポジトリーに対して認証します。
SSH シークレットの作成に関する CLI ヘルプを表示するには、 ibmcloud ce secret create --format ssh を実行します。
以下の例では、 known_hosts ファイルに含まれているホスト用に mysecret-ssh という名前の SSH 秘密を作成し、 /<filepath>/.ssh/<key_name> にある暗号化されていない SSH 秘密鍵ファイルを使用して認証します。ここで、 <filepath> はシステム上のパスです。 このコマンドは、名前とキー・パスを必要とします。また、既知の
hosts ファイルへのパスなど、その他のオプション引数も許可します。
ibmcloud ce secret create --name mysecret-ssh --format ssh --key-path ~/.ssh/<key_name> --known-hosts-path ~/.ssh/known_hosts
SSH シークレットの出力例
Creating SSH secret `mysecret-ssh`...
OK
TLS シークレットの例
Transport Layer Security (TLS) シークレットには、署名付き TLS 証明書が含まれます。これには、すべての中間証明書と、認証局 (CA) からの対応する秘密鍵が含まれます。 カスタム・ドメイン・マッピングを処理する場合は、TLS シークレットを使用します。
TLS シークレットの作成に関する CLI ヘルプを表示するには、 ibmcloud ce secret create --format tls を実行します。
以下の例では、 mysecret-tls という名前の TLS シークレットを作成します。 カスタム・ドメインに対応する証明書チェーンはファイル certificate.txt に含まれ、一致する秘密鍵ファイルはファイル privatekey.txt に含まれます。 これらのファイルは両方とも、ローカル・ワークステーションのルート・ディレクトリーにあります。
ibmcloud ce secret create --name mysecret-tls --format tls --cert-chain-file certificate.txt --private-key-file privatekey.txt
TLS シークレットの出力例
Creating TLS secret `mysecret-tls`...
OK
ibmcloud ce secret delete
シークレットを削除します。
ibmcloud ce secret delete --name SECRET_NAME [--force] [--ignore-not-found] [--quiet]
コマンド・オプション
--name,-n- シークレットの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce secret delete --name mysecret-genericfromfile -f
出力例
Deleting secret mysecret-genericfromfile...
OK
ibmcloud ce secret get
シークレットの詳細を表示します。
ibmcloud ce secret get --name SECRET_NAME [--decode] [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- シークレットの名前。 この値は必須です。
--decode,-dData出力をデコードして詳細に示します。 このオプションを指定しない場合、Data詳細は base64 でエンコードされます。 この値はオプション です。 デフォルト値はfalseです。--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce secret get --name mysecret-basicauth
出力例
Getting secret 'mysecret-basicauth'...
OK
Name: mysecret-basicauth
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Format: basic_auth
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 66s
Created: 2021-03-10T18:44:18-05:00
Data:
---
password: REDACTED
username: bXl1c2VybmFtZQ==
ibmcloud ce secret list
プロジェクト内のすべてのシークレットをリストします。
ibmcloud ce secret list [--all] [--format FORMAT] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--all,-a- Code Engineで管理されていないすべてのフォーマット (
basic_auth、generic、registry、ssh、tls、およびotherのシークレットを含む) のすべてのシークレットを表示します。 この値はオプション です。 デフォルト値はfalseです。 --format,--fo- シークレットの表示をフィルターに掛けるには、このオプションを指定します。 有効な値は
basic_auth、generic、registry、ssh、tls。 この値はオプション です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
このコマンドは、プロジェクト内のすべてのシークレットをリストします。
ibmcloud ce secret list
出力例
Listing secrets...
OK
Name Format Data Age
ce-auto-icr-private-us-south registry 4 333d
ce-auto-private-icr-us-south registry 4 335d
myregistry-seccmd registry 4 3h31m
mysecret-basicauth basic_auth 2 7m37s
mysecret-generic generic 1 7m7s
mysecret-genericfromfile generic 2 2m29s
mysecret-hmac hmac_auth 2 21m
mysecret-registry registry 4 111s
mysecret-ssh ssh_auth 2 42m
mysecret-tls tls 2 3h47m
ibmcloud ce secret update
シークレットを更新します。
ibmcloud ce secret update --name SECRET_NAME (--from-env-file FILE | --from-file FILE | --from-file KEY=FILE | --from-literal KEY=VALUE | --rm KEY) [--access-key-id ACCESS_KEY_ID] [--access-key-id-prompt] [--cert-chain-file CERT_CHAIN_FILE] [--email EMAIL] [--from-json-file FROM_JSON_FILE] [--key-path KEY_PATH] [--known-hosts-path KNOWN_HOSTS_PATH] [--output OUTPUT] [--password PASSWORD] [--password-from-file PASSWORD_FROM_FILE] [--password-from-json-file PASSWORD_FROM_JSON_FILE] [--private-key-file PRIVATE_KEY_FILE] [--quiet] [--secret-access-key SECRET_ACCESS_KEY] [--secret-access-key-prompt] [--server SERVER] [--username USERNAME]
コマンド・オプション
--name,-n- シークレットの名前。 この値は必須です。
--access-key-id,--akid- HMAC資格情報のaccess_key_idを指定します。 この値はオプション です。
--access-key-id-prompt- HMAC資格情報のaccess_key_idを要求するプロンプトを表示します。 この値はオプション です。 デフォルト値は
falseです。 --cert-chain-file,--ccf- TLSシークレット用に認証局から提供された証明書チェーンを含むファイルを指定する。 ファイルのパスを値として指定する必要があります。 この値はオプション です。
--email,--em- レジストリー・シークレットのレジストリー・サーバーにアクセスするための E メール・アドレス。 この値はオプション です。
--from-env-file,-eKEY=VALUEの形式と一致する行が 1 つ以上含まれるファイルで汎用シークレットを更新します。 ファイルのパスを値として指定する必要があります。 指定したファイルにある各行が、キー/値のペアとして追加されます。 指定されたファイル内の、空または#で始まる行はすべて無視されます。--from-literalまたは--from-fileを指定しない場合は、この値が必須です。--from-file,-f- ファイルから汎用シークレットを更新します。 ファイルのパスを値として指定する必要があります。
--from-literalまたは--from-env-fileを指定しない場合は、この値が必須です。 --from-json-file,--json- JSON形式のシークレット値を含むファイルへのパス。 このオプションはシークレットフォーマットでサポートされている
hmacこの値はオプションである。 --from-literal,-l- キー/値のペアから汎用シークレットを更新します。 形式は
KEY=VALUEでなければなりません。--from-fileまたは--from-env-fileを指定しない場合は、この値が必須です。 このオプションは、複数回指定できます。 --key-path,--kp- SSH シークレットの暗号化されていない SSH 秘密鍵ファイルへのパス。 個人用の SSH 秘密鍵を使用する場合、このファイルは通常
$HOME/.ssh/id_rsa(Mac OS または Linux) または%HOMEPATH%\.ssh\id_rsa(Windows) にあります。 この値はオプション です。 --known-hosts-path,--khp- SSH シークレットの既知の hosts ファイルへのパス。 この値は、過去にアクセスしたホスト、具体的には GitHub ホストまたは GitLab ホストでの認証にのみ秘密鍵を使用するようにするためのセキュリティー機能です。 このファイルは通常、
$HOME/.ssh/known_hosts(Mac OS または Linux) または%HOMEPATH%\.ssh\known_hosts(Windows) にあります。 この値はオプション です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --password,--pw- 基本認証またはレジストリー・シークレットのパスワード。
--passwordオプション、--password-from-fileオプション、--password-from-json-fileオプションがいずれも指定されていない場合は、パスワードの入力を求めるプロンプトが出されます。 この値はオプション です。 --password-from-file,--spf- 基本認証またはレジストリー・シークレットのパスワードを含むファイルへのパス。 ファイルの最初の行がパスワードに使用されます。
--passwordオプション、--password-from-fileオプション、--password-from-json-fileオプションがいずれも指定されていない場合は、パスワードの入力を求めるプロンプトが出されます。 ファイルのパスを値として指定する必要があります。 この値はオプション です。 --password-from-json-file,--spfj- 基本認証またはレジストリー・シークレットのパスワードを含む JSON ファイルへのパス。
apikeyフィールドはパスワード用に使用されます。--passwordオプション、--password-from-fileオプション、--password-from-json-fileオプションがいずれも指定されていない場合は、パスワードの入力を求めるプロンプトが出されます。 ファイルのパスを値として指定する必要があります。 この値はオプション です。 --private-key-file,--pkfcert-chain-fileオプションで指定した証明書チェーンにマッチする TLS シークレットの秘密鍵を含むファイルを指定する。 ファイルのパスを値として指定する必要があります。 この値はオプション です。--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --rm- キーの名前を指定して、汎用シークレットの個々のキー/値のペアを削除します。 このオプションは、複数回指定できます。 この値はオプション です。
--secret-access-key,--sak- HMAC資格情報のsecret_access_keyを指定します。 この値はオプション です。
--secret-access-key-prompt- HMAC資格情報のsecret_access_keyを要求するプロンプトを表示します。 この値はオプション です。 デフォルト値は
falseです。 --server,-s- レジストリシークレットのレジストリサーバーの URL。 この値はオプション です。 デフォルト値は
us.icr.ioです。 --username,-u- 基本認証用のユーザー名、あるいはレジストリ・シークレット。 この値はオプション です。
例
この例では、更新された証明書と秘密鍵を使用して TLS シークレットを更新します。
ibmcloud ce secret update --name mysecret-tls --cert-chain-file certificate2.txt --private-key-file privatekey2.txt
出力例
Updating secret mysecret-tls..
OK
サブスクリプション cos コマンド
分散環境では多くの場合、他のコンポーネント (通常、イベント・プロデューサーと呼ばれる) で生成されたメッセージ (イベント) に対応する処理をアプリケーションまたはジョブに行わせます。 Code Engine では、イベント・プロデューサーをサブスクライブすることで、アプリケーションまたはジョブが関心対象のイベントを受信できるようになります。 イベント情報は、アプリケーションについては POST HTTP 要求、ジョブについては環境変数として受信されます。
Object Storage イベント・プロデューサーは、オブジェクト・ストレージ・バケット内のオブジェクトに変更が加えられると、イベントを生成します。 例えば、バケットにオブジェクトが追加されると、アプリケーションがイベントを受信して、その変更に基づくアクション (新しいオブジェクトを取り込むなど) を実行できます。
コマンドは、プロジェクトsubscription cosのコンテキスト内で使用する必要があります。
IBM Cloud Object Storage サブスクリプションの操作について詳しくは、IBM Cloud Object Storage イベント・プロデューサーの操作を参照してください。 Code Engine でのサブスクリプションの処理について詳しくは、サブスクリプションの概要 を参照してください。
subscription cosコマンドでは、subscriptionまたはsubのいずれかを使用できます。 subscription cosコマンドの CLI ヘルプを表示するには、ibmcloud ce sub cos -hを実行します。
ibmcloud ce subscription cos create
IBM Cloud Object Storage のイベント・サブスクリプションを作成します。
ibmcloud ce subscription cos create --name COS_SOURCE_NAME --destination DESTINATION_REF --bucket BUCKET_NAME [--destination-type DESTINATION_TYPE] [--event-type EVENT_TYPE] [--extension EXTENSION] [--force] [--no-wait] [--output OUTPUT] [--path PATH] [--prefix PREFIX] [--quiet] [--suffix SUFFIX] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--bucket,-b- イベントのバケット。 宛先とバケットは、プロジェクトと同じリージョンになければなりません。 この値は必須です。
--destination,-d- イベントを受信するアプリケーション・リソースまたはジョブ・リソースの名前 (例えば、
myapp)。 必要に応じて、--pathオプションを使用してアプリの宛先をさらに限定します。 この値は必須です。 -n,--name- IBM Cloud Object Storage イベント・サブスクリプションの名前。 プロジェクト内で固有の名前を使用します。
- 名前の先頭と末尾は小文字の英数字でなければなりません。
- 名前は 253 文字以下でなければならず、使用できるのは小文字、数字、ピリオド (.)、ハイフン (-) です。
この値は必須です。
--destination-type,--dtdestinationのタイプ。 有効な値はappおよびjobです。 この値はオプション です。 デフォルト値はappです。--event-type,-e- 監視するイベント・タイプ。 有効な値は
delete、write、all。 この値はオプション です。 デフォルト値はallです。 --extension,--ext- 宛先に送信する CloudEvents 拡張を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の CloudEvents 拡張を追加するか、または既存の CloudEvent 属性をオーバーライドします。--extensionオプション 1 つにつき 1 つの拡張を指定してください (例:--ext extA=A --ext extB=B)。 この値はオプション です。 --force,-f- IBM Cloud Object Storage のイベント・サブスクリプションを強制的に作成します。 このオプションを指定すると、指定された宛先の検証がスキップされます。 この値はオプション です。 デフォルト値は
falseです。 --no-wait,--nw- IBM Cloud Object Storage イベント・サブスクリプションを作成し、サブスクリプションの準備完了を待機しません。
--no-waitオプションを指定した場合は、サブスクリプションの作成が開始され、待機は行われません。 サブスクリプションの状況を確認するには、subscription cos getコマンドを使用してください。 この値はオプション です。 デフォルト値はfalseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --path- イベントの転送先とする、
destinationアプリケーション内のパス (例:/events)。 デフォルトのパスは、destinationアプリケーションのルート URL です。 このオプションを指定できるのは、destination-typeがappの場合だけです。 この値はオプション です。 --prefix,-p- IBM Cloud Object Storage オブジェクトの接頭部。 この値はオプション です。
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --suffix,-s- IBM Cloud Object Storage オブジェクトの接尾部。 接尾部を指定する際には、ファイルのファイル・タイプを考慮してください。 この値はオプション です。
--wait,-w- IBM Cloud Object Storage イベント・サブスクリプションを作成し、サブスクリプションの準備完了を待機します。
--waitオプションを指定した場合、サブスクリプション作成コマンドは、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、サブスクリプションの準備完了を待機します。 サブスクリプションの準備が--wait-timeoutで指定された期間内に完了しない場合、IBM Cloud Object Storage イベント・サブスクリプション作成は失敗します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- IBM Cloud Object Storage イベント・サブスクリプションの準備完了を待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は15です。
例
IBM Cloud Object Storage サブスクリプションは、Object Storage バケットに対する変更を listen します。 以下の例では、バケット mycosevent に対する COS サブスクリプション mybucket を作成し、アプリ myapp に関連付けています。 --destination-type オプションは、destination のタイプ (app または job) を指定します。 この例では、--destination-type は app です。これがこのオプションのデフォルトです。 イベントがhttps://<base application URL>/eventsに送信されるように、--pathオプションを使用してイベントが/eventsパスに送信されます。
ibmcloud ce subscription cos create --name mycosevent --destination myapp --bucket mybucket --destination-type app --path /events
出力例
Creating COS source 'mycosevent'...
Run 'ibmcloud ce subscription cos get -n mycosevent' to check the COS source status.
OK
ibmcloud ce subscription cos delete
IBM Cloud Object Storage イベント・サブスクリプションを削除します。
ibmcloud ce subscription cos delete --name COS_SOURCE_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--name,-n- IBM Cloud Object Storage イベント・サブスクリプションの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --no-wait,--nw- IBM Cloud Object Storage イベント・サブスクリプションを削除し、サブスクリプションが削除されるのを待機しません。
--no-waitオプションを指定した場合は、サブスクリプションの削除が開始され、待機は行われません。 サブスクリプションの状況を確認するには、subscription cos getコマンドを使用してください。 この値はオプション です。 デフォルト値はfalseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- IBM Cloud Object Storage イベント・サブスクリプションを削除し、このサブスクリプションが削除されるまで待機します。
--waitオプションを指定した場合、サブスクリプション削除の際に、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、サブスクリプションが削除されるのを待機します。 サブスクリプションが削除されるか、--wait-timeoutに達するか、どちらか早いほうの時点で、このコマンドは終了します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- IBM Cloud Object Storage イベント・サブスクリプションが削除されるまでに待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は15です。
例
ibmcloud ce subscription cos delete --name mycosevent -f
出力例
Deleting COS source 'mycosevent'...
OK
ibmcloud ce subscription cos get
IBM Cloud Object Storage イベント・サブスクリプションの詳細を表示します。 表示される属性には Name、Destination、Bucket、Event Type、Prefix、Suffix、Ready、および Age があります。 具体的な詳細を確認するには、| grep <attribute>を付加します。
ibmcloud ce subscription cos get --name COS_SOURCE_NAME [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- IBM Cloud Object Storage イベント・サブスクリプションの名前。 この値は必須です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce subscription cos get --name mycosevent
出力例
Getting COS source 'mycosevent'...
OK
Name: mycosevent
ID: abcdefgh-abcd-abcd-abcd-fb6be2347a14
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 12s
Created: 2021-03-14T13:28:45-05:00
Destination: App:myapp
Bucket: mybucket
EventType: all
Ready: true
Conditions:
Type OK Age Reason
CosConfigured true 10s
Ready true 10s
ReadyForEvents true 10s
SinkProvided true 10s
Events:
Type Reason Age Source Messages
Normal CosSourceReady 11s cossource-controller CosSource is ready
Ready が true であれば、その COS サブスクリプションは、COS バケットの変更に応じてイベントをトリガーできる状態です。
ibmcloud ce subscription cos list
プロジェクト内のすべての IBM Cloud Object Storage イベント・サブスクリプションをリストします。
ibmcloud ce subscription cos list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce subscription cos list
出力例
Listing COS sources...
OK
Name Age Ready Bucket EventType Prefix Suffix Destination
mycosevent 20m true mycosbucket all http://myapp.2706b22d-676b.svc.cluster.local
ibmcloud ce subscription cos update
IBM Cloud Object Storage イベント・サブスクリプションを更新します。
ibmcloud ce subscription cos update --name COS_SOURCE_NAME [--destination DESTINATION] [--destination-type DESTINATION_TYPE] [--event-type EVENT_TYPE] [--extension EXTENSION] [--extension-rm EXTENSION_RM] [--output OUTPUT] [--path PATH] [--prefix PREFIX] [--quiet] [--suffix SUFFIX]
コマンド・オプション
--name,-n- IBM Cloud Object Storage イベント・サブスクリプションの名前。 この値は必須です。
--destination,-d- イベントを受信するアプリケーション・リソースまたはジョブ・リソースの名前 (例えば、
myapp)。 必要に応じて、--pathオプションを使用してアプリの宛先をさらに限定します。 この値はオプション です。 --destination-type,--dtdestinationのタイプ。 有効な値はappおよびjobです。 この値はオプション です。--event-type,-e- 監視するイベント・タイプ。 有効な値は
delete、write、all。 この値はオプション です。 --extension,--ext- 宛先に送信する CloudEvents 拡張を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の CloudEvents 拡張を追加するか、または既存の CloudEvent 属性をオーバーライドします。--extensionオプション 1 つにつき 1 つの拡張を指定してください (例:--ext extA=A --ext extB=B)。 この値はオプション です。 --extension-rm,--ext-rm- キーの名前を指定して、宛先に送信する CloudEvents 拡張を削除します。
--ext-rmオプション 1 つにつき 1 つの拡張を指定してください (例:--ext-rm extA --ext-rm extB)。 この値はオプション です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --path- イベントの転送先とする、
destinationアプリケーション内のパス (例:/events)。 デフォルトのパスは、destinationアプリケーションのルート URL です。 このオプションを指定できるのは、destination-typeがappの場合だけです。 この値はオプション です。 --prefix,-p- IBM Cloud Object Storage オブジェクトの接頭部。 この値はオプション です。
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --suffix,-s- IBM Cloud Object Storage オブジェクトの接尾部。 接尾部を指定する際には、ファイルのファイル・タイプ (拡張子) を考慮してください。 この値はオプション です。
例
以下の例では、書き込みイベントのみを listen するように、mycosevent という COS サブスクリプションを更新しています。
ibmcloud ce subscription cos update --name mycosevent --event-type write
出力例
Updating COS source 'mycosevent'...
Run 'ibmcloud ce subscription cos get -n mycosevent' to check the COS source status.
OK
サブスクリプション cron コマンド
分散環境では多くの場合、他のコンポーネント (通常、イベント・プロデューサーと呼ばれる) で生成されたメッセージ (イベント) に対応する処理をアプリケーションまたはジョブに行わせます。 Code Engine では、イベント・プロデューサーをサブスクライブすることで、アプリケーションまたはジョブが関心対象のイベントを受信できるようになります。 イベント情報は、アプリケーションについては POST HTTP 要求、ジョブについては環境変数として受信されます。
cron イベント・プロデューサーは、クーロンに基づいており、一定の間隔でイベントを生成します。 明確に定義された間隔または特定の時刻にアクションを実行する必要がある場合に、cron イベント・プロデューサーを使用します。
コマンドは、プロジェクトsubscription cronのコンテキスト内で使用する必要があります。
IBM Cloud Object Storage サブスクリプションの操作について詳しくは、定期的タイマー (cron) イベント・プロデューサーの操作を参照してください。 Code Engine でのサブスクリプションの処理について詳しくは、サブスクリプションの概要 を参照してください。
subscription cronコマンドでは、subscriptionまたはsubのいずれかを使用できます。 subscription cronコマンドの CLI ヘルプを表示するには、ibmcloud ce sub cron -hを実行します。
ibmcloud ce subscription cron create
cron イベント・サブスクリプションを作成します。
ibmcloud ce subscription cron create --name CRON_SOURCE_NAME --destination DESTINATION_REF [--content-type CONTENT_TYPE] [--data DATA] [--data-base64 DATA_BASE64] [--destination-type DESTINATION_TYPE] [--extension EXTENSION] [--force] [--no-wait] [--output OUTPUT] [--path PATH] [--quiet] [--schedule SCHEDULE] [--time-zone TIME_ZONE] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--destination,-d- イベントを受信するアプリケーション・リソースまたはジョブ・リソースの名前 (例えば、
myapp)。 必要に応じて、--pathオプションを使用してアプリの宛先をさらに限定します。 この値は必須です。 -n,--name- cron イベント・サブスクリプションの名前。 プロジェクト内で固有の名前を使用します。
- 名前の先頭と末尾は小文字の英数字でなければなりません。
- 名前は 253 文字以下でなければならず、使用できるのは小文字、数字、ピリオド (.)、ハイフン (-) です。
この値は必須です。
--content-type,--ct--dataオプションまたは--data-base64オプションのメディア・タイプ。 例として、application/json、application/x-www-form-urlencoded、text/html、およびtext/plainがあります。 この値はオプション です。--da,--data- 宛先に送信するデータ (例:
'{ "message": "Hello world!" }')。--dataオプションを指定した場合、--data-base64オプションを使用しないでください。
この値はオプション です。
--data-base64,--db- 宛先に送信する base64 エンコードのデータ (例:
Q29kZSBFbmdpbmU=)。--data-base64オプションを指定した場合、--dataオプションを使用しないでください。 この値はオプション です。 --destination-type,--dtdestinationのタイプ。 有効な値はapp、function、jobである。 この値はオプション です。 デフォルト値はappです。--extension,--ext- 宛先に送信する CloudEvents 拡張を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の CloudEvents 拡張を追加するか、または既存の CloudEvent 属性をオーバーライドします。--extensionオプション 1 つにつき 1 つの拡張を指定してください (例:--ext extA=A --ext extB=B)。 この値はオプション です。 --force,-f- cron イベント・サブスクリプションを強制的に作成します。 このオプションを指定すると、指定された宛先の検証がスキップされます。 この値はオプション です。 デフォルト値は
falseです。 --no-wait,--nw- cron イベント・サブスクリプションを作成し、サブスクリプションの準備完了を待機しません。
--no-waitオプションを指定した場合は、サブスクリプションの作成が開始され、待機は行われません。 サブスクリプションの状況を確認するには、subscription cron getコマンドを使用してください。 この値はオプション です。 デフォルト値はfalseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --path- イベントの転送先とする、
destinationアプリケーション内のパス (例:/events)。 デフォルトのパスは、destinationアプリケーションのルート URL です。 このオプションを指定できるのは、destination-typeがappの場合だけです。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --schedule,-s- イベントをトリガーする頻度を、crontab 形式でスケジュールします。 例えば、2 分間隔は
'*/2 * * * *'(文字列形式) と指定します。 デフォルトでは、cron イベントは 1 分間隔でトリガーされ、UTCタイム・ゾーンに設定されます。 タイム・ゾーンを変更するには、--time-zoneオプションを使用します。 この値はオプション です。 --time-zone,--tz- cron イベントのタイム・ゾーンを設定します (例:
Asia/Tokyo)。--scheduleオプションを指定した場合は、このオプションを使用してタイム・ゾーンを指定します。 有効なタイム・ゾーン値については、タイム・ゾーン・データベースを参照してください。 この値はオプション です。 デフォルト値はUTCです。 --wait,-w- cron イベント・サブスクリプションを作成し、サブスクリプションの準備完了を待機します。
--waitオプションを指定した場合、サブスクリプション作成コマンドは、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、サブスクリプションの準備完了を待機します。--wait-timeoutで指定した期間内にサブスクリプションの準備が完了しない場合、cron イベント・サブスクリプションの作成は失敗します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- cron イベント・サブスクリプションの準備完了を待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は15です。
例
以下の例では、mycronevent というジョブに cron イベントを 2 分間隔で転送する、myjob という cron サブスクリプションを作成します。
ibmcloud ce subscription cron create --name mycronevent --destination myjob --schedule '*/2 * * * *' --destination-type job
出力例
Creating cron source 'mycronevent'...
Run 'ibmcloud ce subscription cron get -n mycronevent' to check the cron source status.
OK
ibmcloud ce subscription cron delete
cron イベント・サブスクリプションを削除します。
ibmcloud ce subscription cron delete --name CRON_SOURCE_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--name,-n- cron イベント・サブスクリプションの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --no-wait,--nw- cron イベント・サブスクリプションを削除し、このサブスクリプションが削除されるのを待機しません。
--no-waitオプションを指定した場合は、サブスクリプションの削除が開始され、待機は行われません。 サブスクリプションの状況を確認するには、subscription cron getコマンドを使用してください。 この値はオプション です。 デフォルト値はfalseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- cron イベント・サブスクリプションを削除し、このサブスクリプションが削除されるまで待機します。
--waitオプションを指定した場合、サブスクリプション削除の際に、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、サブスクリプションが削除されるのを待機します。 サブスクリプションが削除されるか、--wait-timeoutに達するか、どちらか早いほうの時点で、このコマンドは終了します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- cron イベント・サブスクリプションが削除されるまでに待機する時間の長さ (秒単位)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は15です。
例
ibmcloud ce subscription cron delete --name mycronevent -f
出力例
Deleting cron source 'mycronevent'...
OK
ibmcloud ce subscription cron get
cron イベント・サブスクリプションの詳細を表示します。
ibmcloud ce subscription cron get --name CRON_SOURCE_NAME [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- cron イベント・サブスクリプションの名前。 この値は必須です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce subscription cron get --name mycronevent
出力例
Getting cron source 'mycronevent'...
OK
Name: mycronevent
ID: abcdefgh-abcd-abcd-abcd-fb6be2347a14
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 18s
Created: 2021-03-14T13:33:53-05:00
Destination: App:kapp
Schedule: */2 * * * *
Time Zone: UTC
Ready: true
Events:
Type Reason Age Source Messages
Normal FinalizerUpdate 19s pingsource-controller Updated "mycronevent" finalizers
Ready が true であれば、その cron サブスクリプションは、指定されたスケジュールでイベントをトリガーできる状態です。
ibmcloud ce subscription cron list
プロジェクト内のすべての cron イベント・サブスクリプションをリスト表示します。
ibmcloud ce subscription cron list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce subscription cron list
出力例
Listing cron sources...
OK
Name Age Ready Destination Schedule Data
mycronevent 96m true http://myapp.cd4200a7-5037.svc.cluster.local */2 * * * *
ibmcloud ce subscription cron update
cron イベント・サブスクリプションを更新します。
ibmcloud ce subscription cron update --name CRON_SOURCE_NAME [--content-type CONTENT_TYPE] [--data DATA] [--data-base64 DATA_BASE64] [--destination DESTINATION] [--destination-type DESTINATION_TYPE] [--extension EXTENSION] [--extension-rm EXTENSION_RM] [--output OUTPUT] [--path PATH] [--quiet] [--schedule SCHEDULE] [--time-zone TIME_ZONE]
コマンド・オプション
--name,-n- cron イベント・サブスクリプションの名前。 この値は必須です。
--content-type,--ct--dataオプションまたは--data-base64オプションのメディア・タイプ。 例として、application/json、application/x-www-form-urlencoded、text/html、およびtext/plainがあります。 この値はオプション です。--da,--data- 宛先に送信するデータ (例:
'{ "message": "Hello world!" }')。--dataオプションを指定した場合、--data-base64オプションを使用しないでください。
この値はオプション です。
--data-base64,--db- 宛先に送信する base64 エンコードのデータ (例:
Q29kZSBFbmdpbmU=)。--data-base64オプションを指定した場合、--dataオプションを使用しないでください。 この値はオプション です。 --destination,-d- イベントを受信するアプリケーション・リソースまたはジョブ・リソースの名前 (例えば、
myapp)。 必要に応じて、--pathオプションを使用してアプリの宛先をさらに限定します。 この値はオプション です。 --destination-type,--dtdestinationのタイプ。 有効な値はapp、function、jobである。 この値はオプション です。--extension,--ext- 宛先に送信する CloudEvents 拡張を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の CloudEvents 拡張を追加するか、または既存の CloudEvent 属性をオーバーライドします。--extensionオプション 1 つにつき 1 つの拡張を指定してください (例:--ext extA=A --ext extB=B)。 この値はオプション です。 --extension-rm,--ext-rm- キーの名前を指定して、宛先に送信する CloudEvents 拡張を削除します。
--ext-rmオプション 1 つにつき 1 つの拡張を指定してください (例:--ext-rm extA --ext-rm extB)。 この値はオプション です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --path- イベントの転送先とする、
destinationアプリケーション内のパス (例:/events)。 デフォルトのパスは、destinationアプリケーションのルート URL です。 このオプションを指定できるのは、destination-typeがappの場合だけです。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --schedule,-s- イベントをトリガーする頻度を、crontab 形式でスケジュールします。 例えば、2 分間隔は
'*/2 * * * *'(文字列形式) と指定します。 デフォルトでは、cron イベントは 1 分間隔でトリガーされ、UTCタイム・ゾーンに設定されます。 タイム・ゾーンを変更するには、--time-zoneオプションを使用します。 この値はオプション です。 --time-zone,--tz- cron イベントのタイム・ゾーンを設定します (例:
Asia/Tokyo)。--scheduleオプションを指定した場合は、このオプションを使用してタイム・ゾーンを指定します。 有効なタイム・ゾーン値については、タイム・ゾーン・データベースを参照してください。 この値はオプション です。
例
以下の例では、mycronevent というジョブに cron イベントを 1 時間間隔で転送するように、myjob という cron ソース・サブスクリプションを更新します。
ibmcloud ce subscription cron update --name mycronevent --destination myjob --schedule '0 * * * *' --destination-type job
出力例
Updating cron source 'mycronevent'...
Run 'ibmcloud ce subscription cron get -n mycronevent' to check the cron source status.
OK
サブスクリプション kafka コマンド
分散環境では多くの場合、他のコンポーネント (通常、イベント・プロデューサーと呼ばれる) で生成されたメッセージ (イベント) に対応する処理をアプリケーションまたはジョブに行わせます。 Code Engine では、イベント・プロデューサーをサブスクライブすることで、アプリケーションまたはジョブが関心対象のイベントを受信できるようになります。 イベント情報は、アプリケーションについては POST HTTP 要求、ジョブについては環境変数として受信されます。
Kafka イベント・プロデューサーは、 Kafka インスタンスに新規メッセージが表示されるかどうかを監視します。 一連のトピックに対して Code Engine Kafka サブスクリプションを作成すると、アプリケーションまたはジョブは、いずれかのトピックに表示される新規メッセージごとに別個のイベントを受け取ります。
コマンドは、プロジェクトsubscription kafkaのコンテキスト内で使用する必要があります。
Kafka イベント・サブスクリプションの操作について詳しくは、 Kafka イベント・プロデューサーの操作 を参照してください。 Code Engine でのサブスクリプションの処理について詳しくは、サブスクリプションの概要 を参照してください。
subscription kafkaコマンドでは、subscriptionまたはsubのいずれかを使用できます。 subscription コマンドのCLIヘルプを見るには、 ibmcloud ce sub kafka -h を実行する。
ibmcloud ce subscription kafka create
Kafka イベント・サブスクリプションを作成します。
ibmcloud ce subscription kafka create --name KAFKA_SOURCE_NAME --destination DESTINATION_REF --topic TOPIC --broker BROKER [--consumer-group CONSUMER_GROUP] [--destination-type DESTINATION_TYPE] [--extension EXTENSION] [--force] [--no-wait] [--output OUTPUT] [--password PASSWORD] [--path PATH] [--quiet] [--secret SECRET] [--username USERNAME] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--broker,-b- Kafka ソースにブローカーを設定します。 ブローカーは、コンシューマーが接続する Kafka サーバーです。 このオプションは、複数回指定できます。 この値は必須です。
--destination,-d- イベントを受信するアプリケーション・リソースまたはジョブ・リソースの名前 (例えば、
myapp)。 必要に応じて、--pathオプションを使用してアプリの宛先をさらに限定します。 この値は必須です。 -n,--name- Kafka イベント・サブスクリプションの名前。 プロジェクト内で固有の名前を使用します。
- 名前の先頭と末尾は小文字の英数字でなければなりません。
- 名前は 253 文字以下でなければならず、使用できるのは小文字、数字、ピリオド (.)、ハイフン (-) です。
この値は必須です。
--topic,-t- Kafka ソースにトピックを設定します。 トピックは、コンシュームするメッセージをフィルターに掛けるために使用されます。 このオプションは、複数回指定できます。 この値は必須です。
--consumer-group,--cg- イベントのコンシューマー・グループの名前。 この値はオプション です。
--destination-type,--dtdestinationのタイプ。 有効な値はappおよびjobです。 この値はオプション です。 デフォルト値はappです。--extension,--ext- 宛先に送信する CloudEvents 拡張を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の CloudEvents 拡張を追加するか、または既存の CloudEvent 属性をオーバーライドします。--extensionオプション 1 つにつき 1 つの拡張を指定してください (例:--ext extA=A --ext extB=B)。 この値はオプション です。 --force,-f- Kafka イベントサブスクリプションを強制的に作成する。 このオプションは、指定された宛先と秘密の検証をスキップする。 この値はオプション です。 デフォルト値は
falseです。 --no-wait,--nw- Kafka イベントサブスクリプションを作成し、サブスクリプションの準備ができるのを待たないでください。
--no-waitオプションを指定した場合は、サブスクリプションの作成が開始され、待機は行われません。 サブスクリプションの状況を確認するには、subscription kafka getコマンドを使用してください。 この値はオプション です。 デフォルト値はfalseです。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --password,-p- Kafkaインスタンスへの認証に使用されるパスワード。
--passwordオプションを指定する場合は、--secretオプションを指定してはならない。 この値はオプション です。 --path- イベントの転送先とする、
destinationアプリケーション内のパス (例:/events)。 デフォルトのパスは、destinationアプリケーションのルート URL です。 このオプションを指定できるのは、destination-typeがappの場合だけです。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --secret,-s- Kafka インスタンスへの認証に使用され、
usernameとpasswordの両方のキーを含む秘密の名前。--secretオプションを指定する場合、--usernameまたは--passwordオプションを指定してはならない。 この値はオプション です。 --username,-u- Kafkaインスタンスへの認証に使用されるユーザー名。
--usernameオプションを指定する場合は、--passwordオプションを指定する必要があり、--secretオプションを指定してはならない。 この値はオプション です。 デフォルト値はtokenです。 --wait,-w- Kafka イベントサブスクリプションを作成し、サブスクリプションの準備ができるのを待つ。
--waitオプションを指定した場合、サブスクリプション作成コマンドは、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、サブスクリプションの準備完了を待機します。 サブスクリプションが指定された--wait-timeout期間内に準備できない場合、 Kafka イベントサブスクリプションの作成は失敗する。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- Kafka イベントサブスクリプションの準備ができるまでの待機時間(秒)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は120です。
例
以下の例では、 Kafka イベントを kafka-receiver-app という受信アプリに転送する、 mykafkaevent という Kafka イベント・サブスクリプションを作成します。 トピックのブローカーごとに --broker オプションを指定します。 --destination オプションは、イベントを受信する Code Engine リソースを指定します。
kafka-subscription-secret は、メッセージ・ブローカーにアクセスするための資格情報を提供します。
ibmcloud ce subscription kafka create --name mykafkasubscription --destination kafka-receiver-app --secret kafka-subscription-secret --topic kafka-topic1 --broker broker-3-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093 --broker broker-5-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093 --broker broker-0-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093 --broker broker-1-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093 --broker broker-4-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093 --broker broker-2-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
出力例
Creating Kafka event subscription 'mykafkasubscription'...
Run 'ibmcloud ce subscription kafka get -n mykafkasubscription' to check the Kafka event subscription status.
OK
ibmcloud ce subscription kafka delete
Kafka イベント・サブスクリプションを削除します。
ibmcloud ce subscription kafka delete --name KAFKA_SOURCE_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
コマンド・オプション
--name,-n- Kafka イベント・サブスクリプションの名前。 この値は必須です。
--force,-f- 確認なしで削除を強制します。 この値はオプション です。 デフォルト値は
falseです。 --ignore-not-found,--inf- 見つからなかった場合でも、失敗しません。 この値はオプション です。 デフォルト値は
falseです。 --no-wait,--nw- Kafka イベントサブスクリプションを削除し、サブスクリプションが削除されるのを待たないでください。
--no-waitオプションを指定した場合は、サブスクリプションの削除が開始され、待機は行われません。 サブスクリプションの状況を確認するには、subscription kafka getコマンドを使用してください。 この値はオプション です。 デフォルト値はfalseです。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --wait,-w- Kafka イベントサブスクリプションを削除し、サブスクリプションが削除されるのを待つ。
--waitオプションを指定した場合、サブスクリプション削除の際に、--wait-timeoutオプションで設定された最大時間 (秒単位) まで、サブスクリプションが削除されるのを待機します。 サブスクリプションが削除されるか、--wait-timeoutに達するか、どちらか早いほうの時点で、このコマンドは終了します。 この値はオプション です。 デフォルト値はtrueです。 --wait-timeout,--wto- Kafka イベントサブスクリプションが削除されるまでの待機時間(秒)。
--waitオプションを指定する場合、この値は必須です。--no-waitオプションを指定した場合、この値は無視されます。 デフォルト値は15です。
例
ibmcloud ce subscription kafka delete --name mykafkasubscription -f
出力例
Deleting Kafka event subscription 'mykafkasubscription'...
OK
ibmcloud ce subscription kafka get
Kafka イベント・サブスクリプションの詳細を表示します。
ibmcloud ce subscription kafka get --name KAFKA_SOURCE_NAME [--output OUTPUT] [--quiet]
コマンド・オプション
--name,-n- Kafka イベント・サブスクリプションの名前。 この値は必須です。
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce subscription kafka get --name mykafkasubscription
出力例
Getting Kafka event subscription 'mykafkasubscription'...
OK
Name: mykafkasubscription
[...]
Destination Type: app
Destination: kafka-receiver-app2
Brokers:
broker-3-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
broker-5-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
broker-0-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
broker-1-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
broker-4-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
broker-2-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
Consumer Group: knative-kafka-source-a4072fe1-1dfa-4470-9d07-bf7a0ff8e340
Topics:
kafka-topic1
Secret key reference (user): kafka-subscription-secret.username
Secret key reference (password): kafka-subscription-secret.password
Ready: true
Conditions:
Type OK Age Reason
ConnectionEstablished true 24s
InitialOffsetsCommitted true 24s
Ready true 24s
Scheduled true 24s
SinkProvided true 24s
Events:
Type Reason Age Source Messages
Normal FinalizerUpdate 26s kafkasource-controller Updated "mykafkasubscription" finalizers
Ready が true であるとき、 Kafka サブスクリプションは、指定されたスケジュールに従ってイベントをトリガーする準備ができている。
ibmcloud ce subscription kafka list
プロジェクト内のすべての Kafka イベント・サブスクリプションをリストします。
ibmcloud ce subscription kafka list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
コマンド・オプション
--output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --sort-by,-s- リストのソート基準とする列を指定します。 有効な値は
nameおよびageです。 この値はオプション です。 デフォルト値はnameです。
例
ibmcloud ce subscription kafka list
出力例
Listing Kafka event subscriptions...
OK
Name Age Ready Destination Type Destination Path Consumer Group Reason
mykafkasubscription 94s true app kafka-receiver-app knative-kafka-source-dc367965-15e4-44f3-bedf-25d453524a68
ibmcloud ce subscription kafka update
Kafka イベント・サブスクリプションを更新します。
ibmcloud ce subscription kafka update --name KAFKA_SOURCE_NAME [--broker BROKER] [--destination DESTINATION] [--destination-type DESTINATION_TYPE] [--extension EXTENSION] [--extension-rm EXTENSION_RM] [--output OUTPUT] [--password PASSWORD] [--path PATH] [--quiet] [--secret SECRET] [--topic TOPIC] [--username USERNAME]
コマンド・オプション
--name,-n- Kafka イベント・サブスクリプションの名前。 この値は必須です。
--broker,-b- Kafka ソースにブローカーを設定します。 ブローカーは、コンシューマーが接続する Kafka サーバーです。 このオプションは、複数回指定できます。 この値はオプション です。
--destination,-d- イベントを受信するアプリケーション・リソースまたはジョブ・リソースの名前 (例えば、
myapp)。 必要に応じて、--pathオプションを使用してアプリの宛先をさらに限定します。 この値はオプション です。 --destination-type,--dtdestinationのタイプ。 有効な値はappおよびjobです。 この値はオプション です。--extension,--ext- 宛先に送信する CloudEvents 拡張を設定します。 形式は
NAME=VALUEでなければなりません。 この操作は、新規の CloudEvents 拡張を追加するか、または既存の CloudEvent 属性をオーバーライドします。--extensionオプション 1 つにつき 1 つの拡張を指定してください (例:--ext extA=A --ext extB=B)。 この値はオプション です。 --extension-rm,--ext-rm- キーの名前を指定して、宛先に送信する CloudEvents 拡張を削除します。
--ext-rmオプション 1 つにつき 1 つの拡張を指定してください (例:--ext-rm extA --ext-rm extB)。 この値はオプション です。 --output,-o- コマンド出力のフォーマットを指定します。 有効な値は、
json、yaml、jsonpath=JSONPATH_EXPRESSION、およびjsonpath-as-json=JSONPATH_EXPRESSIONです。jsonpathを使用すると、JSON 出力のエレメントのパスを指定できます。 この値はオプション です。 --password,-p- Kafkaインスタンスへの認証に使用されるパスワード。
--passwordオプションを指定する場合は、--secretオプションを指定してはならない。 この値はオプション です。 --path- イベントの転送先とする、
destinationアプリケーション内のパス (例:/events)。 デフォルトのパスは、destinationアプリケーションのルート URL です。 このオプションを指定できるのは、destination-typeがappの場合だけです。 この値はオプション です。 --quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。 --secret,-s- Kafka インスタンスへの認証に使用され、
usernameとpasswordの両方のキーを含む秘密の名前。--secretオプションを指定する場合、--usernameまたは--passwordオプションを指定してはならない。 この値はオプション です。 --topic,-t- Kafka ソースにトピックを設定します。 トピックは、コンシュームするメッセージをフィルターに掛けるために使用されます。 このオプションは、複数回指定できます。 この値はオプション です。
--username,-u- Kafkaインスタンスへの認証に使用されるユーザー名。
--usernameオプションを指定する場合は、--passwordオプションを指定する必要があり、--secretオプションを指定してはならない。 この値はオプション です。 デフォルト値はtokenです。
例
以下の例では、 kafka-topic1 の代わりに kafka-topic2 を使用するように Kafka イベント・サブスクリプションを更新します。
ibmcloud ce subscription kafka update --name mykafkasubscription --topic kafka-topic2
出力例
Updating Kafka event subscription 'mykafkasubscription'...
Run 'ibmcloud ce subscription kafka get -n mykafkasubscription' to check the Kafka event subscription status.
OK
バージョンのコマンド
code-engine コマンド・ライン・インターフェースのバージョンを表示します。
ibmcloud ce version
code-engine コマンド・ライン・インターフェースのバージョンを表示します。
ibmcloud ce version [--quiet]
コマンド・オプション
--quiet,-q- このオプションは、コマンドの出力を減らす場合に指定します。 この値はオプション です。 デフォルト値は
falseです。
例
ibmcloud ce version
出力例
version: v1.17.0
commit: 3ab130b746f4784c9ff8d3da7bb05b6e7acda6d5