interface de ligne de commandeIBM Cloud Code Engine

Exécutez les commandes ci-après pour gérer les entités qui composent IBM Cloud® Code Engine. Pour plus d'informations sur Code Engine, voir Initiation à Code Engine.

Pour exécuter des commandes IBM Cloud Code Engine, utilisez ibmcloud code-engine ou ibmcloud ce.

Prérequis

  • Installez l'interface de ligne de commande IBM Cloud.

  • Installez l'interface de ligne de commande Code Engine en exécutant la commande suivante :

    ibmcloud plugin install code-engine
    

Commandes application

Une application exécute votre code pour servir les demandes HTTP. Outre les demandes HTTP traditionnelles, IBM Cloud® Code Engine prend en charge les applications qui utilisent WebSockets comme protocole de communication. Le nombre d'instances actives d'une application est automatiquement augmenté ou réduit (jusqu'à zéro) en fonction des requêtes entrantes et de vos paramètres de configuration. Une application contient une ou plusieurs révisions. Une révision représente une version non modifiable des propriétés de configuration de l'application. Chaque mise à jour d'une propriété de configuration d'application crée une nouvelle révision de l'application.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes application.

Pour plus d'informations sur l'utilisation des applications, reportez-vous à la rubrique décrivant le déploiement d'applications.

Vous pouvez utiliser soit applicationouapp dans vos commandesapplication. Pour afficher l'aide de l'interface de ligne de commande relative aux commandes application, exécutez la commande ibmcloud ce app -h.

Pour gérer les révisions d'application, voir les commandes ibmcloud ce revision.

ibmcloud ce application bind

Permet de lier une instance de service IBM Cloud à une application.

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]

Options de commande

--name, -n
Nom de l'application à lier. Cette valeur est obligatoire.
--no-wait, --nw
Lie l'instance de service sans attendre que la liaison de service soit prête. Si vous spécifiez l'option no-wait, la création de liaison de service démarre et la commande prend fin sans attendre la fin de l'exécution. Utilisez la commande app getpour vérifier le statut de la liaison d'application. Cette valeur est facultative. La valeur par défaut est false.
--prefix, -p
Préfixe des variables d'environnement qui sont créées pour cette liaison de service. Ne doit contenir que des lettres en majuscules, des chiffres et des traits de soulignement (_) et ne peut pas débuter par un chiffre. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--role, -r
Nom d'un rôle de service pour les nouvelles données d'identification de service créées pour cette liaison de service. Les valeurs valides sont Reader, Writer, Manager ou un rôle propre au service. L'option prend par défaut la valeur Manager ou le premier rôle fourni par le service si Manager n'est pas pris en charge. Cette option est ignorée si --service-credential est spécifié. Cette valeur est facultative.
--service-credential, --sc
Nom d'une donnée d'identification de service existante qui doit être utilisée pour cette liaison de service. Si vous ne spécifiez pas de donnée d'identification d'instance de service, de nouvelles données d'identification sont générées lors de l'action de liaison. Cette valeur est facultative.
--service-instance, --si
Nom d'une instance de service IBM Cloud existante qui doit être liée à l'application. Cette valeur est facultative.
--service-instance-id, --siid
L'identificateur global unique d'une instance de service IBM Cloud existante à lier à l'application. Cette valeur est facultative.
--wait, -w
Permet de lier l'instance de service et d'attendre que la liaison de service soit prête. Si vous spécifiez l'option--wait, la liaison d'application attend une durée maximale en secondes, définie par l'option--wait-timeout, pour que la liaison d'application se termine correctement. Si la liaison d'application ne se termine pas correctement ou échoue dans le délai --wait-timeout spécifié, la commande échoue. Cette valeur est facultative. La valeur par défaut est true.
--wait-timeout, --wto
Délai d'attente en secondes avant que la liaison de service soit prête. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 300.

Exemple

Dans cet exemple, associez votre instance du service « IBM Cloud Object Storage » nommée « my-object-storage » à votre application nommée « myapp ».

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

Exemple de sortie

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

Permet de créer une application.

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]

Options de commande

-n, --name

Nom de l'application. Utilisez un nom unique dans le projet.

  • Le nom doit débuter par une lettre en minuscule.
  • Le nom doit se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 63 caractères au maximum et peut contenir des lettres minuscules, des chiffres et des tirets (-).

Cette valeur est obligatoire.

--argument, --arg, -a
Permet de définir des arguments pour l'application. Spécifiez un argument par option --argument ; par exemple, -a argA -a argB. Cette valeur remplace les valeurs par défaut qui sont spécifiées dans l'image de conteneur. Cette valeur est facultative.
--build-commit, --commit, --bcm, --cm, --revision

Validation, balise ou branche du référentiel source à extraire. L'option build commit n'est autorisée que si l'option --build-source est activée. Cette valeur est facultative.

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

Répertoire inclus dans le référentiel qui contient le fichier de packs de construction ou le fichier Dockerfile. L'option de répertoire de contexte de construction n'est autorisée que si l'option --build-source est activée. Cette valeur est facultative.

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

Chemin d'accès au Dockerfile. Spécifiez cette option uniquement si le nom est différent de Dockerfile. L'option build dockerfile n'est autorisée que si l'option --build-source est définie. Cette valeur est facultative. La valeur par défaut est Dockerfile.

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

Nom du secret SSH, qui contient les identifiants permettant d'accéder au référentiel privé contenant le code source pour la génération de votre image de conteneur. Pour créer ce secret SSH, utilisez la commande secret create --format SSH. Un secret SSH est également utilisé comme secret d'accès au référentiel Git. Cette option n'est autorisée que si l'option --build-source est définie sur URL d'un référentiel Git. Cette valeur est facultative.

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

Taille de la génération, qui détermine la quantité de ressources utilisée. Les valeurs valides sont : small, medium, large, xlarge et xxlarge. Pour plus de détails, voir Définition de la taille de la génération. L'option "build size" n'est autorisée que si l'option " --build-source " est activée. Cette valeur est facultative. La valeur par défaut est medium.

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

L'URL du référentiel Git ou le chemin d'accès à la source locale qui contient votre code source ; par exemple, https://github.com/IBM/CodeEngine ou.. Cette valeur est facultative.

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

Stratégie à utiliser pour générer l'image. Les valeurs valides sont dockerfile et buildpacks. L'option de stratégie de construction n'est autorisée que si l'option --build-source est activée. Si aucune valeur n'est indiquée, la stratégie de compilation est déterminée par Code Engine si --build-source est spécifié et que la source se trouve sur votre ordinateur local. Cette valeur est facultative. La valeur par défaut est dockerfile.

--build-timeout, --bto

Délai en secondes avant la réussite ou l'échec de la génération. L'option build timeout n'est autorisée que si l'option --build-source est activée. Cette valeur est facultative. La valeur par défaut est 600.

--cluster-local, --cl

Déployez l'application avec un nœud final de type projet-uniquement. La définition d'un nœud final de projet uniquement signifie que votre application n'est pas accessible à partir de l'accès public à Internet et que l'accès au réseau est possible uniquement à partir d'autres composants Code Engine qui s'exécutent dans le même projet. Cette valeur est facultative. La valeur par défaut est false.

--command, --cmd, -c

Permet de définir des commandes pour l'application. Spécifiez une commande par option --command ; par exemple, --cmd cmdA --cmd cmdB. Cette valeur remplace la commande par défaut qui est spécifiée dans l'image de conteneur. Cette valeur est facultative.

--concurrency, --cn

Nombre maximal de demandes pouvant être traitées simultanément par instance. Cette valeur est facultative. La valeur par défaut est 100.

--concurrency-target, --ct

Seuil de demandes simultanées par instance auquel une ou plusieurs instances supplémentaires sont créées. Utilisez cette valeur pour augmenter le nombre d'instances en fonction du nombre simultané de demandes. Si --concurrency-target n'est pas spécifié, cette option prend par défaut la valeur de l'option --concurrency. Cette valeur est facultative. La valeur par défaut est 0.

--cpu

Quantité d'UC définie pour l'instance de l'application. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative. La valeur par défaut est 1.

--env, -e

Permet de définir des variables d'environnement dans l'application. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle variable d'environnement ou de remplacer une variable d'environnement existante. Spécifiez une variable d'environnement par option --env ; par exemple, --env envA=A --env envB=B. Cette valeur est facultative.

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

Définissez les variables d'environnement à partir des paires clé-valeur qui sont stockées dans cette mappe de configuration en utilisant l'une des méthodes suivantes :

  • Afin d'ajouter des variables d'environnement pour toutes les clés d'une mappe de configuration nommée configmapName, utilisez la valeur configmapName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement de la mappe de configuration. Pour spécifier un préfixe, utilisez la valeurPREFIX=CONFIGMAP_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans la mappe de configurationconfigmapName enCUSTOM_, utilisez la valeurCUSTOM_=configmapName. Si la mappe de configuration configmapName contient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, afin d'ajouter une variable d'environnement pour une clé key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:myKey=key1.

Cette valeur est facultative.

--env-sec, --env-from-secret
Définissez les variables d'environnement à partir des paires clé-valeur stockées dans un secret en utilisant l'une des méthodes suivantes :
  • Afin d'ajouter des variables d'environnement pour toutes les clés d'un secret nommé secretName, utilisez la valeur secretName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement du secret. Pour spécifier un préfixe, utilisez la valeurPREFIX=SECRET_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_SECRET>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans le secretsecretName vers CUSTOM_, utilisez la valeurCUSTOM_=secretName. Si le secret secretNamecontient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, pour ajouter une variable d'environnement pour une clé uniquekey1 dans un secret nommésecretName, utilisez la valeursecretName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans un secret nommé secretName, utilisez la valeur secretName:myKey=key1.

Cette valeur est facultative.

--ephemeral-storage, --es
Quantité de stockage éphémère à définir pour l'instance de l'application. Utilisez M pour mégaoctets ou G pour gigaoctets. Cette valeur est facultative. La valeur par défaut est 400M.
--force, -f

Ne pas vérifier l'existence des références de mappe de configuration et de secret spécifiées. Les références de mappe de configuration sont spécifiées avec les options --env-from-configmap ou --mount-configmap. Les références de secret sont spécifiées avec l'option --env-from-secret, --mount-secret ou --registry-secret. Cette valeur est facultative. La valeur par défaut est false.

--image, -i

Nom de l'image utilisée pour cette application. Le format est REGISTRY/NAMESPACE/REPOSITORY:TAG, où REGISTRY et TAG sont facultatifs. Si REGISTRY n'est pas spécifié, la valeur par défaut est docker.io. Si TAG n'est pas spécifié, la valeur par défaut est latest. L'option d'image est obligatoire si l'option --build-sourcen'est pas spécifiée. Cette valeur est facultative.

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

Nombre maximal d'instances pouvant être utilisées pour cette application. Si vous définissez cette valeur sur 0, les mises à l'échelle d'application sont nécessaires. La mise à l'échelle de l'application est limitée uniquement par les instances par le quota de ressources alloué pour le projet de votre application. Voir Limites et quotas pour Code Engine. Cette valeur est facultative. La valeur par défaut est 10.

--memory, -m

Quantité de mémoire définie pour l'instance de l'application. Utilisez M pour mégaoctets ou G pour gigaoctets. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative. La valeur par défaut est 4G.

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

Nombre minimal d'instances pouvant être utilisées pour cette application. Cette option permet de s'assurer qu'aucune instance n'est en cours d'exécution lorsque cela n'est pas nécessaire. Cette valeur est facultative. La valeur par défaut est 0.

--mount-configmap, --mount-cm

Ajoute le contenu d'une mappe de configuration au système de fichiers de votre conteneur d'applications en fournissant un répertoire de montage et le nom d'une mappe de configuration, avec le format MOUNT_DIRECTORY=CONFIGMAP_NAME. Chaque mappe de configuration montée doit utiliser un répertoire de montage unique. Pour chaque paire clé-valeur de la mappe de configuration, un fichier est ajouté au répertoire de montage spécifié, où le nom de fichier est la clé et le contenu du fichier, la valeur de la paire clé-valeur. Spécifiez une configuration de montage par option --mount-configmap, --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b, par exemple. Cette valeur est facultative.

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

Montage d'un stockage de persistance des données. Le format est le suivant : MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. SUBPATH est facultatif. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.

--mount-secret, --mount-sec

Ajoute le contenu d'un secret au système de fichiers de votre conteneur d'applications en fournissant un répertoire de montage et le nom d'un secret, avec le format MOUNT_DIRECTORY=SECRET_NAME. Chaque secret monté doit utiliser un répertoire de montage unique. Pour chaque paire clé-valeur du secret, un fichier est ajouté au répertoire de montage spécifié, où le nom de fichier est la clé et le contenu du fichier, la valeur de la paire clé-valeur. Spécifiez une configuration de montage par option --mount-secret, --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b, par exemple. Cette valeur est facultative.

--no-cluster-local, --ncl

Déployer l'application avec un noeud final public. L'application se déploie de telle sorte qu'elle puisse recevoir des demandes provenant de l'Internet public ou des composants du projet Code Engine. Cette valeur est facultative. La valeur par défaut est true.

--no-wait, --nw

Crée l'application et n'attend pas que l'application soit prête. Si vous spécifiez l'option --no-wait, la création de l'application démarre sans attendre. Utilisez la commande app get pour vérifier le statut de l'application. Cette valeur est facultative. La valeur par défaut est false.

--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSION, jsonpath-as-json=JSONPATH_EXPRESSION, urlet project-url. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--port, -p

Port sur lequel l'application est en mode écoute. Le format est [NAME:]PORT, où [NAME:] est facultatif. Si [NAME:] est spécifié, les valeurs valides sont h2c ou http1. Lorsque [NAME:] n'est pas spécifié ou a pour valeur http1, le port utilise HTTP/1.1. Lorsque [NAME:] a pour valeur h2c, il utilise HTTP/2 en mode non chiffré. Par défaut, Code Engine part de l'hypothèse que les applications écoutent les connexions entrantes sur le port 8080. Si votre application doit écouter un port autre que le port 8080, utilisez --port pour spécifier ce port. Cette valeur est facultative.

--probe-live, --pl

Configurez la sonde d'activité pour cette application au format NAME=VALUE. Les options valables pour NAME sont : type, port, path, interval, initial-delay, timeout, failure-threshold. Cette option peut être spécifiée plusieurs fois. La propriété type est obligatoire et les valeurs valides sont tcp et http. Par exemple, --probe-live type=tcp --probe-live port=8080. Pour plus d'informations sur l'utilisation des sondes, voir Configuration des sondes pour votre application. Cette valeur est facultative.

--probe-ready, --pr

Configurez la sonde de conformité pour cette application au format NAME=VALUE. Les options valables pour NAME sont : type, port, path, interval, initial-delay, timeout, failure-threshold. Cette option peut être spécifiée plusieurs fois. La propriété type est obligatoire et les valeurs valides sont tcp et http. Par exemple, --probe-ready type=tcp --probe-ready port=8080. Pour plus d'informations sur l'utilisation des sondes, voir Configuration des sondes pour votre application. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--registry-secret, --rs

Nom du secret de registre. Le secret de registre est utilisée pour l'authentification auprès d'un registre privé lorsque vous téléchargez l'image de conteneur. Cette valeur est facultative.

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

Délai en secondes avant la réussite ou l'échec des demandes adressées à l'application. Cette valeur est facultative. La valeur par défaut est 300.

--rn, --revision-name

Nom de la révision. Utilisez un nom unique dans l'application.

  • Le nom peut contenir des lettres minuscules, des nombres et des traits d'union (-).
  • Le nom doit se terminer par un caractère alphanumérique en minuscule.
  • Le nom de révision complet doit être au format Name_of_application-Name of revision.
  • Le nom de révision complet doit être composé de 63 caractères ou moins.

Cette valeur est facultative.

--scale-down-delay, --sdd
Durée, en secondes, qui doit s'écouler à un niveau d'accès concurrents réduits avant que l'application ne soit réduite. L'augmentation du nombre de requêtes simultanées entraîne la mise à l'échelle d'une application. Si le nombre de demandes diminue (baisse de la concurrence), le délai spécifié pour cette option détermine la durée pendant laquelle la baisse de la concurrence doit persister, avant que l'application ne soit réduite. Par défaut, l'application sera immédiatement réduite si une baisse de la concurrence est détectée. Cette valeur est facultative. La valeur par défaut est 0.
--service-account, --sa

Nom du compte de service. Un compte de service fournit une identité pour les processus qui s'exécutent dans une instance. Pour les comptes de service intégrés, vous pouvez utiliser les noms raccourcis manager, none, reader et writer. Vous pouvez également utiliser les noms complets préfixés avec le Kubernetes Config Context, qui peut être déterminé à l'aide de la commande project current. Cette valeur est facultative.

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

Activer le montage d'un jeton de ressource de calcul dans le conteneur de cette application. Cette valeur est facultative. La valeur par défaut est false.

--user, -u

ID utilisateur employé pour exécuter l'application. Cette valeur remplace tout ID utilisateur défini dans le fichier Dockerfile de l'application. L'ID doit être conforme aux exigences du système d'exploitation du conteneur. Cette valeur est facultative. La valeur par défaut est 0.

--visibility, -v

La visibilité de l'application. Les valeurs valides sont : public, private et project. La définition d'une visibilité de public signifie que votre application peut recevoir des demandes provenant de l'Internet public ou des composants du projet Code Engine. La définition d'une visibilité de private signifie que votre application n'est pas accessible à partir de l'accès public à Internet et que l'accès au réseau n'est possible qu'à partir d'autres IBM Cloud utilisant des nœuds finaux privés virtuels (VPE) ou des composants Code Engine qui s'exécutent dans le même projet. La visibilité ne peut être private que si le projet prend en charge la visibilité privée de l'application. La définition d'une visibilité de project signifie que votre application n'est pas accessible à partir de l'accès public à Internet et que l'accès au réseau est possible uniquement à partir d'autres composants Code Engine qui s'exécutent dans le même projet. Cette valeur est facultative.

--wait, -w

Crée l'application et attend que l'application soit prête. Si vous spécifiez l'option --wait, l'application crée des plages d'attente définies pour une durée maximale en secondes, dans l'option --wait-timeout, pour laisser à l'application le temps d'être prête. Si l'application n'est pas prête dans le délai wait-timeout spécifié, sa création échoue. Cette valeur est facultative. La valeur par défaut est true.

--wait-timeout, --wto

Délai d'attente en secondes avant que l'application soit prête. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 600.

Exemple

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

Exemple de sortie

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

Lorsque vous exécutez ibmcloud ce application get -n 'myapp' pour vérifier le statut de l'application, l'URL de cette dernière s'affiche.

ibmcloud ce application delete

Permet de supprimer une application.

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

Options de commande

--name, -n
Nom de l'application. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--no-wait, --nw
Supprime l'application sans attendre. Si vous spécifiez l'option no-wait, la suppression de l'application commence sans attendre. Utilisez la commande app get pour vérifier le statut de l'application. Cette valeur est facultative. La valeur par défaut est true.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--wait, -w
Supprime l'application et attend pour procéder à la suppression. Si vous spécifiez l'option --wait, la suppression de l'application est mise en attente pour une durée maximale en secondes, définie dans l'option --wait-timeout, avant de supprimer l'application. Si l'application n'est pas supprimée dans le délai --wait-timeout spécifié, sa suppression échoue. Cette valeur est facultative. La valeur par défaut est false.
--wait-timeout, --wto
Délai d'attente en secondes avant la suppression de l'application. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 600.

Exemple

ibmcloud ce application delete --name myapp -f

Exemple de sortie

Deleted application 'myapp'

ibmcloud ce application events

Affichez les événements système des instances d'application. Les événements système sont conservés jusqu'à 60 minutes.

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

Options de commande

--application, --app, -a, --name, -n
Permet d'afficher les événements de toutes les instances de l'application spécifiée. Cette valeur est obligatoire si --instance n'est pas spécifié.
--instance, -i
Nom d'une instance d'application spécifique. Utilisez la commande app get pour identifier le nom de l'instance. Cette valeur est obligatoire si --application n'est pas spécifié.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

L'exemple suivant affiche les informations d'événement système de toutes les instances d'une application spécifiée.

ibmcloud ce application events --application myapp
Exemple de sortie
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

Exemple d'informations d'événement système pour l'instance spécifiée d'une application

L'exemple suivant affiche les informations d'événement système d'une instance spécifiée d'une application. Utilisez la commande app get pour afficher les détails relatifs à votre application, y compris ses instances en cours d'exécution.

ibmcloud ce application events --instance myapp-li17x-1-deployment-69fd57bcb6-sr9tl
Exemple de sortie d'informations sur les évènements système pour une instance spécifiée d'une application
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

Permet d'afficher les détails d'une application.

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

Options de commande

--name, -n
Nom de l'application. Cette valeur est obligatoire.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSION, jsonpath-as-json=JSONPATH_EXPRESSION, urlet project-url. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--show-all-revisions, -r
Permet d'afficher toutes les révisions de cette application. Si cette option n'est pas spécifiée, seules les révisions configurées pour recevoir du trafic sont affichées. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce application get --name myapp

Exemple de sortie

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

Permet de répertorier toutes les applications d'un projet.

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

Options de commande

--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce app list --sort-by age

Exemple de sortie

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

Permet d'afficher les journaux des instances d'application.

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

Options de commande

--all-containers, --all
Permet d'afficher les journaux de tous les conteneurs des instances d'application spécifiées. Cette valeur est facultative. La valeur par défaut est false.
--application, --app, -a, --name, -n
Permet d'afficher les journaux de toutes les instances de l'application spécifiée. Cette valeur est obligatoire si --instance n'est pas spécifié.
--follow, -f
Permet de suivre les journaux des instances de l'application. Utilisez cette option pour diffuser les journaux des instances de l'application. Si vous spécifiez l'option --follow, vous devez entrer Ctrl+C pour mettre fin à cette commande de journal. Cette valeur est facultative. La valeur par défaut est false.
--instance, -i
Nom d'une instance d'application spécifique. Utilisez la commande app get pour identifier le nom de l'instance. Cette valeur est obligatoire si --application n'est pas spécifié.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--raw, -r
Permet d'afficher les journaux sans les libellés d'instance et de conteneur. Cette valeur est facultative. La valeur par défaut est false.
--tail, -t
Permet de limiter l'affichage des journaux des conteneurs des instances d'application spécifiées à un nombre maximal de lignes récentes par conteneur. Par exemple, pour afficher les dernières lignes 3 des journaux des conteneurs des instances d'application spécifiées, indiquez --tail 3. Si cette option n'est pas spécifiée, toutes les lignes des journaux des conteneurs des instances d'application spécifiées sont affichées. Cette valeur est facultative. La valeur par défaut est -1.
--timestamps, --ts
Permet d'inclure des horodatages sur chaque ligne dans la sortie de journal. Cette valeur est facultative. La valeur par défaut est false.

Exemple

L'exemple suivant affiche les journaux d'une instance spécifique d'une application. Utilisez la commande app get pour obtenir le nom des instances d'application.

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

Exemple de sortie

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/

Exemple de journaux de toutes les instances d'une application

L'exemple suivant affiche les journaux de toutes les instances d'une application.

ibmcloud ce application logs --app myapp
Exemple de sortie de journaux de toutes les instances d'une application
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

Redémarrer les instances d'application en cours d'exécution.

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

Options de commande

--application, --app, -a, --name, -n
Redémarrer toutes les instances en cours d'exécution de l'application spécifiée. Cette valeur est obligatoire si --instance n'est pas spécifié.
--instance, -i
Nom d'une instance d'application spécifique. Utilisez la commande app get pour identifier le nom de l'instance. Cette valeur est obligatoire si --application n'est pas spécifié.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce application restart --name myapp

Exemple de sortie

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

ibmcloud ce application unbind

Permet d'annuler la liaison d'instances de service IBM Cloud avec une application.

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

Options de commande

--name, -n
Nom de l'application pour laquelle vous souhaitez annuler la liaison. Cette valeur est obligatoire.
--all, -A
Permet d'annuler la liaison de toutes les instances de service avec cette application. Cette valeur est obligatoire si --binding n'est pas spécifié. La valeur par défaut est false.
--binding, -b
Nom de la liaison à annuler. Exécutez ibmcloud ce app get -n APP_NAME pour afficher les noms de liaison. Cette valeur est obligatoire si --all n'est pas spécifié.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

Cet exemple permet de retirer toutes les liaisons de votre application nommée myapp.

ibmcloud ce application unbind --name myapp --all

Exemple de sortie

Removing service bindings...
OK

ibmcloud ce application update

Permet de mettre à jour une application. Lorsque vous mettez à jour votre application, une révision est créée. Lorsque des appels sont émis vers l'application, le trafic est acheminé vers la révision.

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]

Options de commande

--name, -n

Nom de l'application. Cette valeur est obligatoire.

--argument, --arg, -a

Permet de définir des arguments pour l'application. Spécifiez un argument par option --argument ; par exemple, -a argA -a argB. Cette valeur est facultative.

--arguments-clear, --ac

Permet d'effacer les arguments d'une application. Cette valeur est facultative. La valeur par défaut est false.

--build-clear, --bc

Supprimez l'association d'une génération à partir de cette application. L'option « Effacer la compilation » n'est disponible que si votre application dispose actuellement d'une compilation associée. Cette valeur est facultative. La valeur par défaut est false.

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

Validation, balise ou branche du référentiel source à extraire. L'option « build commit » n'est autorisée que si l'option « --build-source » est définie sur l' URL d'un dépôt Git via cette commande app update, ou si votre application dispose actuellement d'une version associée provenant d'un dépôt Git. Cette valeur est facultative.

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

Effacer la validation, la balise ou la branche dans le référentiel source pour l'extraction. L'option « commit clear » est autorisée si votre application dispose actuellement d'une version associée. Cette valeur est facultative. La valeur par défaut est false.

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

Répertoire inclus dans le référentiel qui contient le fichier de packs de construction ou le fichier Dockerfile. L'option de répertoire de contexte de génération est autorisée si l'option --build-sourceest définie sur cette commande app updateou si votre application dispose actuellement d'une génération associée. Cette valeur est facultative.

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

Chemin d'accès au Dockerfile. Spécifiez cette option uniquement si le nom est différent de Dockerfile. L'option « build dockerfile » n'est autorisée que si l'option « --build-source » est définie dans cette commande « app update », ou si votre application dispose actuellement d'une build associée. Cette valeur est facultative. La valeur par défaut est Dockerfile.

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

Nom du secret SSH, qui contient les identifiants permettant d'accéder au référentiel privé contenant le code source pour la génération de votre image de conteneur. Pour créer ce secret SSH, utilisez la commande secret create --format SSH. Un secret SSH est également utilisé comme secret d'accès au référentiel Git. Cette option n'est autorisée que si l'option « --build-source » est définie sur l'adresse URL d'un référentiel Git via cette commande application update, ou si votre application dispose actuellement d'une version associée provenant d'un référentiel Git. Cette valeur est facultative.

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

Effacer le secret SSH. Cette option est autorisée si votre application dispose actuellement d'une version associée. Cette valeur est facultative. La valeur par défaut est false.

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

Taille de la génération, qui détermine la quantité de ressources utilisée. Les valeurs valides sont : small, medium, large, xlarge et xxlarge. Pour plus de détails, voir Définition de la taille de la génération. L'option « build size » n'est autorisée que si l'option « --build-source » est activée dans cette commande « app update », ou si votre application dispose actuellement d'une version associée. Cette valeur est facultative. La valeur par défaut est medium.

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

L'URL du référentiel Git ou le chemin d'accès à la source locale qui contient votre code source ; par exemple, https://github.com/IBM/CodeEngine ou.. Cette valeur est facultative.

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

Stratégie à utiliser pour générer l'image. Les valeurs valides sont dockerfile et buildpacks. L'option de stratégie de compilation n'est autorisée que si l'option « --build-source » est activée dans cette commande « app update », ou si votre application dispose actuellement d'une compilation associée. Si elle n'est pas spécifiée, la stratégie de génération est déterminée par Code Engine si --build-source est spécifié et si la source se trouve sur votre machine locale. Cette valeur est facultative. La valeur par défaut est dockerfile.

--build-timeout, --bto

Délai en secondes avant la réussite ou l'échec de la génération. L'option de délai d'expiration de la compilation n'est autorisée que si l'option « --build-source » est définie dans cette commande « app update », ou si votre application dispose actuellement d'une compilation associée. Cette valeur est facultative. La valeur par défaut est 600.

--cluster-local, --cl

Déployez l'application avec un nœud final de type projet-uniquement. La définition d'un nœud final de projet uniquement signifie que votre application n'est pas accessible à partir de l'accès public à Internet et que l'accès au réseau est possible uniquement à partir d'autres composants Code Engine qui s'exécutent dans le même projet. Cette valeur est facultative. La valeur par défaut est false.

--command, --cmd, -c

Permet de définir des commandes pour l'application. Spécifiez une commande par option --command ; par exemple, --cmd cmdA --cmd cmdB. Cette valeur remplace la commande par défaut qui est spécifiée dans l'image de conteneur. Cette valeur est facultative.

--commands-clear, --cc

Permet d'effacer les commandes d'une application. Cette valeur est facultative. La valeur par défaut est false.

--concurrency, --cn

Nombre maximal de demandes pouvant être traitées simultanément par instance. Cette valeur est facultative. La valeur par défaut est 0.

--concurrency-target, --ct

Seuil de demandes simultanées par instance auquel une ou plusieurs instances supplémentaires sont créées. Utilisez cette valeur pour augmenter le nombre d'instances en fonction du nombre simultané de demandes. Si --concurrency-target n'est pas spécifié, cette option prend par défaut la valeur de l'option --concurrency. Cette valeur est facultative. La valeur par défaut est 0.

--cpu

Quantité d'UC définie pour l'instance de l'application. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative. La valeur par défaut est 0.

--env, -e

Permet de définir des variables d'environnement dans l'application. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle variable d'environnement ou de remplacer une variable d'environnement existante. Spécifiez une variable d'environnement par option --env ; par exemple, --env envA=A --env envB=B. Cette valeur est facultative.

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

Définissez les variables d'environnement à partir des paires clé-valeur qui sont stockées dans cette mappe de configuration en utilisant l'une des méthodes suivantes :

  • Afin d'ajouter des variables d'environnement pour toutes les clés d'une mappe de configuration nommée configmapName, utilisez la valeur configmapName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement de la mappe de configuration. Pour spécifier un préfixe, utilisez la valeurPREFIX=CONFIGMAP_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans la mappe de configurationconfigmapName enCUSTOM_, utilisez la valeurCUSTOM_=configmapName. Si la mappe de configuration configmapName contient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, afin d'ajouter une variable d'environnement pour une clé key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:myKey=key1.

Cette valeur est facultative.

--env-from-configmap-rm, --env-cm-rm
Permet de retirer des références de variable d'environnement à des mappes de configuration complètes en utilisant le nom de la mappe de configuration. Pour retirer des références de clé individuelles à des mappes de configuration, utilisez l'option --env-rm. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--env-sec, --env-from-secret

Définissez les variables d'environnement à partir des paires clé-valeur stockées dans un secret en utilisant l'une des méthodes suivantes :

  • Afin d'ajouter des variables d'environnement pour toutes les clés d'un secret nommé secretName, utilisez la valeur secretName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement du secret. Pour spécifier un préfixe, utilisez la valeurPREFIX=SECRET_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_SECRET>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans le secretsecretName vers CUSTOM_, utilisez la valeurCUSTOM_=secretName. Si le secret secretNamecontient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, pour ajouter une variable d'environnement pour une clé uniquekey1 dans un secret nommésecretName, utilisez la valeursecretName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans un secret nommé secretName, utilisez la valeur secretName:myKey=key1.

Cette valeur est facultative.

--env-from-secret-rm, --env-sec-rm
Permet de retirer des références de variable d'environnement à des secrets intégraux en utilisant le nom de secret. Pour retirer des références de clé individuelles à des secrets, utilisez l'option --env-rm. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--env-rm

Permet de retirer des références de variable d'environnement à la clé d'une paire clé-valeur dans une mappe de configuration ou un secret. Pour retirer des références de clé individuelles et des valeurs littérales, spécifiez le nom de la clé. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.

--ephemeral-storage, --es

Quantité de stockage éphémère à définir pour l'instance de l'application. Utilisez M pour mégaoctets ou G pour gigaoctets. Cette valeur est facultative.

--force, -f

Ne pas vérifier l'existence des références de mappe de configuration et de secret spécifiées. Les références de mappe de configuration sont spécifiées avec les options --env-from-configmap ou --mount-configmap. Les références de secret sont spécifiées avec l'option --env-from-secret, --mount-secret ou --registry-secret. Cette valeur est facultative. La valeur par défaut est false.

--image, -i

Nom de l'image utilisée pour cette application. Le format est REGISTRY/NAMESPACE/REPOSITORY:TAG, où REGISTRY et TAG sont facultatifs. Si REGISTRY n'est pas spécifié, la valeur par défaut est docker.io. Si TAG n'est pas spécifié, la valeur par défaut est latest. Cette valeur est facultative.

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

Nombre maximal d'instances pouvant être utilisées pour cette application. Si vous définissez cette valeur sur 0, les mises à l'échelle d'application sont nécessaires. La mise à l'échelle de l'application est limitée uniquement par les instances par le quota de ressources alloué pour le projet de votre application. Voir Limites et quotas pour Code Engine. Cette valeur est facultative. La valeur par défaut est 10.

--memory, -m

Quantité de mémoire définie pour l'instance de l'application. Utilisez M pour mégaoctets ou G pour gigaoctets. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative.

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

Nombre minimal d'instances pouvant être utilisées pour cette application. Cette valeur est facultative. La valeur par défaut est 0.

--mount-configmap, --mount-cm

Ajoute le contenu d'une mappe de configuration au système de fichiers de votre conteneur d'applications en fournissant un répertoire de montage et le nom d'une mappe de configuration, avec le format MOUNT_DIRECTORY=CONFIGMAP_NAME. Chaque mappe de configuration montée doit utiliser un répertoire de montage unique. Pour chaque paire clé-valeur de la mappe de configuration, un fichier est ajouté au répertoire de montage spécifié, où le nom de fichier est la clé et le contenu du fichier, la valeur de la paire clé-valeur. Spécifiez une configuration de montage par option --mount-configmap, --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b, par exemple. Cette valeur est facultative.

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

Montage d'un stockage de persistance des données. Le format est le suivant : MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. SUBPATH est facultatif. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.

--mount-rm

Retire le contenu d'une mappe de configuration ou d'un secret du système de fichiers de votre conteneur d'applications en spécifiant le répertoire dans lequel la mappe de configuration ou le secret est monté. Spécifiez un répertoire de montage par option --mount-rm, --mount-rm /etc/configmap-a --mount-rm /etc/secret-b, par exemple. Cette valeur est facultative.

--mount-secret, --mount-sec

Ajoute le contenu d'un secret au système de fichiers de votre conteneur d'applications en fournissant un répertoire de montage et le nom d'un secret, avec le format MOUNT_DIRECTORY=SECRET_NAME. Chaque secret monté doit utiliser un répertoire de montage unique. Pour chaque paire clé-valeur du secret, un fichier est ajouté au répertoire de montage spécifié, où le nom de fichier est la clé et le contenu du fichier, la valeur de la paire clé-valeur. Spécifiez une configuration de montage par option --mount-secret, --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b, par exemple. Cette valeur est facultative.

--no-cluster-local, --ncl

Déployer l'application avec un noeud final public. L'application se déploie de telle sorte qu'elle puisse recevoir des demandes provenant de l'Internet public ou des composants du projet Code Engine. Cette valeur est facultative. La valeur par défaut est true.

--no-wait, --nw

Met à jour l'application et n'attend pas que l'application soit prête. Si vous spécifiez l'option no-wait, la mise à jour de l'application commence sans attendre. Utilisez la commande app get pour vérifier le statut de l'application. Cette valeur est facultative. La valeur par défaut est false.

--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSION, jsonpath-as-json=JSONPATH_EXPRESSION, urlet project-url. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--port, -p

Port sur lequel l'application est en mode écoute. Le format est [NAME:]PORT, où [NAME:] est facultatif. Si [NAME:] est spécifié, les valeurs valides sont h2c ou http1. Lorsque [NAME:] n'est pas spécifié ou a pour valeur http1, le port utilise HTTP/1.1. Lorsque [NAME:] a pour valeur h2c, il utilise HTTP/2 en mode non chiffré. Par défaut, Code Engine part de l'hypothèse que les applications écoutent les connexions entrantes sur le port 8080. Si votre application doit écouter un port autre que le port 8080, utilisez --port pour spécifier ce port. Cette valeur est facultative.

--probe-live, --pl

Configurez la sonde d'activité pour cette application au format NAME=VALUE. Les options valables pour NAME sont : type, port, path, interval, initial-delay, timeout, failure-threshold. Cette option peut être spécifiée plusieurs fois. La propriété type est obligatoire et les valeurs valides sont tcp et http. Par exemple, --probe-live type=tcp --probe-live port=8080. Pour plus d'informations sur l'utilisation des sondes, voir Configuration des sondes pour votre application. Cette valeur est facultative.

--probe-live-clear, --plr

Supprimez la sonde d'activité. Cette option n'est autorisée que si votre application dispose actuellement d'une sonde de vivacité. Cette valeur est facultative. La valeur par défaut est false.

--probe-ready, --pr

Configurez la sonde de conformité pour cette application au format NAME=VALUE. Les options valables pour NAME sont : type, port, path, interval, initial-delay, timeout, failure-threshold. Cette option peut être spécifiée plusieurs fois. La propriété type est obligatoire et les valeurs valides sont tcp et http. Par exemple, --probe-ready type=tcp --probe-ready port=8080. Pour plus d'informations sur l'utilisation des sondes, voir Configuration des sondes pour votre application. Cette valeur est facultative.

--probe-ready-reset, --prr

Réinitialise la sonde de conformité à la configuration par défaut. Cette valeur est facultative. La valeur par défaut est false.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--rebuild

Régénérez l'image à partir de la source. L'option de reconstruction est autorisée si votre application dispose actuellement d'une génération associée. Cette valeur est facultative. La valeur par défaut est false.

--registry-secret, --rs

Nom du secret de registre. Le secret de registre est utilisée pour l'authentification auprès d'un registre privé lorsque vous téléchargez l'image de conteneur. Cette valeur est facultative.

--registry-secret-clear, --rsc

Effacer le secret du registre. Cette valeur est facultative. La valeur par défaut est false.

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

Délai en secondes avant la réussite ou l'échec des demandes adressées à l'application. Cette valeur est facultative. La valeur par défaut est 0.

--rn, --revision-name

Nom de la révision. Utilisez un nom unique dans l'application.

  • Le nom peut contenir des lettres minuscules, des nombres et des traits d'union (-).
  • Le nom doit se terminer par un caractère alphanumérique en minuscule.
  • Le nom de révision complet doit être au format Name_of_application-Name of revision.
  • Le nom de révision complet doit être composé de 63 caractères ou moins.

Cette valeur est facultative.

--scale-down-delay, --sdd
Durée, en secondes, qui doit s'écouler à un niveau d'accès concurrents réduits avant que l'application ne soit réduite. L'augmentation du nombre de requêtes simultanées entraîne la mise à l'échelle d'une application. Si le nombre de demandes diminue (baisse de la concurrence), le délai spécifié pour cette option détermine la durée pendant laquelle la baisse de la concurrence doit persister, avant que l'application ne soit réduite. Par défaut, l'application sera immédiatement réduite si une baisse de la concurrence est détectée. Cette valeur est facultative. La valeur par défaut est 0.
--service-account, --sa

Nom du compte de service. Un compte de service fournit une identité pour les processus qui s'exécutent dans une instance. Pour les comptes de service intégrés, vous pouvez utiliser les noms raccourcis manager, none, reader et writer. Vous pouvez également utiliser les noms complets préfixés avec le Kubernetes Config Context, qui peut être déterminé à l'aide de la commande project current. Cette valeur est facultative.

--service-account-clear, --sac

Effacer le compte de service. Cette valeur est facultative. La valeur par défaut est false.

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

Activer le montage d'un jeton de ressource de calcul dans le conteneur de cette application. Cette valeur est facultative. La valeur par défaut est false.

--user, -u

ID utilisateur employé pour exécuter l'application. Cette valeur remplace tout ID utilisateur défini dans le fichier Dockerfile de l'application. L'ID doit être conforme aux exigences du système d'exploitation du conteneur. Cette valeur est facultative. La valeur par défaut est 0.

--visibility, -v

La visibilité de l'application. Les valeurs valides sont : public, private et project. La définition d'une visibilité de public signifie que votre application peut recevoir des demandes provenant de l'Internet public ou des composants du projet Code Engine. La définition d'une visibilité de private signifie que votre application n'est pas accessible à partir de l'accès public à Internet et que l'accès au réseau n'est possible qu'à partir d'autres IBM Cloud utilisant des nœuds finaux privés virtuels (VPE) ou des composants Code Engine qui s'exécutent dans le même projet. La visibilité ne peut être private que si le projet prend en charge la visibilité privée de l'application. La définition d'une visibilité de project signifie que votre application n'est pas accessible à partir de l'accès public à Internet et que l'accès au réseau est possible uniquement à partir d'autres composants Code Engine qui s'exécutent dans le même projet. Cette valeur est facultative.

--wait, -w

Met à jour l'application et attend que l'application soit prête. Si vous spécifiez l'option --wait, la mise à jour de l'application est mise en attente pour une durée maximale en secondes, définie dans l'option --wait-timeout, pour laisser à l'application le temps d'être prête. Si l'application n'est pas prête dans le délai --wait-timeout spécifié, sa mise à jour échoue. Cette valeur est facultative. La valeur par défaut est true.

--wait-timeout, --wto

Délai d'attente en secondes avant la mise à jour de l'application. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 600.

Exemple

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

Exemple de sortie

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

Commande bêta

Code Engine les commandes bêta ne sont pas généralement disponibles. Ce groupe de commande permet d'accéder à des fonctionnalités futures potentielles pour faciliter leur exploration par des utilisateurs précoces sélectionnés.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes beta.

Pour consulter l'aide de l'interface en ligne de commande (CLI) relative aux commandes « beta », exécutez la commande « ibmcloud ce beta -h ».

ibmcloud ce beta

Code Engine les commandes bêta ne sont pas généralement disponibles. Ce groupe de commande permet d'accéder à des fonctionnalités futures potentielles pour faciliter leur exploration par des utilisateurs précoces sélectionnés.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes beta.

Pour consulter l'aide de l'interface en ligne de commande (CLI) relative aux commandes « beta », exécutez la commande « ibmcloud ce beta -h ».

ibmcloud ce beta COMMAND

Exemple

ibmcloud ce beta help

Exemple de sortie

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.

Commandes build

Une génération, ou génération d'image, est un mécanisme que vous pouvez utiliser pour créer une image de conteneur à partir de votre code source. Code Engine prend en charge la génération à partir d'un Dockerfile et de Cloud Native Buildpacks. Les commandes build vous permettent de créer, mettre à jour et supprimer des configurations de génération et d'afficher les détails les concernant. Une fois que vous avez créé une configuration de génération, vous pouvez soumettre une ou plusieurs commandes buildrun à partir de cette configuration de génération.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes build.

Pour plus d'informations sur l'utilisation des générations, reportez-vous à la rubrique décrivant la génération d'une image de conteneur.

Vous pouvez utiliser soit buildoubd dans vos commandesbuild. Pour afficher l'aide de l'interface de ligne de commande relative aux commandes build, exécutez la commande ibmcloud ce build -h.

ibmcloud ce build create

Permet de créer une génération.

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]

Options de commande

-n, --name

Nom de la génération. Utilisez un nom unique dans le projet.

  • Le nom doit débuter et se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 63 caractères au maximum et peut contenir des caractères alphanumériques en minuscule et des traits d'union (-).

Cette valeur est obligatoire.

--build-type, --bt
Type de génération. Les valeurs valides sont git et local. Si le type de génération est local, les options --source, --commitet --git-repo-secret ne sont pas valides. Cette valeur est facultative. La valeur par défaut est git.
--commit, --cm, --revision

Validation, balise ou branche du référentiel source à extraire. L'option de validation est autorisée si l'option --build-type est git et non autorisée si l'option --build-type est local. Cette valeur est facultative.

--context-dir, --cdr

Répertoire inclus dans le référentiel qui contient le fichier de packs de construction ou le fichier Dockerfile. Cette valeur est facultative.

--dockerfile, --df

Chemin d'accès au Dockerfile. Spécifiez cette option uniquement si le nom est différent de Dockerfile. Cette valeur est facultative. La valeur par défaut est Dockerfile.

--force, -f

Permet de ne pas vérifier l'existence des références de secret spécifiées. Les références de secret sont spécifiées avec l'option --get-repo-secret ou --registry-secret. Cette valeur est facultative. La valeur par défaut est false.

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

Nom du secret SSH, qui contient les identifiants permettant d'accéder au référentiel privé contenant le code source pour la génération de votre image de conteneur. Pour créer ce secret SSH, utilisez la commande secret create --format SSH. Un secret SSH est également utilisé comme secret d'accès au référentiel Git. Cette option est autorisée si l'option --build-type est git et n'est pas autorisée si l'option --build-type est local. Cette valeur est facultative.

--image, -i

Emplacement du registre d'images. Le format est REGISTRY/NAMESPACE/REPOSITORY:TAG, où TAG est facultatif. Si TAG n'est pas spécifié, la valeur par défaut est latest. Cette valeur est facultative.

--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--registry-secret, --rs

La clé de registre utilisée pour accéder au registre. Vous pouvez ajouter la clé de registre en exécutant la commande « registry create ». Cette valeur est facultative.

--size, --sz

Taille de la génération, qui détermine la quantité de ressources utilisée. Les valeurs valides sont : small, medium, large, xlarge et xxlarge. Pour plus de détails, voir Définition de la taille de la génération. Cette valeur est facultative. La valeur par défaut est medium.

--source, --src

Adresse URL du référentiel Git qui contient votre code source. Par exemple https://github.com/IBM/CodeEngine. L'option source est obligatoire si l'option --build-type est git et non autorisée si l'option --build-type est local. Cette valeur est facultative.

--strategy, --str

Stratégie à utiliser pour générer l'image. Pour les candidatures et les offres d'emploi, les adresses valides sont dockerfile et buildpacks. Pour les fonctions, les valeurs valides se présentent sous la forme « codebundle-[RUNTIME-ID] ». Par exemple, si vous voulez construire un paquet de code pour votre fonction avec l'ID d'exécution nodejs-24, utilisez codebundle-nodejs-24 comme stratégie de construction. Vous pouvez trouver l'ID de toutes les fonctions prises en charge en exécutant la commande ibmcloud ce fn runtimes. Cette valeur est facultative. La valeur par défaut est dockerfile.

--timeout, --to

Délai en secondes avant la réussite ou l'échec de la génération. Cette valeur est facultative. La valeur par défaut est 600.

Exemple

L'exemple suivant crée un fichier de configuration de génération appelé helloworld-build à partir d'un fichier Dockerfile source stocké dans https://github.com/IBM/CodeEngine dans le répertoire hello de la branche main, avec la stratégie dockerfile et la taille medium (moyenne). Lorsque cette génération est soumise, l'image de conteneur générée est stockée dans une instance Container Registry à us.icr.io/mynamespace/codeengine-helloworld accessible à l'aide d'un secret de registre d'images appelé 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

Exemple de sortie

Creating build helloworld-build...
OK

ibmcloud ce build delete

Permet de supprimer une génération.

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

Options de commande

--name, -n
Nom de la génération. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce build delete --name helloworld-build

Exemple de sortie

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

ibmcloud ce build get

Permet d'afficher les détails d'une génération.

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

Options de commande

--name, -n
Nom de la génération. Cette valeur est obligatoire.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce build get --name helloworld-build

Exemple de sortie

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

Permet de répertorier toutes les générations d'un projet.

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

Options de commande

--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce build list

Exemple de sortie

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

Permet de mettre à jour une génération.

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]

Options de commande

--name, -n
Nom de la génération. Cette valeur est obligatoire.
--commit, --cm, --revision
Validation, balise ou branche du référentiel source à extraire. Cette valeur est facultative.
--commit-clear, --cmc
Effacer la validation, la balise ou la branche dans le référentiel source pour l'extraction. Cette valeur est facultative. La valeur par défaut est false.
--context-dir, --cdr
Répertoire inclus dans le référentiel qui contient le fichier de packs de construction ou le fichier Dockerfile. Cette valeur est facultative.
--dockerfile, --df
Chemin d'accès au Dockerfile. Spécifiez cette option uniquement si le nom est différent de Dockerfile. Cette valeur est facultative. La valeur par défaut est Dockerfile.
--force, -f
Permet de ne pas vérifier l'existence des références de secret spécifiées. Les références de secret sont spécifiées avec l'option --get-repo-secret ou --registry-secret. Cette valeur est facultative. La valeur par défaut est false.
--git-repo-secret, --grs, --repo, -r
Nom du secret SSH, qui contient les identifiants permettant d'accéder au référentiel privé contenant le code source pour la génération de votre image de conteneur. Pour créer ce secret SSH, utilisez la commande secret create --format SSH. Un secret SSH est également utilisé comme secret d'accès au référentiel Git. Cette valeur est facultative.
--git-repo-secret-clear, --grsc
Effacer le secret SSH. Cette valeur est facultative. La valeur par défaut est false.
--image, -i
Emplacement du registre d'images. Le format est REGISTRY/NAMESPACE/REPOSITORY:TAG, où TAG est facultatif. Si TAG n'est pas spécifié, la valeur par défaut est latest. Cette valeur est facultative.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--registry-secret, --rs
Nom du secret de registre. Le secret de registre est utilisée pour l'authentification auprès d'un registre privé lorsque vous téléchargez l'image de conteneur. Cette valeur est facultative.
--size, --sz
Taille de la génération, qui détermine la quantité de ressources utilisée. Les valeurs valides sont : small, medium, large, xlarge et xxlarge. Pour plus de détails, voir Définition de la taille de la génération. Cette valeur est facultative.
--source, --src
Adresse URL du référentiel Git qui contient votre code source. Par exemple https://github.com/IBM/CodeEngine. Cette valeur est facultative.
--strategy, --str
Stratégie à utiliser pour générer l'image. Pour les candidatures et les offres d'emploi, les adresses valides sont dockerfile et buildpacks. Pour les fonctions, les valeurs valides se présentent sous la forme « codebundle-[RUNTIME-ID] ». Par exemple, si vous voulez construire un paquet de code pour votre fonction avec l'ID d'exécution nodejs-24, utilisez codebundle-nodejs-24 comme stratégie de construction. Vous pouvez trouver l'ID de toutes les fonctions prises en charge en exécutant la commande ibmcloud ce fn runtimes. Cette valeur est facultative.
--timeout, --to
Délai en secondes avant la réussite ou l'échec de la génération. Cette valeur est facultative. La valeur par défaut est 600.

Exemple

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

Exemple de sortie

Updating build helloworld-build...
OK

Commandes buildrun

Une génération, ou génération d'image, est un mécanisme que vous pouvez utiliser pour créer une image de conteneur à partir de votre code source. Code Engine prend en charge la génération à partir d'un Dockerfile et de Cloud Native Buildpacks. Les commandes buildrun vous permettent de soumettre et supprimer des exécutions de génération et d'afficher les détails les concernant.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes buildrun.

Pour plus d'informations sur l'utilisation de générations et d'exécutions de génération, reportez-vous à la rubrique décrivant la génération d'une image de conteneur.

Vous pouvez utiliser soit buildrunoubr dans vos commandesbuildrun. Pour afficher l'aide de l'interface de ligne de commande relative aux commandes buildrun, exécutez la commande ibmcloud ce br -h.

ibmcloud ce buildrun cancel

Annulez une exécution de génération.

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

Options de commande

--name, -n
Nom de l'exécution de génération. Cette valeur est obligatoire.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce buildrun cancel --name mybuildrun

Exemple de sortie

Canceling build run 'mybuildrun'...
OK

ibmcloud ce buildrun delete

Permet de supprimer une exécution de génération.

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

Options de commande

--build, -b
Cette option permet de supprimer toutes les exécutions de génération de la génération spécifiée. L'option --build est requise si vous ne spécifiez pas la valeur --name. Cette valeur est facultative.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--name, -n
Nom de l'exécution de génération. L'option --name est requise si vous ne spécifiez pas la valeur --build. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce buildrun delete --name mybuildrun

Exemple de sortie

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

ibmcloud ce buildrun events

Afficher les événements système d'une exécution de génération. Les événements système sont conservés jusqu'à 60 minutes.

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

Options de commande

--buildrun, -b, --br, --name, -n
Nom de l'exécution de génération. Cette valeur est obligatoire.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

Cet exemple affiche les informations d'événement système d'une exécution de génération.

ibmcloud ce buildrun events --buildrun mybuildrun

Exemple de sortie

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

Permet d'afficher les détails d'une exécution de génération.

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

Options de commande

--name, -n
Nom de l'exécution de génération. Cette valeur est obligatoire.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce buildrun get --name mybuildrun

Exemple de sortie

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

Permet de répertorier toutes les exécutions de génération d'un projet.

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

Options de commande

--build, -b
Cette option permet d'afficher uniquement les exécutions de génération de la génération spécifiée. Cette valeur est facultative.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce buildrun list

Exemple de sortie

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

Permet d'afficher les journaux d'une exécution de génération.

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

Options de commande

--buildrun, -b, --br, --name, -n
Nom de l'exécution de génération. Cette valeur est obligatoire.
--follow, -f
Permet de suivre les journaux de l'exécution de génération. Utilisez cette option pour diffuser les journaux de l'exécution de génération. Si vous spécifiez l'option --follow, vous devez entrer Ctrl+C pour mettre fin à cette commande de journal. Cette valeur est facultative. La valeur par défaut est false.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--raw, -r
Permet d'afficher les journaux sans les libellés d'instance et de conteneur. Cette valeur est facultative. La valeur par défaut est false.
--tail, -t
Permet de limiter l'affichage des journaux des conteneurs de l'exécution de génération spécifiée à un nombre maximal de lignes récentes par conteneur. Par exemple, pour afficher les dernières lignes 3 des journaux des conteneurs de l'exécution de génération spécifiée, indiquez --tail 3. Si cette option n'est pas spécifiée, toutes les lignes des journaux des conteneurs de l'exécution de compilation spécifiée sont affichées. Cette valeur est facultative. La valeur par défaut est -1.
--timestamps, --ts
Permet d'inclure des horodatages sur chaque ligne dans la sortie de journal. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce buildrun logs --name mybuildrun

Exemple de sortie

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

Permet de soumettre une exécution de génération.

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]

Options de commande

--build, -b, --bd

Nom de la configuration de génération à utiliser. Cette valeur est facultative.

--commit, --cm, --revision

Validation, balise ou branche du référentiel source à extraire. L'option de validation de génération est autorisée si l'option --sourceest définie sur l'URL d'un référentiel Git et n'est pas autorisée si l'option --sourcen'est pas définie sur l'URL d'un référentiel Git. Cette valeur est facultative.

--context-dir, --cdr

Répertoire inclus dans le référentiel qui contient le fichier de packs de construction ou le fichier Dockerfile. L'option de répertoire de contexte de génération est autorisée si l'option --build n'est pas définie et n'est pas autorisée si l'option--build est définie. Cette valeur est facultative.

--dockerfile, --df

Chemin d'accès au Dockerfile. Spécifiez cette option uniquement si le nom est différent de Dockerfile. L'option de génération dockerfile est autorisée si l'option --buildn'est pas définie et n'est pas autorisée si l'option --build est définie. Cette valeur est facultative. La valeur par défaut est Dockerfile.

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

Nom du secret SSH, qui contient les identifiants permettant d'accéder au référentiel privé contenant le code source pour la génération de votre image de conteneur. Pour créer ce secret SSH, utilisez la commande secret create --format SSH. Un secret SSH est également utilisé comme secret d'accès au référentiel Git. Cette option n'est autorisée que si l'option --build-source est définie sur URL d'un référentiel Git. Cette valeur est facultative.

--image, -i

Emplacement du registre d'images. Le format est REGISTRY/NAMESPACE/REPOSITORY:TAG, où TAG est facultatif. Si TAG n'est pas spécifié, la valeur par défaut est latest. Cette valeur est facultative.

-n, --name

Nom de l'exécution de génération. Utilisez un nom unique dans le projet. Si l'option --build est définie, l'option de nom est facultative. Si l'option --build n'est pas définie, l'option de nom est requise.

  • Le nom doit débuter et se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 63 caractères au maximum et peut contenir des caractères alphanumériques en minuscule et des traits d'union (-).

Cette valeur est facultative.

--no-wait, --nw
Permet de soumettre l'exécution de génération et de ne pas attendre qu'elle soit terminée. Si vous spécifiez l'option --no-wait, la soumission de l'exécution de génération démarre, sans attendre. Utilisez la commande buildrun get pour vérifier le statut de l'exécution de génération. Cette valeur est facultative. La valeur par défaut est true.
--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--registry-secret, --rs

Nom du secret de registre. Le secret de registre est utilisée pour l'authentification auprès d'un registre privé lorsque vous téléchargez l'image de conteneur. L'option « registry secret » est autorisée si l'option « --build » n'est pas définie, et l'option « pas » est autorisée si l'option « --build » est définie. Cette valeur est facultative.

--service-account, --sa

Nom du compte de service. Un compte de service fournit une identité pour les processus qui s'exécutent dans une instance. Pour les comptes de service intégrés, vous pouvez utiliser les noms raccourcis manager, none, reader et writer. Vous pouvez également utiliser les noms complets préfixés avec le Kubernetes Config Context, qui peut être déterminé à l'aide de la commande project current. Cette valeur est facultative.

--size, --sz

Taille de la génération, qui détermine la quantité de ressources utilisée. Les valeurs valides sont : small, medium, large, xlarge et xxlarge. Pour plus de détails, voir Définition de la taille de la génération. L'option « build size » est autorisée si l'option « --build » n'est pas définie, et n'est pas autorisée si l'option « --build » est définie. Cette valeur est facultative. La valeur par défaut est medium.

--source, --src

L'URL du référentiel Git ou le chemin d'accès à la source locale qui contient votre code source ; par exemple, https://github.com/IBM/CodeEngine ou.. Si l'option --buildest définie, l'option source est requise si l'option --build-typesur la génération associée est localet n'est pas autorisée si l'option --build-typede la génération associée estgit. Si l'option --buildn'est pas définie, l'option source est facultative. Cette valeur est facultative. La valeur par défaut est ..

--strategy, --str

Stratégie à utiliser pour générer l'image. Pour les candidatures et les offres d'emploi, les adresses valides sont dockerfile et buildpacks. Pour les fonctions, les valeurs valides se présentent sous la forme « codebundle-[RUNTIME-ID] ». Par exemple, si vous voulez construire un paquet de code pour votre fonction avec l'ID d'exécution nodejs-24, utilisez codebundle-nodejs-24 comme stratégie de construction. Vous pouvez trouver l'ID de toutes les fonctions prises en charge en exécutant la commande ibmcloud ce fn runtimes. L'option de stratégie de compilation est autorisée si l'option « --build » n'est pas définie, et n'est pas autorisée si l'option « --build » est définie. Si aucune valeur n'est indiquée, la stratégie de compilation est déterminée par Code Engine si --source est spécifié et que la source se trouve sur votre ordinateur local. Cette valeur est facultative. La valeur par défaut est dockerfile.

--timeout, --to

Délai en secondes avant la réussite ou l'échec de l'exécution de génération. Cette valeur est facultative. La valeur par défaut est 600.

--wait, -w

Permet de soumettre l'exécution de génération et d'attendre qu'elle soit terminée. Si vous spécifiez l'option --wait, le délai d'attente maximal, en secondes, de la soumission de l'exécution de génération pour que l'exécution de génération aboutisse est défini par l'option --wait-timeout. Si l'exécution de génération ne se termine pas dans le délai --wait-timeout spécifié, la soumission de l'exécution de génération échoue. Cette valeur est facultative. La valeur par défaut est false.

--wait-timeout, --wto

Délai d'attente, en secondes, avant que cette exécution de génération soit terminée. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 600.

Exemple

La commande illustrée ci-après permet de soumettre une exécution de génération nommée mybuildrun et d'utiliser le fichier de configuration de génération appelé helloworld-build.

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

Exemple de sortie

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

Commandes configmap

Une mappe de configuration fournit une méthode permettant d'inclure des informations de données non sensibles à votre déploiement. En utilisant les valeurs de votre ConfigMap comme variables d'environnement, vous pouvez dissocier certaines informations de votre déploiement et garantir la portabilité de votre application, de votre tâche ou de votre fonction. Une mappe de configuration contient des informations dans des paires clé-valeur. Les commandes configmap vous permettent de créer, mettre à jour et supprimer des mappes de configuration et d'afficher les détails les concernant.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes configmap.

Pour plus d'informations sur l'utilisation des cartes de configuration, voir Travailler avec des cartes de configuration.

Vous pouvez utiliser soit configmapoucm dans vos commandesconfigmap. Pour afficher l'aide de l'interface de ligne de commande relative aux commandes configmap, exécutez la commande ibmcloud ce configmap -h.

ibmcloud ce configmap create

Permet de créer une mappe de configuration.

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]

Options de commande

-n, --name

Nom de la mappe de configuration. Utilisez un nom unique dans le projet.

  • Le nom doit débuter et se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 253 caractères au maximum et peut contenir des lettres minuscules, des chiffres, des points (.) et des tirets (-).

Cette valeur est obligatoire.

--from-env-file, -e
Crée une mappe de configuration à partir d'un fichier contenant une ou plusieurs lignes correspondant au format KEY=VALUE. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Chaque ligne du fichier spécifié est ajoutée en tant que paire clé-valeur. Toutes les lignes du fichier indiqué qui sont vides ou commencent par #sont ignorées. Cette valeur est obligatoire si --from-literal ou --from-file n'est pas spécifié.
--from-file, -f

Permet de créer une mappe de configuration depuis un fichier. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Cette valeur est obligatoire si --from-literal ou --from-env-file n'est pas spécifié.

--from-literal, -l

Permet de créer une mappe de configuration depuis une paire clé-valeur. Le format requis est KEY=VALUE. Cette valeur est obligatoire si --from-file ou --from-env-file n'est pas spécifié. Cette option peut être spécifiée plusieurs fois.

--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

L'exemple illustré ci-après crée une mappe de configuration nommée configmap-fromliteral avec deux valeurs de paire de clés : color=blue et size=large.

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

Exemple de sortie

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

Exemple de mappe de configuration avec des valeurs provenant de plusieurs fichiers

L'exemple illustré ci-après crée une mappe de configuration nommée configmap-fromfile avec des valeurs provenant de plusieurs fichiers.

ibmcloud ce configmap create --name configmap-fromfile  --from-file ./color.txt --from-file ./size.txt
Exemple de sortie d'une mappe de configuration avec des valeurs provenant de plusieurs fichiers
Creating configmap 'configmap-fromfile'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromfile' to see more details.

ibmcloud ce configmap delete

Permet de supprimer une mappe de configuration.

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

Options de commande

--name, -n
Nom de la mappe de configuration. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

Deleting Configmap 'configmap-fromliteral'...
OK

ibmcloud ce configmap get

Permet d'afficher les détails d'une mappe de configuration.

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

Options de commande

--name, -n
Nom de la mappe de configuration. Cette valeur est obligatoire.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce configmap get --name configmap-fromliteral

Exemple de sortie

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

Permet de répertorier toutes les mappes de configuration d'un projet.

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

Options de commande

--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce configmap list

Exemple de sortie

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

ibmcloud ce configmap update

Permet de mettre à jour une mappe de configuration.

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]

Options de commande

--name, -n
Nom de la mappe de configuration. Cette valeur est obligatoire.
--from-env-file, -e
Met à jour une mappe de configuration à partir d'un fichier contenant une ou plusieurs lignes correspondant au format KEY=VALUE. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Chaque ligne du fichier spécifié est ajoutée en tant que paire clé-valeur. Toutes les lignes du fichier indiqué qui sont vides ou commencent par #sont ignorées. Cette valeur est obligatoire si --from-literal ou --from-file n'est pas spécifié. Cette option peut être spécifiée plusieurs fois.
--from-file, -f
Permet de mettre à jour une mappe de configuration à partir d'un fichier. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Cette valeur est obligatoire si --from-literal ou --from-env-file n'est pas spécifié. Cette option peut être spécifiée plusieurs fois.
--from-literal, -l
Permet de mettre à jour une mappe de configuration à partir d'une paire clé-valeur. Le format requis est KEY=VALUE. Cette valeur est obligatoire si --from-file ou --from-env-file n'est pas spécifié. Cette option peut être spécifiée plusieurs fois.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--rm
Permet de retirer une paire clé-valeur individuelle d'une mappe de configuration en spécifiant le nom de la clé. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.

Exemple

L'exemple illustré ci-après met à jour une mappe de configuration nommée configmap-fromliteral avec une paire de valeurs de nom d'utilisateur et de mot de passe.

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

Exemple de sortie

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

Exemple de mappe de configuration avec des valeurs d'un fichier

L'exemple illustré ci-après met à jour une mappe de configuration nommée configmap-fromfile avec des valeurs provenant d'un fichier.

ibmcloud ce configmap update --name configmap-fromfile  --from-file ./username.txt --from-file ./password.txt
Exemple de sortie d'une mappe de configuration avec des valeurs d'un fichier
Updating configmap 'configmap-fromfile'...
OK
Run 'ibmcloud ce configmap get -n configmap-fromfile' to see more details.

Commandes de connectivité

La fonction de connectivité de IBM Cloud® Code Engine permet de configurer divers aspects de la connectivité réseau des charges de travail dans votre projet Code Engine.

  • Définir les points d'extrémité accessibles en spécifiant les plages d'adresses IP de destination autorisées pour les connexions sortantes
  • Se connecter à IBM Cloud VPC Private Path services.
  • Définir les références des pools de sous-réseaux VPC, y compris les groupes de sécurité, pour configurer l'emplacement du réseau de vos travailleurs de la flotte Code Engine.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes connectivity.

Vous pouvez utiliser soit connectivityouconn dans vos commandesconnectivity. Pour afficher l'aide de l'interface de ligne de commande relative aux commandes connectivity, exécutez la commande ibmcloud ce connectivity -h.

ibmcloud ce connectivity outbound

La fonction de connexions sortantes de IBM Cloud® Code Engine permet de définir des points d'extrémité accessibles pour vos projets Code Engine.

  • Utiliser les plages d'adresses IP de destination autorisées pour les connexions sortantes en notation CIDR.
  • Connectez votre projet Code Engine avec IBM Cloud VPC Services de chemins privés en utilisant la console Code Engine ou le CLI.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes connectivity outbound.

Pour plus d'informations sur l'utilisation des commandes de connectivité sortante, voir Travailler avec la connectivité sortante en Code Engine.

Vous pouvez utiliser soit connectivity outboundouconn outbound dans vos commandesconnectivity outbound. Pour afficher l'aide de l'interface de ligne de commande relative aux commandes connectivity outbound, exécutez la commande ibmcloud ce connectivity outbound -h.

ibmcloud ce connectivity outbound COMMAND

ibmcloud ce connectivity outbound create

Créer une destination de sortie autorisée.

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]

Options de commande

--n, --cidr-name, --name
Obligatoire. Nom de la destination autorisée pour la sortie. Cette valeur est obligatoire.
--cidr, -c
Indiquez une plage d'adresses IP valide au format CIDR (par exemple 1.2.3.0/24). Cette valeur est facultative.
--force, -f
Forcer la création sans confirmation. Cette valeur est facultative. La valeur par défaut est false.
--format, --fo
Format de la destination autorisée pour les envois sortants. Les valeurs valables sont [cidr, cidr_block, pps, private_path_gateway_service]. Si elle n'est pas spécifiée, la valeur par défaut est cidr. Cette valeur est facultative. La valeur par défaut est cidr_block.
--pps-crn, --private-path-service-crn
Indiquez le nom CRN du service de chemin privé cible pour établir la connexion. Cette valeur est facultative.
--pps-isolation-policy, --pip
La politique d'isolement de la connexion de chemin privé. Les valeurs valides sont : [dedicated, shared]. Si aucune valeur n'est spécifiée, la valeur par défaut est « shared ». Cette valeur est facultative. La valeur par défaut est shared.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

Exemple de création d'une connexion sortante sur un chemin privé

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

Exemple de sortie pour créer une connexion sortante sur un chemin privé

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

Supprimer une destination de sortie autorisée.

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

Options de commande

--n, --cidr-name, --name
Obligatoire. Nom de la destination autorisée pour la sortie. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

Afficher les détails d'une destination autorisée pour les sorties.

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

Options de commande

--n, --cidr-name, --name
Obligatoire. Nom de la destination autorisée pour la sortie. Cette valeur est obligatoire.
--output, -o
Format de sortie. Les valeurs autorisées sont « json », « yaml », « jsonpath=JSONPATH_EXPRESSION » et « jsonpath-as-json=JSONPATH_EXPRESSION ». Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

Exemple d'obtention d'une connexion sortante sur un chemin privé

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

Exemple de sortie pour obtenir une connexion sortante sur un chemin privé

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

Lister toutes les destinations sortantes autorisées.

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

Options de commande

--format
Limitez l'affichage des destinations sortantes autorisées au format spécifié. Indiquez un ou plusieurs formats dans une liste, séparés par une virgule. Les valeurs valables sont [cidr, cidr_block, pps, private_path_gateway_service]. Cette valeur est facultatif. La valeur par défaut est cidr_block,private_path_service_gateway.
--output, -o
Format de sortie. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce connectivity outbound list

Exemple de sortie

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

Mettre à jour une destination de sortie autorisée.

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

Options de commande

--n, --cidr-name, --name
Obligatoire. Nom de la destination autorisée pour la sortie. Cette valeur est obligatoire.
--cidr, -c
Indiquez une plage d'adresses IP valide au format CIDR (par exemple 1.2.3.0/24). Cette valeur est facultative.
--force, -f
Forcer la mise à jour sans confirmation. Cette valeur est facultative. La valeur par défaut est false.
--pps-isolation-policy, --pip
La politique d'isolement de la connexion de chemin privé. Les valeurs valides sont : [dedicated, shared]. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

ibmcloud ce connectivity subnetpool

La fonctionnalité IBM Cloud® Code Engine subnet pool connections prend en charge la gestion des références des pools de sous-réseaux VPC, y compris les groupes de sécurité. Les flottes sont toujours connectées à un VPC, et un pool de sous-réseaux peut être référencé lors de la création d'une flotte pour spécifier dans quelle zone du réseau les travailleurs de la flotte Code Engine sont déployés. Vous créez un pool de sous-réseaux pour spécifier les sous-réseaux VPC et les zones de disponibilité où votre charge de travail sera traitée. Par exemple, vous pouvez créer un pool de sous-réseaux avec un seul sous-réseau dans la zone eu-de-1 ou un pool de sous-réseaux avec plusieurs sous-réseaux pour couvrir les trois zones dans eu-de. En outre, vous pouvez spécifier le groupe de sécurité auquel votre charge de travail doit être rattachée.

IBM Cloud® Virtual Private Cloud (VPC) est un réseau virtuel qui est lié à votre compte client. Il vous offre une sécurité cloud, avec la possibilité d'évoluer de manière dynamique, en fournissant un contrôle fin de votre infrastructure virtuelle et de la segmentation de votre trafic réseau. Les sous-réseaux de votre VPC offrent une connectivité privée. Les sous-réseaux de votre VPC peuvent se connecter à Internet public via une passerelle publique facultative. Vous pouvez assurer la sécurité de votre VPC et de vos charges de travail en contrôlant le trafic réseau à l'aide de groupes de sécurité. Voir À propos du réseau et de la sécurité dans votre VPC pour plus d'informations.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes connectivity subnetpool.

Pour plus d'informations sur l'utilisation des commandes de connectivité de subnetpool, voir Travailler avec la connectivité de subnetpool sur Code Engine.

Vous pouvez utiliser soit connectivityouconn dans vos commandesconnectivity subnetpool. Pour obtenir l'aide du CLI pour les commandes connectivity subnetpool, exécutez ibmcloud ce connectivity subnetpool -h.

ibmcloud ce connectivity subnetpool COMMAND

ibmcloud ce connectivity subnetpool create

Créer un pool de sous-réseaux.

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

Options de commande

--name, -n
Obligatoire. Nom du pool de sous-réseaux. Utilisez un nom unique dans le projet. Cette valeur est obligatoire.
--subnet-crn, --crn
Indiquez un nom CRN valide de sous-réseau pour le pool. Doit être au format S1=crn:v1:example Cette valeur est obligatoire.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--security-group-crn, --sg-crn
Indiquez un nom CRN de groupe de sécurité valide pour le pool. Cette valeur est facultative.

Exemple

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

Exemple de sortie

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

ibmcloud ce connectivity subnetpool delete

Supprimer un pool de sous-réseaux.

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

Options de commande

--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--id
ID du pool de sous-réseaux. Cette valeur est facultative.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--name, -n
Nom du pool de sous-réseaux. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

Afficher les détails d'un pool de sous-réseaux.

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

Options de commande

--id
ID du pool de sous-réseaux. Cette valeur est facultative.
--name, -n
Nom du pool de sous-réseaux. Cette valeur est facultative.
--output, -o
Format de sortie. Les valeurs autorisées sont « json », « yaml », « jsonpath=JSONPATH_EXPRESSION » et « jsonpath-as-json=JSONPATH_EXPRESSION ». Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

Répertorier tous les pools de sous-réseaux d'un projet.

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

Options de commande

--output, -o
Format de sortie. Les valeurs autorisées sont « json », « yaml », « jsonpath=JSONPATH_EXPRESSION » et « jsonpath-as-json=JSONPATH_EXPRESSION ». Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont « nom » et « âge ». Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce connectivity subnetpool list

Exemple de sortie

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

Commandes de mappage de domaines

Les mappages de domaines permettent d'accéder via URL aux applications et fonctions de votre projet Code Engine. Avec Code Engine, ces mappages sont créés automatiquement, par défaut, chaque fois que vous déployez une application ou créez une fonction. Cependant, vous pouvez associer votre propre domaine personnalisé à une application ou une fonction Code Engine afin de rediriger les requêtes provenant de votre domaine personnalisé URL vers votre application ou votre fonction à l'aide de Code Engine. Utilisez les commandes « domainmapping » pour créer, afficher les détails, mettre à jour et supprimer des mappages de domaine.

Lorsque vous définissez un mappage de domaine personnalisé dans Code Engine, vous définissez un mappage 1-to-1 entre votre nom de domaine entièrement qualifié (FQDN) et une application Code Engine dans votre projet. Pour configurer et utiliser les mappages de domaines personnalisés dans le CLI, utilisez les commandes domainmapping.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes domainmapping.

Pour plus d'informations sur l'utilisation des mappages de domaines, voir Configurer des mappages de domaines personnalisés pour votre application.

Vous pouvez utiliser soit domainmappingoudm dans vos commandesdomainmapping. Pour afficher l'aide de l'interface de ligne de commande relative aux commandes domainmapping, exécutez la commande ibmcloud ce domainmapping -h.

ibmcloud ce domainmapping create

Créez un mappage de domaine personnalisé.

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

Options de commande

--domain-name, --dn, -n, --name
Spécifiez le nom du mappage de domaine. Ce nom doit être un nom de domaine complet valide. Par exemple, www.example.com. Cette valeur est obligatoire.
--target, -t
Nom de l'application ou de la fonction cible. Cette valeur est obligatoire.
--target-type, --type
Type de la cible. Les valeurs valides sont application ou function. Cette valeur est obligatoire.
--tls-secret, --secret, --tls
Indiquez un secret de type « TLS » contenant le certificat, y compris tous ses certificats intermédiaires, ainsi que la clé privée correspondante pour le mappage de domaine. Le certificat doit être signé par une autorité de certification publique digne de confiance. Les certificats autosignés ne sont pas pris en charge. Cette valeur est obligatoire.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

L'exemple suivant crée un mappage de domaine personnalisé entre l'application Code Engine myapp et le domaine personnalisé www.example.com et utilise le secret TLS, mytlssecret.

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

Exemple de sortie

OK
Domain mapping successfully created.

ibmcloud ce domainmapping delete

Supprimez un mappage de domaine personnalisé.

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

Options de commande

--domain-name, --dn, -n, --name
Nom du mappage de domaine. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

ibmcloud ce domainmapping get

Afficher les détails d'un mappage de domaine personnalisé.

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

Options de commande

--domain-name, --dn, -n, --name
Le nom du mappage de domaine Cette valeur est obligatoire.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

Répertorier les mappages de domaine dans un projet.

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

Options de commande

--all, -a
Affichez tous les mappages de domaine dans un projet, y compris les mappages de domaine système et personnalisés. Cette valeur est facultative. La valeur par défaut est false.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

L'exemple suivant affiche une liste de tous les mappages de domaines personnalisés.

ibmcloud ce domainmapping list

Exemple de sortie

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    

Pour afficher une liste de tous les mappages de domaines pour vos applications, y compris les mappages de domaines personnalisés et les mappages de domaines générés automatiquement par le système, spécifiez l'option --all avec la commande ibmcloud ce domainmapping list avec la commande

ibmcloud ce domainmapping update

Mettez à jour un mappage de domaine personnalisé.

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

Options de commande

--domain-name, --dn, -n, --name
Nom du mappage de domaine. Cette valeur est obligatoire.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--target, -t
Nom de l'application ou de la fonction cible. Cette valeur est facultative.
--target-type, --type
Type de la cible. Les valeurs valides sont application ou function. Cette valeur est facultative.
--tls-secret, --secret, --tls
Indiquez un secret de type « TLS » contenant le certificat, y compris tous ses certificats intermédiaires, ainsi que la clé privée correspondante pour le mappage de domaine. Le certificat doit être signé par une autorité de certification publique digne de confiance. Les certificats autosignés ne sont pas pris en charge. Cette valeur est facultative.

Exemple

L'exemple suivant met à jour le mappage du domaine www.example.com pour utiliser mytlssecret2 au lieu de mytlssecret.

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

Exemple de sortie

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

Commande expérimentale

Code Engine les commandes expérimentales ne sont pas généralement disponibles. Ce groupe de commande permet d'accéder à des fonctionnalités futures potentielles pour faciliter leur exploration par des utilisateurs précoces sélectionnés.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes experimental.

Vous pouvez utiliser soit experimentalouexp dans vos commandesexperimental. Pour afficher l'aide de l'interface de ligne de commande relative aux commandes experimental, exécutez la commande ibmcloud ce exp -h.

ibmcloud ce experimental

Code Engine les commandes expérimentales ne sont pas généralement disponibles. Ce groupe de commande permet d'accéder à des fonctionnalités futures potentielles pour faciliter leur exploration par des utilisateurs précoces sélectionnés.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes experimental.

Vous pouvez utiliser soit experimentalouexp dans vos commandesexperimental. Pour afficher l'aide de l'interface de ligne de commande relative aux commandes experimental, exécutez la commande ibmcloud ce exp -h.

ibmcloud ce experimental COMMAND

Exemple

ibmcloud ce experimental help

Exemple de sortie

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.

Commandement de la flotte

Gérer les flottes sans serveur.

ibmcloud ce fleet cancel

Supprimer une flotte sans serveur.

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

Options de commande

--id, --fid, --fleet-id
Obligatoire. L’ID de la flotte serveur. Cette valeur est obligatoire.
--force, -f
Forcer l’annulation sans confirmation. Cette valeur est facultative. La valeur par défaut est false.
--hard
Annulez immédiatement la flotte sans serveur, y compris les tâches dont l'état est « running ». Si vous ne spécifiez pas l'option « hard », le traitement des tâches en état « running » se poursuit jusqu'à ce qu'elles atteignent un état final, et ce n'est qu'à ce moment-là que la flotte passe à l'état « canceled ». Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

Lancer une flotte sans serveur.

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]

Options de commande

--image, -i
Obligatoire. Nom de l’image de conteneur utilisée pour traiter les tâches. Le format est REGISTRY/NAMESPACE/REPOSITORY:TAG, où REGISTRY et TAG sont facultatifs. Si REGISTRY n'est pas spécifié, la valeur par défaut est docker.io. Si TAG n'est pas spécifié, la valeur par défaut est latest. Cette valeur est obligatoire.
--tasks-state-store, --ts-state
Obligatoire. Indiquez le magasin de données persistantes qui conserve l'état des tâches de la flotte. Cette valeur est obligatoire.
--argument, --arg, -a
Définir les arguments nécessaires à l'exécution de la commande dans la tâche. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--command, --cmd, -c
Définir une commande à exécuter dans la tâche. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--cpu, --cp
Quantité d'UC à définir pour une tâche. Cette valeur est facultative. La valeur par défaut est 1.
--env, -e
Définir les variables d'environnement à transmettre à la tâche. Doit être au format NAME=VALUE. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--env-from-configmap, --env-cm
Définissez les variables d'environnement à partir des paires clé-valeur stockées dans ce ConfigMap. Entrez NAME pour faire référence à la mappe de configuration complète, ou PREFIX=NAME pour faire référence à la mappe de configuration complète dans laquelle chaque clé est préfixée avec PREFIX, ou NAME:KEY_A,KEY_B pour faire référence à des clés individuelles. Pour spécifier un nouveau nom pour une clé référencée, utilisez le format NAME:NEW_KEY_NAME=KEY_A. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--env-from-secret, --env-sec
Définissez les variables d'environnement à partir des paires clé-valeur stockées dans ce secret. Entrez NAME pour faire référence au secret complet, ou PREFIX=NAME pour faire référence au secret complet dans lequel chaque clé est préfixée avec PREFIX, ou NAME:KEY_A,KEY_B pour faire référence à des clés individuelles. Pour spécifier un nouveau nom pour une clé référencée, utilisez le format NAME:NEW_KEY_NAME=KEY_A. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--gpu, --gp
Nombre de GPU à allouer à la ressource. Le format est GPU_FAMILY:NUMBER_OF_GPUS. La valeur par défaut de NUMBER_OF_GPUS est 1 et elle peut être une fraction. Par exemple, h100:0.5 Cette valeur est facultative.
--max-scale, --maxscale, --max
Nombre maximal d'instances de tâches à exécuter en parallèle. Cette valeur est facultative. La valeur par défaut est 1.
--maxexecutiontime, --met
Durée maximale d'exécution d'une tâche, exprimée en secondes. Cette valeur est facultative. La valeur par défaut est 0.
--memory, -m
Quantité de mémoire à définir pour une tâche. Utilisez M pour mégaoctets ou G pour gigaoctets. Cette valeur est facultative. La valeur par défaut est 2G.
--mount-data-store, --mount-ds
Montage d'un stockage de persistance des données. Le format est le suivant : MOUNT_DIRECTORY=STORAGE_NAME: [SUBPATH]. SUBPATH est facultatif. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--name, -n
Nom de la flotte. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--registry-secret, --rs
Nom du secret de registre. Le secret du registre est utilisé pour s'authentifier auprès d'un registre privé afin de télécharger l'image du conteneur. Exécutez la commande « ibmcloud ce registry create » pour créer une clé secrète dans le registre. Cette valeur est facultative.
--retrylimit, -r
Nombre de fois qu'une tâche doit être relancée avant d'être considérée comme ayant échoué. Cette valeur est facultative. La valeur par défaut est 3.
--subnetpool-id, --spi
ID du pool de sous-réseaux à utiliser pour l'attribution du réseau de la flotte. Cette valeur est facultative.
--subnetpool-name, --spn
Nom du pool de sous-réseaux à utiliser pour le placement réseau de la flotte. Cette valeur est facultative.
--task-indexes, --ti
Indiquez les index des tâches à traiter, par exemple 0,3,6,9, 1-5,7-8,10. Ne spécifiez pas plus de 1 000 entrées d’index. Cette option ne peut pas être spécifiée si l'option « --tasks » est spécifiée. Cette valeur est facultative.
--tasks, --ts
Indiquez le nombre de tâches à traiter par la flotte. Si aucune option de spécification de tâche n'est fournie, cette option est utilisée avec la valeur par défaut « 1 ».
--tasks-from-cos-bucket, --ts-bucket
Indiquer l'emplacement des fichiers à l'intérieur d'un compartiment COS. Pour chaque fichier, les tâches doivent être traitées par la flotte. Cette valeur est facultative.
--tasks-from-cos-object, --ts-cos
Indiquez l'emplacement d'un fichier JSONL qui se trouve dans un compartiment COS. Ce fichier définit les tâches qui doivent être exécutées par la flotte. Cette valeur est facultative.
--tasks-from-local-file, --ts-file
Indiquez l'emplacement d'un fichier JSONL local. Ce fichier définit les tâches qui doivent être exécutées par la flotte. Cette valeur est facultative.
--worker-profile, --profile, --prof
Indiquez une préférence pour le profil de worker pris en charge. Cette valeur est facultative.

Exemple

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

Exemple de sortie

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

Supprimer une flotte sans serveur.

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

Options de commande

--id, --fid, --fleet-id
Obligatoire. L’ID de la flotte serveur. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--wait, -w
Supprimez la flotte sans serveur et attendez que la fin de la suppression. Cette valeur est facultative. La valeur par défaut est false.
--wait-timeout, --wto
Délai d'attente en secondes pour la suppression de la flotte sans serveur. Cette valeur est facultative. La valeur par défaut est 180.

Exemple

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

Exemple de sortie

Deleting serverless fleet...
OK

ibmcloud ce fleet get

Afficher les détails d'une flotte sans serveur.

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

Options de commande

--id, --fid, --fleet-id
Obligatoire. L’ID de la flotte serveur. Cette valeur est obligatoire.
--output, -o
Format de sortie. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

Liste de toutes les flottes sans serveur d'un projet.

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

Options de commande

--output, -o
Format de sortie. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name, status et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce fleet list

Exemple de sortie

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

Gérer les tâches de la flotte sans serveur.

ibmcloud ce fleet task COMMAND [--quiet]

Options de commande

--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

ibmcloud ce fleet task get

Afficher les détails d'une tâche de flotte sans serveur.

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

Options de commande

--fleet-id, --fid
Obligatoire. L'UUID de la flotte à laquelle la tâche appartient. Cette valeur est obligatoire.
--task-id, --tid, --id
Obligatoire. L'UUID de la tâche. Cette valeur est obligatoire.
--output, -o
Format de sortie. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

Répertorier toutes les tâches d’une flotte sans serveur.

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]

Options de commande

--fleet-id, --fid
Obligatoire. L'UUID de la flotte à laquelle les tâches appartiennent. Cette valeur est obligatoire.
--output, -o
Format de sortie. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Cette valeur est facultative.
--pagination-token, --pt
Afficher la page suivante des tâches en commençant par ce jeton de pagination. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--show-all-columns, --sac
Afficher des colonnes supplémentaires : Created et Finished. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, --sb
Indique la colonne par laquelle trier la liste. Les valeurs valides sont id, index et status. Cette valeur est facultative. La valeur par défaut est index.
--status, --st
Afficher les tâches ayant le statut spécifié. Les valeurs valides sont : canceled, failed, pending, running et succeeded. Cette valeur est facultative.

Exemple

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

Exemple de sortie

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

Gérer les agents de flotte sans serveur.

ibmcloud ce fleet worker COMMAND [--quiet]

Options de commande

--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

ibmcloud ce fleet worker delete

Supprimer un travailleur de flotte sans serveur.

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

Options de commande

--fleet-id, --fid
Obligatoire. ID de la flotte du worker. Cette valeur est obligatoire.
--name, -n, --worker-name
Obligatoire. Nom du travailleur de la flotte sans serveur. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--hard
Supprimez immédiatement le worker de la flotte sans serveur. Si vous ne spécifiez pas l'option 'hard', le traitement des tâches en cours prises en charge par ce worker se poursuit jusqu'à ce que ces tâches atteignent un état final. Ce n'est qu'alors que le worker est supprimé. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--wait, -w
Supprimer le travailleur de flotte sans serveur et attendre que le travailleur soit supprimé. Cette valeur est facultative. La valeur par défaut est false.
--wait-timeout, --wto
Temps en secondes à attendre pour que le travailleur de la flotte sans serveur soit supprimé. Cette valeur est facultative. La valeur par défaut est 180.

Exemple

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

Exemple de sortie

Deleting serverless fleet worker...
OK

ibmcloud ce fleet worker get

Afficher les détails d'un travailleur de flotte sans serveur.

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

Options de commande

--fleet-id, --fid
Obligatoire. ID de la flotte du worker. Cette valeur est obligatoire.
--name, -n, --worker-name
Obligatoire. Nom du travailleur de la flotte sans serveur. Cette valeur est obligatoire.
--output, -o
Format de sortie. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

Répertorier tous les workers d'une flotte sans serveur.

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

Options de commande

--fleet-id, --fid, --id
Obligatoire. ID de la flotte du worker. Cette valeur est obligatoire.
--output, -o
Format de sortie. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et status. Cette valeur est facultative. La valeur par défaut est name.

Exemple

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

Exemple de sortie

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

Lister les profils de worker pris en charge pour les flottes sans serveur.

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

Options de commande

--output, -o
Format de sortie. Les valeurs autorisées sont « json », « yaml », « jsonpath=JSONPATH_EXPRESSION » et « jsonpath-as-json=JSONPATH_EXPRESSION ». Cette valeur est facultative.
--profile-family, --pf
Afficher les profils qui appartiennent à la famille de profils de worker spécifiée. Les valeurs valables sont [b, balanced, c, compute, m, memory, g, gpu, f, flex]. Cette valeur est facultatif.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--region, -r
Afficher les profils des workers pris en charge dans la région spécifiée. Cette valeur est facultative.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name, cpu, disket memory. Cette valeur est facultative. La valeur par défaut est name.

Exemple

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

Exemple de sortie

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  

Commandes de fonctions

Une fonction est un extrait de code sans état qui exécute des tâches au fur et à mesure qu'il est invoqué par les requêtes HTTP. Avec les fonctions IBM Code Engine, vous pouvez exécuter votre logique d'entreprise de manière évolutive et sans serveur. IBM Code Engine fournissent un environnement d'exécution optimisé pour prendre en charge les scénarios de faible latence et d'extension rapide. Votre code de fonction peut être écrit dans un runtime géré qui inclut des versions spécifiques de Node.js ou Python.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes function.

Pour plus d'informations sur l'utilisation des fonctions, voir Utilisation des fonctions.

ibmcloud ce function bind

Associer une instance du service « IBM Cloud » à une fonction.

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]

Options de commande

--name, -n
Nom de la fonction à lier. Cette valeur est obligatoire.
--no-wait, --nw
Lie l'instance de service sans attendre que la liaison de service soit prête. Si vous spécifiez l'option no-wait, la création de liaison de service démarre et la commande prend fin sans attendre la fin de l'exécution. Utilisez la commande « function get » pour vérifier l'état de la liaison de la fonction. Cette valeur est facultative. La valeur par défaut est false.
--prefix, -p
Préfixe des variables d'environnement qui sont créées pour cette liaison de service. Ne doit contenir que des lettres en majuscules, des chiffres et des traits de soulignement (_) et ne peut pas débuter par un chiffre. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--role, -r
Nom d'un rôle de service pour les nouvelles données d'identification de service créées pour cette liaison de service. Les valeurs valides sont Reader, Writer, Manager ou un rôle propre au service. L'option prend par défaut la valeur Manager ou le premier rôle fourni par le service si Manager n'est pas pris en charge. Cette option est ignorée si --service-credential est spécifié. Cette valeur est facultative.
--service-credential, --sc
Nom d'une donnée d'identification de service existante qui doit être utilisée pour cette liaison de service. Si vous ne spécifiez pas de donnée d'identification d'instance de service, de nouvelles données d'identification sont générées lors de l'action de liaison. Cette valeur est facultative.
--service-instance, --si
Nom d'une instance existante du service « IBM Cloud » à associer à la fonction. Cette valeur est facultative.
--service-instance-id, --siid
Le GUID d'une instance existante du service « IBM Cloud » à associer à la fonction. Cette valeur est facultative.
--wait, -w
Permet de lier l'instance de service et d'attendre que la liaison de service soit prête. Si vous spécifiez l'option « --wait », la fonction « bind » attend pendant une durée maximale en secondes, définie par l'option « --wait-timeout », que la fonction « bind » s'exécute correctement. Si la fonction « bind » ne s'effectue pas correctement ou échoue dans le délai spécifié ( --wait-timeout ), la commande échoue. Cette valeur est facultative. La valeur par défaut est true.
--wait-timeout, --wto
Délai d'attente en secondes avant que la liaison de service soit prête. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 300.

Exemple

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

Exemple de sortie

Binding service instance...
Status: Done
OK

ibmcloud ce function create

Créez une fonction.

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]

Options de commande

-n, --name

Nom de la fonction. Utilisez un nom unique dans le projet.

  • Le nom doit débuter par une lettre en minuscule.
  • Le nom doit se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 63 caractères au maximum et peut contenir des lettres minuscules, des chiffres et des tirets (-).

Cette valeur est obligatoire.

--runtime, -r
La durée d'exécution à utiliser pour la fonction. Pour connaître les durées d'exécution prises en charge pour cette région, exécutez ibmcloud ce function runtimes. Voir Délais d'exécution. Cette valeur est obligatoire.
--build-commit, --commit, --bcm, --cm, --revision

Validation, balise ou branche du référentiel source à extraire. Cette valeur est facultative.

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

Répertoire dans le référentiel qui contient le code source de votre fonction. Cette valeur est facultative.

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

Nom du secret SSH, qui contient les données d'identification permettant d'accéder au référentiel privé contenant le code source pour la génération de votre image de bundle de code. Pour créer ce secret SSH, utilisez la commande secret create --format SSH. Un secret SSH est également utilisé comme secret d'accès au référentiel Git. Cette option n'est autorisée que si l'option --build-source est définie sur URL d'un référentiel Git. Cette valeur est facultative.

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

L'URL du référentiel Git ou le chemin d'accès à la source locale qui contient votre code source ; par exemple, https://github.com/IBM/CodeEngine ou.. Cette valeur est facultative.

--build-timeout, --bto

Délai en secondes avant la réussite ou l'échec de la génération. Cette valeur est facultative. La valeur par défaut est 600.

--code-bundle, --cb

Le nom de l'image code-bundle à utiliser pour cette fonction. Lorsque l'option « build-source » est spécifiée, cette valeur correspond au chemin d'accès à l'image de sortie générée par la publication de la version. Lorsque l' build-source n'est pas spécifiée, cette valeur correspond au chemin d'accès à l'image du bundle de code existant. Le format est REGISTRY/NAMESPACE/REPOSITORY:TAG, où TAG est facultatif. Si TAG n'est pas spécifié, la valeur par défaut est latest. Cette valeur est facultative.

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

Nom du secret de registre utilisé pour l'authentification auprès d'un registre privé. Vous pouvez ajouter la clé de registre en exécutant la commande « registry create ». Cette valeur est facultative.

--cpu

Nombre d'unités centrales défini pour l'instance de la fonction. Pour connaître les valeurs valides, consultez la section « Combinaisons de mémoire et de processeurs prises en charge ». Cette valeur est facultative. La valeur par défaut est 1.

--env, -e

Définir des variables d'environnement dans la fonction. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle variable d'environnement ou de remplacer une variable d'environnement existante. Spécifiez une variable d'environnement par option --env ; par exemple, --env envA=A --env envB=B. Cette valeur est facultative.

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

Définissez les variables d'environnement à partir des paires clé-valeur stockées dans ce ConfigMap en utilisant l'une des méthodes suivantes.

  • Afin d'ajouter des variables d'environnement pour toutes les clés d'une mappe de configuration nommée configmapName, utilisez la valeur configmapName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement de la mappe de configuration. Pour spécifier un préfixe, utilisez la valeurPREFIX=CONFIGMAP_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans la mappe de configurationconfigmapName enCUSTOM_, utilisez la valeurCUSTOM_=configmapName. Si la mappe de configuration configmapName contient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, afin d'ajouter une variable d'environnement pour une clé key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:myKey=key1.

Cette valeur est facultative.

--env-sec, --env-from-secret
Définissez les variables d'environnement à partir des paires clé-valeur stockées dans un secret en utilisant l'une des méthodes suivantes.
  • Afin d'ajouter des variables d'environnement pour toutes les clés d'un secret nommé secretName, utilisez la valeur secretName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement du secret. Pour spécifier un préfixe, utilisez la valeurPREFIX=SECRET_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_SECRET>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans le secretsecretName vers CUSTOM_, utilisez la valeurCUSTOM_=secretName. Si le secret secretNamecontient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, pour ajouter une variable d'environnement pour une clé uniquekey1 dans un secret nommésecretName, utilisez la valeursecretName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans un secret nommé secretName, utilisez la valeur secretName:myKey=key1.

Cette valeur est facultative.

--force, -f
Ne pas vérifier l'existence des références de mappe de configuration et de secret spécifiées. Cette valeur est facultative. La valeur par défaut est false.
--inline-code

Indiquez le chemin d'accès au fichier contenant le code source de votre fonction. Le code est intégré à la fonction. Cette valeur est facultative.

--main, --fn-main

Spécifiez le nom de votre fonction principale dans le code source fourni. Cette option est requise lorsque le nom n'est pas main. Cette valeur est facultative. La valeur par défaut est main.

--maxexecutiontime, --met

Durée maximale, en secondes, pendant laquelle cette fonction doit terminer son exécution. Cette valeur est facultative. La valeur par défaut est 60.

--memory, -m

La quantité de mémoire allouée à la fonction. Utilisez M pour mégaoctets ou G pour gigaoctets. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative. La valeur par défaut est 4G.

--no-wait, --nw

N'attendez pas la fin de l'exécution de la génération. Cette valeur est facultative. La valeur par défaut est false.

--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--scale-down-delay, --sdd

Durée, en secondes, pendant laquelle une instance est active à la fin d'un appel. Cette option peut réduire les temps de démarrage à froid. Pour plus d'informations, voir Peut-on maintenir mon instance de fonction en vie plus longtemps? Cette valeur est facultative. La valeur par défaut est 1.

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

Activer le montage d'un jeton de ressource de calcul pour les exécutions de la fonction. Cette valeur est facultative. La valeur par défaut est false.

--visibility, -v

Visibilité de la fonction. Les valeurs valides sont : public, private et project. La visibilité ne peut être « private » que si le projet prend en charge la visibilité « private » des fonctions. Cette valeur est facultative. La valeur par défaut est public.

--wait, -w

Attendez la fin de l'exécution de la génération. Cette valeur est facultative. La valeur par défaut est true.

--wait-timeout, --wto

Durée d'attente, en secondes, jusqu'à ce que la fonction soit prête. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 600.

Exemple

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

Exemple de sortie

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

Lorsque vous exécutez la commande « ibmcloud ce fn get -n 'myfunction' » pour vérifier l'état de la fonction, la page « URL » correspondant à votre fonction s'affiche.

ibmcloud ce function delete

Supprimez une fonction.

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

Options de commande

--name, -n
Nom de la fonction. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce fn delete --name myfunction

Exemple de sortie

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

ibmcloud ce function get

Affichez les détails d'une fonction.

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

Options de commande

--name, -n
Nom de la fonction. Cette valeur est obligatoire.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--save, -s
Enregistrez le code source de la fonction sur le système de fichiers local. Cette option n'est prise en charge que pour les fonctions créées avec du code en ligne. Cette valeur est facultative.

Exemple

ibmcloud ce fn get --name myfunction

Exemple de sortie

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

Répertoriez toutes les fonctions d'un projet.

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

Options de commande

--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce fn delete --name myfunction

Exemple de sortie

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

Répertoriez les environnements d'exécution de fonction disponibles.

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

Options de commande

--all, -A
Afficher tous les environnements d'exécution, y compris ceux qui ont été dépréciés. Cette valeur est facultative. La valeur par défaut est false.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce fn runtimes

Exemple de sortie

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

Désassocier les instances du service « IBM Cloud » d'une fonction.

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

Options de commande

--name, -n
Nom de la fonction pour laquelle vous souhaitez annuler la liaison. Cette valeur est obligatoire.
--all, -A
Annule la liaison de toutes les instances de service pour cette fonction. Cette valeur est obligatoire si --binding n'est pas spécifié. La valeur par défaut est false.
--binding, -b
Nom de la liaison à annuler. Exécutez ibmcloud ce function get -n FUNCTION_NAME pour afficher les noms de liaison. Cette valeur est obligatoire si --all n'est pas spécifié.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce fn unbind --name myfunction --all

Exemple de sortie

Removing bindings from 'myfunction'...
OK

ibmcloud ce function update

Mettez à jour une fonction.

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]

Options de commande

--name, -n

Obligatoire. Nom de la fonction. Cette valeur est obligatoire.

--build-clear, --bc

Retirez l'association d'une génération de cette fonction. L'option « build clear » n'est autorisée que si votre fonction est actuellement associée à une compilation. Cette valeur est facultative. La valeur par défaut est false.

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

Validation, balise ou branche du référentiel source à extraire. Cette valeur est facultative.

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

Effacer la validation, la balise ou la branche dans le référentiel source pour l'extraction. L'option "commit clear" n'est autorisée que si votre fonction a une version associée. Cette valeur est facultative. La valeur par défaut est false.

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

Répertoire dans le référentiel qui contient le code source de votre fonction. Cette option n'est autorisée que si l'option --build-source est activée. Cette valeur est facultative.

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

Nom de la clé secrète SSH contenant les identifiants nécessaires pour accéder au dépôt privé qui héberge le code source permettant de créer votre image. Cette valeur est facultative.

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

Effacer le secret SSH. Cette option n'est autorisée que si votre fonction a actuellement une construction associée. Cette valeur est facultative. La valeur par défaut est false.

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

L'URL du référentiel Git ou le chemin d'accès à la source locale qui contient votre code source ; par exemple, https://github.com/IBM/CodeEngine ou.. Cette valeur est facultative.

--build-timeout, --bto

Délai en secondes avant la réussite ou l'échec de la génération. Cette valeur est facultative. La valeur par défaut est 600.

--code-bundle, --cb

Le nom de l'image code-bundle à utiliser pour cette fonction. Lorsque l'option « build-source » est spécifiée, cette valeur correspond au chemin d'accès à l'image de sortie générée par la publication de la version. Lorsque l' build-source n'est pas spécifiée, cette valeur correspond au chemin d'accès à l'image du bundle de code existant. Le format est REGISTRY/NAMESPACE/REPOSITORY:TAG, où TAG est facultatif. Si TAG n'est pas spécifié, la valeur par défaut est latest. Cette valeur est facultative.

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

Nom du secret de registre utilisé pour l'authentification auprès d'un registre privé. Vous pouvez ajouter la clé de registre en exécutant la commande « registry create ». Cette valeur est facultative.

--cpu

Nombre d'unités centrales défini pour l'instance de la fonction. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative. La valeur par défaut est 1.

--env, -e

Définir des variables d'environnement dans la fonction. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle variable d'environnement ou de remplacer une variable d'environnement existante. Spécifiez une variable d'environnement par option --env ; par exemple, --env envA=A --env envB=B. Cette valeur est facultative.

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

Définissez les variables d'environnement à partir des paires clé-valeur qui sont stockées dans cette mappe de configuration en utilisant l'une des méthodes suivantes :

  • Afin d'ajouter des variables d'environnement pour toutes les clés d'une mappe de configuration nommée configmapName, utilisez la valeur configmapName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement de la mappe de configuration. Pour spécifier un préfixe, utilisez la valeurPREFIX=CONFIGMAP_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans la mappe de configurationconfigmapName enCUSTOM_, utilisez la valeurCUSTOM_=configmapName. Si la mappe de configuration configmapName contient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, afin d'ajouter une variable d'environnement pour une clé key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:myKey=key1.

Cette valeur est facultative.

--env-from-configmap-rm, --env-cm-rm
Permet de retirer des références de variable d'environnement à des mappes de configuration complètes en utilisant le nom de la mappe de configuration. Pour retirer des références de clé individuelles à des mappes de configuration, utilisez l'option --env-rm. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--env-sec, --env-from-secret

Définissez les variables d'environnement à partir des paires clé-valeur stockées dans un secret en utilisant l'une des méthodes suivantes :

  • Afin d'ajouter des variables d'environnement pour toutes les clés d'un secret nommé secretName, utilisez la valeur secretName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement du secret. Pour spécifier un préfixe, utilisez la valeurPREFIX=SECRET_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_SECRET>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans le secretsecretName vers CUSTOM_, utilisez la valeurCUSTOM_=secretName. Si le secret secretNamecontient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, pour ajouter une variable d'environnement pour une clé uniquekey1 dans un secret nommésecretName, utilisez la valeursecretName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans un secret nommé secretName, utilisez la valeur secretName:myKey=key1.

Cette valeur est facultative.

--env-from-secret-rm, --env-sec-rm
Permet de retirer des références de variable d'environnement à des secrets intégraux en utilisant le nom de secret. Pour retirer des références de clé individuelles à des secrets, utilisez l'option --env-rm. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--env-rm

Permet de retirer des références de variable d'environnement à la clé d'une paire clé-valeur dans une mappe de configuration ou un secret. Pour retirer des références de clé individuelles et des valeurs littérales, spécifiez le nom de la clé. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.

--force, -f

Ne pas vérifier l'existence des références de mappe de configuration et de secret spécifiées. Les références de mappe de configuration sont spécifiées avec les options --env-from-configmap ou --mount-configmap. Les références de secret sont spécifiées avec l'option --env-from-secret, --mount-secret ou --registry-secret. Cette valeur est facultative. La valeur par défaut est false.

--inline-code

Spécifiez le chemin d'accès à un fichier contenant le code source de votre fonction. Le code est intégré à la fonction. Cette valeur est facultative.

--main, --fn-main

Spécifiez le nom de votre fonction principale dans le code source fourni. Cette option est requise lorsque le nom n'est pas main. Cette valeur est facultative. La valeur par défaut est main.

--maxexecutiontime, --met

Durée maximale d'exécution, en secondes, pour que cette fonction termine son exécution. Cette valeur est facultative. La valeur par défaut est 60.

--memory, -m

La quantité de mémoire allouée à la fonction. Utilisez M pour mégaoctets ou G pour gigaoctets. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative. La valeur par défaut est 4G.

--no-wait, --nw

Permet de soumettre l'exécution de génération et de ne pas attendre qu'elle soit terminée. Si vous spécifiez l'option --no-wait, la soumission de l'exécution de génération démarre, sans attendre. Utilisez la commande buildrun get pour vérifier le statut de l'exécution de génération. Cette valeur est facultative. La valeur par défaut est false.

--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--rebuild

Recompiler l'image à partir du code source. L'option de reconstruction n'est autorisée que si votre fonction dispose actuellement d'une version associée. Cette valeur est facultative. La valeur par défaut est false.

--runtime, -r

La durée d'exécution à utiliser pour la fonction. Pour connaître les durées d'exécution prises en charge pour cette région, exécutez ibmcloud ce function runtimes. Voir Délais d'exécution. Cette valeur est facultative.

--scale-down-delay, --sdd

Durée, en secondes, pendant laquelle une instance est active à la fin d'un appel. Cette option peut réduire les temps de démarrage à froid. Pour plus d'informations, voir Peut-on maintenir mon instance de fonction en vie plus longtemps? Cette valeur est facultative. La valeur par défaut est 1.

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

Activer le montage d'un jeton de ressource de calcul pour les exécutions de la fonction. Cette valeur est facultative. La valeur par défaut est false.

--visibility, -v

Visibilité de la fonction. Les valeurs valides sont : public, private et project. La visibilité ne peut être « private » que si le projet prend en charge la visibilité « private » des fonctions. Cette valeur est facultative.

--wait, -w

Attendez la fin de l'exécution de la génération. Cette valeur est facultative. La valeur par défaut est true.

--wait-timeout, --wto

Durée d'attente, en secondes, jusqu'à ce que la fonction soit prête. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 600.

Exemple

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

Exemple de sortie

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

Lorsque vous exécutez la commande « ibmcloud ce fn get -n 'myfunction' » pour vérifier l'état de la fonction, la page « URL » correspondant à votre fonction s'affiche.

help, commande

La commande Code Engine help fournit des informations sur les commandes disponibles par groupe de commandes.

ibmcloud ce help

La commande Code Engine help fournit des informations sur les commandes disponibles par groupe de commandes.

ibmcloud ce help COMMAND

Exemple

ibmcloud ce help

Exemple de sortie

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.

Commandes de travail

Une tâche exécute en parallèle une ou plusieurs instances de votre code exécutable. Contrairement aux applications qui gèrent les demandes HTTP, les travaux sont conçus pour s'exécuter une seule fois et prendre fin. Lorsque vous créez un travail, vous pouvez spécifier les informations de configuration de charge de travail qui sont utilisées à chaque fois que le travail est exécuté. Les commandes job vous permettent de créer une configuration pour votre travail.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes job.

Pour plus d'informations sur l'utilisation de travaux, reportez-vous à la rubrique décrivant l'exécution de travaux.

Pour consulter l'aide de l'interface en ligne de commande (CLI) relative aux commandes « job », exécutez la commande « ibmcloud ce job -h ».

ibmcloud ce job bind

Liaison d'une instance de service IBM Cloud à un travail.

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]

Options de commande

--name, -n
Nom du travail à lier. Cette valeur est obligatoire.
--no-wait, --nw
Lie l'instance de service sans attendre que la liaison de service soit prête. Si vous spécifiez l'option --no-wait, la création de liaison de service démarre et la commande prend fin sans attendre la fin de l'exécution. Utilisez la commande job get pour vérifier le statut de liaison du travail. Cette valeur est facultative. La valeur par défaut est false.
--prefix, -p
Préfixe des variables d'environnement qui sont créées pour cette liaison de service. Ne doit contenir que des lettres en majuscules, des chiffres et des traits de soulignement (_) et ne peut pas débuter par un chiffre. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--role, -r
Nom d'un rôle de service pour les nouvelles données d'identification de service créées pour cette liaison de service. Les valeurs valides sont Reader, Writer, Manager ou un rôle propre au service. L'option prend par défaut la valeur Manager ou le premier rôle fourni par le service si Manager n'est pas pris en charge. Cette option est ignorée si --service-credential est spécifié. Cette valeur est facultative.
--service-credential, --sc
Nom d'une donnée d'identification de service existante qui doit être utilisée pour cette liaison de service. Si vous ne spécifiez pas de donnée d'identification d'instance de service, de nouvelles données d'identification sont générées lors de l'action de liaison. Cette valeur est facultative.
--service-instance, --si
Nom d'une instance de service IBM Cloud existante qui doit être liée au travail. Cette valeur est facultative.
--service-instance-id, --siid
L'identificateur global unique d'une instance de service IBM Cloud existante à lier au travail. Cette valeur est facultative.
--wait, -w
Permet de lier l'instance de service et d'attendre que la liaison de service soit prête. Si vous spécifiez l'option --wait, le délai d'attente maximal, en secondes, pour que la liaison de travail aboutisse est défini par l'option --wait-timeout. Si la liaison de travail ne se termine pas correctement ou échoue dans le délai --wait-timeout spécifié, la commande échoue. Cette valeur est facultative. La valeur par défaut est true.
--wait-timeout, --wto
Délai d'attente en secondes avant que la liaison de service soit prête. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 300.

Exemple

Cet exemple permet de lier une instance de service appelée my-object-storage à un travail nommé hello.

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

Exemple de sortie

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

Permet de créer un travail.

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]

Options de commande

-n, --name

Nom du travail. Utilisez un nom unique dans le projet.

  • Le nom doit débuter et se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 63 caractères au maximum et peut contenir des lettres minuscules, des chiffres et des tirets (-).

Cette valeur est obligatoire.

--argument, --arg, -a
Permet de définir des arguments pour les exécutions du travail. Spécifiez un argument par option --argument ; par exemple, -a argA -a argB. Cette valeur est facultative.
--array-indexes, --array-indices, --ai

Spécifie les indices du tableau utilisés pour les exécutions du travail, par exemple 0,3,6,9, 1-5,7-8,10. L'ensemble des résultats des index est limité à 1000 entrées. Cette option ne peut être spécifiée que si l'option « array-size » n'est pas spécifiée. Cette valeur est facultative. La valeur par défaut est 0.

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

Permet de spécifier le nombre d'instances utilisées pour les exécutions du travail. Lorsque vous utilisez cette option, le système convertit en index de tableau. Par exemple, si vous indiquez instances de 5, le système le convertit en array-indexes de 0 - 4. Cette option ne peut être spécifiée que si l'option « --array-indexes » n'est pas spécifiée. Cette valeur est facultative. La valeur par défaut est 1.

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

Validation, balise ou branche du référentiel source à extraire. L'option build commit n'est autorisée que si l'option --build-source est définie sur URL d'un dépôt Git. Cette valeur est facultative.

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

Répertoire inclus dans le référentiel qui contient le fichier de packs de construction ou le fichier Dockerfile. L'option de répertoire de contexte de construction n'est autorisée que si l'option --build-source est activée. Cette valeur est facultative.

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

Chemin d'accès au Dockerfile. Spécifiez cette option uniquement si le nom est différent de Dockerfile. L'option build dockerfile n'est autorisée que si l'option --build-source est définie. Cette valeur est facultative. La valeur par défaut est Dockerfile.

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

Nom du secret SSH, qui contient les identifiants permettant d'accéder au référentiel privé contenant le code source pour la génération de votre image de conteneur. Pour créer ce secret SSH, utilisez la commande secret create --format SSH. Un secret SSH est également utilisé comme secret d'accès au référentiel Git. Cette option n'est autorisée que si l'option --build-source est définie sur URL d'un référentiel Git. Cette valeur est facultative.

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

Taille de la génération, qui détermine la quantité de ressources utilisée. Les valeurs valides sont : small, medium, large, xlarge et xxlarge. Pour plus de détails, voir Définition de la taille de la génération. L'option "build size" n'est autorisée que si l'option " --build-source " est activée. Cette valeur est facultative. La valeur par défaut est medium.

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

L'URL du référentiel Git ou le chemin d'accès à la source locale qui contient votre code source ; par exemple, https://github.com/IBM/CodeEngine ou.. Cette valeur est facultative.

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

Stratégie à utiliser pour générer l'image. Les valeurs valides sont dockerfile et buildpacks. L'option de stratégie de construction n'est autorisée que si l'option --build-source est activée. Si aucune valeur n'est indiquée, la stratégie de compilation est déterminée par Code Engine si --build-source est spécifié et que la source se trouve sur votre ordinateur local. Cette valeur est facultative. La valeur par défaut est dockerfile.

--build-timeout, --bto

Délai en secondes avant la réussite ou l'échec de la génération. L'option build timeout n'est autorisée que si l'option --build-source est activée. Cette valeur est facultative. La valeur par défaut est 600.

--command, --cmd, -c

Permet de définir des commandes pour les exécutions du travail. Spécifiez une commande par option --command ; par exemple, --cmd cmdA --cmd cmdB. Cette valeur remplace la commande par défaut qui est spécifiée dans l'image de conteneur. Cette valeur est facultative.

--cpu

Quantité d'UC à définir pour les exécutions du travail. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative. La valeur par défaut est 1.

--env, -e

Permet de définir des variables d'environnement pour les exécutions du travail. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle variable d'environnement ou de remplacer une variable d'environnement existante. Spécifiez une variable d'environnement par option --env ; par exemple, --env envA=A --env envB=B. Cette valeur est facultative.

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

Définissez les variables d'environnement à partir des paires clé-valeur qui sont stockées dans cette mappe de configuration en utilisant l'une des méthodes suivantes :

  • Afin d'ajouter des variables d'environnement pour toutes les clés d'une mappe de configuration nommée configmapName, utilisez la valeur configmapName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement de la mappe de configuration. Pour spécifier un préfixe, utilisez la valeurPREFIX=CONFIGMAP_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans la mappe de configurationconfigmapName enCUSTOM_, utilisez la valeurCUSTOM_=configmapName. Si la mappe de configuration configmapName contient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, afin d'ajouter une variable d'environnement pour une clé key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:myKey=key1.

Cette valeur est facultative.

--env-sec, --env-from-secret
Définissez les variables d'environnement à partir des paires clé-valeur stockées dans un secret en utilisant l'une des méthodes suivantes :
  • Afin d'ajouter des variables d'environnement pour toutes les clés d'un secret nommé secretName, utilisez la valeur secretName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement du secret. Pour spécifier un préfixe, utilisez la valeurPREFIX=SECRET_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_SECRET>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans le secretsecretName vers CUSTOM_, utilisez la valeurCUSTOM_=secretName. Si le secret secretNamecontient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, pour ajouter une variable d'environnement pour une clé uniquekey1 dans un secret nommésecretName, utilisez la valeursecretName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans un secret nommé secretName, utilisez la valeur secretName:myKey=key1.

Cette valeur est facultative.

--ephemeral-storage, --es
Quantité de stockage éphémère à définir pour les exécutions du travail. Utilisez M pour mégaoctets ou G pour gigaoctets. Cette valeur est facultative. La valeur par défaut est 400M.
--force, -f

Ne pas vérifier l'existence des références de mappe de configuration et de secret spécifiées. Les références de mappe de configuration sont spécifiées avec l'option --env-from-configmap. Les références de secret sont spécifiées avec l'option --env-from-secret ou --registry-secret. Cette valeur est facultative. La valeur par défaut est false.

--image, -i

Nom de l'image qui est utilisée pour les exécutions du travail. Le format est REGISTRY/NAMESPACE/REPOSITORY:TAG, où REGISTRY et TAG sont facultatifs. Si REGISTRY n'est pas spécifié, la valeur par défaut est docker.io. Si TAG n'est pas spécifié, la valeur par défaut est latest. L'option d'image est obligatoire si l'option --build-sourcen'est pas spécifiée. Cette valeur est facultative.

--maxexecutiontime, --met

Temps d'exécution maximal, en secondes, pour les exécutions du travail. Cette option ne peut être spécifiée que si mode est task. Cette valeur est facultative. La valeur par défaut est 7200.

--memory, -m

Quantité de mémoire définie pour les exécutions du travail. Utilisez M pour mégaoctets ou G pour gigaoctets. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative. La valeur par défaut est 4G.

--mode

Mode pour les exécutions du travail. Les valeurs valides sont task et daemon. En mode « task », les options « maxexecutiontime » et « retrylimit » s'appliquent. En mode « daemon », comme il n'y a pas de délai d'expiration et que les instances défaillantes sont redémarrées indéfiniment, les options « --maxexecutiontime » et « --retrylimit » ne sont pas autorisées. Cette valeur est facultative. La valeur par défaut est « task ».

--mount-configmap, --mount-cm

Ajoutez le contenu d'une mappe de configuration au système de fichiers de l'exécution du travail en fournissant un répertoire de montage et le nom d'une mappe de configuration, sous le format MOUNT_DIRECTORY=CONFIGMAP_NAME. Chaque mappe de configuration montée doit utiliser un répertoire de montage unique. Pour chaque paire clé-valeur de la mappe de configuration, un fichier est ajouté au répertoire de montage spécifié, où le nom de fichier est la clé et le contenu du fichier, la valeur de la paire clé-valeur. Spécifiez une configuration de montage par option --mount-configmap, --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b, par exemple. Cette valeur est facultative.

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

Montage d'un stockage de persistance des données. Le format est le suivant : MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. SUBPATH est facultatif. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.

--mount-secret, --mount-sec

Ajoutez les contenus d'un secret au système de fichiers de l'exécution du travail en fournissant un répertoire de montage et le nom d'un secret, au format MOUNT_DIRECTORY=SECRET_NAME. Chaque secret monté doit utiliser un répertoire de montage unique. Pour chaque paire clé-valeur du secret, un fichier est ajouté au répertoire de montage spécifié, où le nom de fichier est la clé et le contenu du fichier, la valeur de la paire clé-valeur. Spécifiez une configuration de montage par option --mount-secret, --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b, par exemple. Cette valeur est facultative.

--no-wait, --nw

N'attendez pas la fin de l'exécution de la génération. Si vous spécifiez l'option --no-wait, l'exécution de la génération commence et n'attend pas. Utilisez la commande buildrun get pour vérifier le statut de l'exécution de génération. L'option no-wait n'est autorisée que si l'option --build-source est activée. Cette valeur est facultative. La valeur par défaut est false.

--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--registry-secret, --rs

Nom du secret de registre. Le secret de registre est utilisée pour l'authentification auprès d'un registre privé lorsque vous téléchargez l'image de conteneur. Cette valeur est facultative.

--retrylimit, -r

Nombre de réexécutions d'une instance du travail avant que celui-ci ne soit marqué comme ayant échoué. Un index de tableau d'un travail est réexécuté lorsqu'il renvoie un code d'exit différent de zéro. Cette option ne peut être spécifiée que si mode est task. Cette valeur est facultative. La valeur par défaut est 3.

--service-account, --sa

Nom du compte de service. Un compte de service fournit une identité pour les processus qui s'exécutent dans une instance. Pour les comptes de service intégrés, vous pouvez utiliser les noms raccourcis manager, none, reader et writer. Vous pouvez également utiliser les noms complets préfixés avec le Kubernetes Config Context, qui peut être déterminé à l'aide de la commande project current. Cette valeur est facultative.

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

Activer le montage d'un jeton de ressource de calcul pour les exécutions du travail. Cette valeur est facultative. La valeur par défaut est false.

--wait, -w

Attendez la fin de l'exécution de la génération. Si vous spécifiez l'option--wait, l'exécution de génération attend une durée maximale en secondes, définie par l'option--wait-timeout, pour que l'exécution de la génération soit terminée. Si l'exécution de génération n'est pas terminée dans la période--wait-timeout spécifiée, l'exécution de la génération échoue. L'option wait n'est autorisée que si l'option --build-source est activée. Cette valeur est facultative. La valeur par défaut est true.

--wait-timeout, --wto

Délai d'attente en secondes avant que cette exécution de génération soit terminée. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. L'option wait-timeout n'est autorisée que si l'option --build-source est activée. La valeur par défaut est 600.

Exemple

L'exemple suivant utilise l'image de conteneur icr.io/codeengine/firstjob et affecte 2G Mo de mémoire et 1 unité centrale au conteneur. Pour plus d'informations sur la sélection de la mémoire et de l'unité centrale, voir Combinaisons de mémoire et d'unité centrale prises en charge.

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

Exemple de sortie

Creating job 'hellojob'...
OK

ibmcloud ce job delete

Permet de supprimer un travail et les exécutions de travail qui lui sont associées.

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

Options de commande

--name, -n
Nom du travail. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--orphan-job-runs, -o
Permet d'indiquer que les exécutions de travail associées à cette configuration de travail doivent être conservées. Ces exécutions de travail orphelines doivent ensuite être supprimées séparément. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce job delete --name hello

Exemple de sortie

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

Lorsque vous exécutez la commande ibmcloud ce job delete pour supprimer un travail, toutes les exécutions de travail soumises qui font référence à ce travail sont également supprimées.

ibmcloud ce job get

Permet d'afficher les détails d'un travail.

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

Options de commande

--name, -n
Nom du travail. Cette valeur est obligatoire.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce job get --name hellojob

Exemple de sortie

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

Permet de répertorier tous les travaux d'un projet.

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

Options de commande

--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce job list

Exemple de sortie

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

Permet d'annuler la liaison d'instances de service IBM Cloud avec un travail pour retirer les liaisons de service existantes.

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

Options de commande

--name, -n
Nom du travail pour lequel vous souhaitez annuler la liaison. Cette valeur est obligatoire.
--all, -A
Permet d'annuler la liaison de toutes les instances de service avec ce travail. Cette valeur est obligatoire si --binding n'est pas spécifié. La valeur par défaut est false.
--binding, -b
Nom de la liaison à annuler. Exécutez ibmcloud ce job get -n JOB_NAME pour afficher les noms de liaison. Cette valeur est obligatoire si --all n'est pas spécifié.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

Cet exemple permet de retirer toutes les liaisons de votre travail nommé hello.

ibmcloud ce job unbind --name hello --all

Exemple de sortie

Removing service bindings...
OK

ibmcloud ce job update

Permet de mettre à jour un travail.

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]

Options de commande

--name, -n

Nom du travail. Cette valeur est obligatoire.

--argument, --arg, -a

Permet de définir des arguments pour les exécutions du travail. Spécifiez un argument par option --argument ; par exemple, -a argA -a argB. Cette valeur est facultative.

--arguments-clear, --ac

Permet d'effacer les arguments d'un travail. Cette valeur est facultative. La valeur par défaut est false.

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

Spécifie les indices du tableau utilisés pour les exécutions du travail, par exemple 0,3,6,9, 1-5,7-8,10. L'ensemble des résultats des index est limité à 1000 entrées. Cette option ne peut être spécifiée que si l'option « array-size » n'est pas spécifiée. Cette valeur est facultative.

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

Permet de spécifier le nombre d'instances utilisées pour les exécutions du travail. Lorsque vous utilisez cette option, le système convertit en index de tableau. Par exemple, si vous indiquez instances de 5, le système le convertit en array-indexes de 0 - 4. Cette option ne peut être spécifiée que si l'option « --array-indexes » n'est pas spécifiée. Cette valeur est facultative. La valeur par défaut est 0.

--build-clear, --bc

Supprimez l'association d'une génération à partir de ce travail. L'option « build clear » n'est autorisée que si votre tâche est actuellement associée à une compilation. Cette valeur est facultative. La valeur par défaut est false.

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

Validation, balise ou branche du référentiel source à extraire. L'option « build commit » n'est autorisée que si l'option « --build-source » est définie sur l' URL d'un dépôt Git via cette commande job update, ou si votre tâche est actuellement associée à une compilation provenant d'un dépôt Git. Cette valeur est facultative.

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

Effacer la validation, la balise ou la branche dans le référentiel source pour l'extraction. L'option « commit clear » n'est autorisée que si votre tâche est actuellement associée à une compilation. Cette valeur est facultative. La valeur par défaut est false.

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

Répertoire inclus dans le référentiel qui contient le fichier de packs de construction ou le fichier Dockerfile. L'option de répertoire de contexte de compilation n'est autorisée que si l'option « --build-source » est définie dans cette commande « job update », ou si votre tâche est actuellement associée à une compilation. Cette valeur est facultative.

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

Chemin d'accès au Dockerfile. Spécifiez cette option uniquement si le nom est différent de Dockerfile. L'option de génération dockerfile est autorisée si l'option --build-sourceest définie sur cette commandejob update ou si votre travail comporte actuellement une génération associée. Cette valeur est facultative. La valeur par défaut est Dockerfile.

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

Nom du secret SSH, qui contient les identifiants permettant d'accéder au référentiel privé contenant le code source pour la génération de votre image de conteneur. Pour créer ce secret SSH, utilisez la commande secret create --format SSH. Un secret SSH est également utilisé comme secret d'accès au référentiel Git. Cette option n'est autorisée que si l'option « --build-source » est définie sur l'adresse URL d'un référentiel Git via cette commande job update, ou si votre tâche est actuellement associée à une version provenant d'un référentiel Git. Cette valeur est facultative.

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

Effacer le secret SSH. Cette option est autorisée si votre tâche est actuellement associée à une version. Cette valeur est facultative. La valeur par défaut est false.

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

Taille de la génération, qui détermine la quantité de ressources utilisée. Les valeurs valides sont : small, medium, large, xlarge et xxlarge. Pour plus de détails, voir Définition de la taille de la génération. L'option « build size » n'est autorisée que si l'option « --build-source » est activée dans cette commande « job update », ou si votre tâche est actuellement associée à une compilation. Cette valeur est facultative. La valeur par défaut est medium.

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

L'URL du référentiel Git ou le chemin d'accès à la source locale qui contient votre code source ; par exemple, https://github.com/IBM/CodeEngine ou.. Cette valeur est facultative.

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

Stratégie à utiliser pour générer l'image. Les valeurs valides sont dockerfile et buildpacks. L'option de stratégie de build n'est autorisée que si l'option « --build-source » est activée dans cette commande « job update », ou si votre tâche est actuellement associée à un build. Si elle n'est pas spécifiée, la stratégie de génération est déterminée par Code Engine si --build-source est spécifié et si la source se trouve sur votre machine locale. Cette valeur est facultative. La valeur par défaut est dockerfile.

--build-timeout, --bto

Délai en secondes avant la réussite ou l'échec de la génération. L'option de délai d'expiration de la compilation n'est autorisée que si l'option « --build-source » est définie dans cette commande « job update », ou si votre tâche est actuellement associée à une compilation. Cette valeur est facultative. La valeur par défaut est 600.

--command, --cmd, -c

Permet de définir des commandes pour les exécutions du travail. Spécifiez une commande par option --command ; par exemple, --cmd cmdA --cmd cmdB. Cette valeur remplace la commande par défaut qui est spécifiée dans l'image de conteneur. Cette valeur est facultative.

--commands-clear, --cc

Permet d'effacer les commandes d'un travail. Cette valeur est facultative. La valeur par défaut est false.

--cpu

Quantité d'UC à définir pour les exécutions du travail. Cette valeur met à jour toute valeur --cpu qui est affectée dans le travail. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative. La valeur par défaut est 0.

--env, -e

Permet de définir des variables d'environnement pour les exécutions du travail. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle variable d'environnement ou de remplacer une variable d'environnement existante. Spécifiez une variable d'environnement par option --env ; par exemple, --env envA=A --env envB=B. Cette valeur est facultative.

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

Définissez les variables d'environnement à partir des paires clé-valeur qui sont stockées dans cette mappe de configuration en utilisant l'une des méthodes suivantes :

  • Afin d'ajouter des variables d'environnement pour toutes les clés d'une mappe de configuration nommée configmapName, utilisez la valeur configmapName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement de la mappe de configuration. Pour spécifier un préfixe, utilisez la valeurPREFIX=CONFIGMAP_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans la mappe de configurationconfigmapName enCUSTOM_, utilisez la valeurCUSTOM_=configmapName. Si la mappe de configuration configmapName contient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, afin d'ajouter une variable d'environnement pour une clé key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:myKey=key1.

Cette valeur est facultative.

--env-from-configmap-rm, --env-cm-rm
Permet de retirer des références de variable d'environnement à des mappes de configuration complètes en utilisant le nom de la mappe de configuration. Pour retirer des références de clé individuelles à des mappes de configuration, utilisez l'option --env-rm. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--env-sec, --env-from-secret

Définissez les variables d'environnement à partir des paires clé-valeur stockées dans un secret en utilisant l'une des méthodes suivantes :

  • Afin d'ajouter des variables d'environnement pour toutes les clés d'un secret nommé secretName, utilisez la valeur secretName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement du secret. Pour spécifier un préfixe, utilisez la valeurPREFIX=SECRET_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_SECRET>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans le secretsecretName vers CUSTOM_, utilisez la valeurCUSTOM_=secretName. Si le secret secretNamecontient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, pour ajouter une variable d'environnement pour une clé uniquekey1 dans un secret nommésecretName, utilisez la valeursecretName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans un secret nommé secretName, utilisez la valeur secretName:myKey=key1.

Cette valeur est facultative.

--env-from-secret-rm, --env-sec-rm
Permet de retirer des références de variable d'environnement à des secrets intégraux en utilisant le nom de secret. Pour retirer des références de clé individuelles à des secrets, utilisez l'option --env-rm. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--env-rm

Permet de retirer des références de variable d'environnement à la clé d'une paire clé-valeur dans une mappe de configuration ou un secret. Pour retirer des références de clé individuelles et des valeurs littérales, spécifiez le nom de la clé. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.

--ephemeral-storage, --es

Quantité de stockage éphémère à définir pour les exécutions du travail. Utilisez M pour mégaoctets ou G pour gigaoctets. Cette valeur est facultative.

--force, -f

Ne pas vérifier l'existence des références de mappe de configuration et de secret spécifiées. Les références de mappe de configuration sont spécifiées avec l'option --env-from-configmap. Les références de secret sont spécifiées avec l'option --env-from-secret ou --registry-secret. Cette valeur est facultative. La valeur par défaut est false.

--image, -i

Nom de l'image qui est utilisée pour les exécutions du travail. Le format est REGISTRY/NAMESPACE/REPOSITORY:TAG, où REGISTRY et TAG sont facultatifs. Si REGISTRY n'est pas spécifié, la valeur par défaut est docker.io. Si TAG n'est pas spécifié, la valeur par défaut est latest. Cette valeur est facultative.

--maxexecutiontime, --met

Temps d'exécution maximal, en secondes, pour les exécutions du travail. Cette option ne peut être spécifiée que si mode est task. Cette valeur est facultative. La valeur par défaut est 7200.

--memory, -m

Quantité de mémoire définie pour les exécutions du travail. Utilisez M pour mégaoctets ou G pour gigaoctets. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative.

--mode

Mode pour les exécutions du travail. Les valeurs valides sont task et daemon. En mode « task », les options « maxexecutiontime » et « retrylimit » s'appliquent. En mode « daemon », comme il n'y a pas de délai d'expiration et que les instances défaillantes sont redémarrées indéfiniment, les options « --maxexecutiontime » et « --retrylimit » ne sont pas autorisées. Cette valeur est facultative.

--mount-configmap, --mount-cm

Ajoutez le contenu d'une mappe de configuration au système de fichiers de l'exécution du travail en fournissant un répertoire de montage et le nom d'une mappe de configuration, sous le format MOUNT_DIRECTORY=CONFIGMAP_NAME. Chaque mappe de configuration montée doit utiliser un répertoire de montage unique. Pour chaque paire clé-valeur de la mappe de configuration, un fichier est ajouté au répertoire de montage spécifié, où le nom de fichier est la clé et le contenu du fichier, la valeur de la paire clé-valeur. Spécifiez une configuration de montage par option --mount-configmap, --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b, par exemple. Cette valeur est facultative.

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

Montage d'un stockage de persistance des données. Le format est le suivant : MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. SUBPATH est facultatif. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.

--mount-rm

Supprimez le contenu d'une mappe de configuration ou d'un secret du système de fichiers de l'exécution du travail en spécifiant le répertoire dans lequel la mappe de configuration ou le secret est monté. Spécifiez un répertoire de montage par option --mount-rm, --mount-rm /etc/configmap-a --mount-rm /etc/secret-b, par exemple. Cette valeur est facultative.

--mount-secret, --mount-sec

Ajoutez les contenus d'un secret au système de fichiers de l'exécution du travail en fournissant un répertoire de montage et le nom d'un secret, au format MOUNT_DIRECTORY=SECRET_NAME. Chaque secret monté doit utiliser un répertoire de montage unique. Pour chaque paire clé-valeur du secret, un fichier est ajouté au répertoire de montage spécifié, où le nom de fichier est la clé et le contenu du fichier, la valeur de la paire clé-valeur. Spécifiez une configuration de montage par option --mount-secret, --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b, par exemple. Cette valeur est facultative.

--no-wait, --nw

N'attendez pas la fin de l'exécution de la génération. Si vous spécifiez l'option --no-wait, l'exécution de la génération commence et n'attend pas. Utilisez la commande buildrun get pour vérifier le statut de l'exécution de génération. L'option « sans attente » n'est autorisée que si l'option « --build-source » est activée dans cette commande « job update » ou si votre tâche est actuellement associée à une compilation. Cette valeur est facultative. La valeur par défaut est false.

--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--rebuild

Régénérez l'image à partir de la source. L'option de reconstruction est autorisée si votre tâche est actuellement associée à une compilation. Cette valeur est facultative. La valeur par défaut est false.

--registry-secret, --rs

Nom du secret de registre. Le secret de registre est utilisée pour l'authentification auprès d'un registre privé lorsque vous téléchargez l'image de conteneur. Cette valeur est facultative.

--registry-secret-clear, --rsc

Effacer le secret du registre. Cette valeur est facultative. La valeur par défaut est false.

--retrylimit, -r

Nombre de réexécutions d'une instance du travail avant que celui-ci ne soit marqué comme ayant échoué. Un index de tableau d'un travail est réexécuté lorsqu'il renvoie un code d'exit différent de zéro. Cette option ne peut être spécifiée que si mode est task. Cette valeur est facultative. La valeur par défaut est 3.

--service-account, --sa

Nom du compte de service. Un compte de service fournit une identité pour les processus qui s'exécutent dans une instance. Pour les comptes de service intégrés, vous pouvez utiliser les noms raccourcis manager, none, reader et writer. Vous pouvez également utiliser les noms complets préfixés avec le Kubernetes Config Context, qui peut être déterminé à l'aide de la commande project current. Cette valeur est facultative.

--service-account-clear, --sac

Effacer le compte de service. Cette valeur est facultative. La valeur par défaut est false.

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

Activer le montage d'un jeton de ressource de calcul pour les exécutions du travail. Cette valeur est facultative. La valeur par défaut est false.

--wait, -w

Attendez la fin de l'exécution de la génération. Si vous spécifiez l'option--wait, l'exécution de génération attend une durée maximale en secondes, définie par l'option--wait-timeout, pour que l'exécution de la génération soit terminée. Si l'exécution de génération n'est pas terminée dans la période--wait-timeout spécifiée, l'exécution de la génération échoue. L'option « wait » n'est autorisée que si l'option « --build-source » est activée pour cette commande « job update » ou si votre tâche est actuellement associée à une compilation. Cette valeur est facultative. La valeur par défaut est true.

--wait-timeout, --wto

Délai d'attente en secondes avant que cette exécution de génération soit terminée. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. L'option délai d'attente est autorisée si l'option --build-sourceest définie sur cette commandejob update ou si votre travail comporte actuellement une génération associée. La valeur par défaut est 600.

Exemple

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

Exemple de sortie

Updating job 'hellojob'...
OK

Commandes jobrun

Une tâche exécute en parallèle une ou plusieurs instances de votre code exécutable. Contrairement aux applications qui gèrent les demandes HTTP, les travaux sont conçus pour s'exécuter une seule fois et prendre fin. Lorsque vous créez un travail, vous pouvez spécifier les informations de configuration de charge de travail qui sont utilisées à chaque fois que le travail est exécuté. Les commandes jobrun permettent d'exécuter des instances d'un travail.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes jobrun.

Pour plus d'informations sur l'utilisation des travaux et des exécutions de travail, voir Exécution de travaux.

Pour consulter l'aide de l'interface en ligne de commande (CLI) relative aux commandes « jobrun », exécutez la commande « ibmcloud ce jobrun -h ».

ibmcloud ce jobrun delete

Permet de supprimer une exécution de travail.

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

Options de commande

--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--job, -j
Cette option permet de supprimer toutes les exécutions de travail du travail spécifié. L'option --job est requise si vous ne spécifiez pas la valeur --name. Cette valeur est facultative.
--name, -n
Nom de l'exécution de travail à supprimer. L'option --name est requise si vous ne spécifiez pas la valeur --job. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce jobrun delete --name myjobrun -f

Exemple de sortie

Deleting job run 'myjobrun'...
OK

ibmcloud ce jobrun events

Affichez les événements système des instances d'exécution de travail. Les événements système sont conservés jusqu'à 60 minutes.

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

Options de commande

--instance, -i
Nom d'une instance d'exécution de travail spécifique. Utilisez la commande jobrun get pour identifier le nom de l'instance. Cette valeur est obligatoire si --jobrun n'est pas spécifié.
--jobrun, -j, --name, -n
Afficher les événements de toutes les instances de l'exécution de travail spécifiée. Cette valeur est obligatoire si --instance n'est pas spécifié.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

L'exemple suivant affiche les informations d'événement système de toutes les instances d'une exécution de travail spécifiée.

ibmcloud ce jobrun events --jobrun myjobrun

Exemple de sortie

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"

Exemple d'informations d'événement système pour l'instance spécifiée d'une exécution de travail

Vous pouvez également afficher des informations sur les évènements système pour une instance spécifiée d'un travail exécuté à l'aide de l'option --instance avec la commande ibmcloud ce jobrun events. Utilisez la commande jobrun get pour afficher les détails de l'exécution de votre travail, y compris les instances d'exécution de l'exécution du travail.

ibmcloud ce jobrun events --instance myjobrun-2-0
Exemple de sortie de données d'évènement système pour une instance spécifiée d'une exécution de travail
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

Permet d'afficher les détails d'une exécution de travail.

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

Options de commande

--name, -n
Nom de l'exécution de travail. Cette valeur est obligatoire.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce jobrun get --name myjobrun  

Exemple de sortie

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

Permet de répertorier toutes les exécutions de travail d'un projet.

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

Options de commande

--job, -j
Cette option permet d'afficher uniquement les exécutions de travail du travail spécifié. Cette valeur est facultative.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce jobrun list

Exemple de sortie

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

Le nom de l'exécution de travail répertoriée indique le nom de l'exécution de travail et la révision en cours de cette dernière.

ibmcloud ce jobrun logs

Permet d'afficher les journaux des instances d'exécution de travail.

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

Options de commande

--follow, -f
Permet de suivre les journaux des instances d'exécution de travail. Utilisez cette option pour diffuser les journaux des instances d'exécution de travail. Si vous spécifiez l'option --follow, vous devez entrer Ctrl+C pour mettre fin à cette commande de journal. Cette valeur est facultative. La valeur par défaut est false.
--instance, -i
Nom d'une instance d'exécution de travail spécifique. Utilisez la commande jobrun get pour identifier le nom de l'instance. Cette valeur est obligatoire si --jobrun n'est pas spécifié.
--jobrun, -j, --name, -n
Afficher les journaux de toutes les instances de l'exécution de travail spécifiée Cette valeur est obligatoire si --instance n'est pas spécifié.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--raw, -r
Permet d'afficher les journaux sans les libellés d'instance et de conteneur. Cette valeur est facultative. La valeur par défaut est false.
--tail, -t
Permet de limiter l'affichage des journaux des instances d'exécution de travail spécifiées à un nombre maximal de lignes récentes. Par exemple, pour afficher les dernières lignes 3 des journaux des instances d'exécution de travaux spécifiées, indiquez --tail 3. Si cette option n'est pas spécifiée, toutes les lignes des journaux des instances d'exécution du travail spécifiées sont affichées. Cette valeur est facultative. La valeur par défaut est -1.
--timestamps, --ts
Permet d'inclure des horodatages sur chaque ligne dans la sortie de journal. Cette valeur est facultative. La valeur par défaut est false.

Exemple

L'exemple suivant affiche les journaux d'une instance spécifique d'une exécution de travail. Utilisez la commande jobrun get pour obtenir le nom des instances d'exécution de travail.

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

Exemple de sortie

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

Exemple de journaux de toutes les instances d'une exécution de travail

L'exemple suivant affiche les journaux de toutes les instances d'une exécution de travail.

ibmcloud ce jobrun logs --jobrun myjobrun
Exemple de sortie de journaux de toutes les instances d'une exécution de travail
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

Redémarrer les instances d'exécution de travaux en cours.

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

Options de commande

--instance, -i
Nom d'une instance d'exécution de travail spécifique. Utilisez la commande jobrun get pour identifier le nom de l'instance. Cette valeur est obligatoire si --jobrun n'est pas spécifié.
--jobrun, -j, --name, -n
Redémarrer toutes les instances en cours d'exécution du travail spécifié. Cette valeur est obligatoire si --instance n'est pas spécifié.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce jobrun restart --name myjobrun   

Exemple de sortie

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

ibmcloud ce jobrun resubmit

Permet de soumettre à nouveau une exécution de travail en fonction de la configuration d'une exécution de travail précédente.

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]

Options de commande

--jobrun, -j

Nom de l'exécution de travail précédente sur laquelle cette exécution de travail est basée. Cette valeur est obligatoire.

--argument, --arg, -a

Permet de définir des arguments pour cette exécution de travail. Spécifiez un argument par option --argument ; par exemple, -a argA -a argB. Cette valeur est facultative.

--arguments-clear, --ac

Permet d'effacer les arguments d'une exécution de travail. Cette valeur est facultative. La valeur par défaut est false.

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

Spécifie les index des instances utilisées pour l'exécution de cette tâche, par exemple 0,3,6,9, 1-5,7-8,10. L'ensemble des résultats des index est limité à 1000 entrées. Cette option ne peut être spécifiée que si l'option « array-size » n'est pas spécifiée. Cette valeur est facultative.

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

Permet de spécifier le nombre d'instances utilisées pour cette exécution de travail. Lorsque vous utilisez cette option, le système convertit en index de tableau. Par exemple, si vous indiquez instances de 5, le système le convertit en array-indexes de 0 - 4. Cette option ne peut être spécifiée que si l'option « --array-indexes » n'est pas spécifiée. Cette valeur est facultative. La valeur par défaut est 0.

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

Permet de définir une valeur personnalisée pour la variable d'environnement « JOB_ARRAY_SIZE ». Par défaut, la variable d'environnement JOB_ARRAY_SIZE est définie soit sur la valeur array-size , soit sur le nombre d'index spécifié par array-indexes``. La valeur de la variable d'environnement JOB_ARRAY_SIZE n'affecte pas la taille du tableau configuré. Cette option permet d'imposer une taille de tableau constante pour les scénarios de réexécution de travaux, dans lesquels seules certaines instances de travaux sont soumises ou resoumises. Cette valeur est facultative.

--command, --cmd, -c

Permet de définir des commandes pour cette exécution de travail. Spécifiez une commande par option --command ; par exemple, --cmd cmdA --cmd cmdB. Cette valeur remplace la commande par défaut qui est spécifiée dans l'image de conteneur. Cette valeur est facultative.

--commands-clear, --cc

Permet d'effacer les commandes d'une exécution de travail. Cette valeur est facultative. La valeur par défaut est false.

--cpu

Quantité d'UC définie pour chaque index de tableau pour cette exécution de travail. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative. La valeur par défaut est 0.

--env, -e

Permet de définir des variables d'environnement pour cette exécution de travail. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle variable d'environnement ou de remplacer une variable d'environnement existante. Spécifiez une variable d'environnement par option --env ; par exemple, -e envA -e envB. Cette valeur est facultative.

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

Définissez les variables d'environnement à partir des paires clé-valeur qui sont stockées dans cette mappe de configuration en utilisant l'une des méthodes suivantes :

  • Afin d'ajouter des variables d'environnement pour toutes les clés d'une mappe de configuration nommée configmapName, utilisez la valeur configmapName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement de la mappe de configuration. Pour spécifier un préfixe, utilisez la valeurPREFIX=CONFIGMAP_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans la mappe de configurationconfigmapName enCUSTOM_, utilisez la valeurCUSTOM_=configmapName. Si la mappe de configuration configmapName contient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, afin d'ajouter une variable d'environnement pour une clé key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:myKey=key1.

Cette valeur est facultative.

--env-from-configmap-rm, --env-cm-rm
Permet de retirer des références de variable d'environnement à des mappes de configuration complètes en utilisant le nom de la mappe de configuration. Pour retirer des références de clé individuelles à des mappes de configuration, utilisez l'option --env-rm. Cette valeur est facultative.
--env-sec, --env-from-secret

Définissez les variables d'environnement à partir des paires clé-valeur stockées dans un secret en utilisant l'une des méthodes suivantes :

  • Afin d'ajouter des variables d'environnement pour toutes les clés d'un secret nommé secretName, utilisez la valeur secretName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement du secret. Pour spécifier un préfixe, utilisez la valeurPREFIX=SECRET_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_SECRET>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans le secretsecretName vers CUSTOM_, utilisez la valeurCUSTOM_=secretName. Si le secret secretNamecontient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, pour ajouter une variable d'environnement pour une clé uniquekey1 dans un secret nommésecretName, utilisez la valeursecretName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans un secret nommé secretName, utilisez la valeur secretName:myKey=key1.

Cette valeur est facultative.

--env-from-secret-rm, --env-sec-rm
Permet de retirer des références de variable d'environnement à des secrets intégraux en utilisant le nom de secret. Pour retirer des références de clé individuelles à des secrets, utilisez l'option --env-rm. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--env-rm

Permet de retirer des références de variable d'environnement à la clé d'une paire clé-valeur dans une mappe de configuration ou un secret. Pour retirer des références de clé individuelles et des valeurs littérales, spécifiez le nom de la clé. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.

--ephemeral-storage, --es

Quantité de stockage éphémère pour cette exécution de travail. Utilisez M pour mégaoctets ou G pour gigaoctets. Cette valeur est facultative.

--force, -f

Ne pas vérifier l'existence des références de mappe de configuration et de secret spécifiées. Les références de mappe de configuration sont spécifiées avec l'option --env-from-configmap. Les références de secret sont spécifiées avec l'option --env-from-secret. Cette valeur est facultative. La valeur par défaut est false.

--maxexecutiontime, --met

Temps d'exécution maximal, en secondes, pour cette exécution de travail. Cette option ne peut être spécifiée que si mode est task. Cette valeur est facultative. La valeur par défaut est 7200.

--memory, -m

Quantité de mémoire à affecter à cette exécution de travail. Utilisez M pour mégaoctets ou G pour gigaoctets. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative.

--mode

Mode de l'exécution du travail. Les valeurs valides sont task et daemon. En mode « task », les options « maxexecutiontime » et « retrylimit » s'appliquent. En mode « daemon », comme il n'y a pas de délai d'expiration et que les instances défaillantes sont redémarrées indéfiniment, les options « maxexecutiontime » et « retrylimit » ne sont pas autorisées. Cette valeur est facultative.

--mount-configmap, --mount-cm

Ajoutez le contenu d'une mappe de configuration au système de fichiers de ce travail en fournissant un répertoire de montage et le nom d'une mappe de configuration, sous le format MOUNT_DIRECTORY=CONFIGMAP_NAME. Chaque mappe de configuration montée doit utiliser un répertoire de montage unique. Pour chaque paire clé-valeur de la mappe de configuration, un fichier est ajouté au répertoire de montage spécifié, où le nom de fichier est la clé et le contenu du fichier, la valeur de la paire clé-valeur. Spécifiez une configuration de montage par option --mount-configmap, --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b, par exemple. Cette valeur est facultative.

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

Montage d'un stockage de persistance des données. Le format est le suivant : MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. SUBPATH est facultatif. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.

--mount-rm

Supprimez le contenu d'une mappe de configuration ou d'un secret du système de fichiers de ce travail en spécifiant le répertoire dans lequel la mappe de configuration ou le secret est monté. Spécifiez un répertoire de montage par option --mount-rm, --mount-rm /etc/configmap-a --mount-rm /etc/secret-b, par exemple. Cette valeur est facultative.

--mount-secret, --mount-sec

Ajoutez le contenu d'un secret au système de fichiers de ce travail en fournissant un répertoire de montage et le nom d'un secret, au format MOUNT_DIRECTORY=SECRET_NAME. Chaque secret monté doit utiliser un répertoire de montage unique. Pour chaque paire clé-valeur du secret, un fichier est ajouté au répertoire de montage spécifié, où le nom de fichier est la clé et le contenu du fichier, la valeur de la paire clé-valeur. Spécifiez une configuration de montage par option --mount-secret, --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b, par exemple. Cette valeur est facultative.

-n, --name

Nom de cette exécution de travail. Cette valeur est obligatoire si aucune configuration de travail n'est associée au travail référencé. Utilisez un nom unique dans le projet.

  • Le nom doit débuter et se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 53 caractères au maximum et peut contenir des lettres minuscules, des chiffres et des tirets (-).

Cette valeur est facultative.

--no-wait, --nw
Permet de soumettre à nouveau le travail et de ne pas attendre que ses instances soient terminées. Si vous spécifiez l'option --no-wait, la nouvelle soumission de l'exécution de travail démarre, sans attendre. Utilisez la commande jobrun get pour vérifier le statut d'exécution du travail. Cette valeur est facultative. La valeur par défaut est true.
--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--retrylimit, -r

Nombre de réexécutions d'une instance de cette exécution de travail avant que celle-ci ne soit marquée comme ayant échoué. Un index de tableau d'une exécution de travail est réexécuté lorsqu'il renvoie un code d'exit différent de zéro. Cette option ne peut être spécifiée que si mode est task. Cette valeur est facultative. La valeur par défaut est 3.

--service-account, --sa

Nom du compte de service. Un compte de service fournit une identité pour les processus qui s'exécutent dans une instance. Pour les comptes de service intégrés, vous pouvez utiliser les noms raccourcis manager, none, reader et writer. Vous pouvez également utiliser les noms complets préfixés avec le Kubernetes Config Context, qui peut être déterminé à l'aide de la commande project current. Cette valeur est facultative.

--service-account-clear, --sac

Effacer le compte de service. Cette valeur est facultative. La valeur par défaut est false.

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

Activer le montage d'un jeton de ressource de calcul pour les instances de ce travail. Cette valeur est facultative. La valeur par défaut est false.

--wait, -w

Permet de soumettre à nouveau l'exécution de travail et d'attendre que ses instances se terminent. Si vous spécifiez l'option --wait, le délai d'attente maximal, en secondes, de la nouvelle soumission de l'exécution de travail pour que l'exécution de travail aboutisse est défini par l'option --wait-timeout. Si l'exécution de travail ne se termine pas dans le délai --wait-timeout spécifié, la nouvelle soumission de l'exécution de travail échoue. Cette valeur est facultative. La valeur par défaut est false.

--wait-timeout, --wto

Délai d'attente en secondes avant que l'exécution des instances de cette exécution de travail soit terminée. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 600.

Exemple

L'exemple illustré ci-après réexécute l'exécution de travail myjobrun pour les instances 4-5. Le nom de l'exécution de travail soumise à nouveau est myjobresubmit.

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

Exemple de sortie

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

Permet de soumettre une exécution de travail en fonction d'un travail.

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]

Options de commande

--argument, --arg, -a

Permet de définir des arguments pour cette exécution de travail. Spécifiez un argument par option --argument ; par exemple, -a argA -a argB. Cette valeur est facultative.

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

Spécifie les index des instances utilisées pour l'exécution de cette tâche, par exemple 0,3,6,9, 1-5,7-8,10. L'ensemble des résultats des index est limité à 1000 entrées. Cette option ne peut être spécifiée que si l'option « array-size » n'est pas spécifiée. Cette valeur est facultative. La valeur par défaut est 0.

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

Permet de spécifier le nombre d'instances utilisées pour cette exécution de travail. Lorsque vous utilisez cette option, le système convertit en index de tableau. Par exemple, si vous indiquez instances de 5, le système le convertit en array-indexes de 0 - 4. Cette option ne peut être spécifiée que si l'option « --array-indexes » n'est pas spécifiée. Cette valeur est facultative. La valeur par défaut est 1.

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

Permet de définir une valeur personnalisée pour la variable d'environnement « JOB_ARRAY_SIZE ». Par défaut, la variable d'environnement JOB_ARRAY_SIZE est définie soit sur la valeur array-size , soit sur le nombre d'index spécifié par array-indexes``. La valeur de la variable d'environnement JOB_ARRAY_SIZE n'affecte pas la taille du tableau configuré. Cette option permet d'imposer une taille de tableau constante pour les scénarios de réexécution de travaux, dans lesquels seules certaines instances de travaux sont soumises ou resoumises. Cette valeur est facultative.

--command, --cmd, -c

Permet de définir des commandes pour cette exécution de travail. Spécifiez une commande par option --command ; par exemple, --cmd cmdA --cmd cmdB. Cette valeur remplace la commande par défaut qui est spécifiée dans l'image de conteneur. Cette valeur est facultative.

--cpu

Quantité d'UC définie pour chaque index de tableau pour cette exécution de travail. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative. La valeur par défaut est 1.

--env, -e

Permet de définir des variables d'environnement pour cette exécution de travail. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle variable d'environnement ou de remplacer une variable d'environnement existante. Spécifiez une variable d'environnement par option --env ; par exemple, -e envA -e envB. Cette valeur est facultative.

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

Définissez les variables d'environnement à partir des paires clé-valeur qui sont stockées dans cette mappe de configuration en utilisant l'une des méthodes suivantes :

  • Afin d'ajouter des variables d'environnement pour toutes les clés d'une mappe de configuration nommée configmapName, utilisez la valeur configmapName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement de la mappe de configuration. Pour spécifier un préfixe, utilisez la valeurPREFIX=CONFIGMAP_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_CONFIGMAP>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans la mappe de configurationconfigmapName enCUSTOM_, utilisez la valeurCUSTOM_=configmapName. Si la mappe de configuration configmapName contient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, afin d'ajouter une variable d'environnement pour une clé key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans une mappe de configuration nommée configmapName, utilisez la valeur configmapName:myKey=key1.

Cette valeur est facultative.

--env-sec, --env-from-secret
Définissez les variables d'environnement à partir des paires clé-valeur stockées dans un secret en utilisant l'une des méthodes suivantes :
  • Afin d'ajouter des variables d'environnement pour toutes les clés d'un secret nommé secretName, utilisez la valeur secretName. Vous pouvez modifier les noms de variables d'environnement en spécifiant un préfixe lors du référencement du secret. Pour spécifier un préfixe, utilisez la valeurPREFIX=SECRET_NAME. Chaque variable d'environnement obtenue a le format<PREFIX><NAME_OF_KEY_IN_SECRET>. Par exemple, pour définir le préfixe de tous les noms de clés des clés dans le secretsecretName vers CUSTOM_, utilisez la valeurCUSTOM_=secretName. Si le secret secretNamecontient KEY_A, le nom de la variable d'environnement estCUSTOM_KEY_A.
  • Pour ajouter des variables d'environnement pour des clés individuelles, utilisez le formatNAME:KEY_A,KEY_B. Par exemple, pour ajouter une variable d'environnement pour une clé uniquekey1 dans un secret nommésecretName, utilisez la valeursecretName:key1. Pour affecter un nom différent à une clé référencée, utilisez le format NAME:NEW_NAME=KEY_A. Par exemple, pour ajouter une variable d'environnement nommée myKey pour une clé unique key1 dans un secret nommé secretName, utilisez la valeur secretName:myKey=key1.

Cette valeur est facultative.

--ephemeral-storage, --es
Quantité de stockage éphémère pour cette exécution de travail. Utilisez M pour mégaoctets ou G pour gigaoctets. Cette valeur est facultative. La valeur par défaut est 400M.
--force, -f

Ne pas vérifier l'existence des références de mappe de configuration et de secret spécifiées. Les références de mappe de configuration sont spécifiées avec l'option --env-from-configmap. Les références de secret sont spécifiées avec l'option --env-from-secret ou --registry-secret. Cette valeur est facultative. La valeur par défaut est false.

--image, -i

Nom de l'image qui est utilisée pour cette exécution de travail. Le format est REGISTRY/NAMESPACE/REPOSITORY:TAG, où REGISTRY et TAG sont facultatifs. Si REGISTRY n'est pas spécifié, la valeur par défaut est docker.io. Si TAG n'est pas spécifié, la valeur par défaut est latest. Si vous ne spécifiez pas l'option --job, les valeurs --name et --image sont obligatoires. Cette valeur est facultative.

--job, -j

Nom de la configuration de travail. Pour afficher les configurations de travail, utilisez la commande job list. Si vous spécifiez la valeur --job, vous pouvez éventuellement spécifier la valeur --name. Si vous ne spécifiez pas la valeur --job, vous devez spécifier les valeurs --name et --image. Cette valeur est facultative.

--maxexecutiontime, --met

Temps d'exécution maximal, en secondes, pour cette exécution de travail. Cette option ne peut être spécifiée que si mode est task. Cette valeur est facultative. La valeur par défaut est 7200.

--memory, -m

Quantité de mémoire à affecter à cette exécution de travail. Utilisez M pour mégaoctets ou G pour gigaoctets. Pour prendre connaissance des valeurs valides, voir Combinaisons de mémoire et d'unité centrale prises en charge. Cette valeur est facultative. La valeur par défaut est 4G.

--mode

Mode de l'exécution du travail. Les valeurs valides sont task et daemon. En mode « task », les options « maxexecutiontime » et « retrylimit » s'appliquent. En mode « daemon », comme il n'y a pas de délai d'expiration et que les instances défaillantes sont redémarrées indéfiniment, les options « maxexecutiontime » et « retrylimit » ne sont pas autorisées. Cette valeur est facultative. La valeur par défaut est « task ».

--mount-configmap, --mount-cm

Ajoutez le contenu d'une mappe de configuration au système de fichiers de ce travail en fournissant un répertoire de montage et le nom d'une mappe de configuration, sous le format MOUNT_DIRECTORY=CONFIGMAP_NAME. Chaque mappe de configuration montée doit utiliser un répertoire de montage unique. Pour chaque paire clé-valeur de la mappe de configuration, un fichier est ajouté au répertoire de montage spécifié, où le nom de fichier est la clé et le contenu du fichier, la valeur de la paire clé-valeur. Spécifiez une configuration de montage par option --mount-configmap, --mount-configmap /etc/config-a=config-a --mount-configmap /etc/config-b=config-b, par exemple. Cette valeur est facultative.

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

Montage d'un stockage de persistance des données. Le format est le suivant : MOUNT_DIRECTORY=STORAGE_NAME [:SUBPATH]. SUBPATH est facultatif. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.

--mount-secret, --mount-sec

Ajoutez le contenu d'un secret au système de fichiers de ce travail en fournissant un répertoire de montage et le nom d'un secret, au format MOUNT_DIRECTORY=SECRET_NAME. Chaque secret monté doit utiliser un répertoire de montage unique. Pour chaque paire clé-valeur du secret, un fichier est ajouté au répertoire de montage spécifié, où le nom de fichier est la clé et le contenu du fichier, la valeur de la paire clé-valeur. Spécifiez une configuration de montage par option --mount-secret, --mount-secret /etc/secret-a=secret--a --mount-secret /etc/secret-b=secret-b, par exemple. Cette valeur est facultative.

-n, --name

Nom de cette exécution de travail. Si vous ne spécifiez pas la valeur --job, les valeurs --name et --image sont obligatoires. Utilisez un nom unique dans le projet.

  • Le nom doit débuter et se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 53 caractères au maximum et peut contenir des lettres minuscules, des chiffres et des tirets (-).

Cette valeur est facultative.

--no-wait, --nw
Permet de soumettre l'exécution de travail et de ne pas attendre que ses instances soient terminées. Si vous spécifiez l'option --no-wait, la soumission de l'exécution de travail démarre, sans attendre. Utilisez la commande jobrun get pour vérifier le statut d'exécution du travail. Cette valeur est facultative. La valeur par défaut est true.
--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--registry-secret, --rs

Nom du secret de registre. Le secret de registre est utilisée pour l'authentification auprès d'un registre privé lorsque vous téléchargez l'image de conteneur. Cette valeur est facultative.

--retrylimit, -r

Nombre de réexécutions d'une instance de cette exécution de travail avant que celle-ci ne soit marquée comme ayant échoué. Un index de tableau d'une exécution de travail est réexécuté lorsqu'il renvoie un code d'exit différent de zéro. Cette option ne peut être spécifiée que si mode est task. Cette valeur est facultative. La valeur par défaut est 3.

--service-account, --sa

Nom du compte de service. Un compte de service fournit une identité pour les processus qui s'exécutent dans une instance. Pour les comptes de service intégrés, vous pouvez utiliser les noms raccourcis manager, none, reader et writer. Vous pouvez également utiliser les noms complets préfixés avec le Kubernetes Config Context, qui peut être déterminé à l'aide de la commande project current. Cette valeur est facultative.

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

Activer le montage d'un jeton de ressource de calcul pour les instances de ce travail. Cette valeur est facultative. La valeur par défaut est false.

--wait, -w

Permet de soumettre l'exécution de travail et d'attendre que ses instances soient terminées. Si vous spécifiez l'option --wait, le délai d'attente maximal, en secondes, de la soumission de l'exécution de travail pour que l'exécution de travail aboutisse est défini par l'option --wait-timeout. Si l'exécution de travail ne se termine pas dans le délai --wait-timeout spécifié, la soumission de l'exécution de travail échoue. Cette valeur est facultative. La valeur par défaut est false.

--wait-timeout, --wto

Délai d'attente en secondes avant que l'exécution des instances de cette exécution de travail soit terminée. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 600.

Exemple

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

Exemple de sortie

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

Commandes du magasin de données persistant

Gérer les magasins de données persistants.

ibmcloud ce persistentdatastore create

Créer un magasin de données persistant.

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

Options de commande

--cos-access-secret, --cos-sec
Obligatoire. Nom du secret qui contient les identifiants permettant d’accéder à l’instance COS. Cette valeur est obligatoire.
--cos-bucket-name, --cos-bucket
Obligatoire. Le nom du compartiment COS. Cette valeur est obligatoire.
--name, -n
Obligatoire. Nom du magasin de données persistantes. Utilisez un nom unique dans le projet. Cette valeur est obligatoire.
--cos-bucket-location, --cos-loc
Emplacement du compartiment COS. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

ibmcloud ce persistentdatastore delete

Supprimer un magasin de données persistant.

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

Options de commande

--name, -n
Obligatoire. Nom du magasin de données persistant. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

ibmcloud ce persistentdatastore get

Afficher les détails d'un magasin de données persistant.

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

Options de commande

--name, -n
Obligatoire. Nom du magasin de données persistantes. Cette valeur est obligatoire.
--output, -o
Format de sortie. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

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

Exemple de sortie

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

Répertorier tous les magasins de données persistants d’un projet.

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

Options de commande

--output, -o
Format de sortie. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

Cette commande dresse la liste de tous les magasins de données persistants d'un projet.

ibmcloud ce persistentdatastore list

Exemple de sortie

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  

Commandes project

Les commandes project permettent de créer, répertorier, supprimer et sélectionner un projet comme contexte actuel.

Un projet est un ensemble d'entités d' Code Engine, telles que des applications, des fonctions, des tâches, des parcs et des versions. Un projet est basé sur un espace de nom Kubernetes. Le nom de votre projet doit être unique au sein de votre groupe de ressources, compte utilisateur et région IBM Cloud®. Les projets servent à gérer les ressources et à permettre l'accès à leurs entités.

Un projet offre les fonctionnalités suivantes :

  • Un espace de noms unique pour les noms d'entités.
  • Gestion des accès entrants aux ressources du projet.
  • Gestion des accès sortants aux services de sauvegarde, aux registres et aux référentiels.
  • Certificat généré automatiquement pour le service de la couche de transport ( TLS ).

Pour plus d'informations sur l'utilisation des projets, voir Gestion des projets.

Vous pouvez utiliser soit projectouproj dans vos commandesproject. Pour afficher l'aide de l'interface de ligne de commande relative aux commandes project, exécutez la commande ibmcloud ce proj -h.

ibmcloud ce project create

Permet de créer un projet.

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

Options de commande

-n, --name

Nom du projet. Utilisez un nom unique dans votre région. Le nom ne doit pas contenir plus de 128 caractères et peut comporter :

  • N'importe quel caractère Unicode ou alphanumérique.
  • Uniquement les caractères spéciaux suivants : espaces ( ), points (.), deux-points (:), traits de soulignement (_) et tirets (-).

Cette valeur est obligatoire.

--endpoint, -e
Le point final du projet. Les valeurs valides sont public et private. Si l'option --endpoint n'est pas explicitement spécifiée, le comportement est déterminé par le système. Si l'interface de ligne de commande IBM Cloud est connectée à private.cloud.ibm.com, le projet Code Engine se comporte comme si --endpoint était private. Si l'interface de ligne de commande IBM Cloud est connectée à cloud.ibm.com, le projet Code Engine se comporte comme si --endpoint était public. Cette valeur est facultative.
--no-select, --ns

Ne sélectionnez pas le projet comme contexte actuel après sa création. Si vous ne sélectionnez pas cette option, le projet est automatiquement sélectionné. Cette valeur est facultative. La valeur par défaut est false.

--no-wait, --nw

Créer le projet et ne pas attendre qu'il soit créé. Si vous spécifiez l'option no-wait, la création du projet commence sans attendre. Utilisez la commande project get pour vérifier le statut du projet. Cette valeur est facultative. La valeur par défaut est false.

--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--tag, -t

Libellé à affecter à votre projet. Le libellé doit contenir 128 caractères ou moins et peut contenir des lettres, des nombres, des espaces (), des points (.), deux points (:), des traits de soulignement (_) et des traits d'union (-). Spécifiez un libellé par option --tag ; par exemple, --tag tagA --tag tagB. Cette valeur est facultative.

--wait, -w

Créer le projet et attendre sa création. Si vous spécifiez l'option --wait, la création du projet peut avoir lieu dans le délai maximal défini en secondes par l'option --wait-timeout. Si le projet n'est pas créé dans le délai --wait-timeout spécifié, la création du projet échoue. Cette valeur est facultative. La valeur par défaut est true.

--wait-timeout, --wto

Délai d'attente en secondes avant la création du projet. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 600.

Exemple

ibmcloud ce project create --name myproject  

Exemple de sortie

Creating project 'myproject'...
OK

ibmcloud ce project current

Permet d'afficher les détails d'un projet actuellement ciblé.

ibmcloud ce project current [--output OUTPUT] [--quiet]

Options de commande

--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce project current  

Exemple de sortie

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

Permet de supprimer un projet.

ibmcloud ce project delete (--name PROJECT_NAME | --id PROJECT_ID) [--force] [--hard] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Options de commande

--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--hard
Supprimez immédiatement le projet. Si vous ne spécifiez pas l'option --hard, le projet peut être restauré dans un délai de 7 jours à l'aide de la commande project restore ou reclamation restore. Cette valeur est facultative. La valeur par défaut est false.
--id, --guid
ID du projet. Cette valeur est obligatoire si --name n'est pas spécifié.
--name, -n
Nom du projet. Cette valeur est obligatoire si --id n'est pas spécifié.
--no-wait, --nw
Supprimer le projet sans attendre. Si vous spécifiez l'option no-wait, la suppression du projet commence sans attendre. Utilisez la commande project get pour vérifier le statut du projet. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--wait, -w
Supprimer le projet et attendre sa suppression. Si vous spécifiez l'option --wait, la suppression du projet est mise en attente pour une durée maximale en secondes, définie dans l'option --wait-timeout, avant de supprimer le projet. Si le projet n'est pas supprimé dans le délai --wait-timeout spécifié, sa suppression échoue. Cette valeur est facultative. La valeur par défaut est true.
--wait-timeout, --wto
Délai d'attente en secondes avant la suppression du projet. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 600.

Exemple

ibmcloud ce project delete --name myproject -f

Exemple de sortie

Deleting project 'myproject'...
OK

ibmcloud ce project get

Permet d'afficher les détails d'un projet.

ibmcloud ce project get (--name PROJECT_NAME | --id PROJECT_ID) [--output OUTPUT] [--quiet]

Options de commande

--id, --guid
ID du projet. Cette valeur est obligatoire si --name n'est pas spécifié.
--name, -n
Nom du projet. Cette valeur est obligatoire si --id n'est pas spécifié.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce project get --name myproject

Exemple de sortie

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

Permet de répertorier tous les projets.

ibmcloud ce project list [--all-resource-groups] [--output OUTPUT] [--quiet] [--regions REGIONS] [--sort-by SORT_BY]

Options de commande

--all-resource-groups, --all
Affiche les projets provenant de tous les groupes de ressources. Par défaut, les projets qui s'affichent proviennent uniquement du groupe de ressources en cours. Cette valeur est facultative. La valeur par défaut est false.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--regions, -r
Limite l'affichage de projets aux régions spécifiées. Indiquez le nom d'une ou plusieurs régions ; par exemple, us-south,eu-de. Cette valeur est facultative.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce project list

Exemple de sortie

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

Restaurer un projet.

ibmcloud ce project restore (--name PROJECT_NAME | --id PROJECT_ID) [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Options de commande

--id, --guid
ID du projet. Cette valeur est obligatoire si --name n'est pas spécifié.
--name, -n
Nom du projet. Cette valeur est obligatoire si --id n'est pas spécifié.
--no-wait, --nw
Restaurer le projet sans attendre sa restauration. Si vous spécifiez l'option no-wait, la restauration du projet commence sans attente. Utilisez la commande project get pour vérifier le statut du projet. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--wait, -w
Restaurer le projet et attendre sa restauration. Si vous spécifiez l'option --wait, la restauration du projet peut avoir lieu dans le délai maximal défini en secondes par l'option --wait-timeout. Si le projet n'est pas restauré dans le délai --wait-timeout spécifié, la restauration du projet échoue. Cette valeur est facultative. La valeur par défaut est true.
--wait-timeout, --wto
Délai d'attente en secondes avant la restauration du projet. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 600.

Exemple

L'exemple ci-dessous restaure à l'état actif le projet myproject dont le statut est soft deleted. Utilisez la commande project list pour afficher la liste de tous les projets avec leur statut.

ibmcloud ce project restore --name myproject

Exemple de sortie

Restoring project 'myproject'...
OK

ibmcloud ce project select

Permet de sélectionner un projet comme contexte actuel. Le projet doit être à l'état active pour pouvoir être sélectionné.

ibmcloud ce project select (--name PROJECT_NAME | --id PROJECT_ID) [--endpoint ENDPOINT] [--kubecfg] [--quiet]

Options de commande

--endpoint, -e
Le point final du projet. Les valeurs valides sont public et private. Si l'option --endpoint n'est pas explicitement spécifiée, le comportement est déterminé par le système. Si l'interface de ligne de commande IBM Cloud est connectée à private.cloud.ibm.com, le projet Code Engine se comporte comme si --endpoint était private. Si l'interface de ligne de commande IBM Cloud est connectée à cloud.ibm.com, le projet Code Engine se comporte comme si --endpoint était public. Cette valeur est facultative.
--id, --guid
ID du projet. Cette valeur est obligatoire si --name n'est pas spécifié.
--kubecfg, -k
Ajoutez le projet au fichier de configuration Kubernetes par défaut. Vous pouvez remplacer le fichier de configuration Kubernetes par défaut en définissant la variable d'environnement KUBECONFIG. Cette valeur est facultative. La valeur par défaut est false.
--name, -n
Nom du projet. Cette valeur est obligatoire si --id n'est pas spécifié.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce project select --name myproject

Exemple de sortie

Selecting project 'myproject'...
OK

ibmcloud ce project tag

Permet de gérer les balises d'un projet.

ibmcloud ce project tag (--name PROJECT_NAME | --id PROJECT_ID) [--quiet] [--tag TAG] [--tag-rm TAG_RM]

Options de commande

--id, --guid
ID du projet. Cette valeur est obligatoire si --name n'est pas spécifié.
--name, -n
Nom du projet. Cette valeur est obligatoire si --id n'est pas spécifié.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--tag, -t
Libellé à affecter à votre projet. Le libellé doit contenir 128 caractères ou moins et peut contenir des lettres, des nombres, des espaces (), des points (.), deux points (:), des traits de soulignement (_) et des traits d'union (-). Spécifiez un libellé par option --tag ; par exemple, --tag tagA --tag tagB. Cette valeur est facultative.
--tag-rm, --trm
Permet de supprimer un libellé affecté à votre projet. Spécifiez un libellé par option --tag-rm. Par exemple, --tag-rm tagA --tag-rm tagB. Cette valeur est facultative.

Exemple

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

Exemple de sortie

Getting project 'myproject'...
OK

ibmcloud ce project update

Mettez à jour le projet sélectionné.

ibmcloud ce project update (--binding-service-id SERVICE_ID_ID | --binding-resource-group RESOURCE_GROUP_NAME | --binding-resource-group-id RESOURCE_GROUP_ID) [--quiet]

Options de commande

--binding-resource-group, --brg
Nom d'un groupe de ressources à utiliser aux fins d'authentification pour les liaisons de service de ce projet. Un ID de service est créé avec les rôles Operator et Manager pour tous les services de ce groupe de ressources. Utilisez "*" pour indiquer tous les groupes de ressources de ce compte. Cette valeur est facultative.
--binding-resource-group-id, --brgid
ID d'un groupe de ressources à utiliser pour l'authentification pour les liaisons de service de ce projet. Un ID de service est créé avec les rôles Operator et Manager pour tous les services de ce groupe de ressources. Cette valeur est facultative.
--binding-service-id, --bsid
ID de l'ID de service à utiliser lors de l'authentification pour les liaisons de service de ce projet. Cet ID de service doit avoir le rôle Operator et un rôle de service approprié pour des instances de service, des types de services ou des groupes de ressources. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce project update --binding-service-id ServiceId-1234abcd-abcd-abcd-1111-1a2b3c4d5e6f

Exemple de sortie

Configuring your project for service bindings...
Creating service binding API key 'my-project-api-key' for service ID 'my-custom-service-id'...
OK

Commandes de réclamation

Gérer les réclamations du projet Code Engine. Les projets ayant fait l'objet d'une suppression logicielle peuvent être restaurés dans un délai de 7 jours à l'aide de la commande reclamation restore.

ibmcloud ce reclamation delete

Supprimer une récupération de projet.

ibmcloud ce reclamation delete (--name PROJECT_NAME | --id PROJECT_ID) [--force] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Options de commande

--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--id, --guid
ID du projet. Cette valeur est obligatoire si --name n'est pas spécifié.
--name, -n
Nom du projet. Cette valeur est obligatoire si --id n'est pas spécifié.
--no-wait, --nw
Supprime la réclamation de projet sans attendre. Si vous spécifiez l'option no-wait, la suppression de la réclamation de projet commence sans attendre. Utilisez la commande reclamation get pour vérifier le statut de la réclamation de projet. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--wait, -w
Supprime le projet dans le délai de suppression défini. Si vous spécifiez l'option --wait, la suppression de la réclamation de projet est mise en attente pour une durée maximale en secondes, définie dans l'option --wait-timeout. Si la réclamation de projet n'est pas supprimée dans le délai --wait-timeout spécifié, sa suppression échoue. Cette valeur est facultative. La valeur par défaut est true.
--wait-timeout, --wto
Délai d'attente en secondes avant la suppression de la réclamation de projet. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 600.

Exemple

L'exemple ci-dessous supprime définitivement le projet myproject dont le statut est soft deleted. L'utilisation de l'option --force avec cette commande force la suppression sans confirmation. Vous pouvez utiliser la commande reclamation list pour afficher la liste de tous les projets dont le statut est soft deleted.

ibmcloud ce reclamation delete --name myproject --f

Exemple de sortie

Hard deleting project 'myproject'...
OK

ibmcloud ce reclamation get

Permet d'afficher les détails d'une réclamation de projet unique.

ibmcloud ce reclamation get (--name PROJECT_NAME | --id PROJECT_ID) [--output OUTPUT] [--quiet]

Options de commande

--id, --guid
ID du projet. Cette valeur est obligatoire si --name n'est pas spécifié.
--name, -n
Nom du projet. Cette valeur est obligatoire si --id n'est pas spécifié.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce reclamation get --name myproject

Exemple de sortie

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

Répertoriez toutes les récupérations de projet.

ibmcloud ce reclamation list [--all-resource-groups] [--output OUTPUT] [--quiet] [--regions REGIONS] [--sort-by SORT_BY]

Options de commande

--all-resource-groups, --all
Affiche les réclamations de projet provenant de tous les groupes de ressources. Par défaut, les réclamations de projet qui s'affichent proviennent uniquement du groupe de ressources en cours. Cette valeur est facultative. La valeur par défaut est false.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--regions, -r
Limite l'affichage des réclamations de projet aux régions spécifiées. Indiquez le nom d'une ou plusieurs régions ; par exemple, us-south,eu-de. Cette valeur est facultative.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce reclamation list

Exemple de sortie

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

Supprimer une récupération de projet. Les projets ayant fait l'objet d'une suppression logicielle peuvent être restaurés dans un délai de 7 jours à l'aide de la commande reclamation restore.

ibmcloud ce reclamation restore (--name PROJECT_NAME | --id PROJECT_ID) [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Options de commande

--id, --guid
ID du projet. Cette valeur est obligatoire si --name n'est pas spécifié.
--name, -n
Nom du projet. Cette valeur est obligatoire si --id n'est pas spécifié.
--no-wait, --nw
Restaurer la récupération de projet et ne pas attendre que la récupération du projet soit restaurée. Si vous spécifiez l'option no-wait, la restauration de la réclamation de projet commence sans attendre. Utilisez la commande reclamation get pour vérifier le statut de la réclamation de projet. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--wait, -w
Restaurer la récupération de projet et attendre que la récupération de projet soit restaurée. Si vous spécifiez l'option --wait, la restauration de la réclamation de projet est mise en attente pour une durée maximale en secondes, définie dans l'option --wait-timeout. Si la réclamation de projet n'est pas restaurée dans le délai --wait-timeout spécifié, sa restauration échoue. Cette valeur est facultative. La valeur par défaut est true.
--wait-timeout, --wto
Délai d'attente en secondes avant la restauration de la réclamation de projet. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 600.

Exemple

L'exemple ci-dessous restaure à l'état actif le projet myproject dont le statut est soft deleted. Utilisez la commande reclamation list pour afficher la liste de tous les projets dont le statut est soft deleted.

ibmcloud ce reclamation restore --name myproject

Exemple de sortie

Restoring project 'myproject'...
OK

Commandes registry

Un registre de conteneur, ou registre, est un service qui stocke les images de conteneur. Par exemple, IBM Cloud Container Registry et Docker Hub sont des registres de conteneurs. Un registre de conteneurs peut être public ou privé. Un registre de conteneurs public ne requiert pas de données d'identification pour y accéder. En revanche, l'accès à un registre privé requiert des données d'identification.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes registry.

Pour plus d'informations sur l'accès aux registres, reportez-vous à la rubrique décrivant l'ajout d'un accès à un registre de conteneur privé.

Pour consulter l'aide de l'interface en ligne de commande (CLI) relative aux commandes « registry », exécutez la commande « ibmcloud ce registry -h ».

À partir de la version de l'interface de programmation 1.42.0, la définition et l'utilisation des secrets dans l'interface de programmation sont unifiées sous le groupe de commandes secret sous le groupe de commandes Voir ibmcloud ce secret les commandes. Utilisez l'option --format pour spécifier la catégorie du secret, par exemple basic_auth, generic, hmac, ssh, tls, ou registry. Bien que vous puissiez continuer à utiliser le groupe de commande registry vous pouvez continuer à utiliser le groupe de commande, mais vous pouvez aussi tirer parti du groupe de commande unifié secret unifié. Pour créer un secret permettant d'accéder au registre d'un conteneur, utilisez la commande ibmcloud ce secret create --format registry pour créer un secret d'accès à un registre de conteneurs. Pour en savoir plus sur le travail avec les secrets dans Code Engine, voir Travailler avec des secrets.

ibmcloud ce registry create

Permet de créer un secret d'accès à un registre d'images.

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]

Options de commande

-n, --name

Nom du secret d'accès au registre d'images. Utilisez un nom unique dans le projet.

  • Le nom doit débuter et se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 253 caractères au maximum et peut contenir des lettres minuscules, des chiffres, des points (.) et des tirets (-).

Cette valeur est obligatoire.

--email, -e
Adresse électronique permettant d'accéder au serveur de registre. Cette valeur est facultative.
--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--password, -p

Mot de passe permettant d'accéder au serveur de registre. Si aucune des options --password, --password-from-file ou --password-from-json-file n'est spécifiée, vous êtes invité à indiquer le mot de passe. Cette valeur est facultative.

--password-from-file, --pf

Chemin d'accès à un fichier qui contient le mot de passe permettant d'accéder au serveur de registre. La première ligne du fichier est utilisée pour le mot de passe. Si aucune des options --password, --password-from-file ou --password-from-json-file n'est spécifiée, vous êtes invité à indiquer le mot de passe. Cette valeur est facultative.

--password-from-json-file, --pfj

Chemin d'accès à un fichier JSON qui contient le mot de passe permettant d'accéder au serveur de registre. La zone apikey est utilisé pour le mot de passe. Si aucune des options --password, --password-from-file ou --password-from-json-file n'est spécifiée, vous êtes invité à indiquer le mot de passe. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--server, -s

URL du serveur de registre. Cette valeur est facultative. La valeur par défaut est us.icr.io.

--username, -u

Nom d'utilisateur permettant d'accéder au serveur de registre. Cette valeur est facultative. La valeur par défaut est iamapikey.

Exemple

L'exemple illustré ci-après permet de créer un accès à un registre d'images nommé myregistry pour une instance Container Registry située dans us.icr.io et d'utiliser le nom d'utilisateur iamapikey et la clé d'API IAM comme mot de passe.

ibmcloud ce registry create --name myregistry --server us.icr.io --username iamapikey --password API_KEY   

Exemple de sortie

Creating image registry access secret myregistry...
OK

ibmcloud ce registry delete

Permet de supprimer un secret d'accès à un registre d'images.

ibmcloud ce registry delete --name NAME [--force] [--ignore-not-found] [--quiet]

Options de commande

--name, -n
Nom du secret d'accès au registre d'images. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce registry delete --name myregistry -f   

Exemple de sortie

Deleting image registry access secret myregistry...
OK

ibmcloud ce registry get

Permet d'afficher les détails d'un secret d'accès à un registre d'images.

ibmcloud ce registry get --name NAME [--decode] [--output OUTPUT] [--quiet]

Options de commande

--name, -n
Nom du secret d'accès au registre d'images. Cette valeur est obligatoire.
--decode, -d
Affiche la sortie de Data sous une forme décodée dans les détails. Si cette option n'est pas spécifiée, les détails de Data sont codés en base64. Cette valeur est facultative. La valeur par défaut est false.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce registry get --name myregistry   

Exemple de sortie

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

Permet de répertorier tous les secrets d'accès à un registre d'images d'un projet.

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

Options de commande

--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce registry list   

Exemple de sortie

Listing image registry access secrets...
OK
Name        Age
myregistry  19m22s

ibmcloud ce registry update

Permet de mettre à jour un secret d'accès à un registre d'images.

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]

Options de commande

--name, -n
Nom du secret d'accès au registre d'images. Cette valeur est obligatoire.
--email, -e
Adresse électronique permettant d'accéder au serveur de registre. Cette valeur est facultative.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--password, -p
Mot de passe permettant d'accéder au serveur de registre. Cette valeur est facultative.
--password-from-file, --pf
Chemin d'accès à un fichier qui contient le mot de passe permettant d'accéder au serveur de registre. La première ligne du fichier est utilisée pour le mot de passe. Cette valeur est facultative.
--password-from-json-file, --pfj
Chemin d'accès à un fichier JSON qui contient le mot de passe permettant d'accéder au serveur de registre. La zone apikey est utilisé pour le mot de passe. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--server, -s
URL du serveur de registre. Cette valeur est facultative.
--username, -u
Nom d'utilisateur permettant d'accéder au serveur de registre. Cette valeur est facultative.

Exemple

L'exemple suivant met à jour un mot de passe d'accès au registre d'images myregistry.

ibmcloud ce registry update --name myregistry --password NEW_API_KEY  

Exemple de sortie

Getting image registry access secret 'myregistry'...
Updating image registry access secret 'myregistry'...
OK

Commandes repo

Un référentiel de code, tel que GitHub ou GitLab, stocke du code source. Grâce à Code Engine, vous pouvez ajouter un accès à un référentiel de code privé, puis référencer ce référentiel à partir de votre génération.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes repo.

Pour plus d'informations sur l'accès aux référentiels, reportez-vous à la rubrique décrivant l'accès aux référentiels de code privés.

Pour consulter l'aide de l'interface en ligne de commande (CLI) relative aux commandes « repo », exécutez la commande « ibmcloud ce repo -h ».

À partir de la version de l'interface de programmation 1.42.0, la définition et l'utilisation des secrets dans l'interface de programmation sont unifiées sous le groupe de commandes secret sous le groupe de commandes Voir ibmcloud ce secret les commandes. Utilisez l'option --format pour spécifier la catégorie du secret, par exemple basic_auth, generic, hmac, ssh, tls, ou registry. Bien que vous puissiez continuer à utiliser le groupe de commande repo vous pouvez continuer à utiliser le groupe de commande, mais vous pouvez aussi tirer parti du groupe de commande unifié secret unifié. Pour créer un secret permettant d'accéder à un service avec une clé SSH, par exemple pour s'authentifier auprès d'un dépôt Git comme GitHub ou GitLab,, utilisez la commande ibmcloud ce secret create --format ssh commande. Un secret SSH est également utilisé comme secret d'accès au référentiel Git. Pour en savoir plus sur le travail avec les secrets dans Code Engine, voir Travailler avec des secrets.

ibmcloud ce repo create

Permet de créer un secret d'accès à un référentiel 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]

Options de commande

--host, --ho

Adresse de l'hôte ; par exemple, github.com. Cette valeur est obligatoire.

--key-path, --kp

Chemin d'accès à votre fichier de clé privée SSH non chiffrée. Si vous utilisez votre clé SSH privée personnelle, ce fichier se trouve généralement sur $HOME/.ssh/id_rsa (Mac OS ou Linux) ou sur %HOMEPATH%\.ssh\id_rsa (Windows). Cette valeur est obligatoire.

-n, --name

Nom du secret d'accès à un référentiel Git. Utilisez un nom unique dans le projet.

  • Le nom doit débuter et se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 253 caractères au maximum et peut contenir des lettres minuscules, des chiffres, des points (.) et des tirets (-).

Cette valeur est obligatoire.

--known-hosts-path, --khp
Chemin d'accès à votre fichier hosts qui recense les hôtes connus. Cette valeur est une fonction de sécurité qui permet de s'assurer que la clé privée est utilisée uniquement pour s'authentifier sur des hôtes auxquels vous avez accédé précédemment, les hôtes GitHub ou GitLab. Ce fichier se trouve généralement sur $HOME/.ssh/known_hosts (Mac OS ou Linux) ou sur %HOMEPATH%\.ssh\known_hosts (Windows). Cette valeur est facultative.
--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

La commande suivante crée un secret d'accès Git appelé github pour l'hôte github.com et authentifie avec une clé SSH située à l'emplacement /<filepath>/.ssh/id_rsa, où <filepath> est le chemin d'accès sur votre système.

ibmcloud ce repo create -n github --key-path /<filepath>/.ssh/id_rsa --host github.com  

Exemple de sortie

Creating Git access secret github...
OK

ibmcloud ce repo delete

Permet de supprimer un secret d'accès à un référentiel Git.

ibmcloud ce repo delete --name NAME [--force] [--ignore-not-found] [--quiet]

Options de commande

--name, -n
Nom du secret d'accès à un référentiel Git. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce repo delete --name github

Exemple de sortie

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

Permet d'afficher les détails d'un secret d'accès à un référentiel Git.

ibmcloud ce repo get --name NAME [--decode] [--output OUTPUT] [--quiet]

Options de commande

--name, -n
Nom du secret d'accès à un référentiel Git. Cette valeur est obligatoire.
--decode, -d
Affiche la sortie de Data sous une forme décodée dans les détails. Si cette option n'est pas spécifiée, les détails de Data sont codés en base64. Cette valeur est facultative. La valeur par défaut est false.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce repo get -n github

Exemple de sortie

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

Permet de répertorier tous les secrets d'accès à un référentiel Git d'un projet.

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

Options de commande

--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce repo list

Exemple de sortie

Listing Git access secrets...
OK
Name    Age  
github  13m0s  

ibmcloud ce repo update

Permet de mettre à jour un secret d'accès à un référentiel Git.

ibmcloud ce repo update --name SECRET_NAME [--host HOST] [--key-path KEY_PATH] [--known-hosts-path KNOWN_HOSTS_PATH] [--output OUTPUT] [--quiet]

Options de commande

--name, -n
Nom du secret d'accès à un référentiel Git. Cette valeur est obligatoire.
--host, --ho
Adresse de l'hôte ; par exemple, github.com. Cette valeur est facultative.
--key-path, --kp
Chemin d'accès à votre fichier de clé privée SSH non chiffrée. Si vous utilisez votre clé SSH privée personnelle, ce fichier se trouve généralement sur $HOME/.ssh/id_rsa (Mac OS ou Linux) ou sur %HOMEPATH%\.ssh\id_rsa (Windows). Cette valeur est facultative.
--known-hosts-path, --khp
Chemin d'accès à votre fichier hosts qui recense les hôtes connus. Cette valeur est une fonction de sécurité qui permet de s'assurer que la clé privée est utilisée uniquement pour s'authentifier sur des hôtes auxquels vous avez accédé précédemment, les hôtes GitHub ou GitLab. Ce fichier se trouve généralement sur $HOME/.ssh/known_hosts (Mac OS ou Linux) ou sur %HOMEPATH%\.ssh\known_hosts (Windows). Cette valeur est facultative.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

La commande suivante met à jour un secret d'accès Git appelé github pour utiliser un nouvel hôte.

ibmcloud ce repo update  -n github --host NEW_HOST  

Exemple de sortie

Getting Git access secret 'github'...
Updating Git access secret 'github'...
OK

Commandes revision

Une application exécute votre code pour servir les demandes HTTP. Outre les demandes HTTP traditionnelles, IBM Cloud® Code Engine prend en charge les applications qui utilisent WebSockets comme protocole de communication. Une application contient une ou plusieurs révisions. Une révision représente une version non modifiable des propriétés de configuration de l'application. Chaque mise à jour d'une propriété de configuration d'application crée une nouvelle révision de l'application.

Utilisez les commandes revision pour gérer les révisions d'application.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes revision.

Pour plus d'informations sur l'utilisation des révisions pour les applications, voir Déploiement d'applications.

Vous pouvez utiliser soit revisionourev dans vos commandesrevision. Pour afficher l'aide de l'interface de ligne de commande relative aux commandes revision, exécutez la commande ibmcloud ce revision -h.

ibmcloud ce revision delete

Supprimez une révision d'application.

ibmcloud ce revision delete --name REVISION_NAME [--force] [--ignore-not-found] [--quiet]

Options de commande

--name, -n
Nom de la révision d'application. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce revision delete -n newapp-mytest-00004 -f

Exemple de sortie

Deleting application revision 'newapp-mytest-00004'...
OK

ibmcloud ce revision events

Affichez les événements système des instances de révision d'application. Les événements système sont conservés jusqu'à 60 minutes.

ibmcloud ce revision events (--instance REVISION_INSTANCE | --revision REVISION_NAME) [--output OUTPUT] [--quiet]

Options de commande

--instance, -i
Nom d'une instance d'application spécifique. Utilisez la commande rev get pour identifier le nom de l'instance. Cette valeur est obligatoire si --revision n'est pas spécifié.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--revision, --rev, -r, --name, -n
Permet d'afficher les événements de toutes les instances de la révision d'application spécifiée. Cette valeur est obligatoire si --instance n'est pas spécifié.

Exemple

ibmcloud ce revision events -n myapp-00001

Exemple de sortie

Code Engine conserve uniquement la révision inactive la plus récente de votre application, en plus de votre révision d'application active. Les révisions plus anciennes ne sont pas conservées.

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

Permet d'afficher les détails d'une révision d'application.

ibmcloud ce revision get --name REVISION_NAME [--output OUTPUT] [--quiet]

Options de commande

--name, -n
Nom de la révision d'application. Cette valeur est obligatoire.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce revision get --name newapp-mytest-00002

Exemple de sortie

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

Permet de répertorier toutes les révisions d'application d'un projet.

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

Options de commande

--application, --app, -a
Utilisez cette option pour afficher uniquement les révisions de l'application spécifiée. Cette valeur est facultative.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce revision list

Exemple de sortie

Code Engine conserve uniquement la révision inactive la plus récente de votre application, en plus de votre révision d'application active. Les révisions plus anciennes ne sont pas conservées.

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

Permet d'afficher les journaux des instances de révision d'application.

ibmcloud ce revision logs (--instance REVISION_INSTANCE | --revision REVISION_NAME) [--all-containers] [--follow] [--output OUTPUT] [--quiet] [--tail TAIL] [--timestamps]

Options de commande

--all-containers, --all
Permet d'afficher les journaux de tous les conteneurs des instances de révision d'application spécifiées. Cette valeur est facultative. La valeur par défaut est false.
--follow, -f
Permet de suivre les journaux des instances de révision d'application. Utilisez cette option pour diffuser les journaux des instances de révision d'application. Si vous spécifiez l'option --follow, vous devez entrer Ctrl+C pour mettre fin à cette commande de journal. Cette valeur est facultative. La valeur par défaut est false.
--instance, -i
Nom d'une instance de révision d'application spécifique. Utilisez la commande revision get pour identifier le nom de l'instance. Cette valeur est obligatoire si --revision n'est pas spécifié.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--revision, --rev, -r, --name, -n
Permet d'afficher les journaux de toutes les instances de la révision d'application spécifiée. Cette valeur est obligatoire si --instance n'est pas spécifié.
--tail, -t
Permet de limiter l'affichage des journaux des conteneurs des instances de révision d'application spécifiées à un nombre maximal de lignes récentes par conteneur. Par exemple, pour afficher les dernières lignes 3 des journaux des conteneurs des instances de révision d'application spécifiées, indiquez --tail 3. Si cette option n'est pas spécifiée, toutes les lignes des journaux des conteneurs des instances de révision d'application spécifiées sont affichées. Cette valeur est facultative. La valeur par défaut est -1.
--timestamps, --ts
Permet d'inclure des horodatages sur chaque ligne dans la sortie de journal. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce revision logs -n myapp-00001

Exemple de sortie

Code Engine conserve uniquement la révision inactive la plus récente de votre application, en plus de votre révision d'application active. Les révisions plus anciennes ne sont pas conservées.

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

Commandes secret

Un secret fournit une méthode permettant d'inclure des informations de configuration sensibles, telles que des mots de passe ou des clés SSH, à votre déploiement. En utilisant les valeurs issues de votre secret, vous pouvez dissocier les informations sensibles de votre déploiement afin de garantir la portabilité de votre application, de votre fonction ou de votre tâche. Quiconque dispose de droits sur votre projet peut également afficher vos secrets : assurez-vous que les informations secrètes peuvent être partagées avec ces utilisateurs. Les secrets contiennent des informations dans des paires clé-valeur.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes secret.

Pour plus d'informations sur l'utilisation des secrets, voir Travailler avec des secrets.

Pour consulter l'aide de l'interface en ligne de commande (CLI) relative aux commandes « secret », exécutez la commande « ibmcloud ce secret -h ».

À partir de la version de l'interface de programmation 1.42.0, la définition et l'utilisation des secrets dans l'interface de programmation sont unifiées sous le groupe de commandes secret sous le groupe de commandes Utilisez l'option --format pour spécifier la catégorie du secret, par exemple basic_auth, generic, hmac, ssh, tls, ou registry. La valeur par défaut de l'option --format est generic.

ibmcloud ce secret create

Créer un secret.

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]

Options de commande

--access-key-id, --akid

Spécifier l'ID de clé d'accès (access_key_id) des données d'identification HMAC. Cette valeur est facultative.

--access-key-id-prompt

Demander l'ID de clé d'accès (access_key_id) des données d'identification HMAC. Cette valeur est facultative. La valeur par défaut est false.

--cert-chain-file, --ccf

Indiquez un fichier contenant la chaîne de certificats fournie par votre autorité de certification pour un secret « TLS ». Vous devez fournir le chemin d'accès au fichier en tant que valeur. Cette valeur est requise pour les secrets tls. Cette valeur est facultative.

--email, --em

L'adresse électronique permettant d'accéder au serveur de registre pour obtenir un secret de registre. Cette valeur ne s'applique qu'aux secrets registry. Cette valeur est facultative.

--format, --fo

Format du secret. Les valeurs valides sont : basic_auth, generic, hmac, registry, ssh ou tls. Cette valeur est facultative. La valeur par défaut est generic.

--from-env-file, -e

Permet de créer un secret générique à partir d'un fichier contenant une ou plusieurs lignes correspondant au format KEY=VALUE. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Chaque ligne du fichier spécifié est ajoutée en tant que paire clé-valeur. Toutes les lignes du fichier indiqué qui sont vides ou commencent par #sont ignorées. Cette valeur est obligatoire si --from-literal ou --from-file n'est pas spécifié. Cette option peut être spécifiée plusieurs fois. Cette valeur ne s'applique qu'aux secrets generic.

--from-file, -f

Permet de créer un secret générique à partir d'un fichier. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Cette valeur est obligatoire si --from-literal ou --from-env-file n'est pas spécifié. Cette option peut être spécifiée plusieurs fois. Cette valeur ne s'applique qu'aux secrets generic.

--from-json-file, --json

Chemin d'accès à un fichier contenant les valeurs secrètes au format JSON. Cette option est prise en charge pour le format secret hmac Cette valeur est facultative.

--from-literal, -l

Permet de créer un secret générique à partir d'une paire clé-valeur. Le format requis est KEY=VALUE. Cette valeur est obligatoire si --from-file ou --from-env-file n'est pas spécifié. Cette option peut être spécifiée plusieurs fois. Cette valeur ne s'applique qu'aux secrets generic.

--key-path, --kp

Le chemin d'accès à votre fichier de clé privée SSH non chiffrée pour un secret SSH. Si vous utilisez votre clé SSH privée personnelle, ce fichier se trouve généralement sur $HOME/.ssh/id_rsa (Mac OS ou Linux) ou sur %HOMEPATH%\.ssh\id_rsa (Windows). Cette valeur est requise pour les secrets ssh. Cette valeur est facultative.

--known-hosts-path, --khp

Le chemin d'accès à votre fichier d'hôtes connus pour un secret SSH. Cette valeur est une fonction de sécurité qui permet de s'assurer que la clé privée est utilisée uniquement pour s'authentifier sur des hôtes auxquels vous avez accédé précédemment, les hôtes GitHub ou GitLab. Ce fichier se trouve généralement sur $HOME/.ssh/known_hosts (Mac OS ou Linux) ou sur %HOMEPATH%\.ssh\known_hosts (Windows). Cette valeur ne s'applique qu'aux secrets ssh. Cette valeur est facultative.

-n, --name

Nom du secret. Utilisez un nom unique dans le projet.

  • Le nom doit débuter et se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 253 caractères au maximum et peut contenir des lettres minuscules, des chiffres, des points (.) et des tirets (-).

Cette valeur est facultative.

--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--password, --pw

Le mot de passe pour une authentification de base ou un secret de registre. Si aucune des options --password, --password-from-file ou --password-from-json-file n'est spécifiée, vous êtes invité à indiquer le mot de passe. Cette valeur est requise pour les secrets basic_auth et registry. Cette valeur est facultative.

--password-from-file, --spf

Chemin d'accès à un fichier contenant le mot de passe d'une authentification de base ou d'un secret de registre. La première ligne du fichier est utilisée pour le mot de passe. Si aucune des options --password, --password-from-file ou --password-from-json-file n'est spécifiée, vous êtes invité à indiquer le mot de passe. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Cette valeur est requise pour les secrets basic_auth et registry. Cette valeur est facultative.

--password-from-json-file, --spfj

Chemin d'accès à un fichier JSON contenant le mot de passe d'une authentification de base ou d'un secret de registre. La zone apikey est utilisé pour le mot de passe. Si aucune des options --password, --password-from-file ou --password-from-json-file n'est spécifiée, vous êtes invité à indiquer le mot de passe. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Cette valeur est requise pour les secrets basic_auth et registry. Cette valeur est facultative.

--private-key-file, --pkf

Utilisez l'option cert-chain-file pour spécifier un fichier contenant la clé privée d'un secret « TLS » correspondant à la chaîne de certificats indiquée. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Cette valeur est requise pour les secrets tls. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette option s'applique aux secrets basic_auth, generic, registry, ssh et tls. Cette valeur est facultative. La valeur par défaut est false.

--secret-access-key, --sak

Spécifier la clé d'accès secrète (secret_access_key) des données d'identification HMAC. Cette valeur est facultative.

--secret-access-key-prompt

Demander la clé d'accès secrète (secret_access_key) des données d'identification HMAC. Cette valeur est facultative. La valeur par défaut est false.

--server, -s

Le site URL du serveur de registre pour un secret de registre. Cette option est requise pour les secrets registry. Cette valeur est facultative. La valeur par défaut est us.icr.io.

--username, -u

Le nom d'utilisateur pour votre authentification de base ou votre clé secrète de registre. Cette option est requise pour les secrets basic_auth et registry. Cette valeur est facultative.

Exemple de secret d'authentification de base

Un secret d'authentification de base contient une clé username et password et est utilisé lorsque vous accédez à un service qui nécessite une authentification de base HTTP.

Pour obtenir l'aide du CLI pour la création d'un secret d'authentification de base, exécutez ibmcloud ce secret create --format basic_auth.

L'exemple suivant crée un secret d'authentification de base nommé mysecret-basicauth. Ce secret contient le nom d'utilisateur myusername, et la valeur du mot de passe est obtenue à partir d'un fichier sur la machine locale. Si le mot de passe n'est pas fourni par un fichier ou un fichier JSON, vous êtes invité à saisir la valeur du mot de passe.

ibmcloud ce secret create --name mysecret-basicauth --format basic_auth --username myusername --password-from-file ./password.txt

Exemple de résultat pour un secret d'authentification de base

Creating basic_auth secret 'mysecret-basicauth'...
OK

Exemple de secret générique

Un secret générique stocke de simples paires clé-valeur et Code Engine ne fait aucune hypothèse sur les paires clé-valeur définies ni sur l'utilisation prévue du secret.

Pour obtenir de l'aide sur la création d'un secret générique, exécutez ibmcloud ce secret create ou ibmcloud ce secret create --format generic.

Notez que --format generic est la valeur par défaut lorsque vous créez un secret avec la commande secret create dans l'interface de programmation.

L'exemple suivant crée un secret générique nommé mysecret-generic et la valeur de ce secret est spécifiée pour une paire clé-valeur avec l'option --from-literal.

ibmcloud ce secret create --name mysecret-generic --format generic --from-literal "TARGET=My literal secret"

Exemple de résultat pour un secret générique

Creating generic secret 'mysecret-generic'...
OK

Exemple de secret générique avec des valeurs provenant d'un fichier

L'exemple illustré ci-après crée un secret nommé mysecret-fromfile avec des valeurs provenant d'un fichier. En utilisant l'option --from-file pour pointer vers un fichier, tout le contenu du fichier devient la valeur de la paire clé-valeur.

ibmcloud ce secret create --name mysecret-genericfromfile  --from-file ./value1.txt --from-file ./value2.txt
Exemple de résultat pour un secret générique avec des valeurs provenant d'un fichier
Creating secret mysecret-genericfromfile...
OK

Exemple de secret HMAC

Un secret HMAC contient une clé access_key_id et une clé secret_access_key et est utilisé avec des outils et des bibliothèques S3-compatible qui nécessitent une authentification mais ne prennent pas en charge les clés API IBM Cloud® Identity and Access Management.

Pour obtenir l'aide du CLI pour la création d'un secret HMAC, exécutez ibmcloud ce secret create --format hmac.

L'exemple suivant crée un secret HMAC nommé mysecret-hmac. Ce secret contient les valeurs access_key_id et secret_access_key fournies lorsqu'elles sont demandées. Si l'une des deux options n'est pas fournie avec la commande ou dans un fichier JSON, vous êtes invité à en saisir les valeurs.

ibmcloud ce secret create --name mysecret-hmac --format hmac --access-key-id-prompt --secret-access-key-prompt

Exemple de sortie pour un secret HMAC

Creating hmac_auth secret 'mysecret-hmac'...
OK

Exemple de secret de registre

Un secret de registre stocke les informations d'identification permettant d'accéder à un registre de conteneurs.

Pour obtenir l'aide de l'interface de programmation pour la création d'un secret de registre, exécutez ibmcloud ce secret create --format registry.

L'exemple suivant crée un secret de registre nommé mysecret-registry pour une instance IBM Cloud Container Registry qui se trouve sur le serveur de registre us.icr.io et spécifie des informations d'identification pour username et password.

ibmcloud ce secret create --name mysecret-registry --format registry --server us.icr.io --username iamapikey --password API_KEY

Exemple de résultat pour un secret de registre

Creating registry secret `mysecret-registry`...
OK

Exemple de secret SSH

Un secret SSH stocke les informations d'identification pour s'authentifier auprès d'un service avec une clé SSH; par exemple, s'authentifier auprès d'un référentiel Git, tel que GitHub ou GitLab.

Pour obtenir de l'aide sur la création d'un secret SSH, exécutez ibmcloud ce secret create --format ssh.

L'exemple suivant crée un secret SSH nommé mysecret-ssh pour un hôte inclus dans le fichier known_hosts et s'authentifie avec un fichier de clé privée SSH non chiffrée situé à l'adresse /<filepath>/.ssh/<key_name>, où <filepath> est le chemin d'accès sur votre système. Cette commande nécessite un nom et un chemin d'accès à la clé, et autorise également d'autres arguments facultatifs tels que le chemin d'accès au fichier des hôtes connus.

ibmcloud ce secret create --name mysecret-ssh --format ssh --key-path ~/.ssh/<key_name> --known-hosts-path  ~/.ssh/known_hosts

Exemple de sortie pour un secret SSH

Creating SSH secret `mysecret-ssh`...
OK

Exemple de secret TLS

Un secret de sécurité de la couche transport ( TLS ) contient un certificat TLS signé, y compris tous ses certificats intermédiaires, et sa clé privée correspondante provenant d'une autorité de certification (CA). Utilisez les secrets TLS lorsque vous travaillez avec des mappages de domaines personnalisés.

Pour obtenir l'aide du CLI pour la création d'un secret TLS, exécutez ibmcloud ce secret create --format tls.

L'exemple suivant crée un secret TLS nommé mysecret-tls. La chaîne de certificats correspondant au domaine personnalisé est contenue dans le fichier certificate.txt et le fichier de clés privées correspondant est contenu dans le fichier privatekey.txt. Ces deux fichiers sont situés dans le répertoire racine du poste de travail local.

ibmcloud ce secret create --name mysecret-tls  --format tls  --cert-chain-file certificate.txt --private-key-file privatekey.txt

Exemple de résultat pour un secret TLS

Creating TLS secret `mysecret-tls`...
OK

ibmcloud ce secret delete

Supprimer un secret.

ibmcloud ce secret delete --name SECRET_NAME [--force] [--ignore-not-found] [--quiet]

Options de commande

--name, -n
Nom du secret. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce secret delete --name mysecret-genericfromfile -f

Exemple de sortie

Deleting secret mysecret-genericfromfile...
OK

ibmcloud ce secret get

Affichez les détails d'un secret.

ibmcloud ce secret get --name SECRET_NAME [--decode] [--output OUTPUT] [--quiet]

Options de commande

--name, -n
Nom du secret. Cette valeur est obligatoire.
--decode, -d
Affiche la sortie de Data sous une forme décodée dans les détails. Si cette option n'est pas spécifiée, les détails de Data sont codés en base64. Cette valeur est facultative. La valeur par défaut est false.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce secret get --name mysecret-basicauth

Exemple de sortie

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

Répertorier tous les secrets d'un projet.

ibmcloud ce secret list [--all] [--format FORMAT] [--output OUTPUT] [--quiet] [--sort-by SORT_BY]

Options de commande

--all, -a
Afficher tous les secrets de tous les formats, y compris les secrets basic_auth, generic, registry, ssh, tls, et other qui ne sont pas gérés par Code Engine. Cette valeur est facultative. La valeur par défaut est false.
--format, --fo
Spécifiez cette option pour filtrer l'affichage des secrets. Les valeurs valides sont : basic_auth, generic, registry, ssh et tls. Cette valeur est facultative.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

Cette commande permet de dresser la liste de tous les secrets d'un projet.

ibmcloud ce secret list

Exemple de sortie

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

Créer un secret.

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]

Options de commande

--name, -n
Nom du secret. Cette valeur est obligatoire.
--access-key-id, --akid
Spécifier l'ID de clé d'accès (access_key_id) des données d'identification HMAC. Cette valeur est facultative.
--access-key-id-prompt
Demander l'ID de clé d'accès (access_key_id) des données d'identification HMAC. Cette valeur est facultative. La valeur par défaut est false.
--cert-chain-file, --ccf
Indiquez un fichier contenant la chaîne de certificats fournie par votre autorité de certification pour un secret « TLS ». Vous devez fournir le chemin d'accès au fichier en tant que valeur. Cette valeur est facultative.
--email, --em
L'adresse électronique permettant d'accéder au serveur de registre pour obtenir un secret de registre. Cette valeur est facultative.
--from-env-file, -e
Permet de mettre à jour un secret générique à partir d'un fichier contenant une ou plusieurs lignes correspondant au format KEY=VALUE. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Chaque ligne du fichier spécifié est ajoutée en tant que paire clé-valeur. Toutes les lignes du fichier indiqué qui sont vides ou commencent par #sont ignorées. Cette valeur est obligatoire si --from-literal ou --from-file n'est pas spécifié.
--from-file, -f
Permet de mettre à jour un secret générique à partir d'un fichier. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Cette valeur est obligatoire si --from-literal ou --from-env-file n'est pas spécifié.
--from-json-file, --json
Chemin d'accès à un fichier contenant les valeurs secrètes au format JSON. Cette option est prise en charge pour le format secret hmac Cette valeur est facultative.
--from-literal, -l
Permet de mettre à jour un secret générique à partir d'une paire clé-valeur. Le format requis est KEY=VALUE. Cette valeur est obligatoire si --from-file ou --from-env-file n'est pas spécifié. Cette option peut être spécifiée plusieurs fois.
--key-path, --kp
Le chemin d'accès à votre fichier de clé privée SSH non chiffrée pour un secret SSH. Si vous utilisez votre clé SSH privée personnelle, ce fichier se trouve généralement sur $HOME/.ssh/id_rsa (Mac OS ou Linux) ou sur %HOMEPATH%\.ssh\id_rsa (Windows). Cette valeur est facultative.
--known-hosts-path, --khp
Le chemin d'accès à votre fichier d'hôtes connus pour un secret SSH. Cette valeur est une fonction de sécurité qui permet de s'assurer que la clé privée est utilisée uniquement pour s'authentifier sur des hôtes auxquels vous avez accédé précédemment, les hôtes GitHub ou GitLab. Ce fichier se trouve généralement sur $HOME/.ssh/known_hosts (Mac OS ou Linux) ou sur %HOMEPATH%\.ssh\known_hosts (Windows). Cette valeur est facultative.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--password, --pw
Le mot de passe pour une authentification de base ou un secret de registre. Si aucune des options --password, --password-from-file ou --password-from-json-file n'est spécifiée, vous êtes invité à indiquer le mot de passe. Cette valeur est facultative.
--password-from-file, --spf
Chemin d'accès à un fichier contenant le mot de passe d'une authentification de base ou d'un secret de registre. La première ligne du fichier est utilisée pour le mot de passe. Si aucune des options --password, --password-from-file ou --password-from-json-file n'est spécifiée, vous êtes invité à indiquer le mot de passe. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Cette valeur est facultative.
--password-from-json-file, --spfj
Chemin d'accès à un fichier JSON contenant le mot de passe d'une authentification de base ou d'un secret de registre. La zone apikey est utilisé pour le mot de passe. Si aucune des options --password, --password-from-file ou --password-from-json-file n'est spécifiée, vous êtes invité à indiquer le mot de passe. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Cette valeur est facultative.
--private-key-file, --pkf
Utilisez l'option cert-chain-file pour spécifier un fichier contenant la clé privée d'un secret « TLS » correspondant à la chaîne de certificats indiquée. Vous devez fournir le chemin d'accès au fichier en tant que valeur. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--rm
Permet de retirer une paire clé-valeur individuelle d'un secret générique en spécifiant le nom de la clé. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--secret-access-key, --sak
Spécifier la clé d'accès secrète (secret_access_key) des données d'identification HMAC. Cette valeur est facultative.
--secret-access-key-prompt
Demander la clé d'accès secrète (secret_access_key) des données d'identification HMAC. Cette valeur est facultative. La valeur par défaut est false.
--server, -s
Le site URL du serveur de registre pour un secret de registre. Cette valeur est facultative. La valeur par défaut est us.icr.io.
--username, -u
Le nom d'utilisateur pour votre authentification de base ou votre clé secrète de registre. Cette valeur est facultative.

Exemple

Cet exemple met à jour un secret TLS avec un certificat et une clé privée actualisés.

ibmcloud ce secret update --name mysecret-tls --cert-chain-file certificate2.txt --private-key-file privatekey2.txt

Exemple de sortie

Updating secret mysecret-tls..
OK

Commandes de cos d'abonnement

Souvent, dans les environnements distribués, vous avez besoin que vos applications ou vos travaux réagissent aux messages (événements) générés à partir d'autres composants, qui sont généralement appelés des producteurs d'événements. Avec Code Engine, vos applications ou vos travaux peuvent recevoir des événements d'intérêt grâce à un abonnement à des producteurs d'événements. Les informations relatives aux événements sont reçues sous forme de demandes HTTP POST pour les applications et sous forme de variables d'environnement pour les travaux.

Le fournisseur d'événements Object Storage génère des événements au fur et à mesure que des modifications sont apportées aux objets de vos compartiments de stockage d'objets. Par exemple, lorsque des objets sont ajoutés à un compartiment, une application peut recevoir un événement, puis effectuer une action en fonction de cette modification, peut-être en consommant ce nouvel objet.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes subscription cos.

Pour plus d'informations sur l'utilisation des abonnements IBM Cloud Object Storage, voir Utilisation du producteur d'événements IBM Cloud Object Storage. Voir Initiation aux abonnements pour plus d'informations sur l'utilisation des abonnements dans Code Engine.

Vous pouvez utiliser soit subscriptionousub dans vos commandessubscription cos. Pour afficher l'aide de l'interface de ligne de commandesubscription cos, exécutez ibmcloud ce sub cos -h.

ibmcloud ce subscription cos create

Permet de créer un abonnement à des événements 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]

Options de commande

--bucket, -b

Compartiment pour des événements. La destination et le compartiment doivent figurer dans la même région que le projet. Cette valeur est obligatoire.

--destination, -d

Le nom de l'application ou de la ressource de travail que vous souhaitez recevoir des événements ; par exemple,myapp. Si nécessaire, utilisez l'option --path pour qualifier davantage une destination d'application. Cette valeur est obligatoire.

-n, --name

Nom de l'abonnement à des événements IBM Cloud Object Storage. Utilisez un nom unique dans le projet.

  • Le nom doit débuter et se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 253 caractères au maximum et peut contenir des lettres minuscules, des chiffres, des points (.) et des tirets (-).

Cette valeur est obligatoire.

--destination-type, --dt
Type de la destination. Les valeurs valides sont app et job. Cette valeur est facultative. La valeur par défaut est app.
--event-type, -e

Types d'événement à surveiller. Les valeurs valides sont : delete, write et all. Cette valeur est facultative. La valeur par défaut est all.

--extension, --ext

Permet de définit les extensions CloudEvents à envoyer à la destination. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle extension CloudEvents ou de remplacer un attribut CloudEvent existant. Spécifiez une extension à l'aide de l'option --extension ; par exemple, --ext extA=A --ext extB=B. Cette valeur est facultative.

--force, -f

Permet de forcer la création d'un abonnement à des événements IBM Cloud Object Storage. Cette option ignore la validation de la destination spécifiée. Cette valeur est facultative. La valeur par défaut est false.

--no-wait, --nw

Permet de créer l'abonnement à des événements IBM Cloud Object Storage sans attendre que l'abonnement soit prêt. Si vous spécifiez l'option --no-wait, la création de l'abonnement démarre, sans attendre. Utilisez la commande subscription cos get pour vérifier l'état de l'abonnement. Cette valeur est facultative. La valeur par défaut est false.

--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--path

Chemin dans l'application destination dans lequel les événements sont acheminés, par exemple /events. Le chemin par défaut est l'URL racine de l'application de destination. Cette option ne peut être spécifiée que si destination-type est app. Cette valeur est facultative.

--prefix, -p

Préfixe de l'objet IBM Cloud Object Storage. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--suffix, -s

Suffixe de l'objet IBM Cloud Object Storage. Tenez compte du type de fichier de votre fichier lors de la spécification du suffixe. Cette valeur est facultative.

--wait, -w

Permet de créer l'abonnement à des événements IBM Cloud Object Storage et d'attendre que l'abonnement soit prêt. Si vous spécifiez l'option --wait, le délai d'attente maximal, en secondes, pour la création de l'abonnement est défini par l'option --wait-timeout pour que l'abonnement soit prêt. Si l'abonnement n'est pas prêt dans le délai --wait-timeout spécifié, la création de l'abonnement à des événements IBM Cloud Object Storage échoue. Cette valeur est facultative. La valeur par défaut est true.

--wait-timeout, --wto

Durée d'attente en secondes avant que l'abonnement à l'événement IBM Cloud Object Storage soit prêt. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 15.

Exemple

L'abonnement IBM Cloud Object Storage est à l'écoute des changements apportés à un compartiment Object Storage. L'exemple suivant crée un abonnement COS appelé mycosevent pour un compartiment appelé mybucket qui est attaché à une application appelée myapp. L'option --destination-type indique le type de destination qui est app ou job. Dans cet exemple, l'option--destination-type a pour valeur app, qui est la valeur par défaut pour cette option. L’évènement est envoyé au chemin /events à l'aide de l'option --path afin que l’évènement soit envoyé à https://<base application URL>/events.

ibmcloud ce subscription cos create --name mycosevent --destination myapp --bucket mybucket --destination-type app --path /events

Exemple de sortie

Creating COS source 'mycosevent'...
Run 'ibmcloud ce subscription cos get -n mycosevent' to check the COS source status.
OK

ibmcloud ce subscription cos delete

Permet de supprimer un abonnement à des événements 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]

Options de commande

--name, -n
Nom de l'abonnement à des événements IBM Cloud Object Storage. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--no-wait, --nw
Permet de supprimer l'abonnement à des événements IBM Cloud Object Storage sans attendre que l'abonnement soit supprimé. Si vous spécifiez l'option --no-wait, la suppression de l'abonnement démarre, sans attendre. Utilisez la commande subscription cos get pour vérifier l'état de l'abonnement. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--wait, -w
Permet de supprimer l'abonnement à des événements IBM Cloud Object Storage et d'attendre que l'abonnement soit supprimé. Si vous spécifiez l'option --wait, le délai d'attente maximal, en secondes, pour la suppression de l'abonnement est défini par l'option --wait-timeout. Cette commande prend fin lorsque l'abonnement est supprimé ou lorsque le délai indiqué par l'option --wait-timeout est atteint, selon ce qui survient en premier. Cette valeur est facultative. La valeur par défaut est true.
--wait-timeout, --wto
Délai d'attente en secondes avant que l'abonnement à des événements IBM Cloud Object Storage soit supprimé. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 15.

Exemple

ibmcloud ce subscription cos delete --name mycosevent -f

Exemple de sortie

Deleting COS source 'mycosevent'...
OK

ibmcloud ce subscription cos get

Permet d'afficher les détails d'un abonnement à des événements IBM Cloud Object Storage. Les attributs affichés sont notamment Name, Destination, Bucket, Event Type, Prefix, Suffix, Ready et Age. Pour afficher des détails spécifiques, joignez| grep <attribute>.

ibmcloud ce subscription cos get --name COS_SOURCE_NAME [--output OUTPUT] [--quiet]

Options de commande

--name, -n
Nom de l'abonnement à des événements IBM Cloud Object Storage. Cette valeur est obligatoire.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce subscription cos get --name mycosevent

Exemple de sortie

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  

Lorsque Ready a pour valeur true, l'abonnement COS est prêt à déclencher des événements selon les changements apportés au compartiment COS.

ibmcloud ce subscription cos list

Permet de répertorier tous les abonnements à des événements IBM Cloud Object Storage dans un projet.

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

Options de commande

--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce subscription cos list

Exemple de sortie

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

Permet de mettre à jour un abonnement à des événements 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]

Options de commande

--name, -n
Nom de l'abonnement à des événements IBM Cloud Object Storage. Cette valeur est obligatoire.
--destination, -d
Le nom de l'application ou de la ressource de travail que vous souhaitez recevoir des événements ; par exemple,myapp. Si nécessaire, utilisez l'option --path pour qualifier davantage une destination d'application. Cette valeur est facultative.
--destination-type, --dt
Type de la destination. Les valeurs valides sont app et job. Cette valeur est facultative.
--event-type, -e
Types d'événement à surveiller. Les valeurs valides sont : delete, write et all. Cette valeur est facultative.
--extension, --ext
Permet de définit les extensions CloudEvents à envoyer à la destination. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle extension CloudEvents ou de remplacer un attribut CloudEvent existant. Spécifiez une extension à l'aide de l'option --extension ; par exemple, --ext extA=A --ext extB=B. Cette valeur est facultative.
--extension-rm, --ext-rm
Permet de supprimer les extensions CloudEvents à envoyer à la destination en spécifiant le nom de la clé. Spécifiez une extension à l'aide de l'option --ext-rm ; par exemple, --ext-rm extA --ext-rm extB. Cette valeur est facultative.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--path
Chemin dans l'application destination dans lequel les événements sont acheminés, par exemple /events. Le chemin par défaut est l'URL racine de l'application de destination. Cette option ne peut être spécifiée que si destination-type est app. Cette valeur est facultative.
--prefix, -p
Préfixe de l'objet IBM Cloud Object Storage. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--suffix, -s
Suffixe de l'objet IBM Cloud Object Storage. Tenez compte du type de fichier (extension) de votre fichier lors de la spécification du suffixe. Cette valeur est facultative.

Exemple

L'exemple illustré ci-après met à jour un abonnement COS nommé mycosevent pour être à l'écoute des événements d'écriture uniquement.

ibmcloud ce subscription cos update --name mycosevent --event-type write

Exemple de sortie

Updating COS source 'mycosevent'...
Run 'ibmcloud ce subscription cos get -n mycosevent' to check the COS source status.
OK

Commandes cron d'abonnement

Souvent, dans les environnements distribués, vous avez besoin que vos applications ou vos travaux réagissent aux messages (événements) générés à partir d'autres composants, qui sont généralement appelés des producteurs d'événements. Avec Code Engine, vos applications ou vos travaux peuvent recevoir des événements d'intérêt grâce à un abonnement à des producteurs d'événements. Les informations relatives aux événements sont reçues sous forme de demandes HTTP POST pour les applications et sous forme de variables d'environnement pour les travaux.

Le producteur d'événements cron est basé sur cron et génère un événement à intervalles réguliers. Utilisez un producteur d'événement cron lorsqu'une action doit être effectuée à des intervalles définis ou à des heures spécifiques.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes subscription cron.

Pour plus d'informations sur l'utilisation des abonnements IBM Cloud Object Storage, voir Utilisation du producteur d'événements temporisateur périodique (cron). Voir Initiation aux abonnements pour plus d'informations sur l'utilisation des abonnements dans Code Engine.

Vous pouvez utiliser soit subscriptionousub dans vos commandessubscription cron. Pour afficher l'aide de l'interface de ligne de commandesubscription cron, exécutez ibmcloud ce sub cron -h.

ibmcloud ce subscription cron create

Créer un abonnement à des événements 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]

Options de commande

--destination, -d

Le nom de l'application ou de la ressource de travail que vous souhaitez recevoir des événements ; par exemple,myapp. Si nécessaire, utilisez l'option --path pour qualifier davantage une destination d'application. Cette valeur est obligatoire.

-n, --name

Nom de l'abonnement à des événements cron. Utilisez un nom unique dans le projet.

  • Le nom doit débuter et se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 253 caractères au maximum et peut contenir des lettres minuscules, des chiffres, des points (.) et des tirets (-).

Cette valeur est obligatoire.

--content-type, --ct
Type de support de l'option --data ou --data-base64. Exemples : application/json, application/x-www-form-urlencoded, text/html et text/plain. Cette valeur est facultative.
--da, --data

Les données à envoyer à la destination ; par exemple, '{ "message": "Hello world!" }'. Si vous spécifiez l'option --data, n'utilisez pas l'option --data-base64.

Cette valeur est facultative.

--data-base64, --db
Données codées en base64 à envoyer à la destination ; par exemple, Q29kZSBFbmdpbmU=. Si vous spécifiez l'option --data-base64, n'utilisez pas l'option --data. Cette valeur est facultative.
--destination-type, --dt

Type de la destination. Les valeurs valides sont : app, function et job. Cette valeur est facultative. La valeur par défaut est app.

--extension, --ext

Permet de définit les extensions CloudEvents à envoyer à la destination. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle extension CloudEvents ou de remplacer un attribut CloudEvent existant. Spécifiez une extension à l'aide de l'option --extension ; par exemple, --ext extA=A --ext extB=B. Cette valeur est facultative.

--force, -f

Permet de forcer la création d'un abonnement à des événements cron. Cette option ignore la validation de la destination spécifiée. Cette valeur est facultative. La valeur par défaut est false.

--no-wait, --nw

Créer l'abonnement à des événements cron et ne pas attendre que l'abonnement soit prêt. Si vous spécifiez l'option --no-wait, la création de l'abonnement démarre, sans attendre. Utilisez la commande subscription cron get pour vérifier l'état de l'abonnement. Cette valeur est facultative. La valeur par défaut est false.

--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--path

Chemin dans l'application destination dans lequel les événements sont acheminés, par exemple /events. Le chemin par défaut est l'URL racine de l'application de destination. Cette option ne peut être spécifiée que si destination-type est app. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--schedule, -s

Permet de planifier la fréquence à laquelle l'événement est déclenché, au format crontab. Par exemple, indiquez '*/2 * * * *' (dans un format chaîne) pour toutes les deux minutes. Par défaut, l'événement cron est déclenché toutes les minutes et utilise le fuseau horaire UTC. Pour modifier le fuseau horaire, utilisez l'option --time-zone. Cette valeur est facultative.

--time-zone, --tz

Définissez le fuseau horaire de votre événement cron ; par exemple, Asia/Tokyo. Si vous spécifiez l'option --schedule, utilisez-la pour indiquer le fuseau horaire. Pour connaître les valeurs de fuseau horaire valides, voir la base de données des fuseaux horaires. Cette valeur est facultative. La valeur par défaut est UTC.

--wait, -w

Créer l'abonnement aux événements cron et attendre que l'abonnement soit prêt. Si vous spécifiez l'option --wait, le délai d'attente maximal, en secondes, pour la création de l'abonnement est défini par l'option --wait-timeout pour que l'abonnement soit prêt. Si l'abonnement n'est pas prêt dans le délai --wait-timeout spécifié, la création de l'abonnement à des événements cron échoue. Cette valeur est facultative. La valeur par défaut est true.

--wait-timeout, --wto

Durée d'attente en secondes avant que l'abonnement à l'événement cron soit prêt. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 15.

Exemple

L'exemple suivant crée un abonnement cron appelé mycronevent qui achemine un événement cron vers un travail appelé myjob toutes les 2 minutes.

ibmcloud ce subscription cron create --name mycronevent --destination myjob --schedule '*/2 * * * *' --destination-type job

Exemple de sortie

Creating cron source 'mycronevent'...
Run 'ibmcloud ce subscription cron get -n mycronevent' to check the cron source status.
OK

ibmcloud ce subscription cron delete

Supprimer un abonnement aux événements cron.

ibmcloud ce subscription cron delete --name CRON_SOURCE_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Options de commande

--name, -n
Nom de l'abonnement à des événements cron. Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--no-wait, --nw
Supprimer l'abonnement aux événements cron et ne pas attendre que l'abonnement soit supprimé. Si vous spécifiez l'option --no-wait, la suppression de l'abonnement démarre, sans attendre. Utilisez la commande subscription cron get pour vérifier l'état de l'abonnement. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--wait, -w
Supprimer l'abonnement aux événements cron et attendre la suppression de l'abonnement. Si vous spécifiez l'option --wait, le délai d'attente maximal, en secondes, pour la suppression de l'abonnement est défini par l'option --wait-timeout. Cette commande prend fin lorsque l'abonnement est supprimé ou lorsque le délai indiqué par l'option --wait-timeout est atteint, selon ce qui survient en premier. Cette valeur est facultative. La valeur par défaut est true.
--wait-timeout, --wto
Délai d'attente, en secondes, avant que l'abonnement à des événements cron soit supprimé. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 15.

Exemple

ibmcloud ce subscription cron delete --name mycronevent -f

Exemple de sortie

Deleting cron source 'mycronevent'...
OK

ibmcloud ce subscription cron get

Afficher les détails d'un abonnement à des événements cron.

ibmcloud ce subscription cron get --name CRON_SOURCE_NAME [--output OUTPUT] [--quiet]

Options de commande

--name, -n
Nom de l'abonnement à des événements cron. Cette valeur est obligatoire.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce subscription cron get --name mycronevent

Exemple de sortie

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  

Lorsque Ready a pour valeur true, l'abonnement cron est prêt à déclencher des événements selon la planification spécifiée.

ibmcloud ce subscription cron list

Répertorier tous les abonnements à des événements cron dans un projet.

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

Options de commande

--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce subscription cron list

Exemple de sortie

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

Mettre à jour un abonnement aux événements 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]

Options de commande

--name, -n

Nom de l'abonnement à des événements cron. Cette valeur est obligatoire.

--content-type, --ct

Type de support de l'option --data ou --data-base64. Exemples : application/json, application/x-www-form-urlencoded, text/html et text/plain. Cette valeur est facultative.

--da, --data

Les données à envoyer à la destination ; par exemple, '{ "message": "Hello world!" }'. Si vous spécifiez l'option --data, n'utilisez pas l'option --data-base64.

Cette valeur est facultative.

--data-base64, --db
Données codées en base64 à envoyer à la destination ; par exemple, Q29kZSBFbmdpbmU=. Si vous spécifiez l'option --data-base64, n'utilisez pas l'option --data. Cette valeur est facultative.
--destination, -d

Le nom de l'application ou de la ressource de travail que vous souhaitez recevoir des événements ; par exemple,myapp. Si nécessaire, utilisez l'option --path pour qualifier davantage une destination d'application. Cette valeur est facultative.

--destination-type, --dt

Type de la destination. Les valeurs valides sont : app, function et job. Cette valeur est facultative.

--extension, --ext

Permet de définit les extensions CloudEvents à envoyer à la destination. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle extension CloudEvents ou de remplacer un attribut CloudEvent existant. Spécifiez une extension à l'aide de l'option --extension ; par exemple, --ext extA=A --ext extB=B. Cette valeur est facultative.

--extension-rm, --ext-rm

Permet de supprimer les extensions CloudEvents à envoyer à la destination en spécifiant le nom de la clé. Spécifiez une extension à l'aide de l'option --ext-rm ; par exemple, --ext-rm extA --ext-rm extB. Cette valeur est facultative.

--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--path

Chemin dans l'application destination dans lequel les événements sont acheminés, par exemple /events. Le chemin par défaut est l'URL racine de l'application de destination. Cette option ne peut être spécifiée que si destination-type est app. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--schedule, -s

Permet de planifier la fréquence à laquelle l'événement est déclenché, au format crontab. Par exemple, indiquez '*/2 * * * *' (dans un format chaîne) pour toutes les deux minutes. Par défaut, l'événement cron est déclenché toutes les minutes et utilise le fuseau horaire UTC. Pour modifier le fuseau horaire, utilisez l'option --time-zone. Cette valeur est facultative.

--time-zone, --tz

Définissez le fuseau horaire de votre événement cron ; par exemple, Asia/Tokyo. Si vous spécifiez l'option --schedule, utilisez-la pour indiquer le fuseau horaire. Pour connaître les valeurs de fuseau horaire valides, voir la base de données des fuseaux horaires. Cette valeur est facultative.

Exemple

L'exemple suivant met à jour un abonnement source cron appelé mycronevent qui achemine un événement cron vers un travail appelé myjob toutes les heures.

ibmcloud ce subscription cron update --name mycronevent --destination myjob --schedule '0 * * * *' --destination-type job

Exemple de sortie

Updating cron source 'mycronevent'...
Run 'ibmcloud ce subscription cron get -n mycronevent' to check the cron source status.
OK

Abonnement kafka commandes

Souvent, dans les environnements distribués, vous avez besoin que vos applications ou vos travaux réagissent aux messages (événements) générés à partir d'autres composants, qui sont généralement appelés des producteurs d'événements. Avec Code Engine, vos applications ou vos travaux peuvent recevoir des événements d'intérêt grâce à un abonnement à des producteurs d'événements. Les informations relatives aux événements sont reçues sous forme de demandes HTTP POST pour les applications et sous forme de variables d'environnement pour les travaux.

Le producteur d'événements Kafka surveille l'apparition de nouveaux messages dans une instance Kafka. Lorsque vous créez un abonnement Code Engine Kafka pour un ensemble de sujets, votre application ou votre tâche reçoit un événement distinct pour chaque nouveau message apparaissant dans l'un des sujets.

Vous devez être dans le contexte d'un projet avant d'utiliser les commandes subscription kafka.

Pour plus d'informations sur l'utilisation des abonnements aux événements Kafka, voir Travailler avec le producteur d'événements Kafka. Voir Initiation aux abonnements pour plus d'informations sur l'utilisation des abonnements dans Code Engine.

Vous pouvez utiliser soit subscriptionousub dans vos commandessubscription kafka. Pour consulter l'aide de l'interface en ligne de commande (CLI) relative aux commandes « subscription », exécutez la commande « ibmcloud ce sub kafka -h ».

ibmcloud ce subscription kafka create

Créer un abonnement à des événements 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]

Options de commande

--broker, -b

Définir un courtier dans la source Kafka. Un courtier est un serveur Kafka auquel le consommateur se connecte. Cette option peut être spécifiée plusieurs fois. Cette valeur est obligatoire.

--destination, -d

Le nom de l'application ou de la ressource de travail que vous souhaitez recevoir des événements ; par exemple,myapp. Si nécessaire, utilisez l'option --path pour qualifier davantage une destination d'application. Cette valeur est obligatoire.

-n, --name

Nom de l'abonnement à l'événement « Kafka ». Utilisez un nom unique dans le projet.

  • Le nom doit débuter et se terminer par un caractère alphanumérique en minuscule.
  • Le nom doit comporter 253 caractères au maximum et peut contenir des lettres minuscules, des chiffres, des points (.) et des tirets (-).

Cette valeur est obligatoire.

--topic, -t
Définir un thème dans la source Kafka. Les sujets sont utilisés pour filtrer les messages à consommer. Cette option peut être spécifiée plusieurs fois. Cette valeur est obligatoire.
--consumer-group, --cg

Nom du groupe de consommateurs pour les événements. Cette valeur est facultative.

--destination-type, --dt

Type de la destination. Les valeurs valides sont app et job. Cette valeur est facultative. La valeur par défaut est app.

--extension, --ext

Permet de définit les extensions CloudEvents à envoyer à la destination. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle extension CloudEvents ou de remplacer un attribut CloudEvent existant. Spécifiez une extension à l'aide de l'option --extension ; par exemple, --ext extA=A --ext extB=B. Cette valeur est facultative.

--force, -f

Forcer la création d'un abonnement à l'événement « Kafka ». Cette option permet de ne pas valider la destination et le secret indiqués. Cette valeur est facultative. La valeur par défaut est false.

--no-wait, --nw

Créer l'abonnement aux événements Kafka et ne pas attendre que l'abonnement soit prêt. Si vous spécifiez l'option --no-wait, la création de l'abonnement démarre, sans attendre. Utilisez la commande subscription kafka get pour vérifier l'état de l'abonnement. Cette valeur est facultative. La valeur par défaut est false.

--output, -o

Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.

--password, -p

Mot de passe utilisé pour l'authentification auprès de l'instance Kafka. Si vous spécifiez l'option « --password », vous ne devez pas spécifier l'option « --secret ». Cette valeur est facultative.

--path

Chemin dans l'application destination dans lequel les événements sont acheminés, par exemple /events. Le chemin par défaut est l'URL racine de l'application de destination. Cette option ne peut être spécifiée que si destination-type est app. Cette valeur est facultative.

--quiet, -q

Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

--secret, -s

Nom du secret utilisé pour l'authentification auprès de l'instance Kafka et qui comprend à la fois les clés « username » et « password ». Si vous spécifiez l'option « --secret », vous ne devez pas spécifier les options « --username » ou « --password ». Cette valeur est facultative.

--username, -u

Nom d'utilisateur utilisé pour l'authentification auprès de l'instance Kafka. Si vous activez l'option « --username », vous devez également activer l'option « --password » et ne devez pas activer l'option « --secret ». Cette valeur est facultative. La valeur par défaut est token.

--wait, -w

Créer l'abonnement aux événements Kafka et attendre que l'abonnement soit prêt. Si vous spécifiez l'option --wait, le délai d'attente maximal, en secondes, pour la création de l'abonnement est défini par l'option --wait-timeout pour que l'abonnement soit prêt. Si l'abonnement n'est pas prêt dans le délai spécifié --wait-timeout, la création de l'abonnement à l'événement Kafka échoue. Cette valeur est facultative. La valeur par défaut est true.

--wait-timeout, --wto

Durée d'attente, en secondes, avant que l'abonnement à l'événement « Kafka » ne soit prêt. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 120.

Exemple

L'exemple suivant crée un abonnement à l'événement Kafka appelé mykafkaevent qui transmet un événement Kafka à une application réceptrice appelée kafka-receiver-app. Spécifiez une option --broker pour chaque courtier de votre sujet. L'option --destination spécifie la ressource Code Engine qui reçoit les événements. Le site kafka-subscription-secret fournit les informations d'identification permettant d'accéder au courtier en messages.

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

Exemple de sortie

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

Supprimer un abonnement aux événements Kafka.

ibmcloud ce subscription kafka delete --name KAFKA_SOURCE_NAME [--force] [--ignore-not-found] [--no-wait] [--quiet] [--wait] [--wait-timeout WAIT_TIMEOUT]

Options de commande

--name, -n
Nom de l'abonnement à l'événement « Kafka ». Cette valeur est obligatoire.
--force, -f
Permet de forcer une suppression sans demander de confirmation. Cette valeur est facultative. La valeur par défaut est false.
--ignore-not-found, --inf
Si introuvable, pas d'échec. Cette valeur est facultative. La valeur par défaut est false.
--no-wait, --nw
Supprimer l'abonnement aux événements Kafka et ne pas attendre que l'abonnement soit supprimé. Si vous spécifiez l'option --no-wait, la suppression de l'abonnement démarre, sans attendre. Utilisez la commande subscription kafka get pour vérifier l'état de l'abonnement. Cette valeur est facultative. La valeur par défaut est false.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--wait, -w
Supprimer l'abonnement aux événements Kafka et attendre la suppression de l'abonnement. Si vous spécifiez l'option --wait, le délai d'attente maximal, en secondes, pour la suppression de l'abonnement est défini par l'option --wait-timeout. Cette commande prend fin lorsque l'abonnement est supprimé ou lorsque le délai indiqué par l'option --wait-timeout est atteint, selon ce qui survient en premier. Cette valeur est facultative. La valeur par défaut est true.
--wait-timeout, --wto
Durée, en secondes, à respecter avant que l'abonnement à l'événement « Kafka » ne soit supprimé. Cette valeur est obligatoire si l'option --wait est spécifiée. Cette valeur est ignorée si l'option --no-wait est spécifiée. La valeur par défaut est 15.

Exemple

ibmcloud ce subscription kafka delete --name mykafkasubscription -f

Exemple de sortie

Deleting Kafka event subscription 'mykafkasubscription'...
OK

ibmcloud ce subscription kafka get

Afficher les détails d'un abonnement à des événements Kafka.

ibmcloud ce subscription kafka get --name KAFKA_SOURCE_NAME [--output OUTPUT] [--quiet]

Options de commande

--name, -n
Nom de l'abonnement à l'événement « Kafka ». Cette valeur est obligatoire.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce subscription kafka get --name mykafkasubscription

Exemple de sortie

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

Lorsque l'adresse Ready est true, l'abonnement Kafka est prêt à déclencher des événements selon la planification spécifiée.

ibmcloud ce subscription kafka list

Répertorier tous les abonnements à des évènements Kafka dans un projet.

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

Options de commande

--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--sort-by, -s
Indique la colonne par laquelle trier la liste. Les valeurs valides sont name et age. Cette valeur est facultative. La valeur par défaut est name.

Exemple

ibmcloud ce subscription kafka list

Exemple de sortie

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

Mettre à jour un abonnement aux événements 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]

Options de commande

--name, -n
Nom de l'abonnement à l'événement « Kafka ». Cette valeur est obligatoire.
--broker, -b
Définir un courtier dans la source Kafka. Un courtier est un serveur Kafka auquel le consommateur se connecte. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--destination, -d
Le nom de l'application ou de la ressource de travail que vous souhaitez recevoir des événements ; par exemple,myapp. Si nécessaire, utilisez l'option --path pour qualifier davantage une destination d'application. Cette valeur est facultative.
--destination-type, --dt
Type de la destination. Les valeurs valides sont app et job. Cette valeur est facultative.
--extension, --ext
Permet de définit les extensions CloudEvents à envoyer à la destination. Le format requis est NAME=VALUE. Cette action permet d'ajouter une nouvelle extension CloudEvents ou de remplacer un attribut CloudEvent existant. Spécifiez une extension à l'aide de l'option --extension ; par exemple, --ext extA=A --ext extB=B. Cette valeur est facultative.
--extension-rm, --ext-rm
Permet de supprimer les extensions CloudEvents à envoyer à la destination en spécifiant le nom de la clé. Spécifiez une extension à l'aide de l'option --ext-rm ; par exemple, --ext-rm extA --ext-rm extB. Cette valeur est facultative.
--output, -o
Indique le format de la sortie de la commande. Les valeurs valides sont json, yaml, jsonpath=JSONPATH_EXPRESSIONet jsonpath-as-json=JSONPATH_EXPRESSION. Utilisez jsonpath pour indiquer le chemin d'accès à un élément de la sortie JSON. Cette valeur est facultative.
--password, -p
Mot de passe utilisé pour l'authentification auprès de l'instance Kafka. Si vous spécifiez l'option « --password », vous ne devez pas spécifier l'option « --secret ». Cette valeur est facultative.
--path
Chemin dans l'application destination dans lequel les événements sont acheminés, par exemple /events. Le chemin par défaut est l'URL racine de l'application de destination. Cette option ne peut être spécifiée que si destination-type est app. Cette valeur est facultative.
--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.
--secret, -s
Nom du secret utilisé pour l'authentification auprès de l'instance Kafka et qui comprend à la fois les clés « username » et « password ». Si vous spécifiez l'option « --secret », vous ne devez pas spécifier les options « --username » ou « --password ». Cette valeur est facultative.
--topic, -t
Définir un thème dans la source Kafka. Les sujets sont utilisés pour filtrer les messages à consommer. Cette option peut être spécifiée plusieurs fois. Cette valeur est facultative.
--username, -u
Nom d'utilisateur utilisé pour l'authentification auprès de l'instance Kafka. Si vous activez l'option « --username », vous devez également activer l'option « --password » et ne devez pas activer l'option « --secret ». Cette valeur est facultative. La valeur par défaut est token.

Exemple

L'exemple suivant met à jour un abonnement à l'événement Kafka pour utiliser kafka-topic2 au lieu de kafka-topic1.

ibmcloud ce subscription kafka update --name mykafkasubscription --topic kafka-topic2

Exemple de sortie

Updating Kafka event subscription 'mykafkasubscription'...
Run 'ibmcloud ce subscription kafka get -n mykafkasubscription' to check the Kafka event subscription status.
OK

Commande version

Permet d'afficher la version de l'interface de ligne de commande code-engine.

ibmcloud ce version

Permet d'afficher la version de l'interface de ligne de commande code-engine.

ibmcloud ce version [--quiet]

Options de commande

--quiet, -q
Spécifiez cette option pour réduire la sortie de la commande. Cette valeur est facultative. La valeur par défaut est false.

Exemple

ibmcloud ce version

Exemple de sortie

version:  v1.17.0
commit:   3ab130b746f4784c9ff8d3da7bb05b6e7acda6d5