CLI do IBM Cloud Code Engine
Execute estes comandos para gerenciar as entidades que compõem o IBM Cloud® Code Engine. Para obter mais informações sobre o Code Engine, consulte Introdução ao Code Engine.
Para executar os comandos do IBM Cloud Code Engine, use ibmcloud code-engine ou ibmcloud ce.
Pré-requisitos
-
Instale a CLI da IBM Cloud.
-
Instale a CLI do Code Engine executando o comando a seguir:
ibmcloud plugin install code-engine
Comandos do aplicativo
Um aplicativo ou app executa o seu código para entregar solicitações de HTTP. Além das solicitações de HTTP tradicionais, o IBM Cloud® Code Engine também suporta aplicativos que usam WebSockets como seu protocolo de comunicações. O número de instâncias em execução de um aplicativo é automaticamente aumentado ou reduzido (para zero) com base nas solicitações recebidas e nas suas configurações. Um app contém uma ou mais revisões. Uma revisão representa uma versão imutável das propriedades de configuração do app. Cada atualização de uma propriedade de configuração do app cria uma nova revisão do app.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos application.
Para obter mais informações sobre como trabalhar com apps, consulte Implementando aplicativos.
É possível usar application ou app em seus comandos application. Para ver a ajuda da CLI para os comandos application, execute ibmcloud ce app -h.
Para gerenciar revisões de aplicativo, consulte os comandos ibmcloud ce revision.
ibmcloud ce application bind
Ligar uma instância de serviço da IBM Cloud a um aplicativo.
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]
Opções de comando
--name,-n- O nome do aplicativo a ser ligado. Este valor é obrigatório.
--no-wait,--nw- Ligue a instância de serviço e não espere a ligação de serviços estar pronta. Se você especificar a opção
no-wait, a criação da ligação de serviços será iniciada e o comando sairá sem esperar a conclusão dela. Use o comandoapp getpara verificar o status de ligação do aplicativo. Este valor é opcional. O valor padrão éfalse. --prefix,-p- Um prefixo para variáveis de ambiente que são criadas para esta ligação de serviços. Deve conter apenas letras maiúsculas, números e sublinhados (_) e não pode iniciar com um número. Este valor é opcional.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --role,-r- O nome de uma função de serviço para a nova credencial de serviço que é criada para essa ligação de serviços. Os valores válidos incluem
Reader,Writer,Managerou uma atribuição específica de serviço. A opção é padronizada paraManagerou a primeira função fornecida pelo serviço seManagernão for suportado. Essa opção será ignorada se--service-credentialfor especificado. Este valor é opcional. --service-credential,--sc- O nome de uma credencial de serviço existente para usar para esta ligação de serviços. Se você não especificar uma credencial de instância de serviço, novas credenciais serão geradas durante a ação de ligação. Este valor é opcional.
--service-instance,--si- O nome de uma instância de serviço existente da IBM Cloud para ligar ao aplicativo. Este valor é opcional.
--service-instance-id,--siid- A GUID de uma instância de serviço do IBM Cloud existente para ligar ao aplicativo. Este valor é opcional.
--wait,-w- Ligue a instância de serviço e aguarde a ligação de serviços estar pronta. Se você especificar a opção
--wait, a ligação do aplicativo esperará por um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para que o app se ligue com sucesso. Se a ligação do app não for concluída com sucesso ou falhar no período--wait-timeoutespecificado, o comando falhará. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- A duração de tempo em segundos para esperar a ligação de serviços ficar pronta. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é300.
Exemplo
Neste exemplo, vincule sua instância IBM Cloud Object Storage de serviço chamada my-object-storage ao seu aplicativo chamado myapp.
ibmcloud ce application bind --name myapp --service-instance my-object-storage
Exemplo de saída
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
Crie um aplicativo.
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]
Opções de comando
-n,--name- O nome do aplicativo. Use um nome que seja exclusivo dentro do projeto.
- O nome deve iniciar com uma letra minúscula.
- O nome deve terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 63 caracteres ou menos e pode conter letras minúsculas, números e hifens (-).
Este valor é obrigatório.
--argument,--arg,-a- Configurar argumentos para o aplicativo. Especifique um argumento por opção
--argument; por exemplo,-a argA -a argB. Esse valor substitui os valores padrão que são especificados dentro da imagem de contêiner. Este valor é opcional. --build-commit,--commit,--bcm,--cm,--revision- A confirmação, a tag ou a ramificação no repositório de origem para fazer pull. A opção de confirmação de construção será permitida apenas se a opção
--build-sourceestiver configurada Este valor é opcional. --build-context-dir,--context-dir,--bcdr,--cdr- O diretório no repositório que contém o arquivo buildpacks ou o Dockerfile. A opção do diretório de contextos de construção será permitida apenas se a opção
--build-sourceestiver configurada Este valor é opcional. --build-dockerfile,--dockerfile,--bdf,--df- O caminho para o Dockerfile. Especifique esta opção apenas se o nome for diferente de
Dockerfile. A opção dockerfile de construção será permitida apenas se a opção--build-sourceestiver configurada Este valor é opcional. O valor padrão éDockerfile. --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- O nome do segredo SSH que contém as credenciais para acessar o repositório privado que contém o código-fonte para construir sua imagem de contêiner. Para criar esse segredo de SSH, use o comando
secret create --format SSHUm segredo de SSH também é utilizado como um segredo de acesso do repositório do Git Essa opção é permitida somente se a opção--build-sourceestiver definida como URL de um repositório Git. Este valor é opcional. --build-size,--size,--bsz,--sz- O tamanho para a compilação, que determina a quantia de recursos usados. Os valores válidos são
small,medium,large,xlargeexxlarge. Para obter detalhes, consulte Determinando o tamanho da construção. A opção de tamanho da construção será permitida apenas se a opção--build-sourceestiver configurada Este valor é opcional. O valor padrão émedium. --build-source,--source,--bsrc,--src- A URL do repositório Git ou o caminho para origem local que contém o seu código-fonte; por exemplo
https://github.com/IBM/CodeEngineou.. Este valor é opcional. --build-strategy,--strategy,--bstr,--str- A estratégia a ser usada para construir a imagem. Os valores válidos são
dockerfileebuildpacks. A opção de estratégia de compilação será permitida apenas se a opção--build-sourceestiver configurada Se não for especificado, a estratégia de compilação é determinada por Code Engine se--build-sourcefor especificado e a fonte estiver em sua máquina local. Este valor é opcional. O valor padrão édockerfile. --build-timeout,--bto- A quantia de tempo, em segundos, que pode transcorrer antes da compilação deve ser aprovada ou reprovada. A opção de tempo limite de construção será permitida apenas se a opção
--build-sourceestiver configurada Este valor é opcional. O valor padrão é600. --cluster-local,--cl- Implemente o aplicativo com um terminal Somente projetos. Configurar um terminal apenas de projeto significa que seu app não é acessível por meio da Internet pública e o acesso à rede só é possível por meio de outros componentes do Code
Engine que estão em execução no mesmo projeto. Este valor é opcional. O valor padrão é
false. --command,--cmd,-c- Configurar comandos para o aplicativo. Especifique um comando por opção
--command; por exemplo,--cmd cmdA --cmd cmdB. Este valor substitui o comando padrão que é especificado dentro da imagem de contêiner. Este valor é opcional. --concurrency,--cn- O número máximo de solicitações que podem ser processadas simultaneamente por instância. Este valor é opcional. O valor padrão é
100. --concurrency-target,--ct- O limite de solicitações simultâneas por instância no qual uma ou mais instâncias adicionais são criadas. Use este valor para ajustar a escala das instâncias com base em um número simultâneo de solicitações. Se
--concurrency-targetnão for especificado, essa opção será padronizada para o valor da opção--concurrency. Este valor é opcional. O valor padrão é0. --cpu- A quantia de CPU configurada para a instância do aplicativo. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. O valor
padrão é
1. --env,-e- Configurar variáveis de ambiente no aplicativo. Deve estar em formato
NAME=VALUE. Esta ação inclui uma nova variável de ambiente ou substitui uma variável de ambiente existente. Especifique uma variável de ambiente por opção--env; por exemplo,--env envA=A --env envB=B. Este valor é opcional. --env-cm,--env-from-configmap- Configure variáveis de ambiente por meio dos pares chave-valor que são armazenados neste configmap usando uma das maneiras a seguir:
- Para incluir variáveis de ambiente para todas as chaves em um mapa de configuração que é denominado
configmapName, use o valorconfigmapName. É possível modificar os nomes de variável de ambiente especificando um prefixo ao referenciar o configmap. Para especificar um prefixo, use o valorPREFIX=CONFIGMAP_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no configmapconfigmapNamecomoCUSTOM_, use o valorCUSTOM_=configmapName. Se o configmapconfigmapNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um mapa de configuração que é denominadoconfigmapName, use o valorconfigmapName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma única chavekey1em um configmap que é denominadoconfigmapName, use o valorconfigmapName:myKey=key1.
Este valor é opcional.
--env-sec,--env-from-secret- Defina variáveis de ambiente a partir dos pares chave-valor armazenados em um segredo usando uma das seguintes maneiras:
- Para incluir variáveis de ambiente para todas as chaves em um segredo que é denominado
secretName, use o valorsecretName. É possível modificar os nomes de variáveis de ambiente especificando um prefixo ao referenciar o segredo. Para especificar um prefixo, use o valorPREFIX=SECRET_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_SECRET>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no segredosecretNamecomoCUSTOM_, use o valorCUSTOM_=secretName. Se o segredosecretNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um segredo que é denominadosecretName, use o valorsecretName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma chave únicakey1em um segredo que é denominadosecretName, use o valorsecretName:myKey=key1.
Este valor é opcional.
--ephemeral-storage,--es- A quantia de armazenamento efêmero para configurar para a instância do aplicativo. Use
Mpara megabytes ouGpara gigabytes. Este valor é opcional. O valor padrão é400M. --force,-f- Não verifique a existência de referências especificadas de configmap e segredos. As referências de configmap são especificadas com as opções
--env-from-configmapou--mount-configmap. As referências de segredo são especificadas com as opções--env-from-secret,--mount-secretou--registry-secret. Este valor é opcional. O valor padrão éfalse. --image,-i- O nome da imagem que é usada para este aplicativo. O formato é
REGISTRY/NAMESPACE/REPOSITORY:TAGem queREGISTRYeTAGsão opcionais. SeREGISTRYnão for especificado, o padrão serádocker.io. SeTAGnão for especificado, o padrão serálatest. A opção de imagem será necessária se a opção--build-sourcenão for especificada. Este valor é opcional. --max-scale,--max,--maxscale- O número máximo de instâncias que podem ser usadas para este aplicativo. Se você configurar esse valor como
0, o aplicativo escalará conforme necessário. O ajuste de escala por parte do aplicativo está limitado apenas pelas instâncias de acordo com a cota de recursos para o projeto de seu aplicativo. Consulte Limites e cotas para o Code Engine. Este valor é opcional. O valor padrão é10. --memory,-m- A quantia de memória configurada para a instância do aplicativo. Use
Mpara megabytes ouGpara gigabytes. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. O valor padrão é4G. --min-scale,--min,--minscale- O número mínimo de instâncias que podem ser usadas para este aplicativo. Esta opção é útil para assegurar que nenhuma instância esteja em execução quando não for necessária. Este valor é opcional. O valor padrão é
0. --mount-configmap,--mount-cm- Inclua o conteúdo de um configmap ao sistema de arquivos de seu contêiner de aplicativo, fornecendo um diretório de montagem e o nome de um configmap, com o formato
MOUNT_DIRECTORY=CONFIGMAP_NAME. Cada configmap montado deve usar um diretório de montagem exclusivo. Para cada par chave-valor no configmap, um arquivo é incluído no diretório de montagem especificado, no qual o nome do arquivo é a chave e os conteúdos do arquivo são o valor do par chave-valor. Especifique uma configuração de montagem por opção--mount-configmap; por exemplo,--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b. Este valor é opcional. --mount-data-store,--mount-ds- Monte um armazenamento de dados persistente. O formato é MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. O SUBPATH é opcional. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--mount-secret,--mount-sec- Inclua o conteúdo de um segredo ao sistema de arquivos de seu contêiner de aplicativo, fornecendo um diretório de montagem e o nome de um segredo, com o formato
MOUNT_DIRECTORY=SECRET_NAME. Cada segredo montado deve usar um diretório de montagem exclusivo. Para cada par chave-valor no segredo, um arquivo é incluído no diretório de montagem especificado, no qual o nome do arquivo é a chave e os conteúdos do arquivo são o valor do par chave-valor. Especifique uma configuração de montagem por opção--mount-secret; por exemplo,--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b. Este valor é opcional. --no-cluster-local,--ncl- Implementar o aplicativo com um terminal público. O aplicativo é implementado de tal forma que possa receber solicitações da Internet pública ou de componentes dentro do projeto do Code Engine. Este valor é opcional. O valor padrão
é
true. --no-wait,--nw- Criar o aplicativo e não esperar o aplicativo ficar pronto. Se você especificar a opção
--no-wait, a criação do aplicativo será iniciada e não esperará. Use o comandoapp getpara verificar o status do aplicativo. Este valor é opcional. O valor padrão éfalse. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSION,jsonpath-as-json=JSONPATH_EXPRESSION,urleproject-url. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --port,-p- A porta na qual o aplicativo atende. O formato é
[NAME:]PORT, no qual[NAME:]é opcional. Se[NAME:]for especificado, os valores válidos serãoh2couhttp1. Quando[NAME:]não for especificado ou forhttp1, a porta usará o HTTP/1.1. Quando[NAME:]forh2c, a porta usará o HTTP/2 não criptografado. Por padrão, o Code Engine assume que os apps atendem as conexões recebidas na porta8080. Se o seu aplicativo precisar atender em uma porta diferente da porta8080, use--portpara especificar a porta. Este valor é opcional. --probe-live,--pl- Configure a análise de vivacidade para esse aplicativo no formato NAME=VALUE. As opções válidas para NAME são:
type,port,path,interval,initial-delay,timeout,failure-threshold. Esta opção pode ser especificada várias vezes A propriedadetypeé necessária, e os valores válidos sãotcpehttpPor exemplo, --probe-live tipo=tcp --probe-live port=8080. Para obter mais informações sobre como trabalhar com análises, para obter mais informações sobre trabalhar com análises, consulte Configurando análises para seu app. Este valor é opcional. --probe-ready,--pr- Configure a análise de prontidão para esse aplicativo no formato NAME=VALUE. As opções válidas para NAME são:
type,port,path,interval,initial-delay,timeout,failure-threshold. Esta opção pode ser especificada várias vezes A propriedadetypeé necessária, e os valores válidos sãotcpehttpPor exemplo, --probe-ready tipo=tcp --probe-ready port=8080. Para obter mais informações sobre como trabalhar com análises, para obter mais informações sobre trabalhar com análises, consulte Configurando análises para seu app. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --registry-secret,--rs- O nome do segredo de registro. O segredo do registro é usado para autenticação com um registro privado quando você faz download da imagem de contêiner. Este valor é opcional.
--request-timeout,--rt,--timeout,-t- A quantia de tempo, em segundos, que pode transcorrer antes que as solicitações feitas para o aplicativo tenham sucesso ou falhem. Este valor é opcional. O valor padrão é
300. --rn,--revision-name- O nome da revisão. Use um nome que seja exclusivo dentro do aplicativo.
- O nome pode conter letras minúsculas, números e hifens (-).
- O nome deve terminar com um caractere alfanumérico minúsculo.
- O nome completo da revisão deve estar no formato,
Name_of_application-Name of revision. - O nome de revisão completo deve ter 63 caracteres ou menos.
Este valor é opcional.
--scale-down-delay,--sdd- A quantidade de tempo, em segundos, que deve passar na simultaneidade reduzida antes que a capacidade do aplicativo seja reduzida. Um aumento do número de solicitações simultâneas faz com que um aplicativo aumente a capacidade. Se o número
de solicitações cair (simultaneidade reduzida), o período de tempo especificado para essa opção determina por quanto tempo a simultaneidade reduzida precisa persistir, antes que o aplicativo seja reduzido. Por padrão, o aplicativo será
reduzido imediatamente, se a simultaneidade reduzida for detectada. Este valor é opcional. O valor padrão é
0. --service-account,--sa- O nome da conta do serviço. Uma conta de serviço fornece uma identidade para processos que são executados em uma instância. Para contas de serviço integradas, é possível usar os nomes abreviados
manager,none,readerewriter. É possível também usar nomes completos que são prefixados com oKubernetes Config Context, que pode ser determinado com o comandoproject current. Este valor é opcional. --trusted-profiles-enabled,--trusted,--tpe- Ative a montagem de um token de recurso de computação no contêiner desse aplicativo. Este valor é opcional. O valor padrão é
false. --user,-u- O ID do usuário (UID) que é usado para executar o aplicativo. Este valor substitui qualquer ID do usuário que esteja configurado no aplicativo Dockerfile. O ID deve estar em conformidade com os requisitos do sistema operacional do contêiner.
Este valor é opcional. O valor padrão é
0. --visibility,-v- A visibilidade para o aplicativo. Os valores válidos são
public,private, eproject. Definir uma visibilidade depublicsignifica que o seu app pode receber solicitações da Internet pública ou de componentes dentro do projeto do Code Engine. Configurar uma visibilidade deprivatesignifica que o seu app não é acessível por meio da Internet pública e o acesso à rede só é possível por meio de outros IBM Cloud usando terminais privados virtuais (VPE) ou componentes do Code Engine que estão em execução no mesmo projeto. A visibilidade só pode serprivatese o projeto suportar a visibilidade privada do aplicativo. Configurar uma visibilidade deprojectsignifica que o seu app não é acessível por meio da Internet pública e o acesso à rede só é possível por meio de outros componentes do Code Engine que estão em execução no mesmo projeto. Este valor é opcional. --wait,-w- Criar o aplicativo e esperar o aplicativo ficar pronto. Se você especificar a opção
--wait, a criação do aplicativo irá esperar por um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para que o aplicativo fique pronto. Se o aplicativo não estiver pronto dentro do períodowait-timeoutespecificado, a criação do aplicativo falhará. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- A duração de tempo em segundos para esperar o aplicativo ficar pronto. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é600.
Exemplo
ibmcloud ce application create --name myapp --image icr.io/codeengine/hello
Exemplo de saída
Creating application 'myapp'...
[...]
Run `ibmcloud ce application get -n 'myapp'` to check the application status.
OK
https://myapp.4svg40kna19.us-south.codeengine.appdomain.cloud
Quando você executa ibmcloud ce application get -n 'myapp' para verificar o status da inscrição, o URL da sua inscrição é exibido.
ibmcloud ce application delete
Excluir um aplicativo.
ibmcloud ce application delete --name APPLICATION_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
--name,-n- O nome do aplicativo. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --no-wait,--nw- Exclua o aplicativo e não espere que o aplicativo seja excluído. Se você especificar a opção
no-wait, a exclusão do aplicativo será iniciada e não esperará. Use o comandoapp getpara verificar o status do aplicativo. Este valor é opcional. O valor padrão étrue. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --wait,-w- Exclua o aplicativo e aguarde que o aplicativo seja excluído. Se você especificar a opção
--wait, a exclusão do aplicativo irá esperar por um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para que o aplicativo seja excluído. Se o aplicativo não for excluído no período--wait-timeoutespecificado, a exclusão dele falhará. Este valor é opcional. O valor padrão éfalse. --wait-timeout,--wto- O período de tempo em segundos que se deve esperar pela exclusão do aplicativo. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é600.
Exemplo
ibmcloud ce application delete --name myapp -f
Exemplo de saída
Deleted application 'myapp'
ibmcloud ce application events
Exiba os eventos do sistema de instâncias do aplicativo. Eventos do sistema são retidos por até 60 minutos.
ibmcloud ce application events (--instance APP_INSTANCE | --application APP_NAME) [--output OUTPUT] [--quiet]
Opções de comando
--application,--app,-a,--name,-n- Exibir os eventos de todas as instâncias do aplicativo especificado. Este valor será necessário se
--instancenão for especificado. --instance,-i- O nome de uma instância do aplicativo específica. Use o comando
app getpara localizar o nome da instância. Este valor será necessário se--applicationnão for especificado. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
O exemplo a seguir exibe as informações de eventos do sistema para todas as instâncias de um aplicativo especificado.
ibmcloud ce application events --application myapp
Exemplo de saída
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
Exemplo de informações de eventos do sistema para instância especificada de um app
O exemplo a seguir exibe as informações de eventos do sistema para uma instância especificada de um app. Use o comando app get para exibir detalhes sobre seu app, incluindo as instâncias de execução do app.
ibmcloud ce application events --instance myapp-li17x-1-deployment-69fd57bcb6-sr9tl
Exemplo de saída de informações de eventos do sistema para instância especificada de um app
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
Exibir os detalhes de um aplicativo.
ibmcloud ce application get --name APPLICATION_NAME [--output OUTPUT] [--quiet] [--show-all-revisions]
Opções de comando
--name,-n- O nome do aplicativo. Este valor é obrigatório.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSION,jsonpath-as-json=JSONPATH_EXPRESSION,urleproject-url. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --show-all-revisions,-r- Mostra todas as revisões para este aplicativo. Se não for especificado, apenas as revisões configuradas para receber tráfego serão mostradas. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce application get --name myapp
Exemplo de saída
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
Listar todos os aplicativos em um projeto.
ibmcloud ce application list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce app list --sort-by age
Exemplo de saída
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
Exibir os logs das instâncias do aplicativo.
ibmcloud ce application logs (--instance APP_INSTANCE | --application APP_NAME) [--all-containers] [--follow] [--output OUTPUT] [--quiet] [--raw] [--tail TAIL] [--timestamps]
Opções de comando
--all-containers,--all- Exibir os logs de todos os contêineres das instâncias do aplicativo especificadas. Este valor é opcional. O valor padrão é
false. --application,--app,-a,--name,-n- Exibir os logs de todas as instâncias do aplicativo especificado. Este valor será necessário se
--instancenão for especificado. --follow,-f- Seguir os logs das instâncias do aplicativo. Use essa opção para logs de fluxo de instâncias de aplicativos. Se você especificar a opção
--follow, deverá inserirCtrl+Cpara finalizar este comando de log. Este valor é opcional. O valor padrão éfalse. --instance,-i- O nome de uma instância do aplicativo específica. Use o comando
app getpara localizar o nome da instância. Este valor será necessário se--applicationnão for especificado. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --raw,-r- Exibir logs sem os rótulos de instância e de contêiner. Este valor é opcional. O valor padrão é
false. --tail,-t- Limitar a exibição de logs de contêineres das instâncias de aplicativos especificadas a um número máximo de linhas recentes por contêiner. Por exemplo, para exibir as últimas
3linhas dos logs dos contêineres das instâncias de aplicativo determinadas, especifique--tail 3. Se esta opção não for especificada, todas as linhas dos logs dos contêineres das instâncias do aplicativo especificado serão exibidas. Este valor é opcional. O valor padrão é-1. --timestamps,--ts- Incluir registros de data e hora em cada linha na saída de log. Este valor é opcional. O valor padrão é
false.
Exemplo
O exemplo a seguir exibe os logs de uma instância específica de um app. Use o comando app get para obter o nome das instâncias do app.
ibmcloud ce application logs --instance myapp-zhk9x-1-deployment-6f955f5cc5-abcde
Exemplo de saída
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/
Exemplo de logs de todas as instâncias de um app
O exemplo a seguir exibe os logs de todas as instâncias de um app.
ibmcloud ce application logs --app myapp
Exemplo de saída de logs de todas as instâncias de um app
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
Reiniciar as instâncias do aplicativo em execução.
ibmcloud ce application restart (--instance APP_INSTANCE | --application APP_NAME) [--quiet]
Opções de comando
--application,--app,-a,--name,-n- Reiniciar todas as instâncias em execução do aplicativo especificado. Este valor será necessário se
--instancenão for especificado. --instance,-i- O nome de uma instância do aplicativo específica. Use o comando
app getpara localizar o nome da instância. Este valor será necessário se--applicationnão for especificado. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce application restart --name myapp
Exemplo de saída
Restarting all running instances of application 'myapp'...
OK
ibmcloud ce application unbind
Desvincular a instância de serviço da IBM Cloud de um aplicativo.
ibmcloud ce application unbind --name APP_NAME (--binding BINDING_NAME | --all) [--quiet]
Opções de comando
--name,-n- O nome do aplicativo a ser desvinculado. Este valor é obrigatório.
--all,-A- Desvincula todas as instâncias de serviço desse aplicativo. Este valor será necessário se
--bindingnão for especificado. O valor padrão éfalse. --binding,-b- O nome da ligação a ser desvinculada. Execute
ibmcloud ce app get -n APP_NAMEpara visualizar nomes de ligação. Este valor será necessário se--allnão for especificado. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
Neste exemplo, remova todas as ligações do seu aplicativo chamado myapp.
ibmcloud ce application unbind --name myapp --all
Exemplo de saída
Removing service bindings...
OK
ibmcloud ce application update
Atualize um aplicativo. A atualização de seu aplicativo cria uma revisão. Quando são feitas chamadas para o aplicativo, o tráfego é roteado para a revisão.
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]
Opções de comando
--name,-n- O nome do aplicativo. Este valor é obrigatório.
--argument,--arg,-a- Configurar argumentos para o aplicativo. Especifique um argumento por opção
--argument; por exemplo,-a argA -a argB. Este valor é opcional. --arguments-clear,--ac- Limpar argumentos do aplicativo. Este valor é opcional. O valor padrão é
false. --build-clear,--bc- Remova a associação de uma compilação a partir deste aplicativo. A opção "limpar compilação" só é permitida se o seu aplicativo tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão é
false. --build-commit,--commit,--bcm,--cm,--revision- A confirmação, a tag ou a ramificação no repositório de origem para fazer pull. A opção de commit de compilação só é permitida se a
--build-sourceopção estiver definida como o GitURL repositório nesteapp updatecomando, ou se o seu aplicativo tiver atualmente uma compilação associada a partir de uma fonte Git de repositório. Este valor é opcional. --build-commit-clear,--commit-clear,--bcmc,--cmc- Limpe a confirmação, tag ou ramificação no repositório de origem para fazer pull. A opção commit clear é permitida se o seu aplicativo tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão é
false. --build-context-dir,--context-dir,--bcdr,--cdr- O diretório no repositório que contém o arquivo buildpacks ou o Dockerfile. A opção build context directory será permitida se a opção
--build-sourcefor definida neste comandoapp update, ou o seu aplicativo possuir atualmente uma construção associada. Este valor é opcional. --build-dockerfile,--dockerfile,--bdf,--df- O caminho para o Dockerfile. Especifique esta opção apenas se o nome for diferente de
Dockerfile. A opção build dockerfile só é permitida se a--build-sourceopção estiver definida nesteapp updatecomando ou se a sua aplicação tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão éDockerfile. --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- O nome do segredo SSH que contém as credenciais para acessar o repositório privado que contém o código-fonte para construir sua imagem de contêiner. Para criar esse segredo de SSH, use o comando
secret create --format SSHUm segredo de SSH também é utilizado como um segredo de acesso do repositório do Git Esta opção só é permitida se a--build-sourceopção estiver definida como o GitURL repositório nesteapplication updatecomando, ou se a sua aplicação tiver atualmente uma compilação associada a partir de uma fonte Git de repositório. Este valor é opcional. --build-git-repo-secret-clear,--git-repo-secret-clear,--bgrsc,--grsc- Limpar o segredo do SSH. Esta opção é permitida se a sua aplicação tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão é
false. --build-size,--size,--bsz,--sz- O tamanho para a compilação, que determina a quantia de recursos usados. Os valores válidos são
small,medium,large,xlargeexxlarge. Para obter detalhes, consulte Determinando o tamanho da construção. A opção de tamanho da compilação só é permitida se a--build-sourceopção estiver definida nesteapp updatecomando ou se o seu aplicativo tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão émedium. --build-source,--source,--bsrc,--src- A URL do repositório Git ou o caminho para origem local que contém o seu código-fonte; por exemplo
https://github.com/IBM/CodeEngineou.. Este valor é opcional. --build-strategy,--strategy,--bstr,--str- A estratégia a ser usada para construir a imagem. Os valores válidos são
dockerfileebuildpacks. A opção de estratégia de compilação só é permitida se a--build-sourceopção estiver definida nesteapp updatecomando ou se o seu aplicativo tiver atualmente uma compilação associada. Se não for especificado, a estratégia de construção será determinada por Code Engine se--build-sourcefor especificado e a origem estiver em sua máquina local. Este valor é opcional. O valor padrão édockerfile. --build-timeout,--bto- A quantia de tempo, em segundos, que pode transcorrer antes da compilação deve ser aprovada ou reprovada. A opção de tempo limite de compilação só é permitida se a
--build-sourceopção estiver definida nesteapp updatecomando ou se o seu aplicativo tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão é600. --cluster-local,--cl- Implemente o aplicativo com um terminal Somente projetos. Configurar um terminal apenas de projeto significa que seu app não é acessível por meio da Internet pública e o acesso à rede só é possível por meio de outros componentes do Code
Engine que estão em execução no mesmo projeto. Este valor é opcional. O valor padrão é
false. --command,--cmd,-c- Configurar comandos para o aplicativo. Especifique um comando por opção
--command; por exemplo,--cmd cmdA --cmd cmdB. Este valor substitui o comando padrão que é especificado dentro da imagem de contêiner. Este valor é opcional. --commands-clear,--cc- Limpar comandos do aplicativo. Este valor é opcional. O valor padrão é
false. --concurrency,--cn- O número máximo de solicitações que podem ser processadas simultaneamente por instância. Este valor é opcional. O valor padrão é
0. --concurrency-target,--ct- O limite de solicitações simultâneas por instância no qual uma ou mais instâncias adicionais são criadas. Use este valor para ajustar a escala das instâncias com base em um número simultâneo de solicitações. Se
--concurrency-targetnão for especificado, essa opção será padronizada para o valor da opção--concurrency. Este valor é opcional. O valor padrão é0. --cpu- A quantia de CPU configurada para a instância do aplicativo. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. O valor
padrão é
0. --env,-e- Configurar variáveis de ambiente no aplicativo. Deve estar em formato
NAME=VALUE. Esta ação inclui uma nova variável de ambiente ou substitui uma variável de ambiente existente. Especifique uma variável de ambiente por opção--env; por exemplo,--env envA=A --env envB=B. Este valor é opcional. --env-cm,--env-from-configmap- Configure variáveis de ambiente por meio dos pares chave-valor que são armazenados neste configmap usando uma das maneiras a seguir:
- Para incluir variáveis de ambiente para todas as chaves em um mapa de configuração que é denominado
configmapName, use o valorconfigmapName. É possível modificar os nomes de variável de ambiente especificando um prefixo ao referenciar o configmap. Para especificar um prefixo, use o valorPREFIX=CONFIGMAP_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no configmapconfigmapNamecomoCUSTOM_, use o valorCUSTOM_=configmapName. Se o configmapconfigmapNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um mapa de configuração que é denominadoconfigmapName, use o valorconfigmapName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma única chavekey1em um configmap que é denominadoconfigmapName, use o valorconfigmapName:myKey=key1.
Este valor é opcional.
--env-from-configmap-rm,--env-cm-rm- Remova referências de variável de ambiente para configmaps integrais usando o nome do configmap. Para remover referências de chave individual a mapas de configuração, use a opção
--env-rm. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional. --env-sec,--env-from-secret- Defina variáveis de ambiente a partir dos pares chave-valor armazenados em um segredo usando uma das seguintes maneiras:
- Para incluir variáveis de ambiente para todas as chaves em um segredo que é denominado
secretName, use o valorsecretName. É possível modificar os nomes de variáveis de ambiente especificando um prefixo ao referenciar o segredo. Para especificar um prefixo, use o valorPREFIX=SECRET_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_SECRET>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no segredosecretNamecomoCUSTOM_, use o valorCUSTOM_=secretName. Se o segredosecretNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um segredo que é denominadosecretName, use o valorsecretName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma chave únicakey1em um segredo que é denominadosecretName, use o valorsecretName:myKey=key1.
Este valor é opcional.
--env-from-secret-rm,--env-sec-rm- Remova referências de variável de ambiente para segredos integrais usando o nome do segredo. Para remover referências de chave individual a segredos, use a opção
--env-rm. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional. --env-rm- Remover referências de variável de ambiente para a chave de um par chave-valor em um mapa de configuração ou segredo. Para remover referências de chave individual e valores literais, especifique o nome da chave. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--ephemeral-storage,--es- A quantia de armazenamento efêmero para configurar para a instância do aplicativo. Use
Mpara megabytes ouGpara gigabytes. Este valor é opcional. --force,-f- Não verifique a existência de referências especificadas de configmap e segredos. As referências de configmap são especificadas com as opções
--env-from-configmapou--mount-configmap. As referências de segredo são especificadas com as opções--env-from-secret,--mount-secretou--registry-secret. Este valor é opcional. O valor padrão éfalse. --image,-i- O nome da imagem que é usada para este aplicativo. O formato é
REGISTRY/NAMESPACE/REPOSITORY:TAGem queREGISTRYeTAGsão opcionais. SeREGISTRYnão for especificado, o padrão serádocker.io. SeTAGnão for especificado, o padrão serálatest. Este valor é opcional. --max-scale,--max,--maxscale- O número máximo de instâncias que podem ser usadas para este aplicativo. Se você configurar esse valor como
0, o aplicativo escalará conforme necessário. O ajuste de escala por parte do aplicativo está limitado apenas pelas instâncias de acordo com a cota de recursos para o projeto de seu aplicativo. Consulte Limites e cotas para o Code Engine. Este valor é opcional. O valor padrão é10. --memory,-m- A quantia de memória configurada para a instância do aplicativo. Use
Mpara megabytes ouGpara gigabytes. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. --min-scale,--min,--minscale- O número mínimo de instâncias que podem ser usadas para este aplicativo. Este valor é opcional. O valor padrão é
0. --mount-configmap,--mount-cm- Inclua o conteúdo de um configmap ao sistema de arquivos de seu contêiner de aplicativo, fornecendo um diretório de montagem e o nome de um configmap, com o formato
MOUNT_DIRECTORY=CONFIGMAP_NAME. Cada configmap montado deve usar um diretório de montagem exclusivo. Para cada par chave-valor no configmap, um arquivo é incluído no diretório de montagem especificado, no qual o nome do arquivo é a chave e os conteúdos do arquivo são o valor do par chave-valor. Especifique uma configuração de montagem por opção--mount-configmap; por exemplo,--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b. Este valor é opcional. --mount-data-store,--mount-ds- Monte um armazenamento de dados persistente. O formato é MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. O SUBPATH é opcional. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--mount-rm- Remova os conteúdos de um configmap ou segredo do sistema de arquivos do seu contêiner de aplicativo, especificando o diretório no qual o configmap ou segredo está montado. Especifique um diretório de montagem por opção
--mount-rm; por exemplo,--mount-rm /etc/configmap-a --mount-rm /etc/secret-b. Este valor é opcional. --mount-secret,--mount-sec- Inclua o conteúdo de um segredo ao sistema de arquivos de seu contêiner de aplicativo, fornecendo um diretório de montagem e o nome de um segredo, com o formato
MOUNT_DIRECTORY=SECRET_NAME. Cada segredo montado deve usar um diretório de montagem exclusivo. Para cada par chave-valor no segredo, um arquivo é incluído no diretório de montagem especificado, no qual o nome do arquivo é a chave e os conteúdos do arquivo são o valor do par chave-valor. Especifique uma configuração de montagem por opção--mount-secret; por exemplo,--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b. Este valor é opcional. --no-cluster-local,--ncl- Implementar o aplicativo com um terminal público. O aplicativo é implementado de tal forma que possa receber solicitações da Internet pública ou de componentes dentro do projeto do Code Engine. Este valor é opcional. O valor padrão
é
true. --no-wait,--nw- Atualize o aplicativo e não espere que o aplicativo esteja pronto. Se você especificar a opção
no-wait, a atualização do aplicativo será iniciada e não esperará. Use o comandoapp getpara verificar o status do aplicativo. Este valor é opcional. O valor padrão éfalse. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSION,jsonpath-as-json=JSONPATH_EXPRESSION,urleproject-url. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --port,-p- A porta na qual o aplicativo atende. O formato é
[NAME:]PORT, no qual[NAME:]é opcional. Se[NAME:]for especificado, os valores válidos serãoh2couhttp1. Quando[NAME:]não for especificado ou forhttp1, a porta usará o HTTP/1.1. Quando[NAME:]forh2c, a porta usará o HTTP/2 não criptografado. Por padrão, o Code Engine assume que os apps atendem as conexões recebidas na porta8080. Se o seu aplicativo precisar atender em uma porta diferente da porta8080, use--portpara especificar a porta. Este valor é opcional. --probe-live,--pl- Configure a análise de vivacidade para esse aplicativo no formato NAME=VALUE. As opções válidas para NAME são:
type,port,path,interval,initial-delay,timeout,failure-threshold. Esta opção pode ser especificada várias vezes A propriedadetypeé necessária, e os valores válidos sãotcpehttpPor exemplo, --probe-live tipo=tcp --probe-live port=8080. Para obter mais informações sobre como trabalhar com análises, para obter mais informações sobre trabalhar com análises, consulte Configurando análises para seu app. Este valor é opcional. --probe-live-clear,--plr- Remova a análise de vivacidade. Essa opção será permitida somente se o seu app tiver atualmente uma análise de atividade. Este valor é opcional. O valor padrão é
false. --probe-ready,--pr- Configure a análise de prontidão para esse aplicativo no formato NAME=VALUE. As opções válidas para NAME são:
type,port,path,interval,initial-delay,timeout,failure-threshold. Esta opção pode ser especificada várias vezes A propriedadetypeé necessária, e os valores válidos sãotcpehttpPor exemplo, --probe-ready tipo=tcp --probe-ready port=8080. Para obter mais informações sobre como trabalhar com análises, para obter mais informações sobre trabalhar com análises, consulte Configurando análises para seu app. Este valor é opcional. --probe-ready-reset,--prr- Redefine a análise de prontidão para a configuração padrão. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --rebuild- Reconstruir a imagem por meio da origem. A opção rebuild será permitida se o seu aplicativo atualmente tiver uma construção associada. Este valor é opcional. O valor padrão é
false. --registry-secret,--rs- O nome do segredo de registro. O segredo do registro é usado para autenticação com um registro privado quando você faz download da imagem de contêiner. Este valor é opcional.
--registry-secret-clear,--rsc- Limpar o segredo de registro. Este valor é opcional. O valor padrão é
false. --request-timeout,--rt,--timeout,-t- A quantia de tempo, em segundos, que pode transcorrer antes que as solicitações feitas para o aplicativo tenham sucesso ou falhem. Este valor é opcional. O valor padrão é
0. --rn,--revision-name- O nome da revisão. Use um nome que seja exclusivo dentro do aplicativo.
- O nome pode conter letras minúsculas, números e hifens (-).
- O nome deve terminar com um caractere alfanumérico minúsculo.
- O nome completo da revisão deve estar no formato,
Name_of_application-Name of revision. - O nome de revisão completo deve ter 63 caracteres ou menos.
Este valor é opcional.
--scale-down-delay,--sdd- A quantidade de tempo, em segundos, que deve passar na simultaneidade reduzida antes que a capacidade do aplicativo seja reduzida. Um aumento do número de solicitações simultâneas faz com que um aplicativo aumente a capacidade. Se o número
de solicitações cair (simultaneidade reduzida), o período de tempo especificado para essa opção determina por quanto tempo a simultaneidade reduzida precisa persistir, antes que o aplicativo seja reduzido. Por padrão, o aplicativo será
reduzido imediatamente, se a simultaneidade reduzida for detectada. Este valor é opcional. O valor padrão é
0. --service-account,--sa- O nome da conta do serviço. Uma conta de serviço fornece uma identidade para processos que são executados em uma instância. Para contas de serviço integradas, é possível usar os nomes abreviados
manager,none,readerewriter. É possível também usar nomes completos que são prefixados com oKubernetes Config Context, que pode ser determinado com o comandoproject current. Este valor é opcional. --service-account-clear,--sac- Limpar a conta de serviço. Este valor é opcional. O valor padrão é
false. --trusted-profiles-enabled,--trusted,--tpe- Ative a montagem de um token de recurso de computação no contêiner desse aplicativo. Este valor é opcional. O valor padrão é
false. --user,-u- O ID do usuário (UID) que é usado para executar o aplicativo. Este valor substitui qualquer ID do usuário que esteja configurado no aplicativo Dockerfile. O ID deve estar em conformidade com os requisitos do sistema operacional do contêiner.
Este valor é opcional. O valor padrão é
0. --visibility,-v- A visibilidade para o aplicativo. Os valores válidos são
public,private, eproject. Definir uma visibilidade depublicsignifica que o seu app pode receber solicitações da Internet pública ou de componentes dentro do projeto do Code Engine. Configurar uma visibilidade deprivatesignifica que o seu app não é acessível por meio da Internet pública e o acesso à rede só é possível por meio de outros IBM Cloud usando terminais privados virtuais (VPE) ou componentes do Code Engine que estão em execução no mesmo projeto. A visibilidade só pode serprivatese o projeto suportar a visibilidade privada do aplicativo. Configurar uma visibilidade deprojectsignifica que o seu app não é acessível por meio da Internet pública e o acesso à rede só é possível por meio de outros componentes do Code Engine que estão em execução no mesmo projeto. Este valor é opcional. --wait,-w- Atualize o aplicativo e aguarde que o aplicativo esteja pronto. Se você especificar a opção
--wait, a atualização do aplicativo irá esperar por um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para que o aplicativo fique pronto. Se o aplicativo não estiver pronto no período--wait-timeoutespecificado, a criação dele falhará. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- A duração de tempo em segundos a esperar para que o aplicativo seja atualizado. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é600.
Exemplo
ibmcloud ce application update --name myapp --image icr.io/codeengine/hello
Exemplo de saída
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
Comando beta
Code Engine Os comandos beta geralmente não estão disponíveis. Esse grupo de comandos fornece acesso a possíveis recursos futuros para facilitar a exploração por usuários iniciais selecionados.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos beta.
Para ver a ajuda da CLI para os beta comandos, execute ibmcloud ce beta -h.
ibmcloud ce beta
Code Engine Os comandos beta geralmente não estão disponíveis. Esse grupo de comandos fornece acesso a possíveis recursos futuros para facilitar a exploração por usuários iniciais selecionados.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos beta.
Para ver a ajuda da CLI para os beta comandos, execute ibmcloud ce beta -h.
ibmcloud ce beta COMMAND
Exemplo
ibmcloud ce beta help
Exemplo de saída
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.
Comandos de construção
Uma construção, ou construção de imagem, é um mecanismo que você pode usar para criar uma imagem de contêiner por meio do seu código-fonte. O Code Engine suporta a construção por meio de um Dockerfile e Cloud Native Buildpacks. Use os comandos
build para criar, exibir detalhes, atualizar e excluir configurações de construção. Depois de criar uma configuração de compilação, uma ou mais buildrun comandos podem ser enviadas com
base na configuração de compilação.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos build.
Para obter mais informações sobre como trabalhar com construções, consulte Construindo uma imagem de contêiner.
É possível usar build ou bd em seus comandos build. Para ver a ajuda da CLI para os comandos build, execute ibmcloud ce build -h.
ibmcloud ce build create
Criar uma construção.
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]
Opções de comando
-n,--name- O nome da compilação. Use um nome que seja exclusivo dentro do projeto.
- O nome deve iniciar e terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 63 caracteres ou menos e pode conter caracteres alfanuméricos minúsculos e hifens (-).
Este valor é obrigatório.
--build-type,--bt- O tipo de compilação. Os valores válidos são
gitelocal. Se o tipo de construção forlocal, as opções--source,--commite--git-repo-secretnão serão válidas. Este valor é opcional. O valor padrão égit. --commit,--cm,--revision- A confirmação, a tag ou a ramificação no repositório de origem para fazer pull. A opção commit será permitida se a opção
--build-typeforgite não permitida se a opção--build-typeforlocal. Este valor é opcional. --context-dir,--cdr- O diretório no repositório que contém o arquivo buildpacks ou o Dockerfile. Este valor é opcional.
--dockerfile,--df- O caminho para o Dockerfile. Especifique esta opção apenas se o nome for diferente de
Dockerfile. Este valor é opcional. O valor padrão éDockerfile. --force,-f- Não verifique a existência de referências de segredo especificadas. As referências de segredo são especificadas com as opções
--get-repo-secretou--registry-secret. Este valor é opcional. O valor padrão éfalse. --git-repo-secret,--grs,--repo,-r- O nome do segredo SSH que contém as credenciais para acessar o repositório privado que contém o código-fonte para construir sua imagem de contêiner. Para criar esse segredo de SSH, use o comando
secret create --format SSHUm segredo de SSH também é utilizado como um segredo de acesso do repositório do Git Essa opção é permitida se a opção--build-typeforgite não permitida se a opção--build-typeforlocal. Este valor é opcional. --image,-i- O local do registro de imagem. O formato é
REGISTRY/NAMESPACE/REPOSITORY:TAGem queTAGé opcional. SeTAGnão for especificado, o padrão serálatest. Este valor é opcional. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --registry-secret,--rs- O segredo do registro usado para acessar o registro. Você pode adicionar o segredo do registro executando o
registry createcomando. Este valor é opcional. --size,--sz- O tamanho para a compilação, que determina a quantia de recursos usados. Os valores válidos são
small,medium,large,xlargeexxlarge. Para obter detalhes, consulte Determinando o tamanho da construção. Este valor é opcional. O valor padrão émedium. --source,--src- A URL do repositório Git que contém seu código-fonte; por exemplo,
https://github.com/IBM/CodeEngine. A opção source será necessária se a opção--build-typeforgite não permitida se a opção--build-typeforlocal. Este valor é opcional. --strategy,--str- A estratégia a ser usada para construir a imagem. Para aplicações e trabalhos, os valores válidos são
dockerfileebuildpacks. Para funções, os valores válidos têm o formatocodebundle-[RUNTIME-ID]. Por exemplo, se você desejar construir um pacote configurável de códigos para sua função com o ID de tempo de execuçãonodejs-20, usecodebundle-nodejs-20como a estratégia de construção É possível localizar o ID de qualquer tempo de execução das funções suportadas executando o comandoibmcloud ce fn runtimes. Este valor é opcional. O valor padrão édockerfile. --timeout,--to- A quantia de tempo, em segundos, que pode transcorrer antes da compilação deve ser aprovada ou reprovada. Este valor é opcional. O valor padrão é
600.
Exemplo
O exemplo a seguir cria um arquivo de configuração de construção chamado helloworld-build por meio de um Dockerfile de origem, que está localizado em https://github.com/IBM/CodeEngine dentro do diretório hello na ramificação main, com a estratégia dockerfile e o tamanho medium. Quando essa construção é enviada, a imagem de contêiner construída é armazenada em uma instância do Container Registry em us.icr.io/mynamespace/codeengine-helloworld,
que é acessada por meio de um segredo de registro de imagem chamado 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
Exemplo de saída
Creating build helloworld-build...
OK
ibmcloud ce build delete
Excluir uma construção.
ibmcloud ce build delete --name BUILD_NAME [--force] [--ignore-not-found] [--quiet]
Opções de comando
--name,-n- O nome da compilação. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce build delete --name helloworld-build
Exemplo de saída
Are you sure you want to delete build helloworld-build? [y/N]> y
Deleting build 'helloworld-build'...
OK
ibmcloud ce build get
Exibir os detalhes de uma construção.
ibmcloud ce build get --name BUILD_NAME [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- O nome da compilação. Este valor é obrigatório.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce build get --name helloworld-build
Exemplo de saída
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
Listar todas as construções em um projeto.
ibmcloud ce build list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce build list
Exemplo de saída
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
Atualizar uma construção.
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]
Opções de comando
--name,-n- O nome da compilação. Este valor é obrigatório.
--commit,--cm,--revision- A confirmação, a tag ou a ramificação no repositório de origem para fazer pull. Este valor é opcional.
--commit-clear,--cmc- Limpe a confirmação, tag ou ramificação no repositório de origem para fazer pull. Este valor é opcional. O valor padrão é
false. --context-dir,--cdr- O diretório no repositório que contém o arquivo buildpacks ou o Dockerfile. Este valor é opcional.
--dockerfile,--df- O caminho para o Dockerfile. Especifique esta opção apenas se o nome for diferente de
Dockerfile. Este valor é opcional. O valor padrão éDockerfile. --force,-f- Não verifique a existência de referências de segredo especificadas. As referências de segredo são especificadas com as opções
--get-repo-secretou--registry-secret. Este valor é opcional. O valor padrão éfalse. --git-repo-secret,--grs,--repo,-r- O nome do segredo SSH que contém as credenciais para acessar o repositório privado que contém o código-fonte para construir sua imagem de contêiner. Para criar esse segredo de SSH, use o comando
secret create --format SSHUm segredo de SSH também é utilizado como um segredo de acesso do repositório do Git Este valor é opcional. --git-repo-secret-clear,--grsc- Limpar o segredo do SSH. Este valor é opcional. O valor padrão é
false. --image,-i- O local do registro de imagem. O formato é
REGISTRY/NAMESPACE/REPOSITORY:TAGem queTAGé opcional. SeTAGnão for especificado, o padrão serálatest. Este valor é opcional. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --registry-secret,--rs- O nome do segredo de registro. O segredo do registro é usado para autenticação com um registro privado quando você faz download da imagem de contêiner. Este valor é opcional.
--size,--sz- O tamanho para a compilação, que determina a quantia de recursos usados. Os valores válidos são
small,medium,large,xlargeexxlarge. Para obter detalhes, consulte Determinando o tamanho da construção. Este valor é opcional. --source,--src- A URL do repositório Git que contém seu código-fonte; por exemplo,
https://github.com/IBM/CodeEngine. Este valor é opcional. --strategy,--str- A estratégia a ser usada para construir a imagem. Para aplicações e trabalhos, os valores válidos são
dockerfileebuildpacks. Para funções, os valores válidos têm o formatocodebundle-[RUNTIME-ID]. Por exemplo, se você desejar construir um pacote configurável de códigos para sua função com o ID de tempo de execuçãonodejs-20, usecodebundle-nodejs-20como a estratégia de construção É possível localizar o ID de qualquer tempo de execução das funções suportadas executando o comandoibmcloud ce fn runtimes. Este valor é opcional. --timeout,--to- A quantia de tempo, em segundos, que pode transcorrer antes da compilação deve ser aprovada ou reprovada. Este valor é opcional. O valor padrão é
600.
Exemplo
ibmcloud ce build update --name helloworld-build --source https://github.com/IBM/CodeEngine --context-dir /hello --commit main --timeout 900
Exemplo de saída
Updating build helloworld-build...
OK
Comandos buildrun
Uma construção, ou construção de imagem, é um mecanismo que você pode usar para criar uma imagem de contêiner por meio do seu código-fonte. O Code Engine suporta a construção por meio de um Dockerfile e Cloud Native Buildpacks. Use os comandos
buildrun para enviar, exibir detalhes e excluir execuções de construção.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos buildrun.
Para obter mais informações sobre como trabalhar com construções e execuções de construção, consulte Construindo uma imagem de contêiner.
É possível usar buildrun ou br em seus comandos buildrun. Para ver a ajuda da CLI para os comandos buildrun, execute ibmcloud ce br -h.
ibmcloud ce buildrun cancel
Cancelar uma execução de compilação.
ibmcloud ce buildrun cancel --name BUILDRUN_NAME [--quiet]
Opções de comando
--name,-n- O nome da execução de compilação. Este valor é obrigatório.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce buildrun cancel --name mybuildrun
Exemplo de saída
Cancelling build run 'mybuildrun'...
OK
ibmcloud ce buildrun delete
Excluir uma execução de compilação.
ibmcloud ce buildrun delete (--name BUILDRUN_NAME | --build BUILD_NAME) [--force] [--ignore-not-found] [--quiet]
Opções de comando
--build,-b- Use esta opção para excluir todas as execuções de construção da construção especificada. A opção
--buildé obrigatória se você não especificar o valor--name. Este valor é opcional. --force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --name,-n- O nome da execução de compilação. A opção
--nameé obrigatória se você não especificar o valor--build. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce buildrun delete --name mybuildrun
Exemplo de saída
Are you sure you want to delete build run mybuildrun? [y/N]> y
Deleting build run 'mybuildrun'...
OK
ibmcloud ce buildrun events
Exiba os eventos do sistema de uma execução de compilação. Eventos do sistema são retidos por até 60 minutos.
ibmcloud ce buildrun events --buildrun BUILDRUN_NAME [--output OUTPUT] [--quiet]
Opções de comando
--buildrun,-b,--br,--name,-n- O nome da execução de compilação. Este valor é obrigatório.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
Este exemplo exibe as informações de evento do sistema para uma execução de compilação.
ibmcloud ce buildrun events --buildrun mybuildrun
Exemplo de saída
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
Exibir os detalhes de uma execução de construção.
ibmcloud ce buildrun get --name BUILDRUN_NAME [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- O nome da execução de compilação. Este valor é obrigatório.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce buildrun get --name mybuildrun
Exemplo de saída
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
Listar todas as execuções de construção em um projeto.
ibmcloud ce buildrun list [--build BUILD] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--build,-b- Use esta opção para exibir somente execuções somente a partir da construção especificada. Este valor é opcional.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce buildrun list
Exemplo de saída
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
Exibir os logs de uma execução de construção.
ibmcloud ce buildrun logs --buildrun BUILDRUN_NAME [--follow] [--output OUTPUT] [--quiet] [--raw] [--tail TAIL] [--timestamps]
Opções de comando
--buildrun,-b,--br,--name,-n- O nome da execução de compilação. Este valor é obrigatório.
--follow,-f- Siga os logs da execução de compilação. Use esta opção para logs de fluxo da execução de compilação. Se você especificar a opção
--follow, deverá inserirCtrl+Cpara finalizar este comando de log. Este valor é opcional. O valor padrão éfalse. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --raw,-r- Exibir logs sem os rótulos de instância e de contêiner. Este valor é opcional. O valor padrão é
false. --tail,-t- Limitar a exibição de logs de contêineres da execução de compilação especificada a um número máximo de linhas recentes por contêiner. Por exemplo, para exibir as últimas
3linhas dos logs dos contêineres da execução de compilação determinada, especifique--tail 3. Se esta opção não for especificada, todas as linhas dos logs dos contêineres da execução de construção especificada serão exibidas. Este valor é opcional. O valor padrão é-1. --timestamps,--ts- Incluir registros de data e hora em cada linha na saída de log. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce buildrun logs --name mybuildrun
Exemplo de saída
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
Enviar uma execução de compilação.
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]
Opções de comando
--build,-b,--bd- O nome da configuração de construção a ser usado. Este valor é opcional.
--commit,--cm,--revision- A confirmação, a tag ou a ramificação no repositório de origem para fazer pull. A opção build commit será permitida se a opção
--sourcefor definida como a URL de um repositório Git e não permitida se a opção--sourcenão for definida como a URL de um repositório Git. Este valor é opcional. --context-dir,--cdr- O diretório no repositório que contém o arquivo buildpacks ou o Dockerfile. A opção build context directory será permitida se a opção
--buildnão for definida e não permitida se a opção--buildfor definida. Este valor é opcional. --dockerfile,--df- O caminho para o Dockerfile. Especifique esta opção apenas se o nome for diferente de
Dockerfile. A opção build dockerfile será permitida se a opção--buildnão for definida e não permitida se a opção--buildfor definida. Este valor é opcional. O valor padrão éDockerfile. --git-repo-secret,--grs,--repo,-r- O nome do segredo SSH que contém as credenciais para acessar o repositório privado que contém o código-fonte para construir sua imagem de contêiner. Para criar esse segredo de SSH, use o comando
secret create --format SSHUm segredo de SSH também é utilizado como um segredo de acesso do repositório do Git Essa opção é permitida somente se a opção--build-sourceestiver definida como URL de um repositório Git. Este valor é opcional. --image,-i- O local do registro de imagem. O formato é
REGISTRY/NAMESPACE/REPOSITORY:TAGem queTAGé opcional. SeTAGnão for especificado, o padrão serálatest. Este valor é opcional. -n,--name- O nome da execução de compilação. Use um nome que seja exclusivo dentro do projeto. Se a opção
--buildfor definida, a opção name será opcional. Se a opção--buildnão for definida, a opção name será necessária.
- O nome deve iniciar e terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 63 caracteres ou menos e pode conter caracteres alfanuméricos minúsculos e hifens (-).
Este valor é opcional.
--no-wait,--nw- Envie a execução de compilação e não espere que ela seja concluída. Se você especificar a opção
--no-wait, o envio de execução de compilação será iniciado e não esperará. Use o comandobuildrun getpara verificar o status de execução da compilação. Este valor é opcional. O valor padrão étrue. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --registry-secret,--rs- O nome do segredo de registro. O segredo do registro é usado para autenticação com um registro privado quando você faz download da imagem de contêiner. A opção de segredo de registro é permitida se a
--buildopção não estiver definida e não é permitida se a--buildopção estiver definida. Este valor é opcional. --service-account,--sa- O nome da conta do serviço. Uma conta de serviço fornece uma identidade para processos que são executados em uma instância. Para contas de serviço integradas, é possível usar os nomes abreviados
manager,none,readerewriter. É possível também usar nomes completos que são prefixados com oKubernetes Config Context, que pode ser determinado com o comandoproject current. Este valor é opcional. --size,--sz- O tamanho para a compilação, que determina a quantia de recursos usados. Os valores válidos são
small,medium,large,xlargeexxlarge. Para obter detalhes, consulte Determinando o tamanho da construção. A opção de tamanho de compilação é permitida se a--buildopção não estiver definida e não é permitida se a--buildopção estiver definida. Este valor é opcional. O valor padrão émedium. --source,--src- A URL do repositório Git ou o caminho para origem local que contém o seu código-fonte; por exemplo
https://github.com/IBM/CodeEngineou.. Se a opção--buildfor definida, a opção source será necessária se a opção--build-typena construção relacionada forlocale não permitida se a opção--build-typena construção relacionada forgit. Se a opção--buildnão for definida, a opção source será opcional. Este valor é opcional. O valor padrão é.. --strategy,--str- A estratégia a ser usada para construir a imagem. Para aplicações e trabalhos, os valores válidos são
dockerfileebuildpacks. Para funções, os valores válidos têm o formatocodebundle-[RUNTIME-ID]. Por exemplo, se você desejar construir um pacote configurável de códigos para sua função com o ID de tempo de execuçãonodejs-20, usecodebundle-nodejs-20como a estratégia de construção É possível localizar o ID de qualquer tempo de execução das funções suportadas executando o comandoibmcloud ce fn runtimes. A opção de estratégia de compilação é permitida se a--buildopção não estiver definida e não é permitida se a--buildopção estiver definida. Se não for especificado, a estratégia de compilação é determinada por Code Engine se--sourcefor especificado e a fonte estiver em sua máquina local. Este valor é opcional. O valor padrão édockerfile. --timeout,--to- O período de tempo, em segundos, que pode passar antes que a execução de construção seja bem-sucedida ou falhe. Este valor é opcional. O valor padrão é
600. --wait,-w- Envie a execução de compilação e aguarde que ela seja concluída. Se você especificar a opção
--wait, o envio de execução de compilação irá esperar por um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para a execução de compilação ser concluída. Se a execução de compilação não for concluída no período--wait-timeoutespecificado, o envio dela falhará. Este valor é opcional. O valor padrão éfalse. --wait-timeout,--wto- O tempo de duração em segundos para esperar essa execução de compilação ser concluída. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é600.
Exemplo
O comando a seguir envia uma execução de compilação chamada mybuildrun e usa o arquivo de configuração de construção chamado helloworld-build.
ibmcloud ce buildrun submit --name mybuildrun --build helloworld-build
Exemplo de saída
Submitting build run 'mybuildrun'...
Run 'ibmcloud ce buildrun get -n mybuildrun' to check the build run status.
OK
Comandos do mapa de configuração
Um mapa de configuração fornece um método para incluir informações de dados não sensíveis em sua implementação. Ao referenciar valores do seu configmap como variáveis de ambiente, você pode separar informações específicas da sua implantação
e manter seu aplicativo, trabalho ou função portátil. Um mapa de configuração contém informações em pares chave-valor. Use os comandos configmap para criar, exibir detalhes, atualizar e excluir mapas de configuração.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos configmap.
Para obter mais informações sobre como trabalhar com configmaps, consulte Trabalhando com configmaps.
É possível usar configmap ou cm em seus comandos configmap. Para ver a ajuda da CLI para os comandos configmap, execute ibmcloud ce configmap -h.
ibmcloud ce configmap create
Crie um 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]
Opções de comando
-n,--name- O nome do mapa de configuração. Use um nome que seja exclusivo dentro do projeto.
- O nome deve iniciar e terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 253 caracteres ou menos e pode conter letras minúsculas, números, pontos (.) e hifens (-).
Este valor é obrigatório.
--from-env-file,-e- Criar um configmap por meio de um arquivo que contém uma ou mais linhas que correspondem ao formato
KEY=VALUE. Deve-se fornecer o caminho para o arquivo como um valor. Cada linha do arquivo especificado é incluída como um par chave-valor. Quaisquer linhas no arquivo especificado que estejam vazias ou começam com#serão ignoradas. Este valor será necessário se--from-literalou--from-filenão for especificado. --from-file,-f- Criar um configmap por meio de um arquivo. Deve-se fornecer o caminho para o arquivo como um valor. Este valor será necessário se
--from-literalou--from-env-filenão for especificado. --from-literal,-l- Criar um configmap por meio de um par chave-valor. Deve estar em formato
KEY=VALUE. Este valor será necessário se--from-fileou--from-env-filenão for especificado. Essa opção pode ser especificada múltiplas vezes. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
O exemplo a seguir cria um mapa de configuração denominado configmap-fromliteral com dois valores de par de chaves: color=blue e size=large.
ibmcloud ce configmap create --name configmap-fromliteral --from-literal color=blue --from-literal size=large
Exemplo de saída
Creating Configmap 'configmap-fromliteral'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromliteral' to see more details.
Exemplo de um configmap com valores de vários arquivos
O exemplo a seguir cria um mapa de configuração denominado configmap-fromfile com valores de diversos arquivos.
ibmcloud ce configmap create --name configmap-fromfile --from-file ./color.txt --from-file ./size.txt
Saída de exemplo de um configmap com valores de vários arquivos
Creating configmap 'configmap-fromfile'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromfile' to see more details.
ibmcloud ce configmap delete
Excluir um configmap.
ibmcloud ce configmap delete --name CONFIGMAP_NAME [--force] [--ignore-not-found] [--quiet]
Opções de comando
--name,-n- O nome do mapa de configuração. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce configmap delete --name configmap-fromliteral -f
Exemplo de saída
Deleting Configmap 'configmap-fromliteral'...
OK
ibmcloud ce configmap get
Exibir os detalhes de um mapa de configuração.
ibmcloud ce configmap get --name CONFIGMAP_NAME [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- O nome do mapa de configuração. Este valor é obrigatório.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce configmap get --name configmap-fromliteral
Exemplo de saída
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
Listar todos os mapas de configuração em um projeto.
ibmcloud ce configmap list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce configmap list
Exemplo de saída
Listing Configmaps...
Name Data Age
configmap-fromfile 2 19m13s
configmap-fromliteral 2 16m12s
ibmcloud ce configmap update
Atualizar um configmap.
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]
Opções de comando
--name,-n- O nome do mapa de configuração. Este valor é obrigatório.
--from-env-file,-e- Atualizar um configmap por meio de um arquivo que contém uma ou mais linhas que correspondem ao formato
KEY=VALUE. Deve-se fornecer o caminho para o arquivo como um valor. Cada linha do arquivo especificado é incluída como um par chave-valor. Quaisquer linhas no arquivo especificado que estejam vazias ou começam com#serão ignoradas. Este valor será necessário se--from-literalou--from-filenão for especificado. Essa opção pode ser especificada múltiplas vezes. --from-file,-f- Atualizar um mapa de configuração por meio de um arquivo. Deve-se fornecer o caminho para o arquivo como um valor. Este valor será necessário se
--from-literalou--from-env-filenão for especificado. Essa opção pode ser especificada múltiplas vezes. --from-literal,-l- Atualizar um configmap por meio de um par chave-valor. Deve estar em formato
KEY=VALUE. Este valor será necessário se--from-fileou--from-env-filenão for especificado. Essa opção pode ser especificada múltiplas vezes. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --rm- Remover um par chave-valor individual em um mapa de configuração especificando o nome da chave. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
Exemplo
O exemplo a seguir atualiza um mapa de configuração denominado configmap-fromliteral com um par de valores de nome do usuário e senha.
ibmcloud ce configmap update --name configmap-fromliteral --from-literal username=devuser --from-literal password='A!B99c$D1Def'
Exemplo de saída
Updating configmap 'configmap-fromliteral'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromliteral' to see more details.
Exemplo de um configmap com valores de um arquivo
O exemplo a seguir atualiza um mapa de configuração denominado configmap-fromfile com valores de um arquivo.
ibmcloud ce configmap update --name configmap-fromfile --from-file ./username.txt --from-file ./password.txt
Saída de exemplo de um configmap com valores de um arquivo
Updating configmap 'configmap-fromfile'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromfile' to see more details.
Comandos de conectividade
O recurso de IBM Cloud® Code Engine conectividade permite configurar vários aspectos de conectividade de rede das cargas de trabalho em seu Code Engine projeto.
- Defina pontos finais acessíveis especificando intervalos de endereços IP de destino permitidos para conexões de saída
- Conecte-se aos serviços IBM Cloud VPC Private Path.
- Defina referências de pool de sub-redes VPC, incluindo grupos de segurança, para configurar a localização de rede dos seus Code Engine funcionários da frota.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos connectivity.
É possível usar connectivity ou conn em seus comandos connectivity. Para ver a ajuda da CLI para os comandos connectivity, execute ibmcloud ce connectivity -h.
ibmcloud ce connectivity outbound
O recurso de conexões de saída IBM Cloud® Code Engine permite definir pontos de extremidade acessíveis para seus projetos Code Engine.
- Use intervalos de endereços IP de destino permitidos para conexões de saída na notação CIDR. Os destinos permitidos garantem que o tráfego de saída seja restrito aos endereços que você definir como seguros. Portanto, você evita o acesso indesejado à Internet e aumenta a conformidade e a segurança.
- Conecte seu Code Engine projeto aos serviçosIBM Cloud VPC Private Path usando o Code Engine console ou a CLI. O Private Path permite conexões entre um IBM Cloud serviço como o Code Engine e sua VPC sem comprometer a segurança ou colocar sua VPC em risco. Consulte Como habilitar um IBM Cloud serviço para se conectar à VPC de um provedor.
As especificações de intervalo CIDR não afetam a comunicação interna do projeto, as conexões de caminho privado ou as conexões de serviço privado, que são sempre destinos permitidos. Consequentemente, restringir o tráfego de saída com base em intervalos CIDR não impede que os aplicativos dentro do seu Code Engine projeto se comuniquem entre si, ou se comuniquem com um serviço de caminho privado conectado, ou com um endpoint privado de uma API IBM Cloud de serviço.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos connectivity outbound.
Para obter mais informações sobre como trabalhar com comandos de conectividade de saída, consulte Trabalho com conectividade de saída em Code Engine.
É possível usar connectivity outbound ou conn outbound em seus comandos connectivity outbound. Para ver a ajuda da CLI para os comandos connectivity outbound, execute ibmcloud ce connectivity outbound -h.
ibmcloud ce connectivity outbound COMMAND
ibmcloud ce connectivity outbound create
Crie um destino de saída permitido.
ibmcloud ce connectivity outbound create --name OUTBOUND_DESTINATION_NAME (--cidr CIDR_IP_ADDRESS | --pps-crn PPS_CRN) [--force] [--format FORMAT] [--quiet]
Opções de comando
--n,--cidr-name,--name- Obrigatório. Nome do destino de saída permitido. Este valor é obrigatório.
--cidr,-c- Forneça um intervalo de endereço IP válido no formato CIDR (por exemplo, 1.2.3.0/24). Este valor é opcional.
--force,-f- Force a criação sem confirmação. Este valor é opcional. O valor padrão é
false. --format,--fo- Formato do destino de saída permitido. Os valores válidos são [
cidr,cidr_block,pps,private_path_gateway_service] Se não for especificado, o padrão écidr. Este valor é opcional. O valor padrão écidr_block. --pps-crn,--private-path-service-crn- Forneça o CRN do serviço de caminho privado de destino ao qual se conectar. Este valor é opcional.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce connectivity outbound create --name allow-to-subnet-a --cidr 5.6.7.8/29
Exemplo de saída
Creating allowed destination IP address range 'allow-to-subnet-a'...
OK
Exemplo para criar uma conexão de saída de caminho privado
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
Exemplo de saída para criar uma conexão de saída de caminho privado
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
Excluir um destino de saída permitido.
ibmcloud ce connectivity outbound delete --name OUTBOUND_DESTINATION_NAME [--force] [--ignore-not-found] [--quiet]
Opções de comando
--n,--cidr-name,--name- Obrigatório. Nome do destino de saída permitido. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce connectivity outbound delete --name allow-to-subnet-a
Exemplo de saída
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
Exibir os detalhes de um destino de saída permitido.
ibmcloud ce connectivity outbound get --name OUTBOUND_DESTINATION_NAME [--output OUTPUT] [--quiet]
Opções de comando
--n,--cidr-name,--name- Obrigatório. Nome do destino de saída permitido. Este valor é obrigatório.
--output,-o- Formato de saída. Os valores válidos são "json", "yaml", "jsonpath=JSONPATH_EXPRESSION" e "jsonpath-as-json=JSONPATH_EXPRESSION". Este valor é opcional.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce connectivity outbound get --name allow-to-subnet-a
Exemplo de saída
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
Exemplo para obter uma conexão de saída de caminho privado
ibmcloud ce connectivity outbound get --name my-pps-connection
Exemplo de saída para obter uma conexão de saída de caminho privado
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
Lista todos os destinos de saída permitidos.
ibmcloud ce connectivity outbound list [--format FORMAT] [--output OUTPUT] [--quiet]
Opções de comando
--format- Limitar a exibição dos destinos de saída permitidos ao formato especificado. Forneça um ou mais formatos em uma lista delimitada por vírgulas. Os valores válidos são [
cidr,cidr_block,pps,private_path_gateway_service] Este valor é opcional. O valor padrão écidr_block,private_path_service_gateway. --output,-o- Formato de saída. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce connectivity outbound list
Exemplo de saída
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
Atualize um intervalo de endereços IP de destino de saída permitido.
ibmcloud ce connectivity outbound update --name OUTBOUND_DESTINATION_NAME --cidr CIDR_IP_ADDRESS [--force] [--quiet]
Opções de comando
--cidr,-c- Obrigatório. Forneça um intervalo de endereço IP válido no formato CIDR (por exemplo, 1.2.3.0/24). Este valor é obrigatório.
--n,--cidr-name,--name- Obrigatório. Nome do destino de saída permitido. Este valor é obrigatório.
--force,-f- Forçar atualização sem confirmação. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce connectivity outbound update --name allow-to-subnet-a --cidr 5.6.7.0/27
Exemplo de saída
Updating allowed destination IP address range 'allow-to-subnet-a'...
OK
ibmcloud ce connectivity subnetpool
O recurso de IBM Cloud® Code Engine conexões de pool de sub-redes oferece suporte ao gerenciamento de referências de pool de sub-redes VPC, incluindo grupos de segurança. Você cria um pool de sub-redes para especificar as sub-redes VPC e as
zonas de disponibilidade onde sua carga de trabalho será processada. Por exemplo, você pode criar um pool de sub-redes com uma única sub-rede na zona eu-de-1 ou um pool de sub-redes com várias sub-redes para abranger todas as
três zonas em eu-de. Além disso, você pode especificar o grupo de segurança ao qual sua carga de trabalho deve ser anexada. Um pool de sub-redes pode ser referenciado ao criar uma frota para especificar em qual zona de rede
os funcionários Code Engine da frota serão implantados.
IBM Cloud® Virtual Private Cloud (VPC) é uma rede virtual que está vinculada à sua conta do cliente. Ela fornece segurança em nuvem com a capacidade de escalar dinamicamente, fornecendo controle de baixa granularidade sobre a infraestrutura virtual e sua segmentação de tráfego de rede. As sub-redes na sua VPC oferecem conectividade privada. As sub-redes de seu VPC podem se conectar à Internet pública por meio de um gateway público opcional. Você pode manter sua VPC e suas cargas de trabalho seguras controlando o tráfego de rede usando grupos de segurança. Consulte Sobre redes e segurança na sua VPC para obter mais informações.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos connectivity subnetpool.
Para obter mais informações sobre como trabalhar com comandos de conectividade de sub-rede, consulte Trabalhando com conectividade de sub-rede em Code Engine.
É possível usar connectivity ou conn em seus comandos connectivity subnetpool. Para ver a ajuda da CLI para os connectivity subnetpool comandos, execute ibmcloud ce connectivity subnetpool -h.
ibmcloud ce connectivity subnetpool COMMAND
ibmcloud ce connectivity subnetpool create
Crie um conjunto de sub-redes.
ibmcloud ce connectivity subnetpool create [--name NAME] [--quiet] [--security-group-crn SECURITY_GROUP_CRN] [--subnet-crn SUBNET_CRN]
Opções de comando
--name,-n- Obrigatório. Nome do conjunto de sub-redes. Use um nome que seja exclusivo dentro do projeto. Este valor é obrigatório.
--subnet-crn,--crn- Forneça um crn de sub-rede válido para o pool. Deve estar no S1=crn:v1:example formato Este valor é obrigatório.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --security-group-crn,--sg-crn- Forneça um crn válido do grupo de segurança para o pool. Este valor é opcional.
Exemplo
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
Exemplo de saída
OK
Successfully created subnet pool with name 'my-other-pool' and ID 'a23ff1d1-b845-4629-86d1-a4126155ad02'
ibmcloud ce connectivity subnetpool delete
Excluir um pool de sub-redes.
ibmcloud ce connectivity subnetpool delete (--name SUBNET_POOL_NAME || --id SUBNET_POOL_ID) [--force] [--ignore-not-found] [--quiet]
Opções de comando
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --id- ID do conjunto de sub-redes. Este valor é opcional.
--ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --name,-n- Nome do conjunto de sub-redes. Este valor é opcional.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce connectivity subnetpool delete --name my-subnet-pool
Exemplo de saída
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
Exibir detalhes de um pool de sub-redes.
ibmcloud ce connectivity subnetpool get (--id SUBNET_POOL_ID || --name SUBNET_POOL_NAME) [--output OUTPUT] [--quiet]
Opções de comando
--id- ID do conjunto de sub-redes. Este valor é opcional.
--name,-n- Nome do conjunto de sub-redes. Este valor é opcional.
--output,-o- Formato de saída. Os valores válidos são "json", "yaml", "jsonpath=JSONPATH_EXPRESSION" e "jsonpath-as-json=JSONPATH_EXPRESSION". Este valor é opcional.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce connectivity subnetpool get --name my-subnet-pool
Exemplo de saída
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
Listar todos os conjuntos de sub-redes em um projeto.
ibmcloud ce connectivity subnetpool list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--output,-o- Formato de saída. Os valores válidos são "json", "yaml", "jsonpath=JSONPATH_EXPRESSION" e "jsonpath-as-json=JSONPATH_EXPRESSION". Este valor é opcional.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são “nome” e “idade”. Este valor é opcional. O valor padrão é
name.
Exemplo
ibmcloud ce connectivity subnetpool list
Exemplo de saída
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
Comandos Domainmapping
Os mapeamentos de domínio fornecem a URL rota para suas Code Engine aplicações dentro de um projeto. Com Code Engine, esses mapeamentos são criados automaticamente, por padrão, sempre que você implanta um aplicativo. No entanto, você pode mapear
seu próprio domínio personalizado para um Code Engine aplicativo para encaminhar solicitações do seu domínio personalizado URL para o seu aplicativo com Code Engine. Use domainmapping comandos para criar, exibir detalhes, atualizar
e excluir mapeamentos de domínio.
Ao configurar um mapeamento de domínio customizado em Code Engine, você define um mapeamento de 1-to-1 entre seu nome completo do domínio (FQDN) e um aplicativo Code Engine em seu projeto. Para configurar e trabalhar com mapeamentos de domínio
customizados na CLI, use os comandos domainmapping..
Deve-se estar dentro do contexto de um projeto antes de usar os comandos domainmapping.
Para obter mais informações sobre como trabalhar com mapeamentos de domínio, consulte Configurando mapeamentos de domínio customizados para seu app..
É possível usar domainmapping ou dm em seus comandos domainmapping. Para ver a ajuda da CLI para os comandos domainmapping, execute ibmcloud ce domainmapping -h.
ibmcloud ce domainmapping create
Crie um mapeamento de domínio customizado.
ibmcloud ce domainmapping create --domain-name DOMAIN_NAME [--target-type TARGET_TYPE] --tls-secret SECRET_NAME [--quiet]
Opções de comando
--domain-name,--dn,-n,--name- Especifique o nome do mapeamento do domínio. Esse nome deve ser um nome completo do domínio (FQDN) válido. Por exemplo,
www.example.com. Este valor é obrigatório. --target,-t- O nome do aplicativo ou função de destino. Este valor é obrigatório.
--target-type,--type- O tipo do destino. Os valores válidos são
applicationoufunction. Este valor é obrigatório. --tls-secret,--secret,--tls- Especifique um segredo TLS que contenha o certificado, incluindo todos os seus certificados intermediários e a chave privada correspondente para o mapeamento de domínio. O certificado deve ser assinado por uma autoridade de certificação (CA) confiável e pública. Os certificados autoassinados não são suportados. Este valor é obrigatório.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
O exemplo a seguir cria um mapeamento de domínio customizado entre o aplicativo Code Engine myapp e o domínio customizado www.example.com e usa o segredo TLS, mytlssecret.
ibmcloud ce domainmapping create --domain-name www.example.com --target myapp --tls-secret mytlssecret
Exemplo de saída
OK
Domain mapping successfully created.
ibmcloud ce domainmapping delete
Exclua um mapeamento de domínio customizado.
ibmcloud ce domainmapping delete --domain-name DOMAIN_NAME [--force] [--ignore-not-found] [--quiet]
Opções de comando
--domain-name,--dn,-n,--name- O nome do mapeamento de domínio. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce domainmapping delete --name www.example.com -f
Exemplo de saída
Deleting domain mapping 'www.example.com'...
OK
ibmcloud ce domainmapping get
Exiba os detalhes de um mapeamento de domínio customizado.
ibmcloud ce domainmapping get --domain-name DOMAIN_NAME [--output OUTPUT] [--quiet]
Opções de comando
--domain-name,--dn,-n,--name- O nome do mapeamento de domínio Este valor é necessário.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce domainmapping get --name www.example.com
Exemplo de saída
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
Listar os mapeamentos de domínio em um projeto.
ibmcloud ce domainmapping list [--all] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--all,-a- Exiba todos os mapeamentos de domínio em um projeto, incluindo mapeamentos de domínio customizados e do sistema. Este valor é opcional. O valor padrão é
false. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
O exemplo a seguir exibe uma listagem de todos os mapeamentos de domínio customizados
ibmcloud ce domainmapping list
Exemplo de saída
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
Para visualizar uma listagem de todos os mapeamentos de domínio para seus aplicativos, incluindo os mapeamentos de domínio customizados e quaisquer mapeamentos de domínio do sistema gerados automaticamente, especifique a opção --all com o comando ibmcloud ce domainmapping list
ibmcloud ce domainmapping update
Atualize um mapeamento de domínio customizado.
ibmcloud ce domainmapping update --domain-name DOMAIN_NAME --target TARGET_NAME --tls-secret SECRET_NAME [--quiet] [--target-type TARGET_TYPE]
Opções de comando
--domain-name,--dn,-n,--name- O nome do mapeamento de domínio. Este valor é obrigatório.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --target,-t- O nome do aplicativo ou função de destino. Este valor é opcional.
--target-type,--type- O tipo do destino. Os valores válidos são
applicationoufunction. Este valor é opcional. --tls-secret,--secret,--tls- Especifique um segredo TLS que contenha o certificado, incluindo todos os seus certificados intermediários e a chave privada correspondente para o mapeamento de domínio. O certificado deve ser assinado por uma autoridade de certificação (CA) confiável e pública. Os certificados autoassinados não são suportados. Este valor é opcional.
Exemplo
O exemplo a seguir atualiza o mapeamento de domínio do www.example.com para usar mytlssecret2 em vez de mytlssecret
ibmcloud ce domainmapping update --domain-name www.example.com --tls-secret mytlssecret2
Exemplo de saída
Updating domainmapping 'www.example.com'...
Comando experimental
Code Engine Os comandos experimentais geralmente não estão disponíveis. Esse grupo de comandos fornece acesso a possíveis recursos futuros para facilitar a exploração por usuários iniciais selecionados.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos experimental.
É possível usar experimental ou exp em seus comandos experimental. Para ver a ajuda da CLI para os comandos experimental, execute ibmcloud ce exp -h.
ibmcloud ce experimental
Code Engine Os comandos experimentais geralmente não estão disponíveis. Esse grupo de comandos fornece acesso a possíveis recursos futuros para facilitar a exploração por usuários iniciais selecionados.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos experimental.
É possível usar experimental ou exp em seus comandos experimental. Para ver a ajuda da CLI para os comandos experimental, execute ibmcloud ce exp -h.
ibmcloud ce experimental COMMAND
Exemplo
ibmcloud ce experimental help
Exemplo de saída
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.
Comandos da frota
Gerencie frotas sem servidor.
ibmcloud ce fleet cancel
Cancelar uma frota sem servidor.
ibmcloud ce fleet cancel --id FLEET_ID [--force] [--hard] [--quiet]
Opções de comando
--id,--fid,--fleet-id- Obrigatório. A identificação da frota sem servidor. Este valor é obrigatório.
--force,-f- Forçar o cancelamento sem confirmação. Este valor é opcional. O valor padrão é
false. --hard- Cancelar imediatamente a frota sem servidor, incluindo tarefas no estado
running. Se você não especificar a opçãohard, o processamento das tarefas no estadorunningcontinuará até que elas atinjam um estado final e, somente então, a frota passará para o estadocanceled. Este valor é opcional. O valor padrão éfalse. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce fleet cancel --force --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Exemplo de saída
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
Ative uma frota sem servidor.
ibmcloud ce fleet create [--argument ARGUMENT] [--command COMMAND] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--gpu GPU] [--image IMAGE] [--max-scale MAX_SCALE] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mount-data-store MOUNT_DATA_STORE] [--name NAME] [--quiet] [--registry-secret REGISTRY_SECRET] [--retrylimit RETRYLIMIT] [--subnetpool-id SUBNETPOOL_ID] [--subnetpool-name SUBNETPOOL_NAME] [--task-indexes TASK_INDEXES] [--tasks TASKS] [--tasks-from-cos-bucket TASKS_FROM_COS_BUCKET] [--tasks-from-cos-object TASKS_FROM_COS_OBJECT] [--tasks-from-local-file TASKS_FROM_LOCAL_FILE] [--tasks-state-store TASKS_STATE_STORE] [--worker-profile WORKER_PROFILE]
Opções de comando
--image,-i- Obrigatório. O nome da imagem do contêiner usada para processar as tarefas. O formato é
REGISTRY/NAMESPACE/REPOSITORY:TAGem queREGISTRYeTAGsão opcionais. SeREGISTRYnão for especificado, o padrão serádocker.io. SeTAGnão for especificado, o padrão serálatest. Este valor é obrigatório. --tasks-state-store,--ts-state- Obrigatório. Especifique o armazenamento de dados persistente que armazena o estado das tarefas da frota. Este valor é obrigatório.
--argument,--arg,-a- Define os argumentos de comando necessários para que o comando seja executado na tarefa. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--command,--cmd,-c- Definir um comando a ser executado na tarefa. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--cpu,--cp- A quantidade de CPU a ser definida para uma tarefa. Este valor é opcional. O valor padrão é
1. --env,-e- Definir variáveis de ambiente a serem passadas para a tarefa. Deve estar no formato NAME=VALUE Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--env-from-configmap,--env-cm- Defina variáveis de ambiente a partir dos pares chave-valor armazenados neste configmap. Forneça NAME para referenciar o configmap completo, PREFIX=NAME para referenciar o configmap completo no qual cada chave é prefixada com PREFIX ou NAME:KEY_A,KEY_B para referenciar chaves individuais. Para especificar um novo nome para uma chave referenciada, use o formato NAME:NEW_KEY_NAME=KEY_A. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--env-from-secret,--env-sec- Defina variáveis de ambiente a partir dos pares chave-valor armazenados neste segredo. Forneça NAME para referenciar o segredo completo, PREFIX=NAME para referenciar o segredo completo no qual cada chave é prefixada com PREFIX, ou NAME:KEY_A,KEY_B para referenciar chaves individuais. Para especificar um novo nome para uma chave referenciada, use o formato NAME:NEW_KEY_NAME=KEY_A. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--gpu,--gp- O número de GPUs a serem alocadas para o recurso. O formato é GPU_FAMILY:NUMBER_OF_GPUS. O NUMBER_OF_GPUS terá como padrão 1 e pode ser uma fração. Por exemplo,
h100:0.5Esse valor é opcional. --max-scale,--maxscale,--max- Número máximo de instâncias de tarefas a serem executadas em paralelo. Este valor é opcional. O valor padrão é
1. --maxexecutiontime,--met- O tempo máximo de execução em segundos para a execução de uma tarefa. Este valor é opcional. O valor padrão é
0. --memory,-m- A quantidade de memória a ser definida para uma tarefa. Use
Mpara megabytes ouGpara gigabytes. Este valor é opcional. O valor padrão é2G. --mount-data-store,--mount-ds- Monte um armazenamento de dados persistente. O formato é MOUNT_DIRECTORY=STORAGE_NAME: [SUBPATH]. O SUBPATH é opcional. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--name,-n- O nome da frota. Este valor é opcional.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --registry-secret,--rs- O nome do segredo de registro. O segredo do registro é usado para autenticação com um registro privado para fazer download da imagem do contêiner. Execute
ibmcloud ce registry createpara criar um segredo de registro. Este valor é opcional. --retrylimit,-r- O número de vezes que uma tarefa deve ser executada novamente antes de ser marcada como falha. Este valor é opcional. O valor padrão é
3. --subnetpool-id,--spi- A identificação do conjunto de sub-redes a ser usado para a colocação da rede da frota. Este valor é opcional.
--subnetpool-name,--spn- O nome do conjunto de sub-redes a ser usado para a colocação da rede da frota. Este valor é opcional.
--task-indexes,--ti- Especifique os índices de tarefas que devem ser processados, por exemplo,
0,3,6,9,1-5,7-8,10. Especifique não mais do que 1.000 entradas de índice. Esta opção não pode ser especificada se--tasksfor especificada. Este valor é opcional. --tasks,--ts- Especifique o número de tarefas que devem ser processadas pela frota. Este valor é opcional. O valor padrão é
0. --tasks-from-cos-bucket,--ts-bucket- Especifique um local de arquivos dentro de um bucket COS. Para cada arquivo, as tarefas devem ser processadas pela frota. Este valor é opcional.
--tasks-from-cos-object,--ts-cos- Especifique um local de arquivo JSONL que reside em um bucket COS. O arquivo define as tarefas que devem ser processadas pela frota. Este valor é opcional.
--tasks-from-local-file,--ts-file- Especifique um local de arquivo JSONL local. O arquivo define as tarefas que devem ser processadas pela frota. Este valor é opcional.
--worker-profile,--profile,--prof- Forneça uma preferência de perfil de trabalhador com suporte. Este valor é opcional.
Exemplo
ibmcloud ce fleet create --image icr.io/codeengine/helloworld --tasks-state-store mytaskstore --tasks 1
Exemplo de saída
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
Excluir uma frota sem servidor.
ibmcloud ce fleet delete --id FLEET_ID [--force] [--ignore-not-found] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
--id,--fid,--fleet-id- Obrigatório. A identificação da frota sem servidor. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --wait,-w- Exclua a frota sem servidor e aguarde até que ela seja excluída. Este valor é opcional. O valor padrão é
false. --wait-timeout,--wto- O tempo em segundos para aguardar a exclusão da frota sem servidor. Este valor é opcional. O valor padrão é
180.
Exemplo
ibmcloud ce fleet delete --force --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Exemplo de saída
Deleting serverless fleet...
OK
ibmcloud ce fleet get
Exiba detalhes de uma frota sem servidor.
ibmcloud ce fleet get --id FLEET_ID [--output OUTPUT] [--quiet]
Opções de comando
--id,--fid,--fleet-id- Obrigatório. A identificação da frota sem servidor. Este valor é obrigatório.
--output,-o- Formato de saída. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce fleet get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Exemplo de saída
Getting fleet '1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e'...
OK
Name: fleet-0123456789
ID: 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Status: running
Created: 2025-09-26T10:46:02Z
Project region: eu-de
Project name: myproj
Tasks status:
Pending: 893
Running: 12
Failed: 0
Canceled: 0
Successful: 96
Total: 1001
Code:
Container image reference: icr.io/codeengine/helloworld
Tasks specification:
Task state store: mytaskstore
Indexes: 0-1000
Resources and scaling:
CPU per instance: 1
Memory per instance: 2G
Max number of instances: 12
Max retries per task: 3
Network placement:
Subnet CRN 0: crn:v1:bluemix:public:is:eu-de-1:a/abcdefabcdefabcdefabcd1234567890::subnet:1a1a-2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
ibmcloud ce fleet list
Liste todas as frotas sem servidor em um projeto.
ibmcloud ce fleet list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--output,-o- Formato de saída. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
name,statuseage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce fleet list
Exemplo de saída
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
Gerencie tarefas de frota sem servidor.
ibmcloud ce fleet task COMMAND [--quiet]
Opções de comando
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
ibmcloud ce fleet task get
Exiba detalhes de uma tarefa de frota sem servidor.
ibmcloud ce fleet task get --task-id TASK_ID --fleet-id FLEET_ID [--output OUTPUT] [--quiet]
Opções de comando
--fleet-id,--fid- Obrigatório. O UUID da frota à qual a tarefa pertence. Este valor é obrigatório.
--task-id,--tid,--id- Obrigatório. O UUID da tarefa. Este valor é obrigatório.
--output,-o- Formato de saída. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce fleet task get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e --task-id 2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f
Exemplo de saída
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
Liste todas as tarefas de uma frota sem servidor.
ibmcloud ce fleet task list --fleet-id FLEET_ID [--output OUTPUT] [--pagination-token PAGINATION_TOKEN] [--quiet] [--sort-by SORT_BY] [--status STATUS]
Opções de comando
--fleet-id,--fid- Obrigatório. O UUID da frota à qual as tarefas pertencem. Este valor é obrigatório.
--output,-o- Formato de saída. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Este valor é opcional. --pagination-token,--pt- Mostrar a próxima página de tarefas que começam com esse token de paginação. Este valor é opcional.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,--sb- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
id,indexestatus. Este valor é opcional. O valor padrão éindex. --status,--st- Mostra as tarefas que têm o status especificado. Os valores válidos são
failed,canceled,pending, erunningsuccessful. Este valor é opcional.
Exemplo
ibmcloud ce fleet task list --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Exemplo de saída
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
Gerencie trabalhadores de frota sem servidor.
ibmcloud ce fleet worker COMMAND [--quiet]
Opções de comando
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
ibmcloud ce fleet worker delete
Excluir um trabalhador de frota sem servidor.
ibmcloud ce fleet worker delete --name WORKER_NAME --fleet-id FLEET_ID [--force] [--hard] [--ignore-not-found] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
--fleet-id,--fid- Obrigatório. A ID da frota à qual o funcionário pertence. Este valor é obrigatório.
--name,-n,--worker-name- Obrigatório. O nome do trabalhador de frota sem servidor. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --hard- Exclua imediatamente o fleet worker sem servidor. Se você não especificar a opção "hard", o tratamento das tarefas "em execução" processadas por esse trabalhador continuará até que essas tarefas atinjam um estado final
e só então o trabalhador será excluído. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --wait,-w- Exclua o trabalhador de frota sem servidor e aguarde a exclusão do trabalhador. Este valor é opcional. O valor padrão é
false. --wait-timeout,--wto- O tempo de espera em segundos para que o trabalhador de frota sem servidor seja excluído. Este valor é opcional. O valor padrão é
180.
Exemplo
ibmcloud ce fleet worker delete --force --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e --worker-name fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-42
Exemplo de saída
Deleting serverless fleet worker...
OK
ibmcloud ce fleet worker get
Exiba detalhes de um trabalhador de frota sem servidor.
ibmcloud ce fleet worker get --name WORKER_NAME --fleet-id FLEET_ID [--output OUTPUT] [--quiet]
Opções de comando
--fleet-id,--fid- Obrigatório. A ID da frota à qual o funcionário pertence. Este valor é obrigatório.
--name,-n,--worker-name- Obrigatório. O nome do trabalhador de frota sem servidor. Este valor é obrigatório.
--output,-o- Formato de saída. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce fleet worker get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e --worker-name fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-42
Exemplo de saída
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
Lista todos os trabalhadores de uma frota sem servidor.
ibmcloud ce fleet worker list --fleet-id FLEET_ID [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--fleet-id,--fid,--id- Obrigatório. A ID da frota à qual o funcionário pertence. Este valor é obrigatório.
--output,-o- Formato de saída. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameestatus. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce fleet worker list --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e
Exemplo de saída
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
Comandos de função
Uma função é um trecho de código sem estado que executa tarefas conforme é invocado por HTTP solicitações. Com IBMCode Engine as funções, você pode executar sua lógica de negócios de maneira escalável e sem servidor. Code EngineIBM As funções fornecem um ambiente de tempo de execução otimizado para oferecer suporte a cenários de baixa latência e rápida expansão. Seu código de função pode ser escrito em um tempo de execução gerenciado que inclui versões específicas Node.jsPython ou.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos function.
Para obter mais informações sobre como trabalhar com Funções, consulte Trabalhando com Funções.
ibmcloud ce function bind
Vincule uma instância IBM Cloud de serviço a uma função.
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]
Opções de comando
--name,-n- O nome da função a ser ligada. Este valor é obrigatório.
--no-wait,--nw- Ligue a instância de serviço e não espere a ligação de serviços estar pronta. Se você especificar a opção
no-wait, a criação da ligação de serviços será iniciada e o comando sairá sem esperar a conclusão dela. Use ofunction getcomando para verificar o status da ligação da função. Este valor é opcional. O valor padrão éfalse. --prefix,-p- Um prefixo para variáveis de ambiente que são criadas para esta ligação de serviços. Deve conter apenas letras maiúsculas, números e sublinhados (_) e não pode iniciar com um número. Este valor é opcional.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --role,-r- O nome de uma função de serviço para a nova credencial de serviço que é criada para essa ligação de serviços. Os valores válidos incluem
Reader,Writer,Managerou uma atribuição específica de serviço. A opção é padronizada paraManagerou a primeira função fornecida pelo serviço seManagernão for suportado. Essa opção será ignorada se--service-credentialfor especificado. Este valor é opcional. --service-credential,--sc- O nome de uma credencial de serviço existente para usar para esta ligação de serviços. Se você não especificar uma credencial de instância de serviço, novas credenciais serão geradas durante a ação de ligação. Este valor é opcional.
--service-instance,--si- O nome de uma instância de serviço IBM Cloud existente a ser vinculada à função. Este valor é opcional.
--service-instance-id,--siid- O GUID de uma instância de serviço IBM Cloud existente a ser vinculada à função. Este valor é opcional.
--wait,-w- Ligue a instância de serviço e aguarde a ligação de serviços estar pronta. Se você especificar a
--waitopção, a função bind aguardará um tempo máximo em segundos, conforme definido pela--wait-timeoutopção, para que a função bind seja concluída com sucesso. Se a função bind não for concluída com sucesso ou falhar dentro do período--wait-timeoutespecificado, o comando falhará. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- A duração de tempo em segundos para esperar a ligação de serviços ficar pronta. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é300.
Exemplo
ibmcloud ce fn bind --name myfunction --service-instance my-object-storage
Exemplo de saída
Binding service instance...
Status: Done
OK
ibmcloud ce function create
Crie uma função.
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]
Opções de comando
-n,--name- O nome da função. Use um nome que seja exclusivo dentro do projeto.
- O nome deve iniciar com uma letra minúscula.
- O nome deve terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 63 caracteres ou menos e pode conter letras minúsculas, números e hifens (-).
Este valor é obrigatório.
--runtime,-r- O tempo de execução para usar para a função. Para localizar os tempos de execução suportados para essa região, execute
ibmcloud ce function runtimesConsulte Runtimes. Este valor é obrigatório. --build-commit,--commit,--bcm,--cm,--revision- A confirmação, a tag ou a ramificação no repositório de origem para fazer pull. Este valor é opcional.
--build-context-dir,--context-dir,--bcdr,--cdr- O diretório no repositório que contém o código-fonte para sua função. Este valor é opcional.
--build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- O nome do segredo do SSH, que contém as credenciais para acessar o repositório privado que contém o código-fonte para construir a imagem do pacote configurável de códigos. Para criar esse segredo de SSH, use o comando
secret create --format SSHUm segredo de SSH também é utilizado como um segredo de acesso do repositório do Git Essa opção é permitida somente se a opção--build-sourceestiver definida como URL de um repositório Git. Este valor é opcional. --build-source,--source,--bsrc,--src- A URL do repositório Git ou o caminho para origem local que contém o seu código-fonte; por exemplo
https://github.com/IBM/CodeEngineou.. Este valor é opcional. --build-timeout,--bto- A quantia de tempo, em segundos, que pode transcorrer antes da compilação deve ser aprovada ou reprovada. Este valor é opcional. O valor padrão é
600. --code-bundle,--cb- O nome da imagem
code-bundlea ser usada para essa função. Quandobuild-sourceé especificado, esse valor é o caminho para a imagem de saída gerada pelo push de compilação. Quando nãobuild-sourceé especificado, este valor é o caminho para a imagem do pacote de código existente. O formato éREGISTRY/NAMESPACE/REPOSITORY:TAGem queTAGé opcional. SeTAGnão for especificado, o padrão serálatest. Este valor é opcional. --code-bundle-secret,--cs,--cbs- O nome do segredo de registro usado para autenticar com um registro privado. Você pode adicionar o segredo do registro executando o
registry createcomando. Este valor é opcional. --cpu- A quantia de CPU configurada para a instância da função. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. O valor padrão
é
1. --env,-e- Configurar variáveis de ambiente na função. Deve estar em formato
NAME=VALUE. Esta ação inclui uma nova variável de ambiente ou substitui uma variável de ambiente existente. Especifique uma variável de ambiente por opção--env; por exemplo,--env envA=A --env envB=B. Este valor é opcional. --env-cm,--env-from-configmap- Defina variáveis de ambiente a partir dos pares chave-valor armazenados neste configmap usando uma das seguintes maneiras.
- Para incluir variáveis de ambiente para todas as chaves em um mapa de configuração que é denominado
configmapName, use o valorconfigmapName. É possível modificar os nomes de variável de ambiente especificando um prefixo ao referenciar o configmap. Para especificar um prefixo, use o valorPREFIX=CONFIGMAP_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no configmapconfigmapNamecomoCUSTOM_, use o valorCUSTOM_=configmapName. Se o configmapconfigmapNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um mapa de configuração que é denominadoconfigmapName, use o valorconfigmapName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma única chavekey1em um configmap que é denominadoconfigmapName, use o valorconfigmapName:myKey=key1.
Este valor é opcional.
--env-sec,--env-from-secret- Defina variáveis de ambiente a partir dos pares chave-valor armazenados em um segredo usando uma das seguintes maneiras.
- Para incluir variáveis de ambiente para todas as chaves em um segredo que é denominado
secretName, use o valorsecretName. É possível modificar os nomes de variáveis de ambiente especificando um prefixo ao referenciar o segredo. Para especificar um prefixo, use o valorPREFIX=SECRET_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_SECRET>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no segredosecretNamecomoCUSTOM_, use o valorCUSTOM_=secretName. Se o segredosecretNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um segredo que é denominadosecretName, use o valorsecretName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma chave únicakey1em um segredo que é denominadosecretName, use o valorsecretName:myKey=key1.
Este valor é opcional.
--force,-f- Não verifique a existência de referências especificadas de configmap e segredos. Este valor é opcional. O valor padrão é
false. --inline-code- Especifique o caminho para um arquivo que contenha o código-fonte da sua função. O código é armazenado em linha com a função. Este valor é opcional.
--main,--fn-main- Especifique o nome de sua função principal no código-fonte fornecido. Essa opção será necessária quando o nome não for
mainEste valor é opcional. O valor padrão émain. --maxexecutiontime,--met- A quantidade máxima de tempo, em segundos, para que essa função conclua sua execução. Este valor é opcional. O valor padrão é
60. --memory,-m- A quantidade de memória definida para a função. Use
Mpara megabytes ouGpara gigabytes. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. O valor padrão é4G. --no-wait,--nw- Não esperar a conclusão da execução de compilação. Este valor é opcional. O valor padrão é
false. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --scale-down-delay,--sdd- O tempo em segundos que uma instância fica ativa após a conclusão de uma chamada. Essa opção pode reduzir o tempo de cold start. Para obter mais informações, consulte Posso manter minha instância de função ativa por mais tempo?.
Este valor é opcional. O valor padrão é
1. --trusted-profiles-enabled,--trusted,--tpe- Ative a montagem de um token de recurso de computação para execuções da função. Este valor é opcional. O valor padrão é
false. --visibility,-v- A visibilidade da função. Os valores válidos são
public,private, eproject. A visibilidade só pode ser definidaprivatese o projeto suportar a visibilidade privada da função. Este valor é opcional. O valor padrão épublic. --wait,-w- Esperar a conclusão da execução de compilação. Este valor é opcional. O valor padrão é
true. --wait-timeout,--wto- O tempo em segundos para aguardar que a função esteja pronta. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é600.
Exemplo
ibmcloud ce fn create --name myfunction --build-source main.js --runtime nodejs
Exemplo de saída
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
Quando você executa ibmcloud ce fn get -n 'myfunction' para verificar o status da função, o URL da sua função é exibido.
ibmcloud ce function delete
Exclua uma função.
ibmcloud ce function delete --name FUNCTION_NAME [--force] [--ignore-not-found] [--quiet]
Opções de comando
--name,-n- O nome da função. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce fn delete --name myfunction
Exemplo de saída
Are you sure you want to delete function 'myfunction'? [y/N]> y
Deleting function 'myfunction'...
OK
ibmcloud ce function get
Exiba os detalhes de uma função.
ibmcloud ce function get --name FUNCTION_NAME [--output OUTPUT] [--quiet] [--save SAVE]
Opções de comando
--name,-n- O nome da função. Este valor é obrigatório.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --save,-s- Salve o código-fonte da função no sistema de arquivos local. Essa opção é suportada apenas para funções que foram criadas com o código sequencial Este valor é opcional.
Exemplo
ibmcloud ce fn get --name myfunction
Exemplo de saída
Getting function 'myfunction'...
OK
Name: myfunction
Project Name: myproject
Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111
Age: 6m8s
Created: 2023-06-22T19:59:51Z
URL: https://myfunction.11c22def3rhz.us-south.codeengine.appdomain.cloud
Status: Ready
Resources:
CPU: 0.25
Memory: 500M
Max Execution Time: 60 seconds
Build Information:
Build Run Name: myfunction-run-111111-12345678
Build Type: local
Build Strategy: codebundle-nodejs-20
Timeout: 600
Source: main.js
Build Run Summary: Succeeded
Build Run Status: Succeeded
Build Run Reason: All Steps have completed executing
Run 'ibmcloud ce buildrun get -n myfunction-run-111111-12345678' for details.
Function Code:
Runtime: nodejs-20 (managed)
Bundle Secret: ce-auto-icr-private-us-south
Code Bundle: cr://icr.io/ce--1a1a1-11c22def3rhz/function-myfunction:12345678-1111-dexla
Main: main()
ibmcloud ce function list
Listar todas as funções em um projeto.
ibmcloud ce function list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce fn delete --name myfunction
Exemplo de saída
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
Liste os tempos de execução da função disponíveis.
ibmcloud ce function runtimes [--all] [--output OUTPUT] [--quiet]
Opções de comando
--all,-A- Exiba todos os tempos de execução, incluindo tempos de execução descontinuados. Este valor é opcional. O valor padrão é
false. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce fn runtimes
Exemplo de saída
Name ID Family Default
Python 3.11 python-3.11 python true
Node.js 20 nodejs-20 nodejs true
Node.js 22 nodejs-22 nodejs false
Python 3.13 python-3.13 python false
ibmcloud ce function unbind
Desvincule IBM Cloud instâncias de serviço de uma função.
ibmcloud ce function unbind --name FUNCTION_NAME (--binding BINDING_NAME | --all) [--quiet]
Opções de comando
--name,-n- O nome da função a ser desvinculada. Este valor é obrigatório.
--all,-A- Desvincula todas as instâncias de serviço para essa função. Este valor será necessário se
--bindingnão for especificado. O valor padrão éfalse. --binding,-b- O nome da ligação a ser desvinculada. Execute
ibmcloud ce function get -n FUNCTION_NAMEpara visualizar nomes de ligação. Este valor será necessário se--allnão for especificado. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce fn unbind --name myfunction --all
Exemplo de saída
Removing bindings from 'myfunction'...
OK
ibmcloud ce function update
Atualize uma função.
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]
Opções de comando
--name,-n- Obrigatório. O nome da função. Este valor é obrigatório.
--build-clear,--bc- Remova a associação de uma compilação desta função. A opção “limpar compilação” só é permitida se sua função tiver uma compilação associada no momento. Este valor é opcional. O valor padrão é
false. --build-commit,--commit,--bcm,--cm,--revision- A confirmação, a tag ou a ramificação no repositório de origem para fazer pull. Este valor é opcional.
--build-commit-clear,--commit-clear,--bcmc,--cmc- Limpe a confirmação, tag ou ramificação no repositório de origem para fazer pull. A opção de limpeza de confirmação será permitida apenas se sua função tiver atualmente uma construção associada. Este valor é opcional. O valor
padrão é
false. --build-context-dir,--context-dir,--bcdr,--cdr- O diretório no repositório que contém o código-fonte para sua função. Essa opção será permitida apenas se a opção
--build-sourceestiver configurada Este valor é opcional. --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- O nome do segredo SSH que contém as credenciais para acessar o repositório privado que contém o código-fonte para construir sua imagem. Este valor é opcional.
--build-git-repo-secret-clear,--git-repo-secret-clear,--bgrsc,--grsc- Limpar o segredo do SSH. Essa opção será permitida apenas se sua função tiver atualmente uma construção associada. Este valor é opcional. O valor padrão é
false. --build-source,--source,--bsrc,--src- A URL do repositório Git ou o caminho para origem local que contém o seu código-fonte; por exemplo
https://github.com/IBM/CodeEngineou.. Este valor é opcional. --build-timeout,--bto- A quantia de tempo, em segundos, que pode transcorrer antes da compilação deve ser aprovada ou reprovada. Este valor é opcional. O valor padrão é
600. --code-bundle,--cb- O nome da imagem
code-bundlea ser usada para essa função. Quandobuild-sourceé especificado, esse valor é o caminho para a imagem de saída gerada pelo push de compilação. Quando nãobuild-sourceé especificado, este valor é o caminho para a imagem do pacote de código existente. O formato éREGISTRY/NAMESPACE/REPOSITORY:TAGem queTAGé opcional. SeTAGnão for especificado, o padrão serálatest. Este valor é opcional. --code-bundle-secret,--cs,--cbs- O nome do segredo de registro usado para autenticar com um registro privado. Você pode adicionar o segredo do registro executando o
registry createcomando. Este valor é opcional. --cpu- A quantia de CPU configurada para a instância da função. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. O valor padrão
é
1. --env,-e- Configurar variáveis de ambiente na função. Deve estar em formato
NAME=VALUE. Esta ação inclui uma nova variável de ambiente ou substitui uma variável de ambiente existente. Especifique uma variável de ambiente por opção--env; por exemplo,--env envA=A --env envB=B. Este valor é opcional. --env-cm,--env-from-configmap- Configure variáveis de ambiente por meio dos pares chave-valor que são armazenados neste configmap usando uma das maneiras a seguir:
- Para incluir variáveis de ambiente para todas as chaves em um mapa de configuração que é denominado
configmapName, use o valorconfigmapName. É possível modificar os nomes de variável de ambiente especificando um prefixo ao referenciar o configmap. Para especificar um prefixo, use o valorPREFIX=CONFIGMAP_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no configmapconfigmapNamecomoCUSTOM_, use o valorCUSTOM_=configmapName. Se o configmapconfigmapNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um mapa de configuração que é denominadoconfigmapName, use o valorconfigmapName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma única chavekey1em um configmap que é denominadoconfigmapName, use o valorconfigmapName:myKey=key1.
Este valor é opcional.
--env-from-configmap-rm,--env-cm-rm- Remova referências de variável de ambiente para configmaps integrais usando o nome do configmap. Para remover referências de chave individual a mapas de configuração, use a opção
--env-rm. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional. --env-sec,--env-from-secret- Defina variáveis de ambiente a partir dos pares chave-valor armazenados em um segredo usando uma das seguintes maneiras:
- Para incluir variáveis de ambiente para todas as chaves em um segredo que é denominado
secretName, use o valorsecretName. É possível modificar os nomes de variáveis de ambiente especificando um prefixo ao referenciar o segredo. Para especificar um prefixo, use o valorPREFIX=SECRET_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_SECRET>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no segredosecretNamecomoCUSTOM_, use o valorCUSTOM_=secretName. Se o segredosecretNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um segredo que é denominadosecretName, use o valorsecretName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma chave únicakey1em um segredo que é denominadosecretName, use o valorsecretName:myKey=key1.
Este valor é opcional.
--env-from-secret-rm,--env-sec-rm- Remova referências de variável de ambiente para segredos integrais usando o nome do segredo. Para remover referências de chave individual a segredos, use a opção
--env-rm. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional. --env-rm- Remover referências de variável de ambiente para a chave de um par chave-valor em um mapa de configuração ou segredo. Para remover referências de chave individual e valores literais, especifique o nome da chave. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--force,-f- Não verifique a existência de referências especificadas de configmap e segredos. As referências de configmap são especificadas com as opções
--env-from-configmapou--mount-configmap. As referências de segredo são especificadas com as opções--env-from-secret,--mount-secretou--registry-secret. Este valor é opcional. O valor padrão éfalse. --inline-code- Especifique o caminho para um arquivo contendo o código-fonte para sua função. O código é armazenado em linha com a função. Este valor é opcional.
--main,--fn-main- Especifique o nome de sua função principal no código-fonte fornecido. Essa opção será necessária quando o nome não for
mainEste valor é opcional. O valor padrão émain. --maxexecutiontime,--met- O tempo máximo de execução em segundos para que esta função seja concluída. Este valor é opcional. O valor padrão é
60. --memory,-m- A quantidade de memória definida para a função. Use
Mpara megabytes ouGpara gigabytes. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. O valor padrão é4G. --no-wait,--nw- Envie a execução de compilação e não espere que ela seja concluída. Se você especificar a opção
--no-wait, o envio de execução de compilação será iniciado e não esperará. Use o comandobuildrun getpara verificar o status de execução da compilação. Este valor é opcional. O valor padrão éfalse. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --rebuild- Reconstrua a imagem a partir da fonte. A opção de reconstrução só é permitida se sua função tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão é
false. --runtime,-r- O tempo de execução para usar para a função. Para localizar os tempos de execução suportados para essa região, execute
ibmcloud ce function runtimesConsulte Runtimes. Este valor é opcional. --scale-down-delay,--sdd- O tempo em segundos que uma instância fica ativa após a conclusão de uma chamada. Essa opção pode reduzir o tempo de cold start. Para obter mais informações, consulte Posso manter minha instância de função ativa por mais tempo?.
Este valor é opcional. O valor padrão é
1. --trusted-profiles-enabled,--trusted,--tpe- Ative a montagem de um token de recurso de computação para execuções da função. Este valor é opcional. O valor padrão é
false. --visibility,-v- A visibilidade da função. Os valores válidos são
public,private, eproject. A visibilidade só pode ser definidaprivatese o projeto suportar a visibilidade privada da função. Este valor é opcional. --wait,-w- Esperar a conclusão da execução de compilação. Este valor é opcional. O valor padrão é
true. --wait-timeout,--wto- O tempo em segundos para aguardar que a função esteja pronta. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é600.
Exemplo
ibmcloud ce fn update --name myfunction --runtime nodejs-20 --build-source main.js
Exemplo de saída
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
Quando você executa ibmcloud ce fn get -n 'myfunction' para verificar o status da função, o URL da sua função é exibido.
comando help
O comando Code Engine help fornece informações sobre os comandos disponíveis por grupo de comandos.
ibmcloud ce help
O comando Code Engine help fornece informações sobre os comandos disponíveis por grupo de comandos.
ibmcloud ce help COMMAND
Exemplo
ibmcloud ce help
Exemplo de saída
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.
Comandos de tarefa
Uma tarefa executa uma ou mais instâncias do seu código executável em paralelo. Ao contrário dos aplicativos, que manipulam solicitações de HTTP, as tarefas são projetadas para executar uma vez e encerrar. Ao criar uma tarefa, é possível especificar
informações de configuração de carga de trabalho que são usadas cada vez que a tarefa é executada. Use comandos job para criar uma configuração para sua tarefa.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos job.
Para obter mais informações sobre como trabalhar com tarefas, consulte Executando tarefas.
Para ver a ajuda da CLI para os job comandos, execute ibmcloud ce job -h.
ibmcloud ce job bind
Ligar uma instância de serviço da IBM Cloud a uma tarefa.
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]
Opções de comando
--name,-n- O nome da tarefa a ser ligada. Este valor é obrigatório.
--no-wait,--nw- Ligue a instância de serviço e não espere a ligação de serviços estar pronta. Se você especificar a opção
--no-wait, a criação da ligação de serviços será iniciada e o comando sairá sem esperar a conclusão dela. Use o comandojob getpara verificar o status de ligação de tarefa. Este valor é opcional. O valor padrão éfalse. --prefix,-p- Um prefixo para variáveis de ambiente que são criadas para esta ligação de serviços. Deve conter apenas letras maiúsculas, números e sublinhados (_) e não pode iniciar com um número. Este valor é opcional.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --role,-r- O nome de uma função de serviço para a nova credencial de serviço que é criada para essa ligação de serviços. Os valores válidos incluem
Reader,Writer,Managerou uma atribuição específica de serviço. A opção é padronizada paraManagerou a primeira função fornecida pelo serviço seManagernão for suportado. Essa opção será ignorada se--service-credentialfor especificado. Este valor é opcional. --service-credential,--sc- O nome de uma credencial de serviço existente para usar para esta ligação de serviços. Se você não especificar uma credencial de instância de serviço, novas credenciais serão geradas durante a ação de ligação. Este valor é opcional.
--service-instance,--si- O nome de uma instância de serviço existente da IBM Cloud a ser ligada à tarefa. Este valor é opcional.
--service-instance-id,--siid- A GUID de uma instância de serviço do IBM Cloud existente para ligar à tarefa. Este valor é opcional.
--wait,-w- Ligue a instância de serviço e aguarde a ligação de serviços estar pronta. Se você especificar a opção
--wait, a ligação de tarefa irá esperar por um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para que ela seja concluída com sucesso. Se a ligação de tarefa não for concluída com sucesso ou falhar no período--wait-timeoutespecificado, o comando falhará. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- A duração de tempo em segundos para esperar a ligação de serviços ficar pronta. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é300.
Exemplo
Neste exemplo, ligue a sua instância de serviço chamada my-object-storage à sua tarefa que é chamada hello.
ibmcloud ce job bind --name hello --service-instance my-object-storage
Exemplo de saída
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
Crie uma atividade.
ibmcloud ce job create --name JOB_NAME ((--image IMAGE_REF | (--build-source SOURCE [--image IMAGE_REF])) [--argument ARGUMENT] [--array-indices ARRAY_INDICES] [--array-size ARRAY_SIZE] [--build-commit BUILD_COMMIT] [--build-context-dir BUILD_CONTEXT_DIR] [--build-dockerfile BUILD_DOCKERFILE] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-size BUILD_SIZE] [--build-strategy BUILD_STRATEGY] [--build-timeout BUILD_TIMEOUT] [--command COMMAND] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-secret MOUNT_SECRET] [--no-wait] [--output OUTPUT] [--quiet] [--registry-secret REGISTRY_SECRET] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
-n,--name- O nome da tarefa. Use um nome que seja exclusivo dentro do projeto.
- O nome deve iniciar e terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 63 caracteres ou menos e pode conter letras minúsculas, números e hifens (-).
Este valor é obrigatório.
--argument,--arg,-a- Configurar argumentos para execuções da tarefa. Especifique um argumento por opção
--argument; por exemplo,-a argA -a argB. Este valor é opcional. --array-indices,--ai- Especifica os índices da matriz usados para execuções da tarefa. Especifique a lista ou intervalo de índices separados por hifens (-) ou vírgulas (,); por exemplo, 0,3,6,9 ou
0,3,6,9ou1-5,7-8,10. O máximo é999999. Esta opção só pode ser especificada se a--array-sizeopção não for especificada. Este valor é opcional. O valor padrão é0. --array-size,--as,--instances,--is- Especifica o número de instâncias que são usadas em execuções da tarefa. Quando você usa essa opção, o sistema se converte em índices de matriz. Por exemplo, se você especificar
instancesde5, o sistema converte-se emarray-indicesde0 - 4. Esta opção só pode ser especificada se a opção--array-indicesnão for especificada. Este valor é opcional. O valor padrão é1. --build-commit,--commit,--bcm,--cm,--revision- A confirmação, a tag ou a ramificação no repositório de origem para fazer pull. A opção build commit é permitida somente se a opção
--build-sourceestiver definida como URL de um repositório Git. Este valor é opcional. --build-context-dir,--context-dir,--bcdr,--cdr- O diretório no repositório que contém o arquivo buildpacks ou o Dockerfile. A opção do diretório de contextos de construção será permitida apenas se a opção
--build-sourceestiver configurada Este valor é opcional. --build-dockerfile,--dockerfile,--bdf,--df- O caminho para o Dockerfile. Especifique esta opção apenas se o nome for diferente de
Dockerfile. A opção dockerfile de construção será permitida apenas se a opção--build-sourceestiver configurada Este valor é opcional. O valor padrão éDockerfile. --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- O nome do segredo SSH que contém as credenciais para acessar o repositório privado que contém o código-fonte para construir sua imagem de contêiner. Para criar esse segredo de SSH, use o comando
secret create --format SSHUm segredo de SSH também é utilizado como um segredo de acesso do repositório do Git Essa opção é permitida somente se a opção--build-sourceestiver definida como URL de um repositório Git. Este valor é opcional. --build-size,--size,--bsz,--sz- O tamanho para a compilação, que determina a quantia de recursos usados. Os valores válidos são
small,medium,large,xlargeexxlarge. Para obter detalhes, consulte Determinando o tamanho da construção. A opção de tamanho da construção será permitida apenas se a opção--build-sourceestiver configurada Este valor é opcional. O valor padrão émedium. --build-source,--source,--bsrc,--src- A URL do repositório Git ou o caminho para origem local que contém o seu código-fonte; por exemplo
https://github.com/IBM/CodeEngineou.. Este valor é opcional. --build-strategy,--strategy,--bstr,--str- A estratégia a ser usada para construir a imagem. Os valores válidos são
dockerfileebuildpacks. A opção de estratégia de compilação será permitida apenas se a opção--build-sourceestiver configurada Se não for especificado, a estratégia de compilação é determinada por Code Engine se--build-sourcefor especificado e a fonte estiver em sua máquina local. Este valor é opcional. O valor padrão édockerfile. --build-timeout,--bto- A quantia de tempo, em segundos, que pode transcorrer antes da compilação deve ser aprovada ou reprovada. A opção de tempo limite de construção será permitida apenas se a opção
--build-sourceestiver configurada Este valor é opcional. O valor padrão é600. --command,--cmd,-c- Configurar comandos para execuções da tarefa. Especifique um comando por opção
--command; por exemplo,--cmd cmdA --cmd cmdB. Este valor substitui o comando padrão que é especificado dentro da imagem de contêiner. Este valor é opcional. --cpu- A quantia de CPU a ser configurada para execuções da tarefa. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. O valor
padrão é
1. --env,-e- Configure variáveis de ambiente para execuções da tarefa. Deve estar em formato
NAME=VALUE. Esta ação inclui uma nova variável de ambiente ou substitui uma variável de ambiente existente. Especifique uma variável de ambiente por opção--env; por exemplo,--env envA=A --env envB=B. Este valor é opcional. --env-cm,--env-from-configmap- Configure variáveis de ambiente por meio dos pares chave-valor que são armazenados neste configmap usando uma das maneiras a seguir:
- Para incluir variáveis de ambiente para todas as chaves em um mapa de configuração que é denominado
configmapName, use o valorconfigmapName. É possível modificar os nomes de variável de ambiente especificando um prefixo ao referenciar o configmap. Para especificar um prefixo, use o valorPREFIX=CONFIGMAP_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no configmapconfigmapNamecomoCUSTOM_, use o valorCUSTOM_=configmapName. Se o configmapconfigmapNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um mapa de configuração que é denominadoconfigmapName, use o valorconfigmapName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma única chavekey1em um configmap que é denominadoconfigmapName, use o valorconfigmapName:myKey=key1.
Este valor é opcional.
--env-sec,--env-from-secret- Defina variáveis de ambiente a partir dos pares chave-valor armazenados em um segredo usando uma das seguintes maneiras:
- Para incluir variáveis de ambiente para todas as chaves em um segredo que é denominado
secretName, use o valorsecretName. É possível modificar os nomes de variáveis de ambiente especificando um prefixo ao referenciar o segredo. Para especificar um prefixo, use o valorPREFIX=SECRET_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_SECRET>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no segredosecretNamecomoCUSTOM_, use o valorCUSTOM_=secretName. Se o segredosecretNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um segredo que é denominadosecretName, use o valorsecretName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma chave únicakey1em um segredo que é denominadosecretName, use o valorsecretName:myKey=key1.
Este valor é opcional.
--ephemeral-storage,--es- A quantia de armazenamento efêmero para configurar para as execuções da tarefa. Use
Mpara megabytes ouGpara gigabytes. Este valor é opcional. O valor padrão é400M. --force,-f- Não verifique a existência de referências especificadas de configmap e segredos. As referências do configmap são especificadas com a opção
--env-from-configmap. As referências de segredo são especificadas com as opções--env-from-secretou--registry-secret. Este valor é opcional. O valor padrão éfalse. --image,-i- O nome da imagem que é usada para execuções da tarefa. O formato é
REGISTRY/NAMESPACE/REPOSITORY:TAGem queREGISTRYeTAGsão opcionais. SeREGISTRYnão for especificado, o padrão serádocker.io. SeTAGnão for especificado, o padrão serálatest. A opção de imagem será necessária se a opção--build-sourcenão for especificada. Este valor é opcional. --maxexecutiontime,--met- O tempo máximo de execução em segundos para execuções da tarefa. Esta opção só pode ser especificada se
modefortask. Este valor é opcional. O valor padrão é7200. --memory,-m- A quantia de memória que é configurada para execuções da tarefa. Use
Mpara megabytes ouGpara gigabytes. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. O valor padrão é4G. --mode- O modo para execuções da tarefa. Os valores válidos são
taskedaemon. Notaskmodo, as opçõesmaxexecutiontimeretrylimite se aplicam. Nodaemonmodo, como não há tempo limite e as instâncias com falha são reiniciadas indefinidamente, as opções--maxexecutiontime--retrylimite não são permitidas. Este valor é opcional. O valor padrão étask. --mount-configmap,--mount-cm- Incluir o conteúdo de um configmap no sistema de arquivos de execuções da tarefa, fornecendo um diretório de montagem e o nome de um configmap com o formato
MOUNT_DIRECTORY=CONFIGMAP_NAME. Cada configmap montado deve usar um diretório de montagem exclusivo. Para cada par chave-valor no configmap, um arquivo é incluído no diretório de montagem especificado, no qual o nome do arquivo é a chave e os conteúdos do arquivo são o valor do par chave-valor. Especifique uma configuração de montagem por opção--mount-configmap; por exemplo,--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b. Este valor é opcional. --mount-data-store,--mount-ds- Monte um armazenamento de dados persistente. O formato é MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. O SUBPATH é opcional. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--mount-secret,--mount-sec- Incluir o conteúdo de um segredo ao sistema de arquivos de execuções da tarefa, fornecendo um diretório de montagem e o nome de um segredo, com o formato
MOUNT_DIRECTORY=SECRET_NAME. Cada segredo montado deve usar um diretório de montagem exclusivo. Para cada par chave-valor no segredo, um arquivo é incluído no diretório de montagem especificado, no qual o nome do arquivo é a chave e os conteúdos do arquivo são o valor do par chave-valor. Especifique uma configuração de montagem por opção--mount-secret; por exemplo,--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b. Este valor é opcional. --no-wait,--nw- Não esperar a conclusão da execução de compilação. Se você especificar a opção
--no-wait, a execução da construção será iniciada e não esperará. Use o comandobuildrun getpara verificar o status de execução da compilação. A opção sem espera será permitida apenas se a opção--build-sourceestiver configurada Este valor é opcional. O valor padrão éfalse. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --registry-secret,--rs- O nome do segredo de registro. O segredo do registro é usado para autenticação com um registro privado quando você faz download da imagem de contêiner. Este valor é opcional.
--retrylimit,-r- O número de vezes para executar novamente uma instância da tarefa antes de a tarefa ser marcada como com falha. Um índice de matriz de uma tarefa será executado novamente quando um código de saída diferente de zero for gerado. Esta opção
só pode ser especificada se
modefortask. Este valor é opcional. O valor padrão é3. --service-account,--sa- O nome da conta do serviço. Uma conta de serviço fornece uma identidade para processos que são executados em uma instância. Para contas de serviço integradas, é possível usar os nomes abreviados
manager,none,readerewriter. É possível também usar nomes completos que são prefixados com oKubernetes Config Context, que pode ser determinado com o comandoproject current. Este valor é opcional. --trusted-profiles-enabled,--trusted,--tpe- Ative a montagem de um token de recurso de computação para execuções da tarefa. Este valor é opcional. O valor padrão é
false. --wait,-w- Esperar a conclusão da execução de compilação. Se você especificar a opção
--wait, a execução da construção esperará por um tempo máximo em segundos, conforme configurado na opção--wait-timeout, pela conclusão da execução da construção. Se a execução da construção não for concluída dentro do período--wait-timeoutespecificado, ela falhará. A opção de espera será permitida somente se a opção--build-sourceestiver configurada Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- O período de tempo em segundos que se deve esperar pela conclusão da execução de compilação. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. A opção wait-timeout será permitida apenas se a opção--build-sourceestiver configurada O valor padrão é600.
Exemplo
O exemplo a seguir usa a imagem do contêiner icr.io/codeengine/firstjob e designa 2G MB como memória e 1 CPU para o contêiner. Para obter mais informações sobre como selecionar memória válida e valores de CPU, consulte Combinações de memória e CPU suportadas.
ibmcloud ce job create --image icr.io/codeengine/firstjob --name hellojob --memory 2G --cpu 1
Exemplo de saída
Creating job 'hellojob'...
OK
ibmcloud ce job delete
Excluir uma tarefa e suas execuções de tarefa associadas.
ibmcloud ce job delete --name JOB_NAME [--force] [--ignore-not-found] [--orphan-job-runs] [--quiet]
Opções de comando
--name,-n- O nome da tarefa. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --orphan-job-runs,-o- Especificar para manter qualquer execução da tarefa que esteja associada a essa configuração de tarefa. Em seguida, essas execuções de tarefa órfãs devem ser excluídas separadamente. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce job delete --name hello
Exemplo de saída
Are you sure you want to delete job hello? [y/N]> y
Deleting job 'hello'...
OK
Quando você executa o ibmcloud ce job delete comando para excluir um trabalho, todas as execuções de trabalhos enviados que fazem referência a esse trabalho também são excluídas.
ibmcloud ce job get
Exibir os detalhes de uma tarefa.
ibmcloud ce job get --name JOB_NAME [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- O nome da tarefa. Este valor é obrigatório.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce job get --name hellojob
Exemplo de saída
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
Listar todas as tarefas em um projeto.
ibmcloud ce job list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce job list
Exemplo de saída
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
Desvincular a instância de serviço da IBM Cloud de uma tarefa a fim de remover as ligações de serviços existentes.
ibmcloud ce job unbind --name JOB_NAME (--binding BINDING_NAME | --all) [--quiet]
Opções de comando
--name,-n- O nome da tarefa a ser desvinculada. Este valor é obrigatório.
--all,-A- Desvincula todas as instâncias de serviço dessa tarefa. Este valor será necessário se
--bindingnão for especificado. O valor padrão éfalse. --binding,-b- O nome da ligação a ser desvinculada. Execute
ibmcloud ce job get -n JOB_NAMEpara visualizar nomes de ligação. Este valor será necessário se--allnão for especificado. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
Neste exemplo, remova todas as ligações da sua tarefa chamada hello.
ibmcloud ce job unbind --name hello --all
Exemplo de saída
Removing service bindings...
OK
ibmcloud ce job update
Atualizar uma tarefa.
ibmcloud ce job update --name JOB_NAME [--argument ARGUMENT] [--arguments-clear] [--array-indices ARRAY_INDICES] [--array-size ARRAY_SIZE] [--build-clear] [--build-commit BUILD_COMMIT] [--build-commit-clear] [--build-context-dir BUILD_CONTEXT_DIR] [--build-dockerfile BUILD_DOCKERFILE] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-git-repo-secret-clear] [--build-size BUILD_SIZE] [--build-source BUILD_SOURCE] [--build-strategy BUILD_STRATEGY] [--build-timeout BUILD_TIMEOUT] [--command COMMAND] [--commands-clear] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-configmap-rm ENV_FROM_CONFIGMAP_RM] [--env-from-secret ENV_FROM_SECRET] [--env-from-secret-rm ENV_FROM_SECRET_RM] [--env-rm ENV_RM] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--image IMAGE] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-rm MOUNT_RM] [--mount-secret MOUNT_SECRET] [--no-wait] [--output OUTPUT] [--quiet] [--rebuild] [--registry-secret REGISTRY_SECRET] [--registry-secret-clear] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--service-account-clear] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
--name,-n- O nome da tarefa. Este valor é obrigatório.
--argument,--arg,-a- Configurar argumentos para execuções da tarefa. Especifique um argumento por opção
--argument; por exemplo,-a argA -a argB. Este valor é opcional. --arguments-clear,--ac- Limpar argumentos da tarefa. Este valor é opcional. O valor padrão é
false. --array-indices,--ai- Especifica os índices da matriz usados para execuções da tarefa. Especifique a lista ou intervalo de índices separados por hifens (-) ou vírgulas (,); por exemplo, 0,3,6,9 ou
0,3,6,9ou1-5,7-8,10. O máximo é999999. Esta opção só pode ser especificada se a--array-sizeopção não for especificada. Este valor é opcional. --array-size,--as,--instances,--is- Especifica o número de instâncias que são usadas em execuções da tarefa. Quando você usa essa opção, o sistema se converte em índices de matriz. Por exemplo, se você especificar
instancesde5, o sistema converte-se emarray-indicesde0 - 4. Esta opção só pode ser especificada se a opção--array-indicesnão for especificada. Este valor é opcional. O valor padrão é0. --build-clear,--bc- Remova a associação de uma compilação a partir desta tarefa. A opção “limpar compilação” só é permitida se o seu trabalho tiver uma compilação associada no momento. Este valor é opcional. O valor padrão é
false. --build-commit,--commit,--bcm,--cm,--revision- A confirmação, a tag ou a ramificação no repositório de origem para fazer pull. A opção de commit de compilação só é permitida se a
--build-sourceopção estiver definida como o GitURL repositório nestejob updatecomando, ou se o seu trabalho tiver atualmente uma compilação associada a partir de uma fonte Git de repositório. Este valor é opcional. --build-commit-clear,--commit-clear,--bcmc,--cmc- Limpe a confirmação, tag ou ramificação no repositório de origem para fazer pull. A opção commit clear só é permitida se o seu trabalho tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão é
false. --build-context-dir,--context-dir,--bcdr,--cdr- O diretório no repositório que contém o arquivo buildpacks ou o Dockerfile. A opção do diretório de contexto de compilação só é permitida se a
--build-sourceopção estiver definida nestejob updatecomando ou se o seu trabalho tiver atualmente uma compilação associada. Este valor é opcional. --build-dockerfile,--dockerfile,--bdf,--df- O caminho para o Dockerfile. Especifique esta opção apenas se o nome for diferente de
Dockerfile. A opção build dockerfile será permitida se a opção--build-sourcefor definida neste comandojob update, ou a sua tarefa tiver atualmente uma construção associada. Este valor é opcional. O valor padrão éDockerfile. --build-git-repo-secret,--git-repo-secret,--bgrs,--grs,--repo- O nome do segredo SSH que contém as credenciais para acessar o repositório privado que contém o código-fonte para construir sua imagem de contêiner. Para criar esse segredo de SSH, use o comando
secret create --format SSHUm segredo de SSH também é utilizado como um segredo de acesso do repositório do Git Esta opção só é permitida se a--build-sourceopção estiver definida como o GitURL repositório nestejob updatecomando, ou se o seu trabalho tiver atualmente uma compilação associada a partir de uma fonte Git de repositório. Este valor é opcional. --build-git-repo-secret-clear,--git-repo-secret-clear,--bgrsc,--grsc- Limpar o segredo do SSH. Esta opção é permitida se o seu trabalho tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão é
false. --build-size,--size,--bsz,--sz- O tamanho para a compilação, que determina a quantia de recursos usados. Os valores válidos são
small,medium,large,xlargeexxlarge. Para obter detalhes, consulte Determinando o tamanho da construção. A opção de tamanho da compilação só é permitida se a--build-sourceopção estiver definida nestejob updatecomando ou se o seu trabalho tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão émedium. --build-source,--source,--bsrc,--src- A URL do repositório Git ou o caminho para origem local que contém o seu código-fonte; por exemplo
https://github.com/IBM/CodeEngineou.. Este valor é opcional. --build-strategy,--strategy,--bstr,--str- A estratégia a ser usada para construir a imagem. Os valores válidos são
dockerfileebuildpacks. A opção de estratégia de compilação só é permitida se a--build-sourceopção estiver definida nestejob updatecomando ou se o seu trabalho tiver atualmente uma compilação associada. Se não for especificado, a estratégia de construção será determinada por Code Engine se--build-sourcefor especificado e a origem estiver em sua máquina local. Este valor é opcional. O valor padrão édockerfile. --build-timeout,--bto- A quantia de tempo, em segundos, que pode transcorrer antes da compilação deve ser aprovada ou reprovada. A opção de tempo limite de compilação só é permitida se a
--build-sourceopção estiver definida nestejob updatecomando ou se o seu trabalho tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão é600. --command,--cmd,-c- Configurar comandos para execuções da tarefa. Especifique um comando por opção
--command; por exemplo,--cmd cmdA --cmd cmdB. Este valor substitui o comando padrão que é especificado dentro da imagem de contêiner. Este valor é opcional. --commands-clear,--cc- Limpar comandos da tarefa. Este valor é opcional. O valor padrão é
false. --cpu- A quantia de CPU a ser configurada para execuções da tarefa. Este valor atualiza qualquer valor
--cpudesignado na tarefa. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. O valor padrão é0. --env,-e- Configure variáveis de ambiente para execuções da tarefa. Deve estar em formato
NAME=VALUE. Esta ação inclui uma nova variável de ambiente ou substitui uma variável de ambiente existente. Especifique uma variável de ambiente por opção--env; por exemplo,--env envA=A --env envB=B. Este valor é opcional. --env-cm,--env-from-configmap- Configure variáveis de ambiente por meio dos pares chave-valor que são armazenados neste configmap usando uma das maneiras a seguir:
- Para incluir variáveis de ambiente para todas as chaves em um mapa de configuração que é denominado
configmapName, use o valorconfigmapName. É possível modificar os nomes de variável de ambiente especificando um prefixo ao referenciar o configmap. Para especificar um prefixo, use o valorPREFIX=CONFIGMAP_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no configmapconfigmapNamecomoCUSTOM_, use o valorCUSTOM_=configmapName. Se o configmapconfigmapNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um mapa de configuração que é denominadoconfigmapName, use o valorconfigmapName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma única chavekey1em um configmap que é denominadoconfigmapName, use o valorconfigmapName:myKey=key1.
Este valor é opcional.
--env-from-configmap-rm,--env-cm-rm- Remova referências de variável de ambiente para configmaps integrais usando o nome do configmap. Para remover referências de chave individual a mapas de configuração, use a opção
--env-rm. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional. --env-sec,--env-from-secret- Defina variáveis de ambiente a partir dos pares chave-valor armazenados em um segredo usando uma das seguintes maneiras:
- Para incluir variáveis de ambiente para todas as chaves em um segredo que é denominado
secretName, use o valorsecretName. É possível modificar os nomes de variáveis de ambiente especificando um prefixo ao referenciar o segredo. Para especificar um prefixo, use o valorPREFIX=SECRET_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_SECRET>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no segredosecretNamecomoCUSTOM_, use o valorCUSTOM_=secretName. Se o segredosecretNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um segredo que é denominadosecretName, use o valorsecretName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma chave únicakey1em um segredo que é denominadosecretName, use o valorsecretName:myKey=key1.
Este valor é opcional.
--env-from-secret-rm,--env-sec-rm- Remova referências de variável de ambiente para segredos integrais usando o nome do segredo. Para remover referências de chave individual a segredos, use a opção
--env-rm. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional. --env-rm- Remover referências de variável de ambiente para a chave de um par chave-valor em um mapa de configuração ou segredo. Para remover referências de chave individual e valores literais, especifique o nome da chave. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--ephemeral-storage,--es- A quantia de armazenamento efêmero para configurar para as execuções da tarefa. Use
Mpara megabytes ouGpara gigabytes. Este valor é opcional. --force,-f- Não verifique a existência de referências especificadas de configmap e segredos. As referências do configmap são especificadas com a opção
--env-from-configmap. As referências de segredo são especificadas com as opções--env-from-secretou--registry-secret. Este valor é opcional. O valor padrão éfalse. --image,-i- O nome da imagem que é usada para execuções da tarefa. O formato é
REGISTRY/NAMESPACE/REPOSITORY:TAGem queREGISTRYeTAGsão opcionais. SeREGISTRYnão for especificado, o padrão serádocker.io. SeTAGnão for especificado, o padrão serálatest. Este valor é opcional. --maxexecutiontime,--met- O tempo máximo de execução em segundos para execuções da tarefa. Esta opção só pode ser especificada se
modefortask. Este valor é opcional. O valor padrão é7200. --memory,-m- A quantia de memória que é configurada para execuções da tarefa. Use
Mpara megabytes ouGpara gigabytes. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. --mode- O modo para execuções da tarefa. Os valores válidos são
taskedaemon. Notaskmodo, as opçõesmaxexecutiontimeretrylimite se aplicam. Nodaemonmodo, como não há tempo limite e as instâncias com falha são reiniciadas indefinidamente, as opções--maxexecutiontime--retrylimite não são permitidas. Este valor é opcional. --mount-configmap,--mount-cm- Incluir o conteúdo de um configmap no sistema de arquivos de execuções da tarefa, fornecendo um diretório de montagem e o nome de um configmap com o formato
MOUNT_DIRECTORY=CONFIGMAP_NAME. Cada configmap montado deve usar um diretório de montagem exclusivo. Para cada par chave-valor no configmap, um arquivo é incluído no diretório de montagem especificado, no qual o nome do arquivo é a chave e os conteúdos do arquivo são o valor do par chave-valor. Especifique uma configuração de montagem por opção--mount-configmap; por exemplo,--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b. Este valor é opcional. --mount-data-store,--mount-ds- Monte um armazenamento de dados persistente. O formato é MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. O SUBPATH é opcional. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--mount-rm- Remova o conteúdo de um configmap ou segredo do sistema de arquivos de execuções da tarefa especificando o diretório onde o configmap ou segredo está montado. Especifique um diretório de montagem por opção
--mount-rm; por exemplo,--mount-rm /etc/configmap-a --mount-rm /etc/secret-b. Este valor é opcional. --mount-secret,--mount-sec- Incluir o conteúdo de um segredo ao sistema de arquivos de execuções da tarefa, fornecendo um diretório de montagem e o nome de um segredo, com o formato
MOUNT_DIRECTORY=SECRET_NAME. Cada segredo montado deve usar um diretório de montagem exclusivo. Para cada par chave-valor no segredo, um arquivo é incluído no diretório de montagem especificado, no qual o nome do arquivo é a chave e os conteúdos do arquivo são o valor do par chave-valor. Especifique uma configuração de montagem por opção--mount-secret; por exemplo,--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b. Este valor é opcional. --no-wait,--nw- Não esperar a conclusão da execução de compilação. Se você especificar a opção
--no-wait, a execução da construção será iniciada e não esperará. Use o comandobuildrun getpara verificar o status de execução da compilação. A opção sem espera só é permitida se a--build-sourceopção estiver definida nestejob updatecomando ou se o seu trabalho tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão éfalse. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --rebuild- Reconstruir a imagem por meio da origem. A opção de reconstrução é permitida se o seu trabalho tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão é
false. --registry-secret,--rs- O nome do segredo de registro. O segredo do registro é usado para autenticação com um registro privado quando você faz download da imagem de contêiner. Este valor é opcional.
--registry-secret-clear,--rsc- Limpar o segredo de registro. Este valor é opcional. O valor padrão é
false. --retrylimit,-r- O número de vezes para executar novamente uma instância da tarefa antes de a tarefa ser marcada como com falha. Um índice de matriz de uma tarefa será executado novamente quando um código de saída diferente de zero for gerado. Esta opção
só pode ser especificada se
modefortask. Este valor é opcional. O valor padrão é3. --service-account,--sa- O nome da conta do serviço. Uma conta de serviço fornece uma identidade para processos que são executados em uma instância. Para contas de serviço integradas, é possível usar os nomes abreviados
manager,none,readerewriter. É possível também usar nomes completos que são prefixados com oKubernetes Config Context, que pode ser determinado com o comandoproject current. Este valor é opcional. --service-account-clear,--sac- Limpar a conta de serviço. Este valor é opcional. O valor padrão é
false. --trusted-profiles-enabled,--trusted,--tpe- Ative a montagem de um token de recurso de computação para execuções da tarefa. Este valor é opcional. O valor padrão é
false. --wait,-w- Esperar a conclusão da execução de compilação. Se você especificar a opção
--wait, a execução da construção esperará por um tempo máximo em segundos, conforme configurado na opção--wait-timeout, pela conclusão da execução da construção. Se a execução da construção não for concluída dentro do período--wait-timeoutespecificado, ela falhará. A opção de espera só é permitida se a--build-sourceopção estiver definida nestejob updatecomando ou se o seu trabalho tiver atualmente uma compilação associada. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- O período de tempo em segundos que se deve esperar pela conclusão da execução de compilação. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. A opção wait-timeout será permitida se a opção--build-sourcefor definida neste comandojob updateou sua tarefa atualmente tiver uma construção associada. O valor padrão é600.
Exemplo
ibmcloud ce job update --name hellojob --cpu 2
Exemplo de saída
Updating job 'hellojob'...
OK
Comandos de execução da tarefa
Uma tarefa executa uma ou mais instâncias do seu código executável em paralelo. Ao contrário dos aplicativos, que manipulam solicitações de HTTP, as tarefas são projetadas para executar uma vez e encerrar. Ao criar uma tarefa, é possível especificar
informações de configuração de carga de trabalho que são usadas cada vez que a tarefa é executada. Use os comandos jobrun para executar instâncias de sua tarefa.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos jobrun.
Para obter mais informações sobre como trabalhar com tarefas e execuções de tarefa, consulte Executando tarefas.
Para ver a ajuda da CLI para os jobrun comandos, execute ibmcloud ce jobrun -h.
ibmcloud ce jobrun delete
Excluir uma execução de tarefa.
ibmcloud ce jobrun delete (--name JOBRUN_NAME | --job JOB_NAME) [--force] [--ignore-not-found] [--quiet]
Opções de comando
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --job,-j- Use esta opção para excluir todas as execuções de tarefa da tarefa especificada. A opção
--jobé obrigatória se você não especificar o valor--name. Este valor é opcional. --name,-n- O nome da execução da tarefa a ser excluída. A opção
--nameé obrigatória se você não especificar o valor--job. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce jobrun delete --name myjobrun -f
Exemplo de saída
Deleting job run 'myjobrun'...
OK
ibmcloud ce jobrun events
Exiba os eventos do sistema de instâncias de execução da tarefa. Eventos do sistema são retidos por até 60 minutos.
ibmcloud ce jobrun events (--instance JOBRUN_INSTANCE | --jobrun JOBRUN_NAME) [--output OUTPUT] [--quiet]
Opções de comando
--instance,-i- O nome de uma instância de execução da tarefa específica. Use o comando
jobrun getpara localizar o nome da instância. Este valor será necessário se--jobrunnão for especificado. --jobrun,-j,--name,-n- Exibir os eventos de todas as instâncias da execução da tarefa especificada. Este valor será necessário se
--instancenão for especificado. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
O exemplo a seguir exibe as informações do evento do sistema para todas as instâncias de uma execução de tarefa especificada.
ibmcloud ce jobrun events --jobrun myjobrun
Exemplo de saída
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"
Exemplo de informações de eventos do sistema para instância especificada de uma execução de tarefa
Também é possível exibir informações do evento do sistema para uma instância especificada de uma execução de tarefa usando a opção --instance com o comando ibmcloud ce jobrun events.
Use o comando jobrun get para exibir detalhes sobre sua execução de tarefa, incluindo as instâncias de execução da execução de tarefa.
ibmcloud ce jobrun events --instance myjobrun-2-0
Exemplo de saída de informações do evento do sistema para instância especificada de uma execução de tarefa
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
Exibir os detalhes de uma execução da tarefa.
ibmcloud ce jobrun get --name JOBRUN_NAME [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- O nome da execução da tarefa. Este valor é obrigatório.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce jobrun get --name myjobrun
Exemplo de saída
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
Listar todas as execuções da tarefa em um projeto.
ibmcloud ce jobrun list [--job JOB] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--job,-j- Use esta opção para exibir somente execuções de tarefa a partir da tarefa especificada. Este valor é opcional.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce jobrun list
Exemplo de saída
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
O nome da execução da tarefa listada indica o nome da execução da tarefa e a revisão atual dela.
ibmcloud ce jobrun logs
Exibir os logs das instâncias de execução da tarefa.
ibmcloud ce jobrun logs (--instance JOBRUN_INSTANCE | --jobrun JOBRUN_NAME) [--follow] [--output OUTPUT] [--quiet] [--raw] [--tail TAIL] [--timestamps]
Opções de comando
--follow,-f- Seguir os logs das instâncias de execução da tarefa. Use essa opção para logs de fluxo de instâncias de execução da tarefa. Se você especificar a opção
--follow, deverá inserirCtrl+Cpara finalizar este comando de log. Este valor é opcional. O valor padrão éfalse. --instance,-i- O nome de uma instância de execução da tarefa específica. Use o comando
jobrun getpara localizar o nome da instância. Este valor será necessário se--jobrunnão for especificado. --jobrun,-j,--name,-n- Exibir os logs de todas as instâncias da execução da tarefa especificada. Este valor será necessário se
--instancenão for especificado. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --raw,-r- Exibir logs sem os rótulos de instância e de contêiner. Este valor é opcional. O valor padrão é
false. --tail,-t- Limitar a exibição de logs das instâncias de execução da tarefa especificadas a um número máximo de linhas recentes. Por exemplo, para exibir as últimas
3linhas dos logs das instâncias de execução de tarefa determinadas, especifique--tail 3. Se esta opção não for especificada, todas as linhas dos logs das instâncias de execução de tarefas especificadas serão exibidas. Este valor é opcional. O valor padrão é-1. --timestamps,--ts- Incluir registros de data e hora em cada linha na saída de log. Este valor é opcional. O valor padrão é
false.
Exemplo
O exemplo a seguir exibe os logs de uma instância específica de uma execução de tarefa. Use o comando jobrun get para obter o nome das instâncias de execução da tarefa.
ibmcloud ce jobrun logs --instance myjobrun-3-0
Exemplo de saída
Getting logs for job run instance 'myjobrun-3-0'...
OK
myjobrun-3-0/myjobrun:
Hi from a batch job! My index is: 3
Exemplo de logs de todas as instâncias de uma execução de tarefa
O exemplo a seguir exibe os logs de todas as instâncias de uma execução de tarefa.
ibmcloud ce jobrun logs --jobrun myjobrun
Exemplo de saída de logs de todas as instâncias de uma execução de tarefa
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
Reiniciar as instâncias da execução de tarefa em execução.
ibmcloud ce jobrun restart (--instance JOBRUN_INSTANCE | --jobrun JOBRUN_NAME) [--quiet]
Opções de comando
--instance,-i- O nome de uma instância de execução da tarefa específica. Use o comando
jobrun getpara localizar o nome da instância. Este valor será necessário se--jobrunnão for especificado. --jobrun,-j,--name,-n- Reiniciar todas as instâncias em execução da execução de tarefa especificada. Este valor será necessário se
--instancenão for especificado. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce jobrun restart --name myjobrun
Exemplo de saída
Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
Restarting all running instances of job run 'myjobrun'...
OK
ibmcloud ce jobrun resubmit
Reenviar uma execução da tarefa com base na configuração de uma execução da tarefa anterior.
ibmcloud ce jobrun resubmit --jobrun REFERENCED_JOBRUN_NAME [--argument ARGUMENT] [--arguments-clear] [--array-indices ARRAY_INDICES] [--array-size ARRAY_SIZE] [--array-size-var-override ARRAY_SIZE_VAR_OVERRIDE] [--command COMMAND] [--commands-clear] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-configmap-rm ENV_FROM_CONFIGMAP_RM] [--env-from-secret ENV_FROM_SECRET] [--env-from-secret-rm ENV_FROM_SECRET_RM] [--env-rm ENV_RM] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-rm MOUNT_RM] [--mount-secret MOUNT_SECRET] [--name NAME] [--no-wait] [--output OUTPUT] [--quiet] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--service-account-clear] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
--jobrun,-j- O nome da execução da tarefa anterior na qual essa tarefa se baseia. Este valor é obrigatório.
--argument,--arg,-a- Configure argumentos para esta execução da tarefa. Especifique um argumento por opção
--argument; por exemplo,-a argA -a argB. Este valor é opcional. --arguments-clear,--ac- Limpar argumentos da execução de tarefa. Este valor é opcional. O valor padrão é
false. --array-indices,--ai- Especifica os índices de matriz que são usados para esta execução da tarefa. Especifique a lista ou intervalo de índices separados por hifens (-) ou vírgulas (,); por exemplo, 0,3,6,9 ou
0,3,6,9ou1-5,7-8,10. O máximo é999999. Esta opção só pode ser especificada se a--array-sizeopção não for especificada. Este valor é opcional. --array-size,--as,--instances,--is- Especifica o número de instâncias que são usadas para essa execução de tarefa. Quando você usa essa opção, o sistema se converte em índices de matriz. Por exemplo, se você especificar
instancesde5, o sistema converte-se emarray-indicesde0 - 4. Esta opção só pode ser especificada se a opção--array-indicesnão for especificada. Este valor é opcional. O valor padrão é0. --array-size-var-override,--array-size-variable-override,--asvo- Especifica um valor personalizado para a variável
JOB_ARRAY_SIZEde ambiente. Por padrão, a variávelJOB_ARRAY_SIZEde ambiente é definida como oarray-sizevalor ou o número de índices especificados porarray-indices. O valor da variável de ambienteJOB_ARRAY_SIZEnão afeta o tamanho da matriz configurada. Use esta opção para forçar um valor de tamanho de matriz constante para cenários de nova execução da tarefa, em que apenas algumas instâncias da tarefa são enviadas ou reenviadas. Este valor é opcional. --command,--cmd,-c- Configure comandos para esta execução da tarefa. Especifique um comando por opção
--command; por exemplo,--cmd cmdA --cmd cmdB. Este valor substitui o comando padrão que é especificado dentro da imagem de contêiner. Este valor é opcional. --commands-clear,--cc- Limpar comandos de execução de tarefa. Este valor é opcional. O valor padrão é
false. --cpu- A quantia de CPU configurada para cada índice de matriz para esta execução da tarefa. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional.
O valor padrão é
0. --env,-e- Configure variáveis de ambiente para esta execução da tarefa. Deve estar em formato
NAME=VALUE. Esta ação inclui uma nova variável de ambiente ou substitui uma variável de ambiente existente. Especifique uma variável de ambiente por opção--env; por exemplo,-e envA -e envB. Este valor é opcional. --env-cm,--env-from-configmap- Configure variáveis de ambiente por meio dos pares chave-valor que são armazenados neste configmap usando uma das maneiras a seguir:
- Para incluir variáveis de ambiente para todas as chaves em um mapa de configuração que é denominado
configmapName, use o valorconfigmapName. É possível modificar os nomes de variável de ambiente especificando um prefixo ao referenciar o configmap. Para especificar um prefixo, use o valorPREFIX=CONFIGMAP_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no configmapconfigmapNamecomoCUSTOM_, use o valorCUSTOM_=configmapName. Se o configmapconfigmapNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um mapa de configuração que é denominadoconfigmapName, use o valorconfigmapName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma única chavekey1em um configmap que é denominadoconfigmapName, use o valorconfigmapName:myKey=key1.
Este valor é opcional.
--env-from-configmap-rm,--env-cm-rm- Remova referências de variável de ambiente para configmaps integrais usando o nome do configmap. Para remover referências de chave individual a mapas de configuração, use a opção
--env-rm. Este valor é opcional. --env-sec,--env-from-secret- Defina variáveis de ambiente a partir dos pares chave-valor armazenados em um segredo usando uma das seguintes maneiras:
- Para incluir variáveis de ambiente para todas as chaves em um segredo que é denominado
secretName, use o valorsecretName. É possível modificar os nomes de variáveis de ambiente especificando um prefixo ao referenciar o segredo. Para especificar um prefixo, use o valorPREFIX=SECRET_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_SECRET>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no segredosecretNamecomoCUSTOM_, use o valorCUSTOM_=secretName. Se o segredosecretNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um segredo que é denominadosecretName, use o valorsecretName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma chave únicakey1em um segredo que é denominadosecretName, use o valorsecretName:myKey=key1.
Este valor é opcional.
--env-from-secret-rm,--env-sec-rm- Remova referências de variável de ambiente para segredos integrais usando o nome do segredo. Para remover referências de chave individual a segredos, use a opção
--env-rm. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional. --env-rm- Remover referências de variável de ambiente para a chave de um par chave-valor em um mapa de configuração ou segredo. Para remover referências de chave individual e valores literais, especifique o nome da chave. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--ephemeral-storage,--es- A quantia de armazenamento efêmero para esta execução da tarefa. Use
Mpara megabytes ouGpara gigabytes. Este valor é opcional. --force,-f- Não verifique a existência de referências especificadas de configmap e segredos. As referências do configmap são especificadas com a opção
--env-from-configmap. As referências de segredo são especificadas com a opção--env-from-secret. Este valor é opcional. O valor padrão éfalse. --maxexecutiontime,--met- O tempo máximo de execução em segundos para esta execução da tarefa. Esta opção só pode ser especificada se
modefortask. Este valor é opcional. O valor padrão é7200. --memory,-m- A quantia de memória para designar para esta execução da tarefa. Use
Mpara megabytes ouGpara gigabytes. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. --mode- O modo da execução da tarefa. Os valores válidos são
taskedaemon. Notaskmodo, as opçõesmaxexecutiontimeretrylimite se aplicam. Nodaemonmodo, como não há tempo limite e as instâncias com falha são reiniciadas indefinidamente, as opçõesmaxexecutiontimeretrylimite não são permitidas. Este valor é opcional. --mount-configmap,--mount-cm- Inclua o conteúdo de um configmap no sistema de arquivos desta execução de tarefa fornecendo um diretório de montagem e o nome de um configmap, com o formato
MOUNT_DIRECTORY=CONFIGMAP_NAME. Cada configmap montado deve usar um diretório de montagem exclusivo. Para cada par chave-valor no configmap, um arquivo é incluído no diretório de montagem especificado, no qual o nome do arquivo é a chave e os conteúdos do arquivo são o valor do par chave-valor. Especifique uma configuração de montagem por opção--mount-configmap; por exemplo,--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b. Este valor é opcional. --mount-data-store,--mount-ds- Monte um armazenamento de dados persistente. O formato é MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. O SUBPATH é opcional. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--mount-rm- Remova o conteúdo de um configmap ou segredo do sistema de arquivos desta execução de tarefa especificando o diretório em que o configmap ou segredo está montado. Especifique um diretório de montagem por opção
--mount-rm; por exemplo,--mount-rm /etc/configmap-a --mount-rm /etc/secret-b. Este valor é opcional. --mount-secret,--mount-sec- Inclua o conteúdo de um segredo para o sistema de arquivos desta execução de tarefa fornecendo um diretório de montagem e o nome de um segredo, com o formato
MOUNT_DIRECTORY=SECRET_NAME. Cada segredo montado deve usar um diretório de montagem exclusivo. Para cada par chave-valor no segredo, um arquivo é incluído no diretório de montagem especificado, no qual o nome do arquivo é a chave e os conteúdos do arquivo são o valor do par chave-valor. Especifique uma configuração de montagem por opção--mount-secret; por exemplo,--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b. Este valor é opcional. -n,--name- O nome dessa execução da tarefa. Este valor é necessário se a tarefa referenciada não tiver uma configuração de tarefa relacionada. Use um nome que seja exclusivo dentro do projeto.
- O nome deve iniciar e terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 53 caracteres ou menos e pode conter letras minúsculas, números e hifens (-).
Este valor é opcional.
--no-wait,--nw- Reenvie a execução da tarefa e não espere que as instâncias dessa execução da tarefa sejam concluídas. Se você especificar a opção
--no-wait, o reenvio de execução da tarefa será iniciado e não esperará. Use o comandojobrun getpara verificar o status de execução da tarefa. Este valor é opcional. O valor padrão étrue. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --retrylimit,-r- O número de vezes para executar novamente uma instância desta execução da tarefa antes de a execução da tarefa ser marcada como com falha. Um índice de matriz de uma execução da tarefa será executado novamente quando um código de saída
diferente de zero for gerado. Esta opção só pode ser especificada se
modefortask. Este valor é opcional. O valor padrão é3. --service-account,--sa- O nome da conta do serviço. Uma conta de serviço fornece uma identidade para processos que são executados em uma instância. Para contas de serviço integradas, é possível usar os nomes abreviados
manager,none,readerewriter. É possível também usar nomes completos que são prefixados com oKubernetes Config Context, que pode ser determinado com o comandoproject current. Este valor é opcional. --service-account-clear,--sac- Limpar a conta de serviço. Este valor é opcional. O valor padrão é
false. --trusted-profiles-enabled,--trusted,--tpe- Ative a montagem de um token de recurso de computação para instâncias dessa execução de tarefa. Este valor é opcional. O valor padrão é
false. --wait,-w- Reenvie a execução da tarefa e aguarde que as instâncias dessa execução da tarefa sejam concluídas. Se você especificar a opção
--wait, o reenvio de execução da tarefa irá esperar por um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para a execução da tarefa ser concluída. Se a execução da tarefa não for concluída no período--wait-timeoutespecificado, o reenvio dela falhará. Este valor é opcional. O valor padrão éfalse. --wait-timeout,--wto- A duração de tempo em segundos a esperar pela conclusão das instâncias desta execução da tarefa. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é600.
Exemplo
O exemplo a seguir executa novamente a execução da tarefa myjobrun para instâncias 4-5. O nome da execução da tarefa reenviada é myjobresubmit.
ibmcloud ce jobrun resubmit --name myjobresubmit --jobrun myjobrun --array-indices 4-5
Exemplo de saída
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
Enviar uma execução de tarefa com base em uma tarefa.
ibmcloud ce jobrun submit ((--name JOBRUN_NAME --image IMAGE) | (--job JOB_NAME [--name JOBRUN_NAME])) [--argument ARGUMENT] [--array-indices ARRAY_INDICES] [--array-size ARRAY_SIZE] [--array-size-var-override ARRAY_SIZE_VAR_OVERRIDE] [--command COMMAND] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-secret MOUNT_SECRET] [--no-wait] [--output OUTPUT] [--quiet] [--registry-secret REGISTRY_SECRET] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
--argument,--arg,-a- Configure argumentos para esta execução da tarefa. Especifique um argumento por opção
--argument; por exemplo,-a argA -a argB. Este valor é opcional. --array-indices,--ai- Especifica os índices de matriz que são usados para esta execução da tarefa. Especifique a lista ou intervalo de índices separados por hifens (-) ou vírgulas (,); por exemplo, 0,3,6,9 ou
0,3,6,9ou1-5,7-8,10. O máximo é999999. Esta opção só pode ser especificada se a--array-sizeopção não for especificada. Este valor é opcional. O valor padrão é0. --array-size,--as,--instances,--is- Especifica o número de instâncias que são usadas para essa execução de tarefa. Quando você usa essa opção, o sistema se converte em índices de matriz. Por exemplo, se você especificar
instancesde5, o sistema converte-se emarray-indicesde0 - 4. Esta opção só pode ser especificada se a opção--array-indicesnão for especificada. Este valor é opcional. O valor padrão é1. --array-size-var-override,--array-size-variable-override,--asvo- Especifica um valor personalizado para a variável
JOB_ARRAY_SIZEde ambiente. Por padrão, a variávelJOB_ARRAY_SIZEde ambiente é definida como oarray-sizevalor ou o número de índices especificados porarray-indices. O valor da variável de ambienteJOB_ARRAY_SIZEnão afeta o tamanho da matriz configurada. Use esta opção para forçar um valor de tamanho de matriz constante para cenários de nova execução da tarefa, em que apenas algumas instâncias da tarefa são enviadas ou reenviadas. Este valor é opcional. --command,--cmd,-c- Configure comandos para esta execução da tarefa. Especifique um comando por opção
--command; por exemplo,--cmd cmdA --cmd cmdB. Este valor substitui o comando padrão que é especificado dentro da imagem de contêiner. Este valor é opcional. --cpu- A quantia de CPU configurada para cada índice de matriz para esta execução da tarefa. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional.
O valor padrão é
1. --env,-e- Configure variáveis de ambiente para esta execução da tarefa. Deve estar em formato
NAME=VALUE. Esta ação inclui uma nova variável de ambiente ou substitui uma variável de ambiente existente. Especifique uma variável de ambiente por opção--env; por exemplo,-e envA -e envB. Este valor é opcional. --env-cm,--env-from-configmap- Configure variáveis de ambiente por meio dos pares chave-valor que são armazenados neste configmap usando uma das maneiras a seguir:
- Para incluir variáveis de ambiente para todas as chaves em um mapa de configuração que é denominado
configmapName, use o valorconfigmapName. É possível modificar os nomes de variável de ambiente especificando um prefixo ao referenciar o configmap. Para especificar um prefixo, use o valorPREFIX=CONFIGMAP_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no configmapconfigmapNamecomoCUSTOM_, use o valorCUSTOM_=configmapName. Se o configmapconfigmapNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um mapa de configuração que é denominadoconfigmapName, use o valorconfigmapName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma única chavekey1em um configmap que é denominadoconfigmapName, use o valorconfigmapName:myKey=key1.
Este valor é opcional.
--env-sec,--env-from-secret- Defina variáveis de ambiente a partir dos pares chave-valor armazenados em um segredo usando uma das seguintes maneiras:
- Para incluir variáveis de ambiente para todas as chaves em um segredo que é denominado
secretName, use o valorsecretName. É possível modificar os nomes de variáveis de ambiente especificando um prefixo ao referenciar o segredo. Para especificar um prefixo, use o valorPREFIX=SECRET_NAME. Cada variável de ambiente resultante tem o formato<PREFIX><NAME_OF_KEY_IN_SECRET>. Por exemplo, para configurar o prefixo para todos os nomes de variável de chaves no segredosecretNamecomoCUSTOM_, use o valorCUSTOM_=secretName. Se o segredosecretNamecontiver KEY_A, o nome da variável de ambiente seráCUSTOM_KEY_A. - Para incluir variáveis de ambiente para chaves individuais, use o formato
NAME:KEY_A,KEY_B. Por exemplo, para incluir uma variável de ambiente para uma única chavekey1em um segredo que é denominadosecretName, use o valorsecretName:key1. Para atribuir um nome diferente a uma chave referenciada, use o formatoNAME:NEW_NAME=KEY_A. Por exemplo, para incluir uma variável de ambiente denominadamyKeypara uma chave únicakey1em um segredo que é denominadosecretName, use o valorsecretName:myKey=key1.
Este valor é opcional.
--ephemeral-storage,--es- A quantia de armazenamento efêmero para esta execução da tarefa. Use
Mpara megabytes ouGpara gigabytes. Este valor é opcional. O valor padrão é400M. --force,-f- Não verifique a existência de referências especificadas de configmap e segredos. As referências do configmap são especificadas com a opção
--env-from-configmap. As referências de segredo são especificadas com as opções--env-from-secretou--registry-secret. Este valor é opcional. O valor padrão éfalse. --image,-i- O nome da imagem que é usada para esta execução da tarefa. O formato é
REGISTRY/NAMESPACE/REPOSITORY:TAGem queREGISTRYeTAGsão opcionais. SeREGISTRYnão for especificado, o padrão serádocker.io. SeTAGnão for especificado, o padrão serálatest. Se você não especificar a opção--job, os valores--namee--imagesão necessários. Este valor é opcional. --job,-j- O nome da configuração de tarefa. Visualize as configurações de tarefa com o comando
job list. Se você especificar o valor--job, será possível especificar opcionalmente o valor--name. Se você não especificar o valor--job, os valores--namee--imagedeverão ser especificados. Este valor é opcional. --maxexecutiontime,--met- O tempo máximo de execução em segundos para esta execução da tarefa. Esta opção só pode ser especificada se
modefortask. Este valor é opcional. O valor padrão é7200. --memory,-m- A quantia de memória para designar para esta execução da tarefa. Use
Mpara megabytes ouGpara gigabytes. Para valores válidos, consulte Combinações de memória e CPU suportadas. Este valor é opcional. O valor padrão é4G. --mode- O modo da execução da tarefa. Os valores válidos são
taskedaemon. Notaskmodo, as opçõesmaxexecutiontimeretrylimite se aplicam. Nodaemonmodo, como não há tempo limite e as instâncias com falha são reiniciadas indefinidamente, as opçõesmaxexecutiontimeretrylimite não são permitidas. Este valor é opcional. O valor padrão étask. --mount-configmap,--mount-cm- Inclua o conteúdo de um configmap no sistema de arquivos desta execução de tarefa fornecendo um diretório de montagem e o nome de um configmap, com o formato
MOUNT_DIRECTORY=CONFIGMAP_NAME. Cada configmap montado deve usar um diretório de montagem exclusivo. Para cada par chave-valor no configmap, um arquivo é incluído no diretório de montagem especificado, no qual o nome do arquivo é a chave e os conteúdos do arquivo são o valor do par chave-valor. Especifique uma configuração de montagem por opção--mount-configmap; por exemplo,--mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b. Este valor é opcional. --mount-data-store,--mount-ds- Monte um armazenamento de dados persistente. O formato é MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. O SUBPATH é opcional. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--mount-secret,--mount-sec- Inclua o conteúdo de um segredo para o sistema de arquivos desta execução de tarefa fornecendo um diretório de montagem e o nome de um segredo, com o formato
MOUNT_DIRECTORY=SECRET_NAME. Cada segredo montado deve usar um diretório de montagem exclusivo. Para cada par chave-valor no segredo, um arquivo é incluído no diretório de montagem especificado, no qual o nome do arquivo é a chave e os conteúdos do arquivo são o valor do par chave-valor. Especifique uma configuração de montagem por opção--mount-secret; por exemplo,--mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b. Este valor é opcional. -n,--name- O nome dessa execução da tarefa. Se você não especificar o valor
--job, então os valores--namee--imageserão obrigatórios. Use um nome que seja exclusivo dentro do projeto.
- O nome deve iniciar e terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 53 caracteres ou menos e pode conter letras minúsculas, números e hifens (-).
Este valor é opcional.
--no-wait,--nw- Envie a execução da tarefa e não espere que as instâncias dessa execução da tarefa sejam concluídas. Se você especificar a opção
--no-wait, o envio de execução da tarefa será iniciado e não esperará. Use o comandojobrun getpara verificar o status de execução da tarefa. Este valor é opcional. O valor padrão étrue. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --registry-secret,--rs- O nome do segredo de registro. O segredo do registro é usado para autenticação com um registro privado quando você faz download da imagem de contêiner. Este valor é opcional.
--retrylimit,-r- O número de vezes para executar novamente uma instância desta execução da tarefa antes de a execução da tarefa ser marcada como com falha. Um índice de matriz de uma execução da tarefa será executado novamente quando um código de saída
diferente de zero for gerado. Esta opção só pode ser especificada se
modefortask. Este valor é opcional. O valor padrão é3. --service-account,--sa- O nome da conta do serviço. Uma conta de serviço fornece uma identidade para processos que são executados em uma instância. Para contas de serviço integradas, é possível usar os nomes abreviados
manager,none,readerewriter. É possível também usar nomes completos que são prefixados com oKubernetes Config Context, que pode ser determinado com o comandoproject current. Este valor é opcional. --trusted-profiles-enabled,--trusted,--tpe- Ative a montagem de um token de recurso de computação para instâncias dessa execução de tarefa. Este valor é opcional. O valor padrão é
false. --wait,-w- Envie a execução da tarefa e espere que as instâncias dessa execução da tarefa sejam concluídas. Se você especificar a opção
--wait, o envio de execução da tarefa irá esperar por um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para a execução da tarefa ser concluída. Se a execução da tarefa não for concluída no período--wait-timeoutespecificado, o envio dela falhará. Este valor é opcional. O valor padrão éfalse. --wait-timeout,--wto- A duração de tempo em segundos a esperar pela conclusão das instâncias desta execução da tarefa. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é600.
Exemplo
ibmcloud ce jobrun submit --name myjobrun --image icr.io/codeengine/firstjob --array-indices 1-5
Exemplo de saída
Submitting job run 'myjobrun'...
Run 'ibmcloud ce jobrun get -n myjobrun' to check the job run status.
OK
Comandos do Persistentdatastore
Gerenciar armazenamentos de dados persistentes.
ibmcloud ce persistentdatastore create
Crie um armazenamento de dados persistente.
ibmcloud ce persistentdatastore create --name NAME --cos-access-secret SECRET_NAME --cos-bucket-name BUCKET_NAME [--cos-bucket-location BUCKET_LOCATION] [--quiet]
Opções de comando
--cos-access-secret,--cos-sec- Obrigatório. O nome do segredo que contém as credenciais para acessar a instância COS. Este valor é obrigatório.
--cos-bucket-name,--cos-bucket- Obrigatório. O nome do bucket COS. Este valor é obrigatório.
--name,-n- Obrigatório. O nome do armazenamento de dados persistentes. Use um nome que seja exclusivo dentro do projeto. Este valor é obrigatório.
--cos-bucket-location,--cos-loc- A localização do bucket COS. Este valor é opcional.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce persistentdatastore create --name my-pds-2 --cos-bucket-name my-test-bucket-2 --cos-access-secret my-hmac-secret-2
Exemplo de saída
Successfully created persistent data store named 'my-pds-2'.
OK
ibmcloud ce persistentdatastore delete
Excluir um armazenamento de dados persistente.
ibmcloud ce persistentdatastore delete --name PERSISTENT_DATA_STORE_NAME [--force] [--ignore-not-found] [--quiet]
Opções de comando
--name,-n- Obrigatório. Nome do armazenamento de dados persistente. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce persistentdatastore delete --name my-pds-3 -f
Exemplo de saída
Deleting persistent data store 'my-pds-3'...
OK
ibmcloud ce persistentdatastore get
Exibir os detalhes de um armazenamento de dados persistente.
ibmcloud ce persistentdatastore get --name NAME [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- Obrigatório. O nome do armazenamento de dados persistentes. Este valor é obrigatório.
--output,-o- Formato de saída. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce persistentdatastore get --name my-pds-2
Exemplo de saída
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
Listar todos os armazenamentos de dados persistentes em um projeto.
ibmcloud ce persistentdatastore list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--output,-o- Formato de saída. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
Esse comando lista todos os armazenamentos de dados persistentes em um projeto.
ibmcloud ce persistentdatastore list
Exemplo de saída
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
Comandos de projeto
Use os comandos project para criar, listar, excluir e selecionar um projeto como o contexto atual.
Um projeto é um agrupamento de entidades do Code Engine como aplicativos, tarefas e construções. Um projeto é baseado em um namespace do Kubernetes. O nome de seu projeto deve ser exclusivo dentro de seu grupo de recursos, sua conta do usuário e sua região do IBM Cloud®. Os projetos são usados para gerenciar recursos e fornecer acesso às suas entidades.
Um projeto fornece os itens a seguir.
- Fornece um namespace exclusivo para nomes da entidade.
- Gerencia o acesso aos recursos do projeto (acesso de entrada).
- Gerencia o acesso a serviços de apoio, registros e repositórios (acesso de saída).
- Tem um certificado gerado automaticamente para o Transport Layer Service (TLS).
Para obter mais informações sobre como trabalhar com projetos, consulte Gerenciando projetos.
É possível usar project ou proj em seus comandos project. Para ver a ajuda da CLI para os comandos project, execute ibmcloud ce proj -h.
ibmcloud ce project create
Criar um projeto.
ibmcloud ce project create --name PROJECT_NAME [--endpoint ENDPOINT] [--no-select] [--no-wait] [--output OUTPUT] [--quiet] [--tag TAG] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
-n,--name- O nome do projeto. Use um nome que seja exclusivo para sua região. O nome deve ter 128 caracteres ou menos e pode conter:
- Qualquer caractere Unicode ou alfanumérico.
- Somente estes caracteres especiais: espaços ( ), pontos (.), dois pontos (:), sublinhados (_) e hifens (-).
Este valor é obrigatório.
--endpoint,-e- O terminal para o projeto. Os valores válidos são
publiceprivate. Se a opção--endpointnão for explicitamente especificada, o comportamento será determinado pelo sistema. Se a CLI do IBM Cloud estiver conectada aprivate.cloud.ibm.com, o projeto Code Engine se comportará como se--endpointfosseprivate. Se a CLI do IBM Cloud estiver conectada acloud.ibm.com, o projeto Code Engine se comportará como se--endpointfossepublic. Este valor é opcional. --no-select,--ns- Não selecione o projeto como o contexto atual depois que esse projeto for criado. Se você não selecionar esta opção, o projeto será selecionado automaticamente. Este valor é opcional. O valor padrão é
false. --no-wait,--nw- Crie o projeto e não espere até que o projeto seja criado. Se você especificar a opção
no-wait, a criação do projeto começa e não espera. Use o comandoproject getpara verificar o status do projeto. Este valor é opcional. O valor padrão éfalse. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --tag,-t- Um rótulo para atribuir ao seu projeto. O rótulo deve ter 128 caracteres ou menos e pode conter letras, números, espaços (), pontos (.), dois pontos (:), sublinhados (_) e hifens (-). Especifique um rótulo por opção
--tag; por exemplo,--tag tagA --tag tagB. Este valor é opcional. --wait,-w- Crie o projeto e aguarde até que o projeto seja criado. Se você especificar a opção
--wait, a criação do projeto espera um tempo máximo em segundos, conforme configuado pela opção--wait-timeout, para que o projeto seja criado. Se o projeto não for criado dentro do período--wait-timeoutespecificado, a criação do projeto falhará. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- O tempo em segundos de espera para que o projeto seja criado. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é600.
Exemplo
ibmcloud ce project create --name myproject
Exemplo de saída
Creating project 'myproject'...
OK
ibmcloud ce project current
Exibir os detalhes do projeto atualmente apontado como destino.
ibmcloud ce project current [--output OUTPUT] [--quiet]
Opções de comando
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce project current
Exemplo de saída
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
Excluir um projeto.
ibmcloud ce project delete (--name PROJECT_NAME | --id PROJECT_ID) [--force] [--hard] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --hard- Excluir o projeto imediatamente. Se você não especificar a opção
--hard, o projeto pode ser restaurado em 7 dias usando o comandoproject restoreoureclamation restore. Este valor é opcional. O valor padrão éfalse. --id,--guid- O ID do projeto. Este valor será necessário se
--namenão for especificado. --name,-n- O nome do projeto. Este valor será necessário se
--idnão for especificado. --no-wait,--nw- Exclua o projeto e não espere que ele seja excluído. Se você especificar a opção
no-wait, a exclusão do projeto será iniciada e não esperará. Use o comandoproject getpara verificar o status do projeto. Este valor é opcional. O valor padrão éfalse. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --wait,-w- Exclua o projeto e espere que ele seja excluído. Se você especificar a opção
--wait, a exclusão do projeto esperará um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para que o projeto seja excluído. Se o projeto não for excluído dentro do período especificado--wait-timeout, a exclusão do projeto falhará. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- O período de tempo em segundos que se deve aguardar pela exclusão do projeto. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é600.
Exemplo
ibmcloud ce project delete --name myproject -f
Exemplo de saída
Deleting project 'myproject'...
OK
ibmcloud ce project get
Exibir os detalhes de um único projeto.
ibmcloud ce project get (--name PROJECT_NAME | --id PROJECT_ID) [--output OUTPUT] [--quiet]
Opções de comando
--id,--guid- O ID do projeto. Este valor será necessário se
--namenão for especificado. --name,-n- O nome do projeto. Este valor será necessário se
--idnão for especificado. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce project get --name myproject
Exemplo de saída
Getting project 'myproject'...
OK
Name: myproject
ID: abcdabcd-abcd-abcd-abcd-f1de4aab5d5d
Status: active
Selected: true
Tags: tag1, tag2
Region: us-south
Resource Group: default
Service Binding Service ID: ServiceId-1234abcd-abcd-abcd-1111-1a2b3c4d5e6f
Age: 52d
Created: Fri, 15 Jan 2021 13:32:30 -0500
Updated: Fri, 15 Jan 2021 13:32:45 -0500
Quotas:
Category Used Limit
App revisions 1 100
Apps 1 100
Build runs 0 100
Builds 0 100
Configmaps 2 100
CPU 1.025 64
Ephemeral storage 902625Ki 256G
Instances (active) 1 250
Instances (total) 2 2500
Job runs 1 100
Jobs 1 100
Memory 4400M 256G
Secrets 5 100
Subscriptions (cron) 0 100
Subscriptions (IBM Cloud Object Storage) 0 100
ibmcloud ce project list
Listar todos os projetos.
ibmcloud ce project list [--all-resource-groups] [--output OUTPUT] [--quiet] [--regions REGIONS] [--sort-by SORT_BY]
Opções de comando
--all-resource-groups,--all- Exibir projetos de todos os grupos de recursos. Por padrão, os projetos são exibidos apenas a partir do grupo de recursos atual. Este valor é opcional. O valor padrão é
false. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --regions,-r- Limite a exibição de projetos a regiões especificadas. Forneça o nome de uma ou mais regiões; por exemplo,
us-south,eu-de. Este valor é opcional. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce project list
Exemplo de saída
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
Restaurar um projeto.
ibmcloud ce project restore (--name PROJECT_NAME | --id PROJECT_ID) [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
--id,--guid- O ID do projeto. Este valor será necessário se
--namenão for especificado. --name,-n- O nome do projeto. Este valor será necessário se
--idnão for especificado. --no-wait,--nw- Restaurar o projeto e não esperar que o projeto seja restaurado. Se você especificar a opção
no-wait, a restauração do projeto começará e não irá esperar. Use o comandoproject getpara verificar o status do projeto. Este valor é opcional. O valor padrão éfalse. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --wait,-w- Restaurar o projeto e aguardar que o projeto seja restaurado. Se você especificar a opção
--wait, a restauração do projeto esperará por um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para que o projeto seja restaurado. Se o projeto não for restaurado dentro do período--wait-timeoutespecificado, a restauração do projeto falhará. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- O período de tempo em segundos a esperar para que o projeto seja restaurado. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é600.
Exemplo
Este exemplo restaura o projeto myproject que está no status soft deleted para um estado ativo. Use o comando project list para exibir uma lista de todos os projetos com os seus status.
ibmcloud ce project restore --name myproject
Exemplo de saída
Restoring project 'myproject'...
OK
ibmcloud ce project select
Selecione um projeto como o contexto atual. O projeto deve estar no status active antes que ele possa ser selecionado.
ibmcloud ce project select (--name PROJECT_NAME | --id PROJECT_ID) [--endpoint ENDPOINT] [--kubecfg] [--quiet]
Opções de comando
--endpoint,-e- O terminal para o projeto. Os valores válidos são
publiceprivate. Se a opção--endpointnão for explicitamente especificada, o comportamento será determinado pelo sistema. Se a CLI do IBM Cloud estiver conectada aprivate.cloud.ibm.com, o projeto Code Engine se comportará como se--endpointfosseprivate. Se a CLI do IBM Cloud estiver conectada acloud.ibm.com, o projeto Code Engine se comportará como se--endpointfossepublic. Este valor é opcional. --id,--guid- O ID do projeto. Este valor será necessário se
--namenão for especificado. --kubecfg,-k- Anexar o projeto ao arquivo de configuração do Kubernetes. É possível substituir o arquivo de configuração padrão do Kubernetes configurando a variável de ambiente
KUBECONFIG. Este valor é opcional. O valor padrão éfalse. --name,-n- O nome do projeto. Este valor será necessário se
--idnão for especificado. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce project select --name myproject
Exemplo de saída
Selecting project 'myproject'...
OK
ibmcloud ce project tag
Gerenciar tags de um único projeto.
ibmcloud ce project tag (--name PROJECT_NAME | --id PROJECT_ID) [--quiet] [--tag TAG] [--tag-rm TAG_RM]
Opções de comando
--id,--guid- O ID do projeto. Este valor será necessário se
--namenão for especificado. --name,-n- O nome do projeto. Este valor será necessário se
--idnão for especificado. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --tag,-t- Um rótulo para atribuir ao seu projeto. O rótulo deve ter 128 caracteres ou menos e pode conter letras, números, espaços (), pontos (.), dois pontos (:), sublinhados (_) e hifens (-). Especifique um rótulo por opção
--tag; por exemplo,--tag tagA --tag tagB. Este valor é opcional. --tag-rm,--trm- Remova um rótulo atribuído ao seu projeto. Especifique um rótulo por opção
--tag-rm. Por exemplo,--tag-rm tagA --tag-rm tagB. Este valor é opcional.
Exemplo
ibmcloud ce project tag --name myproject --tag tag1 --tag tag2
Exemplo de saída
Getting project 'myproject'...
OK
ibmcloud ce project update
Atualizar o projeto selecionado.
ibmcloud ce project update (--binding-service-id SERVICE_ID_ID | --binding-resource-group RESOURCE_GROUP_NAME | --binding-resource-group-id RESOURCE_GROUP_ID) [--quiet]
Opções de comando
--binding-resource-group,--brg- O nome de um grupo de recursos a ser usado para autenticação para as ligações de serviços desse projeto. Um ID de serviço é criado com as funções
OperatoreManagerpara todos os serviços neste grupo de recursos. Use"*"para especificar todos os grupos de recursos nessa conta. Este valor é opcional. --binding-resource-group-id,--brgid- O ID de um grupo de recursos a ser usado para autenticação para as ligações de serviço deste projeto. Um ID de serviço é criado com as funções
OperatoreManagerpara todos os serviços neste grupo de recursos. Este valor é opcional. --binding-service-id,--bsid- O ID de um ID de serviço a ser usado para autenticação para as ligações de serviços deste projeto. Esse ID de serviço deve ter a função
Operatore uma função de serviço apropriada para uma ou mais instâncias de serviço, tipos de serviço ou grupos de recursos. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce project update --binding-service-id ServiceId-1234abcd-abcd-abcd-1111-1a2b3c4d5e6f
Exemplo de saída
Configuring your project for service bindings...
Creating service binding API key 'my-project-api-key' for service ID 'my-custom-service-id'...
OK
Comandos de recuperação
Gerencie as recuperações de projeto do Code Engine. Projetos que são excluídos de forma recuperável podem ser restaurados dentro de 7 dias usando o comando reclamation restore.
ibmcloud ce reclamation delete
Exclua uma recuperação de projeto.
ibmcloud ce reclamation delete (--name PROJECT_NAME | --id PROJECT_ID) [--force] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --id,--guid- O ID do projeto. Este valor será necessário se
--namenão for especificado. --name,-n- O nome do projeto. Este valor será necessário se
--idnão for especificado. --no-wait,--nw- Exclua a recuperação do projeto e não espere que a recuperação do projeto seja excluída. Se você especificar a opção
no-wait, a exclusão de solicitação de projeto começa e não espera. Use o comandoreclamation getpara verificar o status de recuperação do projeto. Este valor é opcional. O valor padrão éfalse. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --wait,-w- Exclua a recuperação do projeto e aguarde até que a recuperação do projeto seja excluída. Se você especificar a opção
--wait, a exclusão da recuperação do projeto aguardará um tempo máximo em segundos, conforme definido pela opção--wait-timeout, para que a recuperação do projeto seja excluída. Se a recuperação do projeto não for excluída dentro do período--wait-timeoutespecificado, a exclusão da recuperação do projeto falhará. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- O tempo em segundos de espera para que a recuperação do projeto seja excluída. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é600.
Exemplo
Este exemplo exclui permanentemente o projeto myproject que está no status de soft deleted. Ao usar a opção --force com este comando, a exclusão é forçada sem confirmação. É possível usar o comando
reclamation list para exibir uma lista de todos os projetos que estão em status de soft deleted.
ibmcloud ce reclamation delete --name myproject --f
Exemplo de saída
Hard deleting project 'myproject'...
OK
ibmcloud ce reclamation get
Exiba os detalhes de uma única recuperação de projeto.
ibmcloud ce reclamation get (--name PROJECT_NAME | --id PROJECT_ID) [--output OUTPUT] [--quiet]
Opções de comando
--id,--guid- O ID do projeto. Este valor será necessário se
--namenão for especificado. --name,-n- O nome do projeto. Este valor será necessário se
--idnão for especificado. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce reclamation get --name myproject
Exemplo de saída
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
Liste todas as recuperações do projeto.
ibmcloud ce reclamation list [--all-resource-groups] [--output OUTPUT] [--quiet] [--regions REGIONS] [--sort-by SORT_BY]
Opções de comando
--all-resource-groups,--all- Exiba recuperações do projeto de todos os grupos de recursos. Por padrão, as recuperações do projeto são exibidas apenas a partir do grupo de recursos atual. Este valor é opcional. O valor padrão é
false. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --regions,-r- Limite a exibição de recuperações do projeto a regiões específicas. Forneça o nome de uma ou mais regiões; por exemplo,
us-south,eu-de. Este valor é opcional. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce reclamation list
Exemplo de saída
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
Restaure uma recuperação de projeto. Projetos que são excluídos de forma recuperável podem ser restaurados dentro de 7 dias usando o comando reclamation restore.
ibmcloud ce reclamation restore (--name PROJECT_NAME | --id PROJECT_ID) [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
--id,--guid- O ID do projeto. Este valor será necessário se
--namenão for especificado. --name,-n- O nome do projeto. Este valor será necessário se
--idnão for especificado. --no-wait,--nw- Restaure a recuperação do projeto e não espere até que a recuperação do projeto seja restaurada. Se você especificar a opção
no-wait, a restauração de recuperação do projeto começa e não espera. Use o comandoreclamation getpara verificar o status de recuperação do projeto. Este valor é opcional. O valor padrão éfalse. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --wait,-w- Restaure a recuperação do projeto e aguarde até que a recuperação do projeto seja restaurada. Se você especificar a opção
--wait, a restauração da recuperação do projeto aguardará um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para que a recuperação do projeto seja restaurada. Se a recuperação do projeto não for restaurada dentro do período--wait-timeoutespecificado, a restauração da recuperação do projeto falhará. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- O tempo em segundos de espera para que a recuperação do projeto seja restaurada. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é600.
Exemplo
Este exemplo restaura o projeto myproject que está no status soft deleted para um estado ativo. Use o comando reclamation list para exibir uma lista de todos os projetos que estão em
status de soft deleted.
ibmcloud ce reclamation restore --name myproject
Exemplo de saída
Restoring project 'myproject'...
OK
Comandos de registro
Um registro de contêiner, ou registro, é um serviço que armazena imagens de contêiner. Por exemplo, IBM Cloud Container Registry e Docker Hub são registros de contêineres. Um Container Registry pode ser público ou privado. Um Container Registry que é público não requer credenciais para acesso. Em contraste, o acesso a um registro privado requer credenciais.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos registry.
Para obter mais informações sobre como acessar registros, consulte Incluindo o acesso a um registro de contêiner privado.
Para ver a ajuda da CLI para os registry comandos, execute ibmcloud ce registry -h.
A partir da versão CLI 1.42.0, a definição e o trabalho com segredos na CLI foram unificados no grupo secret de comandos. Consulte os comandos ibmcloud ce secret Use a opção --format para especificar a categoria do segredo, como basic_auth, generic, hmac, ssh, tls, ou registry. Embora você possa continuar a usar
o registry grupo de comando, aproveite as vantagens do grupo de comando unificado secret grupo de comando unificado. Para criar um segredo para acessar um registro de contêiner, use
o comando ibmcloud ce secret create --format registry comando. Para saber mais sobre como trabalhar com segredos no Code Engine, consulte
Trabalhando com segredos.
ibmcloud ce registry create
Criar um segredo de acesso de registro de imagem.
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]
Opções de comando
-n,--name- O nome do segredo de acesso de registro de imagem. Use um nome que seja exclusivo dentro do projeto.
- O nome deve iniciar e terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 253 caracteres ou menos e pode conter letras minúsculas, números, pontos (.) e hifens (-).
Este valor é obrigatório.
--email,-e- O endereço de e-mail para acessar o servidor de registro. Este valor é opcional.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --password,-p- A senha para acessar o servidor de registro. Se a opções
--password,--password-from-filee--password-from-json-filenão forem especificadas, a senha será solicitada. Este valor é opcional. --password-from-file,--pf- O caminho para um arquivo que contém a senha para acessar o servidor de registro. A primeira linha do arquivo é usada para a senha. Se a opções
--password,--password-from-filee--password-from-json-filenão forem especificadas, a senha será solicitada. Este valor é opcional. --password-from-json-file,--pfj- O caminho para um arquivo JSON contendo a senha para acessar o servidor de registro. O campo
apikeyé usado para a senha. Se a opções--password,--password-from-filee--password-from-json-filenão forem especificadas, a senha será solicitada. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --server,-s- A URL do servidor de registro. Este valor é opcional. O valor padrão é
us.icr.io. --username,-u- O nome do usuário para acessar o servidor de registro. Este valor é opcional. O valor padrão é
iamapikey.
Exemplo
O exemplo a seguir cria um acesso de registro de imagem chamado myregistry para uma instância do Container Registry localizada em us.icr.io e usa um nome do usuário de iamapikey e a chave de API do
IAM como senha.
ibmcloud ce registry create --name myregistry --server us.icr.io --username iamapikey --password API_KEY
Exemplo de saída
Creating image registry access secret myregistry...
OK
ibmcloud ce registry delete
Excluir um segredo de acesso de registro de imagem.
ibmcloud ce registry delete --name NAME [--force] [--ignore-not-found] [--quiet]
Opções de comando
--name,-n- O nome do segredo de acesso de registro de imagem. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce registry delete --name myregistry -f
Exemplo de saída
Deleting image registry access secret myregistry...
OK
ibmcloud ce registry get
Exibir os detalhes de um segredo de acesso de registro de imagem.
ibmcloud ce registry get --name NAME [--decode] [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- O nome do segredo de acesso de registro de imagem. Este valor é obrigatório.
--decode,-d- Mostra a saída
Dataconforme decodificada nos detalhes. Se essa opção não for especificada, os detalhesDataserão codificados em Base64. Este valor é opcional. O valor padrão éfalse. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce registry get --name myregistry
Exemplo de saída
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
Listar todos os segredos de acesso de registro de imagem em um projeto.
ibmcloud ce registry list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce registry list
Exemplo de saída
Listing image registry access secrets...
OK
Name Age
myregistry 19m22s
ibmcloud ce registry update
Atualizar um segredo de acesso de registro de imagem.
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]
Opções de comando
--name,-n- O nome do segredo de acesso de registro de imagem. Este valor é obrigatório.
--email,-e- O endereço de e-mail para acessar o servidor de registro. Este valor é opcional.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --password,-p- A senha para acessar o servidor de registro. Este valor é opcional.
--password-from-file,--pf- O caminho para um arquivo que contém a senha para acessar o servidor de registro. A primeira linha do arquivo é usada para a senha. Este valor é opcional.
--password-from-json-file,--pfj- O caminho para um arquivo JSON contendo a senha para acessar o servidor de registro. O campo
apikeyé usado para a senha. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --server,-s- A URL do servidor de registro. Este valor é opcional.
--username,-u- O nome do usuário para acessar o servidor de registro. Este valor é opcional.
Exemplo
O exemplo a seguir atualiza uma senha para o acesso de registro da imagem chamado myregistry.
ibmcloud ce registry update --name myregistry --password NEW_API_KEY
Exemplo de saída
Getting image registry access secret 'myregistry'...
Updating image registry access secret 'myregistry'...
OK
Comandos de repositório
Um repositório de código, como o GitHub ou o GitLab, armazena código-fonte. Com o Code Engine, é possível incluir acesso em um repositório de código privado e, em seguida, fazer referência a esse repositório por meio de sua compilação.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos repo.
Para obter mais informações sobre como acessar os repositórios, consulte Acessando repositórios de código privado.
Para ver a ajuda da CLI para os repo comandos, execute ibmcloud ce repo -h.
A partir da versão CLI 1.42.0, a definição e o trabalho com segredos na CLI foram unificados no grupo secret de comandos. Consulte os comandos ibmcloud ce secret Use a opção --format para especificar a categoria do segredo, como basic_auth, generic, hmac, ssh, tls, ou registry. Embora você possa continuar a usar
o repo grupo de comando, aproveite as vantagens do grupo de comando unificado secret grupo de comando unificado. Para criar um segredo para acessar um serviço com uma chave SSH, como
para autenticar em um Git repositório como GitHub ou GitLab, usar o ibmcloud ce secret create --format ssh comando. Um segredo de SSH também
é utilizado como um segredo de acesso do repositório do Git Para saber mais sobre como trabalhar com segredos no Code Engine, consulte Trabalhando com segredos.
ibmcloud ce repo create
Criar um segredo de acesso do repositório 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]
Opções de comando
--host,--ho- O endereço do host, por exemplo,
github.com. Este valor é obrigatório. --key-path,--kp- O caminho para o seu arquivo de chave privada SSH não criptografado. Se você usar a sua chave SSH privada pessoal, então, este arquivo geralmente estará localizado em
$HOME/.ssh/id_rsa(Mac OS ou Linux) ou em%HOMEPATH%\.ssh\id_rsa(Windows). Este valor é obrigatório. -n,--name- O nome do segredo de acesso do repositório Git. Use um nome que seja exclusivo dentro do projeto.
- O nome deve iniciar e terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 253 caracteres ou menos e pode conter letras minúsculas, números, pontos (.) e hifens (-).
Este valor é obrigatório.
--known-hosts-path,--khp- O caminho para os seus arquivos host conhecido. Este valor é um recurso de segurança para assegurar que a chave privada seja usada apenas para autenticar em hosts que você acessou anteriormente, especificamente, os hosts do GitHub ou do
GitLab. Este arquivo geralmente está localizado em
$HOME/.ssh/known_hosts(Mac OS ou Linux) ou em%HOMEPATH%\.ssh\known_hosts(Windows). Este valor é opcional. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
O comando a seguir cria um segredo de acesso Git chamado github para host github.com e é autenticado com uma chave SSH localizada em /<filepath>/.ssh/id_rsa, em que <filepath> é o caminho em seu sistema.
ibmcloud ce repo create -n github --key-path /<filepath>/.ssh/id_rsa --host github.com
Exemplo de saída
Creating Git access secret github...
OK
ibmcloud ce repo delete
Excluir um segredo de acesso do repositório Git.
ibmcloud ce repo delete --name NAME [--force] [--ignore-not-found] [--quiet]
Opções de comando
--name,-n- O nome do segredo de acesso do repositório Git. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce repo delete --name github
Exemplo de saída
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
Exibir os detalhes de um segredo de acesso do repositório Git.
ibmcloud ce repo get --name NAME [--decode] [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- O nome do segredo de acesso do repositório Git. Este valor é obrigatório.
--decode,-d- Mostra a saída
Dataconforme decodificada nos detalhes. Se essa opção não for especificada, os detalhesDataserão codificados em Base64. Este valor é opcional. O valor padrão éfalse. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce repo get -n github
Exemplo de saída
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
Listar todos os segredos de acesso do repositório Git em um projeto.
ibmcloud ce repo list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce repo list
Exemplo de saída
Listing Git access secrets...
OK
Name Age
github 13m0s
ibmcloud ce repo update
Atualizar um segredo de acesso de repositório Git.
ibmcloud ce repo update --name SECRET_NAME [--host HOST] [--key-path KEY_PATH] [--known-hosts-path KNOWN_HOSTS_PATH] [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- O nome do segredo de acesso do repositório Git. Este valor é obrigatório.
--host,--ho- O endereço do host, por exemplo,
github.com. Este valor é opcional. --key-path,--kp- O caminho para o seu arquivo de chave privada SSH não criptografado. Se você usar a sua chave SSH privada pessoal, então, este arquivo geralmente estará localizado em
$HOME/.ssh/id_rsa(Mac OS ou Linux) ou em%HOMEPATH%\.ssh\id_rsa(Windows). Este valor é opcional. --known-hosts-path,--khp- O caminho para os seus arquivos host conhecido. Este valor é um recurso de segurança para assegurar que a chave privada seja usada apenas para autenticar em hosts que você acessou anteriormente, especificamente, os hosts do GitHub ou do
GitLab. Este arquivo geralmente está localizado em
$HOME/.ssh/known_hosts(Mac OS ou Linux) ou em%HOMEPATH%\.ssh\known_hosts(Windows). Este valor é opcional. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
O comando a seguir atualiza um segredo de acesso Git chamado github para usar um novo host.
ibmcloud ce repo update -n github --host NEW_HOST
Exemplo de saída
Getting Git access secret 'github'...
Updating Git access secret 'github'...
OK
Comandos de revisão
Um aplicativo ou app executa o seu código para entregar solicitações de HTTP. Além das solicitações de HTTP tradicionais, o IBM Cloud® Code Engine também suporta aplicativos que usam WebSockets como seu protocolo de comunicações. Um app contém uma ou mais revisões. Uma revisão representa uma versão imutável das propriedades de configuração do app. Cada atualização de uma propriedade de configuração do app cria uma nova revisão do app.
Use comandos revision para gerenciar revisões de aplicativo.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos revision.
Para obter mais informações sobre como trabalhar com revisões para apps, consulte Implementando aplicativos.
É possível usar revision ou rev em seus comandos revision. Para ver a ajuda da CLI para os comandos revision, execute ibmcloud ce revision -h.
ibmcloud ce revision delete
Excluir uma revisão de aplicativo.
ibmcloud ce revision delete --name REVISION_NAME [--force] [--ignore-not-found] [--quiet]
Opções de comando
--name,-n- O nome da revisão de aplicativo. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce revision delete -n newapp-mytest-00004 -f
Exemplo de saída
Deleting application revision 'newapp-mytest-00004'...
OK
ibmcloud ce revision events
Exiba os eventos do sistema de instâncias de revisão do aplicativo. Eventos do sistema são retidos por até 60 minutos.
ibmcloud ce revision events (--instance REVISION_INSTANCE | --revision REVISION_NAME) [--output OUTPUT] [--quiet]
Opções de comando
--instance,-i- O nome de uma instância do aplicativo específica. Use o comando
rev getpara localizar o nome da instância. Este valor será necessário se--revisionnão for especificado. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --revision,--rev,-r,--name,-n- Exibir os eventos de todas as instâncias da revisão do aplicativo especificada. Este valor será necessário se
--instancenão for especificado.
Exemplo
ibmcloud ce revision events -n myapp-00001
Exemplo de saída
O Code Engine retém apenas a revisão inativa mais recente de seu aplicativo, além de sua revisão ativa do app. As revisões mais antigas não são retidas.
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
Exibir os detalhes de uma revisão de aplicativo.
ibmcloud ce revision get --name REVISION_NAME [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- O nome da revisão de aplicativo. Este valor é obrigatório.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce revision get --name newapp-mytest-00002
Exemplo de saída
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
Listar todas as revisões de aplicativo em um projeto.
ibmcloud ce revision list [--application APPLICATION] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--application,--app,-a- Use esta opção para exibir revisões apenas do aplicativo especificado. Este valor é opcional.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce revision list
Exemplo de saída
O Code Engine retém apenas a revisão inativa mais recente de seu aplicativo, além de sua revisão ativa do app. As revisões mais antigas não são retidas.
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
Exibir os logs das instâncias de revisão do aplicativo.
ibmcloud ce revision logs (--instance REVISION_INSTANCE | --revision REVISION_NAME) [--all-containers] [--follow] [--output OUTPUT] [--quiet] [--tail TAIL] [--timestamps]
Opções de comando
--all-containers,--all- Exibir os logs de todos os contêineres das instâncias de revisão de aplicativos especificadas. Este valor é opcional. O valor padrão é
false. --follow,-f- Seguir os logs das instâncias de revisão do aplicativo. Use esta opção para transmitir logs de instâncias de revisão de aplicativos. Se você especificar a opção
--follow, deverá inserirCtrl+Cpara finalizar este comando de log. Este valor é opcional. O valor padrão éfalse. --instance,-i- O nome de uma instância de revisão de aplicativo específica. Use o comando
revision getpara localizar o nome da instância. Este valor será necessário se--revisionnão for especificado. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --revision,--rev,-r,--name,-n- Exiba os logs de todas as instâncias da revisão do aplicativo especificada. Este valor será necessário se
--instancenão for especificado. --tail,-t- Limite a exibição de logs de contêineres das instâncias de revisão de aplicativos especificadas a um número máximo de linhas recentes por contêiner. Por exemplo, para exibir as últimas
3linhas dos logs dos contêineres das instâncias de revisão de aplicativo determinadas, especifique--tail 3. Se esta opção não for especificada, todas as linhas dos logs dos contêineres das instâncias de revisão do aplicativo especificadas serão exibidas. Este valor é opcional. O valor padrão é-1. --timestamps,--ts- Incluir registros de data e hora em cada linha na saída de log. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce revision logs -n myapp-00001
Exemplo de saída
O Code Engine retém apenas a revisão inativa mais recente de seu aplicativo, além de sua revisão ativa do app. As revisões mais antigas não são retidas.
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
Comandos de segredo
Um segredo fornece um método para incluir informações de configuração sensíveis, como senhas ou chaves SSH, para a sua implementação. Ao referenciar valores do seu segredo, você pode separar informações confidenciais da sua implantação para manter seu aplicativo, função ou trabalho portátil. Qualquer pessoa que estiver autorizada para o seu projeto também pode visualizar os seus segredos; certifique-se de saber que as informações secretas podem ser compartilhadas com esses usuários. Os segredos contêm informações em pares chave-valor.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos secret.
Para obter mais informações sobre como trabalhar com segredos, consulte Trabalhando com segredos
Para ver a ajuda da CLI para os secret comandos, execute ibmcloud ce secret -h.
A partir da versão CLI 1.42.0, a definição e o trabalho com segredos na CLI foram unificados no grupo secret de comandos. Use a opção --format para especificar a categoria do segredo, como basic_auth,
generic, hmac, ssh, tls, ou registry. O valor padrão da opção --format é generic.
ibmcloud ce secret create
Crie um segredo.
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]
Opções de comando
--access-key-id,--akid- Especifique o access_key_id da credencial HMAC. Este valor é opcional.
--access-key-id-prompt- Solicite o access_key_id da credencial HMAC. Este valor é opcional. O valor padrão é
false. --cert-chain-file,--ccf- Especifique um arquivo contendo a cadeia de certificados fornecida pela sua autoridade certificadora para um segredo TLS. Deve-se fornecer o caminho para o arquivo como um valor. Esse valor é necessário para segredos do
tls. Este valor é opcional. --email,--em- O endereço de email para acessar o servidor de registro para um segredo de registro Esse valor se aplica apenas para os segredos do
registry. Este valor é opcional. --format,--fo- O formato do segredo. Os valores válidos são
basic_auth,generic,hmac,registry,ssh, outls. Este valor é opcional. O valor padrão égeneric. --from-env-file,-e- Criar um segredo genérico por meio de um arquivo que contém uma ou mais linhas que correspondem ao formato
KEY=VALUE. Deve-se fornecer o caminho para o arquivo como um valor. Cada linha do arquivo especificado é incluída como um par chave-valor. Quaisquer linhas no arquivo especificado que estejam vazias ou começam com#serão ignoradas. Este valor será necessário se--from-literalou--from-filenão for especificado. Essa opção pode ser especificada múltiplas vezes. Esse valor se aplica apenas para os segredos dogeneric. --from-file,-f- Criar um segredo genérico por meio de um arquivo. Deve-se fornecer o caminho para o arquivo como um valor. Este valor será necessário se
--from-literalou--from-env-filenão for especificado. Essa opção pode ser especificada múltiplas vezes. Esse valor se aplica apenas para os segredos dogeneric. --from-json-file,--json- O caminho para um arquivo que contém os valores secretos no formato JSON. Essa opção é compatível com o formato secreto
hmac. Esse valor é opcional. --from-literal,-l- Criar um segredo genérico por meio de um par chave-valor. Deve estar em formato
KEY=VALUE. Este valor será necessário se--from-fileou--from-env-filenão for especificado. Essa opção pode ser especificada múltiplas vezes. Esse valor se aplica apenas para os segredos dogeneric. --key-path,--kp- O caminho para seu arquivo de chave privada SSH não criptografado para um segredo SSH. Se você usar a sua chave SSH privada pessoal, então, este arquivo geralmente estará localizado em
$HOME/.ssh/id_rsa(Mac OS ou Linux) ou em%HOMEPATH%\.ssh\id_rsa(Windows). Esse valor é necessário para segredos dossh. Este valor é opcional. --known-hosts-path,--khp- O caminho para o arquivo de hosts conhecidos para um segredo do SSH Este valor é um recurso de segurança para assegurar que a chave privada seja usada apenas para autenticar em hosts que você acessou anteriormente, especificamente, os
hosts do GitHub ou do GitLab. Este arquivo geralmente está localizado em
$HOME/.ssh/known_hosts(Mac OS ou Linux) ou em%HOMEPATH%\.ssh\known_hosts(Windows). Esse valor se aplica apenas para os segredos dossh. Este valor é opcional. -n,--name- O nome do segredo. Use um nome que seja exclusivo dentro do projeto.
- O nome deve iniciar e terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 253 caracteres ou menos e pode conter letras minúsculas, números, pontos (.) e hifens (-).
Este valor é opcional.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --password,--pw- A senha para um segredo de autenticação básica ou de registro Se a opções
--password,--password-from-filee--password-from-json-filenão forem especificadas, a senha será solicitada. Esse valor é necessário para os segredosbasic_autheregistry. Este valor é opcional. --password-from-file,--spf- O caminho para um arquivo que contém a senha para um segredo de autenticação básica ou de registro A primeira linha do arquivo é usada para a senha. Se a opções
--password,--password-from-filee--password-from-json-filenão forem especificadas, a senha será solicitada. Deve-se fornecer o caminho para o arquivo como um valor. Esse valor é necessário para os segredosbasic_autheregistry. Este valor é opcional. --password-from-json-file,--spfj- O caminho para um arquivo JSON contendo a senha para uma autenticação básica ou segredo de registro. O campo
apikeyé usado para a senha. Se a opções--password,--password-from-filee--password-from-json-filenão forem especificadas, a senha será solicitada. Deve-se fornecer o caminho para o arquivo como um valor. Esse valor é necessário para os segredosbasic_autheregistry. Este valor é opcional. --private-key-file,--pkf- Especifique um arquivo que contenha a chave privada para um segredo TLS que corresponda à cadeia de certificados especificada com a
cert-chain-fileopção. Deve-se fornecer o caminho para o arquivo como um valor. Esse valor é necessário para segredos dotls. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Essa opção se aplica para os segredos
basic_auth,generic,registry,sshetlsEste valor é opcional. O valor padrão éfalse. --secret-access-key,--sak- Especifique o secret_access_key da credencial HMAC. Este valor é opcional.
--secret-access-key-prompt- Solicite o secret_access_key da credencial HMAC. Este valor é opcional. O valor padrão é
false. --server,-s- O endereço URL do servidor de registro para um segredo de registro. Essa opção é necessária para os segredos do
registryEste valor é opcional. O valor padrão éus.icr.io. --username,-u- O nome de usuário para sua autenticação básica ou segredo de registro. Essa opção é necessária para os segredos
basic_autheregistryEste valor é opcional.
Exemplo de um segredo de autenticação básica
Um segredo de autenticação básico contém uma chave username e password e é usado quando você acessa um serviço que requer autenticação básica HTTP.
Para ver a ajuda da CLI para criar um segredo de autenticação básica, execute ibmcloud ce secret create --format basic_auth.
O exemplo a seguir cria um segredo de autenticação básica chamado mysecret-basicauth. Esse segredo contém o nome do usuário myusername e o valor da senha é obtido de um arquivo na máquina local. Se a senha não for
fornecida a partir de um arquivo ou arquivo JSON, será solicitado que você insira o valor da senha.
ibmcloud ce secret create --name mysecret-basicauth --format basic_auth --username myusername --password-from-file ./password.txt
Saída de exemplo para um segredo de autenticação básica
Creating basic_auth secret 'mysecret-basicauth'...
OK
Exemplo de um segredo genérico
Um segredo genérico armazena pares chave-valor simples e Code Engine não faz suposições sobre os pares chave-valor definidos nem sobre o uso pretendido do segredo.
Para ver a ajuda da CLI para criar um segredo genérico, execute ibmcloud ce secret create ou ibmcloud ce secret create --format generic.
Observe que --format generic é o padrão quando você cria um segredo com o comando secret create na CLI.
O exemplo a seguir cria um segredo genérico denominado mysecret-generic e o valor desse segredo é especificado para um par chave-valor com a opção --from-literal.
ibmcloud ce secret create --name mysecret-generic --format generic --from-literal "TARGET=My literal secret"
Saída de exemplo para um segredo genérico
Creating generic secret 'mysecret-generic'...
OK
Exemplo de um segredo genérico com valores de um arquivo
O exemplo a seguir cria um segredo denominado mysecret-fromfile com valores de um arquivo. Usando a opção --from-file para apontar para um arquivo, todo o conteúdo do arquivo se tornará o valor para o par chave-valor.
ibmcloud ce secret create --name mysecret-genericfromfile --from-file ./value1.txt --from-file ./value2.txt
Exemplo de saída de um segredo genérico com valores de um arquivo
Creating secret mysecret-genericfromfile...
OK
Exemplo de um segredo HMAC
Um segredo HMAC contém uma chave access_key_id e uma secret_access_key e é usado com ferramentas e bibliotecas S3-compatible que exigem autenticação, mas não oferecem suporte a chaves de API IBM Cloud® Identity
and Access Management.
Para ver a ajuda da CLI para criar um segredo HMAC, execute ibmcloud ce secret create --format hmac.
O exemplo a seguir cria um segredo HMAC com o nome mysecret-hmac. Esse segredo contém os valores access_key_id e secret_access_key fornecidos quando solicitado. Se qualquer uma das duas opções não for
fornecida com o comando ou em um arquivo JSON, você será solicitado a inserir seus valores.
ibmcloud ce secret create --name mysecret-hmac --format hmac --access-key-id-prompt --secret-access-key-prompt
Exemplo de saída para um segredo HMAC
Creating hmac_auth secret 'mysecret-hmac'...
OK
Exemplo de um segredo de registro
Um segredo de registro armazena as credenciais para acessar um registro de contêiner
Para ver a ajuda da CLI para criar um segredo de registro, execute ibmcloud ce secret create --format registry.
O exemplo a seguir cria um segredo de registro denominado mysecret-registry para uma instância IBM Cloud Container Registry que está no servidor de registro do us.icr.io e especifica credenciais para username e password.
ibmcloud ce secret create --name mysecret-registry --format registry --server us.icr.io --username iamapikey --password API_KEY
Saída de exemplo para um segredo de registro
Creating registry secret `mysecret-registry`...
OK
Exemplo de um segredo do SSH
Um segredo SSH armazena credenciais para autenticar em um serviço com uma chave SSH; por exemplo, autenticando em um repositório Git, como GitHub ou GitLab.
Para ver a ajuda da CLI para criar um segredo de SSH, execute ibmcloud ce secret create --format ssh.
O exemplo a seguir cria um segredo SSH que é denominado mysecret-ssh para um host que está incluído no arquivo known_hosts e se autentica com um arquivo de chave privada SSH não criptografado localizado em /<filepath>/.ssh/<key_name>,
em que <filepath> é o caminho em seu sistema. Esse comando requer um nome e um caminho de chave e também permite outros argumentos opcionais como o caminho para o arquivo de hosts conhecidos.
ibmcloud ce secret create --name mysecret-ssh --format ssh --key-path ~/.ssh/<key_name> --known-hosts-path ~/.ssh/known_hosts
Saída de exemplo para um segredo SSH
Creating SSH secret `mysecret-ssh`...
OK
Exemplo de um segredo do TLS
Um segredo do Transport Layer Security (TLS) contém um certificado TLS assinado, incluindo todos os seus certificados intermediários e sua chave privada correspondente de uma autoridade de certificação (CA). Use os segredos TLS ao trabalhar com mapeamentos de domínio customizados.
Para ver a ajuda da CLI para criar um segredo do TLS, execute ibmcloud ce secret create --format tls.
O exemplo a seguir cria um segredo do TLS denominado mysecret-tls. A cadeia de certificados que corresponde ao domínio customizado está contida no arquivo certificate.txt e o arquivo de chave privada correspondente
está contido no arquivo privatekey.txt Ambos os arquivos estão localizados no diretório raiz da estação de trabalho local.
ibmcloud ce secret create --name mysecret-tls --format tls --cert-chain-file certificate.txt --private-key-file privatekey.txt
Saída de exemplo para um segredo TLS
Creating TLS secret `mysecret-tls`...
OK
ibmcloud ce secret delete
Excluir um segredo.
ibmcloud ce secret delete --name SECRET_NAME [--force] [--ignore-not-found] [--quiet]
Opções de comando
--name,-n- O nome do segredo. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce secret delete --name mysecret-genericfromfile -f
Exemplo de saída
Deleting secret mysecret-genericfromfile...
OK
ibmcloud ce secret get
Exiba os detalhes de um segredo.
ibmcloud ce secret get --name SECRET_NAME [--decode] [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- O nome do segredo. Este valor é obrigatório.
--decode,-d- Mostra a saída
Dataconforme decodificada nos detalhes. Se essa opção não for especificada, os detalhesDataserão codificados em Base64. Este valor é opcional. O valor padrão éfalse. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce secret get --name mysecret-basicauth
Exemplo de saída
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
Listar todos os segredos em um projeto.
ibmcloud ce secret list [--all] [--format FORMAT] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--all,-a- Exibir todos os segredos de todos os formatos, incluindo
basic_auth,generic,registry,ssh,tlseothersegredos que não são gerenciados pelo Code Engine. Este valor é opcional. O valor padrão éfalse. --format,--fo- Especifique essa opção para filtrar a exibição de segredos. Os valores válidos são
basic_auth,generic,registry,sshetls. Este valor é opcional. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
Este comando lista todos os segredos em um projeto
ibmcloud ce secret list
Exemplo de saída
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
Atualizar um segredo.
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]
Opções de comando
--name,-n- O nome do segredo. Este valor é obrigatório.
--access-key-id,--akid- Especifique o access_key_id da credencial HMAC. Este valor é opcional.
--access-key-id-prompt- Solicite o access_key_id da credencial HMAC. Este valor é opcional. O valor padrão é
false. --cert-chain-file,--ccf- Especifique um arquivo contendo a cadeia de certificados fornecida pela sua autoridade certificadora para um segredo TLS. Deve-se fornecer o caminho para o arquivo como um valor. Este valor é opcional.
--email,--em- O endereço de email para acessar o servidor de registro para um segredo de registro Este valor é opcional.
--from-env-file,-e- Atualizar um segredo genérico por meio de um arquivo que contém uma ou mais linhas que correspondem ao formato
KEY=VALUE. Deve-se fornecer o caminho para o arquivo como um valor. Cada linha do arquivo especificado é incluída como um par chave-valor. Quaisquer linhas no arquivo especificado que estejam vazias ou começam com#serão ignoradas. Este valor será necessário se--from-literalou--from-filenão for especificado. --from-file,-f- Atualizar um segredo genérico por meio de um arquivo. Deve-se fornecer o caminho para o arquivo como um valor. Este valor será necessário se
--from-literalou--from-env-filenão for especificado. --from-json-file,--json- O caminho para um arquivo que contém os valores secretos no formato JSON. Essa opção é compatível com o formato secreto
hmac. Esse valor é opcional. --from-literal,-l- Atualizar um segredo genérico por meio de um par chave-valor. Deve estar em formato
KEY=VALUE. Este valor será necessário se--from-fileou--from-env-filenão for especificado. Essa opção pode ser especificada múltiplas vezes. --key-path,--kp- O caminho para seu arquivo de chave privada SSH não criptografado para um segredo SSH. Se você usar a sua chave SSH privada pessoal, então, este arquivo geralmente estará localizado em
$HOME/.ssh/id_rsa(Mac OS ou Linux) ou em%HOMEPATH%\.ssh\id_rsa(Windows). Este valor é opcional. --known-hosts-path,--khp- O caminho para o arquivo de hosts conhecidos para um segredo do SSH Este valor é um recurso de segurança para assegurar que a chave privada seja usada apenas para autenticar em hosts que você acessou anteriormente, especificamente, os
hosts do GitHub ou do GitLab. Este arquivo geralmente está localizado em
$HOME/.ssh/known_hosts(Mac OS ou Linux) ou em%HOMEPATH%\.ssh\known_hosts(Windows). Este valor é opcional. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --password,--pw- A senha para um segredo de autenticação básica ou de registro Se a opções
--password,--password-from-filee--password-from-json-filenão forem especificadas, a senha será solicitada. Este valor é opcional. --password-from-file,--spf- O caminho para um arquivo que contém a senha para um segredo de autenticação básica ou de registro A primeira linha do arquivo é usada para a senha. Se a opções
--password,--password-from-filee--password-from-json-filenão forem especificadas, a senha será solicitada. Deve-se fornecer o caminho para o arquivo como um valor. Este valor é opcional. --password-from-json-file,--spfj- O caminho para um arquivo JSON contendo a senha para uma autenticação básica ou segredo de registro. O campo
apikeyé usado para a senha. Se a opções--password,--password-from-filee--password-from-json-filenão forem especificadas, a senha será solicitada. Deve-se fornecer o caminho para o arquivo como um valor. Este valor é opcional. --private-key-file,--pkf- Especifique um arquivo que contenha a chave privada para um segredo TLS que corresponda à cadeia de certificados especificada com a
cert-chain-fileopção. Deve-se fornecer o caminho para o arquivo como um valor. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --rm- Remover um par chave-valor individual em um segredo genérico especificando o nome da chave. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--secret-access-key,--sak- Especifique o secret_access_key da credencial HMAC. Este valor é opcional.
--secret-access-key-prompt- Solicite o secret_access_key da credencial HMAC. Este valor é opcional. O valor padrão é
false. --server,-s- O endereço URL do servidor de registro para um segredo de registro. Este valor é opcional. O valor padrão é
us.icr.io. --username,-u- O nome de usuário para sua autenticação básica ou segredo de registro. Este valor é opcional.
Exemplo
Este exemplo atualiza um segredo do TLS com um certificado atualizado e uma chave privada
ibmcloud ce secret update --name mysecret-tls --cert-chain-file certificate2.txt --private-key-file privatekey2.txt
Exemplo de saída
Updating secret mysecret-tls..
OK
Comandos do COS de assinatura
Muitas vezes, em ambientes distribuídos, você deseja que os seus aplicativos ou tarefas reajam a mensagens (eventos) que são geradas por meio de outros componentes, que geralmente são chamados de produtores de evento. Com o Code Engine, seus aplicativos ou tarefas podem receber eventos de interesse assinando os produtores de evento. As informações do evento são recebidas como solicitações de HTTP POST para aplicativos e como variáveis de ambiente para tarefas.
O produtor de evento do Object Storage gera eventos conforme as mudanças são feitas nos objetos em seus depósitos de armazenamento de objetos. Por exemplo, à medida que objetos são incluídos em um depósito, um aplicativo pode receber um evento e, em seguida, executar uma ação com base nessa mudança, talvez consumindo esse novo objeto.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos subscription cos.
Para obter mais informações sobre como trabalhar com as assinaturas do IBM Cloud Object Storage, consulte Trabalhando com o produtor de evento do IBM Cloud Object Storage. Consulte Introdução às assinaturas para obter mais informações sobre como trabalhar com assinaturas no Code Engine.
É possível usar subscription ou sub em seus comandos subscription cos. Para ver a ajuda da CLI para o comando subscription cos, execute ibmcloud ce sub cos -h.
ibmcloud ce subscription cos create
Crie uma inscrição de evento do 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]
Opções de comando
--bucket,-b- O depósito para eventos. O destino e o depósito devem estar na mesma região do projeto. Este valor é obrigatório.
--destination,-d- O nome do aplicativo ou recurso da tarefa que você deseja que receba eventos; por exemplo,
myapp. Se necessário, use a opção--pathpara qualificar ainda mais um destino de app. Este valor é obrigatório. -n,--name- O nome da inscrição de evento do IBM Cloud Object Storage. Use um nome que seja exclusivo dentro do projeto.
- O nome deve iniciar e terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 253 caracteres ou menos e pode conter letras minúsculas, números, pontos (.) e hifens (-).
Este valor é obrigatório.
--destination-type,--dt- O tipo do
destination. Os valores válidos sãoappejob. Este valor é opcional. O valor padrão éapp. --event-type,-e- Os tipos de evento para assistir. Os valores válidos são
delete,write, eall. Este valor é opcional. O valor padrão éall. --extension,--ext- Configurar extensões do CloudEvents para enviar ao destino. Deve estar em formato
NAME=VALUE. Essa ação inclui uma nova extensão CloudEvents ou substitui um atributo CloudEvent existente. Especifique uma extensão de acordo com a opção--extension; por exemplo,--ext extA=A --ext extB=B. Este valor é opcional. --force,-f- Force para criar uma inscrição de evento do IBM Cloud Object Storage. Esta opção ignora a validação do destino especificado. Este valor é opcional. O valor padrão é
false. --no-wait,--nw- Crie a inscrição de evento do IBM Cloud Object Storage e não espere que a inscrição esteja pronta. Se você especificar a opção
--no-wait, a criação de assinatura será iniciada e não esperará. Use o comandosubscription cos getpara verificar o status da inscrição. Este valor é opcional. O valor padrão éfalse. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --path- O caminho dentro do aplicativo
destinationno qual os eventos são encaminhados; por exemplo,/events. O caminho padrão é a URL raiz do aplicativodestination. Essa opção poderá ser especificada apenas sedestination-typeforapp. Este valor é opcional. --prefix,-p- Prefixo do objeto do IBM Cloud Object Storage. Este valor é opcional.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --suffix,-s- Sufixo do objeto do IBM Cloud Object Storage. Considere o tipo de seu arquivo ao especificar o sufixo. Este valor é opcional.
--wait,-w- Crie a inscrição de evento do IBM Cloud Object Storage e aguarde a inscrição estar pronta. Se você especificar a opção
--wait, a criação da assinatura irá esperar um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para que a assinatura fique pronta. Se a assinatura não estiver pronta no período--wait-timeoutespecificado, a criação da inscrição de evento do IBM Cloud Object Storage falhará. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- A duração de tempo em segundos a aguardar até que a inscrição de evento do IBM Cloud Object Storage esteja pronta. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é15.
Exemplo
A assinatura do IBM Cloud Object Storage atende mudanças em um depósito do Object Storage. O exemplo a seguir cria uma assinatura do COS chamada mycosevent para um depósito chamado mybucket que é anexado a um app
chamado myapp. A opção --destination-type especifica o tipo do destination que é app ou job. Para este exemplo, o --destination-type é app, que
é o padrão para esta opção. O evento é enviado para o caminho /events utilizando a opção --path para que o evento seja enviado para https://<base application URL>/events.
ibmcloud ce subscription cos create --name mycosevent --destination myapp --bucket mybucket --destination-type app --path /events
Exemplo de saída
Creating COS source 'mycosevent'...
Run 'ibmcloud ce subscription cos get -n mycosevent' to check the COS source status.
OK
ibmcloud ce subscription cos delete
Exclua uma inscrição de evento do 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]
Opções de comando
--name,-n- O nome da inscrição de evento do IBM Cloud Object Storage. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --no-wait,--nw- Exclua a inscrição de evento do IBM Cloud Object Storage e não espere que a inscrição seja excluída. Se você especificar a opção
--no-wait, a exclusão da assinatura será iniciada e não esperará. Use o comandosubscription cos getpara verificar o status da inscrição. Este valor é opcional. O valor padrão éfalse. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --wait,-w- Exclua a inscrição de evento do IBM Cloud Object Storage e aguarde que a inscrição seja excluída. Se você especificar a opção
--wait, a exclusão da assinatura irá esperar um tempo máximo em conjuntos, conforme configurado pela opção--wait-timeout, para que a assinatura seja excluída. Este comando é encerrado quando a assinatura é excluída ou sempre que--wait-timeouté atingido, o que ocorrer primeiro. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- A duração de tempo em segundos para aguardar a inscrição de evento do IBM Cloud Object Storage ser excluída. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é15.
Exemplo
ibmcloud ce subscription cos delete --name mycosevent -f
Exemplo de saída
Deleting COS source 'mycosevent'...
OK
ibmcloud ce subscription cos get
Exiba os detalhes de uma inscrição de evento do IBM Cloud Object Storage. Os atributos exibidos incluem Name, Destination, Bucket, Event Type, Prefix, Suffix, Ready e Age. Para ver detalhes específicos, anexe | grep <attribute>.
ibmcloud ce subscription cos get --name COS_SOURCE_NAME [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- O nome da inscrição de evento do IBM Cloud Object Storage. Este valor é obrigatório.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce subscription cos get --name mycosevent
Exemplo de saída
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
Quando Ready for true, a assinatura do COS estará pronta para acionar eventos por mudanças no depósito do COS.
ibmcloud ce subscription cos list
Liste todas as inscrições de evento do IBM Cloud Object Storage em um projeto.
ibmcloud ce subscription cos list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce subscription cos list
Exemplo de saída
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
Atualize uma inscrição de evento do 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]
Opções de comando
--name,-n- O nome da inscrição de evento do IBM Cloud Object Storage. Este valor é obrigatório.
--destination,-d- O nome do aplicativo ou recurso da tarefa que você deseja que receba eventos; por exemplo,
myapp. Se necessário, use a opção--pathpara qualificar ainda mais um destino de app. Este valor é opcional. --destination-type,--dt- O tipo do
destination. Os valores válidos sãoappejob. Este valor é opcional. --event-type,-e- Os tipos de evento para assistir. Os valores válidos são
delete,write, eall. Este valor é opcional. --extension,--ext- Configurar extensões do CloudEvents para enviar ao destino. Deve estar em formato
NAME=VALUE. Essa ação inclui uma nova extensão CloudEvents ou substitui um atributo CloudEvent existente. Especifique uma extensão de acordo com a opção--extension; por exemplo,--ext extA=A --ext extB=B. Este valor é opcional. --extension-rm,--ext-rm- Remova as extensões CloudEvents para enviar ao destino, especificando o nome da chave. Especifique uma extensão de acordo com a opção
--ext-rm; por exemplo,--ext-rm extA --ext-rm extB. Este valor é opcional. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --path- O caminho dentro do aplicativo
destinationno qual os eventos são encaminhados; por exemplo,/events. O caminho padrão é a URL raiz do aplicativodestination. Essa opção poderá ser especificada apenas sedestination-typeforapp. Este valor é opcional. --prefix,-p- Prefixo do objeto do IBM Cloud Object Storage. Este valor é opcional.
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --suffix,-s- Sufixo do objeto do IBM Cloud Object Storage. Considere o tipo de arquivo (extensão) de seu arquivo ao especificar o sufixo. Este valor é opcional.
Exemplo
O exemplo a seguir atualiza uma assinatura do COS chamada mycosevent para atender apenas eventos de gravação.
ibmcloud ce subscription cos update --name mycosevent --event-type write
Exemplo de saída
Updating COS source 'mycosevent'...
Run 'ibmcloud ce subscription cos get -n mycosevent' to check the COS source status.
OK
Comandos cron de assinatura
Muitas vezes, em ambientes distribuídos, você deseja que os seus aplicativos ou tarefas reajam a mensagens (eventos) que são geradas por meio de outros componentes, que geralmente são chamados de produtores de evento. Com o Code Engine, seus aplicativos ou tarefas podem receber eventos de interesse assinando os produtores de evento. As informações do evento são recebidas como solicitações de HTTP POST para aplicativos e como variáveis de ambiente para tarefas.
O produtor de evento cron é baseado em cron e gera um evento em intervalos regulares. Use um produtor de evento cron quando uma ação precisar ser executada em intervalos bem definidos ou em horários específicos.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos subscription cron.
Para obter mais informações sobre como trabalhar com as assinaturas do IBM Cloud Object Storage, consulte Trabalhando com o produtor de evento (cron) do cronômetro periódico. Consulte Introdução às assinaturas para obter mais informações sobre como trabalhar com assinaturas no Code Engine.
É possível usar subscription ou sub em seus comandos subscription cron. Para ver a ajuda da CLI para o comando subscription cron, execute ibmcloud ce sub cron -h.
ibmcloud ce subscription cron create
Crie uma assinatura de evento 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]
Opções de comando
--destination,-d- O nome do aplicativo ou recurso da tarefa que você deseja que receba eventos; por exemplo,
myapp. Se necessário, use a opção--pathpara qualificar ainda mais um destino de app. Este valor é obrigatório. -n,--name- O nome da assinatura de evento cron. Use um nome que seja exclusivo dentro do projeto.
- O nome deve iniciar e terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 253 caracteres ou menos e pode conter letras minúsculas, números, pontos (.) e hifens (-).
Este valor é obrigatório.
--content-type,--ct- O tipo de mídia da opção
--dataou--data-base64. Os exemplos incluemapplication/json,application/x-www-form-urlencoded,text/htmletext/plain. Este valor é opcional. --da,--data- Os dados para enviar para o destino; por exemplo,
'{ "message": "Hello world!" }'. Se você especificar a opção--data, não use a opção--data-base64.
Este valor é opcional.
--data-base64,--db- Os dados codificados em Base64 a serem enviados para o destino, por exemplo,
Q29kZSBFbmdpbmU=. Se você especificar a opção--data-base64, não use a opção--data. Este valor é opcional. --destination-type,--dt- O tipo do
destination. Os valores válidos sãoapp,functionejob. Este valor é opcional. O valor padrão éapp. --extension,--ext- Configurar extensões do CloudEvents para enviar ao destino. Deve estar em formato
NAME=VALUE. Essa ação inclui uma nova extensão CloudEvents ou substitui um atributo CloudEvent existente. Especifique uma extensão de acordo com a opção--extension; por exemplo,--ext extA=A --ext extB=B. Este valor é opcional. --force,-f- Force para criar uma assinatura de evento cron. Esta opção ignora a validação do destino especificado. Este valor é opcional. O valor padrão é
false. --no-wait,--nw- Criar a inscrição de evento cron e não esperar que ela fique pronta. Se você especificar a opção
--no-wait, a criação de assinatura será iniciada e não esperará. Use o comandosubscription cron getpara verificar o status da inscrição. Este valor é opcional. O valor padrão éfalse. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --path- O caminho dentro do aplicativo
destinationno qual os eventos são encaminhados; por exemplo,/events. O caminho padrão é a URL raiz do aplicativodestination. Essa opção poderá ser especificada apenas sedestination-typeforapp. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --schedule,-s- Planeje com que frequência o evento é acionado, em formato crontab. Por exemplo, especifique
'*/2 * * * *'(no formato de sequência) para cada dois minutos. Por padrão, o evento cron é acionado a cada minuto e configurado para o fuso horárioUTC. Para modificar o fuso horário, use a opção--time-zone. Este valor é opcional. --time-zone,--tz- Configure o fuso horário para o seu evento cron; por exemplo,
Asia/Tokyo. Se você especificar a opção--schedule, use-a para especificar o fuso horário. Para obter valores válidos de fuso horário, consulte o banco de dados de fusos horários. Este valor é opcional. O valor padrão éUTC. --wait,-w- Criar a inscrição de evento cron e esperar que ela fique pronta. Se você especificar a opção
--wait, a criação da assinatura irá esperar um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para que a assinatura fique pronta. Se a assinatura não estiver pronta dentro do período--wait-timeoutespecificado, a criação da assinatura do evento cron falhará. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- O período de tempo em segundos de espera para que a assinatura do evento cron esteja pronta. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é15.
Exemplo
O exemplo a seguir cria uma assinatura de cron que chamada mycronevent que encaminha um evento de cron para uma tarefa que chamada myjob a cada 2 minutes minutos.
ibmcloud ce subscription cron create --name mycronevent --destination myjob --schedule '*/2 * * * *' --destination-type job
Exemplo de saída
Creating cron source 'mycronevent'...
Run 'ibmcloud ce subscription cron get -n mycronevent' to check the cron source status.
OK
ibmcloud ce subscription cron delete
Exclua uma assinatura de evento cron.
ibmcloud ce subscription cron delete --name CRON_SOURCE_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
--name,-n- O nome da assinatura de evento cron. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --no-wait,--nw- Exclua a assinatura do evento cron e não espere que a assinatura seja excluída. Se você especificar a opção
--no-wait, a exclusão da assinatura será iniciada e não esperará. Use o comandosubscription cron getpara verificar o status da inscrição. Este valor é opcional. O valor padrão éfalse. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --wait,-w- Exclua a assinatura do evento cron e aguarde até que a assinatura seja excluída. Se você especificar a opção
--wait, a exclusão da assinatura irá esperar um tempo máximo em conjuntos, conforme configurado pela opção--wait-timeout, para que a assinatura seja excluída. Este comando é encerrado quando a assinatura é excluída ou sempre que--wait-timeouté atingido, o que ocorrer primeiro. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- O período de tempo em segundos para aguardar a exclusão da assinatura do evento cron. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é15.
Exemplo
ibmcloud ce subscription cron delete --name mycronevent -f
Exemplo de saída
Deleting cron source 'mycronevent'...
OK
ibmcloud ce subscription cron get
Exiba detalhes de uma assinatura de evento cron.
ibmcloud ce subscription cron get --name CRON_SOURCE_NAME [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- O nome da assinatura de evento cron. Este valor é obrigatório.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce subscription cron get --name mycronevent
Exemplo de saída
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
Quando Ready for true, a assinatura de cron estará pronta para acionar eventos de acordo com a programação especificada.
ibmcloud ce subscription cron list
Liste todas as assinaturas de eventos de cron em um projeto.
ibmcloud ce subscription cron list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce subscription cron list
Exemplo de saída
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
Atualize uma assinatura de evento 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]
Opções de comando
--name,-n- O nome da assinatura de evento cron. Este valor é obrigatório.
--content-type,--ct- O tipo de mídia da opção
--dataou--data-base64. Os exemplos incluemapplication/json,application/x-www-form-urlencoded,text/htmletext/plain. Este valor é opcional. --da,--data- Os dados para enviar para o destino; por exemplo,
'{ "message": "Hello world!" }'. Se você especificar a opção--data, não use a opção--data-base64.
Este valor é opcional.
--data-base64,--db- Os dados codificados em Base64 a serem enviados para o destino, por exemplo,
Q29kZSBFbmdpbmU=. Se você especificar a opção--data-base64, não use a opção--data. Este valor é opcional. --destination,-d- O nome do aplicativo ou recurso da tarefa que você deseja que receba eventos; por exemplo,
myapp. Se necessário, use a opção--pathpara qualificar ainda mais um destino de app. Este valor é opcional. --destination-type,--dt- O tipo do
destination. Os valores válidos sãoapp,functionejob. Este valor é opcional. --extension,--ext- Configurar extensões do CloudEvents para enviar ao destino. Deve estar em formato
NAME=VALUE. Essa ação inclui uma nova extensão CloudEvents ou substitui um atributo CloudEvent existente. Especifique uma extensão de acordo com a opção--extension; por exemplo,--ext extA=A --ext extB=B. Este valor é opcional. --extension-rm,--ext-rm- Remova as extensões CloudEvents para enviar ao destino, especificando o nome da chave. Especifique uma extensão de acordo com a opção
--ext-rm; por exemplo,--ext-rm extA --ext-rm extB. Este valor é opcional. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --path- O caminho dentro do aplicativo
destinationno qual os eventos são encaminhados; por exemplo,/events. O caminho padrão é a URL raiz do aplicativodestination. Essa opção poderá ser especificada apenas sedestination-typeforapp. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --schedule,-s- Planeje com que frequência o evento é acionado, em formato crontab. Por exemplo, especifique
'*/2 * * * *'(no formato de sequência) para cada dois minutos. Por padrão, o evento cron é acionado a cada minuto e configurado para o fuso horárioUTC. Para modificar o fuso horário, use a opção--time-zone. Este valor é opcional. --time-zone,--tz- Configure o fuso horário para o seu evento cron; por exemplo,
Asia/Tokyo. Se você especificar a opção--schedule, use-a para especificar o fuso horário. Para obter valores válidos de fuso horário, consulte o banco de dados de fusos horários. Este valor é opcional.
Exemplo
O exemplo a seguir atualiza uma assinatura de origem cron chamada mycronevent que encaminha um evento cron para um trabalho chamado myjob a cada hora.
ibmcloud ce subscription cron update --name mycronevent --destination myjob --schedule '0 * * * *' --destination-type job
Exemplo de saída
Updating cron source 'mycronevent'...
Run 'ibmcloud ce subscription cron get -n mycronevent' to check the cron source status.
OK
Comandos kafka de Assinatura
Muitas vezes, em ambientes distribuídos, você deseja que os seus aplicativos ou tarefas reajam a mensagens (eventos) que são geradas por meio de outros componentes, que geralmente são chamados de produtores de evento. Com o Code Engine, seus aplicativos ou tarefas podem receber eventos de interesse assinando os produtores de evento. As informações do evento são recebidas como solicitações de HTTP POST para aplicativos e como variáveis de ambiente para tarefas.
O produtor de eventos Kafka assiste a novas mensagens para aparecer em uma instância Kafka. Quando você cria uma assinatura Code Engine Kafka para um conjunto de tópicos, seu app ou job recebe um evento separado para cada nova mensagem que aparece em um dos tópicos.
Deve-se estar dentro do contexto de um projeto antes de usar os comandos subscription kafka.
Para obter mais informações sobre como trabalhar com inscrições de eventos Kafka, consulte Trabalhando com o produtor de eventos Kafka. Consulte Introdução às assinaturas para obter mais informações sobre como trabalhar com assinaturas no Code Engine.
É possível usar subscription ou sub em seus comandos subscription kafka. Para ver a ajuda da CLI para os subscription comandos, execute ibmcloud ce sub kafka -h.
ibmcloud ce subscription kafka create
Crie uma assinatura Kafka de evento.
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]
Opções de comando
--broker,-b- Configure um intermediário na origem Kafka. Um intermediário é um servidor Kafka ao qual o consumidor se conecta. Essa opção pode ser especificada múltiplas vezes. Este valor é obrigatório.
--destination,-d- O nome do aplicativo ou recurso da tarefa que você deseja que receba eventos; por exemplo,
myapp. Se necessário, use a opção--pathpara qualificar ainda mais um destino de app. Este valor é obrigatório. -n,--name- O nome da assinatura do Kafka evento. Use um nome que seja exclusivo dentro do projeto.
- O nome deve iniciar e terminar com um caractere alfanumérico minúsculo.
- O nome deve ter 253 caracteres ou menos e pode conter letras minúsculas, números, pontos (.) e hifens (-).
Este valor é obrigatório.
--topic,-t- Configure um tópico na origem Kafka. Os tópicos são usados para filtrar mensagens para consumir. Essa opção pode ser especificada múltiplas vezes. Este valor é obrigatório.
--consumer-group,--cg- O nome do grupo de consumidores para eventos. Este valor é opcional.
--destination-type,--dt- O tipo do
destination. Os valores válidos sãoappejob. Este valor é opcional. O valor padrão éapp. --extension,--ext- Configurar extensões do CloudEvents para enviar ao destino. Deve estar em formato
NAME=VALUE. Essa ação inclui uma nova extensão CloudEvents ou substitui um atributo CloudEvent existente. Especifique uma extensão de acordo com a opção--extension; por exemplo,--ext extA=A --ext extB=B. Este valor é opcional. --force,-f- Forçar a criação de uma assinatura Kafka de evento. Esta opção ignora a validação do destino e do segredo especificados. Este valor é opcional. O valor padrão é
false. --no-wait,--nw- Criar a inscrição de evento do Kafka e não esperar que ela fique pronta. Se você especificar a opção
--no-wait, a criação de assinatura será iniciada e não esperará. Use o comandosubscription kafka getpara verificar o status da inscrição. Este valor é opcional. O valor padrão éfalse. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --password,-p- A senha que é usada para autenticar para a instância Kafka. Se você especificar a
--passwordopção, não deve especificar a--secretopção. Este valor é opcional. --path- O caminho dentro do aplicativo
destinationno qual os eventos são encaminhados; por exemplo,/events. O caminho padrão é a URL raiz do aplicativodestination. Essa opção poderá ser especificada apenas sedestination-typeforapp. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --secret,-s- O nome do segredo usado para autenticar na Kafka instância e que inclui as chaves
passwordeusername. Se você especificar a--secretopção, não deve especificar as opções--username--passwordou. Este valor é opcional. --username,-u- O username que é usado para autenticar para a instância Kafka. Se você especificar a
--usernameopção, deverá especificar a--passwordopção e não deverá especificar a--secretopção. Este valor é opcional. O valor padrão étoken. --wait,-w- Criar a inscrição de evento do Kafka e esperar que ela fique pronta. Se você especificar a opção
--wait, a criação da assinatura irá esperar um tempo máximo em segundos, conforme configurado pela opção--wait-timeout, para que a assinatura fique pronta. Se a assinatura não estiver pronta dentro do período--wait-timeoutespecificado, a criação da Kafka assinatura do evento falhará. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- O tempo em segundos para aguardar que a assinatura Kafka do evento esteja pronta. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é120.
Exemplo
O exemplo a seguir cria uma assinatura de eventos Kafka que é chamada mykafkaevent que encaminha um evento Kafka para um app de recebimento que é chamado kafka-receiver-app. Especifique uma opção --broker para cada intermediário para o seu tópico. A opção --destination especifica o recurso Code Engine que recebe os eventos. O kafka-subscription-secret fornece credenciais para acessar o intermediário de mensagens.
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
Exemplo de saída
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
Excluir uma assinatura Kafka de evento.
ibmcloud ce subscription kafka delete --name KAFKA_SOURCE_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]
Opções de comando
--name,-n- O nome da assinatura do Kafka evento. Este valor é obrigatório.
--force,-f- Force a exclusão sem confirmação. Este valor é opcional. O valor padrão é
false. --ignore-not-found,--inf- Se não for encontrado, não falhará. Este valor é opcional. O valor padrão é
false. --no-wait,--nw- Exclua a assinatura Kafka do evento e não espere que a assinatura seja excluída. Se você especificar a opção
--no-wait, a exclusão da assinatura será iniciada e não esperará. Use o comandosubscription kafka getpara verificar o status da inscrição. Este valor é opcional. O valor padrão éfalse. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --wait,-w- Exclua a assinatura Kafka do evento e aguarde até que ela seja excluída. Se você especificar a opção
--wait, a exclusão da assinatura irá esperar um tempo máximo em conjuntos, conforme configurado pela opção--wait-timeout, para que a assinatura seja excluída. Este comando é encerrado quando a assinatura é excluída ou sempre que--wait-timeouté atingido, o que ocorrer primeiro. Este valor é opcional. O valor padrão étrue. --wait-timeout,--wto- O tempo em segundos para aguardar a exclusão da assinatura Kafka do evento. Este valor será necessário se a opção
--waitfor especificada. Este valor será ignorado se a opção--no-waitfor especificada. O valor padrão é15.
Exemplo
ibmcloud ce subscription kafka delete --name mykafkasubscription -f
Exemplo de saída
Deleting Kafka event subscription 'mykafkasubscription'...
OK
ibmcloud ce subscription kafka get
Exibir detalhes de uma assinatura Kafka de evento.
ibmcloud ce subscription kafka get --name KAFKA_SOURCE_NAME [--output OUTPUT] [--quiet]
Opções de comando
--name,-n- O nome da assinatura do Kafka evento. Este valor é obrigatório.
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce subscription kafka get --name mykafkasubscription
Exemplo de saída
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
Quando Ready é true, então a Kafka assinatura está pronta para acionar eventos de acordo com a programação especificada.
ibmcloud ce subscription kafka list
Listar todas as Kafka assinaturas de eventos em um projeto.
ibmcloud ce subscription kafka list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]
Opções de comando
--output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --sort-by,-s- Especifica a coluna por meio da qual classificar a lista. Os valores válidos são
nameeage. Este valor é opcional. O valor padrão éname.
Exemplo
ibmcloud ce subscription kafka list
Exemplo de saída
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
Atualizar uma assinatura Kafka de evento.
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]
Opções de comando
--name,-n- O nome da assinatura do Kafka evento. Este valor é obrigatório.
--broker,-b- Configure um intermediário na origem Kafka. Um intermediário é um servidor Kafka ao qual o consumidor se conecta. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--destination,-d- O nome do aplicativo ou recurso da tarefa que você deseja que receba eventos; por exemplo,
myapp. Se necessário, use a opção--pathpara qualificar ainda mais um destino de app. Este valor é opcional. --destination-type,--dt- O tipo do
destination. Os valores válidos sãoappejob. Este valor é opcional. --extension,--ext- Configurar extensões do CloudEvents para enviar ao destino. Deve estar em formato
NAME=VALUE. Essa ação inclui uma nova extensão CloudEvents ou substitui um atributo CloudEvent existente. Especifique uma extensão de acordo com a opção--extension; por exemplo,--ext extA=A --ext extB=B. Este valor é opcional. --extension-rm,--ext-rm- Remova as extensões CloudEvents para enviar ao destino, especificando o nome da chave. Especifique uma extensão de acordo com a opção
--ext-rm; por exemplo,--ext-rm extA --ext-rm extB. Este valor é opcional. --output,-o- Especifica o formato da saída de comando. Os valores válidos são
json,yaml,jsonpath=JSONPATH_EXPRESSIONejsonpath-as-json=JSONPATH_EXPRESSION. Usejsonpathpara especificar o caminho para um elemento da saída JSON. Este valor é opcional. --password,-p- A senha que é usada para autenticar para a instância Kafka. Se você especificar a
--passwordopção, não deve especificar a--secretopção. Este valor é opcional. --path- O caminho dentro do aplicativo
destinationno qual os eventos são encaminhados; por exemplo,/events. O caminho padrão é a URL raiz do aplicativodestination. Essa opção poderá ser especificada apenas sedestination-typeforapp. Este valor é opcional. --quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false. --secret,-s- O nome do segredo usado para autenticar na Kafka instância e que inclui as chaves
passwordeusername. Se você especificar a--secretopção, não deve especificar as opções--username--passwordou. Este valor é opcional. --topic,-t- Configure um tópico na origem Kafka. Os tópicos são usados para filtrar mensagens para consumir. Essa opção pode ser especificada múltiplas vezes. Este valor é opcional.
--username,-u- O username que é usado para autenticar para a instância Kafka. Se você especificar a
--usernameopção, deverá especificar a--passwordopção e não deverá especificar a--secretopção. Este valor é opcional. O valor padrão étoken.
Exemplo
O exemplo a seguir atualiza uma assinatura de evento Kafka para usar kafka-topic2 em vez de kafka-topic1.
ibmcloud ce subscription kafka update --name mykafkasubscription --topic kafka-topic2
Exemplo de saída
Updating Kafka event subscription 'mykafkasubscription'...
Run 'ibmcloud ce subscription kafka get -n mykafkasubscription' to check the Kafka event subscription status.
OK
Comando de versão
Exiba a versão da interface da linha de comandos code-engine.
ibmcloud ce version
Exiba a versão da interface da linha de comandos code-engine.
ibmcloud ce version [--quiet]
Opções de comando
--quiet,-q- Especifique essa opção para reduzir a saída do comando. Este valor é opcional. O valor padrão é
false.
Exemplo
ibmcloud ce version
Exemplo de saída
version: v1.17.0
commit: 3ab130b746f4784c9ff8d3da7bb05b6e7acda6d5