IBM Cloud Code Engine CLI
运行这些命令可管理构成 IBM Cloud® Code Engine 的实体。 有关 Code Engine 的更多信息,请参阅 Code Engine 入门。
要运行 IBM Cloud Code Engine 命令,请使用 ibmcloud code-engine 或 ibmcloud ce。
先决条件
-
安装 IBM Cloud CLI。
-
运行以下命令安装 Code Engine CLI:
ibmcloud plugin install code-engine
应用命令
应用程序或应用程序运行您的代码,为 HTTP 请求提供服务。 除了传统的 HTTP 请求外,IBM Cloud® Code Engine 还支持使用 WebSockets 作为通信协议的应用程序。 应用程序运行实例的数量会根据接收到的请求和您的配置设置自动增加或减少(至零)。 一个应用程序包含一个或多个修订版。 修订版代表应用程序配置属性的不可更改版本。 每次更新应用程序配置属性都会创建一个新的应用程序版本。
在使用 application 命令之前,您必须处于 项目 的上下文环境中。
有关使用应用程序的更多信息,请参阅 部署应用程序。
您可以在 application 命令中使用 application 或 app。 要查看 application 命令的 CLI 帮助,请运行 ibmcloud ce app -h。
要管理应用程序修订版,请参阅 ibmcloud ce revision 命令。
ibmcloud ce application bind
将 IBM Cloud 服务实例绑定到应用程序。
ibmcloud ce application bind --name APP_NAME (--service-instance SI_NAME | --service-instance-id SI_ID) [--no-wait] [--prefix PREFIX] [--quiet] [--role ROLE] [--service-credential SERVICE_CREDENTIAL] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--name,-n- 要绑定的应用程序名称。 此值为必填项。
--no-wait,--nw- 绑定服务实例,不要等待服务绑定准备就绪。 如果指定
no-wait选项,服务绑定创建将启动,命令无需等待完成即可退出。 使用app get命令检查应用程序绑定状态。 此值为可选项。 缺省值为false。 --prefix,-p- 为此服务绑定创建的环境变量的前缀。 必须只包含大写字母、数字和下划线 (_),并且不能以数字开头。 此值为可选项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --role,-r- 为该服务绑定创建的新服务凭证的服务角色名称。 有效值包括
Reader,Writer,Manager或特定于服务的角色。 该选项默认为Manager,如果不支持Manager,则默认为服务提供的第一个角色。 如果指定了--service-credential,该选项将被忽略。 此值为可选项。 --service-credential,--sc- 要用于此服务绑定的现有服务凭证的名称。 如果未指定服务实例凭据,则会在绑定操作期间生成新凭据。 此值为可选项。
--service-instance,--si- 要绑定到应用程序的现有 IBM Cloud 服务实例的名称。 此值为可选项。
--service-instance-id,--siid- 要绑定到应用程序的现有 IBM Cloud 服务实例的 GUID。 此值为可选项。
--wait,-w- 绑定服务实例,等待服务绑定就绪。 如果指定了
--wait选项,应用程序绑定会等待--wait-timeout选项设定的最长秒数,等待应用程序绑定成功完成。 如果应用程序绑定在指定的--wait-timeout时间内未成功完成或失败,则命令失败。 此值为可选项。 缺省值是true。 --wait-timeout,--wto- 等待服务绑定就绪的时间长度(秒)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为300。
示例
在本例中,将名为 my-object-storage 的 IBM Cloud Object Storage 服务实例与名为 myapp 的应用程序绑定。
ibmcloud ce application bind --name myapp --service-instance my-object-storage
示例输出
Binding service instance...
Waiting for service binding to become ready...
Status: Pending (Processing Resource)
Status: Pending (Processing Resource)
Status: Creating service binding
Status: Creating service binding
Status: Ready
Waiting for application revision to become ready...
Traffic is not yet migrated to the latest revision.
Ingress has not yet been reconciled.
Waiting for load balancer to be ready
OK
ibmcloud ce application create
创建应用程序。
ibmcloud ce application create --name APP_NAME ((--image IMAGE_REF | (--build-source SOURCE [--image IMAGE_REF])) [--argument ARGUMENT] [--build-commit BUILD_COMMIT] [--build-context-dir BUILD_CONTEXT_DIR] [--build-dockerfile BUILD_DOCKERFILE] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-size BUILD_SIZE] [--build-strategy BUILD_STRATEGY] [--build-timeout BUILD_TIMEOUT] [--cluster-local] [--command COMMAND] [--concurrency CONCURRENCY] [--concurrency-target CONCURRENCY_TARGET] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--max-scale MAX_SCALE] [--memory MEMORY] [--min-scale MIN_SCALE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-secret MOUNT_SECRET] [--no-cluster-local] [--no-wait] [--output OUTPUT] [--port PORT] [--probe-live PROBE_LIVE] [--probe-ready PROBE_READY] [--quiet] [--registry-secret REGISTRY_SECRET] [--request-timeout REQUEST_TIMEOUT] [--revision-name REVISION_NAME] [--scale-down-delay SCALE_DOWN_DELAY] [--service-account SERVICE_ACCOUNT] [--trusted-profiles-enabled] [--user USER] [--visibility VISIBILITY] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
-n,--name- 应用程序的名称。 请使用项目中唯一的名称。
- 名称必须以小写字母开头。
- 名称必须以小写字母数字字符结尾。
- 名称必须少于或等于 63 个字符,可包含小写字母、数字和连字符 (-)。
此值为必填项。
--argument,--arg,-a- 为应用程序设置参数。 每个
--argument选项指定一个参数;例如,-a argA -a argB。 该值会覆盖容器映像中指定的默认值。 此值为可选项。 --build-commit,--commit,--bcm,--cm,--revision- 要提取的源代码库中的提交、标记或分支。 只有设置了
--build-source选项,才允许使用构建提交选项。 此值为可选项。 --build-context-dir,--context-dir,--bcdr,--cdr- 版本库中包含 buildpacks 文件或 Dockerfile 的目录。 只有设置了
--build-source选项,才允许使用构建上下文目录选项。 此值为可选项。 --build-dockerfile,--dockerfile,--bdf,--df- Dockerfile 的路径。 只有当名称不是
Dockerfile时才指定该选项。 只有设置了--build-source选项,才允许使用 build dockerfile 选项。 此值为可选项。 默认值为Dockerfile。 --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- SSH 私钥的名称,其中包含用于访问专用存储库的凭证,该专用存储库包含用于构建容器映像的源代码。 要创建此 SSH 秘密,请使用
secret create --format SSH命令。 SSH 密文也可用作 Git 存储库访问密文。 只有当--build-source选项设置为 Git 资源库的 URL 时,才允许使用该选项。 此值为可选项。 --build-size,--size,--bsz,--sz- 构建的大小,它决定了使用的资源量。 有效值为
small,medium,large,xlarge和xxlarge。 有关详情,请参阅 确定构建大小。 只有设置了--build-source选项,才允许使用构建大小选项。 此值为可选项。 缺省值为medium。 --build-source,--source,--bsrc,--src- Git 源的 URL 或包含源代码的本地源的路径;例如
https://github.com/IBM/CodeEngine或.。 此值为可选项。 --build-strategy,--strategy,--bstr,--str- 用于构建映像的策略。 有效值为
dockerfile和buildpacks。 只有设置了--build-source选项,才允许使用构建策略选项。 如果未指定,则在指定--build-source且源代码位于本地计算机上时,由 Code Engine 决定构建策略。 此值为可选项。 默认值为dockerfile。 --build-timeout,--bto- 在构建成功或失败之前可能经过的时间(以秒为单位)。 只有设置了
--build-source选项,才允许使用构建超时选项。 此值为可选项。 缺省值为600。 --cluster-local,--cl- 使用仅项目的端点部署应用程序。 设置项目专用端点意味着不能从公共互联网访问你的应用程序,只能从同一项目中运行的其他 Code Engine 组件进行网络访问。 此值为可选项。 缺省值为
false。 --command,--cmd,-c- 为应用程序设置命令。 每个
--command选项指定一条命令;例如,--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- 使用以下方法之一,根据存储在此配置映射中的键值对设置环境变量:
- 要为名为
configmapName的配置映射中的所有键添加环境变量,请使用configmapName。 您可以在引用 configmap 时通过指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=CONFIGMAP_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. 例如,要将配置映射configmapName中所有键的变量名前缀设置为CUSTOM_,请使用值CUSTOM_=configmapName。 如果配置映射configmapName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为configmapName的配置映射中为单键key1添加环境变量,请使用configmapName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为configmapName的配置映射中为单键key1添加名为myKey的环境变量,请使用值configmapName:myKey=key1。
此值为可选项。
--env-sec,--env-from-secret- 使用以下方法之一,根据存储在秘密中的键值对设置环境变量:
- 要为名为
secretName的秘密中的所有密钥添加环境变量,请使用secretName。 您可以通过在引用秘密时指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=SECRET_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,要将密文secretName中所有密钥变量名的前缀设置为CUSTOM_,请使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为secretName的密钥中为单个密钥key1添加环境变量,请使用secretName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为secretName的密文中为单个密钥key1添加名为myKey的环境变量,请使用secretName:myKey=key1。
此值为可选项。
--ephemeral-storage,--es- 要为应用程序实例设置的临时存储器量。 使用
M表示兆字节,使用G表示千兆字节。 此值为可选项。 缺省值为400M。 --force,-f- 不验证指定的 configmap 和秘密引用是否存在。 使用
--env-from-configmap或--mount-configmap选项可指定 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- 通过提供挂载目录和配置映射名称,将配置映射的内容添加到应用容器的文件系统中,格式为
MOUNT_DIRECTORY=CONFIGMAP_NAME. 每个挂载的 configmap 必须使用唯一的挂载目录。 对于配置映射中的每个键值对,都会在指定的挂载目录中添加一个文件,文件名是键,文件内容是键值对的值。 每个--mount-configmap选项指定一个挂载配置;例如,--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值为可选项。 --mount-data-store,--mount-ds- 挂载持久数据存储。 格式为 MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]。 SUBPATH 是可选项。 可以多次指定此选项。 此值为可选项。
--mount-secret,--mount-sec- 通过提供挂载目录和秘密名称,将秘密内容添加到应用容器的文件系统中,格式为
MOUNT_DIRECTORY=SECRET_NAME. 每个挂载的秘密必须使用唯一的挂载目录。 对于密文中的每个键值对,都会在指定的挂载目录中添加一个文件,文件名就是键,文件内容就是键值对的值。 每个--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- 用于运行应用程序的用户 ID(UID)。 该值会覆盖应用程序 Dockerfile 中设置的任何用户 ID。 ID 必须符合容器的操作系统要求。 此值为可选项。 缺省值为
0。 --visibility,-v- 应用程序的可视性。 有效值为
public,private,和project。 将可见性设置为public意味着您的应用程序可以接收来自公共互联网或 Code Engine 项目内组件的请求。 将可见性设置为private意味着您的应用程序无法从公共互联网访问,只能从使用虚拟专用端点(VPE)的其他 IBM Cloud 或运行在同一项目中的 Code Engine 组件进行网络访问。 只有当项目支持应用程序私有可见性时,可见性才能被private。 将可见性设置为project意味着您的应用程序不能从公共互联网访问,只能从同一项目中运行的其他 Code Engine 组件进行网络访问。 此值为可选项。 --wait,-w- 创建应用程序,等待应用程序准备就绪。 如果指定
--wait选项,创建的应用程序将等待由--wait-timeout选项设定的最长秒数,以便应用程序准备就绪。 如果应用程序未在指定的wait-timeout时间内准备就绪,则应用程序创建失败。 此值为可选项。 缺省值是true。 --wait-timeout,--wto- 等待应用程序准备就绪的时间长度(秒)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为600。
示例
ibmcloud ce application create --name myapp --image icr.io/codeengine/hello
示例输出
Creating application 'myapp'...
[...]
Run `ibmcloud ce application get -n 'myapp'` to check the application status.
OK
https://myapp.4svg40kna19.us-south.codeengine.appdomain.cloud
运行 ibmcloud ce application get -n 'myapp' 检查应用程序状态时,会显示应用程序的 URL。
ibmcloud ce application delete
删除应用程序。
ibmcloud ce application delete --name APPLICATION_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--name,-n- 应用程序的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --no-wait,--nw- 删除应用程序,不要等待应用程序被删除。 如果指定
no-wait选项,则程序删除开始,不需要等待。 使用app get命令检查应用程序状态。 此值为可选项。 缺省值为true。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --wait,-w- 删除应用程序,等待应用程序被删除。 如果指定
--wait选项,应用程序删除会等待--wait-timeout选项设定的最长秒数,应用程序才会被删除。 如果在指定的--wait-timeout时间内未删除应用程序,则应用程序删除失败。 此值为可选项。 缺省值是false。 --wait-timeout,--wto- 等待删除应用程序的时间长度(秒)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为600。
示例
ibmcloud ce application delete --name myapp -f
示例输出
Deleted application 'myapp'
ibmcloud ce application events
显示应用程序实例的系统事件。 系统事件最多保留 60 分钟。
ibmcloud ce application events (--instance APP_INSTANCE | --application APP_NAME) [--output OUTPUT] [--quiet]
命令选项
--application,--app,-a,--name,-n- 显示指定应用程序所有实例的事件。 如果未指定
--instance,则必须使用该值。 --instance,-i- 特定应用程序实例的名称。 使用
app get命令查找实例名称。 如果未指定--application,则必须使用该值。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
下面的示例显示了指定应用程序所有实例的系统事件信息。
ibmcloud ce application events --application myapp
示例输出
Getting events for all instances of application 'myapp'...
OK
myapp-atfte-1-deployment-6b49c5fb85-kf4m2:
Type Reason Age Source Messages
Normal Scheduled 31s default-scheduler Successfully assigned 4svg40kna19/myapp-atfte-1-deployment-6b49c5fb85-kf4m2 to 10.240.0.15
Normal Pulling 29s kubelet, 10.240.0.15 Pulling image "icr.io/codeengine/hello@sha256:f0dc03250736a7b40a66ee70fee94fc470e08c864197aa2140054fee6ca9f9d6"
Normal Pulled 24s kubelet, 10.240.0.15 Successfully pulled image "icr.io/codeengine/hello@sha256:f0dc03250736a7b40a66ee70fee94fc470e08c864197aa2140054fee6ca9f9d6" in 4.907426108s
Normal Created 24s kubelet, 10.240.0.15 Created container user-container
Normal Started 24s kubelet, 10.240.0.15 Started container user-container
Normal Pulled 24s kubelet, 10.240.0.15 Container image "icr.io/obs/codeengine/knative-serving/queue-39be6f1d08a095bd076a71d288d295b6:v0.20.0-rc1@sha256:8988bea781130827b3e1006e6e5e7f49094343a5505c1927bb832be3470455f6" already present on machine
Normal Created 23s kubelet, 10.240.0.15 Created container queue-proxy
Normal Started 23s kubelet, 10.240.0.15 Started container queue-proxy
应用程序指定实例的系统事件信息示例
以下示例显示应用程序指定实例的系统事件信息。 使用 app get 命令显示应用程序的详细信息,包括正在运行的应用程序实例。
ibmcloud ce application events --instance myapp-li17x-1-deployment-69fd57bcb6-sr9tl
应用程序指定实例的系统事件信息输出示例
Getting events for application instance 'myapp-li17x-1-deployment-69fd57bcb6-sr9tl'...
OK
myapp-li17x-1-deployment-69fd57bcb6-sr9tl:
Type Reason Age Source Messages
Normal Scheduled 6m40s default-scheduler Successfully assigned 4svg40kna19/myapp-li17x-1-deployment-69fd57bcb6-sr9tl to 10.240.64.6
Normal Pulling 6m39s kubelet, 10.240.64.6 Pulling image "icr.io/codeengine/hello@sha256:f0dc03250736a7b40a66ee70fee94fc470e08c864197aa2140054fee6ca9f9d6"
Normal Pulled 6m36s kubelet, 10.240.64.6 Successfully pulled image "icr.io/codeengine/hello@sha256:f0dc03250736a7b40a66ee70fee94fc470e08c864197aa2140054fee6ca9f9d6"
Normal Created 6m34s kubelet, 10.240.64.6 Created container user-container
Normal Started 6m33s kubelet, 10.240.64.6 Started container user-container
Normal Pulled 6m33s kubelet, 10.240.64.6 Container image "icr.io/obs/codeengine/knative-serving/queue-39be6f1d08a095bd076a71d288d295b6:v0.19.0-rc3@sha256:9cb525af53896afa6b5210b5ac56a893cf85b6cd013a61cb6503a005e40c5c6f" already present on machine
Normal Created 6m33s kubelet, 10.240.64.6 Created container queue-proxy
Normal Started 6m32s kubelet, 10.240.64.6 Started container queue-proxy
[...]
ibmcloud ce application get
显示应用程序的详细信息。
ibmcloud ce application get --name APPLICATION_NAME [--output OUTPUT] [--quiet] [--show-all-revisions]
命令选项
--name,-n- 应用程序的名称。 此值为必填项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,jsonpath-as-json=JSONPATH_EXPRESSION,url和project-url。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --show-all-revisions,-r- 显示此申请的所有修订。 如果未指定,则只显示配置为接收流量的修订。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce application get --name myapp
示例输出
Run 'ibmcloud ce application events -n myapp' to get the system events of the application instances.
Run 'ibmcloud ce application logs -f -n myapp' to follow the logs of the application instances.
OK
Name: myapp
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 31m
Created: 2021-09-09T14:01:02-04:00
URL: https://myapp.abcdabcdabc.us-south.codeengine.appdomain.cloud
Cluster Local URL: http://myapp.abcdabcdabc.svc.cluster.local
Console URL: https://cloud.ibm.com/codeengine/project/us-south/01234567-abcd-abcd-abcd-abcdabcd1111/application/myapp/configuration
Status Summary: Application deployed successfully
Environment Variables:
Type Name Value
Literal CE_API_BASE_URL https://api.private.us-south.codeengine.cloud.ibm.com
Literal CE_APP myapp
Literal CE_DOMAIN us-south.codeengine.appdomain.cloud
Literal CE_PROJECT_ID abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Literal CE_REGION us-south
Literal CE_SUBDOMAIN abcdabcdab
Image: icr.io/codeengine/helloworld
Resource Allocation:
CPU: 1
Ephemeral Storage: 400M
Memory: 4G
Revisions:
myapp-00001:
Age: 42s
Latest: true
Traffic: 100%
Image: icr.io/codeengine/helloworld (pinned to 1cee99)
Running Instances: 1
Runtime:
Concurrency: 100
Maximum Scale: 10
Minimum Scale: 0
Scale Down Delay: 0
Timeout: 300
Conditions:
Type OK Age Reason
ConfigurationsReady true 25s
Ready true 12s
RoutesReady true 12s
Events:
Type Reason Age Source Messages
Normal Created 44s service-controller Created Configuration "myapp"
Normal Created 43s service-controller Created Route "myapp"
Instances:
Name Revision Running Status Restarts Age
myapp-00001-deployment-d59b87654-xkqh7 myapp-00001 3/3 Running 0 43s
ibmcloud ce application list
列出项目中的所有应用程序。
ibmcloud ce application list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce app list --sort-by age
示例输出
Listing all applications...
OK
Name Status URL Latest Age Conditions Reason
myapptestapp2 Ready https://myapptestapp2.4svg40kna19.us-south.codeengine.appdomain.cloud myapptestapp2-emy0q-1 52s 3 OK / 3
myapptestapp1 Ready https://myapptestapp1.4svg40kna19.us-south.codeengine.appdomain.cloud myapptestapp1-ps4ca-1 104s 3 OK / 3
myapp-e Ready https://myapp-e.4svg40kna19.us-south.codeengine.appdomain.cloud myapp-e-gx6xa-1 12m 3 OK / 3
myappd Ready https://myappd.4svg40kna19.us-south.codeengine.appdomain.cloud myappd-lxjxm-1 13m 3 OK / 3
myappc Ready https://myappc.4svg40kna19.us-south.codeengine.appdomain.cloud myappc-qffan-1 14m 3 OK / 3
myappb Ready https://myappb.4svg40kna19.us-south.codeengine.appdomain.cloud myappb-i3hw3-1 15m 3 OK / 3
myapp Ready https://myapp.4svg40kna19.us-south.codeengine.appdomain.cloud myapp-jmxwd-1 17m 3 OK / 3
ibmcloud ce application logs
显示应用程序实例的日志。
ibmcloud ce application logs (--instance APP_INSTANCE | --application APP_NAME) [--all-containers] [--follow] [--output OUTPUT] [--quiet] [--raw] [--tail TAIL] [--timestamps]
命令选项
--all-containers,--all- 显示指定应用程序实例的所有容器的日志。 此值为可选项。 缺省值为
false。 --application,--app,-a,--name,-n- 显示指定应用程序所有实例的日志。 如果未指定
--instance,则必须使用该值。 --follow,-f- 跟踪应用程序实例的日志。 使用此选项可对应用程序实例的日志进行流式处理。 如果指定
--follow选项,则必须输入Ctrl+C才能终止此日志命令。 此值为可选项。 缺省值为false。 --instance,-i- 特定应用程序实例的名称。 使用
app get命令查找实例名称。 如果未指定--application,则必须使用该值。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --raw,-r- 显示日志时不带实例和容器标签。 此值为可选项。 缺省值为
false。 --tail,-t- 将指定应用程序实例的容器日志显示限制为每个容器最近行数的上限。 例如,要显示指定应用程序实例的容器的最后
3行日志,请指定--tail 3。 如果未指定此选项,则会显示指定应用程序实例容器的所有日志行。 此值为可选项。 缺省值为-1。 --timestamps,--ts- 在日志输出的每一行中包含时间戳。 此值为可选项。 缺省值为
false。
示例
下面的示例显示了应用程序特定实例的日志。 使用 app get 命令获取应用程序实例的名称。
ibmcloud ce application logs --instance myapp-zhk9x-1-deployment-6f955f5cc5-abcde
示例输出
Getting logs for application instance 'myapp-zhk9x-1-deployment-6f955f5cc5-abcde'...
OK
myapp-zhk9x-1-deployment-6f955f5cc5-abcde:
Server running at http://0.0.0.0:8080/
应用程序所有实例的日志示例
以下示例显示应用程序所有实例的日志。
ibmcloud ce application logs --app myapp
应用程序所有实例的日志输出示例
Getting application 'myapp'...
Getting revisions for application 'myapp'...
Getting instances for application 'myapp'...
Getting logs for all instances of application 'myapp'...
OK
myapp-zhk9x-1-deployment-6f955f5cc5-abcde:
Server running at http://0.0.0.0:8080/
ibmcloud ce application restart
重新启动正在运行的应用程序实例。
ibmcloud ce application restart (--instance APP_INSTANCE | --application APP_NAME) [--quiet]
命令选项
--application,--app,-a,--name,-n- 重新启动指定应用程序的所有正在运行的实例。 如果未指定
--instance,则必须使用该值。 --instance,-i- 特定应用程序实例的名称。 使用
app get命令查找实例名称。 如果未指定--application,则必须使用该值。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce application restart --name myapp
示例输出
Restarting all running instances of application 'myapp'...
OK
ibmcloud ce application unbind
解除 IBM Cloud 服务实例与应用程序的绑定。
ibmcloud ce application unbind --name APP_NAME (--binding BINDING_NAME | --all) [--quiet]
命令选项
--name,-n- 要解除绑定的应用程序名称。 此值为必填项。
--all,-A- 解除此应用程序的所有服务实例绑定。 如果未指定
--binding,则必须使用该值。 缺省值为false。 --binding,-b- 要解除绑定的绑定名称。 运行
ibmcloud ce app get -n APP_NAME查看绑定名称。 如果未指定--all,则必须使用该值。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
在本例中,删除应用程序 myapp 中的所有绑定。
ibmcloud ce application unbind --name myapp --all
示例输出
Removing service bindings...
OK
ibmcloud ce application update
更新应用程序。 更新应用程序会创建一个修订版本。 当应用程序接到呼叫时,流量会被路由到修订版。
ibmcloud ce application update --name APP_NAME [--argument ARGUMENT] [--arguments-clear] [--build-clear] [--build-commit BUILD_COMMIT] [--build-commit-clear] [--build-context-dir BUILD_CONTEXT_DIR] [--build-dockerfile BUILD_DOCKERFILE] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-git-repo-secret-clear] [--build-size BUILD_SIZE] [--build-source BUILD_SOURCE] [--build-strategy BUILD_STRATEGY] [--build-timeout BUILD_TIMEOUT] [--cluster-local] [--command COMMAND] [--commands-clear] [--concurrency CONCURRENCY] [--concurrency-target CONCURRENCY_TARGET] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-configmap-rm ENV_FROM_CONFIGMAP_RM] [--env-from-secret ENV_FROM_SECRET] [--env-from-secret-rm ENV_FROM_SECRET_RM] [--env-rm ENV_RM] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--image IMAGE] [--max-scale MAX_SCALE] [--memory MEMORY] [--min-scale MIN_SCALE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-rm MOUNT_RM] [--mount-secret MOUNT_SECRET] [--no-cluster-local] [--no-wait] [--output OUTPUT] [--port PORT] [--probe-live PROBE_LIVE] [--probe-live-clear] [--probe-ready PROBE_READY] [--probe-ready-reset] [--quiet] [--rebuild] [--registry-secret REGISTRY_SECRET] [--registry-secret-clear] [--request-timeout REQUEST_TIMEOUT] [--revision-name REVISION_NAME] [--scale-down-delay SCALE_DOWN_DELAY] [--service-account SERVICE_ACCOUNT] [--service-account-clear] [--trusted-profiles-enabled] [--user USER] [--visibility VISIBILITY] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--name,-n- 应用程序的名称。 此值为必填项。
--argument,--arg,-a- 为应用程序设置参数。 每个
--argument选项指定一个参数;例如,-a argA -a argB。 此值为可选项。 --arguments-clear,--ac- 清除应用程序参数。 此值为可选项。 缺省值为
false。 --build-clear,--bc- 从该应用程序中除去构建的关联。 只有当应用程序当前有关联的构建时,才允许使用“构建清除”选项。 此值为可选项。 缺省值为
false。 --build-commit,--commit,--bcm,--cm,--revision- 要提取的源代码库中的提交、标记或分支。 只有当
--build-source选项在此app update命令中设置为 Git 资源库的 URL,或者您的应用程序当前有一个来自 Git 资源库源的关联构建时,才允许使用构建提交选项。 此值为可选项。 --build-commit-clear,--commit-clear,--bcmc,--cmc- 清除要拉取的源存储库中的落实、标记或分支。 如果应用程序当前有关联的构建,则允许使用“提交清除”选项。 此值为可选项。 缺省值为
false。 --build-context-dir,--context-dir,--bcdr,--cdr- 版本库中包含 buildpacks 文件或 Dockerfile 的目录。 如果在
app update命令中设置了--build-source选项,或者您的应用程序当前有关联的构建,则允许使用构建上下文目录选项。 此值为可选项。 --build-dockerfile,--dockerfile,--bdf,--df- Dockerfile 的路径。 只有当名称不是
Dockerfile时才指定该选项。 只有在app update命令中设置了--build-source选项,或者你的应用程序当前有相关的构建,才允许使用 build dockerfile 选项。 此值为可选项。 默认值为Dockerfile。 --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- SSH 私钥的名称,其中包含用于访问专用存储库的凭证,该专用存储库包含用于构建容器映像的源代码。 要创建此 SSH 秘密,请使用
secret create --format SSH命令。 SSH 密文也可用作 Git 存储库访问密文。 只有当--build-source选项设置为该application update命令中 Git 资源库的 URL,或者您的应用程序当前有一个来自 Git 资源库源的关联构建时,才允许使用该选项。 此值为可选项。 --build-git-repo-secret-clear,--git-repo-secret-clear,--bgrsc,--grsc- 清除 SSH 私钥。 如果您的应用程序当前有关联的构建,则允许使用此选项。 此值为可选项。 缺省值为
false。 --build-size,--size,--bsz,--sz- 构建的大小,它决定了使用的资源量。 有效值为
small,medium,large,xlarge和xxlarge。 有关详情,请参阅 确定构建大小。 只有在app update命令中设置了--build-source选项,或应用程序当前有关联的构建时,才允许使用构建大小选项。 此值为可选项。 缺省值为medium。 --build-source,--source,--bsrc,--src- Git 源的 URL 或包含源代码的本地源的路径;例如
https://github.com/IBM/CodeEngine或.。 此值为可选项。 --build-strategy,--strategy,--bstr,--str- 用于构建映像的策略。 有效值为
dockerfile和buildpacks。 只有在app update命令中设置了--build-source选项,或您的应用程序当前有关联的构建时,才允许使用构建策略选项。 如果未指定,则在指定--build-source且源代码位于本地计算机上时,由 Code Engine 决定构建策略。 此值为可选项。 默认值为dockerfile。 --build-timeout,--bto- 在构建成功或失败之前可能经过的时间(以秒为单位)。 只有在
app update命令中设置了--build-source选项,或应用程序当前有相关的构建时,才允许使用构建超时选项。 此值为可选项。 缺省值为600。 --cluster-local,--cl- 使用仅项目的端点部署应用程序。 设置项目专用端点意味着不能从公共互联网访问你的应用程序,只能从同一项目中运行的其他 Code Engine 组件进行网络访问。 此值为可选项。 缺省值为
false。 --command,--cmd,-c- 为应用程序设置命令。 每个
--command选项指定一条命令;例如,--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- 使用以下方法之一,根据存储在此配置映射中的键值对设置环境变量:
- 要为名为
configmapName的配置映射中的所有键添加环境变量,请使用configmapName。 您可以在引用 configmap 时通过指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=CONFIGMAP_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. 例如,要将配置映射configmapName中所有键的变量名前缀设置为CUSTOM_,请使用值CUSTOM_=configmapName。 如果配置映射configmapName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为configmapName的配置映射中为单键key1添加环境变量,请使用configmapName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为configmapName的配置映射中为单键key1添加名为myKey的环境变量,请使用值configmapName:myKey=key1。
此值为可选项。
--env-from-configmap-rm,--env-cm-rm- 使用配置映射名称,删除对完整配置映射的环境变量引用。 要删除对配置映射的单个键引用,请使用
--env-rm选项。 可以多次指定此选项。 此值为可选项。 --env-sec,--env-from-secret- 使用以下方法之一,根据存储在秘密中的键值对设置环境变量:
- 要为名为
secretName的秘密中的所有密钥添加环境变量,请使用secretName。 您可以通过在引用秘密时指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=SECRET_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,要将密文secretName中所有密钥变量名的前缀设置为CUSTOM_,请使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为secretName的密钥中为单个密钥key1添加环境变量,请使用secretName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为secretName的密文中为单个密钥key1添加名为myKey的环境变量,请使用secretName:myKey=key1。
此值为可选项。
--env-from-secret-rm,--env-sec-rm- 使用秘密名称,删除环境变量对完整秘密的引用。 要删除机密的单个密钥引用,请使用
--env-rm选项。 可以多次指定此选项。 此值为可选项。 --env-rm- 删除对配置表或机密中键值对的键的环境变量引用。 要删除单个键引用和字面值,请指定键的名称。 可以多次指定此选项。 此值为可选项。
--ephemeral-storage,--es- 要为应用程序实例设置的临时存储器量。 使用
M表示兆字节,使用G表示千兆字节。 此值为可选项。 --force,-f- 不验证指定的 configmap 和秘密引用是否存在。 使用
--env-from-configmap或--mount-configmap选项可指定 Configmap 引用。 使用--env-from-secret、--mount-secret或--registry-secret选项指定秘密引用。 此值为可选项。 缺省值为false。 --image,-i- 用于此应用程序的图像名称。 格式为
REGISTRY/NAMESPACE/REPOSITORY:TAG,其中REGISTRY和TAG为可选项。 如果未指定REGISTRY,则默认为docker.io。 如果未指定TAG,则默认为latest。 此值为可选项。 --max-scale,--max,--maxscale- 此应用程序可使用的最大实例数。 如果将该值设置为
0,应用程序会根据需要进行缩放。 应用程序缩放仅受应用程序的项目的每个资源配额的实例限制。 请参见 Code Engine 的限制和配额。 此值为可选项。 默认值为10。 --memory,-m- 为应用程序实例设置的内存量。 使用
M表示兆字节,使用G表示千兆字节。 有关有效值,请参阅 支持的内存和 CPU 组合。 此值为可选项。 --min-scale,--min,--minscale- 此应用程序可使用的最小实例数。 此值为可选项。 缺省值为
0。 --mount-configmap,--mount-cm- 通过提供挂载目录和配置映射名称,将配置映射的内容添加到应用容器的文件系统中,格式为
MOUNT_DIRECTORY=CONFIGMAP_NAME. 每个挂载的 configmap 必须使用唯一的挂载目录。 对于配置映射中的每个键值对,都会在指定的挂载目录中添加一个文件,文件名是键,文件内容是键值对的值。 每个--mount-configmap选项指定一个挂载配置;例如,--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值为可选项。 --mount-data-store,--mount-ds- 挂载持久数据存储。 格式为 MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]。 SUBPATH 是可选项。 可以多次指定此选项。 此值为可选项。
--mount-rm- 从应用容器的文件系统中删除配置映射表或密文的内容,方法是指定配置映射表或密文的挂载目录。 每个
--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- 用于运行应用程序的用户 ID(UID)。 该值会覆盖应用程序 Dockerfile 中设置的任何用户 ID。 ID 必须符合容器的操作系统要求。 此值为可选项。 缺省值为
0。 --visibility,-v- 应用程序的可视性。 有效值为
public,private,和project。 将可见性设置为public意味着您的应用程序可以接收来自公共互联网或 Code Engine 项目内组件的请求。 将可见性设置为private意味着您的应用程序无法从公共互联网访问,只能从使用虚拟专用端点(VPE)的其他 IBM Cloud 或运行在同一项目中的 Code Engine 组件进行网络访问。 只有当项目支持应用程序私有可见性时,可见性才能被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
Beta 命令
Code Engine beta 命令一般不可用。 该命令组提供了对未来潜在功能的访问权限,便于选定的早期采用者进行探索。
在使用 beta 命令之前,您必须处于 项目 的上下文环境中。
要查看 beta 命令的 CLI 帮助,请运行 ibmcloud ce beta -h。
ibmcloud ce beta
Code Engine beta 命令一般不可用。 该命令组提供了对未来潜在功能的访问权限,便于选定的早期采用者进行探索。
在使用 beta 命令之前,您必须处于 项目 的上下文环境中。
要查看 beta 命令的 CLI 帮助,请运行 ibmcloud ce beta -h。
ibmcloud ce beta COMMAND
示例
ibmcloud ce beta help
示例输出
NAME:
ibmcloud code-engine beta - Beta Code Engine commands
USAGE:
ibmcloud code-engine beta command [arguments...] [command options]
COMMANDS:
help, h Show help
Enter 'ibmcloud code-engine beta help [command]' for more information about a command.
构建命令
Code Engine 支持从 Dockerfile 构建,Cloud Native Buildpacks 支持从 Dockerfile 构建。 使用 build 命令创建、显示详细信息、更新和删除构建配置。 创建构建配置后,可根据构建配置提交一条或多条 buildrun 命令。
在使用 build 命令之前,您必须处于 项目 的上下文环境中。
有关使用构建的更多信息,请参阅 构建容器镜像。
您可以在 build 命令中使用 build 或 bd。 要查看 build 命令的 CLI 帮助,请运行 ibmcloud ce build -h。
ibmcloud ce build create
创建构建。
ibmcloud ce build create --name BUILD_NAME [--build-type BUILD_TYPE] [--commit COMMIT] [--context-dir CONTEXT_DIR] [--dockerfile DOCKERFILE] [--force] [--git-repo-secret GIT_REPO_SECRET] [--image IMAGE] [--output OUTPUT] [--quiet] [--registry-secret REGISTRY_SECRET] [--size SIZE] [--source SOURCE] [--strategy STRATEGY] [--timeout TIMEOUT]
命令选项
-n,--name- 构建的名称。 请使用项目中唯一的名称。
- 名称必须以小写字母数字字符开头和结尾。
- 名称必须少于或等于 63 个字符,可包含小写字母数字字符和连字符 (-)。
此值为必填项。
--build-type,--bt- 构建的类型。 有效值为
git和local。 如果构建类型为local,则--source、--commit和--git-repo-secret选项无效。 此值为可选项。 默认值为git。 --commit,--cm,--revision- 要提取的源代码库中的提交、标记或分支。 如果
--build-type选项为git,则允许使用提交选项;如果--build-type选项为local,则不允许使用提交选项。 此值为可选项。 --context-dir,--cdr- 版本库中包含 buildpacks 文件或 Dockerfile 的目录。 此值为可选项。
--dockerfile,--df- Dockerfile 的路径。 只有当名称不是
Dockerfile时才指定该选项。 此值为可选项。 缺省值为Dockerfile。 --force,-f- 不验证指定密文是否存在。 秘密引用是通过
--get-repo-secret或--registry-secret选项指定的。 此值为可选项。 缺省值为false。 --git-repo-secret,--grs,--repo,-r- SSH 私钥的名称,其中包含用于访问专用存储库的凭证,该专用存储库包含用于构建容器映像的源代码。 要创建此 SSH 秘密,请使用
secret create --format SSH命令。 SSH 密文也可用作 Git 存储库访问密文。 如果--build-type选项为git,则允许使用该选项;如果--build-type选项为local,则不允许使用该选项。 此值为可选项。 --image,-i- 图像注册表的位置。 格式为
REGISTRY/NAMESPACE/REPOSITORY:TAG,其中TAG为可选项。 如果未指定TAG,则默认为latest。 此值为可选项。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --registry-secret,--rs- 用于访问注册表的注册表密文。 您可以通过运行
registry create命令来添加注册表秘密。 此值为可选项。 --size,--sz- 构建的大小,它决定了使用的资源量。 有效值为
small,medium,large,xlarge和xxlarge。 有关详情,请参阅 确定构建大小。 此值为可选项。 缺省值为medium。 --source,--src- 包含源代码的 Git 资源库的 URL;例如
https://github.com/IBM/CodeEngine。 如果--build-type选项为git,则必须使用源选项;如果--build-type选项为local,则不允许使用源选项。 此值为可选项。 --strategy,--str- 用于构建映像的策略。 对于应用程序和工作,有效值为
dockerfile和buildpacks。 对于函数,有效值的格式为codebundle-[RUNTIME-ID]。 例如,如果要为运行时 ID 为nodejs-24的函数构建代码包,请使用codebundle-nodejs-24作为构建策略。 通过运行ibmcloud ce fn runtimes命令,您可以找到任何支持的函数运行时的 ID。 此值为可选项。 默认值为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
ibmcloud ce build delete
删除构建。
ibmcloud ce build delete --name BUILD_NAME [--force] [--ignore-not-found] [--quiet]
命令选项
--name,-n- 构建的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce build delete --name helloworld-build
示例输出
Are you sure you want to delete build helloworld-build? [y/N]> y
Deleting build 'helloworld-build'...
OK
ibmcloud ce build get
显示构建的详细信息。
ibmcloud ce build get --name BUILD_NAME [--output OUTPUT] [--quiet]
命令选项
--name,-n- 构建的名称。 此值为必填项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce build get --name helloworld-build
示例输出
Getting build 'helloworld-build'
OK
Name: helloworld-build
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 15s
Created: 2021-03-14T14:48:19-05:00
Status: Succeeded
Reason: all validations succeeded
Last Build Run:
Name: helloworld-build-run
Age: 39d
Created: 2021-09-30T15:19:33-04:00
Image: us.icr.io/mynamespace/codeengine-helloworld
Registry Secret: myregistry
Build Strategy: dockerfile-medium
Timeout: 10m0s
Source: https://github.com/IBM/CodeEngine
Commit: main
Context Directory: /hello
Dockerfile: Dockerfile
Build Runs:
Name Status Image Age
helloworld-build-run All Steps have completed executing us.icr.io/mynamespace/codeengine-helloworld 39d
ibmcloud ce build list
列出项目中的所有构建。
ibmcloud ce build list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce build list
示例输出
Listing builds...
OK
Name Status Reason Image Build Strategy Age Last Build Run Name Last Build Run Age
myhellobuild Succeeded all validations succeeded us.icr.io/mynamespace/codeengine-codeengine-200 dockerfile-medium 160d myhellobuild-run-4xdnb 160d
hello-build-5ckgs Succeeded all validations succeeded us.icr.io/mynamespace/codeengine-codeengine-51 dockerfile-medium 39d helloapp3-build-5ckgs-run-210803-2129500 39d
hello-build-pmg6v Succeeded all validations succeeded us.icr.io/mynamespace/codeengine-codeengine-4f dockerfile-medium 40d hellooapp2-build-pmg6v-run-210802-2112310 40d
helloworld-build Succeeded all validations succeeded us.icr.io/mynamespace/codeengine-helloworld dockerfile-medium 39d helloworld-build-run 39d
ibmcloud ce build update
更新构建。
ibmcloud ce build update --name BUILD_NAME [--commit COMMIT] [--commit-clear] [--context-dir CONTEXT_DIR] [--dockerfile DOCKERFILE] [--force] [--git-repo-secret GIT_REPO_SECRET] [--git-repo-secret-clear] [--image IMAGE] [--output OUTPUT] [--quiet] [--registry-secret REGISTRY_SECRET] [--size SIZE] [--source SOURCE] [--strategy STRATEGY] [--timeout TIMEOUT]
命令选项
--name,-n- 构建的名称。 此值为必填项。
--commit,--cm,--revision- 要提取的源代码库中的提交、标记或分支。 此值为可选项。
--commit-clear,--cmc- 清除要拉取的源存储库中的落实、标记或分支。 此值为可选项。 缺省值为
false。 --context-dir,--cdr- 版本库中包含 buildpacks 文件或 Dockerfile 的目录。 此值为可选项。
--dockerfile,--df- Dockerfile 的路径。 只有当名称不是
Dockerfile时才指定该选项。 此值为可选项。 缺省值为Dockerfile。 --force,-f- 不验证指定密文是否存在。 秘密引用是通过
--get-repo-secret或--registry-secret选项指定的。 此值为可选项。 缺省值为false。 --git-repo-secret,--grs,--repo,-r- SSH 私钥的名称,其中包含用于访问专用存储库的凭证,该专用存储库包含用于构建容器映像的源代码。 要创建此 SSH 秘密,请使用
secret create --format SSH命令。 SSH 密文也可用作 Git 存储库访问密文。 此值为可选项。 --git-repo-secret-clear,--grsc- 清除 SSH 私钥。 此值为可选项。 缺省值为
false。 --image,-i- 图像注册表的位置。 格式为
REGISTRY/NAMESPACE/REPOSITORY:TAG,其中TAG为可选项。 如果未指定TAG,则默认为latest。 此值为可选项。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --registry-secret,--rs- 注册表私钥的名称。 下载容器映像时,注册表私钥用于向专用注册表进行认证。 此值为可选项。
--size,--sz- 构建的大小,它决定了使用的资源量。 有效值为
small,medium,large,xlarge和xxlarge。 有关详情,请参阅 确定构建大小。 此值为可选项。 --source,--src- 包含源代码的 Git 资源库的 URL;例如
https://github.com/IBM/CodeEngine。 此值为可选项。 --strategy,--str- 用于构建映像的策略。 对于应用程序和工作,有效值为
dockerfile和buildpacks。 对于函数,有效值的格式为codebundle-[RUNTIME-ID]。 例如,如果要为运行时 ID 为nodejs-24的函数构建代码包,请使用codebundle-nodejs-24作为构建策略。 通过运行ibmcloud ce fn runtimes命令,您可以找到任何支持的函数运行时的 ID。 此值为可选项。 --timeout,--to- 在构建成功或失败之前可能经过的时间(以秒为单位)。 此值为可选项。 缺省值为
600。
示例
ibmcloud ce build update --name helloworld-build --source https://github.com/IBM/CodeEngine --context-dir /hello --commit main --timeout 900
示例输出
Updating build helloworld-build...
OK
Buildrun 命令
Code Engine 支持从 Dockerfile 构建,Cloud Native Buildpacks 支持从 Dockerfile 构建。 使用 buildrun 命令提交、显示详情和删除构建运行。
在使用 buildrun 命令之前,您必须处于 项目 的上下文环境中。
有关使用构建和构建运行的更多信息,请参阅 构建容器映像。
您可以在 buildrun 命令中使用 buildrun 或 br。 要查看 buildrun 命令的 CLI 帮助,请运行 ibmcloud ce br -h。
ibmcloud ce buildrun cancel
取消构建运行。
ibmcloud ce buildrun cancel --name BUILDRUN_NAME [--quiet]
命令选项
--name,-n- 构建运行的名称。 此值为必填项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce buildrun cancel --name mybuildrun
示例输出
Canceling build run 'mybuildrun'...
OK
ibmcloud ce buildrun delete
删除构建运行
ibmcloud ce buildrun delete (--name BUILDRUN_NAME | --build BUILD_NAME) [--force] [--ignore-not-found] [--quiet]
命令选项
--build,-b- 使用该选项可删除指定构建程序的所有构建运行。 如果不指定
--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
ibmcloud ce buildrun events
显示构建运行的系统事件。 系统事件最多保留 60 分钟。
ibmcloud ce buildrun events --buildrun BUILDRUN_NAME [--output OUTPUT] [--quiet]
命令选项
--buildrun,-b,--br,--name,-n- 构建运行的名称。 此值为必填项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
此示例显示构建运行的系统事件信息。
ibmcloud ce buildrun events --buildrun mybuildrun
示例输出
Getting build run 'mybuildrun'...
Getting instances of build run 'mybuildrun'...
Getting events for build run 'mybuildrun'...
OK
mybuildrun-l4mr2-pod-89z4t:
Type Reason Age Source Messages
Normal Scheduled 33s default-scheduler Successfully assigned 4svg40kna19/mybuildrun-l4mr2-pod-89z4t to 10.240.128.97
Normal Pulled 31s kubelet, 10.240.128.97 Container image "gcr.io/distroless/base@sha256:92720b2305d7315b5426aec19f8651e9e04222991f877cae71f40b3141d2f07e" already present on machine
Normal Created 31s kubelet, 10.240.128.97 Created container working-dir-initializer
Normal Started 31s kubelet, 10.240.128.97 Started container working-dir-initializer
Normal Pulled 30s kubelet, 10.240.128.97 Container image "icr.io/obs/codeengine/tekton-pipeline/entrypoint-bff0a22da108bc2f16c818c97641a296:v0.20.1-rc2@sha256:19ec0672b5e84a4c5939c6ece6fa69efbce0d38479baf35ce894cf1c67f7e435" already present on machine
Normal Created 30s kubelet, 10.240.128.97 Created container place-tools
Normal Started 29s kubelet, 10.240.128.97 Started container place-tools
Normal Pulled 28s kubelet, 10.240.128.97 Container image "gcr.io/distroless/base@sha256:92720b2305d7315b5426aec19f8651e9e04222991f877cae71f40b3141d2f07e" already present on machine
Normal Created 28s kubelet, 10.240.128.97 Created container step-create-dir-image-l7lf2
Normal Created 25s kubelet, 10.240.128.97 Created container step-git-source-source-46fm7
Normal Pulled 25s kubelet, 10.240.128.97 Container image "icr.io/obs/codeengine/tekton-pipeline/git-init-4874978a9786b6625dd8b6ef2a21aa70:v0.20.1-rc2@sha256:5febfb32459a114b7beafdc593770a0f692a09d874ac6b59ce85507844641cdf" already present on machine
Normal Started 25s kubelet, 10.240.128.97 Started container step-create-dir-image-l7lf2
Normal Started 24s kubelet, 10.240.128.97 Started container step-git-source-source-46fm7
Normal Pulled 24s kubelet, 10.240.128.97 Container image "icr.io/obs/codeengine/kaniko/executor:v1.3.0-rc1" already present on machine
Normal Created 24s kubelet, 10.240.128.97 Created container step-build-and-push
Normal Started 24s kubelet, 10.240.128.97 Started container step-build-and-push
Normal Pulled 24s kubelet, 10.240.128.97 Container image "icr.io/obs/codeengine/tekton-pipeline/imagedigestexporter-6e7c518e6125f31761ebe0b96cc63971:v0.20.1-rc2@sha256:21b3120ce9b930b4eb1359eb20a3109e3a6643e9d2777ef9694efb033367e57c" already present on machine
Normal Created 24s kubelet, 10.240.128.97 Created container step-image-digest-exporter-gnbrp
Normal Started 23s kubelet, 10.240.128.97 Started container step-image-digest-exporter-gnbrp
ibmcloud ce buildrun get
显示构建运行的详细信息。
ibmcloud ce buildrun get --name BUILDRUN_NAME [--output OUTPUT] [--quiet]
命令选项
--name,-n- 构建运行的名称。 此值为必填项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce buildrun get --name mybuildrun
示例输出
Getting build run 'mybuildrun'...
Run 'ibmcloud ce buildrun events -n mybuildrun' to get the system events of the build run.
Run 'ibmcloud ce buildrun logs -f -n mybuildrun' to follow the logs of the build run.
OK
Name: mybuildrun
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 21m
Created: 2021-03-14T14:50:13-05:00
Summary: Succeeded
Status: Succeeded
Reason: All Steps have completed executing
Source:
Commit Branch: main
Commit SHA: abcdeb88263442e28af6ae26d2082dea1d6abcde
Commit Author: myauthor
Image Digest: sha256:522488ca3b54eb65f8c1e609a7b27c08558d08166fe062e7dde6838d4a609d61
Image: us.icr.io/mynamespace/test
ibmcloud ce buildrun list
列出项目中的所有构建运行。
ibmcloud ce buildrun list [--build BUILD] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--build,-b- 使用该选项只显示指定构建版的构建运行。 此值为可选项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce buildrun list
示例输出
Listing builds...
OK
Name Status Build Name Age
helloworld-build-run Succeeded helloworld-build 5d22h
mybuildrun Succeeded helloworld-build 7m23s
mybuildrun2 Succeeded helloworld-build 3m4s
ibmcloud ce buildrun logs
显示构建运行的日志。
ibmcloud ce buildrun logs --buildrun BUILDRUN_NAME [--follow] [--output OUTPUT] [--quiet] [--raw] [--tail TAIL] [--timestamps]
命令选项
--buildrun,-b,--br,--name,-n- 构建运行的名称。 此值为必填项。
--follow,-f- 查看构建运行的日志。 使用此选项可串流构建运行的日志。 如果指定
--follow选项,则必须输入Ctrl+C才能终止此日志命令。 此值为可选项。 缺省值为false。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --raw,-r- 显示日志时不带实例和容器标签。 此值为可选项。 缺省值为
false。 --tail,-t- 将指定构建运行的容器日志显示限制为每个容器最近行数的上限。 例如,要显示指定构建运行的容器的最后
3行日志,请指定--tail 3。 如果未指定此选项,则会显示指定构建运行的容器的所有日志行。 此值为可选项。 缺省值为-1。 --timestamps,--ts- 在日志输出的每一行中包含时间戳。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce buildrun logs --name mybuildrun
示例输出
Getting build run 'mybuildrun'...
Getting instances of build run 'mybuildrun'...
Getting logs for build run 'mybuildrun'...
OK
mybuildrun-v2mb8-pod-tlzdx/step-git-source-source-g2kbf:
{"level":"info","ts":1614089507.7123275,"caller":"git/git.go:165","msg":"Successfully cloned https://github.com/IBM/CodeEngine @ 433e2b8d6529e4a55f5e0f72d3772a79602a5ee8 (grafted, HEAD, origin/main) in path /workspace/source"}
{"level":"info","ts":1614089509.0128207,"caller":"git/git.go:203","msg":"Successfully initialized and updated submodules in path /workspace/source"}
mybuildrun-v2mb8-pod-tlzdx/step-build-and-push:
INFO[0000] Retrieving image manifest node:12-alpine
INFO[0000] Retrieving image node:12-alpine
INFO[0001] Retrieving image manifest node:12-alpine
INFO[0001] Retrieving image node:12-alpine
INFO[0001] Built cross stage deps: map[]
INFO[0001] Retrieving image manifest node:12-alpine
INFO[0001] Retrieving image node:12-alpine
INFO[0002] Retrieving image manifest node:12-alpine
INFO[0002] Retrieving image node:12-alpine
INFO[0002] Executing 0 build triggers
INFO[0002] Unpacking rootfs as cmd RUN npm install requires it.
INFO[0006] RUN npm install
INFO[0006] Taking snapshot of full filesystem...
INFO[0008] cmd: /bin/sh
INFO[0008] args: [-c npm install]
INFO[0008] Running: [/bin/sh -c npm install]
npm WARN saveError ENOENT: no such file or directory, open '/package.json'
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN enoent ENOENT: no such file or directory, open '/package.json'
npm WARN !invalid#2 No description
npm WARN !invalid#2 No repository field.
npm WARN !invalid#2 No README data
npm WARN !invalid#2 No license field.
up to date in 0.27s
found 0 vulnerabilities
INFO[0010] Taking snapshot of full filesystem...
INFO[0010] COPY server.js .
INFO[0010] Taking snapshot of files...
INFO[0010] EXPOSE 8080
INFO[0010] cmd: EXPOSE
INFO[0010] Adding exposed port: 8080/tcp
INFO[0010] CMD [ "node", "server.js" ]
mybuildrun-v2mb8-pod-tlzdx/step-image-digest-exporter-hcvmf:
2021/02/23 14:11:43 warning: unsuccessful cred copy: ".docker" from "/tekton/creds" to "/tekton/home": unable to open destination: open /tekton/home/.docker/config.json: permission denied
{"severity":"INFO","timestamp":"2021-02-23T14:12:05.65581098Z","caller":"logging/config.go:115","message":"Successfully created the logger.","logging.googleapis.com/labels":{},"logging.googleapis.com/sourceLocation":{"file":"github.com/tektoncd/pipeline/vendor/knative.dev/pkg/logging/config.go","line":"115","function":"github.com/tektoncd/pipeline/vendor/knative.dev/pkg/logging.newLoggerFromConfig"}}
{"severity":"INFO","timestamp":"2021-02-23T14:12:05.655937558Z","caller":"logging/config.go:116","message":"Logging level set to: info","logging.googleapis.com/labels":{},"logging.googleapis.com/sourceLocation":{"file":"github.com/tektoncd/pipeline/vendor/knative.dev/pkg/logging/config.go","line":"116","function":"github.com/tektoncd/pipeline/vendor/knative.dev/pkg/logging.newLoggerFromConfig"}}
ibmcloud ce buildrun submit
提交构建运行。
ibmcloud ce buildrun submit (--build BUILD_NAME [--name NAME]) | (--name NAME [--commit COMMIT] [--context-dir CONTEXT_DIR] [--dockerfile DOCKERFILE] [--git-repo-secret GIT_REPO_SECRET] [--registry-secret REGISTRY_SECRET] [--size SIZE] [--strategy STRATEGY]) [--image IMAGE] [--no-wait] [--output OUTPUT] [--quiet] [--service-account SERVICE_ACCOUNT] [--source SOURCE] [--timeout TIMEOUT] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--build,-b,--bd- 要使用的构建配置的名称。 此值为可选项。
--commit,--cm,--revision- 要提取的源代码库中的提交、标记或分支。 如果
--source选项设置为 Git 版本库的 URL,则允许使用构建提交选项;如果--source选项未设置为 Git 版本库的 URL,则不允许使用构建提交选项。 此值为可选项。 --context-dir,--cdr- 版本库中包含 buildpacks 文件或 Dockerfile 的目录。 如果未设置
--build选项,则允许使用构建上下文目录选项;如果设置了--build选项,则不允许使用构建上下文目录选项。 此值为可选项。 --dockerfile,--df- Dockerfile 的路径。 只有当名称不是
Dockerfile时才指定该选项。 如果没有设置--build选项,则允许使用 build dockerfile 选项;如果设置了--build选项,则不允许使用 build dockerfile 选项。 此值为可选项。 默认值为Dockerfile。 --git-repo-secret,--grs,--repo,-r- SSH 私钥的名称,其中包含用于访问专用存储库的凭证,该专用存储库包含用于构建容器映像的源代码。 要创建此 SSH 秘密,请使用
secret create --format SSH命令。 SSH 密文也可用作 Git 存储库访问密文。 只有当--build-source选项设置为 Git 资源库的 URL 时,才允许使用该选项。 此值为可选项。 --image,-i- 图像注册表的位置。 格式为
REGISTRY/NAMESPACE/REPOSITORY:TAG,其中TAG为可选项。 如果未指定TAG,则默认为latest。 此值为可选项。 -n,--name- 构建运行的名称。 请使用项目中唯一的名称。 如果设置了
--build选项,则名称选项为可选项。 如果未设置--build选项,则需要使用 name 选项。
- 名称必须以小写字母数字字符开头和结尾。
- 名称必须少于或等于 63 个字符,可包含小写字母数字字符和连字符 (-)。
此值为可选项。
--no-wait,--nw- 提交构建运行,不要等待构建运行完成。 如果指定
--no-wait选项,则会开始提交构建运行,而不会等待。 使用buildrun get命令检查构建运行状态。 此值为可选项。 缺省值为true。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --registry-secret,--rs- 注册表私钥的名称。 下载容器映像时,注册表私钥用于向专用注册表进行认证。 如果未设置
--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]。 例如,如果要为运行时 ID 为nodejs-24的函数构建代码包,请使用codebundle-nodejs-24作为构建策略。 通过运行ibmcloud ce fn runtimes命令,您可以找到任何支持的函数运行时的 ID。 如果未设置--build选项,则允许使用构建策略选项;如果设置了--build选项,则不允许使用构建策略选项。 如果未指定,则在指定--source且源代码位于本地计算机上时,由 Code Engine 决定构建策略。 此值为可选项。 默认值为dockerfile。 --timeout,--to- 在构建运行成功或失败之前可能经过的时间(以秒为单位)。 此值为可选项。 缺省值为
600。 --wait,-w- 提交构建运行,等待构建运行完成。 如果指定
--wait选项,编译运行提交会等待--wait-timeout选项设定的最长秒数完成编译运行。 如果在指定的--wait-timeout时间内未完成构建运行,则构建运行提交失败。 此值为可选项。 缺省值是false。 --wait-timeout,--wto- 等待构建运行完成的时间长度(秒)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为600。
示例
以下命令将提交名为 mybuildrun 的构建运行,并使用名为 helloworld-build 的构建配置文件。
ibmcloud ce buildrun submit --name mybuildrun --build helloworld-build
示例输出
Submitting build run 'mybuildrun'...
Run 'ibmcloud ce buildrun get -n mybuildrun' to check the build run status.
OK
配置映射命令
配置图提供了一种将非敏感数据信息纳入部署的方法。 通过将 configmap 中的值作为环境变量引用,可以将特定信息与部署分离,并保持应用程序、作业或函数的可移植性。 配置映射包含键值对信息。 使用 configmap 命令创建、显示详细信息、更新和删除配置映射。
在使用 configmap 命令之前,您必须处于 项目 的上下文环境中。
有关使用配置映射的更多信息,请参阅 使用配置映射。
您可以在 configmap 命令中使用 configmap 或 cm。 要查看 configmap 命令的 CLI 帮助,请运行 ibmcloud ce configmap -h。
ibmcloud ce configmap create
创建配置图。
ibmcloud ce configmap create --name CONFIGMAP_NAME (--from-env-file FILE | --from-file FILE | --from-file KEY=FILE | --from-literal KEY=VALUE) [--output OUTPUT] [--quiet]
命令选项
-n,--name- 配置映射的名称。 请使用项目中唯一的名称。
- 名称必须以小写字母数字字符开头和结尾。
- 名称必须少于或等于 253 个字符,可包含小写字母、数字、句号 (.) 和连字符 (-)。
此值为必填项。
--from-env-file,-e- 从包含符合
KEY=VALUE格式的一行或多行的文件创建配置映射。 您必须提供文件的路径作为值。 指定文件中的每一行都会以键值对的形式添加。 指定文件中任何空行或以#开头的行都将被忽略。 如果未指定--from-literal或--from-file,则必须使用该值。 --from-file,-f- 从文件创建配置图 您必须提供文件的路径作为值。 如果未指定
--from-literal或--from-env-file,则必须使用该值。 --from-literal,-l- 根据键值对创建配置映射。 必须采用
KEY=VALUE格式。 如果未指定--from-file或--from-env-file,则必须使用该值。 可以多次指定此选项。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
下面的示例创建了一个名为 configmap-fromliteral 的配置映射,其中有两个键对值:color=blue 和 size=large。
ibmcloud ce configmap create --name configmap-fromliteral --from-literal color=blue --from-literal size=large
示例输出
Creating Configmap 'configmap-fromliteral'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromliteral' to see more details.
包含多个文件值的配置图示例
下面的示例创建了一个名为 configmap-fromfile 的配置映射,其中的值来自多个文件。
ibmcloud ce configmap create --name configmap-fromfile --from-file ./color.txt --from-file ./size.txt
包含多个文件值的配置图输出示例
Creating configmap 'configmap-fromfile'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromfile' to see more details.
ibmcloud ce configmap delete
删除配置映射。
ibmcloud ce configmap delete --name CONFIGMAP_NAME [--force] [--ignore-not-found] [--quiet]
命令选项
--name,-n- 配置映射的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce configmap delete --name configmap-fromliteral -f
示例输出
Deleting Configmap 'configmap-fromliteral'...
OK
ibmcloud ce configmap get
显示配置图的详细信息。
ibmcloud ce configmap get --name CONFIGMAP_NAME [--output OUTPUT] [--quiet]
命令选项
--name,-n- 配置映射的名称。 此值为必填项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce configmap get --name configmap-fromliteral
示例输出
Getting configmap 'configmap-fromliteral'...
OK
Name: configmap-fromliteral
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 21s
Created: 2021-03-01T13:50:56-05:00
Data:
---
color: blue
size: large
ibmcloud ce configmap list
列出项目中的所有配置映射。
ibmcloud ce configmap list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce configmap list
示例输出
Listing Configmaps...
Name Data Age
configmap-fromfile 2 19m13s
configmap-fromliteral 2 16m12s
ibmcloud ce configmap update
更新配置图。
ibmcloud ce configmap update --name CONFIGMAP_NAME (--from-env-file FILE | --from-file FILE | --from-file KEY=FILE | --from-literal KEY=VALUE | --rm KEY) [--output OUTPUT] [--quiet]
命令选项
--name,-n- 配置映射的名称。 此值为必填项。
--from-env-file,-e- 从包含一行或多行符合格式
KEY=VALUE的文件中更新配置映射。 您必须提供文件的路径作为值。 指定文件中的每一行都会以键值对的形式添加。 指定文件中任何空行或以#开头的行都将被忽略。 如果未指定--from-literal或--from-file,则必须使用该值。 可以多次指定此选项。 --from-file,-f- 从文件更新配置映射。 您必须提供文件的路径作为值。 如果未指定
--from-literal或--from-env-file,则必须使用该值。 可以多次指定此选项。 --from-literal,-l- 根据键值对更新配置映射。 必须采用
KEY=VALUE格式。 如果未指定--from-file或--from-env-file,则必须使用该值。 可以多次指定此选项。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --rm- 通过指定键的名称,删除配置映射中的单个键值对。 可以多次指定此选项。 此值为可选项。
示例
下面的示例用用户名和密码值对更新了名为 configmap-fromliteral 的配置映射。
ibmcloud ce configmap update --name configmap-fromliteral --from-literal username=devuser --from-literal password='A!B99c$D1Def'
示例输出
Updating configmap 'configmap-fromliteral'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromliteral' to see more details.
包含文件值的配置图示例
下面的示例用文件中的值更新了名为 configmap-fromfile 的配置映射。
ibmcloud ce configmap update --name configmap-fromfile --from-file ./username.txt --from-file ./password.txt
包含文件值的配置图输出示例
Updating configmap 'configmap-fromfile'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromfile' to see more details.
连接命令
IBM Cloud® Code Engine 连接功能支持为 Code Engine 项目中的工作负载配置各种网络连接。
- 通过为出站连接指定允许的目标 IP 地址范围来定义可到达的端点
- 连接 IBM Cloud VPC 专用路径服务。
- 定义 VPC 子网池引用,包括安全组,以配置 Code Engine 机群工作人员的网络位置。
在使用 connectivity 命令之前,您必须处于 项目 的上下文环境中。
您可以在 connectivity 命令中使用 connectivity 或 conn。 要查看 connectivity 命令的 CLI 帮助,请运行 ibmcloud ce connectivity -h。
ibmcloud ce connectivity outbound
IBM Cloud® Code Engine 向外连接功能支持为 Code Engine 项目定义可到达的端点。
- 使用 CIDR 符号表示允许的出站连接目标 IP 地址范围。
- 使用 Code Engine 控制台或 CLI 将 Code Engine 项目与 IBM Cloud VPC Private Path 服务 连接。
在使用 connectivity outbound 命令之前,您必须处于 项目 的上下文环境中。
有关使用出站连接命令的更多信息,请参阅 Code Engine 中的使用出站连接。
您可以在 connectivity outbound 命令中使用 connectivity outbound 或 conn outbound。 要查看 connectivity outbound 命令的 CLI 帮助,请运行 ibmcloud ce connectivity outbound -h。
ibmcloud ce connectivity outbound COMMAND
ibmcloud ce connectivity outbound create
创建允许的出站目的地。
ibmcloud ce connectivity outbound create --name OUTBOUND_DESTINATION_NAME (--cidr CIDR_IP_ADDRESS | --pps-crn PPS_CRN) [--force] [--format FORMAT] [--pps-isolation-policy PPS_ISOLATION_POLICY] [--quiet]
命令选项
--n,--cidr-name,--name- 必需。 允许出站目的地的名称。 此值为必填项。
--cidr,-c- 提供 CIDR 格式的有效 IP 地址范围(例如 1.2.3.0/24)。 此值为可选项。
--force,-f- 强制创建而不确认。 此值为可选项。 缺省值为
false。 --format,--fo- 允许出站目的地的格式。 有效值为 [
cidr,cidr_block,pps,private_path_gateway_service]。如果未指定,默认值为cidr。 此值为可选项。 默认值为cidr_block。 --pps-crn,--private-path-service-crn- 提供要连接的目标专用路径服务的 CRN。 此值为可选项。
--pps-isolation-policy,--pip- 专用路径连接的隔离策略。 有效值为 [
dedicated,shared]。 如果未指定,默认值为shared。 此值为可选项。 默认值为shared。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce connectivity outbound create --name allow-to-subnet-a --cidr 5.6.7.8/29
示例输出
Creating allowed destination IP address range 'allow-to-subnet-a'...
OK
创建专用路径出站连接的示例
ibmcloud ce connectivity outbound create --name my-pps-connection --format pps --pps-crn crn:v1:bluemix:public:is:eu-de:a/abcdefabcdefabcdefabcd1234567890::private-path-service-gateway:r010-2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
创建专用路径出站连接的输出示例
Creating allowed outbound destination 'my-pps-connection'...
Successfully created allowed outbound destination 'my-pps-connection'. Current status is 'deploying'
Run 'ibmcloud ce connectivity outbound get --name my-pps-connection' to see more details.
OK
ibmcloud ce connectivity outbound delete
删除允许的出站目的地。
ibmcloud ce connectivity outbound delete --name OUTBOUND_DESTINATION_NAME [--force] [--ignore-not-found] [--quiet]
命令选项
--n,--cidr-name,--name- 必需。 允许出站目的地的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce connectivity outbound delete --name allow-to-subnet-a
示例输出
Are you sure you want to delete allowed outbound destination 'allow-to-subnet-a'? [y/N]> y
Deleting allowed outbound destination 'allow-to-subnet-a'...
OK
ibmcloud ce connectivity outbound get
显示允许出站目的地的详细信息。
ibmcloud ce connectivity outbound get --name OUTBOUND_DESTINATION_NAME [--output OUTPUT] [--quiet]
命令选项
--n,--cidr-name,--name- 必需。 允许出站目的地的名称。 此值为必填项。
--output,-o- 输出格式。 有效值为 "json"、"yaml"、"jsonpath=JSONPATH_EXPRESSION "和 "jsonpath-as-json=JSONPATH_EXPRESSION"。 此值为可选项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce connectivity outbound get --name allow-to-subnet-a
示例输出
Getting allowed outbound destination 'allow-to-subnet-a'...
OK
Project name: myproj
Name: allow-to-subnet-a
Format: cidr_block
IP address range: 5.6.7.8/29
获取专用路径出站连接的示例
ibmcloud ce connectivity outbound get --name my-pps-connection
获取专用路径出站连接的输出示例
Getting allowed outbound destination 'my-pps-connection'...
OK
Project name: myproj
Name: my-pps-connection
Format: private_path_service_gateway
Private path service:
CRN: crn:v1:bluemix:public:is:eu-de:a/abcdefabcdefabcdefabcd1234567890::private-path-service-gateway:r010-2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
Status: ready
Name: my-private-path--is-vpc-pps
Endpoints:
api.ce-1a2b3c4d5e6f.intra
VPE gateway:
Name: code-engine-prod-eu-de-1234ab
IP addresses:
192.168.12.48
192.168.24.60
192.168.36.72
ibmcloud ce connectivity outbound list
列出所有允许的出境目的地。
ibmcloud ce connectivity outbound list [--format FORMAT] [--output OUTPUT] [--quiet]
命令选项
--format- 将允许显示的出站目的地限制为指定格式。 以逗号分隔的列表形式提供一种或多种格式。 有效值为 [
cidr,cidr_block,pps,private_path_gateway_service]。该值为 可选的。 默认值为cidr_block,private_path_service_gateway。 --output,-o- 输出格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce connectivity outbound list
示例输出
Listing allowed outbound destinations...
OK
CIDR ranges:
Name IP address range
allow-to-subnet-a 5.6.7.8/29
allow-to-subnet-b 11.12.13.0/24
Private path connections:
Name Status Service endpoints
broken-connection failed
my-pps-connection ready api.ce-1a2b3c4d5e6f.intra
ibmcloud ce connectivity outbound update
更新允许的出境目的地。
ibmcloud ce connectivity outbound update --name OUTBOUND_DESTINATION_NAME (--cidr CIDR_IP_ADDRESS | --pps-isolation-policy PPS_ISOLATION_POLICY) [--force] [--quiet]
命令选项
--n,--cidr-name,--name- 必需。 允许出站目的地的名称。 此值为必填项。
--cidr,-c- 提供 CIDR 格式的有效 IP 地址范围(例如 1.2.3.0/24)。 此值为可选项。
--force,-f- 强制更新而不进行确认。 此值为可选项。 缺省值为
false。 --pps-isolation-policy,--pip- 专用路径连接的隔离策略。 有效值为 [
dedicated,shared]。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce connectivity outbound update --name allow-to-subnet-a --cidr 5.6.7.0/27
示例输出
Updating allowed destination IP address range 'allow-to-subnet-a'...
OK
ibmcloud ce connectivity subnetpool
IBM Cloud® Code Engine 子网池连接功能支持管理 VPC 子网池引用,包括安全组。 机群总是连接到 VPC,创建机群时可以引用子网池,指定 Code Engine 机群工作人员部署到哪个网络区域。 创建子网池可指定处理工作负载的 VPC 子网和可用性区域。 例如,您可以在 eu-de-1 区创建一个包含单个子网的子网池,或在 eu-de 区创建一个包含多个子网的子网池,以跨越所有 3 个区。 此外,您还可以指定工作负载应附加的安全组。
IBM Cloud® Virtual Private Cloud (VPC) 是与客户账户相连的虚拟网络。 VPC 通过提供对虚拟基础架构和网络流量分段的细颗粒度控制,为您提供了云安全性以及动态伸缩能力。 VPC 中的子网提供专用连接。 VPC 中的子网可以通过可选的公共网关连接到公用因特网。 通过使用安全组控制网络流量,可以确保 VPC 和工作负载的安全。 更多信息见 关于网络 和 VPC 的安全性。
在使用 connectivity subnetpool 命令之前,您必须处于 项目 的上下文环境中。
有关使用子网池连接命令的更多信息,请参阅 Code Engine 中的使用子网池连接。
您可以在 connectivity subnetpool 命令中使用 connectivity 或 conn。 要查看 connectivity subnetpool 命令的 CLI 帮助,请运行 ibmcloud ce connectivity subnetpool -h。
ibmcloud ce connectivity subnetpool COMMAND
ibmcloud ce connectivity subnetpool create
创建子网池。
ibmcloud ce connectivity subnetpool create [--name NAME] [--quiet] [--security-group-crn SECURITY_GROUP_CRN] [--subnet-crn SUBNET_CRN]
命令选项
--name,-n- 必需。 子网池名称。 请使用项目中唯一的名称。 此值为必填项。
--subnet-crn,--crn- 为池提供有效的子网注册号。 必须为 S1=crn:v1:example 格式 此值为必填项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --security-group-crn,--sg-crn- 为池提供有效的安全组 crn。 此值为可选项。
示例
ibmcloud ce connectivity subnetpool create --name my-other-pool \
--subnet-crn S1=crn:v1:bluemix:public:is:eu-de-3:a/abcdefabcdefabcdefabcd1234567890::subnet:1a1a-2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f21 \
--security-group-crn S1=crn:v1:bluemix:public:is:eu-de:a/abcdefabcdefabcdefabcd1234567890::security-group:2b2b-3c3c3c3c-4d4d-5e5e-6f6f-7g7g7g7g7g7g \
--subnet-crn IDx=crn:v1:bluemix:public:is:eu-de-3:a/abcdefabcdefabcdefabcd1234567890::subnet:1a1a-2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f22 \
--security-group-crn IDx=crn:v1:bluemix:public:is:eu-de:a/abcdefabcdefabcdefabcd1234567890::security-group:2b2b-3c3c3c3c-4d4d-5e5e-6f6f-7g7g7g7g7g7g \
--security-group-crn IDx=crn:v1:bluemix:public:is:eu-de:a/abcdefabcdefabcdefabcd1234567890::security-group:2b2b-3c3c3c3c-4d4d-5e5e-6f6f-7g7g7g7g7g8h
示例输出
OK
Successfully created subnet pool with name 'my-other-pool' and ID 'a23ff1d1-b845-4629-86d1-a4126155ad02'
ibmcloud ce connectivity subnetpool delete
删除子网池。
ibmcloud ce connectivity subnetpool delete (--name SUBNET_POOL_NAME || --id SUBNET_POOL_ID) [--force] [--ignore-not-found] [--quiet]
命令选项
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --id- 子网池的 ID。 此值为可选项。
--ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --name,-n- 子网池名称。 此值为可选项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce connectivity subnetpool delete --name my-subnet-pool
示例输出
Are you sure you want to delete subnet pool '1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e'? [y/N]> y
Deleting subnet pool with name 'my-subnet-pool' and ID '1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e'
OK
ibmcloud ce connectivity subnetpool get
显示子网池的详细信息。
ibmcloud ce connectivity subnetpool get (--id SUBNET_POOL_ID || --name SUBNET_POOL_NAME) [--output OUTPUT] [--quiet]
命令选项
--id- 子网池的 ID。 此值为可选项。
--name,-n- 子网池名称。 此值为可选项。
--output,-o- 输出格式。 有效值为 "json"、"yaml"、"jsonpath=JSONPATH_EXPRESSION "和 "jsonpath-as-json=JSONPATH_EXPRESSION"。 此值为可选项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce connectivity subnetpool get --name my-subnet-pool
示例输出
Getting subnet pool 'my-subnet-pool'...
OK
Name: my-subnet-pool
ID: 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Project name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 114d
Network placement:
Number of subnets: 1
Subnet CRN: crn:v1:bluemix:public:is:eu-de-3:a/abcdefabcdefabcdefabcd1234567890::subnet:1a1a-2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
Security Group CRN: crn:v1:bluemix:public:is:eu-de:a/abcdefabcdefabcdefabcd1234567890::security-group:2b2b-3c3c3c3c-4d4d-5e5e-6f6f-7g7g7g7g7g7g
ibmcloud ce connectivity subnetpool list
列出项目中的所有子网池。
ibmcloud ce connectivity subnetpool list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--output,-o- 输出格式。 有效值为 "json"、"yaml"、"jsonpath=JSONPATH_EXPRESSION "和 "jsonpath-as-json=JSONPATH_EXPRESSION"。 此值为可选项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为“姓名”和“年龄”。 此值为可选项。 缺省值为
name。
示例
ibmcloud ce connectivity subnetpool list
示例输出
Listing all subnet pools in a project...
OK
Name ID Subnets Region Age
auto-network-pool-gg55edn1xe hgfedcba-dcba-abcd-abcd-1a2b3c4d5e6f 1 eu-de 93d
my-other-pool abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f 3 eu-de 25h
my-subnet-pool 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e 1 eu-de 114d
域名映射命令
域映射为 URL 项目中的 Code Engine 应用程序提供了路径。 有了 Code Engine,只要部署应用程序,这些映射就会默认自动创建。 不过,您可以将自己的自定义域映射到 Code Engine 应用程序,通过 Code Engine 将来自自定义 URL 的请求路由到您的应用程序。 使用 domainmapping 命令创建、显示详细信息、更新和删除域映射。
当您在 Code Engine 中设置自定义域映射时,就定义了您的完全合格域名 (FQDN) 与项目中 Code Engine 应用程序之间的 1-to-1 映射。 要在 CLI 中配置和使用自定义域映射,请使用 domainmapping 命令。
在使用 domainmapping 命令之前,您必须处于 项目 的上下文环境中。
有关使用域映射的更多信息,请参阅 为应用程序配置自定义域映射。
您可以在 domainmapping 命令中使用 domainmapping 或 dm。 要查看 domainmapping 命令的 CLI 帮助,请运行 ibmcloud ce domainmapping -h。
ibmcloud ce domainmapping create
创建定制域映射。
ibmcloud ce domainmapping create --domain-name DOMAIN_NAME [--target-type TARGET_TYPE] --tls-secret SECRET_NAME [--quiet]
命令选项
--domain-name,--dn,-n,--name- 指定域映射的名称。 此名称必须是有效的标准域名 (FQDN)。 例如,
www.example.com。 此值为必填项。 --target,-t- 目标应用程序或函数的名称。 此值为必填项。
--target-type,--type- 目标的类型。 有效值为
application或function。 此值为必填项。 --tls-secret,--secret,--tls- 指定 TLS 保密信息,其中包含证书(包括其所有中间证书)和域映射的相应私钥。 证书必须由可信的公共认证中心 (CA) 签署。 不支持自签名证书。 此值为必填项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
下面的示例在 应用程序和自定义域 之间创建了自定义域映射,并使用 保密信息。 Code Engine myapp 应用程序和自定义域 www.example.com 之间创建自定义域映射,并使用 TLS 密 码 mytlssecret。
ibmcloud ce domainmapping create --domain-name www.example.com --target myapp --tls-secret mytlssecret
示例输出
OK
Domain mapping successfully created.
ibmcloud ce domainmapping delete
删除定制域映射。
ibmcloud ce domainmapping delete --domain-name DOMAIN_NAME [--force] [--ignore-not-found] [--quiet]
命令选项
--domain-name,--dn,-n,--name- 域映射的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce domainmapping delete --name www.example.com -f
示例输出
Deleting domain mapping 'www.example.com'...
OK
ibmcloud ce domainmapping get
显示定制域映射的详细信息。
ibmcloud ce domainmapping get --domain-name DOMAIN_NAME [--output OUTPUT] [--quiet]
命令选项
--domain-name,--dn,-n,--name- 域映射的名称 此值为必填项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce domainmapping get --name www.example.com
示例输出
Getting domainmapping 'www.example.com'...
OK
Domain Name: www.example.com
CNAME: custom.abcdabcdabc.us-south.codeengine.appdomain.cloud
Target Name: myapp
Target Type: app
TLS Secret: mytlssecret
Status: ready
ibmcloud ce domainmapping list
列出项目中的域映射。
ibmcloud ce domainmapping list [--all] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--all,-a- 显示项目中的所有域映射,包括定制和系统域映射。 此值为可选项。 缺省值为
false。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
下面的示例显示了所有自定义域映射的列表。
ibmcloud ce domainmapping list
示例输出
Listing domain mappings...
OK
Name CNAME Target Target-Type Status Secret Name Age
www.example.com custom.abcdabcdabc.us-south.codeengine.appdomain.cloud myapp app ready mytlssecret 36m
要查看应用程序的所有域映射列表,包括自定义域映射和任何自动生成的系统域映射,请使用 --all 选项指定 ibmcloud ce domainmapping list 命令指定 选项。
ibmcloud ce domainmapping update
更新定制域映射。
ibmcloud ce domainmapping update --domain-name DOMAIN_NAME --target TARGET_NAME --tls-secret SECRET_NAME [--quiet] [--target-type TARGET_TYPE]
命令选项
--domain-name,--dn,-n,--name- 域映射的名称。 此值为必填项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --target,-t- 目标应用程序或函数的名称。 此值为可选项。
--target-type,--type- 目标的类型。 有效值为
application或function。 此值为可选项。 --tls-secret,--secret,--tls- 指定 TLS 保密信息,其中包含证书(包括其所有中间证书)和域映射的相应私钥。 证书必须由可信的公共认证中心 (CA) 签署。 不支持自签名证书。 此值为可选项。
示例
下面的示例更新了 www.example.com 域映射,使用 mytlssecret2 代替 mytlssecret。
ibmcloud ce domainmapping update --domain-name www.example.com --tls-secret mytlssecret2
示例输出
Updating domainmapping 'www.example.com'...
实验指令
Code Engine 实验性命令一般不提供。 该命令组提供了对未来潜在功能的访问权限,便于选定的早期采用者进行探索。
在使用 experimental 命令之前,您必须处于 项目 的上下文环境中。
您可以在 experimental 命令中使用 experimental 或 exp。 要查看 experimental 命令的 CLI 帮助,请运行 ibmcloud ce exp -h。
ibmcloud ce experimental
Code Engine 实验性命令一般不提供。 该命令组提供了对未来潜在功能的访问权限,便于选定的早期采用者进行探索。
在使用 experimental 命令之前,您必须处于 项目 的上下文环境中。
您可以在 experimental 命令中使用 experimental 或 exp。 要查看 experimental 命令的 CLI 帮助,请运行 ibmcloud ce exp -h。
ibmcloud ce experimental COMMAND
示例
ibmcloud ce experimental help
示例输出
NAME:
ibmcloud code-engine experimental - Experimental Code Engine commands
USAGE:
ibmcloud code-engine experimental command [arguments...] [command options]
COMMANDS:
help, h Show help
Enter 'ibmcloud code-engine experimental help [command]' for more information about a command.
舰队指挥
管理无服务器机群
ibmcloud ce fleet cancel
取消无服务器机群。
ibmcloud ce fleet cancel --id FLEET_ID [--force] [--hard] [--quiet]
命令选项
--id,--fid,--fleet-id- 必需。 无服务器机群的 ID。 此值为必填项。
--force,-f- 未经确认强行取消。 此值为可选项。 缺省值为
false。 --hard- 立即取消无服务器机群,包括处于
running状态的任务。 如果不指定hard选项,处于running状态的任务将继续处理,直到达到最终状态,然后才转入canceled状态。 此值为可选项。 缺省值为false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce fleet cancel --force --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
示例输出
Canceling serverless fleet...
Run 'ibmcloud ce fleet get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e' to check the fleet status.
OK
Name: fleet-0123456789
ID: 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Status: canceled
Created: 39m
Project region: eu-de
Project name: myproj
Tasks status:
Failed: 0
Canceled: 0
Successful: 0
Running: 0
Pending: 1
Total: 1
ibmcloud ce fleet create
启动无服务器资源组
ibmcloud ce fleet create --image IMAGE_REF --tasks-state-store TASKS_STATE_STORE (--subnetpool-name SUBNETPOOL_NAME | --subnetpool-id SUBNETPOOL_ID) (--tasks TASKS | --tasks-from-local-file TASKS_FROM_LOCAL_FILE | --tasks-from-cos-object TASKS_FROM_COS_OBJECT | --tasks-from-cos-bucket TASKS_FROM_COS_BUCKET) [--argument ARGUMENT] [--command COMMAND] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--gpu GPU] [--max-scale MAX_SCALE] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mount-data-store MOUNT_DATA_STORE] [--name NAME] [--quiet] [--registry-secret REGISTRY_SECRET] [--retrylimit RETRYLIMIT] [--task-indexes TASK_INDEXES] [--worker-profile WORKER_PROFILE]
命令选项
--image,-i- 必需。 用于处理任务的容器映像的名称。 格式为
REGISTRY/NAMESPACE/REPOSITORY:TAG,其中REGISTRY和TAG为可选项。 如果未指定REGISTRY,则默认为docker.io。 如果未指定TAG,则默认为latest。 此值为必填项。 --tasks-state-store,--ts-state- 必需。 指定存储车队任务状态的持久数据存储。 此值为必填项。
--argument,--arg,-a- 设置任务中执行命令所需的命令参数。 可以多次指定此选项。 此值为可选项。
--command,--cmd,-c- 设置任务中要执行的命令。 可以多次指定此选项。 此值为可选项。
--cpu,--cp- 为任务设置的 CPU 数量。 此值为可选项。 缺省值为
1。 --env,-e- 设置传入任务的环境变量。 必须采用 NAME=VALUE 格式。 可以多次指定此选项。 此值为可选项。
--env-from-configmap,--env-cm- 根据存储在此 configmap 中的键值对设置环境变量。 提供 NAME 以引用完整配置映射,或者提供 PREFIX=NAME 以引用每个密钥以 PREFIX 为前缀的完整配置映射,或者提供 NAME:KEY_A, KEY_B 以引用各个密钥。 要为引用的密钥指定新名称,请使用以下格式:NAME:NEW_KEY_NAME = KEY_A。 可以多次指定此选项。 此值为可选项。
--env-from-secret,--env-sec- 根据存储在此秘密中的键值对设置环境变量。 提供 NAME 以引用完整密钥,或者提供 PREFIX=NAME 以引用完整密钥,其中每个密钥都以 PREFIX 作为前缀,或者提供 NAME:KEY_A,KEY_B 以引用各个密钥。 要为引用的密钥指定新名称,请使用以下格式:NAME:NEW_KEY_NAME = KEY_A。 可以多次指定此选项。 此值为可选项。
--gpu,--gp- 要分配给资源的 GPU 数量。 格式为 GPU_FAMILY:NUMBER_OF_GPUS。 NUMBER_OF_GPUS 的默认值为 1,可以是分数。 例如,
h100:0.5此值为可选值。 --max-scale,--maxscale,--max- 并行运行任务实例的最大数量。 此值为可选项。 缺省值为
1。 --maxexecutiontime,--met- 任务运行的最长执行时间(秒)。 此值为可选项。 缺省值为
0。 --memory,-m- 为任务设置的内存量。 使用
M表示兆字节,使用G表示千兆字节。 此值为可选项。 缺省值为2G。 --mount-data-store,--mount-ds- 挂载持久数据存储。 格式为 MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]。 SUBPATH 是可选项。 可以多次指定此选项。 此值为可选项。
--name,-n- 资源组的名称。 此值为可选项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --registry-secret,--rs- 注册表私钥的名称。 注册表私钥用于在私有注册表中进行身份验证,以便能下载容器映像。 运行
ibmcloud ce registry create创建注册表密文。 此值为可选项。 --retrylimit,-r- 将任务标记为失败前重新运行的次数。 此值为可选项。 缺省值为
3。 --subnetpool-id,--spi- 用于机群网络定位的子网池 ID。 此值为可选项。
--subnetpool-name,--spn- 用于机群网络部署的子网池名称。 此值为可选项。
--task-indexes,--ti- 指定要处理的任务索引,例如
0,3,6,9,1-5,7-8,10。 指定不超过 1000 个索引条目。 如果指定了--tasks,则不能指定该选项。 此值为可选项。 --tasks,--ts- 指定机群要处理的任务数量。 如果没有提供任务规范选项,则使用该选项,默认值为
1。 --tasks-from-cos-bucket,--ts-bucket- 指定 COS 文件桶内的文件位置。 对于每个文件,机群都要处理任务。 此值为可选项。
--tasks-from-cos-object,--ts-cos- 指定 COS 文件桶中的 JSONL 文件位置。 该文件定义了机群要处理的任务。 此值为可选项。
--tasks-from-local-file,--ts-file- 指定本地 JSONL 文件位置。 该文件定义了机群要处理的任务。 此值为可选项。
--worker-profile,--profile,--prof- 提供辅助工人的个人资料偏好。 此值为可选项。
示例
ibmcloud ce fleet create --image icr.io/codeengine/helloworld --subnetpool-name my-pool --tasks-state-store mytaskstore --tasks 1
示例输出
Successfully created fleet with name 'fleet-0123456789' and ID '1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e'
Run 'ibmcloud ce fleet get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e' to check the fleet status.
Run 'ibmcloud ce fleet worker list --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e' to retrieve a list of provisioned workers.
Run 'ibmcloud ce fleet task list --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e' to retrieve a list of tasks.
OK
ibmcloud ce fleet delete
删除无服务器机群。
ibmcloud ce fleet delete --id FLEET_ID [--force] [--ignore-not-found] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--id,--fid,--fleet-id- 必需。 无服务器机群的 ID。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --wait,-w- 删除无服务器机群,等待机群被删除。 此值为可选项。 缺省值为
false。 --wait-timeout,--wto- 等待无服务器机群被删除的时间(秒)。 此值为可选项。 缺省值为
180。
示例
ibmcloud ce fleet delete --force --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
示例输出
Deleting serverless fleet...
OK
ibmcloud ce fleet get
显示无服务器资源组的详细信息。
ibmcloud ce fleet get --id FLEET_ID [--output OUTPUT] [--quiet]
命令选项
--id,--fid,--fleet-id- 必需。 无服务器机群的 ID。 此值为必填项。
--output,-o- 输出格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce fleet get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
示例输出
Getting fleet '1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e'...
OK
Name: fleet-0123456789
ID: 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Status: running
Created: 2025-09-26T10:46:02Z
Project region: eu-de
Project name: myproj
Tasks status:
Pending: 893
Running: 12
Failed: 0
Canceled: 0
Successful: 96
Total: 1001
Code:
Container image reference: icr.io/codeengine/helloworld
Tasks specification:
Task state store: mytaskstore
Indexes: 0-1000
Resources and scaling:
CPU per instance: 1
Memory per instance: 2G
Max number of instances: 12
Max retries per task: 3
Network placement:
Subnet pools:
Name: my-pool-
Number of subnets: 1
Subnet CRN: crn:v1:bluemix:public:is:eu-de-1:a/abcdefabcdefabcdefabcd1234567890::subnet:1a1a-2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
Security Group CRN: crn:v1:bluemix:public:is:eu-de:a/abcdefabcdefabcdefabcd1234567890::security-group:2b2b-3c3c3c3c-4d4d-5e5e-6f6f-7g7g7g7g7g7g
Environment Variables:
Type Name Value
Literal FOO bar
ibmcloud ce fleet list
列出项目中的所有无服务器资源组。
ibmcloud ce fleet list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--output,-o- 输出格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name、status和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce fleet list
示例输出
Listing fleets...
OK
Name ID Status Tasks finished Tasks total Instances Created
fleet-a123456789 0a0a0a0a-2b2b-3c3c-4d4d-5e5e5e5e5e5e successful 300 300 0 2025-09-26T12:11:28Z
fleet-b123456789 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e running 778 1001 12 2025-09-26T12:43:11Z
fleet-c123456789 2a2a2a2a-2b2b-3c3c-4d4d-5e5e5e5e5e5e canceled 1 1 0 2025-09-26T10:46:02Z
ibmcloud ce fleet task
管理无服务器机群任务
ibmcloud ce fleet task COMMAND [--quiet]
命令选项
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
ibmcloud ce fleet task get
显示无服务器资源组任务的详细信息。
ibmcloud ce fleet task get --task-id TASK_ID --fleet-id FLEET_ID [--output OUTPUT] [--quiet]
命令选项
--fleet-id,--fid- 必需。 任务所属车队的 UUID。 此值为必填项。
--task-id,--tid,--id- 必需。 任务的 UUID。 此值为必填项。
--output,-o- 输出格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce fleet task get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e --task-id 2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
示例输出
Getting serverless fleet task '2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f'...
OK
ID: 2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
Task index: 226
Created: 2025-09-26T12:45:58Z
Finished: 2025-09-26T12:47:03Z
Fleet ID: 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Project name: myproj
Project ID: 3c3c3c3c-4d4d-5e5e-6f6f-7g7g7g7g7g7g
State information:
Status: successful
Retries: 0
Worker name: fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-1
ibmcloud ce fleet task list
列出无服务器机群的所有任务。
ibmcloud ce fleet task list --fleet-id FLEET_ID [--output OUTPUT] [--pagination-token PAGINATION_TOKEN] [--quiet] [--show-all-columns] [--sort-by SORT_BY] [--status STATUS]
命令选项
--fleet-id,--fid- 必需。 任务所属车队的 UUID。 此值为必填项。
--output,-o- 输出格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 此值为可选项。 --pagination-token,--pt- 显示以此分页标记开始的下一页任务。 此值为可选项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --show-all-columns,--sac- 显示附加列
Created和Finished。 此值为可选项。 缺省值为false。 --sort-by,--sb- 指定用于对列表进行排序的列。 有效值为
id、index和status。 此值为可选项。 默认值为index。 --status,--st- 显示具有指定状态的任务。 有效值为
canceled,failed,pending,running和succeeded。 此值为可选项。
示例
ibmcloud ce fleet task list --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
示例输出
Listing serverless fleet tasks...
OK
Task index ID Status Result code Worker name
0 5b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f successful 0 fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-0
1 4b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f running fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-1
2 3b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f pending
3 2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f running fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-1
4 1b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f successful 0 fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-0
ibmcloud ce fleet worker
管理无服务器机群工作者。
ibmcloud ce fleet worker COMMAND [--quiet]
命令选项
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
ibmcloud ce fleet worker delete
删除无服务器资源组工作程序。
ibmcloud ce fleet worker delete --name WORKER_NAME --fleet-id FLEET_ID [--force] [--hard] [--ignore-not-found] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--fleet-id,--fid- 必需。 工人所属车队的 ID。 此值为必填项。
--name,-n,--worker-name- 必需。 无服务器资源组工作程序的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --hard- 立即删除无服务器舰队 Worker。 如果不指定“硬”选项,则会继续处理由该 Worker 处理的“运行中”任务,直到这些任务达到最终状态,然后才会删除 Worker。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --wait,-w- 删除无服务器资源组工作程序,等待工作程序被删除。 此值为可选项。 缺省值为
false。 --wait-timeout,--wto- 等待无服务器资源组工作程序被删除的时间(秒)。 此值为可选项。 缺省值为
180。
示例
ibmcloud ce fleet worker delete --force --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e --worker-name fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-42
示例输出
Deleting serverless fleet worker...
OK
ibmcloud ce fleet worker get
显示无服务器资源组工作程序的详细信息。
ibmcloud ce fleet worker get --name WORKER_NAME --fleet-id FLEET_ID [--output OUTPUT] [--quiet]
命令选项
--fleet-id,--fid- 必需。 工人所属车队的 ID。 此值为必填项。
--name,-n,--worker-name- 必需。 无服务器资源组工作程序的名称。 此值为必填项。
--output,-o- 输出格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce fleet worker get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e --worker-name fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-42
示例输出
Getting serverless fleet worker...
OK
Name: fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-42
ID: 2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
Created: 2025-09-26T20:05:33Z
Status: running
Version: v1.0.15
Fleet ID: 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Project name: myproj
Project ID: 3c3c3c3c-4d4d-5e5e-6f6f-7g7g7g7g7g7g
Network placement:
IP address: 10.242.0.42
Network zone: eu-de-1
Subnet CRN: crn:v1:bluemix:public:is:eu-de-1:a/abcdefabcdefabcdefabcd1234567890::subnet:1a1a-2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
Profile information:
Profile: cx2-2x4
vCPUs: 2
Memory (GiB): 4
ibmcloud ce fleet worker list
列出无服务器机群的所有工作者。
ibmcloud ce fleet worker list --fleet-id FLEET_ID [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--fleet-id,--fid,--id- 必需。 工人所属车队的 ID。 此值为必填项。
--output,-o- 输出格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和status。 此值为可选项。 默认值为name。
示例
ibmcloud ce fleet worker list --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
示例输出
Listing serverless fleet workers...
OK
Name ID Status Profile IP Zone Version
fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-0 2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f running cx2-2x4 10.242.0.42 eu-de-1 v1.0.15
fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-1 3c3c3c3c-4d4d-5e5e-6f6f-7g7g7g7g7g7g initializing cx2-8x16 10.242.0.43 eu-de-1 v1.0.15
ibmcloud ce fleet worker profiles
列出无服务器机群支持的工人配置文件。
ibmcloud ce fleet worker profiles [--output OUTPUT] [--profile-family PROFILE_FAMILY] [--quiet] [--region REGION] [--sort-by SORT_BY]
命令选项
--output,-o- 输出格式。 有效值为 "json"、"yaml"、"jsonpath=JSONPATH_EXPRESSION "和 "jsonpath-as-json=JSONPATH_EXPRESSION"。 此值为可选项。
--profile-family,--pf- 显示属于指定工人配置文件族的配置文件。 有效值为 [
b,balanced,c,compute,m,memory,g,gpu,f,flex]。该值为 可选的。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --region,-r- 显示指定区域支持的工人配置文件。 此值为可选项。
--sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name,cpu,disk,和memory。 此值为可选项。 默认值为name。
示例
ibmcloud ce fleet worker profiles --profile-family --region br-sao
示例输出
Listing fleet worker profiles...
OK
Name CPU Memory Disk GPU family Region
gx2-8x64x1v100 8 64Gi 0 v100 br-sao
gx2-32x256x2v100 32 256Gi 0 v100 br-sao
gx3-48x240x2l40s 48 240Gi 0 l40s br-sao
gx3-64x320x4l4 64 320Gi 0 l4 br-sao
gx3d-160x1792x8h100 160 1792Gi 60Ti h100 br-sao
功能命令
函数是一个无状态代码段,在 HTTP 请求调用时执行任务。 通过 IBM Code Engine 函数,您可以以可扩展和无服务器的方式运行业务逻辑。 IBM Code Engine 功能提供优化的运行环境,支持低延迟和快速扩展。 您的函数代码可以在托管运行时编写,托管运行时包括特定的 Node.js 或 Python 版本。
在使用 function 命令之前,您必须处于 项目 的上下文环境中。
有关使用函数的更多信息,请参阅 使用函数。
ibmcloud ce function bind
将 IBM Cloud 服务实例绑定到函数。
ibmcloud ce function bind --name FUNCTION_NAME (--service-instance SI_NAME | --service-instance-id SI_ID) [--no-wait] [--prefix PREFIX] [--quiet] [--role ROLE] [--service-credential SERVICE_CREDENTIAL] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--name,-n- 要绑定的函数的名称。 此值为必填项。
--no-wait,--nw- 绑定服务实例,不要等待服务绑定准备就绪。 如果指定
no-wait选项,服务绑定创建将启动,命令无需等待完成即可退出。 使用function get命令检查功能绑定状态。 此值为可选项。 缺省值为false。 --prefix,-p- 为此服务绑定创建的环境变量的前缀。 必须只包含大写字母、数字和下划线 (_),并且不能以数字开头。 此值为可选项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --role,-r- 为该服务绑定创建的新服务凭证的服务角色名称。 有效值包括
Reader,Writer,Manager或特定于服务的角色。 该选项默认为Manager,如果不支持Manager,则默认为服务提供的第一个角色。 如果指定了--service-credential,该选项将被忽略。 此值为可选项。 --service-credential,--sc- 要用于此服务绑定的现有服务凭证的名称。 如果未指定服务实例凭据,则会在绑定操作期间生成新凭据。 此值为可选项。
--service-instance,--si- 要绑定到函数的现有 IBM Cloud 服务实例的名称。 此值为可选项。
--service-instance-id,--siid- 要绑定到函数的现有 IBM Cloud 服务实例的 GUID。 此值为可选项。
--wait,-w- 绑定服务实例,等待服务绑定就绪。 如果指定
--wait选项,函数绑定将等待--wait-timeout选项设定的最长秒数,函数绑定才能成功完成。 如果在指定的--wait-timeout时间内未成功完成功能绑定或功能绑定失败,则命令失败。 此值为可选项。 缺省值是true。 --wait-timeout,--wto- 等待服务绑定就绪的时间长度(秒)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为300。
示例
ibmcloud ce fn bind --name myfunction --service-instance my-object-storage
示例输出
Binding service instance...
Status: Done
OK
ibmcloud ce function create
创建函数。
ibmcloud ce function create --name FUNCTION_NAME [--build-commit BUILD_COMMIT] [--build-context-dir BUILD_CONTEXT_DIR] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-source BUILD_SOURCE] [--build-timeout BUILD_TIMEOUT] [--code-bundle CODE_BUNDLE] [--code-bundle-secret CODE_BUNDLE_SECRET] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--force] [--inline-code INLINE_CODE] [--main MAIN] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--no-wait] [--output OUTPUT] [--quiet] [--runtime RUNTIME] [--scale-down-delay SCALE_DOWN_DELAY] [--trusted-profiles-enabled] [--visibility VISIBILITY] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
-n,--name- 函数的名称。 请使用项目中唯一的名称。
- 名称必须以小写字母开头。
- 名称必须以小写字母数字字符结尾。
- 名称必须少于或等于 63 个字符,可包含小写字母、数字和连字符 (-)。
此值为必填项。
--runtime,-r- 函数使用的运行时间。 要查找该区域支持的运行时间,请运行
ibmcloud ce function runtimes。 参见 运行时间。 此值为必填项。 --build-commit,--commit,--bcm,--cm,--revision- 要提取的源代码库中的提交、标记或分支。 此值为可选项。
--build-context-dir,--context-dir,--bcdr,--cdr- 存储库中包含函数源代码的目录。 此值为可选项。
--build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- SSH 私钥的名称,其中包含用于访问专用存储库的凭证,该存储库包含用于构建代码束映像的源代码。 要创建此 SSH 秘密,请使用
secret create --format SSH命令。 SSH 密文也可用作 Git 存储库访问密文。 只有当--build-source选项设置为 Git 资源库的 URL 时,才允许使用该选项。 此值为可选项。 --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- 使用以下方法之一,根据存储在此配置映射中的键值对设置环境变量。
- 要为名为
configmapName的配置映射中的所有键添加环境变量,请使用configmapName。 您可以在引用 configmap 时通过指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=CONFIGMAP_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. 例如,要将配置映射configmapName中所有键的变量名前缀设置为CUSTOM_,请使用值CUSTOM_=configmapName。 如果配置映射configmapName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为configmapName的配置映射中为单键key1添加环境变量,请使用configmapName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为configmapName的配置映射中为单键key1添加名为myKey的环境变量,请使用值configmapName:myKey=key1。
此值为可选项。
--env-sec,--env-from-secret- 使用以下方法之一,根据存储在秘密中的键值对设置环境变量。
- 要为名为
secretName的秘密中的所有密钥添加环境变量,请使用secretName。 您可以通过在引用秘密时指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=SECRET_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,要将密文secretName中所有密钥变量名的前缀设置为CUSTOM_,请使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为secretName的密钥中为单个密钥key1添加环境变量,请使用secretName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为secretName的密文中为单个密钥key1添加名为myKey的环境变量,请使用secretName:myKey=key1。
此值为可选项。
--force,-f- 不验证指定的 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
示例输出
Preparing function 'myfunction' for build push...
Creating function 'myfunction'...
Packaging files to upload from source path 'main.js'...
Submitting build run 'myfunction-run-111111-12345678'...
Creating image 'private.stg.icr.io/ce--1a1a1-11c22def3rhz/function-myfunction:12345678-1111-dexla'...
Waiting for build run to complete...
Build run status: 'Running'
Build run completed successfully.
Run 'ibmcloud ce buildrun get -n myfunction-run-111111-12345678' to check the build run status.
Waiting for function 'myfunction' to become ready...
Function 'myfunction' is ready.
OK
Run 'ibmcloud ce function get -n myfunction' to see more details.
https://myfunction.11c22def3rhz.us-south.codeengine.appdomain.cloud
运行 ibmcloud ce fn get -n 'myfunction' 检查功能状态时,将显示功能的 URL。
ibmcloud ce function delete
删除函数。
ibmcloud ce function delete --name FUNCTION_NAME [--force] [--ignore-not-found] [--quiet]
命令选项
--name,-n- 函数的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce fn delete --name myfunction
示例输出
Are you sure you want to delete function 'myfunction'? [y/N]> y
Deleting function 'myfunction'...
OK
ibmcloud ce function get
显示函数的详细信息。
ibmcloud ce function get --name FUNCTION_NAME [--output OUTPUT] [--quiet] [--save SAVE]
命令选项
--name,-n- 函数的名称。 此值为必填项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --save,-s- 将函数的源代码保存到本地文件系统中。 只有使用内联代码创建的函数才支持该选项。 此值为可选项。
示例
ibmcloud ce fn get --name myfunction
示例输出
Getting function 'myfunction'...
OK
Name: myfunction
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 6m8s
Created: 2023-06-22T19:59:51Z
URL: https://myfunction.11c22def3rhz.us-south.codeengine.appdomain.cloud
Status: Ready
Resources:
CPU: 0.25
Memory: 500M
Max Execution Time: 60 seconds
Build Information:
Build Run Name: myfunction-run-111111-12345678
Build Type: local
Build Strategy: codebundle-nodejs-20
Timeout: 600
Source: main.js
Build Run Summary: Succeeded
Build Run Status: Succeeded
Build Run Reason: All Steps have completed executing
Run 'ibmcloud ce buildrun get -n myfunction-run-111111-12345678' for details.
Function Code:
Runtime: nodejs-20 (managed)
Bundle Secret: ce-auto-icr-private-us-south
Code Bundle: cr://icr.io/ce--1a1a1-11c22def3rhz/function-myfunction:12345678-1111-dexla
Main: main()
ibmcloud ce function list
列出项目中的所有函数。
ibmcloud ce function list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce fn delete --name myfunction
示例输出
Name Status URL CPU Memory Age
hellofunction Ready https://hellofunction.4svg40kna19.us-south.codeengine.appdomain.cloud 0.25 500M 25h
myfunction Ready https://myfun1.4svg40kna19.us-south.codeengine.appdomain.cloud 0.25 1G 8d
helloworld Ready https://myfunction1.4svg40kna19.us-south.codeengine.appdomain.cloud 0.25 1G 16d
myfunction1 Ready https://myfunction111.4svg40kna19.us-south.codeengine.appdomain.cloud 0.25 500M 25h
myfunction3 Ready https://myfunction41.4svg40kna19.us-south.codeengine.appdomain.cloud 0.25 500M 25h
ibmcloud ce function runtimes
列出可用函数运行时。
ibmcloud ce function runtimes [--all] [--output OUTPUT] [--quiet]
命令选项
--all,-A- 显示所有运行时,包括不推荐的运行时。 此值为可选项。 缺省值为
false。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce fn runtimes
示例输出
Name ID Family Default
Python 3.11 python-3.11 python true
Node.js 20 nodejs-20 nodejs false
Node.js 22 nodejs-22 nodejs true
Node.js 24 nodejs-24 nodejs false
Python 3.13 python-3.13 python false
ibmcloud ce function unbind
从函数中解除绑定 IBM Cloud 服务实例。
ibmcloud ce function unbind --name FUNCTION_NAME (--binding BINDING_NAME | --all) [--quiet]
命令选项
--name,-n- 要取消绑定的函数的名称。 此值为必填项。
--all,-A- 取消绑定此函数的所有服务实例。 如果未指定
--binding,则必须使用该值。 缺省值为false。 --binding,-b- 要解除绑定的绑定名称。 运行
ibmcloud ce function get -n FUNCTION_NAME查看绑定名称。 如果未指定--all,则必须使用该值。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce fn unbind --name myfunction --all
示例输出
Removing bindings from 'myfunction'...
OK
ibmcloud ce function update
更新函数。
ibmcloud ce function update --name FUNCTION_NAME [--build-clear] [--build-commit BUILD_COMMIT] [--build-commit-clear] [--build-context-dir BUILD_CONTEXT_DIR] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-git-repo-secret-clear] [--build-source BUILD_SOURCE] [--build-timeout BUILD_TIMEOUT] [--code-bundle CODE_BUNDLE] [--code-bundle-secret CODE_BUNDLE_SECRET] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-configmap-rm ENV_FROM_CONFIGMAP_RM] [--env-from-secret ENV_FROM_SECRET] [--env-from-secret-rm ENV_FROM_SECRET_RM] [--env-rm ENV_RM] [--force] [--inline-code INLINE_CODE] [--main MAIN] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--no-wait] [--output OUTPUT] [--quiet] [--rebuild] [--runtime RUNTIME] [--scale-down-delay SCALE_DOWN_DELAY] [--trusted-profiles-enabled] [--visibility VISIBILITY] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--name,-n- 必需。 函数的名称。 此值为必填项。
--build-clear,--bc- 从此函数中除去构建的关联。 只有在函数当前有相关联的构建时,才允许使用“构建清除”选项。 此值为可选项。 缺省值为
false。 --build-commit,--commit,--bcm,--cm,--revision- 要提取的源代码库中的提交、标记或分支。 此值为可选项。
--build-commit-clear,--commit-clear,--bcmc,--cmc- 清除要拉取的源存储库中的落实、标记或分支。 只有在函数当前有关联的构建时,才允许使用提交清除选项。 此值为可选项。 缺省值为
false。 --build-context-dir,--context-dir,--bcdr,--cdr- 存储库中包含函数源代码的目录。 只有设置了
--build-source选项,才允许使用该选项。 此值为可选项。 --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- SSH 密文的名称,其中包含访问私有资源库的凭证,该资源库包含用于构建映像的源代码。 此值为可选项。
--build-git-repo-secret-clear,--git-repo-secret-clear,--bgrsc,--grsc- 清除 SSH 私钥。 只有在您的函数当前有相关联的构建时,才允许使用该选项。 此值为可选项。 缺省值为
false。 --build-source,--source,--bsrc,--src- Git 源的 URL 或包含源代码的本地源的路径;例如
https://github.com/IBM/CodeEngine或.。 此值为可选项。 --build-timeout,--bto- 在构建成功或失败之前可能经过的时间(以秒为单位)。 此值为可选项。 缺省值为
600。 --code-bundle,--cb- 用于此功能的
code-bundle图像名称。 当指定build-source时,该值即为推送构建生成的输出映像的路径。 如果未指定build-source,该值就是现有代码捆绑包映像的路径。 格式为REGISTRY/NAMESPACE/REPOSITORY:TAG,其中TAG为可选项。 如果未指定TAG,则默认为latest。 此值为可选项。 --code-bundle-secret,--cs,--cbs- 用于向专用注册表进行认证的注册表私钥的名称。 您可以通过运行
registry create命令来添加注册表秘密。 此值为可选项。 --cpu- 针对函数实例设置的 CPU 量。 有关有效值,请参阅 支持的内存和 CPU 组合。 此值为可选项。 缺省值为
1。 --env,-e- 在函数中设置环境变量。 必须采用
NAME=VALUE格式。 此操作可添加新的环境变量或覆盖现有的环境变量。 每个--env选项指定一个环境变量;例如,--env envA=A --env envB=B. 此值为可选项。 --env-cm,--env-from-configmap- 使用以下方法之一,根据存储在此配置映射中的键值对设置环境变量:
- 要为名为
configmapName的配置映射中的所有键添加环境变量,请使用configmapName。 您可以在引用 configmap 时通过指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=CONFIGMAP_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. 例如,要将配置映射configmapName中所有键的变量名前缀设置为CUSTOM_,请使用值CUSTOM_=configmapName。 如果配置映射configmapName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为configmapName的配置映射中为单键key1添加环境变量,请使用configmapName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为configmapName的配置映射中为单键key1添加名为myKey的环境变量,请使用值configmapName:myKey=key1。
此值为可选项。
--env-from-configmap-rm,--env-cm-rm- 使用配置映射名称,删除对完整配置映射的环境变量引用。 要删除对配置映射的单个键引用,请使用
--env-rm选项。 可以多次指定此选项。 此值为可选项。 --env-sec,--env-from-secret- 使用以下方法之一,根据存储在秘密中的键值对设置环境变量:
- 要为名为
secretName的秘密中的所有密钥添加环境变量,请使用secretName。 您可以通过在引用秘密时指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=SECRET_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,要将密文secretName中所有密钥变量名的前缀设置为CUSTOM_,请使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为secretName的密钥中为单个密钥key1添加环境变量,请使用secretName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为secretName的密文中为单个密钥key1添加名为myKey的环境变量,请使用secretName:myKey=key1。
此值为可选项。
--env-from-secret-rm,--env-sec-rm- 使用秘密名称,删除环境变量对完整秘密的引用。 要删除机密的单个密钥引用,请使用
--env-rm选项。 可以多次指定此选项。 此值为可选项。 --env-rm- 删除对配置表或机密中键值对的键的环境变量引用。 要删除单个键引用和字面值,请指定键的名称。 可以多次指定此选项。 此值为可选项。
--force,-f- 不验证指定的 configmap 和秘密引用是否存在。 使用
--env-from-configmap或--mount-configmap选项可指定 Configmap 引用。 使用--env-from-secret、--mount-secret或--registry-secret选项指定秘密引用。 此值为可选项。 缺省值为false。 --inline-code- 指定包含函数源代码的文件的路径。 代码与函数内联存储。 此值为可选项。
--main,--fn-main- 在提供的源代码中指定主函数的名称。 当名称不是
main时,需要使用该选项。 此值为可选项。 缺省值为main。 --maxexecutiontime,--met- 该函数完成运行的最长执行时间(秒)。 此值为可选项。 缺省值为
60。 --memory,-m- 为功能设置的内存量。 使用
M表示兆字节,使用G表示千兆字节。 有关有效值,请参阅 支持的内存和 CPU 组合。 此值为可选项。 默认值为4G。 --no-wait,--nw- 提交构建运行,不要等待构建运行完成。 如果指定
--no-wait选项,则会开始提交构建运行,而不会等待。 使用buildrun get命令检查构建运行状态。 此值为可选项。 缺省值为false。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --rebuild- 从源图像重建图像 只有在函数当前有相关联的构建时,才允许使用重建选项。 此值为可选项。 缺省值为
false。 --runtime,-r- 函数使用的运行时间。 要查找该区域支持的运行时间,请运行
ibmcloud ce function runtimes。 参见 运行时间。 此值为可选项。 --scale-down-delay,--sdd- 调用完成后实例处于活动状态的时间量(以秒为单位)。 此选项可减少冷启动时间。 如需了解更多信息,请参阅 " 我可以让函数实例存活更长时间吗? 此值为可选项。 缺省值为
1。 --trusted-profiles-enabled,--trusted,--tpe- 启用为该函数的运行挂载计算资源标记。 此值为可选项。 缺省值为
false。 --visibility,-v- 函数的可视性。 有效值为
public,private,和project。 只有当项目支持功能私有可见性时,可见性才能被private。 此值为可选项。 --wait,-w- 等待构建运行完成。 此值为可选项。 缺省值为
true。 --wait-timeout,--wto- 等待功能就绪的时间长度(秒)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为600。
示例
ibmcloud ce fn update --name myfunction --runtime nodejs-20 --build-source main.js
示例输出
Preparing function 'myfunction' for build push...
Updating function 'myfunction'...
Packaging files to upload from source path 'main.js'...
Submitting build run 'myfunction-run-111111-12345678'...
Creating image 'icr.io/ce--1a1a1-11c22def3rhz/function-myfunction:12345678-1111-dexla'...
Waiting for build run to complete...
Build run status: 'Running'
Build run completed successfully.
Run 'ibmcloud ce buildrun get -n myfunction-run-111111-12345678' to check the build run status.
Waiting for function 'myfunction' to become ready...
Function 'myfunction' is ready.
OK
Run 'ibmcloud ce function get -n myfunction' to see more details.
https://myfunction.11c22def3rhz.us-south.codeengine.appdomain.cloud
运行 ibmcloud ce fn get -n 'myfunction' 检查功能状态时,将显示功能的 URL。
帮助命令
Code Engine help 命令提供每个命令组可用命令的信息。
ibmcloud ce help
Code Engine help 命令提供每个命令组可用命令的信息。
ibmcloud ce help COMMAND
示例
ibmcloud ce help
示例输出
NAME:
code-engine, ce - Manage Code Engine components
USAGE:
ibmcloud ce command [arguments...] [options...]
COMMANDS:
application, app Manage applications.
binding Manage bindings.
build, bd, b Manage configurations for generating images from source code.
buildrun, br Generate images from a build.
configmap, cm Manage configmaps.
domainmapping, dm Manage domain mappings.
experimental, exp Experimental Code Engine commands
function, fn Manage functions.
help, h Show help.
job Manage jobs to configure tasks.
jobrun, jr Manage instances of a job.
connectivity, conn Manage connectivity commands
project, proj Manage Code Engine projects.
reclamation, recl Manage Code Engine project reclamations.
registry Manage image registry access secrets.
repo Manage Git repository access secrets.
revision, rev Manage application revisions.
secret Manage secrets.
serviceaccess Manage service access secrets.
subscription, sub Manage event subscriptions.
version, v Display the 'code-engine' command-line interface version.
Enter 'ibmcloud ce help command' for more information about a command.
工作指令
一个作业并行运行一个或多个可执行代码实例。 与处理 HTTP 请求的应用程序不同,作业只运行一次,然后退出。 创建作业时,可以指定每次运行作业时使用的工作负载配置信息。 使用 job 命令为工作创建配置。
在使用 job 命令之前,您必须处于 项目 的上下文环境中。
有关工作的更多信息,请参阅 运行工作。
要查看 job 命令的 CLI 帮助,请运行 ibmcloud ce job -h。
ibmcloud ce job bind
将 IBM Cloud 服务实例绑定到作业。
ibmcloud ce job bind --name JOB_NAME (--service-instance SI_NAME | --service-instance-id SI_ID) [--no-wait] [--prefix PREFIX] [--quiet] [--role ROLE] [--service-credential SERVICE_CREDENTIAL] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--name,-n- 要绑定的任务名称。 此值为必填项。
--no-wait,--nw- 绑定服务实例,不要等待服务绑定准备就绪。 如果指定
--no-wait选项,服务绑定创建将启动,命令无需等待完成即可退出。 使用job get命令检查作业绑定状态。 此值为可选项。 缺省值为false。 --prefix,-p- 为此服务绑定创建的环境变量的前缀。 必须只包含大写字母、数字和下划线 (_),并且不能以数字开头。 此值为可选项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --role,-r- 为该服务绑定创建的新服务凭证的服务角色名称。 有效值包括
Reader,Writer,Manager或特定于服务的角色。 该选项默认为Manager,如果不支持Manager,则默认为服务提供的第一个角色。 如果指定了--service-credential,该选项将被忽略。 此值为可选项。 --service-credential,--sc- 要用于此服务绑定的现有服务凭证的名称。 如果未指定服务实例凭据,则会在绑定操作期间生成新凭据。 此值为可选项。
--service-instance,--si- 要绑定到任务的现有 IBM Cloud 服务实例的名称。 此值为可选项。
--service-instance-id,--siid- 要绑定到任务的现有 IBM Cloud 服务实例的 GUID。 此值为可选项。
--wait,-w- 绑定服务实例,等待服务绑定就绪。 如果指定
--wait选项,则作业绑定会等待--wait-timeout选项设置的最长秒数,等待作业绑定成功完成。 如果在指定的--wait-timeout时间内未成功完成任务绑定或任务绑定失败,则命令失败。 此值为可选项。 缺省值是true。 --wait-timeout,--wto- 等待服务绑定就绪的时间长度(秒)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为300。
示例
在本例中,将名为 my-object-storage 的服务实例与名为 hello 的作业绑定。
ibmcloud ce job bind --name hello --service-instance my-object-storage
示例输出
Binding service instance...
Waiting for service binding to become ready...
Status: Pending (Processing Resource)
Status: Pending (Processing Resource)
Status: Creating service binding
Status: Creating service binding
Status: Ready
OK
ibmcloud ce job create
创建作业。
ibmcloud ce job create --name JOB_NAME ((--image IMAGE_REF | (--build-source SOURCE [--image IMAGE_REF])) [--argument ARGUMENT] [--array-indexes ARRAY_INDEXES] [--array-size ARRAY_SIZE] [--build-commit BUILD_COMMIT] [--build-context-dir BUILD_CONTEXT_DIR] [--build-dockerfile BUILD_DOCKERFILE] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-size BUILD_SIZE] [--build-strategy BUILD_STRATEGY] [--build-timeout BUILD_TIMEOUT] [--command COMMAND] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-secret MOUNT_SECRET] [--no-wait] [--output OUTPUT] [--quiet] [--registry-secret REGISTRY_SECRET] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
-n,--name- 作业的名称。 请使用项目中唯一的名称。
- 名称必须以小写字母数字字符开头和结尾。
- 名称必须少于或等于 63 个字符,可包含小写字母、数字和连字符 (-)。
此值为必填项。
--argument,--arg,-a- 设置运行任务的参数。 每个
--argument选项指定一个参数;例如,-a argA -a argB。 此值为可选项。 --array-indexes,--array-indices,--ai- 指定用于运行任务的数组索引,例如
0,3,6,9,1-5,7-8,10。 索引的结果集限于 1000 个条目。 只有在未指定array-size时才能指定该选项。 此值为可选项。 缺省值是0。 --array-size,--as,--instances,--is- 指定用于作业运行的实例数。 使用该选项时,系统将转换为数组索引。 例如,如果指定
5的instances,系统会将其转换为0 - 4的array-indexes。 只有在未指定--array-indexes选项时才能指定该选项。 此值为可选项。 缺省值为1。 --build-commit,--commit,--bcm,--cm,--revision- 要提取的源代码库中的提交、标记或分支。 只有当
--build-source选项设置为 Git 版本库的 URL 时,才允许使用构建提交选项。 此值为可选项。 --build-context-dir,--context-dir,--bcdr,--cdr- 版本库中包含 buildpacks 文件或 Dockerfile 的目录。 只有设置了
--build-source选项,才允许使用构建上下文目录选项。 此值为可选项。 --build-dockerfile,--dockerfile,--bdf,--df- Dockerfile 的路径。 只有当名称不是
Dockerfile时才指定该选项。 只有设置了--build-source选项,才允许使用 build dockerfile 选项。 此值为可选项。 默认值为Dockerfile。 --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- SSH 私钥的名称,其中包含用于访问专用存储库的凭证,该专用存储库包含用于构建容器映像的源代码。 要创建此 SSH 秘密,请使用
secret create --format SSH命令。 SSH 密文也可用作 Git 存储库访问密文。 只有当--build-source选项设置为 Git 资源库的 URL 时,才允许使用该选项。 此值为可选项。 --build-size,--size,--bsz,--sz- 构建的大小,它决定了使用的资源量。 有效值为
small,medium,large,xlarge和xxlarge。 有关详情,请参阅 确定构建大小。 只有设置了--build-source选项,才允许使用构建大小选项。 此值为可选项。 缺省值为medium。 --build-source,--source,--bsrc,--src- Git 源的 URL 或包含源代码的本地源的路径;例如
https://github.com/IBM/CodeEngine或.。 此值为可选项。 --build-strategy,--strategy,--bstr,--str- 用于构建映像的策略。 有效值为
dockerfile和buildpacks。 只有设置了--build-source选项,才允许使用构建策略选项。 如果未指定,则在指定--build-source且源代码位于本地计算机上时,由 Code Engine 决定构建策略。 此值为可选项。 默认值为dockerfile。 --build-timeout,--bto- 在构建成功或失败之前可能经过的时间(以秒为单位)。 只有设置了
--build-source选项,才允许使用构建超时选项。 此值为可选项。 缺省值为600。 --command,--cmd,-c- 设置运行任务的命令。 每个
--command选项指定一条命令;例如,--cmd cmdA --cmd cmdB。 该值会覆盖容器映像中指定的默认命令。 此值为可选项。 --cpu- 为运行任务设置的 CPU 数量。 有关有效值,请参阅 支持的内存和 CPU 组合。 此值为可选项。 缺省值为
1。 --env,-e- 为任务运行设置环境变量。 必须采用
NAME=VALUE格式。 此操作可添加新的环境变量或覆盖现有的环境变量。 每个--env选项指定一个环境变量;例如,--env envA=A --env envB=B. 此值为可选项。 --env-cm,--env-from-configmap- 使用以下方法之一,根据存储在此配置映射中的键值对设置环境变量:
- 要为名为
configmapName的配置映射中的所有键添加环境变量,请使用configmapName。 您可以在引用 configmap 时通过指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=CONFIGMAP_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. 例如,要将配置映射configmapName中所有键的变量名前缀设置为CUSTOM_,请使用值CUSTOM_=configmapName。 如果配置映射configmapName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为configmapName的配置映射中为单键key1添加环境变量,请使用configmapName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为configmapName的配置映射中为单键key1添加名为myKey的环境变量,请使用值configmapName:myKey=key1。
此值为可选项。
--env-sec,--env-from-secret- 使用以下方法之一,根据存储在秘密中的键值对设置环境变量:
- 要为名为
secretName的秘密中的所有密钥添加环境变量,请使用secretName。 您可以通过在引用秘密时指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=SECRET_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,要将密文secretName中所有密钥变量名的前缀设置为CUSTOM_,请使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为secretName的密钥中为单个密钥key1添加环境变量,请使用secretName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为secretName的密文中为单个密钥key1添加名为myKey的环境变量,请使用secretName:myKey=key1。
此值为可选项。
--ephemeral-storage,--es- 为任务运行设置的短暂存储量。 使用
M表示兆字节,使用G表示千兆字节。 此值为可选项。 缺省值为400M。 --force,-f- 不验证指定的 configmap 和秘密引用是否存在。 使用
--env-from-configmap选项可指定 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- 通过提供挂载目录和配置映射名称,将配置映射的内容添加到运行任务的文件系统中,格式为
MOUNT_DIRECTORY=CONFIGMAP_NAME. 每个挂载的 configmap 必须使用唯一的挂载目录。 对于配置映射中的每个键值对,都会在指定的挂载目录中添加一个文件,文件名是键,文件内容是键值对的值。 每个--mount-configmap选项指定一个挂载配置;例如,--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值为可选项。 --mount-data-store,--mount-ds- 挂载持久数据存储。 格式为 MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]。 SUBPATH 是可选项。 可以多次指定此选项。 此值为可选项。
--mount-secret,--mount-sec- 通过提供挂载目录和秘密名称,将秘密内容添加到运行任务的文件系统中,格式为
MOUNT_DIRECTORY=SECRET_NAME. 每个挂载的秘密必须使用唯一的挂载目录。 对于密文中的每个键值对,都会在指定的挂载目录中添加一个文件,文件名就是键,文件内容就是键值对的值。 每个--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- 将作业标记为失败之前重新运行该作业的实例的次数。 当作业的退出代码不是 0 时,会重新运行该作业的数组索引。 只有在
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选项,才允许使用等待选项。 此值为可选项。 缺省值为true。 --wait-timeout,--wto- 等待构建运行完成的时间长度(以秒为单位)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 只有设置了--build-source选项,才允许使用等待超时选项。 缺省值为600。
示例
下面的示例使用容器映像 icr.io/codeengine/firstjob,并为容器分配 2G MB 内存和 1 个 CPU。 有关选择有效内存和 CPU 值的更多信息,请参阅 支持的内存和 CPU 组合。
ibmcloud ce job create --image icr.io/codeengine/firstjob --name hellojob --memory 2G --cpu 1
示例输出
Creating job 'hellojob'...
OK
ibmcloud ce job delete
删除作业及其相关的作业运行。
ibmcloud ce job delete --name JOB_NAME [--force] [--ignore-not-found] [--orphan-job-runs] [--quiet]
命令选项
--name,-n- 作业的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --orphan-job-runs,-o- 指定保留与此作业配置相关联的任何作业运行。 然后,必须单独删除这些孤儿作业运行。 此值为可选项。 缺省值为
false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce job delete --name hello
示例输出
Are you sure you want to delete job hello? [y/N]> y
Deleting job 'hello'...
OK
运行 ibmcloud ce job delete 命令删除作业时,所有引用该作业的已提交作业运行也会被删除。
ibmcloud ce job get
显示任务的详细信息。
ibmcloud ce job get --name JOB_NAME [--output OUTPUT] [--quiet]
命令选项
--name,-n- 作业的名称。 此值为必填项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce job get --name hellojob
示例输出
Getting job 'hellojob'...
OK
Name: hellojob
ID: abcdabcd-abcd-abcd-abcd-abcdabcd1111
Project Name: myproj
Project ID: 01234567-abcd-abcd-abcd-abcdabcd2222
Age: 59s
Created: 2021-03-01T15:33:30-05:00
Last Job Run:
Name: hellojob-jobrun-abcde
Age: 32d
Created: 2021-06-06T13:52:42-04:00
Image: icr.io/codeengine/firstjob
Resource Allocation:
CPU: 1
Memory: 4G
Runtime:
Mode: task
Array Indices: 0
Array Size: 1
Max Execution Time: 7200
Retry Limit: 3
ibmcloud ce job list
列出项目中的所有工作。
ibmcloud ce job list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce job list
示例输出
Name Age Last Job Run Name Last Job Run Age
demo 110d demo-jobrun-hkkmx 108d
myjob-envvar 107d
hellojob 7s
myjob 60d myjob-977v7 58d
testjob 88d testjob-jobrun-kzxlp 72d
ibmcloud ce job unbind
从作业中解除绑定 IBM Cloud 服务实例,以移除现有服务绑定。
ibmcloud ce job unbind --name JOB_NAME (--binding BINDING_NAME | --all) [--quiet]
命令选项
--name,-n- 要解除绑定的任务名称。 此值为必填项。
--all,-A- 解除该任务的所有服务实例绑定。 如果未指定
--binding,则必须使用该值。 缺省值为false。 --binding,-b- 要解除绑定的绑定名称。 运行
ibmcloud ce job get -n JOB_NAME查看绑定名称。 如果未指定--all,则必须使用该值。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
在本例中,从名为 hello 的作业中删除所有绑定。
ibmcloud ce job unbind --name hello --all
示例输出
Removing service bindings...
OK
ibmcloud ce job update
更新任务
ibmcloud ce job update --name JOB_NAME [--argument ARGUMENT] [--arguments-clear] [--array-indexes ARRAY_INDEXES] [--array-size ARRAY_SIZE] [--build-clear] [--build-commit BUILD_COMMIT] [--build-commit-clear] [--build-context-dir BUILD_CONTEXT_DIR] [--build-dockerfile BUILD_DOCKERFILE] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-git-repo-secret-clear] [--build-size BUILD_SIZE] [--build-source BUILD_SOURCE] [--build-strategy BUILD_STRATEGY] [--build-timeout BUILD_TIMEOUT] [--command COMMAND] [--commands-clear] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-configmap-rm ENV_FROM_CONFIGMAP_RM] [--env-from-secret ENV_FROM_SECRET] [--env-from-secret-rm ENV_FROM_SECRET_RM] [--env-rm ENV_RM] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--image IMAGE] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-rm MOUNT_RM] [--mount-secret MOUNT_SECRET] [--no-wait] [--output OUTPUT] [--quiet] [--rebuild] [--registry-secret REGISTRY_SECRET] [--registry-secret-clear] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--service-account-clear] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--name,-n- 作业的名称。 此值为必填项。
--argument,--arg,-a- 设置运行任务的参数。 每个
--argument选项指定一个参数;例如,-a argA -a argB。 此值为可选项。 --arguments-clear,--ac- 清除作业参数。 此值为可选项。 缺省值为
false。 --array-indexes,--array-indices,--ai- 指定用于运行任务的数组索引,例如
0,3,6,9,1-5,7-8,10。 索引的结果集限于 1000 个条目。 只有在未指定array-size时才能指定该选项。 此值为可选项。 --array-size,--as,--instances,--is- 指定用于作业运行的实例数。 使用该选项时,系统将转换为数组索引。 例如,如果指定
5的instances,系统会将其转换为0 - 4的array-indexes。 只有在未指定--array-indexes选项时才能指定该选项。 此值为可选项。 缺省值为0。 --build-clear,--bc- 从该作业中除去构建的关联。 只有当作业当前有关联的构建时,才允许使用“构建清除”选项。 此值为可选项。 缺省值为
false。 --build-commit,--commit,--bcm,--cm,--revision- 要提取的源代码库中的提交、标记或分支。 只有当
--build-source选项在此job update命令中设置为 Git 资源库的 URL,或者您的作业当前有一个来自 Git 资源库源的关联构建时,才允许使用构建提交选项。 此值为可选项。 --build-commit-clear,--commit-clear,--bcmc,--cmc- 清除要拉取的源存储库中的落实、标记或分支。 只有当作业当前有关联的构建时,才允许使用“提交清除”选项。 此值为可选项。 缺省值为
false。 --build-context-dir,--context-dir,--bcdr,--cdr- 版本库中包含 buildpacks 文件或 Dockerfile 的目录。 只有在
job update命令上设置了--build-source选项,或作业当前有相关联的构建时,才允许使用构建上下文目录选项。 此值为可选项。 --build-dockerfile,--dockerfile,--bdf,--df- Dockerfile 的路径。 只有当名称不是
Dockerfile时才指定该选项。 如果在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选项在此job update命令中设置为 Git 资源库的 URL,或者您的作业当前有一个来自 Git 资源库源的关联构建时,才允许使用此选项。 此值为可选项。 --build-git-repo-secret-clear,--git-repo-secret-clear,--bgrsc,--grsc- 清除 SSH 私钥。 如果作业当前有关联的构建,则允许使用此选项。 此值为可选项。 缺省值为
false。 --build-size,--size,--bsz,--sz- 构建的大小,它决定了使用的资源量。 有效值为
small,medium,large,xlarge和xxlarge。 有关详情,请参阅 确定构建大小。 只有在job update命令中设置了--build-source选项,或作业当前有关联的构建时,才允许使用构建大小选项。 此值为可选项。 缺省值为medium。 --build-source,--source,--bsrc,--src- Git 源的 URL 或包含源代码的本地源的路径;例如
https://github.com/IBM/CodeEngine或.。 此值为可选项。 --build-strategy,--strategy,--bstr,--str- 用于构建映像的策略。 有效值为
dockerfile和buildpacks。 只有在job update命令上设置了--build-source选项,或作业当前有相关联的构建时,才允许使用构建策略选项。 如果未指定,则在指定--build-source且源代码位于本地计算机上时,由 Code Engine 决定构建策略。 此值为可选项。 默认值为dockerfile。 --build-timeout,--bto- 在构建成功或失败之前可能经过的时间(以秒为单位)。 只有在
job update命令中设置了--build-source选项,或作业当前有关联的构建时,才允许使用构建超时选项。 此值为可选项。 缺省值为600。 --command,--cmd,-c- 设置运行任务的命令。 每个
--command选项指定一条命令;例如,--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- 使用以下方法之一,根据存储在此配置映射中的键值对设置环境变量:
- 要为名为
configmapName的配置映射中的所有键添加环境变量,请使用configmapName。 您可以在引用 configmap 时通过指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=CONFIGMAP_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. 例如,要将配置映射configmapName中所有键的变量名前缀设置为CUSTOM_,请使用值CUSTOM_=configmapName。 如果配置映射configmapName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为configmapName的配置映射中为单键key1添加环境变量,请使用configmapName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为configmapName的配置映射中为单键key1添加名为myKey的环境变量,请使用值configmapName:myKey=key1。
此值为可选项。
--env-from-configmap-rm,--env-cm-rm- 使用配置映射名称,删除对完整配置映射的环境变量引用。 要删除对配置映射的单个键引用,请使用
--env-rm选项。 可以多次指定此选项。 此值为可选项。 --env-sec,--env-from-secret- 使用以下方法之一,根据存储在秘密中的键值对设置环境变量:
- 要为名为
secretName的秘密中的所有密钥添加环境变量,请使用secretName。 您可以通过在引用秘密时指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=SECRET_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,要将密文secretName中所有密钥变量名的前缀设置为CUSTOM_,请使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为secretName的密钥中为单个密钥key1添加环境变量,请使用secretName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为secretName的密文中为单个密钥key1添加名为myKey的环境变量,请使用secretName:myKey=key1。
此值为可选项。
--env-from-secret-rm,--env-sec-rm- 使用秘密名称,删除环境变量对完整秘密的引用。 要删除机密的单个密钥引用,请使用
--env-rm选项。 可以多次指定此选项。 此值为可选项。 --env-rm- 删除对配置表或机密中键值对的键的环境变量引用。 要删除单个键引用和字面值,请指定键的名称。 可以多次指定此选项。 此值为可选项。
--ephemeral-storage,--es- 为任务运行设置的短暂存储量。 使用
M表示兆字节,使用G表示千兆字节。 此值为可选项。 --force,-f- 不验证指定的 configmap 和秘密引用是否存在。 使用
--env-from-configmap选项可指定 Configmap 引用。 秘密引用是通过--env-from-secret或--registry-secret选项指定的。 此值为可选项。 缺省值是false。 --image,-i- 用于运行任务的图像名称。 格式为
REGISTRY/NAMESPACE/REPOSITORY:TAG,其中REGISTRY和TAG为可选项。 如果未指定REGISTRY,则默认为docker.io。 如果未指定TAG,则默认为latest。 此值为可选项。 --maxexecutiontime,--met- 作业运行的最大执行时间(以秒为单位)。 只有在
mode为task时才能指定该选项。 此值为可选项。 缺省值为7200。 --memory,-m- 为任务运行设置的内存量。 使用
M表示兆字节,使用G表示千兆字节。 有关有效值,请参阅 支持的内存和 CPU 组合。 此值为可选项。 --mode- 用于运行作业的方式。 有效值为
task和daemon。 在task模式下,适用maxexecutiontime和retrylimit选项。 在daemon模式下,由于没有超时,失败的实例会无限期重启,因此不允许使用--maxexecutiontime和--retrylimit选项。 此值为可选项。 --mount-configmap,--mount-cm- 通过提供挂载目录和配置映射名称,将配置映射的内容添加到运行任务的文件系统中,格式为
MOUNT_DIRECTORY=CONFIGMAP_NAME. 每个挂载的 configmap 必须使用唯一的挂载目录。 对于配置映射中的每个键值对,都会在指定的挂载目录中添加一个文件,文件名是键,文件内容是键值对的值。 每个--mount-configmap选项指定一个挂载配置;例如,--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值为可选项。 --mount-data-store,--mount-ds- 挂载持久数据存储。 格式为 MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]。 SUBPATH 是可选项。 可以多次指定此选项。 此值为可选项。
--mount-rm- 从运行任务的文件系统中删除配置映射表或密文的内容,具体方法是指定配置映射表或密文的挂载目录。 每个
--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- 将作业标记为失败之前重新运行该作业的实例的次数。 当作业的退出代码不是 0 时,会重新运行该作业的数组索引。 只有在
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选项,或作业当前有关联的构建时,才允许使用等待选项。 此值为可选项。 缺省值是true。 --wait-timeout,--wto- 等待构建运行完成的时间长度(以秒为单位)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 如果在job update命令中设置了--build-source选项,或作业当前有相关的构建,则允许使用等待超时选项。 缺省值是600。
示例
ibmcloud ce job update --name hellojob --cpu 2
示例输出
Updating job 'hellojob'...
OK
工作运行命令
一个作业并行运行一个或多个可执行代码实例。 与处理 HTTP 请求的应用程序不同,作业只运行一次,然后退出。 创建作业时,可以指定每次运行作业时使用的工作负载配置信息。 使用 jobrun 命令运行作业实例。
在使用 jobrun 命令之前,您必须处于 项目 的上下文环境中。
有关作业和作业运行的更多信息,请参阅 运行作业。
要查看 jobrun 命令的 CLI 帮助,请运行 ibmcloud ce jobrun -h。
ibmcloud ce jobrun delete
删除任务运行。
ibmcloud ce jobrun delete (--name JOBRUN_NAME | --job JOB_NAME) [--force] [--ignore-not-found] [--quiet]
命令选项
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --job,-j- 使用该选项可删除指定作业的所有作业运行。 如果不指定
--name值,则--job选项为必填项。 此值为可选项。 --name,-n- 要删除的作业运行的名称。 如果不指定
--job值,则--name选项为必填项。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce jobrun delete --name myjobrun -f
示例输出
Deleting job run 'myjobrun'...
OK
ibmcloud ce jobrun events
显示作业运行实例的系统事件。 系统事件最多保留 60 分钟。
ibmcloud ce jobrun events (--instance JOBRUN_INSTANCE | --jobrun JOBRUN_NAME) [--output OUTPUT] [--quiet]
命令选项
--instance,-i- 特定作业运行实例的名称。 使用
jobrun get命令查找实例名称。 如果未指定--jobrun,则必须使用该值。 --jobrun,-j,--name,-n- 显示指定作业运行的所有实例的事件。 如果未指定
--instance,则必须使用该值。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
下面的示例显示了指定任务运行的所有实例的系统事件信息。
ibmcloud ce jobrun events --jobrun myjobrun
示例输出
Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
Getting events for all instances of job run 'myjobrun'...
OK
myjobrun-1-0:
Type Reason Age Source Messages
Normal Scheduled 49s default-scheduler Successfully assigned 4svg40kna19/myjobrun-1-0 to 10.240.64.136
[...]
Normal Pulling 34s kubelet, 10.240.64.136 Pulling image "icr.io/codeengine/testjob"
myjobrun-2-0:
Type Reason Age Source Messages
Normal Scheduled 50s default-scheduler Successfully assigned 4svg40kna19/myjobrun-2-0 to 10.240.64.131
Normal Pulling 48s kubelet, 10.240.64.131 Pulling image "icr.io/codeengine/testjob"
作业运行指定实例的系统事件信息示例
您还可以使用 --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
ibmcloud ce jobrun get
显示任务运行的详细信息。
ibmcloud ce jobrun get --name JOBRUN_NAME [--output OUTPUT] [--quiet]
命令选项
--name,-n- 运行任务的名称。 此值为必填项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce jobrun get --name myjobrun
示例输出
Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
Getting events of jobrun 'myjobrun'...
Run 'ibmcloud ce jobrun events -n myjobrun' to get the system events of the job run instances.
Run 'ibmcloud ce jobrun logs -f -n myjobrun' to follow the logs of the job run instances.
OK
Name: myjobrun
[...]
Created: 2021-03-02T10:31:13-05:00
Image: icr.io/codeengine/firstjob
Resource Allocation:
CPU: 1
Ephemeral Storage: 400M
Memory: 4G
Runtime:
Mode: task
Array Indices: 1-5
Array Size: 5
JOP_ARRAY_SIZE Value: 5
Max Execution Time: 7200
Retry Limit: 3
Status:
Completed: 2m58s
Instance Statuses:
Succeeded: 5
Conditions:
Type Status Last Probe Last Transition
Pending True 3m55s 3m55s
Running True 3m51s 3m51s
Complete True 2m58s 2m58s
Events:
Type Reason Age Source Messages
[...]
Normal Updated 3m38s (x23 over 3m56s) batch-job-controller Updated JobRun "myjobrun"
Normal Updated 3m38s (x22 over 3m56s) batch-job-controller Updated JobRun "myjobrun"
Instances:
Name Running Status Restarts Age
myjobrun-1-0 0/1 Succeeded 0 3m58s
myjobrun-2-0 0/1 Succeeded 0 3m58s
myjobrun-3-0 0/1 Succeeded 0 3m57s
myjobrun-4-0 0/1 Succeeded 0 3m58s
myjobrun-5-0 0/1 Succeeded 0 3m58s
ibmcloud ce jobrun list
列出项目中的所有工作运行。
ibmcloud ce jobrun list [--job JOB] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--job,-j- 使用该选项只显示指定作业的作业运行。 此值为可选项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce jobrun list
示例输出
Listing job runs...
OK
Name Failed Pending Requested Running Succeeded Unknown Age
firstjob-jobrun-shnj5 0 0 0 0 1 0 11d
myjob-jobrun-fji48 0 0 0 0 5 0 11d
myjob-jobrun-xeqc8 0 0 0 0 5 0 12d
myjobrun 0 0 0 0 5 0 7m47s
mytestjob-jobrun-el0o8 0 0 0 0 1 0 11d
testjobrun 0 0 0 0 5 0 11d
列出的作业运行名称表示作业运行的名称和作业运行的当前版本。
ibmcloud ce jobrun logs
显示任务运行实例的日志。
ibmcloud ce jobrun logs (--instance JOBRUN_INSTANCE | --jobrun JOBRUN_NAME) [--follow] [--output OUTPUT] [--quiet] [--raw] [--tail TAIL] [--timestamps]
命令选项
--follow,-f- 跟踪任务运行实例的日志。 使用此选项可串流作业运行实例的日志。 如果指定
--follow选项,则必须输入Ctrl+C才能终止此日志命令。 此值为可选项。 缺省值为false。 --instance,-i- 特定作业运行实例的名称。 使用
jobrun get命令查找实例名称。 如果未指定--jobrun,则必须使用该值。 --jobrun,-j,--name,-n- 显示指定作业运行的所有实例的日志。 如果未指定
--instance,则必须使用该值。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --raw,-r- 显示日志时不带实例和容器标签。 此值为可选项。 缺省值为
false。 --tail,-t- 将指定作业运行实例的日志显示限制为最近行数的上限。 例如,要显示指定任务运行实例的最后
3行日志,请指定--tail 3。 如果未指定此选项,则会显示指定任务运行实例的所有日志行。 此值为可选项。 缺省值为-1。 --timestamps,--ts- 在日志输出的每一行中包含时间戳。 此值为可选项。 缺省值为
false。
示例
以下示例显示作业运行的特定实例的日志。 使用 jobrun get 命令获取任务运行实例的名称。
ibmcloud ce jobrun logs --instance myjobrun-3-0
示例输出
Getting logs for job run instance 'myjobrun-3-0'...
OK
myjobrun-3-0/myjobrun:
Hi from a batch job! My index is: 3
作业运行的所有实例日志示例
以下示例显示作业运行的所有实例的日志。
ibmcloud ce jobrun logs --jobrun myjobrun
作业运行的所有实例的日志输出示例
Getting logs for all instances of job run 'myjobrun'...
Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
OK
myjobrun-1-0/myjobrun:
Hi from a batch job! My index is: 1
myjobrun-2-0/myjobrun:
Hi from a batch job! My index is: 2
myjobrun-3-0/myjobrun:
Hi from a batch job! My index is: 3
myjobrun-4-0/myjobrun:
Hi from a batch job! My index is: 4
myjobrun-5-0/myjobrun:
Hi from a batch job! My index is: 5
ibmcloud ce jobrun restart
重新启动正在运行的作业运行实例。
ibmcloud ce jobrun restart (--instance JOBRUN_INSTANCE | --jobrun JOBRUN_NAME) [--quiet]
命令选项
--instance,-i- 特定作业运行实例的名称。 使用
jobrun get命令查找实例名称。 如果未指定--jobrun,则必须使用该值。 --jobrun,-j,--name,-n- 重新启动指定作业运行的所有正在运行的实例。 如果未指定
--instance,则必须使用该值。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce jobrun restart --name myjobrun
示例输出
Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
Restarting all running instances of job run 'myjobrun'...
OK
ibmcloud ce jobrun resubmit
根据上次作业运行的配置重新提交作业运行。
ibmcloud ce jobrun resubmit --jobrun REFERENCED_JOBRUN_NAME [--argument ARGUMENT] [--arguments-clear] [--array-indexes ARRAY_INDEXES] [--array-size ARRAY_SIZE] [--array-size-var-override ARRAY_SIZE_VAR_OVERRIDE] [--command COMMAND] [--commands-clear] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-configmap-rm ENV_FROM_CONFIGMAP_RM] [--env-from-secret ENV_FROM_SECRET] [--env-from-secret-rm ENV_FROM_SECRET_RM] [--env-rm ENV_RM] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-rm MOUNT_RM] [--mount-secret MOUNT_SECRET] [--name NAME] [--no-wait] [--output OUTPUT] [--quiet] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--service-account-clear] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--jobrun,-j- 此作业运行所基于的上一个作业运行的名称。 此值为必填项。
--argument,--arg,-a- 为本次任务运行设置参数。 每个
--argument选项指定一个参数;例如,-a argA -a argB。 此值为可选项。 --arguments-clear,--ac- 清除作业运行参数。 此值为可选项。 缺省值为
false。 --array-indexes,--array-indices,--ai- 指定用于此任务运行的实例索引,例如
0,3,6,9,1-5,7-8,10。 索引的结果集限于 1000 个条目。 只有在未指定array-size时才能指定该选项。 此值为可选项。 --array-size,--as,--instances,--is- 指定用于此作业运行的实例数。 使用该选项时,系统将转换为数组索引。 例如,如果指定
5的instances,系统会将其转换为0 - 4的array-indexes。 只有在未指定--array-indexes选项时才能指定该选项。 此值为可选项。 缺省值为0。 --array-size-var-override,--array-size-variable-override,--asvo- 为
JOB_ARRAY_SIZE环境变量指定自定义值。 默认情况下,JOB_ARRAY_SIZE环境变量设置为array-size值或array-indexes指定的索引数。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- 使用以下方法之一,根据存储在此配置映射中的键值对设置环境变量:
- 要为名为
configmapName的配置映射中的所有键添加环境变量,请使用configmapName。 您可以在引用 configmap 时通过指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=CONFIGMAP_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. 例如,要将配置映射configmapName中所有键的变量名前缀设置为CUSTOM_,请使用值CUSTOM_=configmapName。 如果配置映射configmapName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为configmapName的配置映射中为单键key1添加环境变量,请使用configmapName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为configmapName的配置映射中为单键key1添加名为myKey的环境变量,请使用值configmapName:myKey=key1。
此值为可选项。
--env-from-configmap-rm,--env-cm-rm- 使用配置映射名称,删除对完整配置映射的环境变量引用。 要删除对配置映射的单个键引用,请使用
--env-rm选项。 此值为可选项。 --env-sec,--env-from-secret- 使用以下方法之一,根据存储在秘密中的键值对设置环境变量:
- 要为名为
secretName的秘密中的所有密钥添加环境变量,请使用secretName。 您可以通过在引用秘密时指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=SECRET_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,要将密文secretName中所有密钥变量名的前缀设置为CUSTOM_,请使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为secretName的密钥中为单个密钥key1添加环境变量,请使用secretName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为secretName的密文中为单个密钥key1添加名为myKey的环境变量,请使用secretName:myKey=key1。
此值为可选项。
--env-from-secret-rm,--env-sec-rm- 使用秘密名称,删除环境变量对完整秘密的引用。 要删除机密的单个密钥引用,请使用
--env-rm选项。 可以多次指定此选项。 此值为可选项。 --env-rm- 删除对配置表或机密中键值对的键的环境变量引用。 要删除单个键引用和字面值,请指定键的名称。 可以多次指定此选项。 此值为可选项。
--ephemeral-storage,--es- 本次作业运行的短暂存储量。 使用
M表示兆字节,使用G表示千兆字节。 此值为可选项。 --force,-f- 不验证指定的 configmap 和秘密引用是否存在。 使用
--env-from-configmap选项可指定 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- 通过提供挂载目录和配置映射名称(格式为
MOUNT_DIRECTORY=CONFIGMAP_NAME. 每个挂载的 configmap 必须使用唯一的挂载目录。 对于配置映射中的每个键值对,都会在指定的挂载目录中添加一个文件,文件名是键,文件内容是键值对的值。 每个--mount-configmap选项指定一个挂载配置;例如,--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值为可选项。 --mount-data-store,--mount-ds- 挂载持久数据存储。 格式为 MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]。 SUBPATH 是可选项。 可以多次指定此选项。 此值为可选项。
--mount-rm- 通过指定挂载配置映射或机密的目录,从本次任务运行的文件系统中删除配置映射或机密的内容。 每个
--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- 在将作业运行标记为失败之前重新运行此作业运行的实例的次数。 当作业运行给出的退出代码不是 0 时,会重新运行该作业的数组索引。 只有在
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。
示例
下面的示例重新运行了 myjobrun 作业运行实例 4-5。 重新提交的运行任务名称为 myjobresubmit。
ibmcloud ce jobrun resubmit --name myjobresubmit --jobrun myjobrun --array-indices 4-5
示例输出
Getting job run 'myjobrun'...
Rerunning job run 'myjobresubmit'...
Run 'ibmcloud ce jobrun get -n myjobresubmit' to check the job run status.
OK
ibmcloud ce jobrun submit
根据作业提交作业运行。
ibmcloud ce jobrun submit ((--name JOBRUN_NAME --image IMAGE) | (--job JOB_NAME [--name JOBRUN_NAME])) [--argument ARGUMENT] [--array-indexes ARRAY_INDEXES] [--array-size ARRAY_SIZE] [--array-size-var-override ARRAY_SIZE_VAR_OVERRIDE] [--command COMMAND] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-secret MOUNT_SECRET] [--no-wait] [--output OUTPUT] [--quiet] [--registry-secret REGISTRY_SECRET] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--argument,--arg,-a- 为本次任务运行设置参数。 每个
--argument选项指定一个参数;例如,-a argA -a argB。 此值为可选项。 --array-indexes,--array-indices,--ai- 指定用于此任务运行的实例索引,例如
0,3,6,9,1-5,7-8,10。 索引的结果集限于 1000 个条目。 只有在未指定array-size时才能指定该选项。 此值为可选项。 缺省值是0。 --array-size,--as,--instances,--is- 指定用于此作业运行的实例数。 使用该选项时,系统将转换为数组索引。 例如,如果指定
5的instances,系统会将其转换为0 - 4的array-indexes。 只有在未指定--array-indexes选项时才能指定该选项。 此值为可选项。 缺省值为1。 --array-size-var-override,--array-size-variable-override,--asvo- 为
JOB_ARRAY_SIZE环境变量指定自定义值。 默认情况下,JOB_ARRAY_SIZE环境变量设置为array-size值或array-indexes指定的索引数。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- 使用以下方法之一,根据存储在此配置映射中的键值对设置环境变量:
- 要为名为
configmapName的配置映射中的所有键添加环境变量,请使用configmapName。 您可以在引用 configmap 时通过指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=CONFIGMAP_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. 例如,要将配置映射configmapName中所有键的变量名前缀设置为CUSTOM_,请使用值CUSTOM_=configmapName。 如果配置映射configmapName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为configmapName的配置映射中为单键key1添加环境变量,请使用configmapName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为configmapName的配置映射中为单键key1添加名为myKey的环境变量,请使用值configmapName:myKey=key1。
此值为可选项。
--env-sec,--env-from-secret- 使用以下方法之一,根据存储在秘密中的键值对设置环境变量:
- 要为名为
secretName的秘密中的所有密钥添加环境变量,请使用secretName。 您可以通过在引用秘密时指定前缀来修改环境变量名称。 要指定前缀,请使用PREFIX=SECRET_NAME。 由此产生的每个环境变量的格式都是<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,要将密文secretName中所有密钥变量名的前缀设置为CUSTOM_,请使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,则环境变量名称为CUSTOM_KEY_A。 - 要为单个键添加环境变量,请使用
NAME:KEY_A,KEY_B. 例如,要在名为secretName的密钥中为单个密钥key1添加环境变量,请使用secretName:key1。 要为引用的按键指定不同的名称,请使用格式NAME:NEW_NAME=KEY_A。 例如,要在名为secretName的密文中为单个密钥key1添加名为myKey的环境变量,请使用secretName:myKey=key1。
此值为可选项。
--ephemeral-storage,--es- 本次作业运行的短暂存储量。 使用
M表示兆字节,使用G表示千兆字节。 此值为可选项。 缺省值为400M。 --force,-f- 不验证指定的 configmap 和秘密引用是否存在。 使用
--env-from-configmap选项可指定 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- 通过提供挂载目录和配置映射名称(格式为
MOUNT_DIRECTORY=CONFIGMAP_NAME. 每个挂载的 configmap 必须使用唯一的挂载目录。 对于配置映射中的每个键值对,都会在指定的挂载目录中添加一个文件,文件名是键,文件内容是键值对的值。 每个--mount-configmap选项指定一个挂载配置;例如,--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b。 此值为可选项。 --mount-data-store,--mount-ds- 挂载持久数据存储。 格式为 MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]。 SUBPATH 是可选项。 可以多次指定此选项。 此值为可选项。
--mount-secret,--mount-sec- 通过提供挂载目录和秘密名称(格式为
MOUNT_DIRECTORY=SECRET_NAME. 每个挂载的秘密必须使用唯一的挂载目录。 对于密文中的每个键值对,都会在指定的挂载目录中添加一个文件,文件名就是键,文件内容就是键值对的值。 每个--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- 在将作业运行标记为失败之前重新运行此作业运行的实例的次数。 当作业运行给出的退出代码不是 0 时,会重新运行该作业的数组索引。 只有在
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
持久数据存储命令
管理持久数据存储
ibmcloud ce persistentdatastore create
创建持久性数据存储。
ibmcloud ce persistentdatastore create --name NAME --cos-access-secret SECRET_NAME --cos-bucket-name BUCKET_NAME [--cos-bucket-location BUCKET_LOCATION] [--quiet]
命令选项
--cos-access-secret,--cos-sec- 必需。 包含访问 COS 实例凭证的密文名称。 此值为必填项。
--cos-bucket-name,--cos-bucket- 必需。 COS 桶的名称。 此值为必填项。
--name,-n- 必需。 持久性数据存储的名称。 请使用项目中唯一的名称。 此值为必填项。
--cos-bucket-location,--cos-loc- COS 桶的位置。 此值为可选项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce persistentdatastore create --name my-pds-2 --cos-bucket-name my-test-bucket-2 --cos-access-secret my-hmac-secret-2
示例输出
Successfully created persistent data store named 'my-pds-2'.
OK
ibmcloud ce persistentdatastore delete
删除持久性数据存储。
ibmcloud ce persistentdatastore delete --name PERSISTENT_DATA_STORE_NAME [--force] [--ignore-not-found] [--quiet]
命令选项
--name,-n- 必需。 持久性数据存储的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce persistentdatastore delete --name my-pds-3 -f
示例输出
Deleting persistent data store 'my-pds-3'...
OK
ibmcloud ce persistentdatastore get
显示持久性数据存储的详细信息。
ibmcloud ce persistentdatastore get --name NAME [--output OUTPUT] [--quiet]
命令选项
--name,-n- 必需。 持久性数据存储的名称。 此值为必填项。
--output,-o- 输出格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce persistentdatastore get --name my-pds-2
示例输出
Getting persistent data store 'my-pds-2'...
OK
Name: my-pds-2
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Type: object_storage
Created: Fri, 11 Jul 2025 13:52:30 +0200
Age: 103s
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Data:
COS bucket: my-test-bucket-2
Access secret: my-hmac-secret-2
Bucket region: eu-de
ibmcloud ce persistentdatastore list
列出项目中的所有持久性数据存储。
ibmcloud ce persistentdatastore list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--output,-o- 输出格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
此命令会列出项目中的所有持久化数据存储。
ibmcloud ce persistentdatastore list
示例输出
Listing persistent data stores...
OK
Name COS bucket Access secret Bucket region Age
my-pds-1 my-test-bucket-1 my-hmac-secret-1 eu-gb 36d
my-pds-2 my-test-bucket-2 my-hmac-secret-2 eu-de 86s
my-pds-3 my-test-bucket-3 my-hmac-secret-3 us-south 6m30s
项目命令
使用 project 命令创建、列出、删除和选择一个项目作为当前上下文。
项目是 Code Engine 实体(如应用程序、工作和构建)的组合。 项目基于 Kubernetes 命名空间。 在 IBM Cloud® 资源组、用户账户和区域内,项目名称必须是唯一的。 项目用于管理资源并提供对其实体的访问。
项目提供以下项目。
- 为实体名称提供唯一的命名空间。
- 管理项目资源的访问(入境访问)。
- 管理对备份服务、注册表和存储库的访问(出站访问)。
- 具有自动生成的传输层服务证书 ( TLS )。
有关项目工作的更多信息,请参阅 管理项目。
您可以在 project 命令中使用 project 或 proj。 要查看 project 命令的 CLI 帮助,请运行 ibmcloud ce proj -h。
ibmcloud ce project create
创建一个项目。
ibmcloud ce project create --name PROJECT_NAME [--endpoint ENDPOINT] [--no-select] [--no-wait] [--output OUTPUT] [--quiet] [--tag TAG] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
-n,--name- 项目的名称。 使用您所在地区独有的名称。 名称必须少于或等于 128 个字符,可以包含
- 任何 Unicode 或字母数字字符。
- 只有这些特殊字符:空格 ( )、句点 (. )、冒号 (: )、下划线 (_) 和连字符 (-)。
此值为必填项。
--endpoint,-e- 项目的终点。 有效值为
public和private。 如果没有明确指定--endpoint选项,则行为由系统决定。 如果 IBM Cloud CLI 连接到private.cloud.ibm.com,则 Code Engine 项目的行为就好像--endpoint是private。 如果 IBM Cloud CLI 连接到cloud.ibm.com,则 Code Engine 项目的行为就好像--endpoint是public。 此值为可选项。 --no-select,--ns- 创建该项目后,请勿将该项目选择为当前上下文。 如果不选择此选项,项目将自动被选中。 此值为可选项。 缺省值为
false。 --no-wait,--nw- 创建项目,但不等待该项目创建。 如果指定
no-wait选项,项目创建就会开始,不会等待。 使用project get命令检查项目状态。 此值为可选项。 缺省值为false。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --tag,-t- 为项目指定的标签。 标签必须少于或等于 128 个字符,可包含字母、数字、空格( )、句点(.)、冒号(:)、下划线(_)和连字符(-)。每个
--tag选项指定一个标签;例如,--tag tagA --tag tagB。 此值为可选项。 --wait,-w- 创建项目,并等待该项目创建。 如果指定了
--wait选项,项目创建将等待--wait-timeout选项设定的最长秒数。 如果未在指定的--wait-timeout期限内创建项目,则项目创建失败。 此值为可选项。 缺省值是true。 --wait-timeout,--wto- 等待创建项目的时间长度(以秒为单位)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为600。
示例
ibmcloud ce project create --name myproject
示例输出
Creating project 'myproject'...
OK
ibmcloud ce project current
显示当前目标项目的详细信息。
ibmcloud ce project current [--output OUTPUT] [--quiet]
命令选项
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce project current
示例输出
Getting the current project context...
OK
Name: myproject
ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Subdomain: aabon2dfwa0
Domain: us-south.codeengine.appdomain.cloud
Region: us-south
Kubectl Context: 4svg40kna19
Kubernetes Config:
Context: aabon2dfwa0
Environment Variable: export KUBECONFIG=/user/myusername/.bluemix/plugins/code-engine/myproject-01234567-abcd-abcd-abcd-abcdabcd1111.yaml
ibmcloud ce project delete
删除项目。
ibmcloud ce project delete (--name PROJECT_NAME | --id PROJECT_ID) [--force] [--hard] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --hard- 立即删除项目。 如果不指定
--hard选项,则可使用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
ibmcloud ce project get
显示单个项目的详细信息。
ibmcloud ce project get (--name PROJECT_NAME | --id PROJECT_ID) [--output OUTPUT] [--quiet]
命令选项
--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
CRN: crn:v1:bluemix:public:codeengine:au-syd:a/1a2b3c4d5e6f7g1a2b3c4d5e6f7g1234:abcdabcd-abcd-abcd-abcd-f1de4aab5d5d::
Status: active
Enabled: true
Application Private Visibility Supported: true
Selected: true
Tags: tag1, tag2
Region: us-south
Resource Group: default
Service Binding Service ID: ServiceId-1234abcd-abcd-abcd-1111-1a2b3c4d5e6f
Age: 52d
Created: Mon, 30 Jun 2025 18:16:12 +0200
Updated: Mon, 30 Jun 2025 18:16:58 +0200
Connectivity:
Outbound - Source IP addresses:
Public internet
159.23.99.151
130.198.13.241
135.90.137.31
IBM Cloud private network
10.223.236.11
10.223.242.142
10.12.3.244
Inbound - Context-based restrictions for the data plane:
Enforcement status: none
Public internet: allowed
IBM Cloud private network: allowed
Last applied: Wed, 20 May 2026 15:52:02 +0200
Quotas:
Category Used Limit
App revisions 33 100
Apps 10 100
Build runs 4 100
Builds 4 100
Configmaps 7 100
CPU 6.15 64
Custom domain mappings 4 80
Ephemeral storage 5415750Ki 256G
Functions 2 20
Instances (active) 6 250
Instances (total) 9 2500
Job runs 4 100
Jobs 3 100
Memory 26400M 256G
Persistent data stores 2 10
Private path connections 1 3
Secrets 21 100
Serverless fleets 42 1000
Subnet pools 3 20
Subscriptions (cron) 1 100
Subscriptions (IBM Cloud Object Storage) 0 100
ibmcloud ce project list
列出所有项目。
ibmcloud ce project list [--all-resource-groups] [--output OUTPUT] [--quiet] [--regions REGIONS] [--sort-by SORT_BY]
命令选项
--all-resource-groups,--all- 显示所有资源组的项目。 默认情况下,只显示当前资源组中的项目。 此值为可选项。 缺省值为
false。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --regions,-r- 限制在指定区域显示项目。 提供一个或多个地区的名称,例如
us-south,eu-de。 此值为可选项。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce project list
示例输出
Getting projects...
OK
Name ID Status Selected Tags Region Resource Group Age
myproj-eude 09768af4-abcd-abcd-abcd-24674ba90db0 active false eu-de default 27d
myproject cd09cfe1-abcd-abcd-abcd-0f8a8a1d0ddf active true us-south default 52d
ibmcloud ce project restore
恢复项目。
ibmcloud ce project restore (--name PROJECT_NAME | --id PROJECT_ID) [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--id,--guid- 项目的标识。 如果未指定
--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
ibmcloud ce project select
选择一个项目作为当前上下文。 项目必须处于 active 状态才能被选中。
ibmcloud ce project select (--name PROJECT_NAME | --id PROJECT_ID) [--endpoint ENDPOINT] [--kubecfg] [--quiet]
命令选项
--endpoint,-e- 项目的终点。 有效值为
public和private。 如果没有明确指定--endpoint选项,则行为由系统决定。 如果 IBM Cloud CLI 连接到private.cloud.ibm.com,则 Code Engine 项目的行为就好像--endpoint是private。 如果 IBM Cloud CLI 连接到cloud.ibm.com,则 Code Engine 项目的行为就好像--endpoint是public。 此值为可选项。 --id,--guid- 项目的标识。 如果未指定
--name,则必须使用该值。 --kubecfg,-k- 将项目附加到 Kubernetes 配置文件。 您可以通过设置
KUBECONFIG环境变量来覆盖默认的 Kubernetes 配置文件。 此值为可选项。 缺省值为false。 --name,-n- 项目的名称。 如果未指定
--id,则必须使用该值。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce project select --name myproject
示例输出
Selecting project 'myproject'...
OK
ibmcloud ce project tag
管理单个项目的标签。
ibmcloud ce project tag (--name PROJECT_NAME | --id PROJECT_ID) [--quiet] [--tag TAG] [--tag-rm TAG_RM]
命令选项
--id,--guid- 项目的标识。 如果未指定
--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
ibmcloud ce project update
更新所选项目。
ibmcloud ce project update (--binding-service-id SERVICE_ID_ID | --binding-resource-group RESOURCE_GROUP_NAME | --binding-resource-group-id RESOURCE_GROUP_ID) [--quiet]
命令选项
--binding-resource-group,--brg- 用于本项目服务绑定身份验证的资源组名称。 为该资源组中的所有服务创建了一个服务 ID,其中包含
Operator和Manager角色。 使用"*"指定此账户中的所有资源组。 此值为可选项。 --binding-resource-group-id,--brgid- 要用于此项目的服务绑定进行认证的资源组的标识。 为该资源组中的所有服务创建了一个服务 ID,其中包含
Operator和Manager角色。 此值为可选项。 --binding-service-id,--bsid- 服务 ID 的 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
填海命令
管理 Code Engine 项目索赔。 软删除的项目可在 7 天内使用 reclamation restore 命令恢复。
ibmcloud ce reclamation delete
删除项目填海。
ibmcloud ce reclamation delete (--name PROJECT_NAME | --id PROJECT_ID) [--force] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --id,--guid- 项目的标识。 如果未指定
--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
ibmcloud ce reclamation get
显示单个项目填海的详细信息。
ibmcloud ce reclamation get (--name PROJECT_NAME | --id PROJECT_ID) [--output OUTPUT] [--quiet]
命令选项
--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
ibmcloud ce reclamation list
列出所有项目索赔。
ibmcloud ce reclamation list [--all-resource-groups] [--output OUTPUT] [--quiet] [--regions REGIONS] [--sort-by SORT_BY]
命令选项
--all-resource-groups,--all- 显示所有资源组的项目申请。 默认情况下,只显示当前资源组中的项目申请。 此值为可选项。 缺省值为
false。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --regions,-r- 限制在指定区域内显示项目记录。 提供一个或多个地区的名称,例如
us-south,eu-de。 此值为可选项。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce reclamation list
示例输出
Getting project reclamations...
OK
Name ID Reclamation ID Status Region Resource Group Age Time to Hard Deletion
myproject def218c5-abcd-abcd-abcd-97854c288d76 48e3d7a2-abcd-abcd-abcd-99db7152b8fe soft deleted us-south default 40h 6d23h
myproject2 01f0bc66-abcd-abcd-abcd-3ef7e99f6f69 af2cd017-abcd-abcd-abcd-d32e2bb79136 soft deleted jp-osa default 8m58s 2d11h
ibmcloud ce reclamation restore
恢复项目填海。 软删除的项目可在 7 天内使用 reclamation restore 命令恢复。
ibmcloud ce reclamation restore (--name PROJECT_NAME | --id PROJECT_ID) [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--id,--guid- 项目的标识。 如果未指定
--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
注册表命令
容器注册表或注册中心是一种存储容器映像的服务。 例如,IBM Cloud Container Registry 和 Docker Hub 都是容器注册机构。 集装箱登记处可以是公共的,也可以是私人的。 公开的容器注册表无需凭据即可访问。 相比之下,访问私人注册表确实需要凭证。
在使用 registry 命令之前,您必须处于 项目 的上下文环境中。
有关访问注册表的更多信息,请参阅 添加对专用容器注册表的访问。
要查看 registry 命令的 CLI 帮助,请运行 ibmcloud ce registry -h。
从 CLI 版本 1.42.0 开始,在 CLI 中定义和处理秘密将统一到 secret 命令组。 请参见 ibmcloud ce secret 命令。 使用 --format 选项指定秘密类别,如
basic_auth, generic, hmac, ssh, tls 或 registry。 虽然可以继续使用 registry 命令组的同时,还可以利用统一的 secret 命令组的优势。 要创建一个访问容器注册表的秘密,请使用
ibmcloud ce secret create --format registry 命令。 要了解在 Code Engine 中处理秘密的更多信息,请参阅 处理秘密。
ibmcloud ce registry create
创建映像注册表访问私钥。
ibmcloud ce registry create --name NAME (--password PASSWORD | --password-from-file PASSWORD_FILE | --password-from-json-file) [--email EMAIL] [--output OUTPUT] [--quiet] [--server SERVER] [--username USERNAME]
命令选项
-n,--name- 图像注册表访问秘密的名称。 请使用项目中唯一的名称。
- 名称必须以小写字母数字字符开头和结尾。
- 名称必须少于或等于 253 个字符,可包含小写字母、数字、句号 (.) 和连字符 (-)。
此值为必填项。
--email,-e- 访问注册表服务器的电子邮件地址。 此值为可选项。
--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
ibmcloud ce registry delete
删除映像注册表访问私钥。
ibmcloud ce registry delete --name NAME [--force] [--ignore-not-found] [--quiet]
命令选项
--name,-n- 图像注册表访问秘密的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce registry delete --name myregistry -f
示例输出
Deleting image registry access secret myregistry...
OK
ibmcloud ce registry get
显示映像注册表访问私钥的详细信息。
ibmcloud ce registry get --name NAME [--decode] [--output OUTPUT] [--quiet]
命令选项
--name,-n- 图像注册表访问秘密的名称。 此值为必填项。
--decode,-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==
ibmcloud ce registry list
列出项目中的所有映像注册表访问私钥。
ibmcloud ce registry list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce registry list
示例输出
Listing image registry access secrets...
OK
Name Age
myregistry 19m22s
ibmcloud ce registry update
更新映像注册表访问私钥。
ibmcloud ce registry update --name NAME [--email EMAIL] [--output OUTPUT] [--password PASSWORD] [--password-from-file PASSWORD_FROM_FILE] [--password-from-json-file PASSWORD_FROM_JSON_FILE] [--quiet] [--server SERVER] [--username USERNAME]
命令选项
--name,-n- 图像注册表访问秘密的名称。 此值为必填项。
--email,-e- 访问注册表服务器的电子邮件地址。 此值为可选项。
--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
Repo 命令
代码库(如 GitHub 或 GitLab, )存储源代码。 通过 Code Engine,您可以添加对私有代码库的访问,然后在构建过程中引用该库。
在使用 repo 命令之前,您必须处于 项目 的上下文环境中。
有关访问版本库的更多信息,请参阅 访问私有代码库。
要查看 repo 命令的 CLI 帮助,请运行 ibmcloud ce repo -h。
从 CLI 版本 1.42.0 开始,在 CLI 中定义和处理秘密将统一到 secret 命令组。 请参见 ibmcloud ce secret 命令。 使用 --format 选项指定秘密类别,如
basic_auth, generic, hmac, ssh, tls 或 registry。 虽然可以继续使用 repo 命令组的同时,还可以利用统一的 secret 命令组的优势。 要创建一个使用
SSH 密钥访问服务的秘密,例如验证 Git 存储库(如 GitHub 或 GitLab, ),请使用 ibmcloud ce secret create --format ssh 命令。 SSH 密文也可用作 Git 存储库访问密文。 要了解在 Code Engine 中处理秘密的更多信息,请参阅
处理秘密。
ibmcloud ce repo create
创建 Git 存储库访问私钥。
ibmcloud ce repo create --name SECRET_NAME --key-path SSH_KEY_PATH --host HOST_ADDRESS [--known-hosts-path KNOWN_HOSTS_PATH] [--output OUTPUT] [--quiet]
命令选项
--host,--ho- 主机地址,例如
github.com。 此值为必填项。 --key-path,--kp- 未加密 SSH 私钥文件的路径。 如果使用的是个人 SSH 私钥,则该文件通常位于
$HOME/.ssh/id_rsa( Mac OS 或 Linux ) 或%HOMEPATH%\.ssh\id_rsa(Windows) 中。 此值为必填项。 -n,--name- Git 资源库访问秘密的名称。 请使用项目中唯一的名称。
- 名称必须以小写字母数字字符开头和结尾。
- 名称必须少于或等于 253 个字符,可包含小写字母、数字、句号 (.) 和连字符 (-)。
此值为必填项。
--known-hosts-path,--khp- 已知主机文件的路径。 该值是一项安全功能,可确保私钥仅用于验证您以前访问过的主机,特别是 GitHub 或 GitLab 主机。 该文件通常位于
$HOME/.ssh/known_hosts( Mac OS 或 Linux ) 或%HOMEPATH%\.ssh\known_hosts(Windows)。 此值为可选项。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
以下命令为主机 github.com 创建名为 github 的 Git 访问密钥,并使用位于 /<filepath>/.ssh/id_rsa 的 SSH 密钥进行身份验证,其中 <filepath> 是系统中的路径。
ibmcloud ce repo create -n github --key-path /<filepath>/.ssh/id_rsa --host github.com
示例输出
Creating Git access secret github...
OK
ibmcloud ce repo delete
删除 Git 存储库访问私钥。
ibmcloud ce repo delete --name NAME [--force] [--ignore-not-found] [--quiet]
命令选项
--name,-n- Git 资源库访问秘密的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce repo delete --name github
示例输出
Are you sure you want to delete the Git access secret github? [y/N]> y
Deleting Git access secret github...
OK
ibmcloud ce repo get
显示 Git 存储库访问私钥的详细信息。
ibmcloud ce repo get --name NAME [--decode] [--output OUTPUT] [--quiet]
命令选项
--name,-n- Git 资源库访问秘密的名称。 此值为必填项。
--decode,-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
...
ibmcloud ce repo list
列出项目中的所有 Git 存储库访问私钥。
ibmcloud ce repo list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce repo list
示例输出
Listing Git access secrets...
OK
Name Age
github 13m0s
ibmcloud ce repo update
更新 Git 存储库访问私钥。
ibmcloud ce repo update --name SECRET_NAME [--host HOST] [--key-path KEY_PATH] [--known-hosts-path KNOWN_HOSTS_PATH] [--output OUTPUT] [--quiet]
命令选项
--name,-n- Git 资源库访问秘密的名称。 此值为必填项。
--host,--ho- 主机地址,例如
github.com。 此值为可选项。 --key-path,--kp- 未加密 SSH 私钥文件的路径。 如果使用的是个人 SSH 私钥,则该文件通常位于
$HOME/.ssh/id_rsa( Mac OS 或 Linux ) 或%HOMEPATH%\.ssh\id_rsa(Windows) 中。 此值为可选项。 --known-hosts-path,--khp- 已知主机文件的路径。 该值是一项安全功能,可确保私钥仅用于验证您以前访问过的主机,特别是 GitHub 或 GitLab 主机。 该文件通常位于
$HOME/.ssh/known_hosts( Mac OS 或 Linux ) 或%HOMEPATH%\.ssh\known_hosts(Windows)。 此值为可选项。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
下面的命令更新了 Git 访问秘密,使用了新的主机,该访问秘密名为 github。
ibmcloud ce repo update -n github --host NEW_HOST
示例输出
Getting Git access secret 'github'...
Updating Git access secret 'github'...
OK
修订命令
应用程序或应用程序运行您的代码,为 HTTP 请求提供服务。 除了传统的 HTTP 请求外,IBM Cloud® Code Engine 还支持使用 WebSockets 作为通信协议的应用程序。 一个应用程序包含一个或多个修订版。 修订版代表应用程序配置属性的不可更改版本。 每次更新应用程序配置属性都会创建一个新的应用程序版本。
使用 revision 命令管理应用程序修订。
在使用 revision 命令之前,您必须处于 项目 的上下文环境中。
有关使用应用程序修订版的更多信息,请参阅 部署应用程序。
您可以在 revision 命令中使用 revision 或 rev。 要查看 revision 命令的 CLI 帮助,请运行 ibmcloud ce revision -h。
ibmcloud ce revision delete
删除申请修订。
ibmcloud ce revision delete --name REVISION_NAME [--force] [--ignore-not-found] [--quiet]
命令选项
--name,-n- 应用程序修订版的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce revision delete -n newapp-mytest-00004 -f
示例输出
Deleting application revision 'newapp-mytest-00004'...
OK
ibmcloud ce revision events
显示应用程序修订版实例的系统事件。 系统事件最多保留 60 分钟。
ibmcloud ce revision events (--instance REVISION_INSTANCE | --revision REVISION_NAME) [--output OUTPUT] [--quiet]
命令选项
--instance,-i- 特定应用程序实例的名称。 使用
rev get命令查找实例名称。 如果未指定--revision,则必须使用该值。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --revision,--rev,-r,--name,-n- 显示指定应用程序修订版所有实例的事件。 如果未指定
--instance,则必须使用该值。
示例
ibmcloud ce revision events -n myapp-00001
示例输出
Code Engine 仅保留应用程序的最新非活动修订版和活动应用程序修订版。 不保留旧版本。
Getting application revision 'newapp-mytest-00002'...
Getting events for all instances of application revision 'newapp-mytest-00002'...
OK
newapp-mytest-00002-deployment-7c87cfbf66-xnwkp:
Type Reason Age Source Messages
Normal Scheduled 65s default-scheduler Successfully assigned bz8i2yh012p/newapp-mytest-00002-deployment-7c87cfbf66-xnwkp to 10.243.0.60
Normal Pulling 63s kubelet, 10.243.0.60 Pulling image "icr.io/codeengine/codeengine@sha256:b3150372958ab68eea5356a8cab31069ca5293c45959d64f6aaabbccddeeff123"
Normal Created 60s kubelet, 10.243.0.60 Created container queue-proxy
Normal Created 60s kubelet, 10.243.0.60 Created container user-container
Normal Started 60s kubelet, 10.243.0.60 Started container user-container
Normal Pulled 60s kubelet, 10.243.0.60 Container image "icr.io/obs/codeengine/knative-serving/knative.dev/serving/cmd/queue:v0.20.0-rc11@sha256:3fedfa9d9cdd74e85d11d4167043f13902074946caf415d16ff537620f04931a" already present on machine
Normal Pulled 60s kubelet, 10.243.0.60 Successfully pulled image "icr.io/codeengine/codeengine@sha256:b3150372958ab68eea5356a8cab31069ca5293c45959d64f6aaabbccddeeff123" in 2.67237432s
Normal Started 60s kubelet, 10.243.0.60 Started container queue-proxy
Normal Pulling 60s kubelet, 10.243.0.60 Pulling image "icr.io/obs/codeengine/istio/proxyv2:1.9.1-rc7"
Normal Pulled 59s kubelet, 10.243.0.60 Successfully pulled image "icr.io/obs/codeengine/istio/proxyv2:1.9.1-rc7" in 666.211288ms
Normal Created 59s kubelet, 10.243.0.60 Created container istio-proxy
Normal Started 59s kubelet, 10.243.0.60 Started container istio-proxy
ibmcloud ce revision get
显示应用程序修订的详细信息。
ibmcloud ce revision get --name REVISION_NAME [--output OUTPUT] [--quiet]
命令选项
--name,-n- 应用程序修订版的名称。 此值为必填项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce revision get --name newapp-mytest-00002
示例输出
Getting application revision 'newapp-mytest-00002'...
Getting application 'newapp-mytest'...
OK
Name: newapp-mytest-00002
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 27d
Created: 2021-05-05T11:50:00-04:00
Status Summary: Revision is ready
Environment Variables:
Type Name Value
ConfigMap full reference mycolorconfigmap
Literal TARGET Sunshine
Image: icr.io/codeengine/codeengine
Resource Allocation:
CPU: 1
Ephemeral Storage: 400M
Memory: 4G
Port: 8080
Runtime:
Concurrency: 100
Maximum Scale: 10
Minimum Scale: 0
Timeout: 300
Conditions:
Type OK Age Reason
Active false 5d22h NoTraffic : The target is not receiving traffic.
ContainerHealthy true 5d22h
Ready true 5d22h
ResourcesAvailable true 5d22h
ibmcloud ce revision list
列出项目中的所有应用程序修订。
ibmcloud ce revision list [--application APPLICATION] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--application,--app,-a- 使用该选项只显示指定应用程序的修订。 此值为可选项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce revision list
示例输出
Code Engine 仅保留应用程序的最新非活动修订版和活动应用程序修订版。 不保留旧版本。
Listing all application revisions...
OK
Name Application Status URL Latest Tag Traffic Age Conditions Reason
myapp-hc3u8-2 myapp Ready 16d 3 OK / 4
myapp-hc3u8-3 myapp Ready true 100% 2d8h 3 OK / 4
newapp-mytest-00004 newapp-mytest Ready 4d20h 3 OK / 4
newapp-mytest-00005 newapp-mytest Ready true 100% 2d20h 3 OK / 4
ibmcloud ce revision logs
显示应用程序修订实例的日志。
ibmcloud ce revision logs (--instance REVISION_INSTANCE | --revision REVISION_NAME) [--all-containers] [--follow] [--output OUTPUT] [--quiet] [--tail TAIL] [--timestamps]
命令选项
--all-containers,--all- 显示指定应用程序修订实例的所有容器的日志。 此值为可选项。 缺省值为
false。 --follow,-f- 跟踪应用程序修订实例的日志。 使用此选项可对应用程序修订实例的日志进行流式处理。 如果指定
--follow选项,则必须输入Ctrl+C才能终止此日志命令。 此值为可选项。 缺省值为false。 --instance,-i- 特定应用程序修订实例的名称。 使用
revision get命令查找实例名称。 如果未指定--revision,则必须使用该值。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --revision,--rev,-r,--name,-n- 显示指定应用程序修订版所有实例的日志。 如果未指定
--instance,则必须使用该值。 --tail,-t- 将指定应用程序修订实例的容器日志显示限制为每个容器最近行数的上限。 例如,要显示指定应用程序修订实例的容器的最后
3行日志,请指定--tail 3。 如果未指定此选项,则会显示指定应用程序修订实例容器的所有日志行。 此值为可选项。 缺省值为-1。 --timestamps,--ts- 在日志输出的每一行中包含时间戳。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce revision logs -n myapp-00001
示例输出
Code Engine 仅保留应用程序的最新非活动修订版和活动应用程序修订版。 不保留旧版本。
Getting logs for all instances of application revision 'newapp-mytest-00002'...
Getting application revision 'newapp-mytest-00002'...
OK
newapp-mytest-00002-deployment-7c87cfbf66-xnwkp/user-container:
2021-07-15 20:40:56 Listening on port 8080
秘密命令
秘密提供了一种在部署中包含敏感配置信息(如密码或 SSH 密钥)的方法。 通过引用秘密中的值,您可以将敏感信息与部署分离,以保持应用程序、功能或工作的可移植性。 任何获得项目授权的人也可以查看您的秘密;请确保您知道可以与这些用户共享秘密信息。 秘密包含键值对信息。
在使用 secret 命令之前,您必须处于 项目 的上下文环境中。
有关使用秘密的更多信息,请参阅 使用秘密。
要查看 secret 命令的 CLI 帮助,请运行 ibmcloud ce secret -h。
从 CLI 版本 1.42.0 开始,在 CLI 中定义和处理秘密将统一到 secret 命令组。 使用 --format 选项指定秘密类别,如 basic_auth, generic, hmac, ssh, tls 或 registry。
--format 选项的默认值是 generic。
ibmcloud ce secret create
创建私钥。
ibmcloud ce secret create --name SECRET_NAME (--from-env-file FILE | --from-file FILE | --from-file KEY=FILE | --from-literal KEY=VALUE) [--access-key-id ACCESS_KEY_ID] [--access-key-id-prompt] [--cert-chain-file CERT_CHAIN_FILE] [--email EMAIL] [--format FORMAT] [--from-json-file FROM_JSON_FILE] [--key-path KEY_PATH] [--known-hosts-path KNOWN_HOSTS_PATH] [--output OUTPUT] [--password PASSWORD] [--password-from-file PASSWORD_FROM_FILE] [--password-from-json-file PASSWORD_FROM_JSON_FILE] [--private-key-file PRIVATE_KEY_FILE] [--quiet] [--secret-access-key SECRET_ACCESS_KEY] [--secret-access-key-prompt] [--server SERVER] [--username USERNAME]
命令选项
--access-key-id,--akid- 指定 HMAC 凭证的 access_key_id。 此值为可选项。
--access-key-id-prompt- 提示输入 HMAC 凭证的 access_key_id。 此值为可选项。 缺省值为
false。 --cert-chain-file,--ccf- 指定一个文件,其中包含证书颁发机构为 TLS 保密提供的证书链。 您必须提供文件的路径作为值。
tls保密信息需要此值。 此值为可选项。 --email,--em- 用于访问注册表服务器以获取注册表秘密的电子邮件地址。 此值仅适用于
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 secret 的私钥。 您必须提供文件的路径作为值。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 认证的服务时使用。
要查看创建基本 auth 秘密的 CLI 帮助,请运行 ibmcloud ce secret create --format basic_auth。
下面的示例创建了一个名为 mysecret-basicauth 的基本 auth 秘密。 该秘密包含用户名 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。
--format generic 请注意,在 CLI 中使用 secret create 命令创建秘密时,默认值是。
下面的示例创建了一个名为 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 的凭据。
ibmcloud ce secret create --name mysecret-registry --format registry --server us.icr.io --username iamapikey --password API_KEY
注册表秘密的输出示例
Creating registry secret `mysecret-registry`...
OK
SSH 秘密示例
SSH 密钥存储使用 SSH 密钥验证服务的凭证;例如,验证 Git 存储库,如 GitHub 或 GitLab。
要查看创建 SSH 秘密的 CLI 帮助,请运行 ibmcloud ce secret create --format ssh。
下面的示例为 known_hosts 文件中的主机创建了名为 mysecret-ssh 的 SSH 密钥,并使用位于 /<filepath>/.ssh/<key_name> 的未加密 SSH 私钥文件进行身份验证,其中 <filepath> 是系统中的路径。 该命令需要输入名称和密钥路径,还允许输入其他可选参数,如已知主机文件的路径。
ibmcloud ce secret create --name mysecret-ssh --format ssh --key-path ~/.ssh/<key_name> --known-hosts-path ~/.ssh/known_hosts
SSH 秘密的输出示例
Creating SSH secret `mysecret-ssh`...
OK
TLS 秘密示例
传输层安全( TLS )密文包含一个已签名的 TLS 证书(包括其所有中间证书)和来自证书颁发机构(CA)的相应私钥。 使用自定义域映射时,请使用 TLS 保密信息。
要查看创建 TLS 保密信息的 CLI 帮助,请运行 ibmcloud ce secret create --format tls。
下面的示例创建了一个名为 mysecret-tls 的 TLS 秘密。 与自定义域相对应的证书链包含在 certificate.txt 文件中,匹配的私钥文件包含在 privatekey.txt 文件中。 这两个文件都位于本地工作站的根目录下。
ibmcloud ce secret create --name mysecret-tls --format tls --cert-chain-file certificate.txt --private-key-file privatekey.txt
TLS 秘密的输出示例
Creating TLS secret `mysecret-tls`...
OK
ibmcloud ce secret delete
删除私钥。
ibmcloud ce secret delete --name SECRET_NAME [--force] [--ignore-not-found] [--quiet]
命令选项
--name,-n- 私钥的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce secret delete --name mysecret-genericfromfile -f
示例输出
Deleting secret mysecret-genericfromfile...
OK
ibmcloud ce secret get
显示私钥的详细信息。
ibmcloud ce secret get --name SECRET_NAME [--decode] [--output OUTPUT] [--quiet]
命令选项
--name,-n- 私钥的名称。 此值为必填项。
--decode,-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 secret get --name mysecret-basicauth
示例输出
Getting secret 'mysecret-basicauth'...
OK
Name: mysecret-basicauth
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Format: basic_auth
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 66s
Created: 2021-03-10T18:44:18-05:00
Data:
---
password: REDACTED
username: bXl1c2VybmFtZQ==
ibmcloud ce secret list
列出项目中的所有私钥。
ibmcloud ce secret list [--all] [--format FORMAT] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--all,-a- 显示所有格式的所有机密,包括
basic_auth,generic,registry,ssh,tls和other中未被 Code Engine 管理的机密。 此值为可选项。 缺省值为false。 --format,--fo- 指定此选项以过滤私钥的显示。 有效值为
basic_auth,generic,registry,ssh和tls。 此值为可选项。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
此命令会列出项目中的所有秘密。
ibmcloud ce secret list
示例输出
Listing secrets...
OK
Name Format Data Age
ce-auto-icr-private-us-south registry 4 333d
ce-auto-private-icr-us-south registry 4 335d
myregistry-seccmd registry 4 3h31m
mysecret-basicauth basic_auth 2 7m37s
mysecret-generic generic 1 7m7s
mysecret-genericfromfile generic 2 2m29s
mysecret-hmac hmac_auth 2 21m
mysecret-registry registry 4 111s
mysecret-ssh ssh_auth 2 42m
mysecret-tls tls 2 3h47m
ibmcloud ce secret update
更新私钥。
ibmcloud ce secret update --name SECRET_NAME (--from-env-file FILE | --from-file FILE | --from-file KEY=FILE | --from-literal KEY=VALUE | --rm KEY) [--access-key-id ACCESS_KEY_ID] [--access-key-id-prompt] [--cert-chain-file CERT_CHAIN_FILE] [--email EMAIL] [--from-json-file FROM_JSON_FILE] [--key-path KEY_PATH] [--known-hosts-path KNOWN_HOSTS_PATH] [--output OUTPUT] [--password PASSWORD] [--password-from-file PASSWORD_FROM_FILE] [--password-from-json-file PASSWORD_FROM_JSON_FILE] [--private-key-file PRIVATE_KEY_FILE] [--quiet] [--secret-access-key SECRET_ACCESS_KEY] [--secret-access-key-prompt] [--server SERVER] [--username USERNAME]
命令选项
--name,-n- 私钥的名称。 此值为必填项。
--access-key-id,--akid- 指定 HMAC 凭证的 access_key_id。 此值为可选项。
--access-key-id-prompt- 提示输入 HMAC 凭证的 access_key_id。 此值为可选项。 缺省值为
false。 --cert-chain-file,--ccf- 指定一个文件,其中包含证书颁发机构为 TLS 保密提供的证书链。 您必须提供文件的路径作为值。 此值为可选项。
--email,--em- 用于访问注册表服务器以获取注册表秘密的电子邮件地址。 此值为可选项。
--from-env-file,-e- 从文件中更新通用密文,该文件包含符合格式
KEY=VALUE的一行或多行。 您必须提供文件的路径作为值。 指定文件中的每一行都会以键值对的形式添加。 指定文件中任何空行或以#开头的行都将被忽略。 如果未指定--from-literal或--from-file,则必须使用该值。 --from-file,-f- 从文件中更新通用秘密。 您必须提供文件的路径作为值。 如果未指定
--from-literal或--from-env-file,则必须使用该值。 --from-json-file,--json- 文件的路径,该文件包含 JSON 格式的私钥值。 此选项支持密文格式
hmac此值为可选项。 --from-literal,-l- 根据键值对更新通用密文。 必须采用
KEY=VALUE格式。 如果未指定--from-file或--from-env-file,则必须使用该值。 可以多次指定此选项。 --key-path,--kp- 用于 SSH 密钥的未加密 SSH 私钥文件的路径。 如果使用的是个人 SSH 私钥,则该文件通常位于
$HOME/.ssh/id_rsa( Mac OS 或 Linux ) 或%HOMEPATH%\.ssh\id_rsa(Windows) 中。 此值为可选项。 --known-hosts-path,--khp- 用于 SSH 秘密的已知主机文件路径。 该值是一项安全功能,可确保私钥仅用于验证您以前访问过的主机,特别是 GitHub 或 GitLab 主机。 该文件通常位于
$HOME/.ssh/known_hosts( Mac OS 或 Linux ) 或%HOMEPATH%\.ssh\known_hosts(Windows)。 此值为可选项。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --password,--pw- 基本授权或注册表密文的密码。 如果既未指定
--password,也未指定--password-from-file或--password-from-json-file选项,则系统会提示输入密码。 此值为可选项。 --password-from-file,--spf- 包含基本授权或注册表密文密码的文件路径。 文件的第一行用于密码。 如果既未指定
--password,也未指定--password-from-file或--password-from-json-file选项,则系统会提示输入密码。 您必须提供文件的路径作为值。 此值为可选项。 --password-from-json-file,--spfj- JSON 文件的路径,该文件包含基本认证或注册表密文的密码。
apikey字段用于输入密码。 如果既未指定--password,也未指定--password-from-file或--password-from-json-file选项,则系统会提示输入密码。 您必须提供文件的路径作为值。 此值为可选项。 --private-key-file,--pkf- 使用
cert-chain-file选项指定一个文件,其中包含与指定证书链相匹配的 TLS secret 的私钥。 您必须提供文件的路径作为值。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --rm- 通过指定键的名称,删除通用密文中的单个键值对。 可以多次指定此选项。 此值为可选项。
--secret-access-key,--sak- 指定 HMAC 凭证的 secret_access_key。 此值为可选项。
--secret-access-key-prompt- 提示输入 HMAC 凭证的 secret_access_key。 此值为可选项。 缺省值为
false。 --server,-s- 注册表服务器 URL 的注册表密文。 此值为可选项。 缺省值为
us.icr.io。 --username,-u- 基本认证或注册密文的用户名。 此值为可选项。
示例
本例用更新的证书和私钥更新 TLS 保密信息。
ibmcloud ce secret update --name mysecret-tls --cert-chain-file certificate2.txt --private-key-file privatekey2.txt
示例输出
Updating secret mysecret-tls..
OK
订阅 cos 命令
在分布式环境中,您经常希望您的应用程序或作业对其他组件(通常称为事件生产者)生成的消息(事件)做出反应。 有了 Code Engine,您的应用程序或工作可以通过订阅事件制作者来接收感兴趣的事件。 事件信息以 POST HTTP 请求的形式接收应用程序,以环境变量的形式接收作业。
当对象存储桶中的对象发生变化时,Object Storage 事件生成器会生成事件。 例如,当对象被添加到一个桶中时,应用程序可以接收到一个事件,然后根据这一变化执行一个操作,或许就会消耗掉这个新对象。
在使用 subscription cos 命令之前,您必须处于 项目 的上下文环境中。
有关使用 IBM Cloud Object Storage 订阅的更多信息,请参阅 使用 IBM Cloud Object Storage 事件制作器。 有关在 Code Engine 中处理订阅的更多信息,请参阅 开始订阅。
您可以在 subscription cos 命令中使用 subscription 或 sub。 要查看 subscription cos 命令的 CLI 帮助,请运行 ibmcloud ce sub cos -h。
ibmcloud ce subscription cos create
创建 IBM Cloud Object Storage 事件订阅。
ibmcloud ce subscription cos create --name COS_SOURCE_NAME --destination DESTINATION_REF --bucket BUCKET_NAME [--destination-type DESTINATION_TYPE] [--event-type EVENT_TYPE] [--extension EXTENSION] [--force] [--no-wait] [--output OUTPUT] [--path PATH] [--prefix PREFIX] [--quiet] [--suffix SUFFIX] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--bucket,-b- 活动桶 目的地和邮筒必须位于项目的同一区域。 此值为必填项。
--destination,-d- 要接收事件的应用程序或工作资源的名称;例如,
myapp。 如有需要,可使用--path选项进一步限定应用程序的目的地。 此值为必填项。 -n,--name- IBM Cloud Object Storage 事件订阅的名称。 请使用项目中唯一的名称。
- 名称必须以小写字母数字字符开头和结尾。
- 名称必须少于或等于 253 个字符,可包含小写字母、数字、句号 (.) 和连字符 (-)。
此值为必填项。
--destination-type,--dtdestination的类型。 有效值为app和job。 此值为可选项。 默认值为app。--event-type,-e- 值得关注的活动类型。 有效值为
delete,write,和all。 此值为可选项。 缺省值为all。 --extension,--ext- 设置 CloudEvents 分机号码,发送至目的地。 必须采用
NAME=VALUE格式。 此操作可添加新的 CloudEvents 扩展名或覆盖现有的 CloudEvent 属性。 每个--extension选项指定一个扩展名;例如,--ext extA=A --ext extB=B。 此值为可选项。 --force,-f- 强制创建 IBM Cloud Object Storage 事件订阅。 该选项跳过对指定目的地的验证。 此值为可选项。 缺省值为
false。 --no-wait,--nw- 创建 IBM Cloud Object Storage 事件订阅,不要等待订阅准备就绪。 如果指定
--no-wait选项,订阅创建就会开始,不会等待。 使用subscription cos get命令检查订阅状态。 此值为可选项。 缺省值为false。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --pathdestination应用程序中转发事件的路径;例如,/events。 默认路径是destination应用程序的根 URL。 只有在destination-type为app时才能指定该选项。 此值为可选项。--prefix,-p- IBM Cloud Object Storage 对象的前缀。 此值为可选项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --suffix,-s- IBM Cloud Object Storage 对象的后缀。 指定后缀时要考虑文件类型。 此值为可选项。
--wait,-w- 创建 IBM Cloud Object Storage 事件订阅,等待订阅准备就绪。 如果指定
--wait选项,创建订阅会等待--wait-timeout选项设定的最长秒数,以便订阅准备就绪。 如果订阅在指定的--wait-timeout时间内未准备就绪,则 IBM Cloud Object Storage 事件订阅创建失败。 此值为可选项。 缺省值是true。 --wait-timeout,--wto- 等待 IBM Cloud Object Storage 事件订阅就绪的时间长度(秒)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为15。
示例
IBM Cloud Object Storage 订阅会监听 Object Storage 桶的更改。 下面的示例为名为 mybucket 的水桶创建了名为 mycosevent 的 COS 订阅,该水桶连接到名为 myapp 的应用程序。 --destination-type 选项指定 destination 的类型,即 app 或 job。 在本例中,--destination-type 是 app,这是该选项的默认值。 使用 --path 选项将事件发送到 /events 路径,这样事件就会被发送到 https://<base application URL>/events。
ibmcloud ce subscription cos create --name mycosevent --destination myapp --bucket mybucket --destination-type app --path /events
示例输出
Creating COS source 'mycosevent'...
Run 'ibmcloud ce subscription cos get -n mycosevent' to check the COS source status.
OK
ibmcloud ce subscription cos delete
删除 IBM Cloud Object Storage 事件订阅。
ibmcloud ce subscription cos delete --name COS_SOURCE_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--name,-n- IBM Cloud Object Storage 事件订阅的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --no-wait,--nw- 删除 IBM Cloud Object Storage 事件订阅,不要等待订阅被删除。 如果指定
--no-wait选项,订阅删除将开始,不会等待。 使用subscription cos get命令检查订阅状态。 此值为可选项。 缺省值为false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --wait,-w- 删除 IBM Cloud Object Storage 事件订阅,等待订阅被删除。 如果指定
--wait选项,则订阅删除会等待--wait-timeout选项设定的最长秒数来删除订阅。 该命令在订阅被删除或达到--wait-timeout时退出,以先到者为准。 此值为可选项。 缺省值是true。 --wait-timeout,--wto- 等待 IBM Cloud Object Storage 事件订阅被删除的时间长度(秒)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为15。
示例
ibmcloud ce subscription cos delete --name mycosevent -f
示例输出
Deleting COS source 'mycosevent'...
OK
ibmcloud ce subscription cos get
显示 IBM Cloud Object Storage 事件订阅的详细信息。 显示的属性包括 Name, Destination, Bucket, Event Type, Prefix, Suffix, Ready 和 Age。 要查看具体详情,请附加 | grep <attribute>。
ibmcloud ce subscription cos get --name COS_SOURCE_NAME [--output OUTPUT] [--quiet]
命令选项
--name,-n- IBM Cloud Object Storage 事件订阅的名称。 此值为必填项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce subscription cos get --name mycosevent
示例输出
Getting COS source 'mycosevent'...
OK
Name: mycosevent
ID: abcdefgh-abcd-abcd-abcd-fb6be2347a14
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 12s
Created: 2021-03-14T13:28:45-05:00
Destination: App:myapp
Bucket: mybucket
EventType: all
Ready: true
Conditions:
Type OK Age Reason
CosConfigured true 10s
Ready true 10s
ReadyForEvents true 10s
SinkProvided true 10s
Events:
Type Reason Age Source Messages
Normal CosSourceReady 11s cossource-controller CosSource is ready
当 Ready 为 true 时,COS 订阅就可以根据 COS 桶的变化触发事件。
ibmcloud ce subscription cos list
列出项目中所有 IBM Cloud Object Storage 事件订阅。
ibmcloud ce subscription cos list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce subscription cos list
示例输出
Listing COS sources...
OK
Name Age Ready Bucket EventType Prefix Suffix Destination
mycosevent 20m true mycosbucket all http://myapp.2706b22d-676b.svc.cluster.local
ibmcloud ce subscription cos update
更新 IBM Cloud Object Storage 事件订阅。
ibmcloud ce subscription cos update --name COS_SOURCE_NAME [--destination DESTINATION] [--destination-type DESTINATION_TYPE] [--event-type EVENT_TYPE] [--extension EXTENSION] [--extension-rm EXTENSION_RM] [--output OUTPUT] [--path PATH] [--prefix PREFIX] [--quiet] [--suffix SUFFIX]
命令选项
--name,-n- IBM Cloud Object Storage 事件订阅的名称。 此值为必填项。
--destination,-d- 要接收事件的应用程序或工作资源的名称;例如,
myapp。 如有需要,可使用--path选项进一步限定应用程序的目的地。 此值为可选项。 --destination-type,--dtdestination的类型。 有效值为app和job。 此值为可选项。--event-type,-e- 值得关注的活动类型。 有效值为
delete,write,和all。 此值为可选项。 --extension,--ext- 设置 CloudEvents 分机号码,发送至目的地。 必须采用
NAME=VALUE格式。 此操作可添加新的 CloudEvents 扩展名或覆盖现有的 CloudEvent 属性。 每个--extension选项指定一个扩展名;例如,--ext extA=A --ext extB=B。 此值为可选项。 --extension-rm,--ext-rm- 删除 CloudEvents 扩展名,通过指定密钥名称发送到目的地。 每个
--ext-rm选项指定一个扩展名;例如,--ext-rm extA --ext-rm extB。 此值为可选项。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --pathdestination应用程序中转发事件的路径;例如,/events。 默认路径是destination应用程序的根 URL。 只有在destination-type为app时才能指定该选项。 此值为可选项。--prefix,-p- IBM Cloud Object Storage 对象的前缀。 此值为可选项。
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --suffix,-s- IBM Cloud Object Storage 对象的后缀。 指定后缀时要考虑文件类型(扩展名)。 此值为可选项。
示例
下面的示例更新了名为 mycosevent 的 COS 订阅,使其只监听写入事件。
ibmcloud ce subscription cos update --name mycosevent --event-type write
示例输出
Updating COS source 'mycosevent'...
Run 'ibmcloud ce subscription cos get -n mycosevent' to check the COS source status.
OK
订阅 cron 命令
在分布式环境中,您经常希望您的应用程序或作业对其他组件(通常称为事件生产者)生成的消息(事件)做出反应。 有了 Code Engine,您的应用程序或工作可以通过订阅事件制作者来接收感兴趣的事件。 事件信息以 POST HTTP 请求的形式接收应用程序,以环境变量的形式接收作业。
cron 事件生成器基于 cron,每隔一段时间就会生成一个事件。 当需要在明确定义的时间间隔或特定时间执行操作时,可使用 cron 事件生成器。
在使用 subscription cron 命令之前,您必须处于 项目 的上下文环境中。
有关使用 IBM Cloud Object Storage 订阅的更多信息,请参阅 使用周期性定时器(cron)事件生成器。 有关在 Code Engine 中处理订阅的更多信息,请参阅 开始订阅。
您可以在 subscription cron 命令中使用 subscription 或 sub。 要查看 subscription cron 命令的 CLI 帮助,请运行 ibmcloud ce sub cron -h。
ibmcloud ce subscription cron create
创建 cron 事件预订。
ibmcloud ce subscription cron create --name CRON_SOURCE_NAME --destination DESTINATION_REF [--content-type CONTENT_TYPE] [--data DATA] [--data-base64 DATA_BASE64] [--destination-type DESTINATION_TYPE] [--extension EXTENSION] [--force] [--no-wait] [--output OUTPUT] [--path PATH] [--quiet] [--schedule SCHEDULE] [--time-zone TIME_ZONE] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--destination,-d- 要接收事件的应用程序或工作资源的名称;例如,
myapp。 如有需要,可使用--path选项进一步限定应用程序的目的地。 此值为必填项。 -n,--name- cron 事件订阅的名称。 请使用项目中唯一的名称。
- 名称必须以小写字母数字字符开头和结尾。
- 名称必须少于或等于 253 个字符,可包含小写字母、数字、句号 (.) 和连字符 (-)。
此值为必填项。
--content-type,--ct--data或--data-base64选项的介质类型。 例子包括application/json,application/x-www-form-urlencoded,text/html,和text/plain。 此值为可选项。--da,--data- 要发送到目的地的数据;例如,
'{ "message": "Hello world!" }'。 如果指定--data选项,请勿使用--data-base64选项。
此值为可选项。
--data-base64,--db- 要发送到目的地的 base64-encoded 数据;例如,
Q29kZSBFbmdpbmU=。 如果指定--data-base64选项,请勿使用--data选项。 此值为可选项。 --destination-type,--dtdestination的类型。 有效值为app、function和job。 此值为可选项。 默认值为app。--extension,--ext- 设置 CloudEvents 分机号码,发送至目的地。 必须采用
NAME=VALUE格式。 此操作可添加新的 CloudEvents 扩展名或覆盖现有的 CloudEvent 属性。 每个--extension选项指定一个扩展名;例如,--ext extA=A --ext extB=B。 此值为可选项。 --force,-f- 强制创建 cron 事件订阅。 该选项跳过对指定目的地的验证。 此值为可选项。 缺省值为
false。 --no-wait,--nw- 创建 cron 事件预订,但不等待该预订就绪。 如果指定
--no-wait选项,订阅创建就会开始,不会等待。 使用subscription cron get命令检查订阅状态。 此值为可选项。 缺省值为false。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --pathdestination应用程序中转发事件的路径;例如,/events。 默认路径是destination应用程序的根 URL。 只有在destination-type为app时才能指定该选项。 此值为可选项。--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --schedule,-s- 以 crontab 格式安排触发事件的频率。 例如,每两分钟指定
'*/2 * * * *'(字符串格式)。 默认情况下,cron 事件每分钟触发一次,并设置为UTC时区。 要修改时区,请使用--time-zone选项。 此值为可选项。 --time-zone,--tz- 为 cron 事件设置时区,例如
Asia/Tokyo。 如果指定了--schedule选项,则使用该选项指定时区。 有关有效时区值,请参阅 时区数据库。 此值为可选项。 默认值为UTC。 --wait,-w- 创建 cron 事件预订,并等待该预订就绪。 如果指定
--wait选项,创建订阅会等待--wait-timeout选项设定的最长秒数,以便订阅准备就绪。 如果订阅在指定的--wait-timeout时间内未准备就绪,则 cron 事件订阅创建失败。 此值为可选项。 缺省值是true。 --wait-timeout,--wto- 等待 cron 事件订阅就绪的时间长度(秒)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为15。
示例
下面的示例创建了一个名为 mycronevent 的 cron 订阅,每 2 分钟向名为 myjob 的作业转发一次 cron 事件。
ibmcloud ce subscription cron create --name mycronevent --destination myjob --schedule '*/2 * * * *' --destination-type job
示例输出
Creating cron source 'mycronevent'...
Run 'ibmcloud ce subscription cron get -n mycronevent' to check the cron source status.
OK
ibmcloud ce subscription cron delete
删除 cron 事件预订。
ibmcloud ce subscription cron delete --name CRON_SOURCE_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--name,-n- cron 事件订阅的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --no-wait,--nw- 删除 cron 事件预订,但不等待该预订删除。 如果指定
--no-wait选项,订阅删除将开始,不会等待。 使用subscription cron get命令检查订阅状态。 此值为可选项。 缺省值为false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --wait,-w- 删除 cron 事件预订,并等待该预订删除。 如果指定
--wait选项,则订阅删除会等待--wait-timeout选项设定的最长秒数来删除订阅。 该命令在订阅被删除或达到--wait-timeout时退出,以先到者为准。 此值为可选项。 缺省值是true。 --wait-timeout,--wto- 等待删除 cron 事件订阅的时间长度(秒)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为15。
示例
ibmcloud ce subscription cron delete --name mycronevent -f
示例输出
Deleting cron source 'mycronevent'...
OK
ibmcloud ce subscription cron get
显示 cron 事件预订的详细信息。
ibmcloud ce subscription cron get --name CRON_SOURCE_NAME [--output OUTPUT] [--quiet]
命令选项
--name,-n- cron 事件订阅的名称。 此值为必填项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce subscription cron get --name mycronevent
示例输出
Getting cron source 'mycronevent'...
OK
Name: mycronevent
ID: abcdefgh-abcd-abcd-abcd-fb6be2347a14
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 18s
Created: 2021-03-14T13:33:53-05:00
Destination: App:kapp
Schedule: */2 * * * *
Time Zone: UTC
Ready: true
Events:
Type Reason Age Source Messages
Normal FinalizerUpdate 19s pingsource-controller Updated "mycronevent" finalizers
当 Ready 是 true 时,cron 订阅就可以按照指定的时间表触发事件了。
ibmcloud ce subscription cron list
列出项目中的所有 cron 事件预订。
ibmcloud ce subscription cron list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce subscription cron list
示例输出
Listing cron sources...
OK
Name Age Ready Destination Schedule Data
mycronevent 96m true http://myapp.cd4200a7-5037.svc.cluster.local */2 * * * *
ibmcloud ce subscription cron update
更新 cron 事件预订。
ibmcloud ce subscription cron update --name CRON_SOURCE_NAME [--content-type CONTENT_TYPE] [--data DATA] [--data-base64 DATA_BASE64] [--destination DESTINATION] [--destination-type DESTINATION_TYPE] [--extension EXTENSION] [--extension-rm EXTENSION_RM] [--output OUTPUT] [--path PATH] [--quiet] [--schedule SCHEDULE] [--time-zone TIME_ZONE]
命令选项
--name,-n- cron 事件订阅的名称。 此值为必填项。
--content-type,--ct--data或--data-base64选项的介质类型。 例子包括application/json,application/x-www-form-urlencoded,text/html,和text/plain。 此值为可选项。--da,--data- 要发送到目的地的数据;例如,
'{ "message": "Hello world!" }'。 如果指定--data选项,请勿使用--data-base64选项。
此值为可选项。
--data-base64,--db- 要发送到目的地的 base64-encoded 数据;例如,
Q29kZSBFbmdpbmU=。 如果指定--data-base64选项,请勿使用--data选项。 此值为可选项。 --destination,-d- 要接收事件的应用程序或工作资源的名称;例如,
myapp。 如有需要,可使用--path选项进一步限定应用程序的目的地。 此值为可选项。 --destination-type,--dtdestination的类型。 有效值为app、function和job。 此值为可选项。--extension,--ext- 设置 CloudEvents 分机号码,发送至目的地。 必须采用
NAME=VALUE格式。 此操作可添加新的 CloudEvents 扩展名或覆盖现有的 CloudEvent 属性。 每个--extension选项指定一个扩展名;例如,--ext extA=A --ext extB=B。 此值为可选项。 --extension-rm,--ext-rm- 删除 CloudEvents 扩展名,通过指定密钥名称发送到目的地。 每个
--ext-rm选项指定一个扩展名;例如,--ext-rm extA --ext-rm extB。 此值为可选项。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --pathdestination应用程序中转发事件的路径;例如,/events。 默认路径是destination应用程序的根 URL。 只有在destination-type为app时才能指定该选项。 此值为可选项。--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --schedule,-s- 以 crontab 格式安排触发事件的频率。 例如,每两分钟指定
'*/2 * * * *'(字符串格式)。 默认情况下,cron 事件每分钟触发一次,并设置为UTC时区。 要修改时区,请使用--time-zone选项。 此值为可选项。 --time-zone,--tz- 为 cron 事件设置时区,例如
Asia/Tokyo。 如果指定了--schedule选项,则使用该选项指定时区。 有关有效时区值,请参阅 时区数据库。 此值为可选项。
示例
下面的示例更新了名为 mycronevent 的 cron 源订阅,该订阅每小时向名为 myjob 的作业转发一次 cron 事件。
ibmcloud ce subscription cron update --name mycronevent --destination myjob --schedule '0 * * * *' --destination-type job
示例输出
Updating cron source 'mycronevent'...
Run 'ibmcloud ce subscription cron get -n mycronevent' to check the cron source status.
OK
订阅 kafka 命令
在分布式环境中,您经常希望您的应用程序或作业对其他组件(通常称为事件生产者)生成的消息(事件)做出反应。 有了 Code Engine,您的应用程序或工作可以通过订阅事件制作者来接收感兴趣的事件。 事件信息以 POST HTTP 请求的形式接收应用程序,以环境变量的形式接收作业。
Kafka 事件生成器会监视 Kafka 实例中出现的新信息。 当您为一组主题创建 Code Engine Kafka 订阅时,您的应用程序或任务会为其中一个主题中出现的每条新消息接收一个单独的事件。
在使用 subscription kafka 命令之前,您必须处于 项目 的上下文环境中。
有关使用 Kafka 事件订阅的更多信息,请参阅 使用 Kafka 事件制作器。 有关在 Code Engine 中处理订阅的更多信息,请参阅 开始订阅。
您可以在 subscription kafka 命令中使用 subscription 或 sub。 要查看 subscription 命令的 CLI 帮助,请运行 ibmcloud ce sub kafka -h。
ibmcloud ce subscription kafka create
创建 Kafka 事件预订。
ibmcloud ce subscription kafka create --name KAFKA_SOURCE_NAME --destination DESTINATION_REF --topic TOPIC --broker BROKER [--consumer-group CONSUMER_GROUP] [--destination-type DESTINATION_TYPE] [--extension EXTENSION] [--force] [--no-wait] [--output OUTPUT] [--password PASSWORD] [--path PATH] [--quiet] [--secret SECRET] [--username USERNAME] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--broker,-b- 在 Kafka 源中设置代理。 经纪人是消费者连接的 Kafka 服务器。 可以多次指定此选项。 此值为必填项。
--destination,-d- 要接收事件的应用程序或工作资源的名称;例如,
myapp。 如有需要,可使用--path选项进一步限定应用程序的目的地。 此值为必填项。 -n,--name- Kafka 事件订阅的名称。 请使用项目中唯一的名称。
- 名称必须以小写字母数字字符开头和结尾。
- 名称必须少于或等于 253 个字符,可包含小写字母、数字、句号 (.) 和连字符 (-)。
此值为必填项。
--topic,-t- 在 Kafka 源中设置一个主题。 主题用于过滤要消费的信息。 可以多次指定此选项。 此值为必填项。
--consumer-group,--cg- 事件消费者组的名称。 此值为可选项。
--destination-type,--dtdestination的类型。 有效值为app和job。 此值为可选项。 默认值为app。--extension,--ext- 设置 CloudEvents 分机号码,发送至目的地。 必须采用
NAME=VALUE格式。 此操作可添加新的 CloudEvents 扩展名或覆盖现有的 CloudEvent 属性。 每个--extension选项指定一个扩展名;例如,--ext extA=A --ext extB=B。 此值为可选项。 --force,-f- 强制创建 Kafka 事件订阅。 该选项跳过对指定目的地和密文的验证。 此值为可选项。 缺省值为
false。 --no-wait,--nw- 创建 Kafka 事件预订,但不等待该预订就绪。 如果指定
--no-wait选项,订阅创建就会开始,不会等待。 使用subscription kafka get命令检查订阅状态。 此值为可选项。 缺省值为false。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --password,-p- 用于向 Kafka 实例认证的密码。 如果指定
--password选项,则不得指定--secret选项。 此值为可选项。 --pathdestination应用程序中转发事件的路径;例如,/events。 默认路径是destination应用程序的根 URL。 只有在destination-type为app时才能指定该选项。 此值为可选项。--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --secret,-s- 用于验证 Kafka 实例的密文名称,其中包括
username和password密钥。 如果指定--secret选项,则不得指定--username或--password选项。 此值为可选项。 --username,-u- 用于向 Kafka 实例认证的用户名。 如果指定
--username选项,则必须指定--password选项,不得指定--secret选项。 此值为可选项。 缺省值是token。 --wait,-w- 创建 Kafka 事件预订,并等待该预订就绪。 如果指定
--wait选项,创建订阅会等待--wait-timeout选项设定的最长秒数,以便订阅准备就绪。 如果订阅在指定的--wait-timeout时间内未准备就绪,则 Kafka 事件订阅创建失败。 此值为可选项。 缺省值是true。 --wait-timeout,--wto- 等待 Kafka 事件订阅就绪的时间长度(秒)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为120。
示例
下面的示例创建了一个名为 mykafkaevent 的 Kafka 事件订阅,它将 Kafka 事件转发给名为 kafka-receiver-app 的接收应用程序。 为每个经纪人指定一个 --broker 选项。 --destination 选项指定接收事件的 Code Engine 资源。 kafka-subscription-secret 提供访问消息代理的凭据。
ibmcloud ce subscription kafka create --name mykafkasubscription --destination kafka-receiver-app --secret kafka-subscription-secret --topic kafka-topic1 --broker broker-3-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093 --broker broker-5-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093 --broker broker-0-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093 --broker broker-1-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093 --broker broker-4-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093 --broker broker-2-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
示例输出
Creating Kafka event subscription 'mykafkasubscription'...
Run 'ibmcloud ce subscription kafka get -n mykafkasubscription' to check the Kafka event subscription status.
OK
ibmcloud ce subscription kafka delete
删除 Kafka 事件预订。
ibmcloud ce subscription kafka delete --name KAFKA_SOURCE_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
命令选项
--name,-n- Kafka 事件订阅的名称。 此值为必填项。
--force,-f- 强制删除而不确认。 此值为可选项。 缺省值为
false。 --ignore-not-found,--inf- 如果找不到,不让操作失败。 此值为可选项。 缺省值为
false。 --no-wait,--nw- 删除 Kafka 事件预订,但不等待该预订删除。 如果指定
--no-wait选项,订阅删除将开始,不会等待。 使用subscription kafka get命令检查订阅状态。 此值为可选项。 缺省值为false。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --wait,-w- 删除 Kafka 事件预订,并等待该预订删除。 如果指定
--wait选项,则订阅删除会等待--wait-timeout选项设定的最长秒数来删除订阅。 该命令在订阅被删除或达到--wait-timeout时退出,以先到者为准。 此值为可选项。 缺省值是true。 --wait-timeout,--wto- 等待 Kafka 事件订阅被删除的时间长度(秒)。 如果指定了
--wait选项,则必须使用该值。 如果指定了--no-wait选项,该值将被忽略。 缺省值为15。
示例
ibmcloud ce subscription kafka delete --name mykafkasubscription -f
示例输出
Deleting Kafka event subscription 'mykafkasubscription'...
OK
ibmcloud ce subscription kafka get
显示 Kafka 事件预订的详细信息。
ibmcloud ce subscription kafka get --name KAFKA_SOURCE_NAME [--output OUTPUT] [--quiet]
命令选项
--name,-n- Kafka 事件订阅的名称。 此值为必填项。
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce subscription kafka get --name mykafkasubscription
示例输出
Getting Kafka event subscription 'mykafkasubscription'...
OK
Name: mykafkasubscription
[...]
Destination Type: app
Destination: kafka-receiver-app2
Brokers:
broker-3-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
broker-5-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
broker-0-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
broker-1-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
broker-4-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
broker-2-abcdabcdabcdabcd.kafka.svc07.us-south.eventstreams.cloud.ibm.com:9093
Consumer Group: knative-kafka-source-a4072fe1-1dfa-4470-9d07-bf7a0ff8e340
Topics:
kafka-topic1
Secret key reference (user): kafka-subscription-secret.username
Secret key reference (password): kafka-subscription-secret.password
Ready: true
Conditions:
Type OK Age Reason
ConnectionEstablished true 24s
InitialOffsetsCommitted true 24s
Ready true 24s
Scheduled true 24s
SinkProvided true 24s
Events:
Type Reason Age Source Messages
Normal FinalizerUpdate 26s kafkasource-controller Updated "mykafkasubscription" finalizers
当 Ready 为 true 时,Kafka 订阅就可以按照指定的时间表触发事件。
ibmcloud ce subscription kafka list
列出项目中的所有 Kafka 事件预订。
ibmcloud ce subscription kafka list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
命令选项
--output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --sort-by,-s- 指定用于对列表进行排序的列。 有效值为
name和age。 此值为可选项。 默认值为name。
示例
ibmcloud ce subscription kafka list
示例输出
Listing Kafka event subscriptions...
OK
Name Age Ready Destination Type Destination Path Consumer Group Reason
mykafkasubscription 94s true app kafka-receiver-app knative-kafka-source-dc367965-15e4-44f3-bedf-25d453524a68
ibmcloud ce subscription kafka update
更新 Kafka 事件预订。
ibmcloud ce subscription kafka update --name KAFKA_SOURCE_NAME [--broker BROKER] [--destination DESTINATION] [--destination-type DESTINATION_TYPE] [--extension EXTENSION] [--extension-rm EXTENSION_RM] [--output OUTPUT] [--password PASSWORD] [--path PATH] [--quiet] [--secret SECRET] [--topic TOPIC] [--username USERNAME]
命令选项
--name,-n- Kafka 事件订阅的名称。 此值为必填项。
--broker,-b- 在 Kafka 源中设置代理。 经纪人是消费者连接的 Kafka 服务器。 可以多次指定此选项。 此值为可选项。
--destination,-d- 要接收事件的应用程序或工作资源的名称;例如,
myapp。 如有需要,可使用--path选项进一步限定应用程序的目的地。 此值为可选项。 --destination-type,--dtdestination的类型。 有效值为app和job。 此值为可选项。--extension,--ext- 设置 CloudEvents 分机号码,发送至目的地。 必须采用
NAME=VALUE格式。 此操作可添加新的 CloudEvents 扩展名或覆盖现有的 CloudEvent 属性。 每个--extension选项指定一个扩展名;例如,--ext extA=A --ext extB=B。 此值为可选项。 --extension-rm,--ext-rm- 删除 CloudEvents 扩展名,通过指定密钥名称发送到目的地。 每个
--ext-rm选项指定一个扩展名;例如,--ext-rm extA --ext-rm extB。 此值为可选项。 --output,-o- 指定命令输出的格式。 有效值为
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 输出元素的路径。 此值为可选项。 --password,-p- 用于向 Kafka 实例认证的密码。 如果指定
--password选项,则不得指定--secret选项。 此值为可选项。 --pathdestination应用程序中转发事件的路径;例如,/events。 默认路径是destination应用程序的根 URL。 只有在destination-type为app时才能指定该选项。 此值为可选项。--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。 --secret,-s- 用于验证 Kafka 实例的密文名称,其中包括
username和password密钥。 如果指定--secret选项,则不得指定--username或--password选项。 此值为可选项。 --topic,-t- 在 Kafka 源中设置一个主题。 主题用于过滤要消费的信息。 可以多次指定此选项。 此值为可选项。
--username,-u- 用于向 Kafka 实例认证的用户名。 如果指定
--username选项,则必须指定--password选项,不得指定--secret选项。 此值为可选项。 缺省值是token。
示例
下面的示例更新了 Kafka 事件订阅,以使用 kafka-topic2 代替 kafka-topic1。
ibmcloud ce subscription kafka update --name mykafkasubscription --topic kafka-topic2
示例输出
Updating Kafka event subscription 'mykafkasubscription'...
Run 'ibmcloud ce subscription kafka get -n mykafkasubscription' to check the Kafka event subscription status.
OK
版本指令
显示 code-engine 命令行界面的版本。
ibmcloud ce version
显示 code-engine 命令行界面的版本。
ibmcloud ce version [--quiet]
命令选项
--quiet,-q- 指定该选项可减少命令的输出。 此值为可选项。 缺省值为
false。
示例
ibmcloud ce version
示例输出
version: v1.17.0
commit: 3ab130b746f4784c9ff8d3da7bb05b6e7acda6d5