CLI de IBM Cloud Code Engine

Ejecute estos mandatos para gestionar las entidades que componen IBM Cloud® Code Engine. Para obtener más información sobre Code Engine, consulte Iniciación a Code Engine.

Para ejecutar mandatos de IBM Cloud Code Engine, utilice ibmcloud code-engine o ibmcloud ce.

Requisitos previos

  • Instale la CLI de IBM Cloud.

  • Instale la CLI de Code Engine con el mandato siguiente:

    ibmcloud plugin install code-engine

Mandatos application

Una aplicación, o app, ejecuta el código para servir solicitudes HTTP. Además de las solicitudes HTTP tradicionales, IBM Cloud® Code Engine también da soporte a aplicaciones que utilizan WebSockets como protocolo de comunicaciones. El número de instancias activas de una aplicación se amplía o se reduce automáticamente (hasta cero) en función de las solicitudes recibidas y de los parámetros de configuración. Una app contiene una o varias revisiones. Una revisión representa una versión inmutable de las propiedades de configuración de la app. Cada actualización de una propiedad de configuración de la app crea una nueva revisión de la app.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos application.

Para obtener más información sobre cómo trabajar con apps, consulte Despliegue de aplicaciones.

Puede utilizar application o app en los mandatos de application. Para ver la ayuda de la CLI para los mandatos application, ejecute ibmcloud ce app -h.

Para gestionar las revisiones de la aplicación, consulte los mandatos ibmcloud ce revision.

ibmcloud ce application bind

Enlazar una instancia de servicio de IBM Cloud a una aplicación.

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]

Opciones de mandato

--name, -n
El nombre de la aplicación que se va a enlazar. Este valor es obligatorio.
--no-wait, --nw
Enlazar la instancia de servicio y no esperar a que el enlace de servicio esté listo. Si especifica la opción no-wait, la creación de enlace de servicio se inicia y el mandato sale sin esperar a que finalice. Utilice el mandato app get para comprobar el estado del enlace de aplicación. Este valor es opcional. El valor predeterminado es false.
--prefix, -p
Un prefijo para las variables de entorno que se crean para este enlace de servicio. Solo debe contener letras en mayúsculas, números y guiones bajos (_) y no puede empezar por un número. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--role, -r
El nombre de un rol de servicio para la credencial de servicio nueva que se ha creado para este enlace de servicio. Los valores válidos son Reader, Writer, Manager o un rol específico del servicio. La opción predeterminada es Manager o el primer rol proporcionado por el servicio si Manager no está soportado. Esta opción se omite si se especifica --service-credential. Este valor es opcional.
--service-credential, --sc
El nombre de una credencial de servicio existente que se va a utilizar para este enlace de servicio. Si no especifica una credencial de instancia de servicio, se generan nuevas credenciales durante la acción de enlace. Este valor es opcional.
--service-instance, --si
El nombre de una instancia de servicio existente de IBM Cloud que se va a enlazar con la aplicación. Este valor es opcional.
--service-instance-id, --siid
El GUID de una instancia de servicio de IBM Cloud existente para enlazar a la aplicación. Este valor es opcional.
--wait, -w
Enlazar la instancia de servicio y esperar a que el enlace de servicio esté listo. Si especifica la opción --wait, el enlace de aplicación espera un tiempo máximo en segundos, tal como establece la opción --wait-timeout, a que el enlace a la aplicación se complete correctamente. Si el enlace de la app no se ha completado correctamente o falla en el periodo de --wait-timeout especificado, el mandato falla. Este valor es opcional. El valor predeterminado es true.
--wait-timeout, --wto
El periodo de tiempo en segundos que se debe esperar a que el enlace de servicio esté listo. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 300.

Ejemplo

En este ejemplo, vincula tu instancia del servicio « IBM Cloud Object Storage », denominada « my-object-storage », a tu aplicación denominada « myapp ».

ibmcloud ce application bind --name myapp --service-instance my-object-storage

Salida de ejemplo

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

Crear una aplicación.

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]

Opciones de mandato

-n, --name

El nombre de la aplicación. Utilice un nombre que sea exclusivo dentro del proyecto.

  • El nombre debe empezar por una letra minúscula.
  • El nombre debe terminar por un carácter alfanumérico en minúscula.
  • El nombre debe contener 63 caracteres o menos y puede contener letras en minúsculas, números y guiones (-).

Este valor es obligatorio.

--argument, --arg, -a
Establecer los argumentos para la aplicación. Especifique un argumento por opción --argument; por ejemplo, -a argA -a argB. Este valor modifica los valores predeterminados especificados en la imagen del contenedor. Este valor es opcional.
--build-commit, --commit, --bcm, --cm, --revision

La confirmación, el código o la rama del repositorio de origen que se debe extraer. La opción build commit sólo está permitida si la opción --build-source está activada. Este valor es opcional.

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

El directorio del repositorio que contiene el archivo de paquetes de compilación o el Dockerfile. La opción de directorio de contexto de compilación sólo se permite si la opción --build-source está activada. Este valor es opcional.

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

La vía de acceso al Dockerfile. Especifique esta opción únicamente si el nombre es distinto de Dockerfile. La opción build dockerfile sólo está permitida si la opción --build-source está activada. Este valor es opcional. El valor predeterminado es Dockerfile.

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

El nombre del secreto SSH, que contiene las credenciales para acceder al repositorio privado que contiene el código fuente para crear la imagen de contenedor. Para crear este secreto SSH, utilice el comando secret create --format SSH. Un secreto SSH también se utiliza como secreto de acceso al repositorio Git. Esta opción sólo está permitida si la opción --build-source está establecida en URL de un repositorio Git. Este valor es opcional.

--build-size, --size, --bsz, --sz

El tamaño de la compilación, que determina la cantidad de recursos utilizados. Los valores válidos son small, medium, large, xlarge y xxlarge. Para obtener detalles, consulte Determinación del tamaño de la compilación. La opción de tamaño de compilación sólo se permite si está activada la opción --build-source. Este valor es opcional. El valor predeterminado es medium.

--build-source, --source, --bsrc, --src

El URL del repositorio de Git o la vía de acceso del origen local que contiene el código fuente, por ejemplo, https://github.com/IBM/CodeEngine o .. Este valor es opcional.

--build-strategy, --strategy, --bstr, --str

La estrategia que se va a utilizar para compilar la imagen. Los valores válidos son dockerfile y buildpacks. La opción de estrategia de compilación sólo se permite si está activada la opción --build-source. Si no se especifica, la estrategia de compilación viene determinada por Code Engine si se especifica --build-source y el código fuente se encuentra en tu ordenador local. Este valor es opcional. El valor predeterminado es dockerfile.

--build-timeout, --bto

El intervalo de tiempo, en segundos, que puede transcurrir antes de que la compilación tenga éxito o falle. La opción de tiempo de espera de compilación sólo se permite si la opción --build-source está activada. Este valor es opcional. El valor predeterminado es 600.

--cluster-local, --cl

Despliegue la aplicación con un punto final de sólo-proyecto. Establecer un punto final solo del proyecto significa que la aplicación no es accesible desde el Internet público y el acceso a la red sólo es posible desde otros componentes de Code Engine que están en ejecución en el mismo proyecto. Este valor es opcional. El valor predeterminado es false.

--command, --cmd, -c

Establecer mandatos para la aplicación. Especifique un mandato por opción --command; por ejemplo, --cmd cmdA --cmd cmdB. Este valor modifica el mandato predeterminado especificado en la imagen del contenedor. Este valor es opcional.

--concurrency, --cn

El número máximo de solicitudes que se pueden procesar simultáneamente por instancia. Este valor es opcional. El valor predeterminado es 100.

--concurrency-target, --ct

El umbral de solicitudes simultáneas por instancia en el que se crean una o varias instancias adicionales. Utilice este valor para aumentar las instancias en función del número simultáneo de solicitudes. Si no se especifica --concurrency-target, esta opción toma como valor predeterminado el valor de la opción --concurrency. Este valor es opcional. El valor predeterminado es 0.

--cpu

La cantidad de CPU establecida para la instancia de la aplicación. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional. El valor predeterminado es 1.

--env, -e

Establecer las variables de entorno en la aplicación. Debe estar en el formato NAME=VALUE. Esta acción añade una nueva variable de entorno o modifica una variable de entorno existente. Especifique una variable de entorno por opción de --env; por ejemplo, --env envA=A --env envB=B. Este valor es opcional.

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

Establezca las variables de entorno de los pares de clave-valor que se almacenan en este mapa de configuración utilizando una de las formas siguientes:

  • Para añadir variables de entorno para todas las claves de un mapa de configuración denominado configmapName, utilice el valor configmapName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al mapa de configuración. Para especificar un prefijo, utilice el valor PREFIX=CONFIGMAP_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el mapa de configuración configmapName en CUSTOM_, utilice el valor CUSTOM_=configmapName. Si el mapa de configuración configmapName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un mapa de configuración denominado configmapName, utilice el valor configmapName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un configmap denominado configmapName, utilice el valor configmapName:myKey=key1.

Este valor es opcional.

--env-sec, --env-from-secret
Configura las variables de entorno a partir de los pares clave-valor almacenados en un secreto utilizando uno de los siguientes métodos:
  • Para añadir variables de entorno para todas las claves de un secreto denominado secretName, utilice el valor secretName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al secreto. Para especificar un prefijo, utilice el valor PREFIX=SECRET_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_SECRET>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el secreto secretName en CUSTOM_, utilice el valor CUSTOM_=secretName. Si el secreto secretName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:myKey=key1.

Este valor es opcional.

--ephemeral-storage, --es
La cantidad de almacenamiento efímero a establecer para la instancia de la aplicación. Utilice M para megabytes o G para gigabytes. Este valor es opcional. El valor predeterminado es 400M.
--force, -f

No verifique la existencia de las referencias de mapa de configuración y secreto especificadas. Las referencias de mapa de configuración se especifican con las opciones --env-from-configmap o --mount-configmap. Las referencias secretas se especifican con las opciones --env-from-secret, --mount-secret o --registry-secret. Este valor es opcional. El valor predeterminado es false.

--image, -i

El nombre de la imagen que se utiliza para esta aplicación. El formato es REGISTRY/NAMESPACE/REPOSITORY:TAG donde REGISTRY y TAG son opcionales. Si no se especifica REGISTRY, el valor predeterminado es docker.io. Si no se especifica TAG, el valor predeterminado es latest. La opción de imagen es necesaria si no se especifica la opción --build-source. Este valor es opcional.

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

El número máximo de instancias que se pueden utilizar para esta aplicación. Si establece este valor en 0, la aplicación escala según sea necesario. El escalado de la aplicación sólo está limitado por las instancias según la cuota de recursos del proyecto de la aplicación. Consulte Límites y cuotas de Code Engine. Este valor es opcional. El valor predeterminado es 10.

--memory, -m

La cantidad de memoria establecida para la instancia de la aplicación. Utilice M para megabytes o G para gigabytes. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional. El valor predeterminado es 4G.

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

El número mínimo de instancias que se pueden utilizar para esta aplicación. Esta opción es útil para garantizar que no se están ejecutando instancias cuando no se necesitan. Este valor es opcional. El valor predeterminado es 0.

--mount-configmap, --mount-cm

Añada el contenido de un mapa de configuración al sistema de archivos del contenedor de aplicaciones proporcionando un directorio de montaje y el nombre de un mapa de configuración, con el formato MOUNT_DIRECTORY=CONFIGMAP_NAME. Cada mapa de configuración montado debe utilizar un directorio de montaje exclusivo. Para cada par de clave-valor en el mapa de configuración, se añade un archivo al directorio de montaje especificado donde el nombre de archivo es la clave y el contenido del archivo es el valor del par clave-valor. Especifique una configuración de montaje para --mount-configmap; por ejemplo, --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b. Este valor es opcional.

--mount-data-store, --mount-ds

Montar un almacén de datos persistente. El formato es MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. SUBPATH es opcional. Esta opción se puede especificar varias veces. Este valor es opcional.

--mount-secret, --mount-sec

Añada el contenido de un secreto al sistema de archivos del contenedor de aplicaciones proporcionando un directorio de montaje y el nombre de un secreto, con el formato MOUNT_DIRECTORY=SECRET_NAME. Cada secreto montado debe utilizar un directorio de montaje exclusivo. Para cada par de clave-valor en el secreto, se añade un archivo al directorio de montaje especificado donde el nombre de archivo es la clave y el contenido del archivo es el valor del par clave-valor. Especifique una configuración de montaje para --mount-secret; por ejemplo, --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b. Este valor es opcional.

--no-cluster-local, --ncl

Desplegar la aplicación con un punto final público. La aplicación se despliega de forma que puede recibir solicitudes del Internet público o de componentes del proyecto de Code Engine. Este valor es opcional. El valor predeterminado es true.

--no-wait, --nw

Crear la aplicación y no esperar a que la aplicación esté lista. Si se especifica la opción --no-wait, se inicia la creación de la aplicación y no se espera. Utilice el mandato app get para comprobar el estado de la aplicación. Este valor es opcional. El valor predeterminado es false.

--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION, jsonpath-as-json=JSONPATH_EXPRESSION, url y project-url. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--port, -p

El puerto en el que escucha la aplicación. El formato es [NAME:]PORT, donde [NAME:] es opcional. Si se especifica [NAME:], los valores válidos son h2c o http1. Cuando no se especifica [NAME:] o es http1, el puerto utiliza HTTP/1.1. Cuando [NAME:] es h2c, el puerto utiliza HTTP/2 no cifrado. De forma predeterminada, Code Engine presupone que las apps escuchan las conexiones entrantes en el puerto 8080. Si su aplicación necesita ser escuchada en un puerto distinto del puerto 8080, utilice --port para especificar el puerto. Este valor es opcional.

--probe-live, --pl

Configure el analizador de actividad para esta aplicación en formato NAME=VALUE. Las opciones válidas para NOMBRE son: type, port, path, interval, initial-delay, timeout, failure-threshold. Esta opción puede especificarse varias veces. La propiedad type es obligatoria y los valores válidos son tcp y http. Por ejemplo, --probe-live type=tcp --probe-live port=8080. Para obtener más información sobre cómo trabajar con sondas, consulta Configuración de sondas para tu aplicación. Este valor es opcional.

--probe-ready, --pr

Configure el analizador de preparación para esta aplicación en formato NAME=VALUE. Las opciones válidas para NOMBRE son: type, port, path, interval, initial-delay, timeout, failure-threshold. Esta opción puede especificarse varias veces. La propiedad type es obligatoria y los valores válidos son tcp y http. Por ejemplo, --probe-ready type=tcp --probe-ready port=8080. Para obtener más información sobre cómo trabajar con sondas, consulta Configuración de sondas para tu aplicación. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--registry-secret, --rs

El nombre del secreto de registro. El secreto de registro se utiliza para autenticarse con un registro privado al descargar la imagen de contenedor. Este valor es opcional.

--request-timeout, --rt, --timeout, -t

El intervalo de tiempo en segundos que puede transcurrir antes de que las solicitudes realizadas a la aplicación deban finalizar correctamente o de forma errónea. Este valor es opcional. El valor predeterminado es 300.

--rn, --revision-name

El nombre de la revisión. Utilice un nombre que sea exclusivo dentro de la aplicación.

  • El nombre puede contener letras minúsculas, números y guiones (-).
  • El nombre debe terminar por un carácter alfanumérico en minúscula.
  • El nombre de revisión completo debe tener el formato Name_of_application-Name of revision.
  • El nombre de revisión completo debe tener 63 caracteres o menos.

Este valor es opcional.

--scale-down-delay, --sdd
La cantidad de tiempo en segundos que debe pasar en simultaneidad reducida antes de que se deduzcan los recursos de la aplicación. El aumento del número de peticiones concurrentes provoca el escalado de una aplicación. Si el número de peticiones disminuye (concurrencia reducida), la cantidad de tiempo especificada para esta opción determina cuánto tiempo debe persistir la concurrencia reducida, antes de que se reduzca la aplicación. Por defecto, la aplicación se reducirá inmediatamente si se detecta una concurrencia reducida. Este valor es opcional. El valor predeterminado es 0.
--service-account, --sa

Nombre de la cuenta de servicio. Una cuenta de servicio proporciona una identidad para los procesos que se ejecutan en una instancia. Para las cuentas de servicio incorporadas, puede utilizar los nombres abreviados manager, none, reader y writer. También puede utilizar los nombres completos que tienen como prefijo el Kubernetes Config Context, que se puede determinar con el mandato project current. Este valor es opcional.

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

Habilitar el montaje de un token de recurso informático en el contenedor de esta aplicación. Este valor es opcional. El valor predeterminado es false.

--user, -u

El ID de usuario (UID) que se utiliza para ejecutar la aplicación. Este valor modifica cualquier ID de usuario que se haya establecido en el Dockerfile de la aplicación. El ID debe ajustarse a los requisitos del sistema operativo del contenedor. Este valor es opcional. El valor predeterminado es 0.

--visibility, -v

La visibilidad de la aplicación. Los valores válidos son public, private y project. Establecer una visibilidad de public significa que la aplicación puede recibir solicitudes del Internet público o de componentes del proyecto Code Engine. Establecer una visibilidad de private significa que la aplicación no es accesible desde el Internet público y el acceso a la red solo es posible desde otros IBM Cloud utilizando puntos finales privados virtuales (VPE) o componentes de Code Engine que se ejecutan en el mismo proyecto. La visibilidad solo puede ser private si el proyecto admite la visibilidad privada de aplicaciones. Establecer una visibilidad de project significa que la aplicación no es accesible desde el Internet público y el acceso a la red sólo es posible desde otros componentes de Code Engine que están en ejecución en el mismo proyecto. Este valor es opcional.

--wait, -w

Crear la aplicación y esperar a que la aplicación esté lista. Si se especifica la opción --wait, la creación de la aplicación espera durante un tiempo máximo definido en segundos, tal como establece la opción --wait-timeout, para que la aplicación esté lista. Si la aplicación no está preparada dentro del periodo especificado de wait-timeout, la aplicación falla. Este valor es opcional. El valor predeterminado es true.

--wait-timeout, --wto

El periodo de tiempo en segundos que se debe esperar a que la aplicación esté lista. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 600.

Ejemplo

ibmcloud ce application create --name myapp --image icr.io/codeengine/hello

Salida de ejemplo

Creating application 'myapp'...
[...]
Run `ibmcloud ce application get -n 'myapp'` to check the application status.
OK
https://myapp.4svg40kna19.us-south.codeengine.appdomain.cloud

Cuando ejecute ibmcloud ce application get -n 'myapp' para comprobar el estado de la aplicación, se muestra el URL de la aplicación.

ibmcloud ce application delete

Suprimir una aplicación.

ibmcloud ce application delete --name APPLICATION_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

--name, -n
El nombre de la aplicación. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--no-wait, --nw
Suprima la aplicación y no espere a que ésta se haya suprimido. Si se especifica la opción no-wait, se inicia la supresión de la aplicación y no se espera. Utilice el mandato app get para comprobar el estado de la aplicación. Este valor es opcional. El valor predeterminado es true.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--wait, -w
Se suprime la aplicación y se espera a que ésta se haya suprimido. Si se especifica la opción --wait, la supresión de la aplicación espera durante un tiempo máximo definido en segundos, tal como establece la opción --wait-timeout, a que se suprima la aplicación. Si la aplicación no se suprime dentro del periodo especificado de --wait-timeout, la supresión de la aplicación falla. Este valor es opcional. El valor predeterminado es false.
--wait-timeout, --wto
El periodo de tiempo en segundos que se debe esperar a que la aplicación se suprima. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 600.

Ejemplo

ibmcloud ce application delete --name myapp -f

Salida de ejemplo

Deleted application 'myapp'

ibmcloud ce application events

Visualizar los sucesos del sistema de las instancias de aplicación. Los sucesos del sistema se conservan hasta 60 minutos.

ibmcloud ce application events (--instance APP_INSTANCE | --application APP_NAME) [--output OUTPUT] [--quiet]

Opciones de mandato

--application, --app, -a, --name, -n
Se visualizan los sucesos de todas las instancias de la aplicación especificada. Este valor es obligatorio si no se especifica --instance.
--instance, -i
El nombre de una instancia de aplicación específica. Utilice el mandato app get para buscar el nombre de la instancia. Este valor es obligatorio si no se especifica --application.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

En el ejemplo siguiente se muestra la información de sucesos del sistema para todas las instancias de una aplicación especificada.

ibmcloud ce application events --application myapp
Salida de ejemplo
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

Ejemplo de información de sucesos del sistema para la instancia especificada de una aplicación

En el ejemplo siguiente se muestra la información de sucesos del sistema para una instancia especificada de una app. Utilice el mandato app get para visualizar detalles acerca de su app, incluidas las instancias en ejecución de la app.

ibmcloud ce application events --instance myapp-li17x-1-deployment-69fd57bcb6-sr9tl
Ejemplo de salida de información de sucesos del sistema para una instancia especificada de una aplicación
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

Mostrar los detalles de una aplicación.

ibmcloud ce application get --name APPLICATION_NAME [--output OUTPUT] [--quiet] [--show-all-revisions]

Opciones de mandato

--name, -n
El nombre de la aplicación. Este valor es obligatorio.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION, jsonpath-as-json=JSONPATH_EXPRESSION, url y project-url. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--show-all-revisions, -r
Mostrar todas las revisiones de esta aplicación. Si no se especifica, solo se muestran las revisiones que están configuradas para recibir tráfico. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce application get --name myapp

Salida de ejemplo

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

Mostrar una lista de todas las aplicaciones de un proyecto.

ibmcloud ce application list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce app list --sort-by age

Salida de ejemplo

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

Mostrar los registros de las instancias de aplicación.

ibmcloud ce application logs (--instance APP_INSTANCE | --application APP_NAME) [--all-containers] [--follow] [--output OUTPUT] [--quiet] [--raw] [--tail TAIL] [--timestamps]

Opciones de mandato

--all-containers, --all
Visualiza los registros de todos los contenedores de las instancias de aplicación especificadas. Este valor es opcional. El valor predeterminado es false.
--application, --app, -a, --name, -n
Visualiza los registros de todas las instancias de la aplicación especificada. Este valor es obligatorio si no se especifica --instance.
--follow, -f
Seguir los registros de las instancias de aplicación. Utilice esta opción para transmitir los registros de instancias de aplicación. Si especifica la opción --follow, debe indicar Ctrl+C para finalizar este mandato de registro. Este valor es opcional. El valor predeterminado es false.
--instance, -i
El nombre de una instancia de aplicación específica. Utilice el mandato app get para buscar el nombre de la instancia. Este valor es obligatorio si no se especifica --application.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--raw, -r
Mostrar registros sin etiquetas de instancia y contenedor. Este valor es opcional. El valor predeterminado es false.
--tail, -t
Se limita la visualización de registros de contenedores de las instancias de aplicaciones especificadas a un número máximo de líneas recientes por contenedor. Por ejemplo, para visualizar las últimas líneas de 3 de los registros de los contenedores de las instancias de aplicación especificadas, especifique --tail 3. Si no se especifica esta opción, se muestran todas las líneas de los registros de los contenedores de las instancias de aplicación especificadas. Este valor es opcional. El valor predeterminado es -1.
--timestamps, --ts
Se incluyen las indicaciones de fecha y hora en cada línea de la salida del registro. Este valor es opcional. El valor predeterminado es false.

Ejemplo

En el ejemplo siguiente se muestran los registros de una instancia específica de una app. Utilice el mandato app get para obtener el nombre de las instancias de la app.

ibmcloud ce application logs --instance myapp-zhk9x-1-deployment-6f955f5cc5-abcde

Salida de ejemplo

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/

Ejemplo de registros de todas las instancias de una aplicación

En el ejemplo siguiente se muestran los registros de todas las instancias de una aplicación.

ibmcloud ce application logs --app myapp
Ejemplo de salida de los registros de todas las instancias de una aplicación
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 las instancias de aplicación en ejecución.

ibmcloud ce application restart (--instance APP_INSTANCE | --application APP_NAME) [--quiet]

Opciones de mandato

--application, --app, -a, --name, -n
Reiniciar todas las instancias en ejecución de la aplicación especificada. Este valor es obligatorio si no se especifica --instance.
--instance, -i
El nombre de una instancia de aplicación específica. Utilice el mandato app get para buscar el nombre de la instancia. Este valor es obligatorio si no se especifica --application.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce application restart --name myapp

Salida de ejemplo

Restarting all running instances of application 'myapp'...
OK

ibmcloud ce application unbind

Desenlazar instancias de servicio de IBM Cloud de una aplicación.

ibmcloud ce application unbind --name APP_NAME (--binding BINDING_NAME | --all) [--quiet]

Opciones de mandato

--name, -n
El nombre de la aplicación que se va a desenlazar. Este valor es obligatorio.
--all, -A
Desenlaza todas las instancias de servicio para esta aplicación. Este valor es obligatorio si no se especifica --binding. El valor predeterminado es false.
--binding, -b
El nombre del enlace que se debe desenlazar. Ejecute ibmcloud ce app get -n APP_NAME para ver los nombres de enlace. Este valor es obligatorio si no se especifica --all.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

En este ejemplo, se eliminan todos los enlaces de la aplicación denominada myapp.

ibmcloud ce application unbind --name myapp --all

Salida de ejemplo

Removing service bindings...
OK

ibmcloud ce application update

Actualizar una aplicación. La actualización de la aplicación crea una revisión. Cuando se realizan llamadas a la aplicación, el tráfico se direcciona a la revisión.

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]

Opciones de mandato

--name, -n

El nombre de la aplicación. Este valor es obligatorio.

--argument, --arg, -a

Establecer los argumentos para la aplicación. Especifique un argumento por opción --argument; por ejemplo, -a argA -a argB. Este valor es opcional.

--arguments-clear, --ac

Borrar argumentos de aplicación. Este valor es opcional. El valor predeterminado es false.

--build-clear, --bc

Elimine la asociación de una compilación de esta aplicación. La opción «Borrar compilación» solo está disponible si tu aplicación tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es false.

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

La confirmación, el código o la rama del repositorio de origen que se debe extraer. La opción «build commit» solo está permitida si la opción « --build-source » está configurada con el « URL » de un repositorio Git en este comando app update, o si tu aplicación tiene actualmente una compilación asociada procedente de un repositorio Git. Este valor es opcional.

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

Borrar la confirmación, la etiqueta o la rama en el repositorio de origen que se debe extraer. La opción «commit clear» está permitida si tu aplicación tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es false.

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

El directorio del repositorio que contiene el archivo de paquetes de compilación o el Dockerfile. La opción de directorio de contexto de compilación se permite si la opción --build-source se establece en este mandato app update o si la aplicación tiene actualmente una compilación asociada. Este valor es opcional.

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

La vía de acceso al Dockerfile. Especifique esta opción únicamente si el nombre es distinto de Dockerfile. La opción «build dockerfile» solo está permitida si se ha activado la opción « --build-source » en este comando « app update », o si tu aplicación tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es Dockerfile.

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

El nombre del secreto SSH, que contiene las credenciales para acceder al repositorio privado que contiene el código fuente para crear la imagen de contenedor. Para crear este secreto SSH, utilice el comando secret create --format SSH. Un secreto SSH también se utiliza como secreto de acceso al repositorio Git. Esta opción solo está permitida si la opción « --build-source » está configurada con el « URL » de un repositorio de Git en este comando application update, o si tu aplicación tiene actualmente una compilación asociada procedente de un repositorio de Git. Este valor es opcional.

--build-git-repo-secret-clear, --git-repo-secret-clear, --bgrsc, --grsc

Borre el secreto SSH. Esta opción está disponible si tu aplicación tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es false.

--build-size, --size, --bsz, --sz

El tamaño de la compilación, que determina la cantidad de recursos utilizados. Los valores válidos son small, medium, large, xlarge y xxlarge. Para obtener detalles, consulte Determinación del tamaño de la compilación. La opción de tamaño de compilación solo está permitida si se ha activado la opción « --build-source » en este comando « app update », o si tu aplicación tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es medium.

--build-source, --source, --bsrc, --src

El URL del repositorio de Git o la vía de acceso del origen local que contiene el código fuente, por ejemplo, https://github.com/IBM/CodeEngine o .. Este valor es opcional.

--build-strategy, --strategy, --bstr, --str

La estrategia que se va a utilizar para compilar la imagen. Los valores válidos son dockerfile y buildpacks. La opción de estrategia de compilación solo está permitida si se ha activado la opción « --build-source » en este comando « app update », o si tu aplicación tiene actualmente una compilación asociada. Si no se especifica, la estrategia de compilación la determina Code Engine si se especifica --build-source y el origen está en la máquina local. Este valor es opcional. El valor predeterminado es dockerfile.

--build-timeout, --bto

El intervalo de tiempo, en segundos, que puede transcurrir antes de que la compilación tenga éxito o falle. La opción de tiempo de espera de compilación solo está permitida si se ha activado la opción « --build-source » en este comando « app update », o si tu aplicación tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es 600.

--cluster-local, --cl

Despliegue la aplicación con un punto final de sólo-proyecto. Establecer un punto final solo del proyecto significa que la aplicación no es accesible desde el Internet público y el acceso a la red sólo es posible desde otros componentes de Code Engine que están en ejecución en el mismo proyecto. Este valor es opcional. El valor predeterminado es false.

--command, --cmd, -c

Establecer mandatos para la aplicación. Especifique un mandato por opción --command; por ejemplo, --cmd cmdA --cmd cmdB. Este valor modifica el mandato predeterminado especificado en la imagen del contenedor. Este valor es opcional.

--commands-clear, --cc

Borrar mandatos de aplicación. Este valor es opcional. El valor predeterminado es false.

--concurrency, --cn

El número máximo de solicitudes que se pueden procesar simultáneamente por instancia. Este valor es opcional. El valor predeterminado es 0.

--concurrency-target, --ct

El umbral de solicitudes simultáneas por instancia en el que se crean una o varias instancias adicionales. Utilice este valor para aumentar las instancias en función del número simultáneo de solicitudes. Si no se especifica --concurrency-target, esta opción toma como valor predeterminado el valor de la opción --concurrency. Este valor es opcional. El valor predeterminado es 0.

--cpu

La cantidad de CPU establecida para la instancia de la aplicación. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional. El valor predeterminado es 0.

--env, -e

Establecer las variables de entorno en la aplicación. Debe estar en el formato NAME=VALUE. Esta acción añade una nueva variable de entorno o modifica una variable de entorno existente. Especifique una variable de entorno por opción de --env; por ejemplo, --env envA=A --env envB=B. Este valor es opcional.

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

Establezca las variables de entorno de los pares de clave-valor que se almacenan en este mapa de configuración utilizando una de las formas siguientes:

  • Para añadir variables de entorno para todas las claves de un mapa de configuración denominado configmapName, utilice el valor configmapName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al mapa de configuración. Para especificar un prefijo, utilice el valor PREFIX=CONFIGMAP_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el mapa de configuración configmapName en CUSTOM_, utilice el valor CUSTOM_=configmapName. Si el mapa de configuración configmapName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un mapa de configuración denominado configmapName, utilice el valor configmapName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un configmap denominado configmapName, utilice el valor configmapName:myKey=key1.

Este valor es opcional.

--env-from-configmap-rm, --env-cm-rm
Elimina las referencias de variables de entorno a mapas de configuración completos utilizando el nombre del mapa de configuración. Para eliminar referencias de claves individuales a mapas de configuración, utilice la opción --env-rm. Esta opción se puede especificar varias veces. Este valor es opcional.
--env-sec, --env-from-secret

Configura las variables de entorno a partir de los pares clave-valor almacenados en un secreto utilizando uno de los siguientes métodos:

  • Para añadir variables de entorno para todas las claves de un secreto denominado secretName, utilice el valor secretName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al secreto. Para especificar un prefijo, utilice el valor PREFIX=SECRET_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_SECRET>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el secreto secretName en CUSTOM_, utilice el valor CUSTOM_=secretName. Si el secreto secretName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:myKey=key1.

Este valor es opcional.

--env-from-secret-rm, --env-sec-rm
Elimina las referencias de variables de entorno a secretos completos utilizando el nombre secreto. Para eliminar referencias de claves individuales a secretos, utilice la opción --env-rm. Esta opción se puede especificar varias veces. Este valor es opcional.
--env-rm

Eliminar las referencias de variables de entorno a la clave de un par de clave-valor en un mapa de configuración o secreto. Para eliminar referencias de claves individuales y valores literales, especifique el nombre de la clave. Esta opción se puede especificar varias veces. Este valor es opcional.

--ephemeral-storage, --es

La cantidad de almacenamiento efímero a establecer para la instancia de la aplicación. Utilice M para megabytes o G para gigabytes. Este valor es opcional.

--force, -f

No verifique la existencia de las referencias de mapa de configuración y secreto especificadas. Las referencias de mapa de configuración se especifican con las opciones --env-from-configmap o --mount-configmap. Las referencias secretas se especifican con las opciones --env-from-secret, --mount-secret o --registry-secret. Este valor es opcional. El valor predeterminado es false.

--image, -i

El nombre de la imagen que se utiliza para esta aplicación. El formato es REGISTRY/NAMESPACE/REPOSITORY:TAG donde REGISTRY y TAG son opcionales. Si no se especifica REGISTRY, el valor predeterminado es docker.io. Si no se especifica TAG, el valor predeterminado es latest. Este valor es opcional.

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

El número máximo de instancias que se pueden utilizar para esta aplicación. Si establece este valor en 0, la aplicación escala según sea necesario. El escalado de la aplicación sólo está limitado por las instancias según la cuota de recursos del proyecto de la aplicación. Consulte Límites y cuotas de Code Engine. Este valor es opcional. El valor predeterminado es 10.

--memory, -m

La cantidad de memoria establecida para la instancia de la aplicación. Utilice M para megabytes o G para gigabytes. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional.

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

El número mínimo de instancias que se pueden utilizar para esta aplicación. Este valor es opcional. El valor predeterminado es 0.

--mount-configmap, --mount-cm

Añada el contenido de un mapa de configuración al sistema de archivos del contenedor de aplicaciones proporcionando un directorio de montaje y el nombre de un mapa de configuración, con el formato MOUNT_DIRECTORY=CONFIGMAP_NAME. Cada mapa de configuración montado debe utilizar un directorio de montaje exclusivo. Para cada par de clave-valor en el mapa de configuración, se añade un archivo al directorio de montaje especificado donde el nombre de archivo es la clave y el contenido del archivo es el valor del par clave-valor. Especifique una configuración de montaje para --mount-configmap; por ejemplo, --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b. Este valor es opcional.

--mount-data-store, --mount-ds

Montar un almacén de datos persistente. El formato es MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. SUBPATH es opcional. Esta opción se puede especificar varias veces. Este valor es opcional.

--mount-rm

Elimina el contenido de un mapa de configuración o secreto del sistema de archivos del contenedor de aplicaciones especificando el directorio en el que se ha montado el mapa de configuración o el secreto. Especifique un directorio de montaje para la opción --mount-rm; por ejemplo, --mount-rm /etc/configmap-a --mount-rm /etc/secret-b. Este valor es opcional.

--mount-secret, --mount-sec

Añada el contenido de un secreto al sistema de archivos del contenedor de aplicaciones proporcionando un directorio de montaje y el nombre de un secreto, con el formato MOUNT_DIRECTORY=SECRET_NAME. Cada secreto montado debe utilizar un directorio de montaje exclusivo. Para cada par de clave-valor en el secreto, se añade un archivo al directorio de montaje especificado donde el nombre de archivo es la clave y el contenido del archivo es el valor del par clave-valor. Especifique una configuración de montaje para --mount-secret; por ejemplo, --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b. Este valor es opcional.

--no-cluster-local, --ncl

Desplegar la aplicación con un punto final público. La aplicación se despliega de forma que puede recibir solicitudes del Internet público o de componentes del proyecto de Code Engine. Este valor es opcional. El valor predeterminado es true.

--no-wait, --nw

Actualice la aplicación y no espere a que ésta esté lista. Si se especifica la opción no-wait, se inicia la actualización de la aplicación y no se espera. Utilice el mandato app get para comprobar el estado de la aplicación. Este valor es opcional. El valor predeterminado es false.

--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION, jsonpath-as-json=JSONPATH_EXPRESSION, url y project-url. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--port, -p

El puerto en el que escucha la aplicación. El formato es [NAME:]PORT, donde [NAME:] es opcional. Si se especifica [NAME:], los valores válidos son h2c o http1. Cuando no se especifica [NAME:] o es http1, el puerto utiliza HTTP/1.1. Cuando [NAME:] es h2c, el puerto utiliza HTTP/2 no cifrado. De forma predeterminada, Code Engine presupone que las apps escuchan las conexiones entrantes en el puerto 8080. Si su aplicación necesita ser escuchada en un puerto distinto del puerto 8080, utilice --port para especificar el puerto. Este valor es opcional.

--probe-live, --pl

Configure el analizador de actividad para esta aplicación en formato NAME=VALUE. Las opciones válidas para NOMBRE son: type, port, path, interval, initial-delay, timeout, failure-threshold. Esta opción puede especificarse varias veces. La propiedad type es obligatoria y los valores válidos son tcp y http. Por ejemplo, --probe-live type=tcp --probe-live port=8080. Para obtener más información sobre cómo trabajar con sondas, consulta Configuración de sondas para tu aplicación. Este valor es opcional.

--probe-live-clear, --plr

Elimine el analizador de actividad. Esta opción sólo está permitida si tu aplicación tiene actualmente una sonda de liveness. Este valor es opcional. El valor predeterminado es false.

--probe-ready, --pr

Configure el analizador de preparación para esta aplicación en formato NAME=VALUE. Las opciones válidas para NOMBRE son: type, port, path, interval, initial-delay, timeout, failure-threshold. Esta opción puede especificarse varias veces. La propiedad type es obligatoria y los valores válidos son tcp y http. Por ejemplo, --probe-ready type=tcp --probe-ready port=8080. Para obtener más información sobre cómo trabajar con sondas, consulta Configuración de sondas para tu aplicación. Este valor es opcional.

--probe-ready-reset, --prr

Restablece el analizador de preparación a la configuración predeterminada. Este valor es opcional. El valor predeterminado es false.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--rebuild

Reconstruir imagen desde el origen. La opción de reconstrucción se permite si la aplicación tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es false.

--registry-secret, --rs

El nombre del secreto de registro. El secreto de registro se utiliza para autenticarse con un registro privado al descargar la imagen de contenedor. Este valor es opcional.

--registry-secret-clear, --rsc

Borre el secreto de registro. Este valor es opcional. El valor predeterminado es false.

--request-timeout, --rt, --timeout, -t

El intervalo de tiempo en segundos que puede transcurrir antes de que las solicitudes realizadas a la aplicación deban finalizar correctamente o de forma errónea. Este valor es opcional. El valor predeterminado es 0.

--rn, --revision-name

El nombre de la revisión. Utilice un nombre que sea exclusivo dentro de la aplicación.

  • El nombre puede contener letras minúsculas, números y guiones (-).
  • El nombre debe terminar por un carácter alfanumérico en minúscula.
  • El nombre de revisión completo debe tener el formato Name_of_application-Name of revision.
  • El nombre de revisión completo debe tener 63 caracteres o menos.

Este valor es opcional.

--scale-down-delay, --sdd
La cantidad de tiempo en segundos que debe pasar en simultaneidad reducida antes de que se deduzcan los recursos de la aplicación. El aumento del número de peticiones concurrentes provoca el escalado de una aplicación. Si el número de peticiones disminuye (concurrencia reducida), la cantidad de tiempo especificada para esta opción determina cuánto tiempo debe persistir la concurrencia reducida, antes de que se reduzca la aplicación. Por defecto, la aplicación se reducirá inmediatamente si se detecta una concurrencia reducida. Este valor es opcional. El valor predeterminado es 0.
--service-account, --sa

Nombre de la cuenta de servicio. Una cuenta de servicio proporciona una identidad para los procesos que se ejecutan en una instancia. Para las cuentas de servicio incorporadas, puede utilizar los nombres abreviados manager, none, reader y writer. También puede utilizar los nombres completos que tienen como prefijo el Kubernetes Config Context, que se puede determinar con el mandato project current. Este valor es opcional.

--service-account-clear, --sac

Borrar la cuenta de servicio. Este valor es opcional. El valor predeterminado es false.

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

Habilitar el montaje de un token de recurso informático en el contenedor de esta aplicación. Este valor es opcional. El valor predeterminado es false.

--user, -u

El ID de usuario (UID) que se utiliza para ejecutar la aplicación. Este valor modifica cualquier ID de usuario que se haya establecido en el Dockerfile de la aplicación. El ID debe ajustarse a los requisitos del sistema operativo del contenedor. Este valor es opcional. El valor predeterminado es 0.

--visibility, -v

La visibilidad de la aplicación. Los valores válidos son public, private y project. Establecer una visibilidad de public significa que la aplicación puede recibir solicitudes del Internet público o de componentes del proyecto Code Engine. Establecer una visibilidad de private significa que la aplicación no es accesible desde el Internet público y el acceso a la red solo es posible desde otros IBM Cloud utilizando puntos finales privados virtuales (VPE) o componentes de Code Engine que se ejecutan en el mismo proyecto. La visibilidad solo puede ser private si el proyecto admite la visibilidad privada de aplicaciones. Establecer una visibilidad de project significa que la aplicación no es accesible desde el Internet público y el acceso a la red sólo es posible desde otros componentes de Code Engine que están en ejecución en el mismo proyecto. Este valor es opcional.

--wait, -w

Actualiza la aplicación y espera a que ésta esté lista. Si se especifica la opción --wait, la actualización de la aplicación espera durante un tiempo máximo definido en segundos, tal como establece la opción --wait-timeout, para que la aplicación esté lista. Si la aplicación no está preparada dentro del periodo especificado de --wait-timeout, la aplicación falla. Este valor es opcional. El valor predeterminado es true.

--wait-timeout, --wto

El periodo de tiempo en segundos que se debe esperar a que la aplicación se actualice. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 600.

Ejemplo

ibmcloud ce application update --name myapp --image icr.io/codeengine/hello

Salida de ejemplo

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 los comandos beta no suelen estar disponibles. Este grupo de comando proporciona acceso a posibles funciones futuras para que los primeros usuarios seleccionados puedan explorarlas fácilmente.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos beta.

Para consultar la ayuda de la CLI sobre los comandos de « beta », ejecuta « ibmcloud ce beta -h ».

ibmcloud ce beta

Code Engine los comandos beta no suelen estar disponibles. Este grupo de comando proporciona acceso a posibles funciones futuras para que los primeros usuarios seleccionados puedan explorarlas fácilmente.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos beta.

Para consultar la ayuda de la CLI sobre los comandos de « beta », ejecuta « ibmcloud ce beta -h ».

ibmcloud ce beta COMMAND

Ejemplo

ibmcloud ce beta help

Salida de ejemplo

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.

Mandatos build

Una compilación o una compilación de imagen es un mecanismo que puede utilizar para crear una imagen de contenedor a partir del código fuente. Code Engine permite compilar desde un archivo Docker y desde Cloud Native Buildpacks. Utilice mandatos build para crear, mostrar detalles, actualizar y suprimir configuraciones de compilación. Una vez creada una configuración de compilación, se pueden enviar una o varias solicitudes de compilación ( buildrun comandos ) basadas en dicha configuración.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos build.

Para obtener más información sobre cómo trabajar con compilaciones, consulte Creación de una imagen de contenedor.

Puede utilizar build o bd en los mandatos de build. Para ver la ayuda de la CLI para los mandatos build, ejecute ibmcloud ce build -h.

ibmcloud ce build create

Crear una compilación.

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]

Opciones de mandato

-n, --name

El nombre de la compilación. Utilice un nombre que sea exclusivo dentro del proyecto.

  • El nombre debe empezar y terminar con un carácter alfanumérico en minúscula.
  • El nombre debe contener 63 caracteres o menos y puede contener caracteres alfanuméricos en minúsculas y guiones (-).

Este valor es obligatorio.

--build-type, --bt
El tipo de compilación. Los valores válidos son git y local. Si el tipo de compilación es local, las opciones --source, --commit y --git-repo-secret no son válidas. Este valor es opcional. El valor predeterminado es git.
--commit, --cm, --revision

La confirmación, el código o la rama del repositorio de origen que se debe extraer. La opción de confirmación se permite si la opción --build-type es git y no se permite si la opción --build-type es local. Este valor es opcional.

--context-dir, --cdr

El directorio del repositorio que contiene el archivo de paquetes de compilación o el Dockerfile. Este valor es opcional.

--dockerfile, --df

La vía de acceso al Dockerfile. Especifique esta opción únicamente si el nombre es distinto de Dockerfile. Este valor es opcional. El valor predeterminado es Dockerfile.

--force, -f

No verificar la existencia de las referencias secretas especificadas. Las referencias secretas se especifican con las opciones --get-repo-secret o --registry-secret. Este valor es opcional. El valor predeterminado es false.

--git-repo-secret, --grs, --repo, -r

El nombre del secreto SSH, que contiene las credenciales para acceder al repositorio privado que contiene el código fuente para crear la imagen de contenedor. Para crear este secreto SSH, utilice el comando secret create --format SSH. Un secreto SSH también se utiliza como secreto de acceso al repositorio Git. Esta opción está permitida si la opción --build-type es git y no está permitida si la opción --build-type es local. Este valor es opcional.

--image, -i

La ubicación del registro de imágenes. El formato es REGISTRY/NAMESPACE/REPOSITORY:TAG donde TAG es opcional. Si no se especifica TAG, el valor predeterminado es latest. Este valor es opcional.

--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--registry-secret, --rs

La clave del Registro que se utiliza para acceder al Registro. Puedes añadir la clave del Registro ejecutando el comando « registry create ». Este valor es opcional.

--size, --sz

El tamaño de la compilación, que determina la cantidad de recursos utilizados. Los valores válidos son small, medium, large, xlarge y xxlarge. Para obtener detalles, consulte Determinación del tamaño de la compilación. Este valor es opcional. El valor predeterminado es medium.

--source, --src

El URL del repositorio Git que contiene el código fuente; por ejemplo https://github.com/IBM/CodeEngine. La opción de origen es obligatoria si la opción --build-type es git y no se permite si la opción --build-type es local. Este valor es opcional.

--strategy, --str

La estrategia que se va a utilizar para compilar la imagen. En el caso de las solicitudes y las ofertas de empleo, los valores válidos son dockerfile y buildpacks. En el caso de las funciones, los valores válidos tienen el formato « codebundle-[RUNTIME-ID] ». Por ejemplo, si desea crear un paquete de código para su función con el ID de tiempo de ejecución nodejs-24, utilice codebundle-nodejs-24 como estrategia de creación. Puede encontrar el ID de cualquier runtime de funciones soportadas ejecutando el comando ibmcloud ce fn runtimes. Este valor es opcional. El valor predeterminado es dockerfile.

--timeout, --to

El intervalo de tiempo, en segundos, que puede transcurrir antes de que la compilación tenga éxito o falle. Este valor es opcional. El valor predeterminado es 600.

Ejemplo

En el ejemplo siguiente se crea un archivo de configuración de compilación denominado helloworld-build a partir de un Dockerfile de origen, ubicado en https://github.com/IBM/CodeEngine dentro del directorio hello de la rama main, con la estrategia dockerfile y un tamaño medium. Cuando se envíe esta compilación, la imagen del contenedor que se ha creado se almacenará en una instancia de Container Registry en us.icr.io/mynamespace/codeengine-helloworld a la que se accede mediante un secreto de registro de imágenes denominado 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

Salida de ejemplo

Creating build helloworld-build...
OK

ibmcloud ce build delete

Suprimir una compilación.

ibmcloud ce build delete --name BUILD_NAME [--force] [--ignore-not-found] [--quiet]

Opciones de mandato

--name, -n
El nombre de la compilación. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce build delete --name helloworld-build

Salida de ejemplo

Are you sure you want to delete build helloworld-build? [y/N]> y
Deleting build 'helloworld-build'...
OK

ibmcloud ce build get

Mostrar los detalles de una compilación.

ibmcloud ce build get --name BUILD_NAME [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
El nombre de la compilación. Este valor es obligatorio.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce build get --name helloworld-build

Salida de ejemplo

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

Mostrar una lista de todas las compilaciones de un proyecto.

ibmcloud ce build list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce build list

Salida de ejemplo

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

Actualizar una compilación.

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]

Opciones de mandato

--name, -n
El nombre de la compilación. Este valor es obligatorio.
--commit, --cm, --revision
La confirmación, el código o la rama del repositorio de origen que se debe extraer. Este valor es opcional.
--commit-clear, --cmc
Borrar la confirmación, la etiqueta o la rama en el repositorio de origen que se debe extraer. Este valor es opcional. El valor predeterminado es false.
--context-dir, --cdr
El directorio del repositorio que contiene el archivo de paquetes de compilación o el Dockerfile. Este valor es opcional.
--dockerfile, --df
La vía de acceso al Dockerfile. Especifique esta opción únicamente si el nombre es distinto de Dockerfile. Este valor es opcional. El valor predeterminado es Dockerfile.
--force, -f
No verificar la existencia de las referencias secretas especificadas. Las referencias secretas se especifican con las opciones --get-repo-secret o --registry-secret. Este valor es opcional. El valor predeterminado es false.
--git-repo-secret, --grs, --repo, -r
El nombre del secreto SSH, que contiene las credenciales para acceder al repositorio privado que contiene el código fuente para crear la imagen de contenedor. Para crear este secreto SSH, utilice el comando secret create --format SSH. Un secreto SSH también se utiliza como secreto de acceso al repositorio Git. Este valor es opcional.
--git-repo-secret-clear, --grsc
Borre el secreto SSH. Este valor es opcional. El valor predeterminado es false.
--image, -i
La ubicación del registro de imágenes. El formato es REGISTRY/NAMESPACE/REPOSITORY:TAG donde TAG es opcional. Si no se especifica TAG, el valor predeterminado es latest. Este valor es opcional.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--registry-secret, --rs
El nombre del secreto de registro. El secreto de registro se utiliza para autenticarse con un registro privado al descargar la imagen de contenedor. Este valor es opcional.
--size, --sz
El tamaño de la compilación, que determina la cantidad de recursos utilizados. Los valores válidos son small, medium, large, xlarge y xxlarge. Para obtener detalles, consulte Determinación del tamaño de la compilación. Este valor es opcional.
--source, --src
El URL del repositorio Git que contiene el código fuente; por ejemplo https://github.com/IBM/CodeEngine. Este valor es opcional.
--strategy, --str
La estrategia que se va a utilizar para compilar la imagen. En el caso de las solicitudes y las ofertas de empleo, los valores válidos son dockerfile y buildpacks. En el caso de las funciones, los valores válidos tienen el formato « codebundle-[RUNTIME-ID] ». Por ejemplo, si desea crear un paquete de código para su función con el ID de tiempo de ejecución nodejs-24, utilice codebundle-nodejs-24 como estrategia de creación. Puede encontrar el ID de cualquier runtime de funciones soportadas ejecutando el comando ibmcloud ce fn runtimes. Este valor es opcional.
--timeout, --to
El intervalo de tiempo, en segundos, que puede transcurrir antes de que la compilación tenga éxito o falle. Este valor es opcional. El valor predeterminado es 600.

Ejemplo

ibmcloud ce build update --name helloworld-build --source https://github.com/IBM/CodeEngine  --context-dir /hello --commit main --timeout 900

Salida de ejemplo

Updating build helloworld-build...
OK

Mandatos buildrun

Una compilación o una compilación de imagen es un mecanismo que puede utilizar para crear una imagen de contenedor a partir del código fuente. Code Engine permite compilar desde un archivo Docker y desde Cloud Native Buildpacks. Utilice el mandato buildrun para enviar, mostrar detalles y suprimir ejecuciones de compilaciones.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos buildrun.

Para obtener más información sobre cómo trabajar con compilaciones y ejecuciones de compilaciones, consulte Creación de una imagen de contenedor.

Puede utilizar buildrun o br en los mandatos de buildrun. Para ver la ayuda de la CLI para los mandatos buildrun, ejecute ibmcloud ce br -h.

ibmcloud ce buildrun cancel

Cancelar una ejecución de compilación.

ibmcloud ce buildrun cancel --name BUILDRUN_NAME [--quiet]

Opciones de mandato

--name, -n
El nombre de la ejecución de compilación. Este valor es obligatorio.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce buildrun cancel --name mybuildrun

Salida de ejemplo

Canceling build run 'mybuildrun'...
OK

ibmcloud ce buildrun delete

Suprimir una ejecución de compilación.

ibmcloud ce buildrun delete (--name BUILDRUN_NAME | --build BUILD_NAME) [--force] [--ignore-not-found] [--quiet]

Opciones de mandato

--build, -b
Utilice esta opción para suprimir todas las ejecuciones de compilación de la compilación especificada. La opción --build es necesaria si no especifica el valor --name. Este valor es opcional.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--name, -n
El nombre de la ejecución de compilación. La opción --name es necesaria si no especifica el valor --build. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce buildrun delete --name mybuildrun

Salida de ejemplo

Are you sure you want to delete build run mybuildrun? [y/N]> y
Deleting build run 'mybuildrun'...
OK

ibmcloud ce buildrun events

Visualizar los sucesos del sistema de una ejecución de compilación. Los sucesos del sistema se conservan hasta 60 minutos.

ibmcloud ce buildrun events --buildrun BUILDRUN_NAME [--output OUTPUT] [--quiet]

Opciones de mandato

--buildrun, -b, --br, --name, -n
El nombre de la ejecución de compilación. Este valor es obligatorio.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

En este ejemplo se muestra información de sucesos del sistema de una ejecución de compilación.

ibmcloud ce buildrun events --buildrun mybuildrun

Salida de ejemplo

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

Mostrar los detalles de una ejecución de compilación.

ibmcloud ce buildrun get --name BUILDRUN_NAME [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
El nombre de la ejecución de compilación. Este valor es obligatorio.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce buildrun get --name mybuildrun

Salida de ejemplo

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

Mostrar una lista de todas las ejecuciones de compilación en un proyecto.

ibmcloud ce buildrun list [--build BUILD] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--build, -b
Utilice esta opción para mostrar sólo las ejecuciones de compilación de la compilación especificada. Este valor es opcional.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce buildrun list

Salida de ejemplo

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

Muestra los registros de una ejecución de compilación.

ibmcloud ce buildrun logs --buildrun BUILDRUN_NAME [--follow] [--output OUTPUT] [--quiet] [--raw] [--tail TAIL] [--timestamps]

Opciones de mandato

--buildrun, -b, --br, --name, -n
El nombre de la ejecución de compilación. Este valor es obligatorio.
--follow, -f
Seguir los registros de la ejecución de una compilación. Utilice esta opción para transmitir los registros de la ejecución de la compilación. Si especifica la opción --follow, debe indicar Ctrl+C para finalizar este mandato de registro. Este valor es opcional. El valor predeterminado es false.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--raw, -r
Mostrar registros sin etiquetas de instancia y contenedor. Este valor es opcional. El valor predeterminado es false.
--tail, -t
Se limita la visualización de los registros de contenedores de la ejecución de compilación especificada a un número máximo de líneas recientes por contenedor. Por ejemplo, para visualizar las últimas líneas de 3 de los registros de los contenedores de la ejecución de compilación especificada, especifique --tail 3. Si no se especifica esta opción, se muestran todas las líneas de los registros de los contenedores de la ejecución de compilación especificada. Este valor es opcional. El valor predeterminado es -1.
--timestamps, --ts
Se incluyen las indicaciones de fecha y hora en cada línea de la salida del registro. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce buildrun logs --name mybuildrun

Salida de ejemplo

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 una ejecución de compilación.

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]

Opciones de mandato

--build, -b, --bd

El nombre de la configuración de compilación que se va a utilizar. Este valor es opcional.

--commit, --cm, --revision

La confirmación, el código o la rama del repositorio de origen que se debe extraer. La opción de confirmación de compilación se permite si la opción --source se establece en el URL de un repositorio de Git y no se permite si la opción --source no se establece en el URL de un repositorio de Git. Este valor es opcional.

--context-dir, --cdr

El directorio del repositorio que contiene el archivo de paquetes de compilación o el Dockerfile. La opción de directorio de contexto de compilación se permite si no se establece la opción --build y no se permite si se establece la opción --build. Este valor es opcional.

--dockerfile, --df

La vía de acceso al Dockerfile. Especifique esta opción únicamente si el nombre es distinto de Dockerfile. La opción dockerfile de compilación se permite si no se establece la opción --build y no se permite si se establece la opción --build. Este valor es opcional. El valor predeterminado es Dockerfile.

--git-repo-secret, --grs, --repo, -r

El nombre del secreto SSH, que contiene las credenciales para acceder al repositorio privado que contiene el código fuente para crear la imagen de contenedor. Para crear este secreto SSH, utilice el comando secret create --format SSH. Un secreto SSH también se utiliza como secreto de acceso al repositorio Git. Esta opción sólo está permitida si la opción --build-source está establecida en URL de un repositorio Git. Este valor es opcional.

--image, -i

La ubicación del registro de imágenes. El formato es REGISTRY/NAMESPACE/REPOSITORY:TAG donde TAG es opcional. Si no se especifica TAG, el valor predeterminado es latest. Este valor es opcional.

-n, --name

El nombre de la ejecución de compilación. Utilice un nombre que sea exclusivo dentro del proyecto. Si se establece la opción --build, la opción de nombre es opcional. Si no se establece la opción --build, la opción de nombre es necesaria.

  • El nombre debe empezar y terminar con un carácter alfanumérico en minúscula.
  • El nombre debe contener 63 caracteres o menos y puede contener caracteres alfanuméricos en minúsculas y guiones (-).

Este valor es opcional.

--no-wait, --nw
Enviar la ejecución de compilación y no esperar a que se complete esta compilación. Si se especifica la opción --no-wait, el envío de la ejecución de la compilación comienza y no espera. Utilice el mandato buildrun get para comprobar el estado de la ejecución de la compilación. Este valor es opcional. El valor predeterminado es true.
--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--registry-secret, --rs

El nombre del secreto de registro. El secreto de registro se utiliza para autenticarse con un registro privado al descargar la imagen de contenedor. La opción «registry secret» está permitida si no está activada la opción « --build », y no está permitida si está activada la opción « --build ». Este valor es opcional.

--service-account, --sa

Nombre de la cuenta de servicio. Una cuenta de servicio proporciona una identidad para los procesos que se ejecutan en una instancia. Para las cuentas de servicio incorporadas, puede utilizar los nombres abreviados manager, none, reader y writer. También puede utilizar los nombres completos que tienen como prefijo el Kubernetes Config Context, que se puede determinar con el mandato project current. Este valor es opcional.

--size, --sz

El tamaño de la compilación, que determina la cantidad de recursos utilizados. Los valores válidos son small, medium, large, xlarge y xxlarge. Para obtener detalles, consulte Determinación del tamaño de la compilación. La opción «build size» está permitida si no se ha activado la opción « --build », y no está permitida si se ha activado la opción « --build ». Este valor es opcional. El valor predeterminado es medium.

--source, --src

El URL del repositorio de Git o la vía de acceso del origen local que contiene el código fuente, por ejemplo, https://github.com/IBM/CodeEngine o .. Si se establece la opción --build, la opción de origen es necesaria si la opción --build-type en la compilación relacionada es local y no se permite si la opción --build-type en la compilación relacionada es git. Si la opción --build no se establece, la opción de origen es opcional. Este valor es opcional. El valor predeterminado es ..

--strategy, --str

La estrategia que se va a utilizar para compilar la imagen. En el caso de las solicitudes y las ofertas de empleo, los valores válidos son dockerfile y buildpacks. En el caso de las funciones, los valores válidos tienen el formato « codebundle-[RUNTIME-ID] ». Por ejemplo, si desea crear un paquete de código para su función con el ID de tiempo de ejecución nodejs-24, utilice codebundle-nodejs-24 como estrategia de creación. Puede encontrar el ID de cualquier runtime de funciones soportadas ejecutando el comando ibmcloud ce fn runtimes. La opción de estrategia de compilación está permitida si no se ha activado la opción « --build » y no está permitida si se ha activado la opción « --build ». Si no se especifica, la estrategia de compilación viene determinada por Code Engine si se especifica --source y el código fuente se encuentra en tu ordenador local. Este valor es opcional. El valor predeterminado es dockerfile.

--timeout, --to

El intervalo de tiempo, en segundos, que puede transcurrir antes de que la ejecución de compilación tenga éxito o falle. Este valor es opcional. El valor predeterminado es 600.

--wait, -w

Enviar la ejecución de compilación y esperar a que se complete esta compilación. Si especifica la opción --wait, el envío de la ejecución de la compilación espera un tiempo máximo en segundos, definido en la opción --wait-timeout, hasta que finalice la ejecución de la compilación. Si la ejecución de la compilación no finaliza en el periodo --wait-timeout especificado, el envío de la ejecución de la compilación falla. Este valor es opcional. El valor predeterminado es false.

--wait-timeout, --wto

El intervalo de tiempo en segundos que se debe esperar a que se complete esta compilación. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 600.

Ejemplo

El mandato siguiente envía una ejecución de compilación denominada mybuildrun y utiliza el archivo de configuración de compilación denominado helloworld-build.

ibmcloud ce buildrun submit --name mybuildrun --build helloworld-build

Salida de ejemplo

Submitting build run 'mybuildrun'...
Run 'ibmcloud ce buildrun get -n mybuildrun' to check the build run status.
OK

Mandatos configmap

Un mapa de configuración proporciona un método para incluir información de datos no confidenciales en el despliegue. Al hacer referencia a los valores de tu ConfigMap como variables de entorno, puedes separar la información específica de tu despliegue y mantener la portabilidad de tu aplicación, tarea o función. Un mapa de configuración contiene información en pares de clave-valor. Utilice mandatos configmap para crear, mostrar detalles, actualizar y suprimir mapas de configuración.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos configmap.

Para obtener más información sobre cómo trabajar con configmaps, consulte Trabajar con configmaps.

Puede utilizar configmap o cm en los mandatos de configmap. Para ver la ayuda de la CLI para los mandatos configmap, ejecute ibmcloud ce configmap -h.

ibmcloud ce configmap create

Crear un 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]

Opciones de mandato

-n, --name

El nombre del mapa de configuración. Utilice un nombre que sea exclusivo dentro del proyecto.

  • El nombre debe empezar y terminar con un carácter alfanumérico en minúscula.
  • El nombre no puede contener más de 253 y puede contener letras en minúsculas, números, puntos (.) y guiones (-).

Este valor es obligatorio.

--from-env-file, -e
Cree un mapa de configuración a partir de un archivo que contenga una o varias líneas que coincidan con el formato KEY=VALUE. Debe proporcionar la vía de acceso al archivo como un valor. Cada línea del archivo especificado se añade como un par de clave-valor. Las líneas del archivo especificado que están vacías o empiezan por # se ignoran. Este valor es obligatorio si no se especifica --from-literal o --from-file.
--from-file, -f

Crea un mapa de configuración a partir de un archivo. Debe proporcionar la vía de acceso al archivo como un valor. Este valor es obligatorio si no se especifica --from-literal o --from-env-file.

--from-literal, -l

Crea el mapa de configuración a partir de un par de clave-valor. Debe estar en el formato KEY=VALUE. Este valor es obligatorio si no se especifica --from-file o --from-env-file. Esta opción se puede especificar varias veces.

--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

En el siguiente ejemplo sea crea un mapa de configuración denominado configmap-fromliteral con dos valores de par de claves: color=blue y size=large.

ibmcloud ce configmap create --name configmap-fromliteral --from-literal color=blue --from-literal size=large

Salida de ejemplo

Creating Configmap 'configmap-fromliteral'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromliteral' to see more details.

Ejemplo de un configmap con valores de varios archivos

En el siguiente ejemplo crea un mapa de configuración denominado configmap-fromfile con valores de varios archivos.

ibmcloud ce configmap create --name configmap-fromfile  --from-file ./color.txt --from-file ./size.txt
Ejemplo de salida de un configmap con valores de varios archivos
Creating configmap 'configmap-fromfile'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromfile' to see more details.

ibmcloud ce configmap delete

Suprimir un configmap.

ibmcloud ce configmap delete --name CONFIGMAP_NAME [--force] [--ignore-not-found] [--quiet]

Opciones de mandato

--name, -n
El nombre del mapa de configuración. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce configmap delete --name configmap-fromliteral -f

Salida de ejemplo

Deleting Configmap 'configmap-fromliteral'...
OK

ibmcloud ce configmap get

Mostrar los detalles de un mapa de configuración.

ibmcloud ce configmap get --name CONFIGMAP_NAME [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
El nombre del mapa de configuración. Este valor es obligatorio.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce configmap get --name configmap-fromliteral

Salida de ejemplo

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

Mostrar una lista de todos los mapas de configuración de un proyecto.

ibmcloud ce configmap list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce configmap list

Salida de ejemplo

Listing Configmaps...
Name                    Data   Age
configmap-fromfile      2      19m13s
configmap-fromliteral   2      16m12s

ibmcloud ce configmap update

Actualizar un 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]

Opciones de mandato

--name, -n
El nombre del mapa de configuración. Este valor es obligatorio.
--from-env-file, -e
Actualiza un mapa de configuración a partir de un archivo que contenga una o varias líneas que coincidan con el formato KEY=VALUE. Debe proporcionar la vía de acceso al archivo como un valor. Cada línea del archivo especificado se añade como un par de clave-valor. Las líneas del archivo especificado que están vacías o empiezan por # se ignoran. Este valor es obligatorio si no se especifica --from-literal o --from-file. Esta opción se puede especificar varias veces.
--from-file, -f
Actualizar un mapa de configuración desde un archivo. Debe proporcionar la vía de acceso al archivo como un valor. Este valor es obligatorio si no se especifica --from-literal o --from-env-file. Esta opción se puede especificar varias veces.
--from-literal, -l
Actualiza un mapa de configuración a partir de un par de clave-valor. Debe estar en el formato KEY=VALUE. Este valor es obligatorio si no se especifica --from-file ni --from-env-file. Esta opción se puede especificar varias veces.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--rm
Eliminar un par de clave-valor individual de un mapa de configuración especificando el nombre de la clave. Esta opción se puede especificar varias veces. Este valor es opcional.

Ejemplo

En el siguiente ejemplo se actualiza un mapa de configuración denominado configmap-fromliteral con un par de nombre de usuario y contraseña.

ibmcloud ce configmap update --name configmap-fromliteral --from-literal username=devuser --from-literal password='A!B99c$D1Def'

Salida de ejemplo

Updating configmap 'configmap-fromliteral'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromliteral' to see more details.

Ejemplo de un configmap con valores de un archivo

En el siguiente ejemplo actualiza un mapa de configuración denominado configmap-fromfile con valores de varios archivos.

ibmcloud ce configmap update --name configmap-fromfile  --from-file ./username.txt --from-file ./password.txt
Ejemplo de salida de un configmap con valores de un archivo
Updating configmap 'configmap-fromfile'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromfile' to see more details.

Comandos de conectividad

La función de conectividad de IBM Cloud® Code Engine permite configurar varios aspectos de la conectividad de red de las cargas de trabajo de su proyecto Code Engine.

  • Defina los puntos finales alcanzables especificando los rangos de direcciones IP de destino permitidos para las conexiones salientes
  • Conéctese a IBM Cloud VPC Private Path services.
  • Defina las referencias del grupo de subredes de la VPC, incluidos los grupos de seguridad, para configurar la ubicación en red de los trabajadores de su flota Code Engine.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos connectivity.

Puede utilizar connectivity o conn en los mandatos de connectivity. Para ver la ayuda de la CLI para los mandatos connectivity, ejecute ibmcloud ce connectivity -h.

ibmcloud ce connectivity outbound

La función de conexiones salientes de IBM Cloud® Code Engine permite definir puntos finales alcanzables para sus proyectos de Code Engine.

  • Utilice los rangos de direcciones IP de destino permitidos para las conexiones salientes en notación CIDR.
  • Conecte su proyecto Code Engine con IBM Cloud VPC Servicios privados utilizando la consola Code Engine o CLI.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos connectivity outbound.

Para obtener más información sobre cómo trabajar con comandos conectividad saliente, consulte Trabajar con conectividad saliente en Code Engine.

Puede utilizar connectivity outbound o conn outbound en los mandatos de connectivity outbound. Para ver la ayuda de la CLI para los mandatos connectivity outbound, ejecute ibmcloud ce connectivity outbound -h.

ibmcloud ce connectivity outbound COMMAND

ibmcloud ce connectivity outbound create

Crear un destino de salida permitido.

ibmcloud ce connectivity outbound create --name OUTBOUND_DESTINATION_NAME (--cidr CIDR_IP_ADDRESS | --pps-crn PPS_CRN) [--force] [--format FORMAT] [--pps-isolation-policy PPS_ISOLATION_POLICY] [--quiet]

Opciones de mandato

--n, --cidr-name, --name
Obligatorio. Nombre del destino de salida permitido. Este valor es obligatorio.
--cidr, -c
Proporcione un rango de direcciones IP válido en formato CIDR (por ejemplo 1.2.3.0/24). Este valor es opcional.
--force, -f
Forzar la creación sin confirmación. Este valor es opcional. El valor predeterminado es false.
--format, --fo
Formato del destino de salida permitido. Los valores válidos son [cidr, cidr_block, pps, private_path_gateway_service]. Si no se especifica, el valor por defecto es cidr. Este valor es opcional. El valor predeterminado es cidr_block.
--pps-crn, --private-path-service-crn
Proporcione el CRN del servicio de via de acceso privada de destino al que desee conectarse. Este valor es opcional.
--pps-isolation-policy, --pip
La política de aislamiento de la conexión de vía de acceso privada. Los valores válidos son: [dedicated y shared]. Si no se especifica, el valor por defecto es shared. Este valor es opcional. El valor predeterminado es shared.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce connectivity outbound create --name allow-to-subnet-a --cidr 5.6.7.8/29

Salida de ejemplo

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

Ejemplo para crear una conexión saliente de ruta privada

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

Ejemplo de salida para crear una conexión saliente de ruta privada

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

Suprimir un destino de salida permitido.

ibmcloud ce connectivity outbound delete --name OUTBOUND_DESTINATION_NAME [--force] [--ignore-not-found] [--quiet]

Opciones de mandato

--n, --cidr-name, --name
Obligatorio. Nombre del destino de salida permitido. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce connectivity outbound delete --name allow-to-subnet-a

Salida de ejemplo

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

Visualizar los detalles de un destino de salida permitido.

ibmcloud ce connectivity outbound get --name OUTBOUND_DESTINATION_NAME [--output OUTPUT] [--quiet]

Opciones de mandato

--n, --cidr-name, --name
Obligatorio. Nombre del destino de salida permitido. Este valor es obligatorio.
--output, -o
Formato de salida. Los valores válidos son «json», «yaml», «jsonpath=JSONPATH_EXPRESSION» y «jsonpath-as-json=JSONPATH_EXPRESSION». Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

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

Salida de ejemplo

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

Ejemplo para obtener una conexión de salida de ruta privada

ibmcloud ce connectivity outbound get --name my-pps-connection

Ejemplo de salida para obtener una conexión saliente de ruta privada

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

Listar todos los destinos de salida permitidos.

ibmcloud ce connectivity outbound list [--format FORMAT] [--output OUTPUT] [--quiet]

Opciones de mandato

--format
Limitar la visualización de los destinos de salida permitidos al formato especificado. Proporcione uno o más formatos en una lista delimitada por comas. Los valores válidos son [cidr, cidr_block, pps, private_path_gateway_service]. Este valor es opcional. El valor predeterminado es cidr_block,private_path_service_gateway.
--output, -o
Formato de salida. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce connectivity outbound list

Salida de ejemplo

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

Actualizar un destino de salida permitido.

ibmcloud ce connectivity outbound update --name OUTBOUND_DESTINATION_NAME (--cidr CIDR_IP_ADDRESS | --pps-isolation-policy PPS_ISOLATION_POLICY) [--force] [--quiet]

Opciones de mandato

--n, --cidr-name, --name
Obligatorio. Nombre del destino de salida permitido. Este valor es obligatorio.
--cidr, -c
Proporcione un rango de direcciones IP válido en formato CIDR (por ejemplo 1.2.3.0/24). Este valor es opcional.
--force, -f
Forzar actualización sin confirmación. Este valor es opcional. El valor predeterminado es false.
--pps-isolation-policy, --pip
La política de aislamiento de la conexión de vía de acceso privada. Los valores válidos son: [dedicated y shared]. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

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

Salida de ejemplo

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

ibmcloud ce connectivity subnetpool

La función de conexiones a grupos de subredes de IBM Cloud® Code Engine admite la gestión de referencias a grupos de subredes de VPC, incluidos los grupos de seguridad. Las flotas siempre están conectadas a una VPC, y se puede hacer referencia a un grupo de subredes al crear una flota para especificar en qué zona de red se despliegan los trabajadores de la flota de Code Engine. Cree un grupo de subredes para especificar las subredes de la VPC y las zonas de disponibilidad en las que se procesará la carga de trabajo. Por ejemplo, puede crear un grupo de subredes con una única subred en la zona eu-de-1 o un grupo de subredes con varias subredes para abarcar las 3 zonas en eu-de. Además, puede especificar el grupo de seguridad al que debe adjuntarse su carga de trabajo.

IBM Cloud® Virtual Private Cloud (VPC) es una red virtual que está vinculada a su cuenta de cliente. Le proporciona seguridad en la nube con la capacidad de escalar dinámicamente, proporcionando un control muy completo sobre la infraestructura virtual y la segmentación de tráfico de red. Las subredes de su VPC ofrecen conectividad privada. Las subredes de la VPC se pueden conectar a la Internet pública a través de una pasarela pública opcional. Puedes garantizar la seguridad de tu VPC y tus cargas de trabajo controlando el tráfico de red mediante grupos de seguridad. Para más información, consulte Acerca de las redes y la seguridad en su VPC.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos connectivity subnetpool.

Para obtener más información sobre cómo trabajar con comandos conectividad de subnetpool, consulte Trabajar con conectividad de subnetpool en Code Engine.

Puede utilizar connectivity o conn en los mandatos de connectivity subnetpool. Para ver la ayuda de la CLI para los comandos connectivity subnetpool, ejecute ibmcloud ce connectivity subnetpool -h.

ibmcloud ce connectivity subnetpool COMMAND

ibmcloud ce connectivity subnetpool create

Crear una agrupación de subredes.

ibmcloud ce connectivity subnetpool create [--name NAME] [--quiet] [--security-group-crn SECURITY_GROUP_CRN] [--subnet-crn SUBNET_CRN]

Opciones de mandato

--name, -n
Obligatorio. Nombre de la agrupación de subredes. Utilice un nombre que sea exclusivo dentro del proyecto. Este valor es obligatorio.
--subnet-crn, --crn
Proporcione un CRN de subred válido para la agrupación. Debe estar en formato S1=crn:v1:example Este valor es obligatorio.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--security-group-crn, --sg-crn
Proporcione un CRN de grupo de seguridad válido para la agrupación. Este valor es opcional.

Ejemplo

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

Salida de ejemplo

OK
Successfully created subnet pool with name 'my-other-pool' and ID 'a23ff1d1-b845-4629-86d1-a4126155ad02'

ibmcloud ce connectivity subnetpool delete

Suprimir una agrupación de subredes.

ibmcloud ce connectivity subnetpool delete (--name SUBNET_POOL_NAME || --id SUBNET_POOL_ID) [--force] [--ignore-not-found] [--quiet]

Opciones de mandato

--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--id
ID de la agrupación de subredes. Este valor es opcional.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--name, -n
Nombre de la agrupación de subredes. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce connectivity subnetpool delete --name my-subnet-pool

Salida de ejemplo

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

Visualizar los detalles de una agrupación de subredes.

ibmcloud ce connectivity subnetpool get (--id SUBNET_POOL_ID || --name SUBNET_POOL_NAME) [--output OUTPUT] [--quiet]

Opciones de mandato

--id
ID de la agrupación de subredes. Este valor es opcional.
--name, -n
Nombre de la agrupación de subredes. Este valor es opcional.
--output, -o
Formato de salida. Los valores válidos son «json», «yaml», «jsonpath=JSONPATH_EXPRESSION» y «jsonpath-as-json=JSONPATH_EXPRESSION». Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce connectivity subnetpool get --name my-subnet-pool

Salida de ejemplo

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 todas las agrupaciones de subredes de un proyecto.

ibmcloud ce connectivity subnetpool list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Formato de salida. Los valores válidos son «json», «yaml», «jsonpath=JSONPATH_EXPRESSION» y «jsonpath-as-json=JSONPATH_EXPRESSION». Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son «nombre» y «edad». Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce connectivity subnetpool list

Salida de ejemplo

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 de mapeo de dominios

Las asignaciones de dominio proporcionan la ruta URL a tus aplicaciones y funciones de Code Engine dentro de un proyecto. Con « Code Engine », estas asignaciones se crean automáticamente, de forma predeterminada, cada vez que se implementa una aplicación o se crea una función. No obstante, puedes asociar tu propio dominio personalizado a una aplicación o función de Code Engine para redirigir las solicitudes procedentes de tu dominio personalizado URL hacia tu aplicación o función mediante Code Engine. Utiliza comandos de « domainmapping » para crear, visualizar detalles, actualizar y eliminar asignaciones de dominios.

Cuando establece una asignación de dominio personalizada en Code Engine, define una asignación 1-to-1 entre su nombre de dominio completo (FQDN) y una aplicación Code Engine en su proyecto. Para configurar y trabajar con asignaciones de dominio personalizadas en la CLI, utilice los comandos domainmapping.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos domainmapping.

Para obtener más información sobre cómo trabajar con asignaciones de dominio, consulte Configuración de asignaciones de dominio personalizadas para su aplicación.

Puede utilizar domainmapping o dm en los mandatos de domainmapping. Para ver la ayuda de la CLI para los mandatos domainmapping, ejecute ibmcloud ce domainmapping -h.

ibmcloud ce domainmapping create

Crear una correlación de dominio personalizado.

ibmcloud ce domainmapping create --domain-name DOMAIN_NAME [--target-type TARGET_TYPE] --tls-secret SECRET_NAME [--quiet]

Opciones de mandato

--domain-name, --dn, -n, --name
Especifique el nombre de la correlación de dominios. Este nombre tiene que ser un nombre de dominio completo (FQDN) válido. Por ejemplo, www.example.com. Este valor es obligatorio.
--target, -t
El nombre de la aplicación o función de destino. Este valor es obligatorio.
--target-type, --type
Tipo del destino. Los valores válidos son application o function. Este valor es obligatorio.
--tls-secret, --secret, --tls
Especifica un secreto de « TLS » que contenga el certificado, incluidos todos sus certificados intermedios, y la clave privada correspondiente para la asignación de dominios. El certificado tiene que estar firmado por una entidad emisora de certificados (CA) pública de confianza. Los certificados autofirmados no están soportados. Este valor es obligatorio.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

El siguiente ejemplo crea una asignación de dominio personalizada entre la aplicación Code Engine myapp y el dominio personalizado, www.example.com y utiliza el secreto TLS, mytlssecret.

ibmcloud ce domainmapping create --domain-name www.example.com --target myapp --tls-secret mytlssecret

Salida de ejemplo

OK
Domain mapping successfully created.

ibmcloud ce domainmapping delete

Suprimir una correlación de dominio personalizado.

ibmcloud ce domainmapping delete --domain-name DOMAIN_NAME [--force] [--ignore-not-found] [--quiet]

Opciones de mandato

--domain-name, --dn, -n, --name
Nombre de la correlación de dominios. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce domainmapping delete --name www.example.com -f

Salida de ejemplo

Deleting domain mapping 'www.example.com'...
OK

ibmcloud ce domainmapping get

Visualizar los detalles de una correlación de dominio personalizado.

ibmcloud ce domainmapping get --domain-name DOMAIN_NAME [--output OUTPUT] [--quiet]

Opciones de mandato

--domain-name, --dn, -n, --name
Nombre de la asignación de dominios Este valor es obligatorio.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce domainmapping get --name www.example.com

Salida de ejemplo

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 las correlaciones de dominios de un proyecto.

ibmcloud ce domainmapping list [--all] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--all, -a
Visualizar todas las correlaciones de dominios de un proyecto, incluidas las correlaciones de dominios personalizadas y del sistema. Este valor es opcional. El valor predeterminado es false.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

El siguiente ejemplo muestra un listado de todas las asignaciones de dominio personalizadas.

ibmcloud ce domainmapping list

Salida de ejemplo

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 ver una lista de todas las asignaciones de dominio de sus aplicaciones, incluidas las asignaciones de dominio personalizadas y las asignaciones de dominio del sistema generadas automáticamente, especifique la opción --all con el comando ibmcloud ce domainmapping list comando.

ibmcloud ce domainmapping update

Actualizar una correlación de dominio personalizado.

ibmcloud ce domainmapping update --domain-name DOMAIN_NAME --target TARGET_NAME --tls-secret SECRET_NAME [--quiet] [--target-type TARGET_TYPE]

Opciones de mandato

--domain-name, --dn, -n, --name
Nombre de la correlación de dominios. Este valor es obligatorio.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--target, -t
El nombre de la aplicación o función de destino. Este valor es opcional.
--target-type, --type
Tipo del destino. Los valores válidos son application o function. Este valor es opcional.
--tls-secret, --secret, --tls
Especifica un secreto de « TLS » que contenga el certificado, incluidos todos sus certificados intermedios, y la clave privada correspondiente para la asignación de dominios. El certificado tiene que estar firmado por una entidad emisora de certificados (CA) pública de confianza. Los certificados autofirmados no están soportados. Este valor es opcional.

Ejemplo

El siguiente ejemplo actualiza la asignación de dominio www.example.com para utilizar mytlssecret2 en lugar de mytlssecret.

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

Salida de ejemplo

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

Comando

Code Engine los comandos experimentales no están disponibles de forma general. Este grupo de comando proporciona acceso a posibles funciones futuras para que los primeros usuarios seleccionados puedan explorarlas fácilmente.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos experimental.

Puede utilizar experimental o exp en los mandatos de experimental. Para ver la ayuda de la CLI para los mandatos experimental, ejecute ibmcloud ce exp -h.

ibmcloud ce experimental

Code Engine los comandos experimentales no están disponibles de forma general. Este grupo de comando proporciona acceso a posibles funciones futuras para que los primeros usuarios seleccionados puedan explorarlas fácilmente.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos experimental.

Puede utilizar experimental o exp en los mandatos de experimental. Para ver la ayuda de la CLI para los mandatos experimental, ejecute ibmcloud ce exp -h.

ibmcloud ce experimental COMMAND

Ejemplo

ibmcloud ce experimental help

Salida de ejemplo

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

Gestionar flotas sin servidor.

ibmcloud ce fleet cancel

Cancelar una flota sin servidor.

ibmcloud ce fleet cancel --id FLEET_ID [--force] [--hard] [--quiet]

Opciones de mandato

--id, --fid, --fleet-id
Obligatorio. El ID de la flota sin servidor. Este valor es obligatorio.
--force, -f
Forzar la cancelación sin confirmación. Este valor es opcional. El valor predeterminado es false.
--hard
Cancela inmediatamente la flota sin servidor, incluidas las tareas que se encuentren en estado « running ». Si no se especifica la opción « hard », el procesamiento de las tareas en estado « running » continúa hasta que alcanzan un estado final, y solo entonces la flota pasa al estado « canceled ». Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce fleet cancel --force --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e

Salida de ejemplo

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

Iniciar una flota sin servidor.

ibmcloud ce fleet create --image IMAGE_REF --tasks-state-store TASKS_STATE_STORE (--subnetpool-name SUBNETPOOL_NAME | --subnetpool-id SUBNETPOOL_ID) (--tasks TASKS | --tasks-from-local-file TASKS_FROM_LOCAL_FILE | --tasks-from-cos-object TASKS_FROM_COS_OBJECT | --tasks-from-cos-bucket TASKS_FROM_COS_BUCKET) [--argument ARGUMENT] [--command COMMAND] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--gpu GPU] [--max-scale MAX_SCALE] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mount-data-store MOUNT_DATA_STORE] [--name NAME] [--quiet] [--registry-secret REGISTRY_SECRET] [--retrylimit RETRYLIMIT] [--task-indexes TASK_INDEXES] [--worker-profile WORKER_PROFILE]

Opciones de mandato

--image, -i
Obligatorio. El nombre de la imagen de contenedor que se utiliza para procesar las tareas. El formato es REGISTRY/NAMESPACE/REPOSITORY:TAG donde REGISTRY y TAG son opcionales. Si no se especifica REGISTRY, el valor predeterminado es docker.io. Si no se especifica TAG, el valor predeterminado es latest. Este valor es obligatorio.
--tasks-state-store, --ts-state
Obligatorio. Especifique el almacén de datos persistente que almacena el estado de las tareas de la flota. Este valor es obligatorio.
--argument, --arg, -a
Defina los argumentos que necesita el mandato para ejecutarse en la tarea. Esta opción se puede especificar varias veces. Este valor es opcional.
--command, --cmd, -c
Defina un mandato para ejecutar en la tarea. Esta opción se puede especificar varias veces. Este valor es opcional.
--cpu, --cp
La cantidad de CPU a establecer para una tarea. Este valor es opcional. El valor predeterminado es 1.
--env, -e
Defina las variables de entorno que se pasarán a la tarea. Debe estar en formato NOMBRE=VALOR. Esta opción se puede especificar varias veces. Este valor es opcional.
--env-from-configmap, --env-cm
Establece las variables de entorno a partir de los pares clave-valor almacenados en este configmap. Proporcione un valor NAME para hacer referencia al configmap completo o PREFIX=NAME para hacer referencia al configmap completo donde cada clave tiene el prefijo PREFIX o NAME:KEY_A,KEY_B para hacer referencia a claves individuales. Para especificar un nombre nuevo para una clave referenciada, utilice el formato NAME:NEW_KEY_NAME=KEY_A. Esta opción se puede especificar varias veces. Este valor es opcional.
--env-from-secret, --env-sec
Establece las variables de entorno a partir de los pares clave-valor almacenados en este secreto. Proporcione un valor NAME para hacer referencia al secreto completo o PREFIX=NAME para hacer referencia al secreto completo donde cada clave tiene el prefijo PREFIX o NAME:KEY_A,KEY_B para hacer referencia a claves individuales. Para especificar un nombre nuevo para una clave referenciada, utilice el formato NAME:NEW_KEY_NAME=KEY_A. Esta opción se puede especificar varias veces. Este valor es opcional.
--gpu, --gp
El número de GPU que se van a asignar al recurso. El formato es PU_FAMILY:NUMBER_OF_GPUS. El valor predeterminado de NUMBER_OF_GPUS será 1 y podrá ser una fracción. Por ejemplo, h100:0.5 Este valor es opcional.
--max-scale, --maxscale, --max
Número máximo de instancias de tareas que se pueden ejecutar en paralelo. Este valor es opcional. El valor predeterminado es 1.
--maxexecutiontime, --met
El tiempo máximo de ejecución en segundos para que una tarea se ejecute. Este valor es opcional. El valor predeterminado es 0.
--memory, -m
La cantidad de memoria a establecer para una tarea. Utilice M para megabytes o G para gigabytes. Este valor es opcional. El valor predeterminado es 2G.
--mount-data-store, --mount-ds
Montar un almacén de datos persistente. El formato es MOUNT_DIRECTORY=STORAGE_NAME: [SUBPATH]. SUBPATH es opcional. Esta opción se puede especificar varias veces. Este valor es opcional.
--name, -n
El nombre de la flota. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--registry-secret, --rs
El nombre del secreto de registro. El secreto de registro se utiliza para autenticarse con un registro privado para descargar la imagen del contenedor. Ejecuta « ibmcloud ce registry create » para crear un secreto del Registro. Este valor es opcional.
--retrylimit, -r
El número de veces que se debe volver a ejecutar una tarea antes de marcarla como fallida. Este valor es opcional. El valor predeterminado es 3.
--subnetpool-id, --spi
El ID de la agrupación de subredes que se utilizará para la ubicación de la red de la flota. Este valor es opcional.
--subnetpool-name, --spn
El nombre de la agrupación de subredes que se utilizará para la ubicación de la red de la flota. Este valor es opcional.
--task-indexes, --ti
Especifica los índices de tareas que se van a procesar; por ejemplo, 0,3,6,9, 1-5,7-8,10. Especifique un máximo de 1000 entradas de índice. Esta opción no se puede especificar si se ha especificado « --tasks ». Este valor es opcional.
--tasks, --ts
Especifique el número de tareas que la flota debe procesar. Si no se especifica ninguna opción de especificación de tarea, se utiliza esta opción con un valor por defecto de 1.
--tasks-from-cos-bucket, --ts-bucket
Especifique la ubicación de los archivos dentro de un grupo de COS. Para cada archivo, la flota debe procesar las tareas. Este valor es opcional.
--tasks-from-cos-object, --ts-cos
Especifica la ubicación de un archivo JSONL que se encuentra en un grupo de COS. El archivo define las tareas que la flota debe procesar. Este valor es opcional.
--tasks-from-local-file, --ts-file
Especifica la ubicación de un archivo JSONL local. El archivo define las tareas que la flota debe procesar. Este valor es opcional.
--worker-profile, --profile, --prof
Proporcione una preferencia de perfil de trabajador compatible. Este valor es opcional.

Ejemplo

ibmcloud ce fleet create --image icr.io/codeengine/helloworld --subnetpool-name my-pool --tasks-state-store mytaskstore --tasks 1

Salida de ejemplo

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

Suprimir una flota sin servidor.

ibmcloud ce fleet delete --id FLEET_ID [--force] [--ignore-not-found] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

--id, --fid, --fleet-id
Obligatorio. El ID de la flota sin servidor. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--wait, -w
Suprima la flota sin servidor y espere a que se haya suprimido. Este valor es opcional. El valor predeterminado es false.
--wait-timeout, --wto
El tiempo, en segundos, que se debe esperar la supresión de la flota sin servidor. Este valor es opcional. El valor predeterminado es 180.

Ejemplo

ibmcloud ce fleet delete --force --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e

Salida de ejemplo

Deleting serverless fleet...
OK

ibmcloud ce fleet get

Mostrar los detalles de una flota sin servidor.

ibmcloud ce fleet get --id FLEET_ID [--output OUTPUT] [--quiet]

Opciones de mandato

--id, --fid, --fleet-id
Obligatorio. El ID de la flota sin servidor. Este valor es obligatorio.
--output, -o
Formato de salida. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce fleet get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e

Salida de ejemplo

Getting fleet '1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e'...
OK
Name:            fleet-0123456789  
ID:              1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e  
Status:          running  
Created:         2025-09-26T10:46:02Z  
Project region:  eu-de  
Project name:    myproj  
Tasks status:             
  Pending:     893  
  Running:     12  
  Failed:      0  
  Canceled:    0  
  Successful:  96  
  Total:       1001  
Code:                     
  Container image reference:  icr.io/codeengine/helloworld  
Tasks specification:      
  Task state store:  mytaskstore  
  Indexes:           0-1000  
Resources and scaling:    
  CPU per instance:         1  
  Memory per instance:      2G  
  Max number of instances:  12  
  Max retries per task:     3  
Network placement:        
  Subnet pools:    
    Name:                my-pool-
    Number of subnets:   1  
                         
    Subnet CRN:          crn:v1:bluemix:public:is:eu-de-1:a/abcdefabcdefabcdefabcd1234567890::subnet:1a1a-2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f   
    Security Group CRN:  crn:v1:bluemix:public:is:eu-de:a/abcdefabcdefabcdefabcd1234567890::security-group:2b2b-3c3c3c3c-4d4d-5e5e-6f6f-7g7g7g7g7g7g  
Environment Variables:    
  Type     Name   Value  
  Literal  FOO    bar

ibmcloud ce fleet list

Listar todas las flotas sin servidor de un proyecto.

ibmcloud ce fleet list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Formato de salida. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name, status y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce fleet list

Salida de ejemplo

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

Gestionar las tareas de la flota sin servidor.

ibmcloud ce fleet task COMMAND [--quiet]

Opciones de mandato

--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

ibmcloud ce fleet task get

Mostrar los detalles de una tarea de flota sin servidor.

ibmcloud ce fleet task get --task-id TASK_ID --fleet-id FLEET_ID [--output OUTPUT] [--quiet]

Opciones de mandato

--fleet-id, --fid
Obligatorio. El UUID de la flota a la que pertenece la tarea. Este valor es obligatorio.
--task-id, --tid, --id
Obligatorio. El UUID de la tarea. Este valor es obligatorio.
--output, -o
Formato de salida. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce fleet task get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e --task-id 2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f

Salida de ejemplo

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

Listar todas las tareas de una flota sin servidor.

ibmcloud ce fleet task list --fleet-id FLEET_ID [--output OUTPUT] [--pagination-token PAGINATION_TOKEN] [--quiet] [--show-all-columns] [--sort-by SORT_BY] [--status STATUS]

Opciones de mandato

--fleet-id, --fid
Obligatorio. El UUID de la flota a la que pertenecen las tareas. Este valor es obligatorio.
--output, -o
Formato de salida. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Este valor es opcional.
--pagination-token, --pt
Mostrar la siguiente página de tareas a partir de esta señal de paginación. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--show-all-columns, --sac
Mostrar columnas adicionales en Created y Finished. Este valor es opcional. El valor predeterminado es false.
--sort-by, --sb
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son id, index y status. Este valor es opcional. El valor predeterminado es index.
--status, --st
Mostrar las tareas que tienen el estado especificado. Los valores válidos son canceled, failed, pending, running y succeeded. Este valor es opcional.

Ejemplo

ibmcloud ce fleet task list --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e

Salida de ejemplo

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

Gestionar los trabajadores de la flota sin servidor.

ibmcloud ce fleet worker COMMAND [--quiet]

Opciones de mandato

--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

ibmcloud ce fleet worker delete

Suprimir un trabajador de flota sin servidor.

ibmcloud ce fleet worker delete --name WORKER_NAME --fleet-id FLEET_ID [--force] [--hard] [--ignore-not-found] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

--fleet-id, --fid
Obligatorio. El ID de la flota a la que pertenece el trabajador. Este valor es obligatorio.
--name, -n, --worker-name
Obligatorio. El nombre del trabajador de flota sin servidor. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--hard
Suprima inmediatamente el trabajador de la flota sin servidor. Si no se especifica la opción "hard", el manejo de las tareas "running" procesadas por este trabajador continuará hasta que dichas tareas alcancen un estado final, y solo entonces se suprimirá el trabajador. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--wait, -w
Suprimir el trabajador de flota sin servidor y esperar a que se suprima el trabajador. Este valor es opcional. El valor predeterminado es false.
--wait-timeout, --wto
El tiempo en segundos que se esperará la supresión del trabajador de flota sin servidor. Este valor es opcional. El valor predeterminado es 180.

Ejemplo

ibmcloud ce fleet worker delete --force --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e --worker-name fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-42

Salida de ejemplo

Deleting serverless fleet worker...
OK

ibmcloud ce fleet worker get

Mostrar los detalles de un trabajador de flota sin servidor.

ibmcloud ce fleet worker get --name WORKER_NAME --fleet-id FLEET_ID [--output OUTPUT] [--quiet]

Opciones de mandato

--fleet-id, --fid
Obligatorio. El ID de la flota a la que pertenece el trabajador. Este valor es obligatorio.
--name, -n, --worker-name
Obligatorio. El nombre del trabajador de flota sin servidor. Este valor es obligatorio.
--output, -o
Formato de salida. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce fleet worker get --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e --worker-name fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-42

Salida de ejemplo

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

Listar todos los trabajadores de una flota sin servidor.

ibmcloud ce fleet worker list --fleet-id FLEET_ID [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--fleet-id, --fid, --id
Obligatorio. El ID de la flota a la que pertenece el trabajador. Este valor es obligatorio.
--output, -o
Formato de salida. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y status. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce fleet worker list --fleet-id 1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e

Salida de ejemplo

Listing serverless fleet workers...
OK
Name                                          ID                                    Status        Profile   IP           Zone     Version  
fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-0  2b2b2b2b-3c3c-4d4d-5e5e-6f6f6f6f6f6f  running       cx2-2x4   10.242.0.42  eu-de-1  v1.0.15
fleet-1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e-1  3c3c3c3c-4d4d-5e5e-6f6f-7g7g7g7g7g7g  initializing  cx2-8x16  10.242.0.43  eu-de-1  v1.0.15

ibmcloud ce fleet worker profiles

Listar los perfiles de trabajador admitidos para las flotas sin servidor.

ibmcloud ce fleet worker profiles [--output OUTPUT] [--profile-family PROFILE_FAMILY] [--quiet] [--region REGION] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Formato de salida. Los valores válidos son «json», «yaml», «jsonpath=JSONPATH_EXPRESSION» y «jsonpath-as-json=JSONPATH_EXPRESSION». Este valor es opcional.
--profile-family, --pf
Mostrar los perfiles pertenecientes a la familia de perfiles de trabajador especificada. Los valores válidos son [b, balanced, c, compute, m, memory, g, gpu, f, flex]. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--region, -r
Visualizar los perfiles de trabajador compatibles en la región especificada. Este valor es opcional.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name, cpu, disk y memory. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce fleet worker profiles --profile-family --region br-sao

Salida de ejemplo

Listing fleet worker profiles...
OK
Name                 CPU  Memory  Disk  GPU family  Region  
gx2-8x64x1v100       8    64Gi    0     v100        br-sao  
gx2-32x256x2v100     32   256Gi   0     v100        br-sao  
gx3-48x240x2l40s     48   240Gi   0     l40s        br-sao  
gx3-64x320x4l4       64   320Gi   0     l4          br-sao  
gx3d-160x1792x8h100  160  1792Gi  60Ti  h100        br-sao

Comandos función

Una función es un fragmento de código sin estado que realiza tareas a medida que es invocado por las peticiones de HTTP. Con las funciones de IBM Code Engine, puede ejecutar su lógica empresarial de forma escalable y sin servidor. IBM Code Engine proporcionan un entorno de ejecución optimizado para soportar escenarios de baja latencia y escalabilidad rápida. Su código de función puede escribirse en un tiempo de ejecución gestionado que incluya versiones específicas de Node.js o Python.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos function.

Para más información sobre cómo trabajar con Funciones, véase Trabajar con Funciones.

ibmcloud ce function bind

Asignar una instancia del servicio « IBM Cloud » a una función.

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]

Opciones de mandato

--name, -n
El nombre de la función a enlazar. Este valor es obligatorio.
--no-wait, --nw
Enlazar la instancia de servicio y no esperar a que el enlace de servicio esté listo. Si especifica la opción no-wait, la creación de enlace de servicio se inicia y el mandato sale sin esperar a que finalice. Utiliza el comando « function get » para comprobar el estado de la asignación de funciones. Este valor es opcional. El valor predeterminado es false.
--prefix, -p
Un prefijo para las variables de entorno que se crean para este enlace de servicio. Solo debe contener letras en mayúsculas, números y guiones bajos (_) y no puede empezar por un número. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--role, -r
El nombre de un rol de servicio para la credencial de servicio nueva que se ha creado para este enlace de servicio. Los valores válidos son Reader, Writer, Manager o un rol específico del servicio. La opción predeterminada es Manager o el primer rol proporcionado por el servicio si Manager no está soportado. Esta opción se omite si se especifica --service-credential. Este valor es opcional.
--service-credential, --sc
El nombre de una credencial de servicio existente que se va a utilizar para este enlace de servicio. Si no especifica una credencial de instancia de servicio, se generan nuevas credenciales durante la acción de enlace. Este valor es opcional.
--service-instance, --si
El nombre de una instancia existente del servicio « IBM Cloud » a la que vincular la función. Este valor es opcional.
--service-instance-id, --siid
El GUID de una instancia existente del servicio « IBM Cloud » a la que vincular la función. Este valor es opcional.
--wait, -w
Enlazar la instancia de servicio y esperar a que el enlace de servicio esté listo. Si se especifica la opción « --wait », la función «bind» esperará un tiempo máximo en segundos —tal y como se establece en la opción « --wait-timeout »— a que la función «bind» se complete correctamente. Si la función «bind» no se completa correctamente o falla dentro del periodo especificado --wait-timeout, el comando falla. Este valor es opcional. El valor predeterminado es true.
--wait-timeout, --wto
El periodo de tiempo en segundos que se debe esperar a que el enlace de servicio esté listo. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 300.

Ejemplo

ibmcloud ce fn bind --name myfunction --service-instance my-object-storage

Salida de ejemplo

Binding service instance...
Status: Done
OK

ibmcloud ce function create

Crear una función.

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]

Opciones de mandato

-n, --name

Nombre de la función. Utilice un nombre que sea exclusivo dentro del proyecto.

  • El nombre debe empezar por una letra minúscula.
  • El nombre debe terminar por un carácter alfanumérico en minúscula.
  • El nombre debe contener 63 caracteres o menos y puede contener letras en minúsculas, números y guiones (-).

Este valor es obligatorio.

--runtime, -r
El tiempo de ejecución a utilizar para la función. Para encontrar los tiempos de ejecución compatibles para esta región, ejecute ibmcloud ce function runtimes. Ver tiempos de ejecución. Este valor es obligatorio.
--build-commit, --commit, --bcm, --cm, --revision

La confirmación, el código o la rama del repositorio de origen que se debe extraer. Este valor es opcional.

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

El directorio del repositorio que contiene el código fuente para la función. Este valor es opcional.

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

El nombre del secreto SSH, que contiene las credenciales para acceder al repositorio privado que contiene el código fuente para crear la imagen de paquete de código. Para crear este secreto SSH, utilice el comando secret create --format SSH. Un secreto SSH también se utiliza como secreto de acceso al repositorio Git. Esta opción sólo está permitida si la opción --build-source está establecida en URL de un repositorio Git. Este valor es opcional.

--build-source, --source, --bsrc, --src

El URL del repositorio de Git o la vía de acceso del origen local que contiene el código fuente, por ejemplo, https://github.com/IBM/CodeEngine o .. Este valor es opcional.

--build-timeout, --bto

El intervalo de tiempo, en segundos, que puede transcurrir antes de que la compilación tenga éxito o falle. Este valor es opcional. El valor predeterminado es 600.

--code-bundle, --cb

El nombre de la imagen code-bundle que se utilizará para esta función. Cuando se especifica « build-source », este valor corresponde a la ruta de acceso a la imagen de salida generada por la operación «build push». Cuando no se especifica « build-source », este valor corresponde a la ruta de acceso a la imagen del paquete de código existente. El formato es REGISTRY/NAMESPACE/REPOSITORY:TAG donde TAG es opcional. Si no se especifica TAG, el valor predeterminado es latest. Este valor es opcional.

--code-bundle-secret, --cs, --cbs

El nombre del secreto de registro que se utiliza para autenticarse con un registro privado. Puedes añadir la clave del Registro ejecutando el comando « registry create ». Este valor es opcional.

--cpu

Cantidad de CPU configurada para la instancia de la función. Para conocer los valores válidos, consulta « Combinaciones de memoria y CPU compatibles ». Este valor es opcional. El valor predeterminado es 1.

--env, -e

Establezca las variables de entorno en la función. Debe estar en el formato NAME=VALUE. Esta acción añade una nueva variable de entorno o modifica una variable de entorno existente. Especifique una variable de entorno por opción de --env; por ejemplo, --env envA=A --env envB=B. Este valor es opcional.

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

Configura las variables de entorno a partir de los pares clave-valor almacenados en este configmap utilizando uno de los siguientes métodos.

  • Para añadir variables de entorno para todas las claves de un mapa de configuración denominado configmapName, utilice el valor configmapName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al mapa de configuración. Para especificar un prefijo, utilice el valor PREFIX=CONFIGMAP_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el mapa de configuración configmapName en CUSTOM_, utilice el valor CUSTOM_=configmapName. Si el mapa de configuración configmapName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un mapa de configuración denominado configmapName, utilice el valor configmapName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un configmap denominado configmapName, utilice el valor configmapName:myKey=key1.

Este valor es opcional.

--env-sec, --env-from-secret
Configura las variables de entorno a partir de los pares clave-valor almacenados en un secreto utilizando uno de los siguientes métodos.
  • Para añadir variables de entorno para todas las claves de un secreto denominado secretName, utilice el valor secretName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al secreto. Para especificar un prefijo, utilice el valor PREFIX=SECRET_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_SECRET>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el secreto secretName en CUSTOM_, utilice el valor CUSTOM_=secretName. Si el secreto secretName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:myKey=key1.

Este valor es opcional.

--force, -f
No verifique la existencia de las referencias de mapa de configuración y secreto especificadas. Este valor es opcional. El valor predeterminado es false.
--inline-code

Indica la ruta de acceso a un archivo que contenga el código fuente de tu función. El código se almacena dentro de la función. Este valor es opcional.

--main, --fn-main

Especifique el nombre de la función principal en el código fuente proporcionado. Esta opción es necesaria cuando el nombre no es main. Este valor es opcional. El valor predeterminado es main.

--maxexecutiontime, --met

La cantidad máxima de tiempo en segundos para que esta función complete su ejecución. Este valor es opcional. El valor predeterminado es 60.

--memory, -m

La cantidad de memoria asignada a la función. Utilice M para megabytes o G para gigabytes. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional. El valor predeterminado es 4G.

--no-wait, --nw

No esperar a que se complete la ejecución de compilación. Este valor es opcional. El valor predeterminado es false.

--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--scale-down-delay, --sdd

La cantidad de tiempo en segundos que una instancia está activa después de completar una invocación. Esta opción puede reducir los tiempos de inicio en frío. Para obtener más información, consulte ¿Puedo mantener viva mi instancia de función durante más tiempo? Este valor es opcional. El valor predeterminado es 1.

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

Habilitar el montaje de un token de recurso informático para las ejecuciones de la función. Este valor es opcional. El valor predeterminado es false.

--visibility, -v

La visibilidad de la función. Los valores válidos son public, private y project. La visibilidad solo puede ser « private » si el proyecto admite la visibilidad «private» para las funciones. Este valor es opcional. El valor predeterminado es public.

--wait, -w

Espere a que se complete la ejecución de compilación. Este valor es opcional. El valor predeterminado es true.

--wait-timeout, --wto

El tiempo, en segundos, que hay que esperar a que la función esté lista. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 600.

Ejemplo

ibmcloud ce fn create --name myfunction --build-source main.js --runtime nodejs

Salida de ejemplo

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

Al ejecutar « ibmcloud ce fn get -n 'myfunction' » para comprobar el estado de la función, se muestra la « URL » correspondiente a dicha función.

ibmcloud ce function delete

Suprimir una función.

ibmcloud ce function delete --name FUNCTION_NAME [--force] [--ignore-not-found] [--quiet]

Opciones de mandato

--name, -n
Nombre de la función. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce fn delete --name myfunction

Salida de ejemplo

Are you sure you want to delete function 'myfunction'? [y/N]> y
Deleting function 'myfunction'...
OK

ibmcloud ce function get

Visualizar los detalles de una función.

ibmcloud ce function get --name FUNCTION_NAME [--output OUTPUT] [--quiet] [--save SAVE]

Opciones de mandato

--name, -n
Nombre de la función. Este valor es obligatorio.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--save, -s
Guarda el código fuente de la función en el sistema de archivos local. Esta opción sólo es compatible con las funciones creadas con código inline. Este valor es opcional.

Ejemplo

ibmcloud ce fn get --name myfunction

Salida de ejemplo

Getting function 'myfunction'...
OK
Name:          myfunction  
Project Name:  myproject
Project ID:    01234567-abcd-abcd-abcd-abcdabcd1111
Age:           6m8s  
Created:       2023-06-22T19:59:51Z
URL:           https://myfunction.11c22def3rhz.us-south.codeengine.appdomain.cloud  
Status:        Ready  
Resources:    
  CPU:                 0.25  
  Memory:              500M  
  Max Execution Time:  60 seconds  
Build Information:    
  Build Run Name:     myfunction-run-111111-12345678
  Build Type:         local  
  Build Strategy:     codebundle-nodejs-22
  Timeout:            600  
  Source:             main.js  
                      
  Build Run Summary:  Succeeded  
  Build Run Status:   Succeeded  
  Build Run Reason:   All Steps have completed executing  
  Run 'ibmcloud ce buildrun get -n myfunction-run-111111-12345678' for details.  
Function Code:    
  Runtime:        nodejs-22 (managed)
  Bundle Secret:  ce-auto-icr-private-us-south  
  Code Bundle:    cr://icr.io/ce--1a1a1-11c22def3rhz/function-myfunction:12345678-1111-dexla
  Main:           main()

ibmcloud ce function list

Listar todas las funciones de un proyecto.

ibmcloud ce function list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce fn delete --name myfunction

Salida de ejemplo

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

Listar tiempos de ejecución de función disponibles.

ibmcloud ce function runtimes [--all] [--output OUTPUT] [--quiet]

Opciones de mandato

--all, -A
Visualizar todos los tiempos de ejecución, incluidos los tiempos de ejecución en desuso. Este valor es opcional. El valor predeterminado es false.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce fn runtimes

Salida de ejemplo

Name         ID           Family  Default
Python 3.11  python-3.11  python  true
Node.js 22   nodejs-22    nodejs  true
Node.js 24   nodejs-24    nodejs  false
Python 3.13  python-3.13  python  false

ibmcloud ce function unbind

Desvincular las instancias del servicio « IBM Cloud » de una función.

ibmcloud ce function unbind --name FUNCTION_NAME (--binding BINDING_NAME | --all) [--quiet]

Opciones de mandato

--name, -n
El nombre de la función a desenlazar. Este valor es obligatorio.
--all, -A
Desenlaza todas las instancias de servicio para esta función. Este valor es obligatorio si no se especifica --binding. El valor predeterminado es false.
--binding, -b
El nombre del enlace que se debe desenlazar. Ejecute ibmcloud ce function get -n FUNCTION_NAME para ver los nombres de enlace. Este valor es obligatorio si no se especifica --all.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce fn unbind --name myfunction --all

Salida de ejemplo

Removing bindings from 'myfunction'...
OK

ibmcloud ce function update

Actualizar una función.

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]

Opciones de mandato

--name, -n

Obligatorio. Nombre de la función. Este valor es obligatorio.

--build-clear, --bc

Elimine la asociación de una compilación de esta función. La opción «build clear» solo está permitida si tu función tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es false.

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

La confirmación, el código o la rama del repositorio de origen que se debe extraer. Este valor es opcional.

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

Borrar la confirmación, la etiqueta o la rama en el repositorio de origen que se debe extraer. La opción commit clear sólo está permitida si su función tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es false.

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

El directorio del repositorio que contiene el código fuente para la función. Esta opción sólo se permite si está activada la opción --build-source. Este valor es opcional.

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

El nombre del secreto SSH que contiene las credenciales para acceder al repositorio privado que contiene el código fuente necesario para compilar tu imagen. Este valor es opcional.

--build-git-repo-secret-clear, --git-repo-secret-clear, --bgrsc, --grsc

Borre el secreto SSH. Esta opción sólo está permitida si su función tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es false.

--build-source, --source, --bsrc, --src

El URL del repositorio de Git o la vía de acceso del origen local que contiene el código fuente, por ejemplo, https://github.com/IBM/CodeEngine o .. Este valor es opcional.

--build-timeout, --bto

El intervalo de tiempo, en segundos, que puede transcurrir antes de que la compilación tenga éxito o falle. Este valor es opcional. El valor predeterminado es 600.

--code-bundle, --cb

El nombre de la imagen code-bundle que se utilizará para esta función. Cuando se especifica « build-source », este valor corresponde a la ruta de acceso a la imagen de salida generada por la operación «build push». Cuando no se especifica « build-source », este valor corresponde a la ruta de acceso a la imagen del paquete de código existente. El formato es REGISTRY/NAMESPACE/REPOSITORY:TAG donde TAG es opcional. Si no se especifica TAG, el valor predeterminado es latest. Este valor es opcional.

--code-bundle-secret, --cs, --cbs

El nombre del secreto de registro que se utiliza para autenticarse con un registro privado. Puedes añadir la clave del Registro ejecutando el comando « registry create ». Este valor es opcional.

--cpu

Cantidad de CPU configurada para la instancia de la función. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional. El valor predeterminado es 1.

--env, -e

Establezca las variables de entorno en la función. Debe estar en el formato NAME=VALUE. Esta acción añade una nueva variable de entorno o modifica una variable de entorno existente. Especifique una variable de entorno por opción de --env; por ejemplo, --env envA=A --env envB=B. Este valor es opcional.

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

Establezca las variables de entorno de los pares de clave-valor que se almacenan en este mapa de configuración utilizando una de las formas siguientes:

  • Para añadir variables de entorno para todas las claves de un mapa de configuración denominado configmapName, utilice el valor configmapName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al mapa de configuración. Para especificar un prefijo, utilice el valor PREFIX=CONFIGMAP_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el mapa de configuración configmapName en CUSTOM_, utilice el valor CUSTOM_=configmapName. Si el mapa de configuración configmapName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un mapa de configuración denominado configmapName, utilice el valor configmapName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un configmap denominado configmapName, utilice el valor configmapName:myKey=key1.

Este valor es opcional.

--env-from-configmap-rm, --env-cm-rm
Elimina las referencias de variables de entorno a mapas de configuración completos utilizando el nombre del mapa de configuración. Para eliminar referencias de claves individuales a mapas de configuración, utilice la opción --env-rm. Esta opción se puede especificar varias veces. Este valor es opcional.
--env-sec, --env-from-secret

Configura las variables de entorno a partir de los pares clave-valor almacenados en un secreto utilizando uno de los siguientes métodos:

  • Para añadir variables de entorno para todas las claves de un secreto denominado secretName, utilice el valor secretName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al secreto. Para especificar un prefijo, utilice el valor PREFIX=SECRET_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_SECRET>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el secreto secretName en CUSTOM_, utilice el valor CUSTOM_=secretName. Si el secreto secretName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:myKey=key1.

Este valor es opcional.

--env-from-secret-rm, --env-sec-rm
Elimina las referencias de variables de entorno a secretos completos utilizando el nombre secreto. Para eliminar referencias de claves individuales a secretos, utilice la opción --env-rm. Esta opción se puede especificar varias veces. Este valor es opcional.
--env-rm

Eliminar las referencias de variables de entorno a la clave de un par de clave-valor en un mapa de configuración o secreto. Para eliminar referencias de claves individuales y valores literales, especifique el nombre de la clave. Esta opción se puede especificar varias veces. Este valor es opcional.

--force, -f

No verifique la existencia de las referencias de mapa de configuración y secreto especificadas. Las referencias de mapa de configuración se especifican con las opciones --env-from-configmap o --mount-configmap. Las referencias secretas se especifican con las opciones --env-from-secret, --mount-secret o --registry-secret. Este valor es opcional. El valor predeterminado es false.

--inline-code

Especifique la vía de acceso a un archivo que contenga el código fuente de la función. El código se almacena dentro de la función. Este valor es opcional.

--main, --fn-main

Especifique el nombre de la función principal en el código fuente proporcionado. Esta opción es necesaria cuando el nombre no es main. Este valor es opcional. El valor predeterminado es main.

--maxexecutiontime, --met

El tiempo máximo de ejecución, en segundos, que debe tardar esta función en completarse. Este valor es opcional. El valor predeterminado es 60.

--memory, -m

La cantidad de memoria asignada a la función. Utilice M para megabytes o G para gigabytes. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional. El valor predeterminado es 4G.

--no-wait, --nw

Enviar la ejecución de compilación y no esperar a que se complete esta compilación. Si se especifica la opción --no-wait, el envío de la ejecución de la compilación comienza y no espera. Utilice el mandato buildrun get para comprobar el estado de la ejecución de la compilación. Este valor es opcional. El valor predeterminado es false.

--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--rebuild

Recompila la imagen a partir del código fuente. La opción de recompilación solo está disponible si tu función tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es false.

--runtime, -r

El tiempo de ejecución a utilizar para la función. Para encontrar los tiempos de ejecución compatibles para esta región, ejecute ibmcloud ce function runtimes. Ver tiempos de ejecución. Este valor es opcional.

--scale-down-delay, --sdd

La cantidad de tiempo en segundos que una instancia está activa después de completar una invocación. Esta opción puede reducir los tiempos de inicio en frío. Para obtener más información, consulte ¿Puedo mantener viva mi instancia de función durante más tiempo? Este valor es opcional. El valor predeterminado es 1.

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

Habilitar el montaje de un token de recurso informático para las ejecuciones de la función. Este valor es opcional. El valor predeterminado es false.

--visibility, -v

La visibilidad de la función. Los valores válidos son public, private y project. La visibilidad solo puede ser « private » si el proyecto admite la visibilidad «private» para las funciones. Este valor es opcional.

--wait, -w

Espere a que se complete la ejecución de compilación. Este valor es opcional. El valor predeterminado es true.

--wait-timeout, --wto

El tiempo, en segundos, que hay que esperar a que la función esté lista. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 600.

Ejemplo

ibmcloud ce fn update --name myfunction --runtime nodejs-22 --build-source main.js

Salida de ejemplo

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

Al ejecutar « ibmcloud ce fn get -n 'myfunction' » para comprobar el estado de la función, se muestra la « URL » correspondiente a dicha función.

help, mandato

El comando Code Engine help proporciona información sobre los comandos disponibles por grupo de comando.

ibmcloud ce help

El comando Code Engine help proporciona información sobre los comandos disponibles por grupo de comando.

ibmcloud ce help COMMAND

Ejemplo

ibmcloud ce help

Salida de ejemplo

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.

Mandatos de trabajo

Un trabajo ejecuta una o varias instancias de tu código ejecutable en paralelo. A diferencia de las aplicaciones, que gestionan solicitudes HTTP, los trabajos se han diseñado para que se ejecuten una vez y se salga. Cuando crea un trabajo, puede especificar la información de configuración de carga de trabajo que se utiliza cada vez que se ejecuta el trabajo. Utilice mandatos job para crear una configuración para el trabajo.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos job.

Para obtener más información sobre cómo trabajar con trabajos, consulte Ejecución de trabajos.

Para consultar la ayuda de la CLI sobre los comandos de « job », ejecuta « ibmcloud ce job -h ».

ibmcloud ce job bind

Enlazar una instancia de servicio de IBM Cloud a un trabajo.

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]

Opciones de mandato

--name, -n
El nombre del trabajo que se va a enlazar. Este valor es obligatorio.
--no-wait, --nw
Enlazar la instancia de servicio y no esperar a que el enlace de servicio esté listo. Si especifica la opción --no-wait, la creación de enlace de servicio se inicia y el mandato sale sin esperar a que finalice. Utilice el mandato job get para comprobar el estado de enlace de trabajo. Este valor es opcional. El valor predeterminado es false.
--prefix, -p
Un prefijo para las variables de entorno que se crean para este enlace de servicio. Solo debe contener letras en mayúsculas, números y guiones bajos (_) y no puede empezar por un número. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--role, -r
El nombre de un rol de servicio para la credencial de servicio nueva que se ha creado para este enlace de servicio. Los valores válidos son Reader, Writer, Manager o un rol específico del servicio. La opción predeterminada es Manager o el primer rol proporcionado por el servicio si Manager no está soportado. Esta opción se omite si se especifica --service-credential. Este valor es opcional.
--service-credential, --sc
El nombre de una credencial de servicio existente que se va a utilizar para este enlace de servicio. Si no especifica una credencial de instancia de servicio, se generan nuevas credenciales durante la acción de enlace. Este valor es opcional.
--service-instance, --si
El nombre de una instancia de servicio existente de IBM Cloud que se va a enlazar con el trabajo. Este valor es opcional.
--service-instance-id, --siid
El GUID de una instancia de servicio de IBM Cloud existente para enlazar a la aplicación. Este valor es opcional.
--wait, -w
Enlazar la instancia de servicio y esperar a que el enlace de servicio esté listo. Si especifica la opción --wait, el enlace del trabajo espera un tiempo máximo en segundos, definido en la opción --wait-timeout, hasta que el enlace del trabajo finalice correctamente. Si el enlace del trabajo no se ha completado correctamente o falla en el periodo de --wait-timeout especificado, el mandato falla. Este valor es opcional. El valor predeterminado es true.
--wait-timeout, --wto
El periodo de tiempo en segundos que se debe esperar a que el enlace de servicio esté listo. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 300.

Ejemplo

En este ejemplo, se enlaza la instancia de servicio denominada my-object-storage al trabajo denominado hello.

ibmcloud ce job bind --name hello --service-instance my-object-storage

Salida de ejemplo

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

Crear un trabajo.

ibmcloud ce job create --name JOB_NAME ((--image IMAGE_REF | (--build-source SOURCE [--image IMAGE_REF])) [--argument ARGUMENT] [--array-indexes ARRAY_INDEXES] [--array-size ARRAY_SIZE] [--build-commit BUILD_COMMIT] [--build-context-dir BUILD_CONTEXT_DIR] [--build-dockerfile BUILD_DOCKERFILE] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-size BUILD_SIZE] [--build-strategy BUILD_STRATEGY] [--build-timeout BUILD_TIMEOUT] [--command COMMAND] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-secret MOUNT_SECRET] [--no-wait] [--output OUTPUT] [--quiet] [--registry-secret REGISTRY_SECRET] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

-n, --name

El nombre del trabajo. Utilice un nombre que sea exclusivo dentro del proyecto.

  • El nombre debe empezar y terminar con un carácter alfanumérico en minúscula.
  • El nombre debe contener 63 caracteres o menos y puede contener letras en minúsculas, números y guiones (-).

Este valor es obligatorio.

--argument, --arg, -a
Establecer argumentos para ejecuciones del trabajo. Especifique un argumento por opción --argument; por ejemplo, -a argA -a argB. Este valor es opcional.
--array-indexes, --array-indices, --ai

Especifica los índices de la matriz que se utilizan para las ejecuciones del trabajo; por ejemplo, 0,3,6,9, 1-5,7-8,10. El conjunto de índices resultante está limitado a 1000 entradas. Esta opción solo se puede especificar si no se ha especificado « array-size ». Este valor es opcional. El valor predeterminado es 0.

--array-size, --as, --instances, --is

Especifica el número de instancias que se utilizan para las ejecuciones del trabajo. Al utilizar esta opción, el sistema convierte a índices de matriz. Por ejemplo, si se especifica instances de 5, el sistema lo convierte a array-indexes de 0 - 4. Esta opción solo se puede especificar si no se ha especificado la opción « --array-indexes ». Este valor es opcional. El valor predeterminado es 1.

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

La confirmación, el código o la rama del repositorio de origen que se debe extraer. La opción build commit sólo está permitida si la opción --build-source está establecida en URL de un repositorio Git. Este valor es opcional.

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

El directorio del repositorio que contiene el archivo de paquetes de compilación o el Dockerfile. La opción de directorio de contexto de compilación sólo se permite si la opción --build-source está activada. Este valor es opcional.

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

La vía de acceso al Dockerfile. Especifique esta opción únicamente si el nombre es distinto de Dockerfile. La opción build dockerfile sólo está permitida si la opción --build-source está activada. Este valor es opcional. El valor predeterminado es Dockerfile.

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

El nombre del secreto SSH, que contiene las credenciales para acceder al repositorio privado que contiene el código fuente para crear la imagen de contenedor. Para crear este secreto SSH, utilice el comando secret create --format SSH. Un secreto SSH también se utiliza como secreto de acceso al repositorio Git. Esta opción sólo está permitida si la opción --build-source está establecida en URL de un repositorio Git. Este valor es opcional.

--build-size, --size, --bsz, --sz

El tamaño de la compilación, que determina la cantidad de recursos utilizados. Los valores válidos son small, medium, large, xlarge y xxlarge. Para obtener detalles, consulte Determinación del tamaño de la compilación. La opción de tamaño de compilación sólo se permite si está activada la opción --build-source. Este valor es opcional. El valor predeterminado es medium.

--build-source, --source, --bsrc, --src

El URL del repositorio de Git o la vía de acceso del origen local que contiene el código fuente, por ejemplo, https://github.com/IBM/CodeEngine o .. Este valor es opcional.

--build-strategy, --strategy, --bstr, --str

La estrategia que se va a utilizar para compilar la imagen. Los valores válidos son dockerfile y buildpacks. La opción de estrategia de compilación sólo se permite si está activada la opción --build-source. Si no se especifica, la estrategia de compilación viene determinada por Code Engine si se especifica --build-source y el código fuente se encuentra en tu ordenador local. Este valor es opcional. El valor predeterminado es dockerfile.

--build-timeout, --bto

El intervalo de tiempo, en segundos, que puede transcurrir antes de que la compilación tenga éxito o falle. La opción de tiempo de espera de compilación sólo se permite si la opción --build-source está activada. Este valor es opcional. El valor predeterminado es 600.

--command, --cmd, -c

Establecer mandatos para ejecuciones del trabajo. Especifique un mandato por opción --command; por ejemplo, --cmd cmdA --cmd cmdB. Este valor modifica el mandato predeterminado especificado en la imagen del contenedor. Este valor es opcional.

--cpu

La cantidad de CPU que se va a establecer para las ejecuciones del trabajo. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional. El valor predeterminado es 1.

--env, -e

Establecer variables de entorno para ejecuciones del trabajo. Debe estar en el formato NAME=VALUE. Esta acción añade una nueva variable de entorno o modifica una variable de entorno existente. Especifique una variable de entorno por opción de --env; por ejemplo, --env envA=A --env envB=B. Este valor es opcional.

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

Establezca las variables de entorno de los pares de clave-valor que se almacenan en este mapa de configuración utilizando una de las formas siguientes:

  • Para añadir variables de entorno para todas las claves de un mapa de configuración denominado configmapName, utilice el valor configmapName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al mapa de configuración. Para especificar un prefijo, utilice el valor PREFIX=CONFIGMAP_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el mapa de configuración configmapName en CUSTOM_, utilice el valor CUSTOM_=configmapName. Si el mapa de configuración configmapName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un mapa de configuración denominado configmapName, utilice el valor configmapName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un configmap denominado configmapName, utilice el valor configmapName:myKey=key1.

Este valor es opcional.

--env-sec, --env-from-secret
Configura las variables de entorno a partir de los pares clave-valor almacenados en un secreto utilizando uno de los siguientes métodos:
  • Para añadir variables de entorno para todas las claves de un secreto denominado secretName, utilice el valor secretName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al secreto. Para especificar un prefijo, utilice el valor PREFIX=SECRET_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_SECRET>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el secreto secretName en CUSTOM_, utilice el valor CUSTOM_=secretName. Si el secreto secretName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:myKey=key1.

Este valor es opcional.

--ephemeral-storage, --es
La cantidad de almacenamiento efímero que se va a establecer para las ejecuciones del trabajo. Utilice M para megabytes o G para gigabytes. Este valor es opcional. El valor predeterminado es 400M.
--force, -f

No verifique la existencia de las referencias de mapa de configuración y secreto especificadas. Las referencias de mapa de configuración se especifican con la opción --env-from-configmap. Las referencias secretas se especifican con las opciones --env-from-secret o --registry-secret. Este valor es opcional. El valor predeterminado es false.

--image, -i

El nombre de la imagen que se utiliza para las ejecuciones del trabajo. El formato es REGISTRY/NAMESPACE/REPOSITORY:TAG donde REGISTRY y TAG son opcionales. Si no se especifica REGISTRY, el valor predeterminado es docker.io. Si no se especifica TAG, el valor predeterminado es latest. La opción de imagen es necesaria si no se especifica la opción --build-source. Este valor es opcional.

--maxexecutiontime, --met

El tiempo máximo de ejecución en segundos para ejecuciones del trabajo. Esta opción solo se puede especificar si « mode » es « task ». Este valor es opcional. El valor predeterminado es 7200.

--memory, -m

La cantidad de memoria que se va a establecer para las ejecuciones del trabajo. Utilice M para megabytes o G para gigabytes. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional. El valor predeterminado es 4G.

--mode

La modalidad para las ejecuciones del trabajo. Los valores válidos son task y daemon. En el modo « task », se aplican las opciones « maxexecutiontime » y « retrylimit ». En el modo « daemon », dado que no hay tiempo de espera y las instancias que fallan se reinician indefinidamente, no se permiten las opciones « --maxexecutiontime » y « --retrylimit ». Este valor es opcional. El valor por defecto es « task ».

--mount-configmap, --mount-cm

Añada el contenido de un configmap al sistema de archivos de ejecuciones del trabajo proporcionando un directorio de montaje y el nombre de un configmap, con el formato MOUNT_DIRECTORY=CONFIGMAP_NAME. Cada mapa de configuración montado debe utilizar un directorio de montaje exclusivo. Para cada par de clave-valor en el mapa de configuración, se añade un archivo al directorio de montaje especificado donde el nombre de archivo es la clave y el contenido del archivo es el valor del par clave-valor. Especifique una configuración de montaje para --mount-configmap; por ejemplo, --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b. Este valor es opcional.

--mount-data-store, --mount-ds

Montar un almacén de datos persistente. El formato es MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. SUBPATH es opcional. Esta opción se puede especificar varias veces. Este valor es opcional.

--mount-secret, --mount-sec

Añada el contenido de un secreto al sistema de archivos de ejecuciones del trabajo proporcionando un directorio de montaje y el nombre de un secreto, con el formato MOUNT_DIRECTORY=SECRET_NAME. Cada secreto montado debe utilizar un directorio de montaje exclusivo. Para cada par de clave-valor en el secreto, se añade un archivo al directorio de montaje especificado donde el nombre de archivo es la clave y el contenido del archivo es el valor del par clave-valor. Especifique una configuración de montaje para --mount-secret; por ejemplo, --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b. Este valor es opcional.

--no-wait, --nw

No esperar a que se complete la ejecución de compilación. Si especifica la opción --no-wait, la ejecución de compilación empieza y no espera. Utilice el mandato buildrun get para comprobar el estado de la ejecución de la compilación. La opción no-wait sólo se permite si la opción --build-source está activada. Este valor es opcional. El valor predeterminado es false.

--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--registry-secret, --rs

El nombre del secreto de registro. El secreto de registro se utiliza para autenticarse con un registro privado al descargar la imagen de contenedor. Este valor es opcional.

--retrylimit, -r

El número de veces que se va a volver a ejecutar una instancia del trabajo antes de que el trabajo se marque como anómalo. Se vuelve a ejecutar un índice de matriz de un trabajo cuando da un código de salida distinto de cero. Esta opción solo se puede especificar si « mode » es « task ». Este valor es opcional. El valor predeterminado es 3.

--service-account, --sa

Nombre de la cuenta de servicio. Una cuenta de servicio proporciona una identidad para los procesos que se ejecutan en una instancia. Para las cuentas de servicio incorporadas, puede utilizar los nombres abreviados manager, none, reader y writer. También puede utilizar los nombres completos que tienen como prefijo el Kubernetes Config Context, que se puede determinar con el mandato project current. Este valor es opcional.

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

Habilitar el montaje de un token de recurso informático para las ejecuciones del trabajo. Este valor es opcional. El valor predeterminado es false.

--wait, -w

Espere a que se complete la ejecución de compilación. Si especifica la opción --wait, la ejecución de compilación espera un tiempo máximo en segundos, según lo establecido por la opción --wait-timeout, a que se complete la ejecución de compilación. Si la ejecución de compilación no se ha completado en el periodo de --wait-timeout especificado, la ejecución de compilación falla. La opción de espera sólo se permite si la opción --build-source está activada. Este valor es opcional. El valor predeterminado es true.

--wait-timeout, --wto

El periodo de tiempo, en segundos que se esperará a que se complete esta ejecución de compilación. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. La opción de tiempo de espera sólo se permite si la opción --build-source está activada. El valor predeterminado es 600.

Ejemplo

El ejemplo siguiente utiliza la imagen de contenedor icr.io/codeengine/firstjob y asigna 2G MB como memoria y 1 CPU al contenedor. Para obtener más información sobre la selección de valores de memoria y CPU válidos, consulte Combinaciones de memoria y CPU soportadas.

ibmcloud ce job create --image icr.io/codeengine/firstjob --name hellojob --memory 2G --cpu 1

Salida de ejemplo

Creating job 'hellojob'...
OK

ibmcloud ce job delete

Suprimir un trabajo y sus ejecuciones de trabajo asociadas.

ibmcloud ce job delete --name JOB_NAME [--force] [--ignore-not-found] [--orphan-job-runs] [--quiet]

Opciones de mandato

--name, -n
El nombre del trabajo. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--orphan-job-runs, -o
Especifique que se deben mantener las ejecuciones de trabajo asociadas con esta configuración de trabajo. Estas ejecuciones de trabajo huérfanas se deben suprimir por separado. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce job delete --name hello

Salida de ejemplo

Are you sure you want to delete job hello? [y/N]> y
Deleting job 'hello'...
OK

Cuando se ejecuta el mandato ibmcloud ce job delete para suprimir un trabajo, también se suprimen todos los trabajos enviados que hacen referencia a este trabajo.

ibmcloud ce job get

Mostrar los detalles de un trabajo.

ibmcloud ce job get --name JOB_NAME [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
El nombre del trabajo. Este valor es obligatorio.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce job get --name hellojob

Salida de ejemplo

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

Mostrar una lista de todos los trabajos de un proyecto.

ibmcloud ce job list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce job list

Salida de ejemplo

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

Desenlazar instancias de servicio de IBM Cloud de un trabajo para eliminar los enlaces de servicio existentes.

ibmcloud ce job unbind --name JOB_NAME (--binding BINDING_NAME | --all) [--quiet]

Opciones de mandato

--name, -n
El nombre del trabajo que se va a desenlazar. Este valor es obligatorio.
--all, -A
Desenlaza todas las instancias de servicio para este trabajo. Este valor es obligatorio si no se especifica --binding. El valor predeterminado es false.
--binding, -b
El nombre del enlace que se debe desenlazar. Ejecute ibmcloud ce job get -n JOB_NAME para ver los nombres de enlace. Este valor es obligatorio si no se especifica --all.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

En este ejemplo, se eliminan todos los enlaces del trabajo denominado hello.

ibmcloud ce job unbind --name hello --all

Salida de ejemplo

Removing service bindings...
OK

ibmcloud ce job update

Actualizar un trabajo.

ibmcloud ce job update --name JOB_NAME [--argument ARGUMENT] [--arguments-clear] [--array-indexes ARRAY_INDEXES] [--array-size ARRAY_SIZE] [--build-clear] [--build-commit BUILD_COMMIT] [--build-commit-clear] [--build-context-dir BUILD_CONTEXT_DIR] [--build-dockerfile BUILD_DOCKERFILE] [--build-git-repo-secret BUILD_GIT_REPO_SECRET] [--build-git-repo-secret-clear] [--build-size BUILD_SIZE] [--build-source BUILD_SOURCE] [--build-strategy BUILD_STRATEGY] [--build-timeout BUILD_TIMEOUT] [--command COMMAND] [--commands-clear] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-configmap-rm ENV_FROM_CONFIGMAP_RM] [--env-from-secret ENV_FROM_SECRET] [--env-from-secret-rm ENV_FROM_SECRET_RM] [--env-rm ENV_RM] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--image IMAGE] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-rm MOUNT_RM] [--mount-secret MOUNT_SECRET] [--no-wait] [--output OUTPUT] [--quiet] [--rebuild] [--registry-secret REGISTRY_SECRET] [--registry-secret-clear] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--service-account-clear] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

--name, -n

El nombre del trabajo. Este valor es obligatorio.

--argument, --arg, -a

Establecer argumentos para ejecuciones del trabajo. Especifique un argumento por opción --argument; por ejemplo, -a argA -a argB. Este valor es opcional.

--arguments-clear, --ac

Borrar argumentos de trabajo. Este valor es opcional. El valor predeterminado es false.

--array-indexes, --array-indices, --ai

Especifica los índices de la matriz que se utilizan para las ejecuciones del trabajo; por ejemplo, 0,3,6,9, 1-5,7-8,10. El conjunto de índices resultante está limitado a 1000 entradas. Esta opción solo se puede especificar si no se ha especificado « array-size ». Este valor es opcional.

--array-size, --as, --instances, --is

Especifica el número de instancias que se utilizan para las ejecuciones del trabajo. Al utilizar esta opción, el sistema convierte a índices de matriz. Por ejemplo, si se especifica instances de 5, el sistema lo convierte a array-indexes de 0 - 4. Esta opción solo se puede especificar si no se ha especificado la opción « --array-indexes ». Este valor es opcional. El valor predeterminado es 0.

--build-clear, --bc

Elimine la asociación de una compilación de este trabajo. La opción «build clear» solo está disponible si tu trabajo tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es false.

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

La confirmación, el código o la rama del repositorio de origen que se debe extraer. La opción «build commit» solo está permitida si la opción « --build-source » está configurada con el « URL » de un repositorio Git en este comando job update, o si tu trabajo tiene actualmente una compilación asociada procedente de un repositorio Git. Este valor es opcional.

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

Borrar la confirmación, la etiqueta o la rama en el repositorio de origen que se debe extraer. La opción «commit clear» solo está permitida si tu trabajo tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es false.

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

El directorio del repositorio que contiene el archivo de paquetes de compilación o el Dockerfile. La opción del directorio de contexto de compilación solo está permitida si se ha configurado la opción « --build-source » en este comando « job update », o si tu trabajo tiene actualmente una compilación asociada. Este valor es opcional.

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

La vía de acceso al Dockerfile. Especifique esta opción únicamente si el nombre es distinto de Dockerfile. La opción dockerfile de compilación se permite si la opción --build-source se establece en este mandato job update o si el trabajo tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es Dockerfile.

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

El nombre del secreto SSH, que contiene las credenciales para acceder al repositorio privado que contiene el código fuente para crear la imagen de contenedor. Para crear este secreto SSH, utilice el comando secret create --format SSH. Un secreto SSH también se utiliza como secreto de acceso al repositorio Git. Esta opción solo está permitida si la opción « --build-source » está configurada con la URL URL de un repositorio Git en este comando job update, o si tu trabajo tiene actualmente una compilación asociada procedente de un repositorio Git. Este valor es opcional.

--build-git-repo-secret-clear, --git-repo-secret-clear, --bgrsc, --grsc

Borre el secreto SSH. Esta opción está disponible si tu trabajo tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es false.

--build-size, --size, --bsz, --sz

El tamaño de la compilación, que determina la cantidad de recursos utilizados. Los valores válidos son small, medium, large, xlarge y xxlarge. Para obtener detalles, consulte Determinación del tamaño de la compilación. La opción de tamaño de compilación solo está permitida si se ha activado la opción « --build-source » en este comando « job update », o si tu trabajo tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es medium.

--build-source, --source, --bsrc, --src

El URL del repositorio de Git o la vía de acceso del origen local que contiene el código fuente, por ejemplo, https://github.com/IBM/CodeEngine o .. Este valor es opcional.

--build-strategy, --strategy, --bstr, --str

La estrategia que se va a utilizar para compilar la imagen. Los valores válidos son dockerfile y buildpacks. La opción de estrategia de compilación solo está permitida si se ha activado la opción « --build-source » en este comando « job update », o si tu trabajo tiene actualmente una compilación asociada. Si no se especifica, la estrategia de compilación la determina Code Engine si se especifica --build-source y el origen está en la máquina local. Este valor es opcional. El valor predeterminado es dockerfile.

--build-timeout, --bto

El intervalo de tiempo, en segundos, que puede transcurrir antes de que la compilación tenga éxito o falle. La opción de tiempo de espera de compilación solo está permitida si se ha activado la opción « --build-source » en este comando « job update », o si tu trabajo tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es 600.

--command, --cmd, -c

Establecer mandatos para ejecuciones del trabajo. Especifique un mandato por opción --command; por ejemplo, --cmd cmdA --cmd cmdB. Este valor modifica el mandato predeterminado especificado en la imagen del contenedor. Este valor es opcional.

--commands-clear, --cc

Borrar mandatos de trabajo. Este valor es opcional. El valor predeterminado es false.

--cpu

La cantidad de CPU que se va a establecer para las ejecuciones del trabajo. Este valor actualiza cualquier valor de --cpu que se haya asignado en el trabajo. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional. El valor predeterminado es 0.

--env, -e

Establecer variables de entorno para ejecuciones del trabajo. Debe estar en el formato NAME=VALUE. Esta acción añade una nueva variable de entorno o modifica una variable de entorno existente. Especifique una variable de entorno por opción de --env; por ejemplo, --env envA=A --env envB=B. Este valor es opcional.

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

Establezca las variables de entorno de los pares de clave-valor que se almacenan en este mapa de configuración utilizando una de las formas siguientes:

  • Para añadir variables de entorno para todas las claves de un mapa de configuración denominado configmapName, utilice el valor configmapName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al mapa de configuración. Para especificar un prefijo, utilice el valor PREFIX=CONFIGMAP_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el mapa de configuración configmapName en CUSTOM_, utilice el valor CUSTOM_=configmapName. Si el mapa de configuración configmapName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un mapa de configuración denominado configmapName, utilice el valor configmapName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un configmap denominado configmapName, utilice el valor configmapName:myKey=key1.

Este valor es opcional.

--env-from-configmap-rm, --env-cm-rm
Elimina las referencias de variables de entorno a mapas de configuración completos utilizando el nombre del mapa de configuración. Para eliminar referencias de claves individuales a mapas de configuración, utilice la opción --env-rm. Esta opción se puede especificar varias veces. Este valor es opcional.
--env-sec, --env-from-secret

Configura las variables de entorno a partir de los pares clave-valor almacenados en un secreto utilizando uno de los siguientes métodos:

  • Para añadir variables de entorno para todas las claves de un secreto denominado secretName, utilice el valor secretName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al secreto. Para especificar un prefijo, utilice el valor PREFIX=SECRET_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_SECRET>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el secreto secretName en CUSTOM_, utilice el valor CUSTOM_=secretName. Si el secreto secretName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:myKey=key1.

Este valor es opcional.

--env-from-secret-rm, --env-sec-rm
Elimina las referencias de variables de entorno a secretos completos utilizando el nombre secreto. Para eliminar referencias de claves individuales a secretos, utilice la opción --env-rm. Esta opción se puede especificar varias veces. Este valor es opcional.
--env-rm

Eliminar las referencias de variables de entorno a la clave de un par de clave-valor en un mapa de configuración o secreto. Para eliminar referencias de claves individuales y valores literales, especifique el nombre de la clave. Esta opción se puede especificar varias veces. Este valor es opcional.

--ephemeral-storage, --es

La cantidad de almacenamiento efímero que se va a establecer para las ejecuciones del trabajo. Utilice M para megabytes o G para gigabytes. Este valor es opcional.

--force, -f

No verifique la existencia de las referencias de mapa de configuración y secreto especificadas. Las referencias de mapa de configuración se especifican con la opción --env-from-configmap. Las referencias secretas se especifican con las opciones --env-from-secret o --registry-secret. Este valor es opcional. El valor predeterminado es false.

--image, -i

El nombre de la imagen que se utiliza para las ejecuciones del trabajo. El formato es REGISTRY/NAMESPACE/REPOSITORY:TAG donde REGISTRY y TAG son opcionales. Si no se especifica REGISTRY, el valor predeterminado es docker.io. Si no se especifica TAG, el valor predeterminado es latest. Este valor es opcional.

--maxexecutiontime, --met

El tiempo máximo de ejecución en segundos para ejecuciones del trabajo. Esta opción solo se puede especificar si « mode » es « task ». Este valor es opcional. El valor predeterminado es 7200.

--memory, -m

La cantidad de memoria que se va a establecer para las ejecuciones del trabajo. Utilice M para megabytes o G para gigabytes. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional.

--mode

La modalidad para las ejecuciones del trabajo. Los valores válidos son task y daemon. En el modo « task », se aplican las opciones « maxexecutiontime » y « retrylimit ». En el modo « daemon », dado que no hay tiempo de espera y las instancias que fallan se reinician indefinidamente, no se permiten las opciones « --maxexecutiontime » y « --retrylimit ». Este valor es opcional.

--mount-configmap, --mount-cm

Añada el contenido de un configmap al sistema de archivos de ejecuciones del trabajo proporcionando un directorio de montaje y el nombre de un configmap, con el formato MOUNT_DIRECTORY=CONFIGMAP_NAME. Cada mapa de configuración montado debe utilizar un directorio de montaje exclusivo. Para cada par de clave-valor en el mapa de configuración, se añade un archivo al directorio de montaje especificado donde el nombre de archivo es la clave y el contenido del archivo es el valor del par clave-valor. Especifique una configuración de montaje para --mount-configmap; por ejemplo, --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b. Este valor es opcional.

--mount-data-store, --mount-ds

Montar un almacén de datos persistente. El formato es MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. SUBPATH es opcional. Esta opción se puede especificar varias veces. Este valor es opcional.

--mount-rm

Elimine el contenido de un configmap o un secreto del sistema de archivos de ejecuciones del trabajo especificando el directorio donde está montado el configmap o el secreto. Especifique un directorio de montaje para la opción --mount-rm; por ejemplo, --mount-rm /etc/configmap-a --mount-rm /etc/secret-b. Este valor es opcional.

--mount-secret, --mount-sec

Añada el contenido de un secreto al sistema de archivos de ejecuciones del trabajo proporcionando un directorio de montaje y el nombre de un secreto, con el formato MOUNT_DIRECTORY=SECRET_NAME. Cada secreto montado debe utilizar un directorio de montaje exclusivo. Para cada par de clave-valor en el secreto, se añade un archivo al directorio de montaje especificado donde el nombre de archivo es la clave y el contenido del archivo es el valor del par clave-valor. Especifique una configuración de montaje para --mount-secret; por ejemplo, --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b. Este valor es opcional.

--no-wait, --nw

No esperar a que se complete la ejecución de compilación. Si especifica la opción --no-wait, la ejecución de compilación empieza y no espera. Utilice el mandato buildrun get para comprobar el estado de la ejecución de la compilación. La opción «sin espera» solo está permitida si se ha activado la opción « --build-source » en este comando « job update » o si tu trabajo tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es false.

--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--rebuild

Reconstruir imagen desde el origen. La opción de recompilación está permitida si tu trabajo tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es false.

--registry-secret, --rs

El nombre del secreto de registro. El secreto de registro se utiliza para autenticarse con un registro privado al descargar la imagen de contenedor. Este valor es opcional.

--registry-secret-clear, --rsc

Borre el secreto de registro. Este valor es opcional. El valor predeterminado es false.

--retrylimit, -r

El número de veces que se va a volver a ejecutar una instancia del trabajo antes de que el trabajo se marque como anómalo. Se vuelve a ejecutar un índice de matriz de un trabajo cuando da un código de salida distinto de cero. Esta opción solo se puede especificar si « mode » es « task ». Este valor es opcional. El valor predeterminado es 3.

--service-account, --sa

Nombre de la cuenta de servicio. Una cuenta de servicio proporciona una identidad para los procesos que se ejecutan en una instancia. Para las cuentas de servicio incorporadas, puede utilizar los nombres abreviados manager, none, reader y writer. También puede utilizar los nombres completos que tienen como prefijo el Kubernetes Config Context, que se puede determinar con el mandato project current. Este valor es opcional.

--service-account-clear, --sac

Borrar la cuenta de servicio. Este valor es opcional. El valor predeterminado es false.

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

Habilitar el montaje de un token de recurso informático para las ejecuciones del trabajo. Este valor es opcional. El valor predeterminado es false.

--wait, -w

Espere a que se complete la ejecución de compilación. Si especifica la opción --wait, la ejecución de compilación espera un tiempo máximo en segundos, según lo establecido por la opción --wait-timeout, a que se complete la ejecución de compilación. Si la ejecución de compilación no se ha completado en el periodo de --wait-timeout especificado, la ejecución de compilación falla. La opción «wait» solo está permitida si se ha activado la opción « --build-source » en este comando « job update » o si tu trabajo tiene actualmente una compilación asociada. Este valor es opcional. El valor predeterminado es true.

--wait-timeout, --wto

El periodo de tiempo, en segundos que se esperará a que se complete esta ejecución de compilación. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. La opción de tiempo de espera se permite si la opción --build-source se establece en este mandato job update o si el trabajo tiene actualmente una compilación asociada. El valor predeterminado es 600.

Ejemplo

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

Salida de ejemplo

Updating job 'hellojob'...
OK

Mandatos jobrun

Un trabajo ejecuta una o varias instancias de tu código ejecutable en paralelo. A diferencia de las aplicaciones, que gestionan solicitudes HTTP, los trabajos se han diseñado para que se ejecuten una vez y se salga. Cuando crea un trabajo, puede especificar la información de configuración de carga de trabajo que se utiliza cada vez que se ejecuta el trabajo. Utilice mandatos jobrun para ejecutar instancias del trabajo.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos jobrun.

Para obtener más información sobre cómo trabajar con trabajos y ejecuciones de trabajos, consulte Ejecución de trabajos.

Para consultar la ayuda de la CLI sobre los comandos de « jobrun », ejecuta « ibmcloud ce jobrun -h ».

ibmcloud ce jobrun delete

Suprimir una ejecución de trabajo.

ibmcloud ce jobrun delete (--name JOBRUN_NAME | --job JOB_NAME) [--force] [--ignore-not-found] [--quiet]

Opciones de mandato

--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--job, -j
Utilice esta opción para suprimir todas las ejecuciones de trabajo del trabajo especificado. La opción --job es necesaria si no especifica el valor --name. Este valor es opcional.
--name, -n
El nombre de la ejecución del trabajo que se va a suprimir. La opción --name es necesaria si no especifica el valor --job. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce jobrun delete --name myjobrun -f

Salida de ejemplo

Deleting job run 'myjobrun'...
OK

ibmcloud ce jobrun events

Mostrar los sucesos del sistema de las instancias de ejecución de trabajos. Los sucesos del sistema se conservan hasta 60 minutos.

ibmcloud ce jobrun events (--instance JOBRUN_INSTANCE | --jobrun JOBRUN_NAME) [--output OUTPUT] [--quiet]

Opciones de mandato

--instance, -i
El nombre de una instancia de ejecución de trabajo específica. Utilice el mandato jobrun get para buscar el nombre de la instancia. Este valor es obligatorio si no se especifica --jobrun.
--jobrun, -j, --name, -n
Se visualizan los sucesos de todas las instancias de la ejecución de trabajo que se haya especificado. Este valor es obligatorio si no se especifica --instance.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

En el ejemplo siguiente se muestra la información de sucesos del sistema para todas las instancias de una ejecución de trabajo especificada.

ibmcloud ce jobrun events --jobrun myjobrun

Salida de ejemplo

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"

Ejemplo de información de sucesos del sistema para la instancia especificada de una ejecución de trabajo

También puede visualizar información de sucesos del sistema para una instancia especificada de una ejecución de trabajo utilizando la opción --instance con el mandato ibmcloud ce jobrun events. Utilice el mandato jobrun get para visualizar detalles sobre la ejecución del trabajo, incluyendo las instancias en ejecución de la ejecución del trabajo.

ibmcloud ce jobrun events --instance myjobrun-2-0
Ejemplo de salida de información de sucesos del sistema para la instancia especificada de una ejecución de trabajo
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

Mostrar los detalles de una ejecución del trabajo.

ibmcloud ce jobrun get --name JOBRUN_NAME [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
El nombre de la ejecución del trabajo. Este valor es obligatorio.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce jobrun get --name myjobrun

Salida de ejemplo

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

Mostrar una lista de todas las ejecuciones de trabajo de un proyecto.

ibmcloud ce jobrun list [--job JOB] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--job, -j
Utilice esta opción para visualizar sólo las ejecuciones de trabajo del trabajo especificado. Este valor es opcional.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce jobrun list

Salida de ejemplo

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

El nombre de la ejecución del trabajo que aparece indica el nombre de la ejecución del trabajo y la revisión actual de la ejecución del trabajo.

ibmcloud ce jobrun logs

Mostrar los registros de las instancias de ejecución de trabajo.

ibmcloud ce jobrun logs (--instance JOBRUN_INSTANCE | --jobrun JOBRUN_NAME) [--follow] [--output OUTPUT] [--quiet] [--raw] [--tail TAIL] [--timestamps]

Opciones de mandato

--follow, -f
Seguir los registros de las instancias de ejecución de trabajos. Utilice esta opción para transmitir los registros de instancias de ejecución de trabajos. Si especifica la opción --follow, debe indicar Ctrl+C para finalizar este mandato de registro. Este valor es opcional. El valor predeterminado es false.
--instance, -i
El nombre de una instancia de ejecución de trabajo específica. Utilice el mandato jobrun get para buscar el nombre de la instancia. Este valor es obligatorio si no se especifica --jobrun.
--jobrun, -j, --name, -n
Se visualizan los registros de todas las instancias de la ejecución de trabajo que se haya especificado. Este valor es obligatorio si no se especifica --instance.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--raw, -r
Mostrar registros sin etiquetas de instancia y contenedor. Este valor es opcional. El valor predeterminado es false.
--tail, -t
Se limita la visualización de los registros de las instancias de ejecución de trabajos especificadas a un número máximo de líneas recientes. Por ejemplo, para visualizar las últimas líneas de 3 de los registros de las instancias de ejecución de trabajos especificadas, especifique --tail 3. Si no se especifica esta opción, se muestran todas las líneas de los registros de las instancias de ejecución de trabajos especificadas. Este valor es opcional. El valor predeterminado es -1.
--timestamps, --ts
Se incluyen las indicaciones de fecha y hora en cada línea de la salida del registro. Este valor es opcional. El valor predeterminado es false.

Ejemplo

En el ejemplo siguiente se muestran los registros de una instancia específica de una ejecución de trabajo. Utilice el mandato jobrun get para obtener el nombre de las instancias de ejecución del trabajo.

ibmcloud ce jobrun logs --instance myjobrun-3-0

Salida de ejemplo

Getting logs for job run instance 'myjobrun-3-0'...
OK
myjobrun-3-0/myjobrun:
Hi from a batch job! My index is: 3

Ejemplo de registros de todas las instancias de una ejecución de trabajo

En el ejemplo siguiente se muestran los registros de todas las instancias de una ejecución de trabajo.

ibmcloud ce jobrun logs --jobrun myjobrun
Ejemplo de salida de registros de todas las instancias de una ejecución de trabajo
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 las instancias de ejecución de trabajos en ejecución.

ibmcloud ce jobrun restart (--instance JOBRUN_INSTANCE | --jobrun JOBRUN_NAME) [--quiet]

Opciones de mandato

--instance, -i
El nombre de una instancia de ejecución de trabajo específica. Utilice el mandato jobrun get para buscar el nombre de la instancia. Este valor es obligatorio si no se especifica --jobrun.
--jobrun, -j, --name, -n
Reiniciar todas las instancias en ejecución de la ejecución de trabajo especificada. Este valor es obligatorio si no se especifica --instance.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce jobrun restart --name myjobrun

Salida de ejemplo

Getting jobrun 'myjobrun'...
Getting instances of jobrun 'myjobrun'...
Restarting all running instances of job run 'myjobrun'...
OK

ibmcloud ce jobrun resubmit

Volver a enviar una ejecución del trabajo basada en la configuración de una ejecución del trabajo anterior.

ibmcloud ce jobrun resubmit --jobrun REFERENCED_JOBRUN_NAME [--argument ARGUMENT] [--arguments-clear] [--array-indexes ARRAY_INDEXES] [--array-size ARRAY_SIZE] [--array-size-var-override ARRAY_SIZE_VAR_OVERRIDE] [--command COMMAND] [--commands-clear] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-configmap-rm ENV_FROM_CONFIGMAP_RM] [--env-from-secret ENV_FROM_SECRET] [--env-from-secret-rm ENV_FROM_SECRET_RM] [--env-rm ENV_RM] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-rm MOUNT_RM] [--mount-secret MOUNT_SECRET] [--name NAME] [--no-wait] [--output OUTPUT] [--quiet] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--service-account-clear] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

--jobrun, -j

El nombre de la ejecución del trabajo anterior en la que se basa esta ejecución del trabajo. Este valor es obligatorio.

--argument, --arg, -a

Establecer argumentos para esta ejecución del trabajo. Especifique un argumento por opción --argument; por ejemplo, -a argA -a argB. Este valor es opcional.

--arguments-clear, --ac

Borrar argumentos de ejecución de trabajo. Este valor es opcional. El valor predeterminado es false.

--array-indexes, --array-indices, --ai

Especifica los índices de las instancias que se utilizan para esta ejecución del trabajo; por ejemplo, 0,3,6,9, 1-5,7-8,10. El conjunto de índices resultante está limitado a 1000 entradas. Esta opción solo se puede especificar si no se ha especificado « array-size ». Este valor es opcional.

--array-size, --as, --instances, --is

Especifica el número de instancias que se utilizan para esta ejecución de trabajo. Al utilizar esta opción, el sistema convierte a índices de matriz. Por ejemplo, si se especifica instances de 5, el sistema lo convierte a array-indexes de 0 - 4. Esta opción solo se puede especificar si no se ha especificado la opción « --array-indexes ». Este valor es opcional. El valor predeterminado es 0.

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

Especifica un valor personalizado para la variable de entorno « JOB_ARRAY_SIZE ». De forma predeterminada, la variable de entorno JOB_ARRAY_SIZE se establece en el valor array-size o en el número de índices especificado en array-indexes``. El valor de la variable de entorno JOB_ARRAY_SIZE no afecta al tamaño de array configurado. Utilice esta opción para imponer un valor de tamaño de matriz constante para escenarios de repetición de trabajos, en los que sólo se envían o reenvían algunas instancias de trabajo. Este valor es opcional.

--command, --cmd, -c

Establecer mandatos para esta ejecución del trabajo. Especifique un mandato por opción --command; por ejemplo, --cmd cmdA --cmd cmdB. Este valor modifica el mandato predeterminado especificado en la imagen del contenedor. Este valor es opcional.

--commands-clear, --cc

Borrar mandatos de ejecución de trabajo. Este valor es opcional. El valor predeterminado es false.

--cpu

Cantidad de CPU definida para cada índice de matriz para esta ejecución del trabajo. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional. El valor predeterminado es 0.

--env, -e

Establecer variables de entorno para esta ejecución del trabajo. Debe estar en el formato NAME=VALUE. Esta acción añade una nueva variable de entorno o modifica una variable de entorno existente. Especifique una variable de entorno por opción de --env; por ejemplo, -e envA -e envB. Este valor es opcional.

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

Establezca las variables de entorno de los pares de clave-valor que se almacenan en este mapa de configuración utilizando una de las formas siguientes:

  • Para añadir variables de entorno para todas las claves de un mapa de configuración denominado configmapName, utilice el valor configmapName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al mapa de configuración. Para especificar un prefijo, utilice el valor PREFIX=CONFIGMAP_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el mapa de configuración configmapName en CUSTOM_, utilice el valor CUSTOM_=configmapName. Si el mapa de configuración configmapName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un mapa de configuración denominado configmapName, utilice el valor configmapName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un configmap denominado configmapName, utilice el valor configmapName:myKey=key1.

Este valor es opcional.

--env-from-configmap-rm, --env-cm-rm
Elimina las referencias de variables de entorno a mapas de configuración completos utilizando el nombre del mapa de configuración. Para eliminar referencias de claves individuales a mapas de configuración, utilice la opción --env-rm. Este valor es opcional.
--env-sec, --env-from-secret

Configura las variables de entorno a partir de los pares clave-valor almacenados en un secreto utilizando uno de los siguientes métodos:

  • Para añadir variables de entorno para todas las claves de un secreto denominado secretName, utilice el valor secretName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al secreto. Para especificar un prefijo, utilice el valor PREFIX=SECRET_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_SECRET>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el secreto secretName en CUSTOM_, utilice el valor CUSTOM_=secretName. Si el secreto secretName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:myKey=key1.

Este valor es opcional.

--env-from-secret-rm, --env-sec-rm
Elimina las referencias de variables de entorno a secretos completos utilizando el nombre secreto. Para eliminar referencias de claves individuales a secretos, utilice la opción --env-rm. Esta opción se puede especificar varias veces. Este valor es opcional.
--env-rm

Eliminar las referencias de variables de entorno a la clave de un par de clave-valor en un mapa de configuración o secreto. Para eliminar referencias de claves individuales y valores literales, especifique el nombre de la clave. Esta opción se puede especificar varias veces. Este valor es opcional.

--ephemeral-storage, --es

La cantidad de almacenamiento efímero para esta ejecución del trabajo. Utilice M para megabytes o G para gigabytes. Este valor es opcional.

--force, -f

No verifique la existencia de las referencias de mapa de configuración y secreto especificadas. Las referencias de mapa de configuración se especifican con la opción --env-from-configmap. Las referencias de secreto se especifican con la opción --env-from-secret. Este valor es opcional. El valor predeterminado es false.

--maxexecutiontime, --met

El tiempo máximo de ejecución en segundos para esta ejecución del trabajo. Esta opción solo se puede especificar si « mode » es « task ». Este valor es opcional. El valor predeterminado es 7200.

--memory, -m

La cantidad de memoria que se asignará a esta ejecución del trabajo. Utilice M para megabytes o G para gigabytes. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional.

--mode

La modalidad de la ejecución del trabajo. Los valores válidos son task y daemon. En el modo « task », se aplican las opciones « maxexecutiontime » y « retrylimit ». En el modo « daemon », dado que no hay tiempo de espera y las instancias que fallan se reinician indefinidamente, no se permiten las opciones « maxexecutiontime » y « retrylimit ». Este valor es opcional.

--mount-configmap, --mount-cm

Añada el contenido de un configmap al sistema de archivos de esta ejecución de trabajo proporcionando un directorio de montaje y el nombre de un configmap, con el formato MOUNT_DIRECTORY=CONFIGMAP_NAME. Cada mapa de configuración montado debe utilizar un directorio de montaje exclusivo. Para cada par de clave-valor en el mapa de configuración, se añade un archivo al directorio de montaje especificado donde el nombre de archivo es la clave y el contenido del archivo es el valor del par clave-valor. Especifique una configuración de montaje para --mount-configmap; por ejemplo, --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b. Este valor es opcional.

--mount-data-store, --mount-ds

Montar un almacén de datos persistente. El formato es MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. SUBPATH es opcional. Esta opción se puede especificar varias veces. Este valor es opcional.

--mount-rm

Elimine el contenido de un configmap o un secreto del sistema de archivos de esta ejecución de trabajo especificando el directorio donde está montado el configmap o el secreto. Especifique un directorio de montaje para la opción --mount-rm; por ejemplo, --mount-rm /etc/configmap-a --mount-rm /etc/secret-b. Este valor es opcional.

--mount-secret, --mount-sec

Añada el contenido de un secreto al sistema de archivos de esta ejecución de trabajo proporcionando un directorio de montaje y el nombre de un secreto, con el formato MOUNT_DIRECTORY=SECRET_NAME. Cada secreto montado debe utilizar un directorio de montaje exclusivo. Para cada par de clave-valor en el secreto, se añade un archivo al directorio de montaje especificado donde el nombre de archivo es la clave y el contenido del archivo es el valor del par clave-valor. Especifique una configuración de montaje para --mount-secret; por ejemplo, --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b. Este valor es opcional.

-n, --name

El nombre de esta ejecución del trabajo. Este valor es necesario si el trabajo referenciado no tiene una configuración de trabajo relacionada. Utilice un nombre que sea exclusivo dentro del proyecto.

  • El nombre debe empezar y terminar con un carácter alfanumérico en minúscula.
  • El nombre debe contener 53 caracteres o menos y puede contener letras en minúsculas, números y guiones (-).

Este valor es opcional.

--no-wait, --nw
Volver a enviar la ejecución del trabajo y no esperar a que se completen las instancias de este trabajo. Si se especifica la opción --no-wait, el reenvío de la ejecución del trabajo comienza y no espera. Utilice el mandato jobrun get para comprobar el estado de la ejecución del trabajo. Este valor es opcional. El valor predeterminado es true.
--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--retrylimit, -r

El número de veces que se va a volver a ejecutar una instancia de esta ejecución del trabajo antes de que la ejecución del trabajo se marque como anómala. Se vuelve a ejecutar un índice de matriz de una ejecución del trabajo cuando da un código de salida distinto de cero. Esta opción solo se puede especificar si « mode » es « task ». Este valor es opcional. El valor predeterminado es 3.

--service-account, --sa

Nombre de la cuenta de servicio. Una cuenta de servicio proporciona una identidad para los procesos que se ejecutan en una instancia. Para las cuentas de servicio incorporadas, puede utilizar los nombres abreviados manager, none, reader y writer. También puede utilizar los nombres completos que tienen como prefijo el Kubernetes Config Context, que se puede determinar con el mandato project current. Este valor es opcional.

--service-account-clear, --sac

Borrar la cuenta de servicio. Este valor es opcional. El valor predeterminado es false.

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

Habilita el montaje de un token de recurso informático para las instancias de esta ejecución de trabajo. Este valor es opcional. El valor predeterminado es false.

--wait, -w

Volver a enviar la ejecución del trabajo y esperar a que se completen las instancias de este trabajo. Si especifica la opción --wait, el reenvío de la ejecución del trabajo espera un tiempo máximo en segundos, definido en la opción --wait-timeout, hasta que finalice la ejecución del trabajo. Si la ejecución del trabajo no finaliza en el periodo --wait-timeout especificado, el reenvío de la ejecución del trabajo falla. Este valor es opcional. El valor predeterminado es false.

--wait-timeout, --wto

El periodo de tiempo en segundos que se debe esperar a que finalicen las instancias de esta ejecución del trabajo. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 600.

Ejemplo

En el siguiente ejemplo se vuelve a ejecutar la ejecución del trabajo myjobrun para las instancias 4-5. El nombre de la ejecución del trabajo reenviada es myjobresubmit.

ibmcloud ce jobrun resubmit --name myjobresubmit --jobrun myjobrun --array-indices 4-5

Salida de ejemplo

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 una ejecución de trabajo basada en un trabajo.

ibmcloud ce jobrun submit ((--name JOBRUN_NAME --image IMAGE) | (--job JOB_NAME [--name JOBRUN_NAME])) [--argument ARGUMENT] [--array-indexes ARRAY_INDEXES] [--array-size ARRAY_SIZE] [--array-size-var-override ARRAY_SIZE_VAR_OVERRIDE] [--command COMMAND] [--cpu CPU] [--env ENV] [--env-from-configmap ENV_FROM_CONFIGMAP] [--env-from-secret ENV_FROM_SECRET] [--ephemeral-storage EPHEMERAL_STORAGE] [--force] [--maxexecutiontime MAXEXECUTIONTIME] [--memory MEMORY] [--mode MODE] [--mount-configmap MOUNT_CONFIGMAP] [--mount-data-store MOUNT_DATA_STORE] [--mount-secret MOUNT_SECRET] [--no-wait] [--output OUTPUT] [--quiet] [--registry-secret REGISTRY_SECRET] [--retrylimit RETRYLIMIT] [--service-account SERVICE_ACCOUNT] [--trusted-profiles-enabled] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

--argument, --arg, -a

Establecer argumentos para esta ejecución del trabajo. Especifique un argumento por opción --argument; por ejemplo, -a argA -a argB. Este valor es opcional.

--array-indexes, --array-indices, --ai

Especifica los índices de las instancias que se utilizan para esta ejecución del trabajo; por ejemplo, 0,3,6,9, 1-5,7-8,10. El conjunto de índices resultante está limitado a 1000 entradas. Esta opción solo se puede especificar si no se ha especificado « array-size ». Este valor es opcional. El valor predeterminado es 0.

--array-size, --as, --instances, --is

Especifica el número de instancias que se utilizan para esta ejecución de trabajo. Al utilizar esta opción, el sistema convierte a índices de matriz. Por ejemplo, si se especifica instances de 5, el sistema lo convierte a array-indexes de 0 - 4. Esta opción solo se puede especificar si no se ha especificado la opción « --array-indexes ». Este valor es opcional. El valor predeterminado es 1.

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

Especifica un valor personalizado para la variable de entorno « JOB_ARRAY_SIZE ». De forma predeterminada, la variable de entorno JOB_ARRAY_SIZE se establece en el valor array-size o en el número de índices especificado en array-indexes``. El valor de la variable de entorno JOB_ARRAY_SIZE no afecta al tamaño de array configurado. Utilice esta opción para imponer un valor de tamaño de matriz constante para escenarios de repetición de trabajos, en los que sólo se envían o reenvían algunas instancias de trabajo. Este valor es opcional.

--command, --cmd, -c

Establecer mandatos para esta ejecución del trabajo. Especifique un mandato por opción --command; por ejemplo, --cmd cmdA --cmd cmdB. Este valor modifica el mandato predeterminado especificado en la imagen del contenedor. Este valor es opcional.

--cpu

Cantidad de CPU definida para cada índice de matriz para esta ejecución del trabajo. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional. El valor predeterminado es 1.

--env, -e

Establecer variables de entorno para esta ejecución del trabajo. Debe estar en el formato NAME=VALUE. Esta acción añade una nueva variable de entorno o modifica una variable de entorno existente. Especifique una variable de entorno por opción de --env; por ejemplo, -e envA -e envB. Este valor es opcional.

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

Establezca las variables de entorno de los pares de clave-valor que se almacenan en este mapa de configuración utilizando una de las formas siguientes:

  • Para añadir variables de entorno para todas las claves de un mapa de configuración denominado configmapName, utilice el valor configmapName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al mapa de configuración. Para especificar un prefijo, utilice el valor PREFIX=CONFIGMAP_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el mapa de configuración configmapName en CUSTOM_, utilice el valor CUSTOM_=configmapName. Si el mapa de configuración configmapName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un mapa de configuración denominado configmapName, utilice el valor configmapName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un configmap denominado configmapName, utilice el valor configmapName:myKey=key1.

Este valor es opcional.

--env-sec, --env-from-secret
Configura las variables de entorno a partir de los pares clave-valor almacenados en un secreto utilizando uno de los siguientes métodos:
  • Para añadir variables de entorno para todas las claves de un secreto denominado secretName, utilice el valor secretName. Puede modificar los nombres de las variables de entorno especificando un prefijo cuando hace referencia al secreto. Para especificar un prefijo, utilice el valor PREFIX=SECRET_NAME. Cada variable de entorno resultante tiene el formato <PREFIX><NAME_OF_KEY_IN_SECRET>. Por ejemplo, para establecer el prefijo de todos los nombres de variable de las claves en el secreto secretName en CUSTOM_, utilice el valor CUSTOM_=secretName. Si el secreto secretName contiene KEY_A, el nombre de la variable de entorno es CUSTOM_KEY_A.
  • Para añadir variables de entorno para claves individuales, utilice el formato NAME:KEY_A,KEY_B. Por ejemplo, para añadir una variable de entorno para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:key1. Para asignar un nombre distinto a una clave referenciada, utilice el formato NAME:NEW_NAME=KEY_A. Por ejemplo, para añadir una variable de entorno denominada myKey para una sola clave key1 en un secreto denominado secretName, utilice el valor secretName:myKey=key1.

Este valor es opcional.

--ephemeral-storage, --es
La cantidad de almacenamiento efímero para esta ejecución del trabajo. Utilice M para megabytes o G para gigabytes. Este valor es opcional. El valor predeterminado es 400M.
--force, -f

No verifique la existencia de las referencias de mapa de configuración y secreto especificadas. Las referencias de mapa de configuración se especifican con la opción --env-from-configmap. Las referencias secretas se especifican con las opciones --env-from-secret o --registry-secret. Este valor es opcional. El valor predeterminado es false.

--image, -i

El nombre de la imagen que se utiliza para esta ejecución de trabajo. El formato es REGISTRY/NAMESPACE/REPOSITORY:TAG donde REGISTRY y TAG son opcionales. Si no se especifica REGISTRY, el valor predeterminado es docker.io. Si no se especifica TAG, el valor predeterminado es latest. Si no especifica la opción --job, se necesitan los valores --name y --image. Este valor es opcional.

--job, -j

El nombre de la configuración del trabajo. Para ver configuraciones del trabajo, utilice el mandato job list. Si se especifica el valor --job, puede especificar opcionalmente el valor --name. Si no se especifica el valor --job, debe especificar los valores --name e --image. Este valor es opcional.

--maxexecutiontime, --met

El tiempo máximo de ejecución en segundos para esta ejecución del trabajo. Esta opción solo se puede especificar si « mode » es « task ». Este valor es opcional. El valor predeterminado es 7200.

--memory, -m

La cantidad de memoria que se asignará a esta ejecución del trabajo. Utilice M para megabytes o G para gigabytes. Para obtener los valores válidos, consulte Combinaciones de memoria y CPU soportadas. Este valor es opcional. El valor predeterminado es 4G.

--mode

La modalidad de la ejecución del trabajo. Los valores válidos son task y daemon. En el modo « task », se aplican las opciones « maxexecutiontime » y « retrylimit ». En el modo « daemon », dado que no hay tiempo de espera y las instancias que fallan se reinician indefinidamente, no se permiten las opciones « maxexecutiontime » y « retrylimit ». Este valor es opcional. El valor por defecto es « task ».

--mount-configmap, --mount-cm

Añada el contenido de un configmap al sistema de archivos de esta ejecución de trabajo proporcionando un directorio de montaje y el nombre de un configmap, con el formato MOUNT_DIRECTORY=CONFIGMAP_NAME. Cada mapa de configuración montado debe utilizar un directorio de montaje exclusivo. Para cada par de clave-valor en el mapa de configuración, se añade un archivo al directorio de montaje especificado donde el nombre de archivo es la clave y el contenido del archivo es el valor del par clave-valor. Especifique una configuración de montaje para --mount-configmap; por ejemplo, --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b. Este valor es opcional.

--mount-data-store, --mount-ds

Montar un almacén de datos persistente. El formato es MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. SUBPATH es opcional. Esta opción se puede especificar varias veces. Este valor es opcional.

--mount-secret, --mount-sec

Añada el contenido de un secreto al sistema de archivos de esta ejecución de trabajo proporcionando un directorio de montaje y el nombre de un secreto, con el formato MOUNT_DIRECTORY=SECRET_NAME. Cada secreto montado debe utilizar un directorio de montaje exclusivo. Para cada par de clave-valor en el secreto, se añade un archivo al directorio de montaje especificado donde el nombre de archivo es la clave y el contenido del archivo es el valor del par clave-valor. Especifique una configuración de montaje para --mount-secret; por ejemplo, --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b. Este valor es opcional.

-n, --name

El nombre de esta ejecución del trabajo. Si no especifica el valor --job, se necesitan los valores --name y --image. Utilice un nombre que sea exclusivo dentro del proyecto.

  • El nombre debe empezar y terminar con un carácter alfanumérico en minúscula.
  • El nombre debe contener 53 caracteres o menos y puede contener letras en minúsculas, números y guiones (-).

Este valor es opcional.

--no-wait, --nw
Enviar la ejecución del trabajo y no esperar a que se completen las instancias de este trabajo. Si se especifica la opción --no-wait, el envío de la ejecución del trabajo comienza y no espera. Utilice el mandato jobrun get para comprobar el estado de la ejecución del trabajo. Este valor es opcional. El valor predeterminado es true.
--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--registry-secret, --rs

El nombre del secreto de registro. El secreto de registro se utiliza para autenticarse con un registro privado al descargar la imagen de contenedor. Este valor es opcional.

--retrylimit, -r

El número de veces que se va a volver a ejecutar una instancia de esta ejecución del trabajo antes de que la ejecución del trabajo se marque como anómala. Se vuelve a ejecutar un índice de matriz de una ejecución del trabajo cuando da un código de salida distinto de cero. Esta opción solo se puede especificar si « mode » es « task ». Este valor es opcional. El valor predeterminado es 3.

--service-account, --sa

Nombre de la cuenta de servicio. Una cuenta de servicio proporciona una identidad para los procesos que se ejecutan en una instancia. Para las cuentas de servicio incorporadas, puede utilizar los nombres abreviados manager, none, reader y writer. También puede utilizar los nombres completos que tienen como prefijo el Kubernetes Config Context, que se puede determinar con el mandato project current. Este valor es opcional.

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

Habilita el montaje de un token de recurso informático para las instancias de esta ejecución de trabajo. Este valor es opcional. El valor predeterminado es false.

--wait, -w

Enviar la ejecución del trabajo y esperar a que se completen las instancias de este trabajo. Si especifica la opción --wait, el envío de la ejecución del trabajo espera un tiempo máximo en segundos, definido en la opción --wait-timeout, hasta que finalice la ejecución del trabajo. Si la ejecución del trabajo no finaliza en el periodo --wait-timeout especificado, el envío de la ejecución del trabajo falla. Este valor es opcional. El valor predeterminado es false.

--wait-timeout, --wto

El periodo de tiempo en segundos que se debe esperar a que finalicen las instancias de esta ejecución del trabajo. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 600.

Ejemplo

ibmcloud ce jobrun submit --name myjobrun --image icr.io/codeengine/firstjob --array-indices 1-5

Salida de ejemplo

Submitting job run 'myjobrun'...
Run 'ibmcloud ce jobrun get -n myjobrun' to check the job run status.
OK

Comandos Persistentdatastore

Gestionar almacenes de datos persistentes.

ibmcloud ce persistentdatastore create

Crear un almacén de datos persistente.

ibmcloud ce persistentdatastore create --name NAME --cos-access-secret SECRET_NAME --cos-bucket-name BUCKET_NAME [--cos-bucket-location BUCKET_LOCATION] [--quiet]

Opciones de mandato

--cos-access-secret, --cos-sec
Obligatorio. El nombre del secreto que contiene las credenciales para acceder a la instancia de COS. Este valor es obligatorio.
--cos-bucket-name, --cos-bucket
Obligatorio. El nombre del grupo de COS. Este valor es obligatorio.
--name, -n
Obligatorio. El nombre del almacén de datos persistente. Utilice un nombre que sea exclusivo dentro del proyecto. Este valor es obligatorio.
--cos-bucket-location, --cos-loc
La ubicación del grupo de COS. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce persistentdatastore create --name my-pds-2 --cos-bucket-name my-test-bucket-2 --cos-access-secret my-hmac-secret-2

Salida de ejemplo

Successfully created persistent data store named 'my-pds-2'.
OK

ibmcloud ce persistentdatastore delete

Suprimir un almacén de datos persistente.

ibmcloud ce persistentdatastore delete --name PERSISTENT_DATA_STORE_NAME [--force] [--ignore-not-found] [--quiet]

Opciones de mandato

--name, -n
Obligatorio. Nombre del almacén de datos persistente. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce persistentdatastore delete --name my-pds-3 -f

Salida de ejemplo

Deleting persistent data store 'my-pds-3'...
OK

ibmcloud ce persistentdatastore get

Visualizar los detalles de un almacén de datos persistente.

ibmcloud ce persistentdatastore get --name NAME [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
Obligatorio. El nombre del almacén de datos persistente. Este valor es obligatorio.
--output, -o
Formato de salida. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce persistentdatastore get --name my-pds-2

Salida de ejemplo

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 los almacenes de datos persistentes en un proyecto.

ibmcloud ce persistentdatastore list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Formato de salida. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

Este comando enumera todos los almacenes de datos persistentes de un proyecto.

ibmcloud ce persistentdatastore list

Salida de ejemplo

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

Mandatos project

Utilice los mandatos project para crear, mostrar una lista, suprimir y seleccionar un proyecto como contexto actual.

Un proyecto es un conjunto de entidades de Code Engine, como aplicaciones, funciones, trabajos, flotas y compilaciones. Un proyecto se basa en un espacio de nombres de Kubernetes. El nombre del proyecto debe ser exclusivo en el grupo de recursos, la cuenta de usuario y la región de IBM Cloud®. Los proyectos se utilizan para gestionar recursos y facilitar el acceso a sus entidades.

Un proyecto ofrece las siguientes funciones:

  • Un espacio de nombres único para los nombres de las entidades.
  • Gestión del acceso de los usuarios a los recursos del proyecto.
  • Gestión del acceso externo a los servicios de respaldo, los registros y los repositorios.
  • Un certificado generado automáticamente para el Servicio de la Capa de Transporte ( TLS ).

Para obtener más información sobre cómo trabajar con proyectos, consulte Ejecución de trabajos.

Puede utilizar project o proj en los mandatos de project. Para ver la ayuda de la CLI para los mandatos project, ejecute ibmcloud ce proj -h.

ibmcloud ce project create

Cree un proyecto.

ibmcloud ce project create --name PROJECT_NAME [--endpoint ENDPOINT] [--no-select] [--no-wait] [--output OUTPUT] [--quiet] [--tag TAG] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

-n, --name

El nombre del proyecto. Utilice un nombre que sea exclusivo de la región. El nombre debe tener 128 caracteres o menos y puede contener:

  • Cualquier carácter Unicode o alfanumérico.
  • Solo estos caracteres especiales: espacios ( ), puntos (.), dos puntos (:), guiones bajos (_) y guiones (-).

Este valor es obligatorio.

--endpoint, -e
El punto final del proyecto. Los valores válidos son public y private. Si la opción --endpoint no se especifica explícitamente, el sistema determina el comportamiento. Si la CLI de IBM Cloud está conectada a private.cloud.ibm.com, el proyecto Code Engine se comporta como si --endpoint fuera private. Si la CLI de IBM Cloud está conectada a cloud.ibm.com, el proyecto Code Engine se comporta como si --endpoint fuera public. Este valor es opcional.
--no-select, --ns

No seleccione el proyecto como contexto actual después de crear este proyecto. Si no selecciona esta opción, el proyecto se selecciona automáticamente. Este valor es opcional. El valor predeterminado es false.

--no-wait, --nw

Cree el proyecto y no espere a que se cree el proyecto. Si especifica la opción no-wait, se inicia la creación del proyecto sin esperar. Utilice el mandato project get para comprobar el estado del proyecto. Este valor es opcional. El valor predeterminado es false.

--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--tag, -t

Una etiqueta para asignar a su proyecto. La etiqueta debe tener 128 caracteres o menos y puede contener letras, números, espacios (), puntos (.), dos puntos (:), subrayados (_) y guiones (-). Especifique una etiqueta por opción --tag; por ejemplo, --tag tagA --tag tagB. Este valor es opcional.

--wait, -w

Cree el proyecto y espere a que se cree el proyecto. Si especifica la opción --wait, el proyecto de creación del proyecto espera un tiempo máximo en segundos, tal como establece la opción --wait-timeout, para que se cree el proyecto. Si el proyecto no se crea dentro del periodo --wait-timeout especificado, la creación del proyecto falla. Este valor es opcional. El valor predeterminado es true.

--wait-timeout, --wto

El periodo de tiempo, en segundos, que se esperará a que se cree el proyecto. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 600.

Ejemplo

ibmcloud ce project create --name myproject

Salida de ejemplo

Creating project 'myproject'...
OK

ibmcloud ce project current

Mostrar los detalles del proyecto seleccionado actualmente como destino.

ibmcloud ce project current [--output OUTPUT] [--quiet]

Opciones de mandato

--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce project current

Salida de ejemplo

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

Suprimir un proyecto.

ibmcloud ce project delete (--name PROJECT_NAME | --id PROJECT_ID) [--force] [--hard] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--hard
Suprimir inmediatamente el proyecto. Si no especifica la opción --hard, el proyecto se puede restaurar en un plazo de 7 días utilizando el mandato project restore o reclamation restore. Este valor es opcional. El valor predeterminado es false.
--id, --guid
El ID del proyecto. Este valor es obligatorio si no se especifica --name.
--name, -n
El nombre del proyecto. Este valor es obligatorio si no se especifica --id.
--no-wait, --nw
Suprima el proyecto y no espere a que éste se haya suprimido. Si se especifica la opción no-wait, se inicia la supresión del proyecto y no se espera. Utilice el mandato project get para comprobar el estado del proyecto. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--wait, -w
Suprima el proyecto y espere a que éste se haya suprimido. Si se especifica la opción --wait, la supresión del proyecto espera durante un tiempo máximo definido en segundos, tal como establece la opción --wait-timeout, a que se suprima el proyecto. Si el proyecto no se suprime dentro del periodo especificado de --wait-timeout, la supresión del proyecto falla. Este valor es opcional. El valor predeterminado es true.
--wait-timeout, --wto
El periodo de tiempo en segundos que se debe esperar a que el proyecto se suprima. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 600.

Ejemplo

ibmcloud ce project delete --name myproject -f

Salida de ejemplo

Deleting project 'myproject'...
OK

ibmcloud ce project get

Mostrar los detalles de un solo proyecto.

ibmcloud ce project get (--name PROJECT_NAME | --id PROJECT_ID) [--output OUTPUT] [--quiet]

Opciones de mandato

--id, --guid
El ID del proyecto. Este valor es obligatorio si no se especifica --name.
--name, -n
El nombre del proyecto. Este valor es obligatorio si no se especifica --id.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce project get --name myproject

Salida de ejemplo

Getting project 'myproject'...
OK
Name:                                      myproject
ID:                                        abcdabcd-abcd-abcd-abcd-f1de4aab5d5d
CRN:                                       crn:v1:bluemix:public:codeengine:au-syd:a/1a2b3c4d5e6f7g1a2b3c4d5e6f7g1234:abcdabcd-abcd-abcd-abcd-f1de4aab5d5d::
Status:                                    active
Enabled:                                   true
Application Private Visibility Supported:  true
Selected:                                  true
Tags:                                      tag1, tag2
Region:                                    us-south
Resource Group:                            default
Service Binding Service ID:                ServiceId-1234abcd-abcd-abcd-1111-1a2b3c4d5e6f
Age:                                       52d
Created:                                   Mon, 30 Jun 2025 18:16:12 +0200
Updated:                                   Mon, 30 Jun 2025 18:16:58 +0200
Connectivity:    
  Outbound - Source IP addresses:                             
    Public internet  
    159.23.99.151  
    130.198.13.241  
    135.90.137.31  
    
    IBM Cloud private network  
    10.223.236.11  
    10.223.242.142  
    10.12.3.244  
  Inbound - Context-based restrictions for the data plane:    
    Enforcement status:         none  
    Public internet:            allowed  
    IBM Cloud private network:  allowed  
    Last applied:               Wed, 20 May 2026 15:52:02 +0200  
Quotas:
    Category                                  Used       Limit
    App revisions                             33         100
    Apps                                      10         100
    Build runs                                4          100
    Builds                                    4          100
    Configmaps                                7          100
    CPU                                       6.15       64
    Custom domain mappings                    4          80
    Ephemeral storage                         5415750Ki  256G
    Functions                                 2          20
    Instances (active)                        6          250
    Instances (total)                         9          2500
    Job runs                                  4          100
    Jobs                                      3          100
    Memory                                    26400M     256G
    Persistent data stores                    2          10
    Private path connections                  1          3
    Secrets                                   21         100
    Serverless fleets                         42         1000
    Subnet pools                              3          20
    Subscriptions (cron)                      1          100
    Subscriptions (IBM Cloud Object Storage)  0          100

ibmcloud ce project list

Listar todos los proyectos.

ibmcloud ce project list [--all-resource-groups] [--output OUTPUT] [--quiet] [--regions REGIONS] [--sort-by SORT_BY]

Opciones de mandato

--all-resource-groups, --all
Mostrar proyectos de todos los grupos de recursos. De forma predeterminada, los proyectos solo se visualizan desde el grupo de recursos actual. Este valor es opcional. El valor predeterminado es false.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--regions, -r
Limitar la visualización de proyectos a las regiones especificadas. Proporcione el nombre de una o varias regiones; por ejemplo, us-south,eu-de. Este valor es opcional.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce project list

Salida de ejemplo

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

ibmcloud ce project restore (--name PROJECT_NAME | --id PROJECT_ID) [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

--id, --guid
El ID del proyecto. Este valor es obligatorio si no se especifica --name.
--name, -n
El nombre del proyecto. Este valor es obligatorio si no se especifica --id.
--no-wait, --nw
Restaure el proyecto y no espere a que se restaure el proyecto. Si se especifica la opción no-wait, la restauración del proyecto empieza y no espera. Utilice el mandato project get para comprobar el estado del proyecto. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--wait, -w
Restaure el proyecto y espere a que se restaure el proyecto. Si se especifica la opción --wait, la restauración del proyecto espera un tiempo máximo en segundos, configurado mediante la opción --wait-timeout, para restaurar el proyecto. Si el proyecto no se restaura dentro del periodo --wait-timeout especificado, la restauración del proyecto ha fallado. Este valor es opcional. El valor predeterminado es true.
--wait-timeout, --wto
El periodo de tiempo en segundos que hay que esperar para que se restaure el proyecto. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 600.

Ejemplo

Este ejemplo restaura el proyecto myproject, que se encuentra en estado de soft deleted, a un estado activo. Utilice el comando project list para visualizar la lista de todos los proyectos y su estado.

ibmcloud ce project restore --name myproject

Salida de ejemplo

Restoring project 'myproject'...
OK

ibmcloud ce project select

Seleccione un proyecto como contexto actual. El proyecto debe estar en estado active para poder seleccionarlo.

ibmcloud ce project select (--name PROJECT_NAME | --id PROJECT_ID) [--endpoint ENDPOINT] [--kubecfg] [--quiet]

Opciones de mandato

--endpoint, -e
El punto final del proyecto. Los valores válidos son public y private. Si la opción --endpoint no se especifica explícitamente, el sistema determina el comportamiento. Si la CLI de IBM Cloud está conectada a private.cloud.ibm.com, el proyecto Code Engine se comporta como si --endpoint fuera private. Si la CLI de IBM Cloud está conectada a cloud.ibm.com, el proyecto Code Engine se comporta como si --endpoint fuera public. Este valor es opcional.
--id, --guid
El ID del proyecto. Este valor es obligatorio si no se especifica --name.
--kubecfg, -k
Añada el proyecto al archivo de configuración de Kubernetes. Puede sobrescribir el archivo de configuración predeterminado de Kubernetes estableciendo la variable de entorno KUBECONFIG. Este valor es opcional. El valor predeterminado es false.
--name, -n
El nombre del proyecto. Este valor es obligatorio si no se especifica --id.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce project select --name myproject

Salida de ejemplo

Selecting project 'myproject'...
OK

ibmcloud ce project tag

Gestiona las etiquetas de un único proyecto.

ibmcloud ce project tag (--name PROJECT_NAME | --id PROJECT_ID) [--quiet] [--tag TAG] [--tag-rm TAG_RM]

Opciones de mandato

--id, --guid
El ID del proyecto. Este valor es obligatorio si no se especifica --name.
--name, -n
El nombre del proyecto. Este valor es obligatorio si no se especifica --id.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--tag, -t
Una etiqueta para asignar a su proyecto. La etiqueta debe tener 128 caracteres o menos y puede contener letras, números, espacios (), puntos (.), dos puntos (:), subrayados (_) y guiones (-). Especifique una etiqueta por opción --tag; por ejemplo, --tag tagA --tag tagB. Este valor es opcional.
--tag-rm, --trm
Elimine una etiqueta asignada a su proyecto. Especifique una etiqueta por opción --tag-rm; por ejemplo, --tag-rm tagA --tag-rm tagB. Este valor es opcional.

Ejemplo

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

Salida de ejemplo

Getting project 'myproject'...
OK

ibmcloud ce project update

Actualizar el proyecto seleccionado.

ibmcloud ce project update (--binding-service-id SERVICE_ID_ID | --binding-resource-group RESOURCE_GROUP_NAME | --binding-resource-group-id RESOURCE_GROUP_ID) [--quiet]

Opciones de mandato

--binding-resource-group, --brg
El nombre de un grupo de recursos que se utilizará para la autenticación de los enlaces de servicio de este proyecto. Un ID de servicio se crea con los roles Operator y Manager para todos los servicios en este grupo de recursos. Utilice "*" para especificar todos los grupos de recursos de esta cuenta. Este valor es opcional.
--binding-resource-group-id, --brgid
El ID de un grupo de recursos que se utilizará para la autenticación para los enlaces de servicio de este proyecto. Un ID de servicio se crea con los roles Operator y Manager para todos los servicios en este grupo de recursos. Este valor es opcional.
--binding-service-id, --bsid
El ID de un servicio que se utilizará para la autenticación de los enlaces de servicio de este proyecto. Este ID de servicio debe tener el rol de Operator y un rol de servicio apropiado para una o más instancias de servicio, tipos de servicio o grupos de recursos. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce project update --binding-service-id ServiceId-1234abcd-abcd-abcd-1111-1a2b3c4d5e6f

Salida de ejemplo

Configuring your project for service bindings...
Creating service binding API key 'my-project-api-key' for service ID 'my-custom-service-id'...
OK

Mandatos de reclamación

Gestione las reclamaciones de proyecto de Code Engine. Los proyectos que se suprimen de forma suave se pueden restaurar en un plazo de 7 días mediante el mandato reclamation restore.

ibmcloud ce reclamation delete

Suprimir una reclamación de proyecto.

ibmcloud ce reclamation delete (--name PROJECT_NAME | --id PROJECT_ID) [--force] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--id, --guid
El ID del proyecto. Este valor es obligatorio si no se especifica --name.
--name, -n
El nombre del proyecto. Este valor es obligatorio si no se especifica --id.
--no-wait, --nw
Suprimir la reclamación de proyecto y no esperar a que la reclamación de proyecto se haya suprimido. Si se especifica la opción no-wait, se inicia la supresión de reclamación del proyecto sin esperar. Utilice el mandato reclamation get para comprobar el estado de reclamación del proyecto. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--wait, -w
Suprimir la reclamación de proyecto y esperar a que la reclamación de proyecto se haya suprimido. Si se especifica la opción --wait, la supresión de reclamación de proyecto espera un tiempo máximo en segundos, tal como establece la opción --wait-timeout, para que se suprima la reclamación del proyecto. Si la reclamación de proyecto no se suprime en el periodo --wait-timeout especificado, la supresión de reclamación del proyecto falla. Este valor es opcional. El valor predeterminado es true.
--wait-timeout, --wto
El periodo de tiempo, en segundos, que se esperará a que se suprima la reclamación de proyecto. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 600.

Ejemplo

Este ejemplo suprime permanentemente el proyecto myproject que se encuentra en estado soft deleted. Al utilizar la opción --force con este mandato, se fuerza la supresión sin confirmación. Puede utilizar el mandato reclamation list para visualizar una lista de todos los proyectos que están en estado soft deleted.

ibmcloud ce reclamation delete --name myproject --f

Salida de ejemplo

Hard deleting project 'myproject'...
OK

ibmcloud ce reclamation get

Visualizar los detalles de una reclamación de proyecto individual.

ibmcloud ce reclamation get (--name PROJECT_NAME | --id PROJECT_ID) [--output OUTPUT] [--quiet]

Opciones de mandato

--id, --guid
El ID del proyecto. Este valor es obligatorio si no se especifica --name.
--name, -n
El nombre del proyecto. Este valor es obligatorio si no se especifica --id.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce reclamation get --name myproject

Salida de ejemplo

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

Listar todas las reclamaciones de proyecto.

ibmcloud ce reclamation list [--all-resource-groups] [--output OUTPUT] [--quiet] [--regions REGIONS] [--sort-by SORT_BY]

Opciones de mandato

--all-resource-groups, --all
Mostrar las reclamaciones de proyecto de todos los grupos de recursos. De forma predeterminada, las reclamaciones de proyecto solo se visualizan desde el grupo de recursos actual. Este valor es opcional. El valor predeterminado es false.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--regions, -r
Limitar la visualización de reclamaciones de proyecto a regiones especificadas. Proporcione el nombre de una o varias regiones; por ejemplo, us-south,eu-de. Este valor es opcional.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce reclamation list

Salida de ejemplo

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 una reclamación de proyecto. Los proyectos que se suprimen de forma suave se pueden restaurar en un plazo de 7 días mediante el mandato reclamation restore.

ibmcloud ce reclamation restore (--name PROJECT_NAME | --id PROJECT_ID) [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

--id, --guid
El ID del proyecto. Este valor es obligatorio si no se especifica --name.
--name, -n
El nombre del proyecto. Este valor es obligatorio si no se especifica --id.
--no-wait, --nw
Restaure la reclamación de proyecto y no espere a que se restaure la reclamación del proyecto. Si especifica la opción no-wait, la restauración de reclamación de proyecto comienza sin esperar. Utilice el mandato reclamation get para comprobar el estado de reclamación del proyecto. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--wait, -w
Restaure la reclamación del proyecto y espere a que se restaure la reclamación del proyecto. Si especifica la opción --wait la restauración de reclamación de proyecto espera un tiempo máximo en segundos, tal como establece la opción --wait-timeout, para que se restaure la reclamación del proyecto. Si la reclamación de proyecto no se restaura dentro del periodo --wait-timeout especificado, la restauración de reclamación del proyecto falla. Este valor es opcional. El valor predeterminado es true.
--wait-timeout, --wto
El periodo de tiempo, en segundos, que se esperará a que se restaure la reclamación de proyecto. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 600.

Ejemplo

Este ejemplo restaura el proyecto myproject, que se encuentra en estado de soft deleted, a un estado activo. Utilice el mandato reclamation list para visualizar una lista de todos los proyectos que están en estado soft deleted.

ibmcloud ce reclamation restore --name myproject

Salida de ejemplo

Restoring project 'myproject'...
OK

Mandatos registry

Un registro de contenedor, o registro, es un servicio que almacena imágenes de contenedor. Por ejemplo, IBM Cloud Container Registry y Docker Hub son registros de contenedor. Un registro de contenedor puede ser público o privado. Para acceder a un registro de contenedor público no se requieren credenciales. En cambio, el acceso a un registro privado requiere credenciales.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos registry.

Para obtener más información sobre el acceso a registros, consulte Adición de acceso a un registro de contenedores privado.

Para consultar la ayuda de la CLI sobre los comandos de « registry », ejecuta « ibmcloud ce registry -h ».

A partir de la versión de la CLI 1.42.0, la definición y el trabajo con secretos en la CLI se unifican bajo el grupo de comandos secret grupo de comando. Véase ibmcloud ce secret comandos. Utilice la opción --format para especificar la categoría del secreto, como basic_auth, generic, hmac, ssh, tls o registry. Aunque puede seguir utilizando el registry grupo de comandos, aproveche las ventajas del grupo de comando unificado secret unificado. Para crear un secreto de acceso al registro de un contenedor, utilice el comando ibmcloud ce secret create --format registry comando. Para obtener más información sobre cómo trabajar con secretos en Code Engine, consulte Trabajar con secretos.

ibmcloud ce registry create

Crear un secreto de acceso del registro de imágenes.

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]

Opciones de mandato

-n, --name

El nombre del secreto de acceso del registro de imágenes. Utilice un nombre que sea exclusivo dentro del proyecto.

  • El nombre debe empezar y terminar con un carácter alfanumérico en minúscula.
  • El nombre no puede contener más de 253 y puede contener letras en minúsculas, números, puntos (.) y guiones (-).

Este valor es obligatorio.

--email, -e
La dirección de correo electrónico para acceder al servidor de registro. Este valor es opcional.
--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--password, -p

La contraseña para acceder al servidor de registro. Si no se especifica la opción --password, ni --password-from-fileni --password-from-json-file, se le solicitará la contraseña. Este valor es opcional.

--password-from-file, --pf

La vía de acceso a un archivo que contiene la contraseña para acceder al servidor de registro. La primera línea del archivo se utiliza para la contraseña. Si no se especifica la opción --password, ni --password-from-fileni --password-from-json-file, se le solicitará la contraseña. Este valor es opcional.

--password-from-json-file, --pfj

La vía de acceso a un archivo JSON que contiene la contraseña para acceder al servidor de registro. El campo apikey se utiliza para la contraseña. Si no se especifica la opción --password, ni --password-from-fileni --password-from-json-file, se le solicitará la contraseña. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--server, -s

El URL del servidor de registro. Este valor es opcional. El valor predeterminado es us.icr.io.

--username, -u

El nombre de usuario para acceder al servidor de registro. Este valor es opcional. El valor predeterminado es iamapikey.

Ejemplo

En el ejemplo siguiente se crea el acceso del registro de imágenes denominado myregistry a una instancia de Container Registry que se encuentra en us.icr.io y se utiliza el nombre de usuario iamapikey y la clave de API de IAM como contraseña.

ibmcloud ce registry create --name myregistry --server us.icr.io --username iamapikey --password API_KEY

Salida de ejemplo

Creating image registry access secret myregistry...
OK

ibmcloud ce registry delete

Suprimir un secreto de acceso del registro de imágenes.

ibmcloud ce registry delete --name NAME [--force] [--ignore-not-found] [--quiet]

Opciones de mandato

--name, -n
El nombre del secreto de acceso del registro de imágenes. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce registry delete --name myregistry -f

Salida de ejemplo

Deleting image registry access secret myregistry...
OK

ibmcloud ce registry get

Mostrar los detalles de un secreto de acceso de registro de imágenes.

ibmcloud ce registry get --name NAME [--decode] [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
El nombre del secreto de acceso del registro de imágenes. Este valor es obligatorio.
--decode, -d
Muestra la salida Data como decodificada en los detalles. Si no se especifica esta opción, los detalles de Data se codificarán en base 64. Este valor es opcional. El valor predeterminado es false.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce registry get --name myregistry

Salida de ejemplo

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

Mostrar una lista de todos los secretos de acceso del registro de imágenes de un proyecto.

ibmcloud ce registry list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce registry list

Salida de ejemplo

Listing image registry access secrets...
OK
Name        Age
myregistry  19m22s

ibmcloud ce registry update

Actualizar un secreto de registro de imágenes.

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]

Opciones de mandato

--name, -n
El nombre del secreto de acceso del registro de imágenes. Este valor es obligatorio.
--email, -e
La dirección de correo electrónico para acceder al servidor de registro. Este valor es opcional.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--password, -p
La contraseña para acceder al servidor de registro. Este valor es opcional.
--password-from-file, --pf
La vía de acceso a un archivo que contiene la contraseña para acceder al servidor de registro. La primera línea del archivo se utiliza para la contraseña. Este valor es opcional.
--password-from-json-file, --pfj
La vía de acceso a un archivo JSON que contiene la contraseña para acceder al servidor de registro. El campo apikey se utiliza para la contraseña. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--server, -s
El URL del servidor de registro. Este valor es opcional.
--username, -u
El nombre de usuario para acceder al servidor de registro. Este valor es opcional.

Ejemplo

En el ejemplo siguiente se actualiza una contraseña para el acceso de registro de imágenes denominado myregistry.

ibmcloud ce registry update --name myregistry --password NEW_API_KEY

Salida de ejemplo

Getting image registry access secret 'myregistry'...
Updating image registry access secret 'myregistry'...
OK

Mandatos repo

Un repositorio de código, como GitHub o GitLab, almacena el código fuente. Con Code Engine, puede añadir acceso a un repositorio de código privado y, a continuación, hacer referencia a dicho repositorio desde la compilación.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos repo.

Para obtener más información sobre el acceso de repositorios, consulte el tema sobre Acceso a repositorios de código privado.

Para consultar la ayuda de la CLI sobre los comandos de « repo », ejecuta « ibmcloud ce repo -h ».

A partir de la versión de la CLI 1.42.0, la definición y el trabajo con secretos en la CLI se unifican bajo el grupo de comandos secret grupo de comando. Véase ibmcloud ce secret comandos. Utilice la opción --format para especificar la categoría del secreto, como basic_auth, generic, hmac, ssh, tls o registry. Aunque puede seguir utilizando el repo grupo de comandos, aproveche las ventajas del grupo de comando unificado secret unificado. Para crear un secreto para acceder a un servicio con una clave SSH, como para autenticarse en un repositorio Git como GitHub o GitLab, utilice el comando ibmcloud ce secret create --format ssh comando Un secreto SSH también se utiliza como secreto de acceso al repositorio Git. Para obtener más información sobre cómo trabajar con secretos en Code Engine, consulte Trabajar con secretos.

ibmcloud ce repo create

Crear un secreto de acceso del repositorio 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]

Opciones de mandato

--host, --ho

La dirección del host; por ejemplo github.com. Este valor es obligatorio.

--key-path, --kp

La vía de acceso al archivo de claves privadas SSH no cifrado. Si utiliza la clave SSH privada personal, este archivo se suele hallar en $HOME/.ssh/id_rsa (Mac OS o Linux) o en %HOMEPATH%\.ssh\id_rsa (Windows). Este valor es obligatorio.

-n, --name

El nombre del secreto de acceso del repositorio Git. Utilice un nombre que sea exclusivo dentro del proyecto.

  • El nombre debe empezar y terminar con un carácter alfanumérico en minúscula.
  • El nombre no puede contener más de 253 y puede contener letras en minúsculas, números, puntos (.) y guiones (-).

Este valor es obligatorio.

--known-hosts-path, --khp
La vía de acceso al archivo de hosts conocidos. Este valor es una característica de seguridad para garantizar que la clave privada solo se utiliza para autenticarse en hosts a los que ha accedido anteriormente, específicamente los hosts de GitHub o GitLab. Este archivo se suele hallar en $HOME/.ssh/known_hosts (Mac OS o Linux) o en %HOMEPATH%\.ssh\known_hosts (Windows). Este valor es opcional.
--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

El mandato siguiente crea un secreto de acceso de Git denominado github para el host github.com y se autentica con una clave SSH ubicada en /<filepath>/.ssh/id_rsa, donde <filepath> es la vía de acceso del sistema.

ibmcloud ce repo create -n github --key-path /<filepath>/.ssh/id_rsa --host github.com

Salida de ejemplo

Creating Git access secret github...
OK

ibmcloud ce repo delete

Suprimir un secreto de acceso del repositorio Git.

ibmcloud ce repo delete --name NAME [--force] [--ignore-not-found] [--quiet]

Opciones de mandato

--name, -n
El nombre del secreto de acceso del repositorio Git. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce repo delete --name github

Salida de ejemplo

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

Mostrar los detalles de un secreto de acceso del repositorio Git.

ibmcloud ce repo get --name NAME [--decode] [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
El nombre del secreto de acceso del repositorio Git. Este valor es obligatorio.
--decode, -d
Muestra la salida Data como decodificada en los detalles. Si no se especifica esta opción, los detalles de Data se codificarán en base 64. Este valor es opcional. El valor predeterminado es false.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce repo get -n github

Salida de ejemplo

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

Mostrar una lista de todos los secretos de acceso del repositorio Git de un proyecto.

ibmcloud ce repo list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce repo list

Salida de ejemplo

Listing Git access secrets...
OK
Name    Age  
github  13m0s

ibmcloud ce repo update

Actualizar un secreto de acceso de repositorio Git.

ibmcloud ce repo update --name SECRET_NAME [--host HOST] [--key-path KEY_PATH] [--known-hosts-path KNOWN_HOSTS_PATH] [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
El nombre del secreto de acceso del repositorio Git. Este valor es obligatorio.
--host, --ho
La dirección del host; por ejemplo github.com. Este valor es opcional.
--key-path, --kp
La vía de acceso al archivo de claves privadas SSH no cifrado. Si utiliza la clave SSH privada personal, este archivo se suele hallar en $HOME/.ssh/id_rsa (Mac OS o Linux) o en %HOMEPATH%\.ssh\id_rsa (Windows). Este valor es opcional.
--known-hosts-path, --khp
La vía de acceso al archivo de hosts conocidos. Este valor es una característica de seguridad para garantizar que la clave privada solo se utiliza para autenticarse en hosts a los que ha accedido anteriormente, específicamente los hosts de GitHub o GitLab. Este archivo se suele hallar en $HOME/.ssh/known_hosts (Mac OS o Linux) o en %HOMEPATH%\.ssh\known_hosts (Windows). Este valor es opcional.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

El mandato siguiente actualiza un secreto de acceso Git denominado github para que utilice un host nuevo.

ibmcloud ce repo update  -n github --host NEW_HOST

Salida de ejemplo

Getting Git access secret 'github'...
Updating Git access secret 'github'...
OK

Mandatos de revisión

Una aplicación, o app, ejecuta el código para servir solicitudes HTTP. Además de las solicitudes HTTP tradicionales, IBM Cloud® Code Engine también da soporte a aplicaciones que utilizan WebSockets como protocolo de comunicaciones. Una app contiene una o varias revisiones. Una revisión representa una versión inmutable de las propiedades de configuración de la app. Cada actualización de una propiedad de configuración de la app crea una nueva revisión de la app.

Utilice los mandatos revision para gestionar revisiones de la aplicación.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos revision.

Para obtener más información sobre cómo trabajar con revisiones para apps, Despliegue de aplicaciones.

Puede utilizar revision o rev en los mandatos de revision. Para ver la ayuda de la CLI para los mandatos revision, ejecute ibmcloud ce revision -h.

ibmcloud ce revision delete

Suprimir una revisión de aplicación.

ibmcloud ce revision delete --name REVISION_NAME [--force] [--ignore-not-found] [--quiet]

Opciones de mandato

--name, -n
El nombre de la revisión de la aplicación. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce revision delete -n newapp-mytest-00004 -f

Salida de ejemplo

Deleting application revision 'newapp-mytest-00004'...
OK

ibmcloud ce revision events

Mostrar los sucesos del sistema de las instancias de revisión de aplicación. Los sucesos del sistema se conservan hasta 60 minutos.

ibmcloud ce revision events (--instance REVISION_INSTANCE | --revision REVISION_NAME) [--output OUTPUT] [--quiet]

Opciones de mandato

--instance, -i
El nombre de una instancia de aplicación específica. Utilice el mandato rev get para buscar el nombre de la instancia. Este valor es obligatorio si no se especifica --revision.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--revision, --rev, -r, --name, -n
Visualice los sucesos de todas las instancias de la revisión de aplicación especificada. Este valor es obligatorio si no se especifica --instance.

Ejemplo

ibmcloud ce revision events -n myapp-00001

Salida de ejemplo

Code Engine solo conserva la última revisión inactiva de la aplicación, además de la revisión de la app activa. Las revisiones más antiguas no se retienen.

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

Mostrar los detalles de una revisión de aplicación.

ibmcloud ce revision get --name REVISION_NAME [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
El nombre de la revisión de la aplicación. Este valor es obligatorio.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce revision get --name newapp-mytest-00002

Salida de ejemplo

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 las revisiones de aplicación en un proyecto.

ibmcloud ce revision list [--application APPLICATION] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--application, --app, -a
Utilice esta opción para visualizar solo las revisiones de la aplicación especificada. Este valor es opcional.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce revision list

Salida de ejemplo

Code Engine solo conserva la última revisión inactiva de la aplicación, además de la revisión de la app activa. Las revisiones más antiguas no se retienen.

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

Visualice los registros de instancias de revisión de aplicación.

ibmcloud ce revision logs (--instance REVISION_INSTANCE | --revision REVISION_NAME) [--all-containers] [--follow] [--output OUTPUT] [--quiet] [--tail TAIL] [--timestamps]

Opciones de mandato

--all-containers, --all
Visualice los registros de todos los contenedores de las instancias de la revisión de aplicación especificadas. Este valor es opcional. El valor predeterminado es false.
--follow, -f
Siga los registros de las instancias de revisión de la aplicación. Utilice esta opción para transmitir registros de instancias de revisión de aplicación. Si especifica la opción --follow, debe indicar Ctrl+C para finalizar este mandato de registro. Este valor es opcional. El valor predeterminado es false.
--instance, -i
El nombre de una instancia de revisión de aplicación específica. Utilice el mandato revision get para buscar el nombre de la instancia. Este valor es obligatorio si no se especifica --revision.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--revision, --rev, -r, --name, -n
Visualizar los registros de todas las instancias de la revisión de aplicación especificadas. Este valor es obligatorio si no se especifica --instance.
--tail, -t
Limite la visualización de los registros de los contenedores de las instancias de revisión de aplicación especificadas a un número máximo de líneas recientes por contenedor. Por ejemplo, para visualizar las últimas 3 líneas de los registros de los contenedores de las instancias de revisión de aplicación especificadas, especifique --tail 3. Si no se especifica esta opción, se muestran todas las líneas de los registros de los contenedores de las instancias de revisión de la aplicación especificadas. Este valor es opcional. El valor predeterminado es -1.
--timestamps, --ts
Se incluyen las indicaciones de fecha y hora en cada línea de la salida del registro. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce revision logs -n myapp-00001

Salida de ejemplo

Code Engine solo conserva la última revisión inactiva de la aplicación, además de la revisión de la app activa. Las revisiones más antiguas no se retienen.

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

Mandatos secret

Un secreto proporciona un método para incluir información de configuración confidencial, como contraseñas o claves SSH, en el despliegue. Al hacer referencia a los valores de tu secreto, puedes separar la información confidencial de tu implementación para que tu aplicación, función o tarea sea portátil. Cualquiera que tenga autorización sobre su proyecto también puede ver sus secretos; asegúrese de que se puede compartir la información secreta con dichos usuarios. Los secretos contienen información en pares de clave-valor.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos secret.

Para más información sobre cómo trabajar con secretos, consulta Trabajar con secretos.

Para consultar la ayuda de la CLI sobre los comandos de « secret », ejecuta « ibmcloud ce secret -h ».

A partir de la versión de la CLI 1.42.0, la definición y el trabajo con secretos en la CLI se unifican bajo el grupo de comandos secret grupo de comando. Utilice la opción --format para especificar la categoría del secreto, como basic_auth, generic, hmac, ssh, tls o registry. El valor por defecto de la opción --format es generic.

ibmcloud ce secret create

Cree un secreto.

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]

Opciones de mandato

--access-key-id, --akid

Especifique el ID de clave de acceso de la credencial de HMAC. Este valor es opcional.

--access-key-id-prompt

Solicitar el ID de clave de acceso de la credencial de HMAC. Este valor es opcional. El valor predeterminado es false.

--cert-chain-file, --ccf

Especifica un archivo que contenga la cadena de certificados facilitada por tu autoridad de certificación para un secreto de « TLS ». Debe proporcionar la vía de acceso al archivo como un valor. Este valor es necesario para los secretos de tls. Este valor es opcional.

--email, --em

La dirección de correo electrónico para acceder al servidor de registro para un secreto de registro. Este valor sólo se aplica a los secretos de registry. Este valor es opcional.

--format, --fo

Formato del secreto. Los valores válidos son basic_auth, generic, hmac, registry, ssh o tls. Este valor es opcional. El valor predeterminado es generic.

--from-env-file, -e

Cree un secreto genérico a partir de un archivo que contenga una o varias líneas que coincidan con el formato KEY=VALUE. Debe proporcionar la vía de acceso al archivo como un valor. Cada línea del archivo especificado se añade como un par de clave-valor. Las líneas del archivo especificado que están vacías o empiezan por # se ignoran. Este valor es obligatorio si no se especifica --from-literal o --from-file. Esta opción se puede especificar varias veces. Este valor sólo se aplica a los secretos de generic.

--from-file, -f

Crear un secreto genérico a partir de un archivo. Debe proporcionar la vía de acceso al archivo como un valor. Este valor es obligatorio si no se especifica --from-literal o --from-env-file. Esta opción se puede especificar varias veces. Este valor sólo se aplica a los secretos de generic.

--from-json-file, --json

La vía de acceso a un archivo que contiene los valores secretos en formato JSON. Esta opción es compatible con el formato secreto hmac Este valor es opcional.

--from-literal, -l

Crear un secreto genérico a partir de un par de clave-valor. Debe estar en el formato KEY=VALUE. Este valor es obligatorio si no se especifica --from-file o --from-env-file. Esta opción se puede especificar varias veces. Este valor sólo se aplica a los secretos de generic.

--key-path, --kp

La ruta a su archivo de clave privada SSH sin cifrar para un secreto SSH. Si utiliza la clave SSH privada personal, este archivo se suele hallar en $HOME/.ssh/id_rsa (Mac OS o Linux) o en %HOMEPATH%\.ssh\id_rsa (Windows). Este valor es necesario para los secretos de ssh. Este valor es opcional.

--known-hosts-path, --khp

La ruta a su archivo de hosts conocidos para un secreto SSH. Este valor es una característica de seguridad para garantizar que la clave privada solo se utiliza para autenticarse en hosts a los que ha accedido anteriormente, específicamente los hosts de GitHub o GitLab. Este archivo se suele hallar en $HOME/.ssh/known_hosts (Mac OS o Linux) o en %HOMEPATH%\.ssh\known_hosts (Windows). Este valor sólo se aplica a los secretos de ssh. Este valor es opcional.

-n, --name

El nombre del secreto. Utilice un nombre que sea exclusivo dentro del proyecto.

  • El nombre debe empezar y terminar con un carácter alfanumérico en minúscula.
  • El nombre no puede contener más de 253 y puede contener letras en minúsculas, números, puntos (.) y guiones (-).

Este valor es opcional.

--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--password, --pw

La contraseña para una autenticación básica o secreto de registro. Si no se especifica la opción --password, ni --password-from-fileni --password-from-json-file, se le solicitará la contraseña. Este valor es necesario para los secretos basic_auth y registry. Este valor es opcional.

--password-from-file, --spf

La ruta a un archivo que contiene la contraseña para una autenticación básica o un secreto de registro. La primera línea del archivo se utiliza para la contraseña. Si no se especifica la opción --password, ni --password-from-fileni --password-from-json-file, se le solicitará la contraseña. Debe proporcionar la vía de acceso al archivo como un valor. Este valor es necesario para los secretos basic_auth y registry. Este valor es opcional.

--password-from-json-file, --spfj

La ruta a un archivo JSON que contiene la contraseña para una autenticación básica o un secreto de registro. El campo apikey se utiliza para la contraseña. Si no se especifica la opción --password, ni --password-from-fileni --password-from-json-file, se le solicitará la contraseña. Debe proporcionar la vía de acceso al archivo como un valor. Este valor es necesario para los secretos basic_auth y registry. Este valor es opcional.

--private-key-file, --pkf

Especifica un archivo que contenga la clave privada de un secreto de « TLS » que coincida con la cadena de certificados especificada mediante la opción « cert-chain-file ». Debe proporcionar la vía de acceso al archivo como un valor. Este valor es necesario para los secretos de tls. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Esta opción se aplica a los secretos basic_auth, generic, registry, ssh y tls. Este valor es opcional. El valor predeterminado es false.

--secret-access-key, --sak

Especifique la clave de acceso secreta de la credencial de HMAC. Este valor es opcional.

--secret-access-key-prompt

Solicitar la clave de acceso secreta de la credencial de HMAC. Este valor es opcional. El valor predeterminado es false.

--server, -s

La dirección URL del servidor de registro para un secreto de registro. Esta opción es necesaria para los secretos de registry. Este valor es opcional. El valor predeterminado es us.icr.io.

--username, -u

El nombre de usuario para tu autenticación básica o el secreto de registro. Esta opción es necesaria para los secretos basic_auth y registry. Este valor es opcional.

Ejemplo de auth secret básico

Un secreto de autenticación básica contiene una clave username y password y se utiliza cuando se accede a un servicio que requiere autenticación básica HTTP.

Para ver la ayuda de la CLI para crear un auth secret básico, ejecute ibmcloud ce secret create --format basic_auth.

El siguiente ejemplo crea un secreto de autenticación básico llamado mysecret-basicauth. Este secreto contiene el nombre de usuario myusername, y el valor de la contraseña se obtiene de un archivo en la máquina local. Si no se proporciona la contraseña desde un archivo o un archivo JSON, se le pedirá que introduzca el valor de la contraseña.

ibmcloud ce secret create --name mysecret-basicauth --format basic_auth --username myusername --password-from-file ./password.txt

Ejemplo de salida para un secreto de autenticación básico

Creating basic_auth secret 'mysecret-basicauth'...
OK

Ejemplo de secreto genérico

Un secreto genérico almacena pares clave-valor simples y Code Engine no hace suposiciones sobre los pares clave-valor definidos ni sobre el uso previsto del secreto.

Para ver la ayuda de la CLI para crear un secreto genérico, ejecute ibmcloud ce secret create o ibmcloud ce secret create --format generic.

Tenga en cuenta que --format generic es el valor predeterminado cuando se crea un secreto con el comando secret create en la CLI.

El siguiente ejemplo crea un secreto genérico que se denomina mysecret-generic y el valor de este secreto se especifica para un par clave-valor con la opción --from-literal.

ibmcloud ce secret create --name mysecret-generic --format generic --from-literal "TARGET=My literal secret"

Ejemplo de salida para un secreto genérico

Creating generic secret 'mysecret-generic'...
OK

Ejemplo de un secreto genérico con valores procedentes de un archivo

En el siguiente ejemplo se crea un secreto denominado mysecret-fromfile con valores procedentes de un archivo. Al utilizar la opción --from-file para apuntar a un archivo, todo el contenido del archivo se convierte en el valor del par clave-valor.

ibmcloud ce secret create --name mysecret-genericfromfile  --from-file ./value1.txt --from-file ./value2.txt
Ejemplo de resultado de un secreto genérico con valores procedentes de un archivo
Creating secret mysecret-genericfromfile...
OK

Ejemplo de secreto HMAC

Un secreto HMAC contiene una access_key_id y una secret_access_key clave y se utiliza con S3-compatible herramientas y bibliotecas que requieren autenticación pero no soportan IBM Cloud® Identity and Access Management claves API.

Para ver la ayuda de la CLI para crear un secreto HMAC, ejecute ibmcloud ce secret create --format hmac.

El siguiente ejemplo crea un secreto HMAC llamado mysecret-hmac. Este secreto contiene los valores access_key_id y secret_access_key proporcionados cuando se le solicite. Si alguna de las dos opciones no se proporciona con el comando o desde un archivo JSON, se le pedirá que introduzca sus valores.

ibmcloud ce secret create --name mysecret-hmac --format hmac --access-key-id-prompt --secret-access-key-prompt

Ejemplo de salida para un secreto HMAC

Creating hmac_auth secret 'mysecret-hmac'...
OK

Ejemplo de secreto de registro

Un secreto de registro almacena credenciales para acceder al registro de un contenedor.

Para ver la ayuda de la CLI para crear un secreto de registro, ejecute ibmcloud ce secret create --format registry.

En el siguiente ejemplo se crea un secreto de registro denominado mysecret-registry para una instancia de IBM Cloud Container Registry que se encuentra en el servidor de registro us.icr.io y se especifican credenciales para username y password.

ibmcloud ce secret create --name mysecret-registry --format registry --server us.icr.io --username iamapikey --password API_KEY

Ejemplo de salida para un secreto de registro

Creating registry secret `mysecret-registry`...
OK

Ejemplo de secreto SSH

Un secreto SSH almacena credenciales para autenticarse en un servicio con una clave SSH; por ejemplo, autenticarse en un repositorio Git, como GitHub o GitLab.

Para ver la ayuda de la CLI para crear un secreto SSH, ejecute ibmcloud ce secret create --format ssh.

El siguiente ejemplo crea un secreto SSH que se llama mysecret-ssh para un host que está incluido en el archivo known_hosts, y autentica con un archivo de clave privada SSH sin cifrar ubicado en /<filepath>/.ssh/<key_name>, donde <filepath> es la ruta en su sistema. Este comando requiere un nombre y una ruta clave, y también permite otros argumentos opcionales como la ruta al archivo de hosts conocidos.

ibmcloud ce secret create --name mysecret-ssh --format ssh --key-path ~/.ssh/<key_name> --known-hosts-path  ~/.ssh/known_hosts

Ejemplo de salida para un secreto SSH

Creating SSH secret `mysecret-ssh`...
OK

Ejemplo de secreto TLS

Un secreto de seguridad de la capa de transporte ( TLS ) contiene un certificado TLS firmado, incluidos todos sus certificados intermedios, y su correspondiente clave privada de una autoridad de certificación (CA). Utilice TLS secrets cuando trabaje con asignaciones de dominio personalizadas.

Para ver la ayuda de la CLI para crear un secreto TLS, ejecute ibmcloud ce secret create --format tls.

El siguiente ejemplo crea un TLS secreto que se llama mysecret-tls. La cadena de certificados correspondiente al dominio personalizado se encuentra en el archivo certificate.txt y el archivo de claves privadas correspondiente se encuentra en el archivo privatekey.txt. Ambos archivos se encuentran en el directorio raíz de la estación de trabajo local.

ibmcloud ce secret create --name mysecret-tls  --format tls  --cert-chain-file certificate.txt --private-key-file privatekey.txt

Ejemplo de salida para un secreto TLS

Creating TLS secret `mysecret-tls`...
OK

ibmcloud ce secret delete

Suprimir un secreto.

ibmcloud ce secret delete --name SECRET_NAME [--force] [--ignore-not-found] [--quiet]

Opciones de mandato

--name, -n
El nombre del secreto. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce secret delete --name mysecret-genericfromfile -f

Salida de ejemplo

Deleting secret mysecret-genericfromfile...
OK

ibmcloud ce secret get

Mostrar los detalles de un secreto.

ibmcloud ce secret get --name SECRET_NAME [--decode] [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
El nombre del secreto. Este valor es obligatorio.
--decode, -d
Muestra la salida Data como decodificada en los detalles. Si no se especifica esta opción, los detalles de Data se codificarán en base 64. Este valor es opcional. El valor predeterminado es false.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce secret get --name mysecret-basicauth

Salida de ejemplo

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 los secretos de un proyecto.

ibmcloud ce secret list [--all] [--format FORMAT] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--all, -a
Muestra todos los secretos de todos los formatos, incluidos basic_auth, generic, registry, ssh, tls, y other secretos que no son gestionados por Code Engine. Este valor es opcional. El valor predeterminado es false.
--format, --fo
Especifique esta opción para filtrar la visualización de secretos. Los valores válidos son basic_auth, generic, registry, ssh y tls. Este valor es opcional.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

Este comando enumera todos los secretos de un proyecto.

ibmcloud ce secret list

Salida de ejemplo

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

Actualizar un secreto.

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]

Opciones de mandato

--name, -n
El nombre del secreto. Este valor es obligatorio.
--access-key-id, --akid
Especifique el ID de clave de acceso de la credencial de HMAC. Este valor es opcional.
--access-key-id-prompt
Solicitar el ID de clave de acceso de la credencial de HMAC. Este valor es opcional. El valor predeterminado es false.
--cert-chain-file, --ccf
Especifica un archivo que contenga la cadena de certificados facilitada por tu autoridad de certificación para un secreto de « TLS ». Debe proporcionar la vía de acceso al archivo como un valor. Este valor es opcional.
--email, --em
La dirección de correo electrónico para acceder al servidor de registro para un secreto de registro. Este valor es opcional.
--from-env-file, -e
Actualice un secreto genérico a partir de un archivo que contenga una o varias líneas que coincidan con el formato KEY=VALUE. Debe proporcionar la vía de acceso al archivo como un valor. Cada línea del archivo especificado se añade como un par de clave-valor. Las líneas del archivo especificado que están vacías o empiezan por # se ignoran. Este valor es obligatorio si no se especifica --from-literal o --from-file.
--from-file, -f
Actualizar un secreto genérico a partir de un archivo. Debe proporcionar la vía de acceso al archivo como un valor. Este valor es obligatorio si no se especifica --from-literal o --from-env-file.
--from-json-file, --json
La vía de acceso a un archivo que contiene los valores secretos en formato JSON. Esta opción es compatible con el formato secreto hmac Este valor es opcional.
--from-literal, -l
Actualizar un secreto genérico a partir de un par de clave-valor. Debe estar en el formato KEY=VALUE. Este valor es obligatorio si no se especifica --from-file o --from-env-file. Esta opción se puede especificar varias veces.
--key-path, --kp
La ruta a su archivo de clave privada SSH sin cifrar para un secreto SSH. Si utiliza la clave SSH privada personal, este archivo se suele hallar en $HOME/.ssh/id_rsa (Mac OS o Linux) o en %HOMEPATH%\.ssh\id_rsa (Windows). Este valor es opcional.
--known-hosts-path, --khp
La ruta a su archivo de hosts conocidos para un secreto SSH. Este valor es una característica de seguridad para garantizar que la clave privada solo se utiliza para autenticarse en hosts a los que ha accedido anteriormente, específicamente los hosts de GitHub o GitLab. Este archivo se suele hallar en $HOME/.ssh/known_hosts (Mac OS o Linux) o en %HOMEPATH%\.ssh\known_hosts (Windows). Este valor es opcional.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--password, --pw
La contraseña para una autenticación básica o secreto de registro. Si no se especifica la opción --password, ni --password-from-fileni --password-from-json-file, se le solicitará la contraseña. Este valor es opcional.
--password-from-file, --spf
La ruta a un archivo que contiene la contraseña para una autenticación básica o un secreto de registro. La primera línea del archivo se utiliza para la contraseña. Si no se especifica la opción --password, ni --password-from-fileni --password-from-json-file, se le solicitará la contraseña. Debe proporcionar la vía de acceso al archivo como un valor. Este valor es opcional.
--password-from-json-file, --spfj
La ruta a un archivo JSON que contiene la contraseña para una autenticación básica o un secreto de registro. El campo apikey se utiliza para la contraseña. Si no se especifica la opción --password, ni --password-from-fileni --password-from-json-file, se le solicitará la contraseña. Debe proporcionar la vía de acceso al archivo como un valor. Este valor es opcional.
--private-key-file, --pkf
Especifica un archivo que contenga la clave privada de un secreto de « TLS » que coincida con la cadena de certificados especificada mediante la opción « cert-chain-file ». Debe proporcionar la vía de acceso al archivo como un valor. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--rm
Eliminar un par de clave-valor individual de un secreto genérico especificando el nombre de la clave. Esta opción se puede especificar varias veces. Este valor es opcional.
--secret-access-key, --sak
Especifique la clave de acceso secreta de la credencial de HMAC. Este valor es opcional.
--secret-access-key-prompt
Solicitar la clave de acceso secreta de la credencial de HMAC. Este valor es opcional. El valor predeterminado es false.
--server, -s
La dirección URL del servidor de registro para un secreto de registro. Este valor es opcional. El valor predeterminado es us.icr.io.
--username, -u
El nombre de usuario para tu autenticación básica o el secreto de registro. Este valor es opcional.

Ejemplo

Este ejemplo actualiza un secreto de TLS con un certificado y una clave privada actualizados.

ibmcloud ce secret update --name mysecret-tls --cert-chain-file certificate2.txt --private-key-file privatekey2.txt

Salida de ejemplo

Updating secret mysecret-tls..
OK

Mandatos cos de suscripción

En entornos distribuidos, a menudo deseará que las aplicaciones o trabajos reaccionen a los mensajes (sucesos) que se generan en otros componentes, normalmente llamados generadores de sucesos. Con Code Engine, las aplicaciones o los trabajos pueden recibir sucesos de interés suscribiéndose a productores de sucesos. La información de sucesos se recibe como solicitudes POST HTTP para aplicaciones y como variables de entorno para trabajos.

El productor de sucesos de Object Storage genera sucesos a medida que se realizan cambios en los objetos de los grupos de almacenamiento de objetos. Por ejemplo, a medida que se añaden objetos a un grupo, una aplicación puede recibir un suceso y emprender una acción basada en dicho cambio, quizás consumiendo ese nuevo objeto.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos subscription cos.

Para obtener más información sobre cómo trabajar con las suscripciones de IBM Cloud Object Storage, consulte Trabajar con el productor de sucesos de IBM Cloud Object Storage. Consulte Cómo empezar con las suscripciones para obtener más información sobre cómo trabajar con suscripciones en Code Engine.

Puede utilizar subscription o sub en los mandatos de subscription cos. Para ver la ayuda de la CLI para el mandato subscription cos, ejecute ibmcloud ce sub cos -h.

ibmcloud ce subscription cos create

Crear una suscripción de sucesos de 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]

Opciones de mandato

--bucket, -b

El grupo para sucesos. El destino y el grupo deben estar en la misma región del proyecto. Este valor es obligatorio.

--destination, -d

El nombre de la aplicación o el recurso de trabajo que desea que reciba los sucesos, por ejemplo, myapp. Si es necesario, utilice la opción --path para calificar con más detalle el destino de la app. Este valor es obligatorio.

-n, --name

El nombre de la suscripción de sucesos de IBM Cloud Object Storage. Utilice un nombre que sea exclusivo dentro del proyecto.

  • El nombre debe empezar y terminar con un carácter alfanumérico en minúscula.
  • El nombre no puede contener más de 253 y puede contener letras en minúsculas, números, puntos (.) y guiones (-).

Este valor es obligatorio.

--destination-type, --dt
El tipo de destination. Los valores válidos son app y job. Este valor es opcional. El valor predeterminado es app.
--event-type, -e

Los tipos de suceso que se van a supervisar. Los valores válidos son delete, write y all. Este valor es opcional. El valor predeterminado es all.

--extension, --ext

Establecer las extensiones de CloudEvents para enviarlas al destino. Debe estar en el formato NAME=VALUE. Esta acción añade una extensión nueva de CloudEvents o altera temporalmente un atributo existente de CloudEvent. Especifique una extensión por cada opción --extension; por ejemplo, --ext extA=A --ext extB=B. Este valor es opcional.

--force, -f

Forzar la creación de una suscripción de sucesos de IBM Cloud Object Storage. Esta opción omite la validación del destino especificado. Este valor es opcional. El valor predeterminado es false.

--no-wait, --nw

Crear la suscripción de sucesos de IBM Cloud Object Storage y no esperar a que la suscripción esté lista. Si se especifica la opción --no-wait, se inicia la creación de la suscripción y no se espera. Utilice el mandato subscription cos get para comprobar el estado de la suscripción. Este valor es opcional. El valor predeterminado es false.

--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--path

La vía de acceso dentro de la aplicación destination donde se reenvían los sucesos; por ejemplo, /events. La vía de acceso predeterminada es el URL raíz de la aplicación destination. Esta opción solo se puede especificar si destination-type es app. Este valor es opcional.

--prefix, -p

Prefijo del objeto de IBM Cloud Object Storage. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--suffix, -s

Sufijo del objeto de IBM Cloud Object Storage. Tenga en cuenta el tipo de su archivo cuando especifique el sufijo. Este valor es opcional.

--wait, -w

Crear la suscripción de sucesos de IBM Cloud Object Storage y esperar a que la suscripción esté lista. Si se especifica la opción --wait, la creación de la suscripción espera durante un tiempo máximo definido en segundos, tal como establece la opción --wait-timeout, para que la suscripción esté lista. Si la suscripción no está lista dentro del periodo --wait-timeout especificado, la creación de la suscripción de sucesos de IBM Cloud Object Storage falla. Este valor es opcional. El valor predeterminado es true.

--wait-timeout, --wto

El periodo de tiempo, en segundos, que se esperará a que la suscripción de sucesos de IBM Cloud Object Storage esté preparada. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 15.

Ejemplo

La suscripción de IBM Cloud Object Storage escucha si hay cambios en un grupo de Object Storage. En el ejemplo siguiente se crea una suscripción de COS denominada mycosevent para un grupo denominado mybucket que se conecta a una app denominada myapp. La opción --destination-type especifica el tipo de destination que es app o job. Para este ejemplo, --destination-type es app, que es el valor predeterminado para esta opción. El suceso se envía a la vía de acceso de /events utilizando la opción --path para que el suceso se envíe a https://<base application URL>/events.

ibmcloud ce subscription cos create --name mycosevent --destination myapp --bucket mybucket --destination-type app --path /events

Salida de ejemplo

Creating COS source 'mycosevent'...
Run 'ibmcloud ce subscription cos get -n mycosevent' to check the COS source status.
OK

ibmcloud ce subscription cos delete

Suprimir una suscripción de sucesos de 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]

Opciones de mandato

--name, -n
El nombre de la suscripción de sucesos de IBM Cloud Object Storage. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--no-wait, --nw
Suprimir la suscripción de sucesos de IBM Cloud Object Storage y no esperar a que la suscripción se suprima. Si se especifica la opción --no-wait, se inicia la supresión de la suscripción y no se espera. Utilice el mandato subscription cos get para comprobar el estado de la suscripción. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--wait, -w
Suprimir la suscripción de sucesos de IBM Cloud Object Storage y esperar a que la suscripción se suprima. Si se especifica la opción --wait, la supresión de la suscripción espera durante un tiempo máximo definido en segundos, tal como establece la opción --wait-timeout, para que la suscripción se suprima. Este mandato sale cuando se suprime la suscripción o cuando se alcanza --wait-timeout, lo que ocurra primero. Este valor es opcional. El valor predeterminado es true.
--wait-timeout, --wto
El intervalo de tiempo en segundos que se debe esperar a que se suprima la suscripción de sucesos de IBM Cloud Object Storage. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 15.

Ejemplo

ibmcloud ce subscription cos delete --name mycosevent -f

Salida de ejemplo

Deleting COS source 'mycosevent'...
OK

ibmcloud ce subscription cos get

Mostrar los detalles de una suscripción de sucesos de IBM Cloud Object Storage. Los atributos que se muestran incluyen Name, Destination, Bucket, Event Type, Prefix, Suffix, Ready y Age. Para ver detalles específicos, adjunte | grep <attribute>.

ibmcloud ce subscription cos get --name COS_SOURCE_NAME [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
El nombre de la suscripción de sucesos de IBM Cloud Object Storage. Este valor es obligatorio.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce subscription cos get --name mycosevent

Salida de ejemplo

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

Cuando Ready tiene el valor true, la suscripción de COS está lista para desencadenar sucesos por cambios en el grupo de COS.

ibmcloud ce subscription cos list

Mostrar una lista de todas las suscripciones de sucesos de IBM Cloud Object Storage de un proyecto.

ibmcloud ce subscription cos list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce subscription cos list

Salida de ejemplo

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

Actualizar una suscripción de sucesos de 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]

Opciones de mandato

--name, -n
El nombre de la suscripción de sucesos de IBM Cloud Object Storage. Este valor es obligatorio.
--destination, -d
El nombre de la aplicación o el recurso de trabajo que desea que reciba los sucesos, por ejemplo, myapp. Si es necesario, utilice la opción --path para calificar con más detalle el destino de la app. Este valor es opcional.
--destination-type, --dt
El tipo de destination. Los valores válidos son app y job. Este valor es opcional.
--event-type, -e
Los tipos de suceso que se van a supervisar. Los valores válidos son delete, write y all. Este valor es opcional.
--extension, --ext
Establecer las extensiones de CloudEvents para enviarlas al destino. Debe estar en el formato NAME=VALUE. Esta acción añade una extensión nueva de CloudEvents o altera temporalmente un atributo existente de CloudEvent. Especifique una extensión por cada opción --extension; por ejemplo, --ext extA=A --ext extB=B. Este valor es opcional.
--extension-rm, --ext-rm
Elimine las extensiones de CloudEvents para enviarlas al destino especificando el nombre de la clave. Especifique una extensión por cada opción --ext-rm; por ejemplo, --ext-rm extA --ext-rm extB. Este valor es opcional.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--path
La vía de acceso dentro de la aplicación destination donde se reenvían los sucesos; por ejemplo, /events. La vía de acceso predeterminada es el URL raíz de la aplicación destination. Esta opción solo se puede especificar si destination-type es app. Este valor es opcional.
--prefix, -p
Prefijo del objeto de IBM Cloud Object Storage. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--suffix, -s
Sufijo del objeto de IBM Cloud Object Storage. Tenga en cuenta el tipo de su archivo (extensión) cuando especifique el sufijo. Este valor es opcional.

Ejemplo

En el siguiente ejemplo se actualiza una suscripción de COS denominada mycosevent para que solo escuche sucesos de escritura.

ibmcloud ce subscription cos update --name mycosevent --event-type write

Salida de ejemplo

Updating COS source 'mycosevent'...
Run 'ibmcloud ce subscription cos get -n mycosevent' to check the COS source status.
OK

Mandatos cron de suscripción

En entornos distribuidos, a menudo deseará que las aplicaciones o trabajos reaccionen a los mensajes (sucesos) que se generan en otros componentes, normalmente llamados generadores de sucesos. Con Code Engine, las aplicaciones o los trabajos pueden recibir sucesos de interés suscribiéndose a productores de sucesos. La información de sucesos se recibe como solicitudes POST HTTP para aplicaciones y como variables de entorno para trabajos.

El productor de sucesos cron se basa en cron y genera un suceso a intervalos regulares. Utilice un productor de sucesos cron cuando haya que realizar una acción a intervalos bien definidos o en momentos específicos.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos subscription cron.

Para obtener más información sobre cómo trabajar con las suscripciones de IBM Cloud Object Storage, consulte Trabajar con el productor de sucesos de temporizador periódico (cron). Consulte Cómo empezar con las suscripciones para obtener más información sobre cómo trabajar con suscripciones en Code Engine.

Puede utilizar subscription o sub en los mandatos de subscription cron. Para ver la ayuda de la CLI para el mandato subscription cron, ejecute ibmcloud ce sub cron -h.

ibmcloud ce subscription cron create

Cree una suscripción de sucesos de 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]

Opciones de mandato

--destination, -d

El nombre de la aplicación o el recurso de trabajo que desea que reciba los sucesos, por ejemplo, myapp. Si es necesario, utilice la opción --path para calificar con más detalle el destino de la app. Este valor es obligatorio.

-n, --name

El nombre de la suscripción de sucesos de cron. Utilice un nombre que sea exclusivo dentro del proyecto.

  • El nombre debe empezar y terminar con un carácter alfanumérico en minúscula.
  • El nombre no puede contener más de 253 y puede contener letras en minúsculas, números, puntos (.) y guiones (-).

Este valor es obligatorio.

--content-type, --ct
El tipo de soporte de la opción --data o --data-base64. Los ejemplos incluyen application/json, application/x-www-form-urlencoded, text/html y text/plain. Este valor es opcional.
--da, --data

Los datos que se envían al destino; por ejemplo, '{ "message": "Hello world!" }'. Si especifica la opción --data, no utilice la opción --data-base64.

Este valor es opcional.

--data-base64, --db
Los datos codificados en base64 para enviarlos al destino; por ejemplo, Q29kZSBFbmdpbmU=. Si especifica la opción --data-base64, no utilice la opción --data. Este valor es opcional.
--destination-type, --dt

El tipo de destination. Los valores válidos son app, function y job. Este valor es opcional. El valor predeterminado es app.

--extension, --ext

Establecer las extensiones de CloudEvents para enviarlas al destino. Debe estar en el formato NAME=VALUE. Esta acción añade una extensión nueva de CloudEvents o altera temporalmente un atributo existente de CloudEvent. Especifique una extensión por cada opción --extension; por ejemplo, --ext extA=A --ext extB=B. Este valor es opcional.

--force, -f

Forzar creación de una suscripción de sucesos de cron. Esta opción omite la validación del destino especificado. Este valor es opcional. El valor predeterminado es false.

--no-wait, --nw

Cree la suscripción de sucesos de cron y no espere a que la suscripción esté lista. Si se especifica la opción --no-wait, se inicia la creación de la suscripción y no se espera. Utilice el mandato subscription cron get para comprobar el estado de la suscripción. Este valor es opcional. El valor predeterminado es false.

--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--path

La vía de acceso dentro de la aplicación destination donde se reenvían los sucesos; por ejemplo, /events. La vía de acceso predeterminada es el URL raíz de la aplicación destination. Esta opción solo se puede especificar si destination-type es app. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--schedule, -s

Planificar la frecuencia con la que se desencadena el suceso, en formato crontab. Por ejemplo, especifique '*/2 * * * *' (en formato de serie) para que se desencadene cada dos minutos. De forma predeterminada, el suceso de cron se desencadena cada minuto y se establece en el huso horario de UTC . Para modificar el huso horario, utilice la opción --time-zone. Este valor es opcional.

--time-zone, --tz

Establezca el huso horario para el suceso de cron; por ejemplo, Asia/Tokyo. Si especifica la opción --schedule, utilice esta opción para especificar el huso horario. Para ver los valores de huso horario válidos, consulte la base de datos de husos horarios. Este valor es opcional. El valor predeterminado es UTC.

--wait, -w

Cree la suscripción de sucesos de cron y espere a que la suscripción esté lista. Si se especifica la opción --wait, la creación de la suscripción espera durante un tiempo máximo definido en segundos, tal como establece la opción --wait-timeout, para que la suscripción esté lista. Si la suscripción no está lista dentro del periodo --wait-timeout especificado, la creación de la suscripción de sucesos de cron falla. Este valor es opcional. El valor predeterminado es true.

--wait-timeout, --wto

El periodo de tiempo, en segundos, que se esperará a que la suscripción de sucesos de cron esté preparada. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 15.

Ejemplo

En el ejemplo siguiente se crea una suscripción de cron llamada mycronevent que reenvía un suceso de cron a un trabajo llamado myjob cada 2 minutos.

ibmcloud ce subscription cron create --name mycronevent --destination myjob --schedule '*/2 * * * *' --destination-type job

Salida de ejemplo

Creating cron source 'mycronevent'...
Run 'ibmcloud ce subscription cron get -n mycronevent' to check the cron source status.
OK

ibmcloud ce subscription cron delete

Suprima una suscripción de sucesos de cron.

ibmcloud ce subscription cron delete --name CRON_SOURCE_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

--name, -n
El nombre de la suscripción de sucesos de cron. Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--no-wait, --nw
Suprima la suscripción de sucesos de cron y no espere a que se suprima la suscripción. Si se especifica la opción --no-wait, se inicia la supresión de la suscripción y no se espera. Utilice el mandato subscription cron get para comprobar el estado de la suscripción. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--wait, -w
Suprima la suscripción de sucesos de cron y espere a que se suprima la suscripción. Si se especifica la opción --wait, la supresión de la suscripción espera durante un tiempo máximo definido en segundos, tal como establece la opción --wait-timeout, para que la suscripción se suprima. Este mandato sale cuando se suprime la suscripción o cuando se alcanza --wait-timeout, lo que ocurra primero. Este valor es opcional. El valor predeterminado es true.
--wait-timeout, --wto
El periodo de tiempo, en segundos, que se esperará a que se suprima la suscripción de sucesos de cron. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 15.

Ejemplo

ibmcloud ce subscription cron delete --name mycronevent -f

Salida de ejemplo

Deleting cron source 'mycronevent'...
OK

ibmcloud ce subscription cron get

Mostrar detalles de una suscripción de sucesos de cron.

ibmcloud ce subscription cron get --name CRON_SOURCE_NAME [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
El nombre de la suscripción de sucesos de cron. Este valor es obligatorio.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce subscription cron get --name mycronevent

Salida de ejemplo

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

Cuando Ready es true, la suscripción de cron está lista para desencadenar sucesos según la planificación especificada.

ibmcloud ce subscription cron list

Listar todas las suscripciones de sucesos de cron de un proyecto.

ibmcloud ce subscription cron list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce subscription cron list

Salida de ejemplo

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

Actualizar una suscripción de sucesos de 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]

Opciones de mandato

--name, -n

El nombre de la suscripción de sucesos de cron. Este valor es obligatorio.

--content-type, --ct

El tipo de soporte de la opción --data o --data-base64. Los ejemplos incluyen application/json, application/x-www-form-urlencoded, text/html y text/plain. Este valor es opcional.

--da, --data

Los datos que se envían al destino; por ejemplo, '{ "message": "Hello world!" }'. Si especifica la opción --data, no utilice la opción --data-base64.

Este valor es opcional.

--data-base64, --db
Los datos codificados en base64 para enviarlos al destino; por ejemplo, Q29kZSBFbmdpbmU=. Si especifica la opción --data-base64, no utilice la opción --data. Este valor es opcional.
--destination, -d

El nombre de la aplicación o el recurso de trabajo que desea que reciba los sucesos, por ejemplo, myapp. Si es necesario, utilice la opción --path para calificar con más detalle el destino de la app. Este valor es opcional.

--destination-type, --dt

El tipo de destination. Los valores válidos son app, function y job. Este valor es opcional.

--extension, --ext

Establecer las extensiones de CloudEvents para enviarlas al destino. Debe estar en el formato NAME=VALUE. Esta acción añade una extensión nueva de CloudEvents o altera temporalmente un atributo existente de CloudEvent. Especifique una extensión por cada opción --extension; por ejemplo, --ext extA=A --ext extB=B. Este valor es opcional.

--extension-rm, --ext-rm

Elimine las extensiones de CloudEvents para enviarlas al destino especificando el nombre de la clave. Especifique una extensión por cada opción --ext-rm; por ejemplo, --ext-rm extA --ext-rm extB. Este valor es opcional.

--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--path

La vía de acceso dentro de la aplicación destination donde se reenvían los sucesos; por ejemplo, /events. La vía de acceso predeterminada es el URL raíz de la aplicación destination. Esta opción solo se puede especificar si destination-type es app. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--schedule, -s

Planificar la frecuencia con la que se desencadena el suceso, en formato crontab. Por ejemplo, especifique '*/2 * * * *' (en formato de serie) para que se desencadene cada dos minutos. De forma predeterminada, el suceso de cron se desencadena cada minuto y se establece en el huso horario de UTC . Para modificar el huso horario, utilice la opción --time-zone. Este valor es opcional.

--time-zone, --tz

Establezca el huso horario para el suceso de cron; por ejemplo, Asia/Tokyo. Si especifica la opción --schedule, utilice esta opción para especificar el huso horario. Para ver los valores de huso horario válidos, consulte la base de datos de husos horarios. Este valor es opcional.

Ejemplo

En el ejemplo siguiente se actualiza una suscripción de origen de cron llamada mycronevent que reenvía un suceso de cron a un trabajo llamado myjob cada hora.

ibmcloud ce subscription cron update --name mycronevent --destination myjob --schedule '0 * * * *' --destination-type job

Salida de ejemplo

Updating cron source 'mycronevent'...
Run 'ibmcloud ce subscription cron get -n mycronevent' to check the cron source status.
OK

Suscripción kafka comandos

En entornos distribuidos, a menudo deseará que las aplicaciones o trabajos reaccionen a los mensajes (sucesos) que se generan en otros componentes, normalmente llamados generadores de sucesos. Con Code Engine, las aplicaciones o los trabajos pueden recibir sucesos de interés suscribiéndose a productores de sucesos. La información de sucesos se recibe como solicitudes POST HTTP para aplicaciones y como variables de entorno para trabajos.

El productor de eventos Kafka está atento a la aparición de nuevos mensajes en una instancia de Kafka. Al crear una suscripción a Code Engine Kafka para un conjunto de temas, tu aplicación o trabajo recibe un evento independiente por cada nuevo mensaje que aparece en uno de los temas.

Debe estar dentro del contexto de un proyecto antes de utilizar los mandatos subscription kafka.

Para obtener más información sobre cómo trabajar con las suscripciones a eventos de Kafka, consulte Trabajar con el productor de eventos de Kafka. Consulte Cómo empezar con las suscripciones para obtener más información sobre cómo trabajar con suscripciones en Code Engine.

Puede utilizar subscription o sub en los mandatos de subscription kafka. Para consultar la ayuda de la CLI sobre los comandos de « subscription », ejecuta « ibmcloud ce sub kafka -h ».

ibmcloud ce subscription kafka create

Crea una suscripción al evento « Kafka ».

ibmcloud ce subscription kafka create --name KAFKA_SOURCE_NAME --destination DESTINATION_REF --topic TOPIC --broker BROKER [--consumer-group CONSUMER_GROUP] [--destination-type DESTINATION_TYPE] [--extension EXTENSION] [--force] [--no-wait] [--output OUTPUT] [--password PASSWORD] [--path PATH] [--quiet] [--secret SECRET] [--username USERNAME] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

--broker, -b

Establezca un corredor en la fuente Kafka. Un broker es un servidor Kafka al que se conecta el consumidor. Esta opción se puede especificar varias veces. Este valor es obligatorio.

--destination, -d

El nombre de la aplicación o el recurso de trabajo que desea que reciba los sucesos, por ejemplo, myapp. Si es necesario, utilice la opción --path para calificar con más detalle el destino de la app. Este valor es obligatorio.

-n, --name

El nombre de la suscripción al evento « Kafka ». Utilice un nombre que sea exclusivo dentro del proyecto.

  • El nombre debe empezar y terminar con un carácter alfanumérico en minúscula.
  • El nombre no puede contener más de 253 y puede contener letras en minúsculas, números, puntos (.) y guiones (-).

Este valor es obligatorio.

--topic, -t
Establezca un tema en la fuente Kafka. Los temas se utilizan para filtrar los mensajes a consumir. Esta opción se puede especificar varias veces. Este valor es obligatorio.
--consumer-group, --cg

El nombre del grupo de consumidores para eventos. Este valor es opcional.

--destination-type, --dt

El tipo de destination. Los valores válidos son app y job. Este valor es opcional. El valor predeterminado es app.

--extension, --ext

Establecer las extensiones de CloudEvents para enviarlas al destino. Debe estar en el formato NAME=VALUE. Esta acción añade una extensión nueva de CloudEvents o altera temporalmente un atributo existente de CloudEvent. Especifique una extensión por cada opción --extension; por ejemplo, --ext extA=A --ext extB=B. Este valor es opcional.

--force, -f

Forzar la creación de una suscripción al evento « Kafka ». Esta opción omite la validación del destino y el secreto especificados. Este valor es opcional. El valor predeterminado es false.

--no-wait, --nw

Crea la suscripción al evento « Kafka » y no esperes a que la suscripción esté lista. Si se especifica la opción --no-wait, se inicia la creación de la suscripción y no se espera. Utilice el mandato subscription kafka get para comprobar el estado de la suscripción. Este valor es opcional. El valor predeterminado es false.

--output, -o

Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.

--password, -p

La contraseña que se utiliza para autenticarse en la instancia de Kafka. Si se especifica la opción « --password », no se debe especificar la opción « --secret ». Este valor es opcional.

--path

La vía de acceso dentro de la aplicación destination donde se reenvían los sucesos; por ejemplo, /events. La vía de acceso predeterminada es el URL raíz de la aplicación destination. Esta opción solo se puede especificar si destination-type es app. Este valor es opcional.

--quiet, -q

Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

--secret, -s

El nombre del secreto que se utiliza para autenticarse en la instancia de Kafka y que incluye tanto la clave « username » como la clave « password ». Si se especifica la opción « --secret », no se deben especificar las opciones « --username » ni « --password ». Este valor es opcional.

--username, -u

El nombre de usuario que se utiliza para autenticarse en la instancia de Kafka. Si se especifica la opción « --username », es necesario especificar también la opción « --password » y no se debe especificar la opción « --secret ». Este valor es opcional. El valor predeterminado es token.

--wait, -w

Crea la suscripción al evento « Kafka » y espera a que la suscripción esté lista. Si se especifica la opción --wait, la creación de la suscripción espera durante un tiempo máximo definido en segundos, tal como establece la opción --wait-timeout, para que la suscripción esté lista. Si la suscripción no está lista dentro del plazo especificado en --wait-timeout, la creación de la suscripción al evento Kafka fallará. Este valor es opcional. El valor predeterminado es true.

--wait-timeout, --wto

El tiempo, en segundos, que hay que esperar a que la suscripción al evento « Kafka » esté lista. Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 120.

Ejemplo

El siguiente ejemplo crea una suscripción a eventos Kafka que se denomina mykafkaevent y que reenvía un evento Kafka a una aplicación receptora que se denomina kafka-receiver-app. Especifique una opción --broker para cada corredor de su tema. La opción --destination especifica el recurso Code Engine que recibe los eventos. La dirección kafka-subscription-secret proporciona credenciales para acceder al agente de mensajes.

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

Salida de ejemplo

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

Eliminar una suscripción a un evento de « Kafka ».

ibmcloud ce subscription kafka delete --name KAFKA_SOURCE_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Opciones de mandato

--name, -n
El nombre de la suscripción al evento « Kafka ». Este valor es obligatorio.
--force, -f
Forzar la supresión sin confirmación. Este valor es opcional. El valor predeterminado es false.
--ignore-not-found, --inf
Si no se encuentra, no da error. Este valor es opcional. El valor predeterminado es false.
--no-wait, --nw
Elimina la suscripción al evento « Kafka » y no esperes a que se elimine la suscripción. Si se especifica la opción --no-wait, se inicia la supresión de la suscripción y no se espera. Utilice el mandato subscription kafka get para comprobar el estado de la suscripción. Este valor es opcional. El valor predeterminado es false.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--wait, -w
Elimina la suscripción al evento « Kafka » y espera a que se elimine la suscripción. Si se especifica la opción --wait, la supresión de la suscripción espera durante un tiempo máximo definido en segundos, tal como establece la opción --wait-timeout, para que la suscripción se suprima. Este mandato sale cuando se suprime la suscripción o cuando se alcanza --wait-timeout, lo que ocurra primero. Este valor es opcional. El valor predeterminado es true.
--wait-timeout, --wto
El tiempo, en segundos, que hay que esperar a que se elimine la suscripción al evento « Kafka ». Este valor es necesario si se ha especificado la opción --wait. Este valor se ignora si se ha especificado la opción --no-wait. El valor predeterminado es 15.

Ejemplo

ibmcloud ce subscription kafka delete --name mykafkasubscription -f

Salida de ejemplo

Deleting Kafka event subscription 'mykafkasubscription'...
OK

ibmcloud ce subscription kafka get

Mostrar los detalles de una suscripción a eventos de « Kafka ».

ibmcloud ce subscription kafka get --name KAFKA_SOURCE_NAME [--output OUTPUT] [--quiet]

Opciones de mandato

--name, -n
El nombre de la suscripción al evento « Kafka ». Este valor es obligatorio.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce subscription kafka get --name mykafkasubscription

Salida de ejemplo

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

Cuando Ready es true, la suscripción Kafka está lista para activar eventos según la programación especificada.

ibmcloud ce subscription kafka list

Mostrar todas las suscripciones a eventos de « Kafka » de un proyecto.

ibmcloud ce subscription kafka list [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Opciones de mandato

--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--sort-by, -s
Especifica la columna por la que se debe ordenar la lista. Los valores válidos son name y age. Este valor es opcional. El valor predeterminado es name.

Ejemplo

ibmcloud ce subscription kafka list

Salida de ejemplo

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

Actualizar una suscripción a un evento de « Kafka ».

ibmcloud ce subscription kafka update --name KAFKA_SOURCE_NAME [--broker BROKER] [--destination DESTINATION] [--destination-type DESTINATION_TYPE] [--extension EXTENSION] [--extension-rm EXTENSION_RM] [--output OUTPUT] [--password PASSWORD] [--path PATH] [--quiet] [--secret SECRET] [--topic TOPIC] [--username USERNAME]

Opciones de mandato

--name, -n
El nombre de la suscripción al evento « Kafka ». Este valor es obligatorio.
--broker, -b
Establezca un corredor en la fuente Kafka. Un broker es un servidor Kafka al que se conecta el consumidor. Esta opción se puede especificar varias veces. Este valor es opcional.
--destination, -d
El nombre de la aplicación o el recurso de trabajo que desea que reciba los sucesos, por ejemplo, myapp. Si es necesario, utilice la opción --path para calificar con más detalle el destino de la app. Este valor es opcional.
--destination-type, --dt
El tipo de destination. Los valores válidos son app y job. Este valor es opcional.
--extension, --ext
Establecer las extensiones de CloudEvents para enviarlas al destino. Debe estar en el formato NAME=VALUE. Esta acción añade una extensión nueva de CloudEvents o altera temporalmente un atributo existente de CloudEvent. Especifique una extensión por cada opción --extension; por ejemplo, --ext extA=A --ext extB=B. Este valor es opcional.
--extension-rm, --ext-rm
Elimine las extensiones de CloudEvents para enviarlas al destino especificando el nombre de la clave. Especifique una extensión por cada opción --ext-rm; por ejemplo, --ext-rm extA --ext-rm extB. Este valor es opcional.
--output, -o
Especifica el formato de la salida del mandato. Los valores válidos son json, yaml, jsonpath=JSONPATH_EXPRESSION y jsonpath-as-json=JSONPATH_EXPRESSION. Utilice jsonpath para especificar la vía de acceso a un elemento de la salida JSON. Este valor es opcional.
--password, -p
La contraseña que se utiliza para autenticarse en la instancia de Kafka. Si se especifica la opción « --password », no se debe especificar la opción « --secret ». Este valor es opcional.
--path
La vía de acceso dentro de la aplicación destination donde se reenvían los sucesos; por ejemplo, /events. La vía de acceso predeterminada es el URL raíz de la aplicación destination. Esta opción solo se puede especificar si destination-type es app. Este valor es opcional.
--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.
--secret, -s
El nombre del secreto que se utiliza para autenticarse en la instancia de Kafka y que incluye tanto la clave « username » como la clave « password ». Si se especifica la opción « --secret », no se deben especificar las opciones « --username » ni « --password ». Este valor es opcional.
--topic, -t
Establezca un tema en la fuente Kafka. Los temas se utilizan para filtrar los mensajes a consumir. Esta opción se puede especificar varias veces. Este valor es opcional.
--username, -u
El nombre de usuario que se utiliza para autenticarse en la instancia de Kafka. Si se especifica la opción « --username », es necesario especificar también la opción « --password » y no se debe especificar la opción « --secret ». Este valor es opcional. El valor predeterminado es token.

Ejemplo

El siguiente ejemplo actualiza una suscripción a eventos de Kafka para que utilice kafka-topic2 en lugar de kafka-topic1.

ibmcloud ce subscription kafka update --name mykafkasubscription --topic kafka-topic2

Salida de ejemplo

Updating Kafka event subscription 'mykafkasubscription'...
Run 'ibmcloud ce subscription kafka get -n mykafkasubscription' to check the Kafka event subscription status.
OK

Mandato version

Mostrar la versión de la interfaz de línea de mandatos de code-engine.

ibmcloud ce version

Mostrar la versión de la interfaz de línea de mandatos de code-engine.

ibmcloud ce version [--quiet]

Opciones de mandato

--quiet, -q
Especifique esta opción para reducir la salida del mandato. Este valor es opcional. El valor predeterminado es false.

Ejemplo

ibmcloud ce version

Salida de ejemplo

version:  v1.17.0
commit:   3ab130b746f4784c9ff8d3da7bb05b6e7acda6d5