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
應用程式指令
應用程式(或稱 app)會執行您的程式碼,為 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。
範例
在這個範例中,將您的 IBM Cloud Object Storage 服務實例 my-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 commit 選項。 此值為可選項。 --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-
使用下列其中一種方式,從儲存於此 configmap 的 key-value 對中設定環境變數:
- 若要為名為
configmapName的 configmap 中的所有按鍵新增環境變數,請使用值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的 configmap 中為單一關鍵key1新增環境變數,請使用configmapName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,若要為名為configmapName的 configmap 中的單一鍵key1新增名為myKey的環境變數,請使用值configmapName:myKey=key1。
此值為可選項。
--env-sec,--env-from-secret- 使用下列其中一種方式,從儲存於秘密中的鍵值對設定環境變數:
- 若要為命名為
secretName的秘密中的所有金鑰新增環境變數,請使用secretName。 您可以在引用秘密時指定前綴來修改環境變數名稱。 若要指定前綴,請使用PREFIX=SECRET_NAME。 每個結果環境變數的格式為<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,若要將密碼secretName中所有變數名稱的前綴設定為CUSTOM_,請使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,環境變數名稱就是CUSTOM_KEY_A。 - 若要為個別金鑰新增環境變數,請使用格式
NAME:KEY_A,KEY_B. 例如,若要在名稱為secretName的秘密中為單一金鑰key1新增環境變數,請使用secretName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,要在一個名為secretName的秘密中為單一金鑰key1新增一個名為myKey的環境變數,請使用secretName:myKey=key1的值。
此值為可選項。
--ephemeral-storage,--es- 要為應用程式實例設定的暫時儲存體數量。 若要表示兆位元組,請使用
M;若要表示吉位元組,請使用G。 此值為可選項。 預設值為400M。
- 若要為名為
--force,-f-
不驗證指定的 configmap 和 secret 參照是否存在。 Configmap 引用是使用
--env-from-configmap或--mount-configmap選項指定的。 秘密參照使用--env-from-secret、--mount-secret或--registry-secret選項指定。 此值為可選項。 預設值為false。 --image,-i-
用於此應用程式的影像名稱。 格式為
REGISTRY/NAMESPACE/REPOSITORY:TAG,其中REGISTRY和TAG皆為可選項目。 若未指定REGISTRY,預設值為docker.io。 若未指定TAG,預設值為latest。 若未指定--build-source選項,則必須指定image選項。 此值為可選項。 --max-scale,--max,--maxscale-
此應用程式可使用的最大實體數。 若將此值設定為
0``,應用程式便會根據需求進行擴展。 應用程式調整大小僅受限於應用程式專案的每個資源配額的實例數。 請參閱 Code Engine 的限制和配額。 此值為可選項。 預設值為10。 --memory,-m-
為該應用程式執行個體設定的記憶體用量。 若要表示兆位元組,請使用
M;若要表示吉位元組,請使用G。 有關有效值,請參閱 支援的記憶體和 CPU 組合。 此值為可選項。 預設值為4G。 --min-scale,--min,--minscale-
此應用程式可使用的最小實體數量。 此選項有助於確保在不需要時不會執行任何實體。 此值為可選項。 預設值為
0。 --mount-configmap,--mount-cm-
透過提供掛載目錄和 configmap 的名稱,將 configmap 的內容加入應用程式容器的檔案系統,格式為
MOUNT_DIRECTORY=CONFIGMAP_NAME. 每個掛載的 configmap 必須使用唯一的掛載目錄。 對於 configmap 中的每個 key-value 對,都會新增一個檔案到指定的 mount 目錄,其中檔案名稱是 key,檔案內容是 key-value 對的值。 每個--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 選項。 此值為可選項。 --build-commit-clear,--commit-clear,--bcmc,--cmc-
清除來源儲存庫中要取回的確定、標籤或分支。 如果您的應用程式目前有相關的建立,則允許使用 commit clear 選項。 此值為可選項。 預設值為
false。 --build-context-dir,--context-dir,--bcdr,--cdr-
套件庫中包含 buildpacks 檔案或 Dockerfile 的目錄。 如果在此
app update指令上設定了--build-source選項,或您的應用程式目前有相關的建立,則允許使用建立上下文目錄選項。 此值為可選項。 --build-dockerfile,--dockerfile,--bdf,--df-
Dockerfile 的路徑。 僅在名稱不是
Dockerfile時指定此選項。 build dockerfile 選項只有在--build-source選項被設定在這個app update指令上,或是你的應用程式目前有一個相關的 build 時才允許使用。 此值為可選項。 預設值為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-
在建立成功或失敗之前所能經過的時間,以秒為單位。 僅當
--build-source選項已在此app update指令上設定,或您的應用程式目前有相關的建立時,才允許使用建立逾時選項。 此值為可選項。 預設值為600。 --cluster-local,--cl-
使用僅限專案端點來部署應用程式。 設定「僅限專案」端點,表示您的應用程式無法透過公共網際網路存取,且僅能由在同一專案中執行的其他 Code Engine 元件進行網路存取。 此值為可選項。 預設值為
false。 --command,--cmd,-c-
設定應用程式的指令。 每個
--command選項指定一個指令;例如,--cmd cmdA --cmd cmdB。 此值會覆寫在容器影像中指定的預設命令。 此值為可選項。 --commands-clear,--cc-
清除應用程式指令。 此值為可選項。 預設值為
false。 --concurrency,--cn-
每個執行個體可同時處理的請求最大數量。 此值為可選項。 預設值為
0。 --concurrency-target,--ct-
建立一個或多個額外實體時,每個實體的並發請求臨界值。 使用此值可根據並發請求數擴充實體。 如果
--concurrency-target未指定,則此選項預設為--concurrency選項的值。 此值為可選項。 預設值為0。 --cpu-
為該應用程式執行個體設定的 CPU 數量。 有關有效值,請參閱 支援的記憶體和 CPU 組合。 此值為可選項。 預設值為
0。 --env,-e-
在應用程式中設定環境變數。 必須採用
NAME=VALUE格式。 此動作可新增環境變數或覆寫現有的環境變數。 每個--env選項指定一個環境變數;例如,--env envA=A --env envB=B。 此值為可選項。 --env-cm,--env-from-configmap-
使用下列其中一種方式,從儲存於此 configmap 的 key-value 對中設定環境變數:
- 若要為名為
configmapName的 configmap 中的所有按鍵新增環境變數,請使用值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的 configmap 中為單一關鍵key1新增環境變數,請使用configmapName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,若要為名為configmapName的 configmap 中的單一鍵key1新增名為myKey的環境變數,請使用值configmapName:myKey=key1。
此值為可選項。
--env-from-configmap-rm,--env-cm-rm- 使用 configmap 名稱,移除對完整 configmap 的環境變數參照。 若要移除對 configmaps 的個別關鍵參照,請使用
--env-rm選項。 此選項可以指定多次。 此值為可選項。
- 若要為名為
--env-sec,--env-from-secret-
使用下列其中一種方式,從儲存於秘密中的鍵值對設定環境變數:
- 若要為命名為
secretName的秘密中的所有金鑰新增環境變數,請使用secretName。 您可以在引用秘密時指定前綴來修改環境變數名稱。 若要指定前綴,請使用PREFIX=SECRET_NAME。 每個結果環境變數的格式為<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,若要將密碼secretName中所有變數名稱的前綴設定為CUSTOM_,請使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,環境變數名稱就是CUSTOM_KEY_A。 - 若要為個別金鑰新增環境變數,請使用格式
NAME:KEY_A,KEY_B. 例如,若要在名稱為secretName的秘密中為單一金鑰key1新增環境變數,請使用secretName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,要在一個名為secretName的秘密中為單一金鑰key1新增一個名為myKey的環境變數,請使用secretName:myKey=key1的值。
此值為可選項。
--env-from-secret-rm,--env-sec-rm- 使用秘密名稱,移除對完整秘密的環境變數參照。 若要移除秘密的個別金鑰參照,請使用
--env-rm選項。 此選項可以指定多次。 此值為可選項。
- 若要為命名為
--env-rm-
移除對 configmap 或 secret 中鍵值對的 key 的環境變數參照。 若要移除個別的關鍵參照和字面值,請指定關鍵的名稱。 此選項可以指定多次。 此值為可選項。
--ephemeral-storage,--es-
要為應用程式實例設定的暫時儲存體數量。 若要表示兆位元組,請使用
M;若要表示吉位元組,請使用G。 此值為可選項。 --force,-f-
不驗證指定的 configmap 和 secret 參照是否存在。 Configmap 引用是使用
--env-from-configmap或--mount-configmap選項指定的。 秘密參照使用--env-from-secret、--mount-secret或--registry-secret選項指定。 此值為可選項。 預設值為false。 --image,-i-
用於此應用程式的影像名稱。 格式為
REGISTRY/NAMESPACE/REPOSITORY:TAG,其中REGISTRY和TAG皆為可選項目。 若未指定REGISTRY,預設值為docker.io。 若未指定TAG,預設值為latest。 此值為可選項。 --max-scale,--max,--maxscale-
此應用程式可使用的最大實體數。 若將此值設定為
0``,應用程式便會根據需求進行擴展。 應用程式調整大小僅受限於應用程式專案的每個資源配額的實例數。 請參閱 Code Engine 的限制和配額。 此值為可選項。 預設值為10。 --memory,-m-
為該應用程式執行個體設定的記憶體用量。 若要表示兆位元組,請使用
M;若要表示吉位元組,請使用G。 有關有效值,請參閱 支援的記憶體和 CPU 組合。 此值為可選項。 --min-scale,--min,--minscale-
此應用程式可使用的最小實體數量。 此值為可選項。 預設值為
0。 --mount-configmap,--mount-cm-
透過提供掛載目錄和 configmap 的名稱,將 configmap 的內容加入應用程式容器的檔案系統,格式為
MOUNT_DIRECTORY=CONFIGMAP_NAME. 每個掛載的 configmap 必須使用唯一的掛載目錄。 對於 configmap 中的每個 key-value 對,都會新增一個檔案到指定的 mount 目錄,其中檔案名稱是 key,檔案內容是 key-value 對的值。 每個--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-
從應用程式容器的檔案系統中移除 configmap 或 secret 的內容,方法是指定掛載 configmap 或 secret 的目錄。 每個
--mount-rm選項指定一個掛載目錄;例如,--mount-rm /etc/configmap-a --mount-rm /etc/secret-b。 此值為可選項。 --mount-secret,--mount-sec-
透過提供掛載目錄和秘密名稱,將秘密的內容加入應用程式容器的檔案系統,格式為
MOUNT_DIRECTORY=SECRET_NAME. 每個掛載的秘密必須使用唯一的掛載目錄。 對於秘密中的每個鍵值對,都會在指定的掛載目錄中加入一個檔案,其中檔案名稱是鍵,檔案內容是鍵值對的值。 每個--mount-secret選項指定一個掛載設定;例如,--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b。 此值為可選項。 --no-cluster-local,--ncl-
部署帶有公用端點的應用程式。 此應用程式的部署方式,使其能夠接收來自公共網際網路或「Code Engine」專案內各元件的請求。 此值為可選項。 預設值為
true。 --no-wait,--nw-
更新申請,不要等待申請就緒。 如果指定
no-wait選項,應用程式更新會開始,不會等待。 使用app get指令檢查應用程式狀態。 此值為可選項。 預設值為false。 --output,-o-
指定指令輸出的格式。 有效值包括:
json、yaml、jsonpath=JSONPATH_EXPRESSION、jsonpath-as-json=JSONPATH_EXPRESSION、url以及project-url。 使用jsonpath指定 JSON 輸出元素的路徑。 此值為可選項。 --port,-p-
應用程式監聽的連接埠。 格式為
[NAME:]PORT,其中[NAME:]為可選項目。 如果指定[NAME:],有效值為h2c,或http1。 當[NAME:]未指定或為http1時,埠會使用 HTTP/1.1。 當[NAME:]為h2c時,連接埠使用未加密的 HTTP/2。 預設情況下,Code Engine 假定應用程式會在8080連接埠上聽取傳入的連線。 如果您的應用程式需要在8080以外的連接埠聆聽,請使用--port指定連接埠。 此值為可選項。 --probe-live,--pl-
以 NAME=VALUE 格式配置此應用程式的活性探測。 NAME 的有效選項為
type,port,path,interval,initial-delay,timeout,failure-threshold。此選項可指定多次。type屬性為必填項目,有效值為tcp和http。 例如,--probe-live type=tcp --probe-live port=8080。 有關使用探針的詳細資訊,請參閱 為您的應用程式配置探針。 此值為可選項。 --probe-live-clear,--plr-
移除活性探測。 只有當您的應用程式目前有一個 liveness probe 時,才允許此選項。 此值為可選項。 預設值為
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 支援從 Docker 檔案建立,而 Cloud Native Buildpacks 則支援從 Docker 檔案建立。 使用 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,則允許使用 commit 選項;如果--build-type選項是local,則不允許使用 commit 選項。 此值為可選項。 --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 支援從 Docker 檔案建立,而 Cloud Native Buildpacks 則支援從 Docker 檔案建立。 使用 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,則允許 build commit 選項;如果--source選項未設定為 Git 儲存庫的 URL,則不允許 build commit 選項。 此值為可選項。 --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選項,則 name 選項是可選的。 如果未設定--build選項,則必須使用 name 選項。- 名稱必須以小寫的英數字元開頭,並以小寫的英數字元結尾。
- 名稱必須為 63 個字元或以下,並可包含小寫字母數字字元和連字號 (-)。
此值為可選項。
--no-wait,--nw- 提交建立執行,不要等待此建立執行完成。 如果指定
--no-wait選項,則會開始提交建立執行,而不會等待。 使用buildrun get指令檢查建立執行狀態。 此值為可選項。 預設值為true。
--output,-o-
指定指令輸出的格式。 有效值為
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 輸出元素的路徑。 此值為可選項。 --quiet,-q-
指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。 --registry-secret,--rs-
登錄密鑰的名稱。 當您下載容器映像檔時,會使用登錄密鑰向專用登錄進行鑑別。 如果
--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 指令建立、顯示詳細資料、更新及刪除組態圖。
在使用 configmap 指令之前,您必須在 專案 的上下文中。
如需有關使用 configmaps 的詳細資訊,請參閱 使用 configmaps。
您可以在 configmap 指令中使用 configmap 或 cm。 若要查看 configmap 命令的 CLI 說明,請執行 ibmcloud ce configmap -h。
ibmcloud ce configmap create
建立 configmap。
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-
configmap 的名稱。 請使用專案內唯一的名稱。
- 名稱必須以小寫的英數字元開頭,並以小寫的英數字元結尾。
- 名稱必須為 253 個字元或以下,並可包含小寫字母、數字、句點 (.) 和連字號 (-)。
此欄位為必填項目。
--from-env-file,-e- 從檔案建立 configmap,該檔案包含符合格式
KEY=VALUE的一或多行。 您必須提供檔案的路徑作為值。 指定檔案中的每一行都會以鍵值對的方式加入。 指定檔案中的任何空行或以#開頭的行都會被忽略。 如果未指定--from-literal或--from-file,則必須使用此值。
--from-file,-f-
從檔案建立一個 ConfigMap。 您必須提供檔案的路徑作為值。 如果未指定
--from-literal或--from-env-file,則必須使用此值。 --from-literal,-l-
從鍵值對建立 configmap。 必須採用
KEY=VALUE格式。 如果未指定--from-file或--from-env-file,則必須使用此值。 此選項可以指定多次。 --output,-o-
指定指令輸出的格式。 有效值為
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 輸出元素的路徑。 此值為可選項。 --quiet,-q-
指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。
範例
以下範例建立了一個名為 configmap-fromliteral 的 configmap,其中有兩個關鍵對值:color=blue 和 size=large。
ibmcloud ce configmap create --name configmap-fromliteral --from-literal color=blue --from-literal size=large
輸出範例
Creating Configmap 'configmap-fromliteral'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromliteral' to see more details.
包含來自多個檔案的值的 configmap 範例
以下範例建立了一個名為 configmap-fromfile 的 configmap,其中包含來自多個檔案的值。
ibmcloud ce configmap create --name configmap-fromfile --from-file ./color.txt --from-file ./size.txt
包含多個檔案值的 configmap 輸出範例
Creating configmap 'configmap-fromfile'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromfile' to see more details.
ibmcloud ce configmap delete
刪除一個 configmap。
ibmcloud ce configmap delete --name CONFIGMAP_NAME [--force] [--ignore-not-found] [--quiet]
指令選項
--name,-n- configmap 的名稱。 此欄位為必填項目。
--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- configmap 的名稱。 此欄位為必填項目。
--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
列出專案中的所有 ConfigMap。
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- configmap 的名稱。 此欄位為必填項目。
--from-env-file,-e- 從檔案更新 configmap,該檔案包含符合格式
KEY=VALUE的一行或多行。 您必須提供檔案的路徑作為值。 指定檔案中的每一行都會以鍵值對的方式加入。 指定檔案中的任何空行或以#開頭的行都會被忽略。 如果未指定--from-literal或--from-file,則必須使用此值。 此選項可以指定多次。 --from-file,-f- 從檔案更新 configmap。 您必須提供檔案的路徑作為值。 如果未指定
--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 中的個別鍵值對。 此選項可以指定多次。 此值為可選項。
範例
以下範例以使用者名稱和密碼值對更新名為 configmap-fromliteral 的 configmap。
ibmcloud ce configmap update --name configmap-fromliteral --from-literal username=devuser --from-literal password='A!B99c$D1Def'
輸出範例
Updating configmap 'configmap-fromliteral'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromliteral' to see more details.
包含檔案值的 configmap 範例
以下範例使用檔案中的值更新名為 configmap-fromfile 的 configmap。
ibmcloud ce configmap update --name configmap-fromfile --from-file ./username.txt --from-file ./password.txt
包含檔案值的 configmap 輸出範例
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 Private Path 服務。
- 定義 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 中的安全性。
在使用 connectivity subnetpool 指令之前,您必須在 專案 的上下文中。
有關使用 subnetpool 連線指令的詳細資訊,請參閱 Code Engine 中的使用 subnetpool 連線。
您可以在 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- 提供儲存區的有效子網路 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
網域映射指令
網域映射可為專案中的 Code Engine 應用程式和函式提供 URL 路徑。 在 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.
艦隊指令
管理無伺服器 Fleet。
ibmcloud ce fleet cancel
取消無伺服器 Fleet。
ibmcloud ce fleet cancel --id FLEET_ID [--force] [--hard] [--quiet]
指令選項
--id,--fid,--fleet-id- 必要。 無伺服器 Fleet 的 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
啟動無伺服器 Fleet。
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- 必要。 指定用於儲存 Fleet 作業狀態的持續資料儲存庫。 此欄位為必填項目。
--argument,--arg,-a- 設定作業中要執行的指令所需的指令引數。 此選項可以指定多次。 此值為可選項。
--command,--cmd,-c- 在作業中設定執行指令。 此選項可以指定多次。 此值為可選項。
--cpu,--cp- 為作業設定的 CPU 數量。 此值為可選項。 預設值為
1。 --env,-e- 設定環境變數以傳遞到作業中。 必須是 NAME=VALUE 格式。 此選項可以指定多次。 此值為可選項。
--env-from-configmap,--env-cm- 從儲存於此 configmap 的 key-value 對設定環境變數。 提供 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- Fleet 的名稱。 此值為可選項。
--quiet,-q- 指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。 --registry-secret,--rs- 登錄密鑰的名稱。 登錄密鑰用於與專用登錄進行鑑別,以下載儲存器映像檔。 執行
ibmcloud ce registry create以建立登錄機密。 此值為可選項。 --retrylimit,-r- 在將作業標記為失敗之前,重新執行該作業的次數。 此值為可選項。 預設值為
3。 --subnetpool-id,--spi- 用於 Fleet 網路放置的子網路儲存區 ID。 此值為可選項。
--subnetpool-name,--spn- 用於 Fleet 網路放置的子網路儲存區名稱。 此值為可選項。
--task-indexes,--ti- 請指定要處理的任務索引,例如
0,3,6,9、1-5,7-8,10。 指定最多 1000 個索引項目。 若已指定--tasks,則無法指定此選項。 此值為可選項。 --tasks,--ts- 指定要由 Fleet 處理的作業數量。 若未提供任何工作規格選項,則會使用此選項,其預設值為
1。 --tasks-from-cos-bucket,--ts-bucket- 指定 COS 儲存區中檔案的位置。 對於每個檔案,作業將由 Fleet 處理。 此值為可選項。
--tasks-from-cos-object,--ts-cos- 指定位於 COS 儲存區中的 JSONL 檔案位置。 該檔案定義了要由 Fleet 處理的作業。 此值為可選項。
--tasks-from-local-file,--ts-file- 指定本端 JSONL 檔案的路徑。 該檔案定義了要由 Fleet 處理的作業。 此值為可選項。
--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
刪除無伺服器 Fleet。
ibmcloud ce fleet delete --id FLEET_ID [--force] [--ignore-not-found] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
指令選項
--id,--fid,--fleet-id- 必要。 無伺服器 Fleet 的 ID。 此欄位為必填項目。
--force,-f- 強制刪除,而不進行確認。 此值為可選項。 預設值為
false。 --ignore-not-found,--inf- 如果未找到,請勿失敗。 此值為可選項。 預設值為
false。 --quiet,-q- 指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。 --wait,-w- 刪除無伺服器 Fleet,並等待 Fleet 刪除完成。 此值為可選項。 預設值為
false。 --wait-timeout,--wto- 等待無伺服器 Fleet 被刪除所需的時間(以秒為單位) 此值為可選項。 預設值為
180。
範例
ibmcloud ce fleet delete --force --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
輸出範例
Deleting serverless fleet...
OK
ibmcloud ce fleet get
顯示無伺服器 Fleet 的詳細資料。
ibmcloud ce fleet get --id FLEET_ID [--output OUTPUT] [--quiet]
指令選項
--id,--fid,--fleet-id- 必要。 無伺服器 Fleet 的 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
列出專案中的所有無伺服器 Fleet。
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
管理無伺服器 Fleet 作業。
ibmcloud ce fleet task COMMAND [--quiet]
指令選項
--quiet,-q- 指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。
ibmcloud ce fleet task get
顯示無伺服器 Fleet 作業的詳細資料。
ibmcloud ce fleet task get --task-id TASK_ID --fleet-id FLEET_ID [--output OUTPUT] [--quiet]
指令選項
--fleet-id,--fid- 必要。 該作業所屬 Fleet 的 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
列出無伺服器 Fleet 的所有作業。
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- 必要。 該作業所屬 Fleet 的 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
管理無伺服器 Fleet 工作程式。
ibmcloud ce fleet worker COMMAND [--quiet]
指令選項
--quiet,-q- 指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。
ibmcloud ce fleet worker delete
刪除無伺服器 Fleet 工作者。
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- 必要。 該工作程式所屬 Fleet 的 ID。 此欄位為必填項目。
--name,-n,--worker-name- 必要。 無伺服器 Fleet 工作者的名稱。 此欄位為必填項目。
--force,-f- 強制刪除,而不進行確認。 此值為可選項。 預設值為
false。 --hard- 立即刪除無伺服器 Fleet 工作程式。 若未指定「硬」選項,工作程式將繼續處理「執行中」的作業,直到這些作業達到最終狀態後,然後才會刪除工作程式。 此值為可選項。 預設值為
false。 --ignore-not-found,--inf- 如果未找到,請勿失敗。 此值為可選項。 預設值為
false。 --quiet,-q- 指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。 --wait,-w- 刪除無伺服器 Fleet 工作者,並等待工作者完成刪除。 此值為可選項。 預設值為
false。 --wait-timeout,--wto- 等待無伺服器 Fleet 工作者完成刪除的時間(以秒為單位)。 此值為可選項。 預設值為
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
顯示無伺服器 Fleet 工作者的詳細資料。
ibmcloud ce fleet worker get --name WORKER_NAME --fleet-id FLEET_ID [--output OUTPUT] [--quiet]
指令選項
--fleet-id,--fid- 必要。 該工作程式所屬 Fleet 的 ID。 此欄位為必填項目。
--name,-n,--worker-name- 必要。 無伺服器 Fleet 工作者的名稱。 此欄位為必填項目。
--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
列出無伺服器 Fleet 中的所有工作程式。
ibmcloud ce fleet worker list --fleet-id FLEET_ID [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
指令選項
--fleet-id,--fid,--id- 必要。 該工作程式所屬 Fleet 的 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
列出無伺服器 Fleet 受支援的工作程式設定檔。
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。 請參閱 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-
使用下列其中一種方式,從儲存於此 configmap 的 key-value 對中設定環境變數。
- 若要為名為
configmapName的 configmap 中的所有按鍵新增環境變數,請使用值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的 configmap 中為單一關鍵key1新增環境變數,請使用configmapName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,若要為名為configmapName的 configmap 中的單一鍵key1新增名為myKey的環境變數,請使用值configmapName:myKey=key1。
此值為可選項。
--env-sec,--env-from-secret- 使用下列其中一種方式,從儲存於秘密中的鍵值對設定環境變數。
- 若要為命名為
secretName的秘密中的所有金鑰新增環境變數,請使用secretName。 您可以在引用秘密時指定前綴來修改環境變數名稱。 若要指定前綴,請使用PREFIX=SECRET_NAME。 每個結果環境變數的格式為<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,若要將密碼secretName中所有變數名稱的前綴設定為CUSTOM_,請使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,環境變數名稱就是CUSTOM_KEY_A。 - 若要為個別金鑰新增環境變數,請使用格式
NAME:KEY_A,KEY_B. 例如,若要在名稱為secretName的秘密中為單一金鑰key1新增環境變數,請使用secretName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,要在一個名為secretName的秘密中為單一金鑰key1新增一個名為myKey的環境變數,請使用secretName:myKey=key1的值。
此值為可選項。
--force,-f- 不驗證指定的 configmap 和 secret 參照是否存在。 此值為可選項。 預設值為
false。
- 若要為名為
--inline-code-
請指定包含該函式原始碼之檔案的路徑。 程式碼是與函式內嵌在一起的。 此值為可選項。
--main,--fn-main-
在提供的原始碼中指定 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-
在呼叫完成之後,實例處於作用中狀態的時間量(以秒為單位)。 此選項可以減少冷啟動時間。 如需詳細資訊,請參閱 Can I keep my function instance alive longer?。 此值為可選項。 預設值為
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-22
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-22 (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 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-
清除來源儲存庫中要取回的確定、標籤或分支。 只有當您的函式目前有關聯的建立時,才允許使用 commit clear 選項。 此值為可選項。 預設值為
false。 --build-context-dir,--context-dir,--bcdr,--cdr-
儲存庫中包含函數原始碼的目錄。 只有設定
--build-source選項時,才允許使用此選項。 此值為可選項。 --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo-
包含用於存取私有儲存庫之憑證的 SSH 密鑰名稱,該儲存庫內含用於建置您的映像檔的原始碼。 此值為可選項。
--build-git-repo-secret-clear,--git-repo-secret-clear,--bgrsc,--grsc-
清除 SSH 密鑰。 只有當您的函式目前有關聯的建立時,才允許使用此選項。 此值為可選項。 預設值為
false。 --build-source,--source,--bsrc,--src-
Git 儲存庫的 URL 或包含您原始碼的本機原始碼路徑;例如
https://github.com/IBM/CodeEngine或.。 此值為可選項。 --build-timeout,--bto-
在建立成功或失敗之前所能經過的時間,以秒為單位。 此值為可選項。 預設值為
600。 --code-bundle,--cb-
此功能要使用的
code-bundle影像名稱。 當指定build-source時,此值即為建置推送所產生之輸出影像的路徑。 若未指定build-source,此值即為現有程式碼封裝映像檔的路徑。 格式為REGISTRY/NAMESPACE/REPOSITORY:TAG,其中TAG為可選項目。 若未指定TAG,預設值為latest。 此值為可選項。 --code-bundle-secret,--cs,--cbs-
用來向專用登錄進行鑑別的登錄密鑰名稱。 您可以透過執行
registry create指令來新增註冊密碼。 此值為可選項。 --cpu-
為函數實例設定的 CPU 數量。 有關有效值,請參閱 支援的記憶體和 CPU 組合。 此值為可選項。 預設值為
1。 --env,-e-
在函數中設定環境變數。 必須採用
NAME=VALUE格式。 此動作可新增環境變數或覆寫現有的環境變數。 每個--env選項指定一個環境變數;例如,--env envA=A --env envB=B。 此值為可選項。 --env-cm,--env-from-configmap-
使用下列其中一種方式,從儲存於此 configmap 的 key-value 對中設定環境變數:
- 若要為名為
configmapName的 configmap 中的所有按鍵新增環境變數,請使用值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的 configmap 中為單一關鍵key1新增環境變數,請使用configmapName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,若要為名為configmapName的 configmap 中的單一鍵key1新增名為myKey的環境變數,請使用值configmapName:myKey=key1。
此值為可選項。
--env-from-configmap-rm,--env-cm-rm- 使用 configmap 名稱,移除對完整 configmap 的環境變數參照。 若要移除對 configmaps 的個別關鍵參照,請使用
--env-rm選項。 此選項可以指定多次。 此值為可選項。
- 若要為名為
--env-sec,--env-from-secret-
使用下列其中一種方式,從儲存於秘密中的鍵值對設定環境變數:
- 若要為命名為
secretName的秘密中的所有金鑰新增環境變數,請使用secretName。 您可以在引用秘密時指定前綴來修改環境變數名稱。 若要指定前綴,請使用PREFIX=SECRET_NAME。 每個結果環境變數的格式為<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,若要將密碼secretName中所有變數名稱的前綴設定為CUSTOM_,請使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,環境變數名稱就是CUSTOM_KEY_A。 - 若要為個別金鑰新增環境變數,請使用格式
NAME:KEY_A,KEY_B. 例如,若要在名稱為secretName的秘密中為單一金鑰key1新增環境變數,請使用secretName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,要在一個名為secretName的秘密中為單一金鑰key1新增一個名為myKey的環境變數,請使用secretName:myKey=key1的值。
此值為可選項。
--env-from-secret-rm,--env-sec-rm- 使用秘密名稱,移除對完整秘密的環境變數參照。 若要移除秘密的個別金鑰參照,請使用
--env-rm選項。 此選項可以指定多次。 此值為可選項。
- 若要為命名為
--env-rm-
移除對 configmap 或 secret 中鍵值對的 key 的環境變數參照。 若要移除個別的關鍵參照和字面值,請指定關鍵的名稱。 此選項可以指定多次。 此值為可選項。
--force,-f-
不驗證指定的 configmap 和 secret 參照是否存在。 Configmap 引用是使用
--env-from-configmap或--mount-configmap選項指定的。 秘密參照使用--env-from-secret、--mount-secret或--registry-secret選項指定。 此值為可選項。 預設值為false。 --inline-code-
指定包含函數之原始碼的檔案路徑。 程式碼是與函式內嵌在一起的。 此值為可選項。
--main,--fn-main-
在提供的原始碼中指定 main 函數的名稱。 當名稱不是
main時,需要使用此選項。 此值為可選項。 預設值為main。 --maxexecutiontime,--met-
此函式完成執行所需的最大執行時間(以秒為單位)。 此值為可選項。 預設值為
60。 --memory,-m-
為該函式設定的記憶體容量。 若要表示兆位元組,請使用
M;若要表示吉位元組,請使用G。 有關有效值,請參閱 支援的記憶體和 CPU 組合。 此值為可選項。 預設值為4G。 --no-wait,--nw-
提交建立執行,不要等待此建立執行完成。 如果指定
--no-wait選項,則會開始提交建立執行,而不會等待。 使用buildrun get指令檢查建立執行狀態。 此值為可選項。 預設值為false。 --output,-o-
指定指令輸出的格式。 有效值為
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 輸出元素的路徑。 此值為可選項。 --quiet,-q-
指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。 --rebuild-
從原始檔重新建立映像檔。 只有當您的函式目前有關聯的建立時,才允許使用重建選項。 此值為可選項。 預設值為
false。 --runtime,-r-
函式要使用的執行時間。 若要尋找此區域的支援執行時間,請執行
ibmcloud ce function runtimes。 請參閱 Runtimes。 此值為可選項。 --scale-down-delay,--sdd-
在呼叫完成之後,實例處於作用中狀態的時間量(以秒為單位)。 此選項可以減少冷啟動時間。 如需詳細資訊,請參閱 Can I keep my function instance alive longer?。 此值為可選項。 預設值為
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-22 --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-
指定用於執行工作的實例數。 當您使用此選項時,系統會將其轉換為陣列索引。 舉例來說,若您指定
instances(網址為5),系統會將其轉換為array-indexes(網址為0 - 4)。 只有在未指定--array-indexes選項的情況下,才可指定此選項。 此值為可選項。 預設值為1。 --build-commit,--commit,--bcm,--cm,--revision-
來源儲存庫中要取回的確定、標籤或分支。 只有在
--build-source選項設定為 Git 倉庫的 URL 時,才允許使用 build commit 選項。 此值為可選項。 --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-
使用下列其中一種方式,從儲存於此 configmap 的 key-value 對中設定環境變數:
- 若要為名為
configmapName的 configmap 中的所有按鍵新增環境變數,請使用值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的 configmap 中為單一關鍵key1新增環境變數,請使用configmapName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,若要為名為configmapName的 configmap 中的單一鍵key1新增名為myKey的環境變數,請使用值configmapName:myKey=key1。
此值為可選項。
--env-sec,--env-from-secret- 使用下列其中一種方式,從儲存於秘密中的鍵值對設定環境變數:
- 若要為命名為
secretName的秘密中的所有金鑰新增環境變數,請使用secretName。 您可以在引用秘密時指定前綴來修改環境變數名稱。 若要指定前綴,請使用PREFIX=SECRET_NAME。 每個結果環境變數的格式為<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,若要將密碼secretName中所有變數名稱的前綴設定為CUSTOM_,請使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,環境變數名稱就是CUSTOM_KEY_A。 - 若要為個別金鑰新增環境變數,請使用格式
NAME:KEY_A,KEY_B. 例如,若要在名稱為secretName的秘密中為單一金鑰key1新增環境變數,請使用secretName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,要在一個名為secretName的秘密中為單一金鑰key1新增一個名為myKey的環境變數,請使用secretName:myKey=key1的值。
此值為可選項。
--ephemeral-storage,--es- 應為該工作執行程序設定的暫存儲存空間大小。 若要表示兆位元組,請使用
M;若要表示吉位元組,請使用G。 此值為可選項。 預設值為400M。
- 若要為名為
--force,-f-
不驗證指定的 configmap 和 secret 參照是否存在。 Configmap 引用是使用
--env-from-configmap選項指定的。 秘密參照使用--env-from-secret或--registry-secret選項指定。 此值為可選項。 預設值為false。 --image,-i-
用於執行工作的影像名稱。 格式為
REGISTRY/NAMESPACE/REPOSITORY:TAG,其中REGISTRY和TAG皆為可選項目。 若未指定REGISTRY,預設值為docker.io。 若未指定TAG,預設值為latest。 若未指定--build-source選項,則必須指定image選項。 此值為可選項。 --maxexecutiontime,--met-
工作執行的執行時間上限(以秒為單位)。 只有當
mode的值為task`` 時,才可指定此選項。 此值為可選項。 預設值為7200。 --memory,-m-
為執行工作設定的記憶體數量。 若要表示兆位元組,請使用
M;若要表示吉位元組,請使用G。 有關有效值,請參閱 支援的記憶體和 CPU 組合。 此值為可選項。 預設值為4G。 --mode-
工作執行的模式。 有效值為
task和daemon。 在task模式下,maxexecutiontime和retrylimit選項將生效。 在daemon模式下,由於沒有超時設定,且失敗的執行個體會無限期地重新啟動,因此不允許使用--maxexecutiontime和--retrylimit選項。 此值為可選項。 預設值為task。 --mount-configmap,--mount-cm-
透過提供掛載目錄和 configmap 的名稱,將 configmap 的內容新增至執行工作的檔案系統,格式為
MOUNT_DIRECTORY=CONFIGMAP_NAME. 每個掛載的 configmap 必須使用唯一的掛載目錄。 對於 configmap 中的每個 key-value 對,都會新增一個檔案到指定的 mount 目錄,其中檔案名稱是 key,檔案內容是 key-value 對的值。 每個--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-
在工作標示為失敗之前,重新執行工作實例的次數。 當作業的陣列索引出現非零的退出代碼時,該作業就會重新執行。 只有當
mode的值為task`` 時,才可指定此選項。 此值為可選項。 預設值為3。 --service-account,--sa-
服務帳戶的名稱。 服務帳戶提供在實例中執行之程序的身分。 對於內建服務帳戶,您可以使用縮寫名稱
manager,none,reader,以及writer。 您也可以使用以Kubernetes Config Context為前綴的全名,這可以使用project current指令來確定。 此值為可選項。 --trusted-profiles-enabled,--trusted,--tpe-
啟用工作執行時裝載計算資源記號。 此值為可選項。 預設值為
false。 --wait,-w-
等待建置執行完成。 如果指定
--wait選項,建立執行會等待--wait-timeout選項設定的最長時間(以秒為單位)完成建立執行。 如果建立執行未在指定的--wait-timeout期間內完成,建立執行會失敗。 只有設定了--build-source選項,才允許使用 wait 選項。 此值為可選項。 預設值為true。 --wait-timeout,--wto-
等待建置執行完成的時間長度(以秒為單位)。 如果指定了
--wait選項,則必須使用此值。 如果指定了--no-wait選項,此值會被忽略。 只有設定了--build-source選項,才允許使用 wait-timeout 選項。 預設值為600。
範例
下面的示例使用容器映像 icr.io/codeengine/firstjob,並將 2G MB 作為記憶體和 1 個 CPU 指派給容器。 有關選擇有效記憶體和 CPU 值的詳細資訊,請參閱 支援的記憶體和 CPU 組合。
ibmcloud ce job create --image icr.io/codeengine/firstjob --name hellojob --memory 2G --cpu 1
輸出範例
Creating job 'hellojob'...
OK
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-
指定用於執行工作的實例數。 當您使用此選項時,系統會將其轉換為陣列索引。 舉例來說,若您指定
instances(網址為5),系統會將其轉換為array-indexes(網址為0 - 4)。 只有在未指定--array-indexes選項的情況下,才可指定此選項。 此值為可選項。 預設值為0。 --build-clear,--bc-
從此工作中移除建置的關聯。 只有當您的作業目前有關聯的建立時,才允許使用建立清除選項。 此值為可選項。 預設值為
false。 --build-commit,--commit,--bcm,--cm,--revision-
來源儲存庫中要取回的確定、標籤或分支。 只有當
--build-source選項在此job update指令上設定為 Git 儲存庫的 URL,或您的工作目前有來自 Git 儲存庫來源的關聯建立,才允許使用 build commit 選項。 此值為可選項。 --build-commit-clear,--commit-clear,--bcmc,--cmc-
清除來源儲存庫中要取回的確定、標籤或分支。 只有當您的工作目前有關聯的建立時,才允許使用 commit clear 選項。 此值為可選項。 預設值為
false。 --build-context-dir,--context-dir,--bcdr,--cdr-
套件庫中包含 buildpacks 檔案或 Dockerfile 的目錄。 只有在
job update指令上設定了--build-source選項,或您的工作目前有相關的建立,才允許使用建立上下文目錄選項。 此值為可選項。 --build-dockerfile,--dockerfile,--bdf,--df-
Dockerfile 的路徑。 僅在名稱不是
Dockerfile時指定此選項。 如果--build-source選項是在這個job update指令上設定的,或是你的工作目前有一個相關的 build,那麼 build 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-
使用下列其中一種方式,從儲存於此 configmap 的 key-value 對中設定環境變數:
- 若要為名為
configmapName的 configmap 中的所有按鍵新增環境變數,請使用值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的 configmap 中為單一關鍵key1新增環境變數,請使用configmapName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,若要為名為configmapName的 configmap 中的單一鍵key1新增名為myKey的環境變數,請使用值configmapName:myKey=key1。
此值為可選項。
--env-from-configmap-rm,--env-cm-rm- 使用 configmap 名稱,移除對完整 configmap 的環境變數參照。 若要移除對 configmaps 的個別關鍵參照,請使用
--env-rm選項。 此選項可以指定多次。 此值為可選項。
- 若要為名為
--env-sec,--env-from-secret-
使用下列其中一種方式,從儲存於秘密中的鍵值對設定環境變數:
- 若要為命名為
secretName的秘密中的所有金鑰新增環境變數,請使用secretName。 您可以在引用秘密時指定前綴來修改環境變數名稱。 若要指定前綴,請使用PREFIX=SECRET_NAME。 每個結果環境變數的格式為<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,若要將密碼secretName中所有變數名稱的前綴設定為CUSTOM_,請使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,環境變數名稱就是CUSTOM_KEY_A。 - 若要為個別金鑰新增環境變數,請使用格式
NAME:KEY_A,KEY_B. 例如,若要在名稱為secretName的秘密中為單一金鑰key1新增環境變數,請使用secretName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,要在一個名為secretName的秘密中為單一金鑰key1新增一個名為myKey的環境變數,請使用secretName:myKey=key1的值。
此值為可選項。
--env-from-secret-rm,--env-sec-rm- 使用秘密名稱,移除對完整秘密的環境變數參照。 若要移除秘密的個別金鑰參照,請使用
--env-rm選項。 此選項可以指定多次。 此值為可選項。
- 若要為命名為
--env-rm-
移除對 configmap 或 secret 中鍵值對的 key 的環境變數參照。 若要移除個別的關鍵參照和字面值,請指定關鍵的名稱。 此選項可以指定多次。 此值為可選項。
--ephemeral-storage,--es-
應為該工作執行程序設定的暫存儲存空間大小。 若要表示兆位元組,請使用
M;若要表示吉位元組,請使用G。 此值為可選項。 --force,-f-
不驗證指定的 configmap 和 secret 參照是否存在。 Configmap 引用是使用
--env-from-configmap選項指定的。 秘密參照使用--env-from-secret或--registry-secret選項指定。 此值為可選項。 預設值為false。 --image,-i-
用於執行工作的影像名稱。 格式為
REGISTRY/NAMESPACE/REPOSITORY:TAG,其中REGISTRY和TAG皆為可選項目。 若未指定REGISTRY,預設值為docker.io。 若未指定TAG,預設值為latest。 此值為可選項。 --maxexecutiontime,--met-
工作執行的執行時間上限(以秒為單位)。 只有當
mode的值為task`` 時,才可指定此選項。 此值為可選項。 預設值為7200。 --memory,-m-
為執行工作設定的記憶體數量。 若要表示兆位元組,請使用
M;若要表示吉位元組,請使用G。 有關有效值,請參閱 支援的記憶體和 CPU 組合。 此值為可選項。 --mode-
工作執行的模式。 有效值為
task和daemon。 在task模式下,maxexecutiontime和retrylimit選項將生效。 在daemon模式下,由於沒有超時設定,且失敗的執行個體會無限期地重新啟動,因此不允許使用--maxexecutiontime和--retrylimit選項。 此值為可選項。 --mount-configmap,--mount-cm-
透過提供掛載目錄和 configmap 的名稱,將 configmap 的內容新增至執行工作的檔案系統,格式為
MOUNT_DIRECTORY=CONFIGMAP_NAME. 每個掛載的 configmap 必須使用唯一的掛載目錄。 對於 configmap 中的每個 key-value 對,都會新增一個檔案到指定的 mount 目錄,其中檔案名稱是 key,檔案內容是 key-value 對的值。 每個--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-
從執行工作的檔案系統中移除 configmap 或 secret 的內容,方法是指定掛載 configmap 或 secret 的目錄。 每個
--mount-rm選項指定一個掛載目錄;例如,--mount-rm /etc/configmap-a --mount-rm /etc/secret-b。 此值為可選項。 --mount-secret,--mount-sec-
透過提供掛載目錄和秘密名稱,將秘密內容加入執行工作的檔案系統,格式為
MOUNT_DIRECTORY=SECRET_NAME. 每個掛載的秘密必須使用唯一的掛載目錄。 對於秘密中的每個鍵值對,都會在指定的掛載目錄中加入一個檔案,其中檔案名稱是鍵,檔案內容是鍵值對的值。 每個--mount-secret選項指定一個掛載設定;例如,--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b。 此值為可選項。 --no-wait,--nw-
請不必等待建置執行完成。 如果指定
--no-wait選項,則會開始執行建立,而不會等待。 使用buildrun get指令檢查建立執行狀態。 只有在此job update指令上設定了--build-source選項,或您的工作目前有相關的建立時,才允許使用 no-wait 選項。 此值為可選項。 預設值為false。 --output,-o-
指定指令輸出的格式。 有效值為
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 輸出元素的路徑。 此值為可選項。 --quiet,-q-
指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。 --rebuild-
從來源重建映像檔。 如果您的作業目前有相關的建立,則允許使用重建選項。 此值為可選項。 預設值為
false。 --registry-secret,--rs-
登錄密鑰的名稱。 當您下載容器映像檔時,會使用登錄密鑰向專用登錄進行鑑別。 此值為可選項。
--registry-secret-clear,--rsc-
清除登錄密鑰。 此值為可選項。 預設值為
false。 --retrylimit,-r-
在工作標示為失敗之前,重新執行工作實例的次數。 當作業的陣列索引出現非零的退出代碼時,該作業就會重新執行。 只有當
mode的值為task`` 時,才可指定此選項。 此值為可選項。 預設值為3。 --service-account,--sa-
服務帳戶的名稱。 服務帳戶提供在實例中執行之程序的身分。 對於內建服務帳戶,您可以使用縮寫名稱
manager,none,reader,以及writer。 您也可以使用以Kubernetes Config Context為前綴的全名,這可以使用project current指令來確定。 此值為可選項。 --service-account-clear,--sac-
清除服務帳戶。 此值為可選項。 預設值為
false。 --trusted-profiles-enabled,--trusted,--tpe-
啟用工作執行時裝載計算資源記號。 此值為可選項。 預設值為
false。 --wait,-w-
等待建置執行完成。 如果指定
--wait選項,建立執行會等待--wait-timeout選項設定的最長時間(以秒為單位)完成建立執行。 如果建立執行未在指定的--wait-timeout期間內完成,建立執行會失敗。 只有在此job update指令上設定了--build-source選項,或您的工作目前有相關的建立時,才允許使用 wait 選項。 此值為可選項。 預設值為true。 --wait-timeout,--wto-
等待建置執行完成的時間長度(以秒為單位)。 如果指定了
--wait選項,則必須使用此值。 如果指定了--no-wait選項,此值會被忽略。 如果在此job update指令上設定了--build-source選項,或您的工作目前有相關的建立,則允許使用 wait-timeout 選項。 預設值為600。
範例
ibmcloud ce job update --name hellojob --cpu 2
輸出範例
Updating job 'hellojob'...
OK
Jobrun 指令
一個作業會並行執行一個或多個可執行程式碼的實體。 與處理 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-
指定用於此工作執行的實例數。 當您使用此選項時,系統會將其轉換為陣列索引。 舉例來說,若您指定
instances(網址為5),系統會將其轉換為array-indexes(網址為0 - 4)。 只有在未指定--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-
使用下列其中一種方式,從儲存於此 configmap 的 key-value 對中設定環境變數:
- 若要為名為
configmapName的 configmap 中的所有按鍵新增環境變數,請使用值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的 configmap 中為單一關鍵key1新增環境變數,請使用configmapName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,若要為名為configmapName的 configmap 中的單一鍵key1新增名為myKey的環境變數,請使用值configmapName:myKey=key1。
此值為可選項。
--env-from-configmap-rm,--env-cm-rm- 使用 configmap 名稱,移除對完整 configmap 的環境變數參照。 若要移除對 configmaps 的個別關鍵參照,請使用
--env-rm選項。 此值為可選項。
- 若要為名為
--env-sec,--env-from-secret-
使用下列其中一種方式,從儲存於秘密中的鍵值對設定環境變數:
- 若要為命名為
secretName的秘密中的所有金鑰新增環境變數,請使用secretName。 您可以在引用秘密時指定前綴來修改環境變數名稱。 若要指定前綴,請使用PREFIX=SECRET_NAME。 每個結果環境變數的格式為<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,若要將密碼secretName中所有變數名稱的前綴設定為CUSTOM_,請使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,環境變數名稱就是CUSTOM_KEY_A。 - 若要為個別金鑰新增環境變數,請使用格式
NAME:KEY_A,KEY_B. 例如,若要在名稱為secretName的秘密中為單一金鑰key1新增環境變數,請使用secretName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,要在一個名為secretName的秘密中為單一金鑰key1新增一個名為myKey的環境變數,請使用secretName:myKey=key1的值。
此值為可選項。
--env-from-secret-rm,--env-sec-rm- 使用秘密名稱,移除對完整秘密的環境變數參照。 若要移除秘密的個別金鑰參照,請使用
--env-rm選項。 此選項可以指定多次。 此值為可選項。
- 若要為命名為
--env-rm-
移除對 configmap 或 secret 中鍵值對的 key 的環境變數參照。 若要移除個別的關鍵參照和字面值,請指定關鍵的名稱。 此選項可以指定多次。 此值為可選項。
--ephemeral-storage,--es-
本次作業執行的暫存空間數量。 若要表示兆位元組,請使用
M;若要表示吉位元組,請使用G。 此值為可選項。 --force,-f-
不驗證指定的 configmap 和 secret 參照是否存在。 Configmap 引用是使用
--env-from-configmap選項指定的。 秘密參照使用--env-from-secret選項指定。 此值為可選項。 預設值為false。 --maxexecutiontime,--met-
此工作執行的執行時間上限(以秒為單位)。 只有當
mode的值為task`` 時,才可指定此選項。 此值為可選項。 預設值為7200。 --memory,-m-
分配給此工作執行的記憶體數量。 若要表示兆位元組,請使用
M;若要表示吉位元組,請使用G。 有關有效值,請參閱 支援的記憶體和 CPU 組合。 此值為可選項。 --mode-
工作執行的模式。 有效值為
task和daemon。 在task模式下,maxexecutiontime和retrylimit選項將生效。 在daemon模式下,由於沒有超時設定,且失敗的執行個體會無限期地重新啟動,因此不允許使用maxexecutiontime和retrylimit選項。 此值為可選項。 --mount-configmap,--mount-cm-
透過提供掛載目錄和 configmap 的名稱,將 configmap 的內容新增至此工作執行的檔案系統,格式為
MOUNT_DIRECTORY=CONFIGMAP_NAME. 每個掛載的 configmap 必須使用唯一的掛載目錄。 對於 configmap 中的每個 key-value 對,都會新增一個檔案到指定的 mount 目錄,其中檔案名稱是 key,檔案內容是 key-value 對的值。 每個--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-
從此工作執行的檔案系統中移除 configmap 或 secret 的內容,方法是指定掛載 configmap 或 secret 的目錄。 每個
--mount-rm選項指定一個掛載目錄;例如,--mount-rm /etc/configmap-a --mount-rm /etc/secret-b。 此值為可選項。 --mount-secret,--mount-sec-
透過提供掛載目錄和秘密名稱,將秘密的內容加入此工作執行的檔案系統,格式為
MOUNT_DIRECTORY=SECRET_NAME. 每個掛載的秘密必須使用唯一的掛載目錄。 對於秘密中的每個鍵值對,都會在指定的掛載目錄中加入一個檔案,其中檔案名稱是鍵,檔案內容是鍵值對的值。 每個--mount-secret選項指定一個掛載設定;例如,--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b。 此值為可選項。 -n,--name-
此工作執行的名稱。 如果引用的作業沒有相關的作業組態,則需要此值。 請使用專案內唯一的名稱。
- 名稱必須以小寫的英數字元開頭,並以小寫的英數字元結尾。
- 名稱必須為 53 個字元或以下,並可包含小寫字母、數字和連字符號 (-)。
此值為可選項。
--no-wait,--nw- 重新提交作业运行,不要等待此作业运行的实例完成。 如果指定
--no-wait選項,作業執行重新提交就會開始,不會等待。 使用jobrun get指令檢查工作執行狀態。 此值為可選項。 預設值為true。
--output,-o-
指定指令輸出的格式。 有效值為
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 使用jsonpath指定 JSON 輸出元素的路徑。 此值為可選項。 --quiet,-q-
指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。 --retrylimit,-r-
在工作執行標示為失敗之前,重新執行此工作執行實例的次數。 當作業執行的陣列索引產生非零的退出代碼時,會重新執行。 只有當
mode的值為task`` 時,才可指定此選項。 此值為可選項。 預設值為3。 --service-account,--sa-
服務帳戶的名稱。 服務帳戶提供在實例中執行之程序的身分。 對於內建服務帳戶,您可以使用縮寫名稱
manager,none,reader,以及writer。 您也可以使用以Kubernetes Config Context為前綴的全名,這可以使用project current指令來確定。 此值為可選項。 --service-account-clear,--sac-
清除服務帳戶。 此值為可選項。 預設值為
false。 --trusted-profiles-enabled,--trusted,--tpe-
啟用此工作執行實例裝載計算資源記號。 此值為可選項。 預設值為
false。 --wait,-w-
重新提交工作執行,並等待此工作執行的實例完成。 如果指定
--wait選項,工作執行重新提交會等待--wait-timeout選項設定的最長時間(以秒為單位),等待工作執行完成。 如果工作執行未在指定的--wait-timeout期間內完成,則工作執行重新提交失敗。 此值為可選項。 預設值為false。 --wait-timeout,--wto-
等待此工作執行實例完成所需的時間(以秒為單位)。 如果指定了
--wait選項,則必須使用此值。 如果指定了--no-wait選項,此值會被忽略。 預設值為600。
範例
下面的示例重新运行了 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-
指定用於此工作執行的實例數。 當您使用此選項時,系統會將其轉換為陣列索引。 舉例來說,若您指定
instances(網址為5),系統會將其轉換為array-indexes(網址為0 - 4)。 只有在未指定--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-
使用下列其中一種方式,從儲存於此 configmap 的 key-value 對中設定環境變數:
- 若要為名為
configmapName的 configmap 中的所有按鍵新增環境變數,請使用值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的 configmap 中為單一關鍵key1新增環境變數,請使用configmapName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,若要為名為configmapName的 configmap 中的單一鍵key1新增名為myKey的環境變數,請使用值configmapName:myKey=key1。
此值為可選項。
--env-sec,--env-from-secret- 使用下列其中一種方式,從儲存於秘密中的鍵值對設定環境變數:
- 若要為命名為
secretName的秘密中的所有金鑰新增環境變數,請使用secretName。 您可以在引用秘密時指定前綴來修改環境變數名稱。 若要指定前綴,請使用PREFIX=SECRET_NAME。 每個結果環境變數的格式為<PREFIX><NAME_OF_KEY_IN_SECRET>. 例如,若要將密碼secretName中所有變數名稱的前綴設定為CUSTOM_,請使用值CUSTOM_=secretName。 如果密文secretName包含 KEY_A,環境變數名稱就是CUSTOM_KEY_A。 - 若要為個別金鑰新增環境變數,請使用格式
NAME:KEY_A,KEY_B. 例如,若要在名稱為secretName的秘密中為單一金鑰key1新增環境變數,請使用secretName:key1。 若要為引用的按鍵指定不同的名稱,請使用格式NAME:NEW_NAME=KEY_A。 例如,要在一個名為secretName的秘密中為單一金鑰key1新增一個名為myKey的環境變數,請使用secretName:myKey=key1的值。
此值為可選項。
--ephemeral-storage,--es- 本次作業執行的暫存空間數量。 若要表示兆位元組,請使用
M;若要表示吉位元組,請使用G。 此值為可選項。 預設值為400M。
- 若要為名為
--force,-f-
不驗證指定的 configmap 和 secret 參照是否存在。 Configmap 引用是使用
--env-from-configmap選項指定的。 秘密參照使用--env-from-secret或--registry-secret選項指定。 此值為可選項。 預設值為false。 --image,-i-
用於此工作執行的影像名稱。 格式為
REGISTRY/NAMESPACE/REPOSITORY:TAG,其中REGISTRY和TAG皆為可選項目。 若未指定REGISTRY,預設值為docker.io。 若未指定TAG,預設值為latest。 如果未指定--job選項,則需要--name和--image值。 此值為可選項。 --job,-j-
工作配置的名稱。 使用
job list指令檢視工作組態。 如果指定--job值,則可選擇指定--name值。 如果未指定--job值,則必須指定--name和--image值。 此值為可選項。 --maxexecutiontime,--met-
此工作執行的執行時間上限(以秒為單位)。 只有當
mode的值為task`` 時,才可指定此選項。 此值為可選項。 預設值為7200。 --memory,-m-
分配給此工作執行的記憶體數量。 若要表示兆位元組,請使用
M;若要表示吉位元組,請使用G。 有關有效值,請參閱 支援的記憶體和 CPU 組合。 此值為可選項。 預設值為4G。 --mode-
工作執行的模式。 有效值為
task和daemon。 在task模式下,maxexecutiontime和retrylimit選項將生效。 在daemon模式下,由於沒有超時設定,且失敗的執行個體會無限期地重新啟動,因此不允許使用maxexecutiontime和retrylimit選項。 此值為可選項。 預設值為task。 --mount-configmap,--mount-cm-
透過提供掛載目錄和 configmap 的名稱,將 configmap 的內容新增至此工作執行的檔案系統,格式為
MOUNT_DIRECTORY=CONFIGMAP_NAME. 每個掛載的 configmap 必須使用唯一的掛載目錄。 對於 configmap 中的每個 key-value 對,都會新增一個檔案到指定的 mount 目錄,其中檔案名稱是 key,檔案內容是 key-value 對的值。 每個--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-
在工作執行標示為失敗之前,重新執行此工作執行實例的次數。 當作業執行的陣列索引產生非零的退出代碼時,會重新執行。 只有當
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
Persistentdatastore 指令
管理持續資料儲存庫。
ibmcloud ce persistentdatastore create
建立一個持續資料儲存庫。
ibmcloud ce persistentdatastore create --name NAME --cos-access-secret SECRET_NAME --cos-bucket-name BUCKET_NAME [--cos-bucket-location BUCKET_LOCATION] [--quiet]
指令選項
--cos-access-secret,--cos-sec- 必要。 包含存取 COS 實例認證的密鑰名稱。 此欄位為必填項目。
--cos-bucket-name,--cos-bucket- 必要。 COS 儲存區的名稱。 此欄位為必填項目。
--name,-n- 必要。 持續資料儲存庫的名稱。 請使用專案內唯一的名稱。 此欄位為必填項目。
--cos-bucket-location,--cos-loc- COS 儲存區的位置。 此值為可選項。
--quiet,-q- 指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。
範例
ibmcloud ce persistentdatastore create --name my-pds-2 --cos-bucket-name my-test-bucket-2 --cos-access-secret my-hmac-secret-2
輸出範例
Successfully created persistent data store named 'my-pds-2'.
OK
ibmcloud ce persistentdatastore delete
刪除一個持續資料儲存庫。
ibmcloud ce persistentdatastore delete --name PERSISTENT_DATA_STORE_NAME [--force] [--ignore-not-found] [--quiet]
指令選項
--name,-n- 必要。 持續資料儲存庫的名稱。 此欄位為必填項目。
--force,-f- 強制刪除,而不進行確認。 此值為可選項。 預設值為
false。 --ignore-not-found,--inf- 如果未找到,請勿失敗。 此值為可選項。 預設值為
false。 --quiet,-q- 指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。
範例
ibmcloud ce persistentdatastore delete --name my-pds-3 -f
輸出範例
Deleting persistent data store 'my-pds-3'...
OK
ibmcloud ce persistentdatastore get
顯示持續資料儲存庫的詳細資料。
ibmcloud ce persistentdatastore get --name NAME [--output OUTPUT] [--quiet]
指令選項
--name,-n- 必要。 持續資料儲存庫的名稱。 此欄位為必填項目。
--output,-o- 輸出格式。 有效值為
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 此值為可選項。 --quiet,-q- 指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。
範例
ibmcloud ce persistentdatastore get --name my-pds-2
輸出範例
Getting persistent data store 'my-pds-2'...
OK
Name: my-pds-2
ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Type: object_storage
Created: Fri, 11 Jul 2025 13:52:30 +0200
Age: 103s
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Data:
COS bucket: my-test-bucket-2
Access secret: my-hmac-secret-2
Bucket region: eu-de
ibmcloud ce persistentdatastore list
列出專案中的所有持續資料儲存庫。
ibmcloud ce persistentdatastore list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
指令選項
--output,-o- 輸出格式。 有效值為
json,yaml,jsonpath=JSONPATH_EXPRESSION,和jsonpath-as-json=JSONPATH_EXPRESSION。 此值為可選項。 --quiet,-q- 指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。 --sort-by,-s- 指定清單排序的直欄。 有效值為
name和age。 此值為可選項。 預設值為name。
範例
此指令會列出專案中的所有持久性資料儲存。
ibmcloud ce persistentdatastore list
輸出範例
Listing persistent data stores...
OK
Name COS bucket Access secret Bucket region Age
my-pds-1 my-test-bucket-1 my-hmac-secret-1 eu-gb 36d
my-pds-2 my-test-bucket-2 my-hmac-secret-2 eu-de 86s
my-pds-3 my-test-bucket-3 my-hmac-secret-3 us-south 6m30s
專案指令
使用 project 指令建立、列出、刪除及選取專案作為目前的上下文。
專案是由 Code Engine 中的各項實體(例如應用程式、函式、工作、機隊和建置)所組成的集合。 專案以 Kubernetes 命名空間為基礎。 您的專案名稱在 IBM Cloud® 資源群組、使用者帳戶和區域內必須是唯一的。 專案用於管理資源,並提供對其實體的存取權限。
一個專案提供以下功能:
- 實體名稱的專用命名空間。
- 專案資源的外部存取管理。
- 對後端服務、註冊機構及資料庫的外連存取進行管理。
- 一份針對傳輸層服務( 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- 用於此專案服務綁定之驗證的資源群組名稱。 會為此資源群組中的所有服務建立一個服務識別碼,並賦予其「
Operator」及「Manager」角色。 使用"*"指定此帳戶中的所有資源群組。 此值為可選項。 --binding-resource-group-id,--brgid- 用於鑑別此專案之服務連結的資源群組 ID。 會為此資源群組中的所有服務建立一個服務識別碼,並賦予其「
Operator」及「Manager」角色。 此值為可選項。 --binding-service-id,--bsid- 用於此專案中服務綁定之驗證的服務識別碼。 此服務 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 建立 Git 存取密碼,稱為 github,並使用位於 /<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
修訂指令
應用程式(或稱 app)會執行您的程式碼,為 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」機密之私密金鑰的檔案。 您必須提供檔案的路徑作為值。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秘密需要使用此選項。 此值為可選項。
基本認證密碼範例
基本 auth 秘密包含 username 和 password 金鑰,在您存取需要基本 HTTP 驗證的服務時使用。
若要查看建立基本 auth 秘密的 CLI 說明,請執行 ibmcloud ce secret create --format basic_auth。
下面的示例创建了一个名为 mysecret-basicauth 的基本 auth secret。 此密碼包含使用者名稱 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 命令創建秘密時,預設值是。
下面的範例建立了一個 generic secret,它的名稱是 mysecret-generic,這個 secret 的值是用 --from-literal 選項指定的 key-value 對。
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 檔案中的主機建立一個 SSH 密鑰,名稱為 mysecret-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 secret 的 CLI 說明,請執行 ibmcloud ce secret create --format tls。
以下範例建立一個 TLS secret,名稱為 mysecret-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」機密之私密金鑰的檔案。 您必須提供檔案的路徑作為值。 此值為可選項。 --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 secret。
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 輸出元素的路徑。 此值為可選項。 --path-
destination應用程式內轉發事件的路徑;例如,/events。 預設路徑是destination應用程式的根 URL。 只有當destination-type的值為app`` 時,才可指定此選項。 此值為可選項。 --prefix,-p-
IBM Cloud Object Storage 物件的前綴。 此值為可選項。
--quiet,-q-
指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。 --suffix,-s-
IBM Cloud Object Storage 物件的後綴。 指定後綴時,請考慮您的檔案類型。 此值為可選項。
--wait,-w-
建立 IBM Cloud Object Storage 事件訂閱,並等待訂閱就緒。 如果指定
--wait選項,訂閱建立會等待--wait-timeout選項設定的最長時間(以秒為單位),讓訂閱準備就緒。 如果訂閱未在指定的--wait-timeout期間內就緒,則 IBM Cloud Object Storage 事件訂閱建立失敗。 此值為可選項。 預設值為true。 --wait-timeout,--wto-
等待「IBM Cloud Object Storage」事件訂閱就緒所需的時間(以秒為單位)。 如果指定了
--wait選項,則必須使用此值。 如果指定了--no-wait選項,此值會被忽略。 預設值為15。
範例
IBM Cloud Object Storage 訂閱監聽 Object Storage 桶的變更。 下面的示例为名为 mybucket 的 bucket 创建了名为 mycosevent 的 COS 订阅,该 bucket 连接到名为 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 物件的後綴。 指定後綴時,請考慮您檔案的類型 (副檔名)。 此值為可選項。
範例
以下範例會更新 COS 訂閱 mycosevent,使其只監聽寫入事件。
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,--dt-
destination的類型。 有效值為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 輸出元素的路徑。 此值為可選項。 --path-
destination應用程式內轉發事件的路徑;例如,/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 分鐘將 cron 事件轉寄給名為 myjob 的工作。
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,--dt-
destination的類型。 有效值為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 輸出元素的路徑。 此值為可選項。 --path-
destination應用程式內轉發事件的路徑;例如,/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 來源訂閱,它每小時轉發一個 cron 事件給名為 myjob 的工作。
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,--dt-
destination的類型。 有效值為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」選項。 此值為可選項。 --path-
destination應用程式內轉發事件的路徑;例如,/events。 預設路徑是destination應用程式的根 URL。 只有當destination-type的值為app`` 時,才可指定此選項。 此值為可選項。 --quiet,-q-
指定此選項可減少指令的輸出。 此值為可選項。 預設值為
false。 --secret,-s-
用於對 Kafka 實例進行身份驗證的密鑰名稱,該密鑰包含
username和password兩組金鑰。 若指定了「--secret」選項,則不得同時指定「--username」或「--password」選項。 此值為可選項。 --username,-u-
用來鑑別 Kafka 實例的使用者名稱。 若您指定了「
--username」選項,則必須同時指定「--password」選項,且不得指定「--secret」選項。 此值為可選項。 預設值為token。 --wait,-w-
建立 Kafka 事件訂閱,並等待訂閱就緒。 如果指定
--wait選項,訂閱建立會等待--wait-timeout選項設定的最長時間(以秒為單位),讓訂閱準備就緒。 如果訂閱未在指定的--wait-timeout期間內就緒,則 Kafka 事件訂閱建立失敗。 此值為可選項。 預設值為true。 --wait-timeout,--wto-
等待「Kafka」事件訂閱就緒所需的時間(以秒為單位)。 如果指定了
--wait選項,則必須使用此值。 如果指定了--no-wait選項,此值會被忽略。 預設值為120。
範例
以下範例建立了 Kafka 事件訂閱,其名稱為 mykafkaevent,可將 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