5.3. Ligne de référence OpenShift Pipelines tkn
Cette section répertorie les commandes de base tkn CLI.
5.3.1. La syntaxe de base Copier lienLien copié sur presse-papiers!
[commande ou options] [arguments…]
5.3.2. Les options globales Copier lienLien copié sur presse-papiers!
--aide, -h
5.3.3. Commandes d’utilitaire Copier lienLien copié sur presse-papiers!
5.3.3.1. le TKN Copier lienLien copié sur presse-papiers!
Commande parent pour tkn CLI.
Exemple : Afficher toutes les options
tkn
$ tkn
5.3.3.2. achèvement [coquille] Copier lienLien copié sur presse-papiers!
Imprimer le code d’achèvement du shell qui doit être évalué pour fournir un achèvement interactif. Les coques prises en charge sont bash et zsh.
Exemple: Code d’achèvement pour bash shell
tkn completion bash
$ tkn completion bash
5.3.3.3. la version Copier lienLien copié sur presse-papiers!
Imprimer les informations de la version tkn CLI.
Exemple : Vérifiez la version tkn
tkn version
$ tkn version
5.3.4. Commandes de gestion des pipelines Copier lienLien copié sur presse-papiers!
5.3.4.1. gazoduc Copier lienLien copié sur presse-papiers!
Gérer les pipelines.
Exemple : Aide d’affichage
tkn pipeline --help
$ tkn pipeline --help
5.3.4.2. éliminer le pipeline Copier lienLien copié sur presse-papiers!
Effacez un pipeline.
Exemple : Supprimer le pipeline mypipeline d’un espace de noms
tkn pipeline delete mypipeline -n myspace
$ tkn pipeline delete mypipeline -n myspace
5.3.4.3. description du pipeline Copier lienLien copié sur presse-papiers!
Décrivez un pipeline.
Exemple : Décrivez le pipeline mypipeline
tkn pipeline describe mypipeline
$ tkn pipeline describe mypipeline
5.3.4.4. liste des pipelines Copier lienLien copié sur presse-papiers!
Afficher une liste de pipelines.
Exemple : Afficher une liste de pipelines
tkn pipeline list
$ tkn pipeline list
5.3.4.5. journaux des pipelines Copier lienLien copié sur presse-papiers!
Afficher les journaux d’un pipeline spécifique.
Exemple: diffuser les journaux en direct pour le pipeline mypipeline
tkn pipeline logs -f mypipeline
$ tkn pipeline logs -f mypipeline
5.3.4.6. démarrage du pipeline Copier lienLien copié sur presse-papiers!
Lancez un pipeline.
Exemple : Démarrer le pipeline mypipeline
tkn pipeline start mypipeline
$ tkn pipeline start mypipeline
5.3.5. Commandes d’exécution de pipeline Copier lienLien copié sur presse-papiers!
5.3.5.1. cours d’oléoduc Copier lienLien copié sur presse-papiers!
Gérer les conduites de pipelines.
Exemple : Aide d’affichage
tkn pipelinerun -h
$ tkn pipelinerun -h
5.3.5.2. annulation de pipelinerun Copier lienLien copié sur presse-papiers!
Annulez une conduite d’oléoduc.
Exemple: Annuler le pipeline mypipelinerun exécuté à partir d’un espace de noms
tkn pipelinerun cancel mypipelinerun -n myspace
$ tkn pipelinerun cancel mypipelinerun -n myspace
5.3.5.3. les pipelinerun suppriment Copier lienLien copié sur presse-papiers!
Effacez une conduite de pipeline.
Exemple : Supprimer le pipeline à partir d’un espace de noms
tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
Exemple: Supprimer tous les pipelines d’un espace de noms, à l’exception des cinq plus récentes exécutions de pipeline
tkn pipelinerun delete -n myspace --keep 5
$ tkn pipelinerun delete -n myspace --keep 5
- 1
- 5 par le nombre d’exécutions de pipelines les plus récentes que vous souhaitez conserver.
Exemple : Supprimer tous les pipelines
tkn pipelinerun delete --all
$ tkn pipelinerun delete --all
À partir de Red Hat OpenShift Pipelines 1.6, la commande tkn pipelinerun supprimer --all ne supprime aucune ressource dans l’état en cours d’exécution.
5.3.5.4. description de pipelinerun Copier lienLien copié sur presse-papiers!
Décrivez une conduite d’oléoduc.
Exemple : Décrivez le pipeline mypipelinerun exécuté dans un espace de noms
tkn pipelinerun describe mypipelinerun -n myspace
$ tkn pipelinerun describe mypipelinerun -n myspace
5.3.5.5. liste de pipelinerun Copier lienLien copié sur presse-papiers!
Liste des cours d’eau.
Exemple : Afficher une liste d’exécutions de pipelines dans un espace de noms
tkn pipelinerun list -n myspace
$ tkn pipelinerun list -n myspace
5.3.5.6. journaux de pipelinerun Copier lienLien copié sur presse-papiers!
Afficher les journaux d’une course de pipeline.
Exemple : Afficher les journaux du pipeline mypipelinerun exécuté avec toutes les tâches et étapes dans un espace de noms
tkn pipelinerun logs mypipelinerun -a -n myspace
$ tkn pipelinerun logs mypipelinerun -a -n myspace
5.3.6. Commandes de gestion des tâches Copier lienLien copié sur presse-papiers!
5.3.6.1. la tâche Copier lienLien copié sur presse-papiers!
Gérer les tâches.
Exemple : Aide d’affichage
tkn task -h
$ tkn task -h
5.3.6.2. effacer la tâche Copier lienLien copié sur presse-papiers!
Effacer une tâche.
Exemple: Supprimer les tâches mytask1 et mytask2 à partir d’un espace de noms
tkn task delete mytask1 mytask2 -n myspace
$ tkn task delete mytask1 mytask2 -n myspace
5.3.6.3. décrire la tâche Copier lienLien copié sur presse-papiers!
Décrivez une tâche.
Exemple : Décrivez la tâche mytask dans un espace de noms
tkn task describe mytask -n myspace
$ tkn task describe mytask -n myspace
5.3.6.4. liste des tâches Copier lienLien copié sur presse-papiers!
Liste des tâches.
Exemple : Répertez toutes les tâches dans un espace de noms
tkn task list -n myspace
$ tkn task list -n myspace
5.3.6.5. journaux des tâches Copier lienLien copié sur presse-papiers!
Afficher les journaux des tâches.
Exemple: Afficher les journaux pour l’exécution de tâches mytaskrun de la tâche mytask
tkn task logs mytask mytaskrun -n myspace
$ tkn task logs mytask mytaskrun -n myspace
5.3.6.6. démarrage de la tâche Copier lienLien copié sur presse-papiers!
Commencez une tâche.
Exemple : Démarrez la tâche mytask dans un espace de noms
tkn task start mytask -s <ServiceAccountName> -n myspace
$ tkn task start mytask -s <ServiceAccountName> -n myspace
5.3.7. Commandes d’exécution des tâches Copier lienLien copié sur presse-papiers!
5.3.7.1. exécution des tâches Copier lienLien copié sur presse-papiers!
Gérer l’exécution des tâches.
Exemple : Aide d’affichage
tkn taskrun -h
$ tkn taskrun -h
5.3.7.2. annulation de Taskrun Copier lienLien copié sur presse-papiers!
Annuler une tâche.
Exemple : Annuler la tâche mytaskrun exécutée à partir d’un espace de noms
tkn taskrun cancel mytaskrun -n myspace
$ tkn taskrun cancel mytaskrun -n myspace
5.3.7.3. Effacer les tâches Copier lienLien copié sur presse-papiers!
Effacer un TaskRun.
Exemple: Supprimer la tâche mytaskrun1 et mytaskrun2 s’exécute à partir d’un espace de noms
tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
Exemple: Supprimer tout sauf les cinq tâches les plus récemment exécutées s’exécute à partir d’un espace de noms
tkn taskrun delete -n myspace --keep 5
$ tkn taskrun delete -n myspace --keep 5
- 1
- 5 par le nombre d’exécutions de tâches les plus récentes que vous souhaitez conserver.
5.3.7.4. description de Taskrun Copier lienLien copié sur presse-papiers!
Décrivez une tâche exécutée.
Exemple : Décrivez la tâche mytaskrun exécutée dans un espace de noms
tkn taskrun describe mytaskrun -n myspace
$ tkn taskrun describe mytaskrun -n myspace
5.3.7.5. liste des tâches Copier lienLien copié sur presse-papiers!
Liste des tâches exécutées.
Exemple : Répertez toutes les tâches exécutées dans un espace de noms
tkn taskrun list -n myspace
$ tkn taskrun list -n myspace
5.3.7.6. journaux d’exécution des tâches Copier lienLien copié sur presse-papiers!
Afficher les journaux d’exécution des tâches.
Exemple : Afficher les journaux en direct pour la tâche mytaskrun exécutée dans un espace de noms
tkn taskrun logs -f mytaskrun -n myspace
$ tkn taskrun logs -f mytaskrun -n myspace
5.3.8. Commandes de gestion de condition Copier lienLien copié sur presse-papiers!
5.3.8.1. État de l’état Copier lienLien copié sur presse-papiers!
Gérer les conditions.
Exemple : Aide d’affichage
tkn condition --help
$ tkn condition --help
5.3.8.2. condition supprimer Copier lienLien copié sur presse-papiers!
Effacer une condition.
Exemple: Supprimer la condition mycondition1 d’un espace de noms
tkn condition delete mycondition1 -n myspace
$ tkn condition delete mycondition1 -n myspace
5.3.8.3. condition décrire Copier lienLien copié sur presse-papiers!
Décrivez une condition.
Exemple : Décrivez la condition mycondition1 dans un espace de noms
tkn condition describe mycondition1 -n myspace
$ tkn condition describe mycondition1 -n myspace
5.3.8.4. liste de condition Copier lienLien copié sur presse-papiers!
Liste des conditions.
Exemple : Liste des conditions dans un espace de noms
tkn condition list -n myspace
$ tkn condition list -n myspace
5.3.9. Commandes de gestion des ressources de pipeline Copier lienLien copié sur presse-papiers!
5.3.9.1. a) Ressources Copier lienLien copié sur presse-papiers!
Gérer les ressources des pipelines.
Exemple : Aide d’affichage
tkn resource -h
$ tkn resource -h
5.3.9.2. créer des ressources Copier lienLien copié sur presse-papiers!
Créer une ressource de pipeline.
Exemple : Créer une ressource de pipeline dans un espace de noms
tkn resource create -n myspace
$ tkn resource create -n myspace
Il s’agit d’une commande interactive qui demande une entrée sur le nom de la ressource, le type de la ressource et les valeurs basées sur le type de la ressource.
5.3.9.3. effacer la ressource Copier lienLien copié sur presse-papiers!
Supprimez une ressource de pipeline.
Exemple: Supprimer la ressource de pipeline myresource à partir d’un espace de noms
tkn resource delete myresource -n myspace
$ tkn resource delete myresource -n myspace
5.3.9.4. décrire la ressource Copier lienLien copié sur presse-papiers!
Décrivez une ressource de pipeline.
Exemple : Décrivez la ressource du pipeline myresource
tkn resource describe myresource -n myspace
$ tkn resource describe myresource -n myspace
5.3.9.5. liste des ressources Copier lienLien copié sur presse-papiers!
Liste des ressources du pipeline.
Exemple : Répertez toutes les ressources de pipeline dans un espace de noms
tkn resource list -n myspace
$ tkn resource list -n myspace
5.3.10. Commandes de gestion de ClusterTask Copier lienLien copié sur presse-papiers!
Dans Red Hat OpenShift Pipelines 1.10, la fonctionnalité ClusterTask de l’utilitaire de ligne de commande tkn est obsolète et devrait être supprimée dans une version ultérieure.
5.3.10.1. clustertask Copier lienLien copié sur presse-papiers!
Gérer ClusterTasks.
Exemple : Aide d’affichage
tkn clustertask --help
$ tkn clustertask --help
5.3.10.2. clustertask supprimer Copier lienLien copié sur presse-papiers!
Supprimez une ressource ClusterTask dans un cluster.
Exemple: Supprimer mytask1 et mytask2 ClusterTasks
tkn clustertask delete mytask1 mytask2
$ tkn clustertask delete mytask1 mytask2
5.3.10.3. clustertask décrire Copier lienLien copié sur presse-papiers!
Décrivez un ClusterTask.
Exemple : Décrivez le ClusterTask de mytask
tkn clustertask describe mytask1
$ tkn clustertask describe mytask1
5.3.10.4. liste de clustertask Copier lienLien copié sur presse-papiers!
Liste ClusterTasks.
Exemple: Liste ClusterTasks
tkn clustertask list
$ tkn clustertask list
5.3.10.5. démarrage de clustertask Copier lienLien copié sur presse-papiers!
Démarrez ClusterTasks.
Exemple: Démarrer le ClusterTask de mytask
tkn clustertask start mytask
$ tkn clustertask start mytask
5.3.11. Commandes de gestion de déclenchement Copier lienLien copié sur presse-papiers!
5.3.11.1. EventListener Copier lienLien copié sur presse-papiers!
Gérer EventListeners.
Exemple : Aide d’affichage
tkn eventlistener -h
$ tkn eventlistener -h
5.3.11.2. EventListener supprimer Copier lienLien copié sur presse-papiers!
Effacer un EventListener.
Exemple : Supprimer mylistener1 et mylistener2 EventListeners dans un espace de noms
tkn eventlistener delete mylistener1 mylistener2 -n myspace
$ tkn eventlistener delete mylistener1 mylistener2 -n myspace
5.3.11.3. EventListener décrire Copier lienLien copié sur presse-papiers!
Décrivez un EventListener.
Exemple : Décrivez le mylistener EventListener dans un espace de noms
tkn eventlistener describe mylistener -n myspace
$ tkn eventlistener describe mylistener -n myspace
5.3.11.4. liste EventListener Copier lienLien copié sur presse-papiers!
Liste EventListeners.
Exemple : Répertez tous les EventListeners dans un espace de noms
tkn eventlistener list -n myspace
$ tkn eventlistener list -n myspace
5.3.11.5. journaux EventListener Copier lienLien copié sur presse-papiers!
Afficher les journaux d’un EventListener.
Exemple : Afficher les journaux du mylistener EventListener dans un espace de noms
tkn eventlistener logs mylistener -n myspace
$ tkn eventlistener logs mylistener -n myspace
5.3.11.6. binage de déclenchement Copier lienLien copié sur presse-papiers!
Gérez TriggerBindings.
Exemple: Affichage TriggerBindings aide
tkn triggerbinding -h
$ tkn triggerbinding -h
5.3.11.7. triggerbinding supprimer Copier lienLien copié sur presse-papiers!
Effacer un TriggerBinding.
Exemple: Supprimer mybinding1 et mybinding2 TriggerBindings dans un espace de noms
tkn triggerbinding delete mybinding1 mybinding2 -n myspace
$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace
5.3.11.8. triggerbinding décrire Copier lienLien copié sur presse-papiers!
Décrivez un TriggerBinding.
Exemple: Décrivez le Mybinding TriggerBinding dans un espace de noms
tkn triggerbinding describe mybinding -n myspace
$ tkn triggerbinding describe mybinding -n myspace
5.3.11.9. liste debinaison de déclenchement Copier lienLien copié sur presse-papiers!
Liste TriggerBindings.
Exemple: Liste tous les TriggerBindings dans un espace de noms
tkn triggerbinding list -n myspace
$ tkn triggerbinding list -n myspace
5.3.11.10. triggertemplate Copier lienLien copié sur presse-papiers!
Gérez TriggerTemplates.
Exemple: Affichage TriggerTemplate aide
tkn triggertemplate -h
$ tkn triggertemplate -h
5.3.11.11. triggertemplate supprimer Copier lienLien copié sur presse-papiers!
Effacer un TriggerTemplate.
Exemple: Supprimer mytemplate1 et mytemplate2 TriggerTemplates dans un espace de noms
tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
5.3.11.12. triggertemplate décrit Copier lienLien copié sur presse-papiers!
Décrivez un TriggerTemplate.
Exemple: Décrivez le mytemplate TriggerTemplate dans un espace de noms
tkn triggertemplate describe mytemplate -n `myspace`
$ tkn triggertemplate describe mytemplate -n `myspace`
5.3.11.13. liste de triggertemplate Copier lienLien copié sur presse-papiers!
Liste TriggerTemplates.
Exemple: Liste tous les TriggerTemplates dans un espace de noms
tkn triggertemplate list -n myspace
$ tkn triggertemplate list -n myspace
5.3.11.14. clustertriggerbinding Copier lienLien copié sur presse-papiers!
Gérer ClusterTriggerBindings.
Exemple: Affichage ClusterTriggerBindings aide
tkn clustertriggerbinding -h
$ tkn clustertriggerbinding -h
5.3.11.15. clustertriggerbinding supprimer Copier lienLien copié sur presse-papiers!
Effacer un ClusterTriggerBinding.
Exemple: Supprimer myclusterbinding1 et myclusterbinding2 ClusterTriggerBindings
tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
5.3.11.16. clustertriggerbinding décrit Copier lienLien copié sur presse-papiers!
Décrivez un ClusterTriggerBinding.
Exemple: Décrivez le myclusterbinding ClusterTriggerBinding
tkn clustertriggerbinding describe myclusterbinding
$ tkn clustertriggerbinding describe myclusterbinding
5.3.11.17. liste de clustertriggerbinding Copier lienLien copié sur presse-papiers!
Liste ClusterTriggerBindings.
Exemple: Liste tous les ClusterTriggerBindings
tkn clustertriggerbinding list
$ tkn clustertriggerbinding list
5.3.12. Commandes d’interaction Hub Copier lienLien copié sur presse-papiers!
Interagissez avec Tekton Hub pour des ressources telles que des tâches et des pipelines.
5.3.12.1. le hub Copier lienLien copié sur presse-papiers!
Interagissez avec le hub.
Exemple : Aide d’affichage
tkn hub -h
$ tkn hub -h
Exemple : Interagir avec un serveur API hub
tkn hub --api-server https://api.hub.tekton.dev
$ tkn hub --api-server https://api.hub.tekton.dev
Dans chaque exemple, pour obtenir les sous-commandes et drapeaux correspondants, exécutez tkn hub <command> --help.
5.3.12.2. déclassement du moyeu Copier lienLien copié sur presse-papiers!
Déclasser une ressource installée.
Exemple: Déclasser la tâche mytask dans l’espace de noms mynamespace à sa version antérieure
tkn hub downgrade task mytask --to version -n mynamespace
$ tkn hub downgrade task mytask --to version -n mynamespace
5.3.12.3. le hub se fait Copier lienLien copié sur presse-papiers!
Bénéficiez d’un manifeste de ressources par son nom, son genre, son catalogue et sa version.
Exemple: Obtenez le manifeste pour une version spécifique du pipeline ou de la tâche myresource à partir du catalogue tekton
tkn hub get [pipeline | task] myresource --from tekton --version version
$ tkn hub get [pipeline | task] myresource --from tekton --version version
5.3.12.4. infos sur le hub Copier lienLien copié sur presse-papiers!
Afficher des informations sur une ressource par son nom, son genre, son catalogue et sa version.
Exemple : Afficher des informations sur une version spécifique de la tâche mytask du catalogue tekton
tkn hub info task mytask --from tekton --version version
$ tkn hub info task mytask --from tekton --version version
5.3.12.5. installation du hub Copier lienLien copié sur presse-papiers!
Installez une ressource à partir d’un catalogue par son genre, son nom et sa version.
Exemple: Installer une version spécifique de la tâche mytask à partir du catalogue tekton dans l’espace de noms mynamespace
tkn hub install task mytask --from tekton --version version -n mynamespace
$ tkn hub install task mytask --from tekton --version version -n mynamespace
5.3.12.6. Hub réinstallé Copier lienLien copié sur presse-papiers!
Installez une ressource par son genre et son nom.
Exemple : Réinstaller une version spécifique de la tâche mytask à partir du catalogue tekton dans l’espace de noms mynamespace
tkn hub reinstall task mytask --from tekton --version version -n mynamespace
$ tkn hub reinstall task mytask --from tekton --version version -n mynamespace
5.3.12.7. la recherche de hub Copier lienLien copié sur presse-papiers!
Cherchez une ressource par une combinaison de nom, de genre et de balises.
Exemple: Rechercher une ressource avec une balise cli
tkn hub search --tags cli
$ tkn hub search --tags cli
5.3.12.8. amélioration du hub Copier lienLien copié sur presse-papiers!
Améliorez une ressource installée.
Exemple : Mettre à niveau la tâche mytask installée dans l’espace de noms mynamespace vers une nouvelle version
tkn hub upgrade task mytask --to version -n mynamespace
$ tkn hub upgrade task mytask --to version -n mynamespace