命令选项

--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

命令选项

-n, --name

应用程序的名称。 请使用项目中唯一的名称。

• 名称必须以小写字母开头。
• 名称必须以小写字母数字字符结尾。
• 名称不得超过 63 个字符，并且可以包含小写字母，数字和连字符 (-)。

此值为必填项。

--argument, --arg, -a

设置应用程序的自变量。 每个 --argument 选项指定一个自变量; 例如，-a argA -a argB。 此值将覆盖容器映像中指定的缺省值。 此值为可选项。

--build-commit, --commit, --bcm, --cm, --revision

要提取的源代码库中的提交、标记或分支。 仅当设置了 --build-source 选项时，才允许使用构建落实选项。 此值为可选项。

--build-context-dir, --context-dir, --bcdr, --cdr

存储库中包含 buildpack 文件或 Dockerfile 的目录。 仅当设置了 --build-source 选项时，才允许使用构建上下文目录选项。 此值为可选项。

--build-dockerfile, --dockerfile, --bdf, --df

Dockerfile 的路径。 仅当名称不是 Dockerfile 时才指定此选项。 仅当设置了 --build-source 选项时，才允许构建 dockerfile 选项。 此值为可选项。 默认值为 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 选项时，才允许使用构建策略选项。 如果未指定，那么构建策略由 Code Engine 确定 (如果指定了 --build-source 并且源位于本地机器上)。 此值为可选项。 默认值为 dockerfile。

--build-timeout, --bto

在构建必须成功或失败之前可以经过的时间量 (以秒为单位)。 仅当设置了 --build-source 选项时，才允许使用构建超时选项。 此值为可选项。 缺省值为 600。

--cluster-local, --cl

使用仅项目的端点部署应用程序。 设置项目专用端点意味着不能从公共互联网访问你的应用程序，只能从运行在同一项目中的其他 Code Engine 组件进行网络访问。 此值为可选项。 缺省值为 false。

--command, --cmd, -c

设置应用程序的命令。 每个 --command 选项指定一个命令; 例如，--cmd cmdA --cmd cmdB。 此值将覆盖在容器映像中指定的缺省命令。 此值为可选项。

--concurrency, --cn

每个实例可并行处理的最大请求数量。 此值为可选项。 缺省值为 100。

--concurrency-target, --ct

创建一个或多个附加实例的每个实例的并发请求阈值。 使用此值可根据并发请求数来扩展实例。 如果未指定 --concurrency-target，那么此选项缺省为 --concurrency 选项的值。 此值为可选项。 缺省值为 0。

--cpu

为应用程序实例设置的 CPU 数量。 有关有效值，请参阅 支持的内存和 CPU 组合。 此值为可选项。 缺省值为 1。

--env, -e

在应用程序中设置环境变量。 必须采用 NAME=VALUE 格式。 此操作将添加新的环境变量或覆盖现有环境变量。 每个 --env 选项指定一个环境变量; 例如，--env envA=A --env envB=B。 此值为可选项。

--env-cm, --env-from-configmap

使用下列其中一种方法从存储在此 configmap 中的“键/值”对设置环境变量:

• 要为名为 configmapName 的 configmap 中的所有键添加环境变量，请使用值 configmapName。 您可以通过在引用 configmap 时指定前缀来修改环境变量名称。 要指定前缀，请使用值 PREFIX=CONFIGMAP_NAME。 每个生成的环境变量都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，要将 configmap configmapName 中键的所有变量名称的前缀设置为 CUSTOM_，请使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，那么环境变量名称为 CUSTOM_KEY_A。
• 要为各个密钥添加环境变量，请使用格式 NAME:KEY_A,KEY_B。 例如，要在名为 configmapName 的 configmap 中为单个键 key1 添加环境变量，请使用值 configmapName:key1。 要对引用的密钥指定其他名称，请使用格式 NAME:NEW_NAME=KEY_A。 例如，要在名为 configmapName 的 configmap 中为单个键 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

请勿验证是否存在指定的 configmap 和私钥引用。 配置映射引用是使用 --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 选项，则需要使用 image 选项。 此值为可选项。

--max-scale, --max, --maxscale

可用于此应用程序的最大实例数。 如果将该值设置为 0，应用程序会根据需要进行缩放。 应用程序缩放仅受应用程序的项目的每个资源配额的实例限制。 请参阅 Code Engine的限制和配额。 此值为可选项。 默认值为 10。

--memory, -m

为应用程序实例设置的内存量。 使用 M 表示兆字节，使用 G 表示千兆字节。 有关有效值，请参阅 支持的内存和 CPU 组合。 此值为可选项。 默认值为 4G。

--min-scale, --min, --minscale

可用于此应用程序的最小实例数。 此选项对于确保不需要任何实例时都未在运行非常有用。 此值为可选项。 缺省值为 0。

--mount-configmap, --mount-cm

通过提供安装目录和 configmap 的名称 (格式为 MOUNT_DIRECTORY=CONFIGMAP_NAME)，将 configmap 的内容添加到应用程序容器的文件系统。 每个已安装的 configmap 都必须使用唯一的安装目录。 对于 configmap 中的每个键/值对，将向指定的安装目录添加一个文件，其中文件名是键，文件内容是键/值对的值。 每个 --mount-configmap 选项指定一个安装配置; 例如，--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值为可选项。

--mount-secret, --mount-sec

通过提供安装目录和私钥名称 (格式为 MOUNT_DIRECTORY=SECRET_NAME)，将私钥内容添加到应用程序容器的文件系统。 每个已安装的密钥都必须使用唯一的安装目录。 对于私钥中的每个“键/值”对，将向指定的安装目录添加一个文件，其中文件名是键，而文件的内容是“键/值”对的值。 每个 --mount-secret 选项指定一个安装配置; 例如，--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

应用程序侦听的端口。 格式为 [NAME:]PORT，其中 [NAME:] 是可选的。 如果指定了 [NAME:]，那么有效值为 h2c 或 http1。 如果未指定 [NAME:] 或为 http1，那么端口将使用 HTTP/1.1。 当 [NAME:] 为 h2c 时，端口使用未加密的 HTTP/2。 缺省情况下，Code Engine 假定应用程序侦听端口 8080 上的入局连接。 如果应用程序需要侦听端口 8080 以外的端口，请使用 --port 来指定端口。 此值为可选项。

--probe-live, --pl

为此应用程序配置 NAME=VALUE 格式的活动性探测器。 NAME 的有效选项包括: type，port，path，interval，initial-delay，timeout 和 failure-threshold。可以多次指定此选项。 type 属性是必需的，有效值为 tcp 和 http。 例如，--probe-live type=tcp --probe-live port=8080. 有关使用探测器的更多信息，有关使用探测器的更多信息，请参阅 为应用程序配置探测器。 此值为可选项。

--probe-ready, --pr

为此应用程序配置 NAME=VALUE 格式的就绪性探测器。 NAME 的有效选项包括: type，port，path，interval，initial-delay，timeout 和 failure-threshold。可以多次指定此选项。 type 属性是必需的，有效值为 tcp 和 http。 例如，--probe-ready type=tcp --probe-ready port=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

缺省帐户的名称。 服务帐户为在实例中运行的进程提供标识。 对于内置服务帐户，可以使用简短名称 manager，none，reader 和 writer。 您还可以使用以 Kubernetes Config Context 为前缀的全名，可以使用 project current 命令来确定这些全名。 此值为可选项。

--trusted-profiles-enabled, --trusted, --tpe

启用将计算资源标记挂载到此应用程序的容器。 此值为可选项。 缺省值为 false。

--user, -u

用于运行应用程序的用户标识 (UID)。 此值将覆盖在应用程序 Dockerfile 中设置的任何用户标识。 标识必须符合容器的操作系统需求。 此值为可选项。 缺省值为 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。

命令选项

--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'

命令选项

--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
    [...]

命令选项

--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.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

命令选项

--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

命令选项

--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/

命令选项

--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

命令选项

--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

命令选项

--name, -n

应用程序的名称。 此值为必填项。

--argument, --arg, -a

设置应用程序的自变量。 每个 --argument 选项指定一个自变量; 例如，-a argA -a argB。 此值为可选项。

--arguments-clear, --ac

清除应用程序参数。 此值为可选项。 缺省值为 false。

--build-clear, --bc

从该应用程序中除去构建的关联。 仅当应用程序当前具有关联的构建时，才允许使用构建清除选项。 此值为可选项。 缺省值为 false。

--build-commit, --commit, --bcm, --cm, --revision

要提取的源代码库中的提交、标记或分支。 只有在 --build-source 选项设置为 URL 的 Git 存储库的 app update 命令，或者您的应用程序当前有一个来自 Git 存储库源的关联构建时，才允许使用构建提交选项。 此值为可选项。

--build-commit-clear, --commit-clear, --bcmc, --cmc

清除要拉取的源存储库中的落实、标记或分支。 如果应用程序当前具有关联的构建，那么允许使用落实清除选项。 此值为可选项。 缺省值为 false。

--build-context-dir, --context-dir, --bcdr, --cdr

存储库中包含 buildpack 文件或 Dockerfile 的目录。 如果在此 app update 命令上设置了 --build-source 选项，或者应用程序当前具有关联的构建，那么允许使用构建上下文目录选项。 此值为可选项。

--build-dockerfile, --dockerfile, --bdf, --df

Dockerfile 的路径。 仅当名称不是 Dockerfile 时才指定此选项。 仅当在此 app update 命令上设置了 --build-source 选项，或者应用程序当前具有关联的构建时，才允许使用构建 dockerfile 选项。 此值为可选项。 默认值为 Dockerfile。

--build-git-repo-secret, --git-repo-secret, --bgrs, --grs, --repo

SSH 私钥的名称，其中包含用于访问专用存储库的凭证，该专用存储库包含用于构建容器映像的源代码。 要创建此 SSH 密钥，请使用 secret create --format SSH 命令。 SSH 私钥也用作 Git 存储库访问私钥。 仅当 --build-source 选项设置为 URL 的 Git 存储库的 application update 命令，或者您的应用程序当前具有来自 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 选项，或者应用程序当前具有关联的构建时，才允许使用构建策略选项。 如果未指定，那么构建策略由 Code Engine 确定 (如果指定了 --build-source 并且源位于本地机器上)。 此值为可选项。 默认值为 dockerfile。

--build-timeout, --bto

在构建必须成功或失败之前可以经过的时间量 (以秒为单位)。 仅当在此 app update 命令上设置了 --build-source 选项，或者应用程序当前具有关联的构建时，才允许使用构建超时选项。 此值为可选项。 缺省值为 600。

--cluster-local, --cl

使用仅项目的端点部署应用程序。 设置项目专用端点意味着不能从公共互联网访问你的应用程序，只能从运行在同一项目中的其他 Code Engine 组件进行网络访问。 此值为可选项。 缺省值为 false。

--command, --cmd, -c

设置应用程序的命令。 每个 --command 选项指定一个命令; 例如，--cmd cmdA --cmd cmdB。 此值将覆盖在容器映像中指定的缺省命令。 此值为可选项。

--commands-clear, --cc

清除应用程序命令。 此值为可选项。 缺省值为 false。

--concurrency, --cn

每个实例可并行处理的最大请求数量。 此值为可选项。 缺省值为 0。

--concurrency-target, --ct

创建一个或多个附加实例的每个实例的并发请求阈值。 使用此值可根据并发请求数来扩展实例。 如果未指定 --concurrency-target，那么此选项缺省为 --concurrency 选项的值。 此值为可选项。 缺省值为 0。

--cpu

为应用程序实例设置的 CPU 数量。 有关有效值，请参阅 支持的内存和 CPU 组合。 此值为可选项。 缺省值为 0。

--env, -e

在应用程序中设置环境变量。 必须采用 NAME=VALUE 格式。 此操作将添加新的环境变量或覆盖现有环境变量。 每个 --env 选项指定一个环境变量; 例如，--env envA=A --env envB=B。 此值为可选项。

--env-cm, --env-from-configmap

使用下列其中一种方法从存储在此 configmap 中的“键/值”对设置环境变量:

• 要为名为 configmapName 的 configmap 中的所有键添加环境变量，请使用值 configmapName。 您可以通过在引用 configmap 时指定前缀来修改环境变量名称。 要指定前缀，请使用值 PREFIX=CONFIGMAP_NAME。 每个生成的环境变量都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，要将 configmap configmapName 中键的所有变量名称的前缀设置为 CUSTOM_，请使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，那么环境变量名称为 CUSTOM_KEY_A。
• 要为各个密钥添加环境变量，请使用格式 NAME:KEY_A,KEY_B。 例如，要在名为 configmapName 的 configmap 中为单个键 key1 添加环境变量，请使用值 configmapName:key1。 要对引用的密钥指定其他名称，请使用格式 NAME:NEW_NAME=KEY_A。 例如，要在名为 configmapName 的 configmap 中为单个键 key1 添加名为 myKey 的环境变量，请使用值 configmapName:myKey=key1。

此值为可选项。

--env-from-configmap-rm, --env-cm-rm

使用 configmap 名称除去对完整 configmap 的环境变量引用。 要除去对 configmap 的个别密钥引用，请使用 --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

除去对 configmap 或 secret 中键/值对的键的环境变量引用。 要除去个别密钥引用和字面值，请指定密钥的名称。 可以多次指定此选项。 此值为可选项。

--ephemeral-storage, --es

要为应用程序实例设置的临时存储器量。 使用 M 表示兆字节，使用 G 表示千兆字节。 此值为可选项。

--force, -f

请勿验证是否存在指定的 configmap 和私钥引用。 配置映射引用是使用 --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

通过提供安装目录和 configmap 的名称 (格式为 MOUNT_DIRECTORY=CONFIGMAP_NAME)，将 configmap 的内容添加到应用程序容器的文件系统。 每个已安装的 configmap 都必须使用唯一的安装目录。 对于 configmap 中的每个键/值对，将向指定的安装目录添加一个文件，其中文件名是键，文件内容是键/值对的值。 每个 --mount-configmap 选项指定一个安装配置; 例如，--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值为可选项。

--mount-rm

通过指定安装 configmap 或 secret 的目录，从应用程序容器的文件系统中除去 configmap 或 secret 的内容。 每个 --mount-rm 选项指定一个安装目录; 例如，--mount-rm /etc/configmap-a --mount-rm /etc/secret-b。 此值为可选项。

--mount-secret, --mount-sec

通过提供安装目录和私钥名称 (格式为 MOUNT_DIRECTORY=SECRET_NAME)，将私钥内容添加到应用程序容器的文件系统。 每个已安装的密钥都必须使用唯一的安装目录。 对于私钥中的每个“键/值”对，将向指定的安装目录添加一个文件，其中文件名是键，而文件的内容是“键/值”对的值。 每个 --mount-secret 选项指定一个安装配置; 例如，--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

应用程序侦听的端口。 格式为 [NAME:]PORT，其中 [NAME:] 是可选的。 如果指定了 [NAME:]，那么有效值为 h2c 或 http1。 如果未指定 [NAME:] 或为 http1，那么端口将使用 HTTP/1.1。 当 [NAME:] 为 h2c 时，端口使用未加密的 HTTP/2。 缺省情况下，Code Engine 假定应用程序侦听端口 8080 上的入局连接。 如果应用程序需要侦听端口 8080 以外的端口，请使用 --port 来指定端口。 此值为可选项。

--probe-live, --pl

为此应用程序配置 NAME=VALUE 格式的活动性探测器。 NAME 的有效选项包括: type，port，path，interval，initial-delay，timeout 和 failure-threshold。可以多次指定此选项。 type 属性是必需的，有效值为 tcp 和 http。 例如，--probe-live type=tcp --probe-live port=8080. 有关使用探测器的更多信息，有关使用探测器的更多信息，请参阅 为应用程序配置探测器。 此值为可选项。

--probe-live-clear, --plr

除去活动性探测器。 仅当应用程序当前具有活动性探测器时，才允许使用此选项。 此值为可选项。 缺省值为 false。

--probe-ready, --pr

为此应用程序配置 NAME=VALUE 格式的就绪性探测器。 NAME 的有效选项包括: type，port，path，interval，initial-delay，timeout 和 failure-threshold。可以多次指定此选项。 type 属性是必需的，有效值为 tcp 和 http。 例如，--probe-ready type=tcp --probe-ready port=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

缺省帐户的名称。 服务帐户为在实例中运行的进程提供标识。 对于内置服务帐户，可以使用简短名称 manager，none，reader 和 writer。 您还可以使用以 Kubernetes Config Context 为前缀的全名，可以使用 project current 命令来确定这些全名。 此值为可选项。

--service-account-clear, --sac

清除服务帐户。 此值为可选项。 缺省值为 false。

--trusted-profiles-enabled, --trusted, --tpe

启用将计算资源标记挂载到此应用程序的容器。 此值为可选项。 缺省值为 false。

--user, -u

用于运行应用程序的用户标识 (UID)。 此值将覆盖在应用程序 Dockerfile 中设置的任何用户标识。 标识必须符合容器的操作系统需求。 此值为可选项。 缺省值为 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

命令选项

-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

存储库中包含 buildpack 文件或 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]。 例如，如果要使用运行时标识 nodejs-20 为函数构建代码束，请使用 codebundle-nodejs-20 作为构建策略。 您可以通过运行 ibmcloud ce fn runtimes 命令来查找任何受支持函数运行时的标识。 此值为可选项。 默认值为 dockerfile。

--timeout, --to

在构建必须成功或失败之前可以经过的时间量 (以秒为单位)。 此值为可选项。 缺省值为 600。

示例

以下示例从源 Dockerfile 创建名为 helloworld-build 的构建配置文件，该文件位于 main 分支的 hello 目录中的 https://github.com/IBM/CodeEngine 内，具有 dockerfile 策略和 medium 大小。 提交此构建时，所构建的容器映像将存储在 us.icr.io/mynamespace/codeengine-helloworld 上的 Container Registry 实例中，该实例可使用名为 myregistry 的映像注册表私钥进行访问。

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

命令选项

--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

命令选项

--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

命令选项

--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

命令选项

--name, -n

构建的名称。 此值为必填项。

--commit, --cm, --revision

要提取的源代码库中的提交、标记或分支。 此值为可选项。

--commit-clear, --cmc

清除要拉取的源存储库中的落实、标记或分支。 此值为可选项。 缺省值为 false。

--context-dir, --cdr

存储库中包含 buildpack 文件或 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]。 例如，如果要使用运行时标识 nodejs-20 为函数构建代码束，请使用 codebundle-nodejs-20 作为构建策略。 您可以通过运行 ibmcloud ce fn runtimes 命令来查找任何受支持函数运行时的标识。 此值为可选项。

--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

命令选项

--name, -n

构建运行的名称。 此值为必填项。

--quiet, -q

指定此选项以减少命令的输出。 此值为可选项。 缺省值为 false。

示例

ibmcloud ce buildrun cancel --name mybuildrun

示例输出

Cancelling build run 'mybuildrun'...
OK

命令选项

--build, -b

使用此选项可删除指定构建的所有构建运行。 如果未指定 --name 值，那么 --build 选项是必需的。 此值为可选项。

--force, -f

强制删除而不确认。 此值为可选项。 缺省值为 false。

--ignore-not-found, --inf

如果找不到，不让操作失败。 此值为可选项。 缺省值为 false。

--name, -n

构建运行的名称。 如果未指定 --build 值，那么 --name 选项是必需的。 此值为可选项。

--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

命令选项

--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

命令选项

--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

命令选项

--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

命令选项

--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"}}

命令选项

--build, -b, --bd

要使用的构建配置的名称。 此值为可选项。

--commit, --cm, --revision

要提取的源代码库中的提交、标记或分支。 如果 --source 选项设置为 Git 存储库的 URL，**如果 **--source 选项未设置为 Git 存储库的 URL。 此值为可选项。

--context-dir, --cdr

存储库中包含 buildpack 文件或 Dockerfile 的目录。 如果未设置 --build 选项，那么允许构建上下文目录选项; 如果设置了 --build 选项，那么 不 允许构建上下文目录选项。 此值为可选项。

--dockerfile, --df

Dockerfile 的路径。 仅当名称不是 Dockerfile 时才指定此选项。 如果未设置 --build 选项，那么允许构建 dockerfile 选项; 如果设置了 --build 选项，那么 不 允许构建 dockerfile 选项。 此值为可选项。 默认值为 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 选项，那么名称选项是必需的。

• 名称必须以小写字母数字字符开头和结尾。
• 名称不得超过 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

注册表私钥的名称。 下载容器映像时，注册表私钥用于向专用注册表进行认证。 如果未设置 --build 选项，那么允许使用注册表私钥选项; 如果设置了 --build 选项，那么 不 允许使用注册表私钥选项。 此值为可选项。

--service-account, --sa

缺省帐户的名称。 服务帐户为在实例中运行的进程提供标识。 对于内置服务帐户，可以使用简短名称 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]。 例如，如果要使用运行时标识 nodejs-20 为函数构建代码束，请使用 codebundle-nodejs-20 作为构建策略。 您可以通过运行 ibmcloud ce fn runtimes 命令来查找任何受支持函数运行时的标识。 如果未设置 --build 选项，那么允许使用构建策略选项; 如果设置了 --build 选项，那么 不 允许使用构建策略选项。 如果未指定，那么构建策略由 Code Engine 确定 (如果指定了 --source 并且源位于本地机器上)。 此值为可选项。 默认值为 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

命令选项

-n, --name

配置映射的名称。 请使用项目中唯一的名称。

• 名称必须以小写字母数字字符开头和结尾。
• 名称不得超过 253 个字符，并且可以包含小写字母，数字，句点 (.) 和连字符 (-)。

此值为必填项。

--from-env-file, -e

从包含与格式 KEY=VALUE 匹配的一行或多行的文件创建 configmap。 必须以值形式提供文件的路径。 指定文件中的每行都将添加为键/值对。 将忽略指定文件中的任何空行或以 # 开头的行。 如果未指定 --from-literal 或 --from-file，那么此值是必需的。

--from-file, -f

从文件创建配置图 必须以值形式提供文件的路径。 如果未指定 --from-literal 或 --from-env-file，那么此值是必需的。

--from-literal, -l

从键/值对创建 configmap。 必须采用 KEY=VALUE 格式。 如果未指定 --from-file 或 --from-env-file，那么此值是必需的。 可以多次指定此选项。

--output, -o

指定命令输出的格式。 有效值为 json，yaml，jsonpath=JSONPATH_EXPRESSION 和 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 来指定 JSON 输出元素的路径。 此值为可选项。

--quiet, -q

指定此选项以减少命令的输出。 此值为可选项。 缺省值为 false。

示例

以下示例创建名为 configmap-fromliteral 且具有两个密钥对值的 configmap: 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 示例

以下示例使用多个文件中的值创建名为 configmap-fromfile 的 configmap。

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.

命令选项

--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

命令选项

--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

命令选项

--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

命令选项

--name, -n

配置映射的名称。 此值为必填项。

--from-env-file, -e

从包含与格式 KEY=VALUE 匹配的一行或多行的文件更新 configmap。 必须以值形式提供文件的路径。 指定文件中的每行都将添加为键/值对。 将忽略指定文件中的任何空行或以 # 开头的行。 如果未指定 --from-literal 或 --from-file，那么此值是必需的。 可以多次指定此选项。

--from-file, -f

从文件更新 configmap。 必须以值形式提供文件的路径。 如果未指定 --from-literal 或 --from-env-file，那么此值是必需的。 可以多次指定此选项。

--from-literal, -l

从键/值对更新 configmap。 必须采用 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 中的单个键/值对。 可以多次指定此选项。 此值为可选项。

示例

以下示例使用用户名和密码值对更新名为 configmap-fromliteral 的 configmap。

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 示例

以下示例使用文件中的值更新名为 configmap-fromfile 的 configmap。

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.

示例

ibmcloud ce connectivity outbound create --cidr-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 delete --cidr-name allow-to-subnet-a

示例输出

Are you sure you want to delete an allowed destination IP address range 'allow-to-subnet-a'? [y/N]> y
Deleting allowed destination IP address range 'allow-to-subnet-a'...
OK

示例

ibmcloud ce connectivity outbound get --cidr-name allow-to-subnet-a

示例输出

Getting allowed destination IP address range 'allow-to-subnet-a'...
OK

Project Name:      project123
Name:              allow-to-subnet-a
IP address range:  5.6.7.8/29
Type:              cidr_block

示例

ibmcloud ce connectivity outbound list

示例输出

Name               Type        IP Address
allow-to-subnet-a  cidr_block  5.6.7.8/29
allow-to-subnet-b  cidr_block  11.12.13.0/24

示例

ibmcloud ce connectivity outbound update --cidr-name allow-to-subnet-a --cidr 5.6.7.0/27

示例输出

Updating allowed destination IP address range 'allow-to-subnet-a'...
OK

命令选项

--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.

命令选项

--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

命令选项

--domain-name, --dn, -n, --name

域映射的名称。此值为 required。

--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  

命令选项

--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 选项。

命令选项

--domain-name, --dn, -n, --name

域映射的名称。 此值为必填项。

--quiet, -q

指定此选项以减少命令的输出。 此值为可选项。 缺省值为 false。

--target, -t

目标应用程序或函数的名称。 此值为可选项。

--target-type, --type

目标的类型。 有效值为 application 或 function。 此值为可选项。

--tls-secret, --secret, --tls

指定包含证书（包括所有中间证书）和域映射相应私钥的 TLS 密钥。 证书必须由可信的公共认证中心 (CA) 签署。 不支持自签名证书。 此值为可选项。

示例

以下示例更新 www.example.com 域映射以使用 mytlssecret2 而不是 mytlssecret。

ibmcloud ce domainmapping update --domain-name www.example.com --tls-secret mytlssecret2

示例输出

Updating domainmapping 'www.example.com'...

示例

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.

命令选项

--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

命令选项

-n, --name

函数的名称。 请使用项目中唯一的名称。

• 名称必须以小写字母开头。
• 名称必须以小写字母数字字符结尾。
• 名称不得超过 63 个字符，并且可以包含小写字母，数字和连字符 (-)。

此值为必填项。

--runtime, -r

要用于函数的运行时。 要查找此区域的受支持运行时，请运行 ibmcloud ce function runtimes。 请参阅 运行时(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 选项指定一个环境变量; 例如，--env envA=A --env envB=B。 此值为可选项。

--env-cm, --env-from-configmap

使用下列其中一种方法从存储在此 configmap 中的“键/值”对设置环境变量。

• 要为名为 configmapName 的 configmap 中的所有键添加环境变量，请使用值 configmapName。 您可以通过在引用 configmap 时指定前缀来修改环境变量名称。 要指定前缀，请使用值 PREFIX=CONFIGMAP_NAME。 每个生成的环境变量都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，要将 configmap configmapName 中键的所有变量名称的前缀设置为 CUSTOM_，请使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，那么环境变量名称为 CUSTOM_KEY_A。
• 要为各个密钥添加环境变量，请使用格式 NAME:KEY_A,KEY_B。 例如，要在名为 configmapName 的 configmap 中为单个键 key1 添加环境变量，请使用值 configmapName:key1。 要对引用的密钥指定其他名称，请使用格式 NAME:NEW_NAME=KEY_A。 例如，要在名为 configmapName 的 configmap 中为单个键 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

请勿验证是否存在指定的 configmap 和私钥引用。 此值为可选项。 缺省值为 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-20

示例输出

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。

命令选项

--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

命令选项

--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()

命令选项

--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  

命令选项

--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  Optimized  
Node.js 20   nodejs-20    nodejs  true     true  
Python 3.11  python-3.11  python  true     true

命令选项

--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

命令选项

--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 选项指定一个环境变量; 例如，--env envA=A --env envB=B。 此值为可选项。

--env-cm, --env-from-configmap

使用下列其中一种方法从存储在此 configmap 中的“键/值”对设置环境变量:

• 要为名为 configmapName 的 configmap 中的所有键添加环境变量，请使用值 configmapName。 您可以通过在引用 configmap 时指定前缀来修改环境变量名称。 要指定前缀，请使用值 PREFIX=CONFIGMAP_NAME。 每个生成的环境变量都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，要将 configmap configmapName 中键的所有变量名称的前缀设置为 CUSTOM_，请使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，那么环境变量名称为 CUSTOM_KEY_A。
• 要为各个密钥添加环境变量，请使用格式 NAME:KEY_A,KEY_B。 例如，要在名为 configmapName 的 configmap 中为单个键 key1 添加环境变量，请使用值 configmapName:key1。 要对引用的密钥指定其他名称，请使用格式 NAME:NEW_NAME=KEY_A。 例如，要在名为 configmapName 的 configmap 中为单个键 key1 添加名为 myKey 的环境变量，请使用值 configmapName:myKey=key1。

此值为可选项。

--env-from-configmap-rm, --env-cm-rm

使用 configmap 名称除去对完整 configmap 的环境变量引用。 要除去对 configmap 的个别密钥引用，请使用 --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

除去对 configmap 或 secret 中键/值对的键的环境变量引用。 要除去个别密钥引用和字面值，请指定密钥的名称。 可以多次指定此选项。 此值为可选项。

--force, -f

请勿验证是否存在指定的 configmap 和私钥引用。 配置映射引用是使用 --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。 请参阅 运行时(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。

示例

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.

命令选项

--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

命令选项

-n, --name

作业的名称。 请使用项目中唯一的名称。

• 名称必须以小写字母数字字符开头和结尾。
• 名称不得超过 63 个字符，并且可以包含小写字母，数字和连字符 (-)。

此值为必填项。

--argument, --arg, -a

设置作业运行的参数。 每个 --argument 选项指定一个自变量; 例如，-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

指定用于作业运行的实例数。 使用此选项时，系统会将其转换为数组下标。 例如，如果指定 5 的 instances，系统会将其转换为 0 - 4 的 array-indices。 只有在未指定 --array-indices 选项时才能指定该选项。 此值为可选项。 缺省值为 1。

--build-commit, --commit, --bcm, --cm, --revision

要提取的源代码库中的提交、标记或分支。 只有在 --build-source 选项设置为 URL 的 Git 存储库时，构建提交选项才可用。 此值为可选项。

--build-context-dir, --context-dir, --bcdr, --cdr

存储库中包含 buildpack 文件或 Dockerfile 的目录。 仅当设置了 --build-source 选项时，才允许使用构建上下文目录选项。 此值为可选项。

--build-dockerfile, --dockerfile, --bdf, --df

Dockerfile 的路径。 仅当名称不是 Dockerfile 时才指定此选项。 仅当设置了 --build-source 选项时，才允许构建 dockerfile 选项。 此值为可选项。 默认值为 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 选项时，才允许使用构建策略选项。 如果未指定，那么构建策略由 Code Engine 确定 (如果指定了 --build-source 并且源位于本地机器上)。 此值为可选项。 默认值为 dockerfile。

--build-timeout, --bto

在构建必须成功或失败之前可以经过的时间量 (以秒为单位)。 仅当设置了 --build-source 选项时，才允许使用构建超时选项。 此值为可选项。 缺省值为 600。

--command, --cmd, -c

设置用于运行作业的命令。 每个 --command 选项指定一个命令; 例如，--cmd cmdA --cmd cmdB。 此值将覆盖在容器映像中指定的缺省命令。 此值为可选项。

--cpu

要为作业运行设置的 CPU 量。 有关有效值，请参阅 支持的内存和 CPU 组合。 此值为可选项。 缺省值为 1。

--env, -e

为作业的运行设置环境变量。 必须采用 NAME=VALUE 格式。 此操作将添加新的环境变量或覆盖现有环境变量。 每个 --env 选项指定一个环境变量; 例如，--env envA=A --env envB=B。 此值为可选项。

--env-cm, --env-from-configmap

使用下列其中一种方法从存储在此 configmap 中的“键/值”对设置环境变量:

• 要为名为 configmapName 的 configmap 中的所有键添加环境变量，请使用值 configmapName。 您可以通过在引用 configmap 时指定前缀来修改环境变量名称。 要指定前缀，请使用值 PREFIX=CONFIGMAP_NAME。 每个生成的环境变量都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，要将 configmap configmapName 中键的所有变量名称的前缀设置为 CUSTOM_，请使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，那么环境变量名称为 CUSTOM_KEY_A。
• 要为各个密钥添加环境变量，请使用格式 NAME:KEY_A,KEY_B。 例如，要在名为 configmapName 的 configmap 中为单个键 key1 添加环境变量，请使用值 configmapName:key1。 要对引用的密钥指定其他名称，请使用格式 NAME:NEW_NAME=KEY_A。 例如，要在名为 configmapName 的 configmap 中为单个键 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

请勿验证是否存在指定的 configmap 和私钥引用。 配置映射引用是使用 --env-from-configmap 选项指定的。 私钥引用是使用 --env-from-secret 或 --registry-secret 选项指定的。 此值为可选项。 缺省值是 false。

--image, -i

用于运行作业的映像的名称。 格式为 REGISTRY/NAMESPACE/REPOSITORY:TAG，其中 REGISTRY 和 TAG 为可选项。 如果未指定 REGISTRY，则默认为 docker.io。 如果未指定 TAG，则默认为 latest。 如果未指定 --build-source 选项，则需要使用 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-cm

通过提供安装目录和 configmap 的名称 (格式为 MOUNT_DIRECTORY=CONFIGMAP_NAME)，将 configmap 的内容添加到作业运行的文件系统。 每个已安装的 configmap 都必须使用唯一的安装目录。 对于 configmap 中的每个键/值对，将向指定的安装目录添加一个文件，其中文件名是键，文件内容是键/值对的值。 每个 --mount-configmap 选项指定一个安装配置; 例如，--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值为可选项。

--mount-secret, --mount-sec

通过提供安装目录和私钥名称 (格式为 MOUNT_DIRECTORY=SECRET_NAME)，将私钥内容添加到作业运行的文件系统。 每个已安装的密钥都必须使用唯一的安装目录。 对于私钥中的每个“键/值”对，将向指定的安装目录添加一个文件，其中文件名是键，而文件的内容是“键/值”对的值。 每个 --mount-secret 选项指定一个安装配置; 例如，--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b。 此值为可选项。

--no-wait, --nw

请不要等待构建运行完成。 如果指定 --no-wait 选项，那么构建运行将开始并且不会等待。 使用 buildrun get 命令来检查构建运行状态。 仅当设置了 --build-source 选项时，才允许使用 no-wait 选项。 此值为可选项。 缺省值是 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

缺省帐户的名称。 服务帐户为在实例中运行的进程提供标识。 对于内置服务帐户，可以使用简短名称 manager，none，reader 和 writer。 您还可以使用以 Kubernetes Config Context 为前缀的全名，可以使用 project current 命令来确定这些全名。 此值为可选项。

--trusted-profiles-enabled, --trusted, --tpe

为运行作业启用计算资源标记。 此值为可选项。 缺省值为 false。

--wait, -w

等待构建运行完成。 如果指定 --wait 选项，那么构建运行将等待 --wait-timeout 选项设置的最长时间 (以秒为单位)，以便构建运行完成。 如果未在指定的 --wait-timeout 时间段内完成构建运行，那么构建运行将失败。 仅当设置了 --build-source 选项时，才允许使用 wait 选项。 此值为可选项。 缺省值是 true。

--wait-timeout, --wto

等待构建运行完成的时间长度（以秒为单位）。 如果指定了 --wait 选项，那么此值是必需的。 如果指定了 --no-wait 选项，那么将忽略此值。 仅当设置了 --build-source 选项时，才允许使用 wait-timeout 选项。 缺省值为 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

命令选项

--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 命令以删除作业时，还会删除引用此作业的所有已提交作业运行。

命令选项

--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

命令选项

--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

命令选项

--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

命令选项

--name, -n

作业的名称。 此值为必填项。

--argument, --arg, -a

设置作业运行的参数。 每个 --argument 选项指定一个自变量; 例如，-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

指定用于作业运行的实例数。 使用此选项时，系统会将其转换为数组下标。 例如，如果指定 5 的 instances，系统会将其转换为 0 - 4 的 array-indices。 只有在未指定 --array-indices 选项时才能指定该选项。 此值为可选项。 缺省值为 0。

--build-clear, --bc

从该作业中除去构建的关联。 仅当作业当前具有关联的构建时，才允许使用构建清除选项。 此值为可选项。 缺省值为 false。

--build-commit, --commit, --bcm, --cm, --revision

要提取的源代码库中的提交、标记或分支。 只有在 --build-source 选项设置为 URL 的 Git 存储库的 job update 命令，或者您的工作当前有一个来自 Git 存储库源的关联构建时，才允许使用构建提交选项。 此值为可选项。

--build-commit-clear, --commit-clear, --bcmc, --cmc

清除要拉取的源存储库中的落实、标记或分支。 仅当作业当前具有关联的构建时，才允许使用落实清除选项。 此值为可选项。 缺省值为 false。

--build-context-dir, --context-dir, --bcdr, --cdr

存储库中包含 buildpack 文件或 Dockerfile 的目录。 仅当在此 job update 命令上设置了 --build-source 选项，或者作业当前具有关联的构建时，才允许使用构建上下文目录选项。 此值为可选项。

--build-dockerfile, --dockerfile, --bdf, --df

Dockerfile 的路径。 仅当名称不是 Dockerfile 时才指定此选项。 如果在此 job update 命令上设置了 --build-source 选项，或者您的作业当前具有关联的构建，那么允许使用构建 dockerfile 选项。 此值为可选项。 默认值为 Dockerfile。

--build-git-repo-secret, --git-repo-secret, --bgrs, --grs, --repo

SSH 私钥的名称，其中包含用于访问专用存储库的凭证，该专用存储库包含用于构建容器映像的源代码。 要创建此 SSH 密钥，请使用 secret create --format SSH 命令。 SSH 私钥也用作 Git 存储库访问私钥。 仅当 --build-source 选项设置为 URL 命令中 Git 存储库的 job update 时，或者您的工作当前具有来自 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 选项，或者您的作业当前具有关联的构建时，才允许使用构建策略选项。 如果未指定，那么构建策略由 Code Engine 确定 (如果指定了 --build-source 并且源位于本地机器上)。 此值为可选项。 默认值为 dockerfile。

--build-timeout, --bto

在构建必须成功或失败之前可以经过的时间量 (以秒为单位)。 仅当在此 job update 命令上设置了 --build-source 选项，或者作业当前具有关联的构建时，才允许使用构建超时选项。 此值为可选项。 缺省值为 600。

--command, --cmd, -c

设置用于运行作业的命令。 每个 --command 选项指定一个命令; 例如，--cmd cmdA --cmd cmdB。 此值将覆盖在容器映像中指定的缺省命令。 此值为可选项。

--commands-clear, --cc

清除作业命令。 此值为可选项。 缺省值为 false。

--cpu

要为作业运行设置的 CPU 量。 此值将更新在作业中分配的任何 --cpu 值。 有关有效值，请参阅 支持的内存和 CPU 组合。 此值为可选项。 默认值为 0。

--env, -e

为作业的运行设置环境变量。 必须采用 NAME=VALUE 格式。 此操作将添加新的环境变量或覆盖现有环境变量。 每个 --env 选项指定一个环境变量; 例如，--env envA=A --env envB=B。 此值为可选项。

--env-cm, --env-from-configmap

使用下列其中一种方法从存储在此 configmap 中的“键/值”对设置环境变量:

• 要为名为 configmapName 的 configmap 中的所有键添加环境变量，请使用值 configmapName。 您可以通过在引用 configmap 时指定前缀来修改环境变量名称。 要指定前缀，请使用值 PREFIX=CONFIGMAP_NAME。 每个生成的环境变量都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，要将 configmap configmapName 中键的所有变量名称的前缀设置为 CUSTOM_，请使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，那么环境变量名称为 CUSTOM_KEY_A。
• 要为各个密钥添加环境变量，请使用格式 NAME:KEY_A,KEY_B。 例如，要在名为 configmapName 的 configmap 中为单个键 key1 添加环境变量，请使用值 configmapName:key1。 要对引用的密钥指定其他名称，请使用格式 NAME:NEW_NAME=KEY_A。 例如，要在名为 configmapName 的 configmap 中为单个键 key1 添加名为 myKey 的环境变量，请使用值 configmapName:myKey=key1。

此值为可选项。

--env-from-configmap-rm, --env-cm-rm

使用 configmap 名称除去对完整 configmap 的环境变量引用。 要除去对 configmap 的个别密钥引用，请使用 --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

除去对 configmap 或 secret 中键/值对的键的环境变量引用。 要除去个别密钥引用和字面值，请指定密钥的名称。 可以多次指定此选项。 此值为可选项。

--ephemeral-storage, --es

为任务运行设置的短暂存储量。 使用 M 表示兆字节，使用 G 表示千兆字节。 此值为可选项。

--force, -f

请勿验证是否存在指定的 configmap 和私钥引用。 配置映射引用是使用 --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

通过提供安装目录和 configmap 的名称 (格式为 MOUNT_DIRECTORY=CONFIGMAP_NAME)，将 configmap 的内容添加到作业运行的文件系统。 每个已安装的 configmap 都必须使用唯一的安装目录。 对于 configmap 中的每个键/值对，将向指定的安装目录添加一个文件，其中文件名是键，文件内容是键/值对的值。 每个 --mount-configmap 选项指定一个安装配置; 例如，--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值为可选项。

--mount-rm

通过指定安装 configmap 或 secret 的目录，从作业运行的文件系统中除去 configmap 或 secret 的内容。 每个 --mount-rm 选项指定一个安装目录; 例如，--mount-rm /etc/configmap-a --mount-rm /etc/secret-b。 此值为可选项。

--mount-secret, --mount-sec

通过提供安装目录和私钥名称 (格式为 MOUNT_DIRECTORY=SECRET_NAME)，将私钥内容添加到作业运行的文件系统。 每个已安装的密钥都必须使用唯一的安装目录。 对于私钥中的每个“键/值”对，将向指定的安装目录添加一个文件，其中文件名是键，而文件的内容是“键/值”对的值。 每个 --mount-secret 选项指定一个安装配置; 例如，--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b。 此值为可选项。

--no-wait, --nw

请不要等待构建运行完成。 如果指定 --no-wait 选项，那么构建运行将开始并且不会等待。 使用 buildrun get 命令来检查构建运行状态。 仅当在此 job update 命令上设置了 --build-source 选项或者您的作业当前具有关联的构建时，才允许使用 no-wait 选项。 此值为可选项。 默认值为 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

缺省帐户的名称。 服务帐户为在实例中运行的进程提供标识。 对于内置服务帐户，可以使用简短名称 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 时间段内完成构建运行，那么构建运行将失败。 仅当在此 job update 命令上设置了 --build-source 选项或者您的作业当前具有关联的构建时，才允许使用 wait 选项。 此值为可选项。 缺省值是 true。

--wait-timeout, --wto

等待构建运行完成的时间长度（以秒为单位）。 如果指定了 --wait 选项，那么此值是必需的。 如果指定了 --no-wait 选项，那么将忽略此值。 如果在此 job update 命令上设置了 --build-source 选项，或者您的作业当前具有关联的构建，那么允许使用 wait-timeout 选项。 缺省值是 600。

示例

ibmcloud ce job update --name hellojob --cpu 2

示例输出

Updating job 'hellojob'...
OK

命令选项

--force, -f

强制删除而不确认。 此值为可选项。 缺省值为 false。

--ignore-not-found, --inf

如果找不到，不让操作失败。 此值为可选项。 缺省值为 false。

--job, -j

使用此选项可删除指定作业的所有作业运行。 如果未指定 --name 值，那么 --job 选项是必需的。 此值为可选项。

--name, -n

要删除的作业运行的名称。 如果未指定 --job 值，那么 --name 选项是必需的。 此值为可选项。

--quiet, -q

指定此选项以减少命令的输出。 此值为可选项。 缺省值为 false。

示例

ibmcloud ce jobrun delete --name myjobrun -f

示例输出

Deleting job run 'myjobrun'...
OK

命令选项

--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"

作业运行的指定实例的系统事件信息示例

您还可以通过将 --instance 选项与 ibmcloud ce jobrun events 命令配合使用来显示作业运行的指定实例的系统事件信息。 使用 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

命令选项

--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

命令选项

--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

列示的作业运行的名称指示作业运行的名称和作业运行的当前修订版。

命令选项

--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

命令选项

--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

命令选项

--jobrun, -j

此作业运行所基于的先前作业运行的名称。 此值为必填项。

--argument, --arg, -a

设置此作业运行的自变量。 每个 --argument 选项指定一个自变量; 例如，-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

指定用于此作业运行的实例数。 使用此选项时，系统会将其转换为数组下标。 例如，如果指定 5 的 instances，系统会将其转换为 0 - 4 的 array-indices。 只有在未指定 --array-indices 选项时才能指定该选项。 此值为可选项。 缺省值为 0。

--array-size-var-override, --array-size-variable-override, --asvo

为 JOB_ARRAY_SIZE 环境变量指定自定义值。 默认情况下，JOB_ARRAY_SIZE 环境变量设置为 array-size 值或 array-indices 指定的索引数。 JOB_ARRAY_SIZE 环境变量的值不会影响配置的数组大小。 使用此选项对仅提交或重新提交某些作业实例的作业重新运行方案实施常量数组大小值。 此值为可选项。

--command, --cmd, -c

设置此作业运行的命令。 每个 --command 选项指定一个命令; 例如，--cmd cmdA --cmd cmdB。 此值将覆盖在容器映像中指定的缺省命令。 此值为可选项。

--commands-clear, --cc

清除作业运行命令。 此值为可选项。 缺省值为 false。

--cpu

为此作业运行的每个阵列索引设置的 CPU 量。 有关有效值，请参阅 支持的内存和 CPU 组合。 此值为可选项。 缺省值为 0。

--env, -e

为此作业运行设置环境变量。 必须采用 NAME=VALUE 格式。 此操作将添加新的环境变量或覆盖现有环境变量。 每个 --env 选项指定一个环境变量; 例如，-e envA -e envB。 此值为可选项。

--env-cm, --env-from-configmap

使用下列其中一种方法从存储在此 configmap 中的“键/值”对设置环境变量:

• 要为名为 configmapName 的 configmap 中的所有键添加环境变量，请使用值 configmapName。 您可以通过在引用 configmap 时指定前缀来修改环境变量名称。 要指定前缀，请使用值 PREFIX=CONFIGMAP_NAME。 每个生成的环境变量都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，要将 configmap configmapName 中键的所有变量名称的前缀设置为 CUSTOM_，请使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，那么环境变量名称为 CUSTOM_KEY_A。
• 要为各个密钥添加环境变量，请使用格式 NAME:KEY_A,KEY_B。 例如，要在名为 configmapName 的 configmap 中为单个键 key1 添加环境变量，请使用值 configmapName:key1。 要对引用的密钥指定其他名称，请使用格式 NAME:NEW_NAME=KEY_A。 例如，要在名为 configmapName 的 configmap 中为单个键 key1 添加名为 myKey 的环境变量，请使用值 configmapName:myKey=key1。

此值为可选项。

--env-from-configmap-rm, --env-cm-rm

使用 configmap 名称除去对完整 configmap 的环境变量引用。 要除去对 configmap 的个别密钥引用，请使用 --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

除去对 configmap 或 secret 中键/值对的键的环境变量引用。 要除去个别密钥引用和字面值，请指定密钥的名称。 可以多次指定此选项。 此值为可选项。

--ephemeral-storage, --es

此作业运行的临时存储量。 使用 M 表示兆字节，使用 G 表示千兆字节。 此值为可选项。

--force, -f

请勿验证是否存在指定的 configmap 和私钥引用。 配置映射引用是使用 --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-cm

通过提供安装目录和 configmap 的名称 (格式为 MOUNT_DIRECTORY=CONFIGMAP_NAME)，将 configmap 的内容添加到此作业运行的文件系统。 每个已安装的 configmap 都必须使用唯一的安装目录。 对于 configmap 中的每个键/值对，将向指定的安装目录添加一个文件，其中文件名是键，文件内容是键/值对的值。 每个 --mount-configmap 选项指定一个安装配置; 例如，--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值为可选项。

--mount-rm

通过指定安装 configmap 或 secret 的目录，从此作业运行的文件系统中除去 configmap 或 secret 的内容。 每个 --mount-rm 选项指定一个安装目录; 例如，--mount-rm /etc/configmap-a --mount-rm /etc/secret-b。 此值为可选项。

--mount-secret, --mount-sec

通过提供安装目录和私钥名称 (格式为 MOUNT_DIRECTORY=SECRET_NAME)，将私钥的内容添加到此作业运行的文件系统。 每个已安装的密钥都必须使用唯一的安装目录。 对于私钥中的每个“键/值”对，将向指定的安装目录添加一个文件，其中文件名是键，而文件的内容是“键/值”对的值。 每个 --mount-secret 选项指定一个安装配置; 例如，--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

缺省帐户的名称。 服务帐户为在实例中运行的进程提供标识。 对于内置服务帐户，可以使用简短名称 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。

示例

以下示例重新运行实例 4-5 的 myjobrun 作业运行。 重新提交的作业运行的名称为 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

命令选项

--argument, --arg, -a

设置此作业运行的自变量。 每个 --argument 选项指定一个自变量; 例如，-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

指定用于此作业运行的实例数。 使用此选项时，系统会将其转换为数组下标。 例如，如果指定 5 的 instances，系统会将其转换为 0 - 4 的 array-indices。 只有在未指定 --array-indices 选项时才能指定该选项。 此值为可选项。 缺省值为 1。

--array-size-var-override, --array-size-variable-override, --asvo

为 JOB_ARRAY_SIZE 环境变量指定自定义值。 默认情况下，JOB_ARRAY_SIZE 环境变量设置为 array-size 值或 array-indices 指定的索引数。 JOB_ARRAY_SIZE 环境变量的值不会影响配置的数组大小。 使用此选项对仅提交或重新提交某些作业实例的作业重新运行方案实施常量数组大小值。 此值为可选项。

--command, --cmd, -c

设置此作业运行的命令。 每个 --command 选项指定一个命令; 例如，--cmd cmdA --cmd cmdB。 此值将覆盖在容器映像中指定的缺省命令。 此值为可选项。

--cpu

为此作业运行的每个阵列索引设置的 CPU 量。 有关有效值，请参阅 支持的内存和 CPU 组合。 此值为可选项。 缺省值为 1。

--env, -e

为此作业运行设置环境变量。 必须采用 NAME=VALUE 格式。 此操作将添加新的环境变量或覆盖现有环境变量。 每个 --env 选项指定一个环境变量; 例如，-e envA -e envB。 此值为可选项。

--env-cm, --env-from-configmap

使用下列其中一种方法从存储在此 configmap 中的“键/值”对设置环境变量:

• 要为名为 configmapName 的 configmap 中的所有键添加环境变量，请使用值 configmapName。 您可以通过在引用 configmap 时指定前缀来修改环境变量名称。 要指定前缀，请使用值 PREFIX=CONFIGMAP_NAME。 每个生成的环境变量都具有格式 <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>。 例如，要将 configmap configmapName 中键的所有变量名称的前缀设置为 CUSTOM_，请使用值 CUSTOM_=configmapName。 如果 configmap configmapName 包含 KEY_A，那么环境变量名称为 CUSTOM_KEY_A。
• 要为各个密钥添加环境变量，请使用格式 NAME:KEY_A,KEY_B。 例如，要在名为 configmapName 的 configmap 中为单个键 key1 添加环境变量，请使用值 configmapName:key1。 要对引用的密钥指定其他名称，请使用格式 NAME:NEW_NAME=KEY_A。 例如，要在名为 configmapName 的 configmap 中为单个键 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

请勿验证是否存在指定的 configmap 和私钥引用。 配置映射引用是使用 --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-cm

通过提供安装目录和 configmap 的名称 (格式为 MOUNT_DIRECTORY=CONFIGMAP_NAME)，将 configmap 的内容添加到此作业运行的文件系统。 每个已安装的 configmap 都必须使用唯一的安装目录。 对于 configmap 中的每个键/值对，将向指定的安装目录添加一个文件，其中文件名是键，文件内容是键/值对的值。 每个 --mount-configmap 选项指定一个安装配置; 例如，--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值为可选项。

--mount-secret, --mount-sec

通过提供安装目录和私钥名称 (格式为 MOUNT_DIRECTORY=SECRET_NAME)，将私钥的内容添加到此作业运行的文件系统。 每个已安装的密钥都必须使用唯一的安装目录。 对于私钥中的每个“键/值”对，将向指定的安装目录添加一个文件，其中文件名是键，而文件的内容是“键/值”对的值。 每个 --mount-secret 选项指定一个安装配置; 例如，--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

缺省帐户的名称。 服务帐户为在实例中运行的进程提供标识。 对于内置服务帐户，可以使用简短名称 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

命令选项

-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 选项指定一个标签; 例如，--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

命令选项

--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

命令选项

--force, -f

强制删除而不确认。 此值为可选项。 缺省值为 false。

--hard

立即删除项目。 如果未指定 --hard 选项，那么可以使用 project restore 或 reclamation restore 命令在 7 天内复原项目。 此值为可选项。 缺省值是 false。

--id, --guid

项目的标识。 如果未指定 --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

命令选项

--id, --guid

项目的标识。 如果未指定 --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

命令选项

--all-resource-groups, --all

显示所有资源组中的项目。 缺省情况下，仅显示当前资源组中的项目。 此值为可选项。 缺省值为 false。

--output, -o

指定命令输出的格式。 有效值为 json，yaml，jsonpath=JSONPATH_EXPRESSION 和 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 来指定 JSON 输出元素的路径。 此值为可选项。

--quiet, -q

指定此选项以减少命令的输出。 此值为可选项。 缺省值为 false。

--regions, -r

将项目的显示限制为指定区域。 提供一个或多个区域的名称; 例如，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

命令选项

--id, --guid

项目的标识。 如果未指定 --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。

示例

此示例将处于 soft deleted 状态的 myproject 项目复原为活动状态。 使用 project list 命令可显示所有项目及其状态的列表。

ibmcloud ce project restore --name myproject

示例输出

Restoring project 'myproject'...
OK

命令选项

--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

项目的标识。 如果未指定 --name，那么此值是必需的。

--kubecfg, -k

将项目附加到 Kubernetes 配置文件。 您可以通过设置 KUBECONFIG 环境变量来覆盖默认的 Kubernetes 配置文件。 此值为可选项。 缺省值为 false。

--name, -n

项目的名称。 如果未指定 --id，那么此值是必需的。

--quiet, -q

指定此选项以减少命令的输出。 此值为可选项。 缺省值为 false。

示例

ibmcloud ce project select --name myproject

示例输出

Selecting project 'myproject'...
OK

命令选项

--id, --guid

项目的标识。 如果未指定 --name，那么此值是必需的。

--name, -n

项目的名称。 如果未指定 --id，那么此值是必需的。

--quiet, -q

指定此选项以减少命令的输出。 此值为可选项。 缺省值为 false。

--tag, -t

要分配给项目的标签。 标签必须不超过 128 个字符，并且可以包含字母，数字，空格 ()，句点 (.)，冒号 (:)，下划线 (_) 和连字符 (-)。每个 --tag 选项指定一个标签; 例如，--tag tagA --tag tagB。 此值为可选项。

--tag-rm, --trm

除去分配给项目的标签。 每个 --tag-rm 选项指定一个标签; 例如，--tag-rm tagA --tag-rm tagB。 此值为可选项。

示例

ibmcloud ce project tag --name myproject --tag tag1 --tag tag2

示例输出

Getting project 'myproject'...
OK

命令选项

--binding-resource-group, --brg

用于本项目服务绑定身份验证的资源组名称。 为该资源组中的所有服务创建了一个服务 ID，其中包含 Operator 和 Manager 角色。 使用 "*" 来指定此帐户中的所有资源组。 此值为可选项。

--binding-resource-group-id, --brgid

要用于此项目的服务绑定进行认证的资源组的标识。 为该资源组中的所有服务创建了一个服务 ID，其中包含 Operator 和 Manager 角色。 此值为可选项。

--binding-service-id, --bsid

服务 ID 的 ID，用于对本项目的服务绑定进行身份验证。 此服务标识必须具有 Operator 角色以及一个或多个服务实例，服务类型或资源组的相应服务角色。 此值为可选项。

--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

命令选项

--force, -f

强制删除而不确认。 此值为可选项。 缺省值为 false。

--id, --guid

项目的标识。 如果未指定 --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。

示例

此示例永久删除处于 soft deleted 状态的 myproject 项目。 通过将 --force 选项与此命令配合使用，将强制删除而不进行确认。 您可以使用 reclamation list 命令来显示处于 soft deleted 状态的所有项目的列表。

ibmcloud ce reclamation delete --name myproject --f

示例输出

Hard deleting project 'myproject'...
OK

命令选项

--id, --guid

项目的标识。 如果未指定 --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

命令选项

--all-resource-groups, --all

显示来自所有资源组的项目回收。 缺省情况下，仅显示当前资源组中的项目回收。 此值为可选项。 缺省值为 false。

--output, -o

指定命令输出的格式。 有效值为 json，yaml，jsonpath=JSONPATH_EXPRESSION 和 jsonpath-as-json=JSONPATH_EXPRESSION。 使用 jsonpath 来指定 JSON 输出元素的路径。 此值为可选项。

--quiet, -q

指定此选项以减少命令的输出。 此值为可选项。 缺省值为 false。

--regions, -r

将项目回收的显示限制为指定区域。 提供一个或多个区域的名称; 例如，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

命令选项

--id, --guid

项目的标识。 如果未指定 --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。

示例

此示例将处于 soft deleted 状态的 myproject 项目复原为活动状态。 使用 reclamation list 命令可显示处于 soft deleted 状态的所有项目的列表。

ibmcloud ce reclamation restore --name myproject

示例输出

Restoring project 'myproject'...
OK

命令选项

-n, --name

图像注册表访问秘密的名称。 请使用项目中唯一的名称。

• 名称必须以小写字母数字字符开头和结尾。
• 名称不得超过 253 个字符，并且可以包含小写字母，数字，句点 (.) 和连字符 (-)。

此值为必填项。

--email, -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 的映像注册表访问位于 us.icr.io 的 Container Registry 实例，并使用用户名 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

命令选项

--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

命令选项

--name, -n

图像注册表访问秘密的名称。 此值为必填项。

--decode, -d

在详细信息中显示已解码的 Data 输出。 如果未指定此选项，那么 Data 详细信息为 base64-encoded。 此值为可选项。 缺省值为 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==

命令选项

--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

命令选项

--name, -n

图像注册表访问秘密的名称。 此值为必填项。

--email, -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

命令选项

--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

命令选项

--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

命令选项

--name, -n

Git 资源库访问秘密的名称。 此值为必填项。

--decode, -d

在详细信息中显示已解码的 Data 输出。 如果未指定此选项，那么 Data 详细信息为 base64-encoded。 此值为可选项。 缺省值为 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
...

命令选项

--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  

命令选项

--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

命令选项

--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

命令选项

--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

命令选项

--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

命令选项

--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

命令选项

--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

命令选项

--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

用于访问注册表服务器以获取注册表私钥的电子邮件地址。 此值仅适用于 registry 私钥。 此值为可选项。

--format, --fo

私钥的格式。 有效值为 basic_auth, generic, hmac, registry, ssh 或 tls。 此值为可选项。 缺省值为 generic。

--from-env-file, -e

从包含与格式 KEY=VALUE 匹配的一行或多行的文件创建通用密钥。 必须以值形式提供文件的路径。 指定文件中的每行都将添加为键/值对。 将忽略指定文件中的任何空行或以 # 开头的行。 如果未指定 --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 私钥的已知主机文件的路径。 此值是一项安全功能，用于确保专用密钥仅用于在您先前访问的主机 (尤其是 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, --pkf

使用 cert-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 私钥需要此选项。 此值为可选项。

基本认证密钥的示例

基本认证密钥包含一个 username 和 password 密钥，当您访问需要基本 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 值。 如果命令或 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 的凭证。