5.3. Référence pour OpenShift Pipelines
Cette section énumère les commandes CLI de base de tkn.
5.3.1. Syntaxe de base
tkn [command or options] [arguments…]
5.3.2. Options globales
--help, -h
5.3.3. Commandes d'utilitaires
5.3.3.1. tkn
Commande parente de tkn CLI.
Exemple : Afficher toutes les options
$ tkn
5.3.3.2. achèvement [shell]
Imprime le code d'achèvement de l'interpréteur de commandes qui doit être évalué pour fournir un achèvement interactif. Les shells supportés sont bash et zsh.
Exemple : Code d'achèvement pour bash shell
$ tkn completion bash
5.3.3.3. version
Imprimer les informations relatives à la version de l'interface CLI de tkn.
Exemple : Vérifier la version de tkn
$ tkn version
5.3.4. Commandes de gestion des pipelines
5.3.4.1. canalisation
Gérer les pipelines.
Exemple : Afficher l'aide
$ tkn pipeline --help
5.3.4.2. suppression du pipeline
Supprimer une canalisation.
Exemple : Supprimer le pipeline mypipeline d'un espace de noms
$ tkn pipeline delete mypipeline -n myspace
5.3.4.3. description du pipeline
Décrire un pipeline.
Exemple : Décrire la filière mypipeline
$ tkn pipeline describe mypipeline
5.3.4.4. liste des pipelines
Affiche une liste de pipelines.
Exemple : Afficher une liste de pipelines
$ tkn pipeline list
5.3.4.5. journaux de bord des pipelines
Affiche les journaux d'un pipeline spécifique.
Exemple : Diffusion en continu des journaux en direct de la canalisation mypipeline
$ tkn pipeline logs -f mypipeline
5.3.4.6. démarrage du pipeline
Lancer un pipeline.
Exemple : Démarrer le pipeline mypipeline
$ tkn pipeline start mypipeline
5.3.5. Commandes d'exécution du pipeline
5.3.5.1. pipelinerun
Gérer l'exécution du pipeline.
Exemple : Afficher l'aide
$ tkn pipelinerun -h
5.3.5.2. pipelinerun annuler
Annule le passage d'un pipeline.
Exemple : Annuler l'exécution du pipeline mypipelinerun à partir d'un espace de noms
$ tkn pipelinerun cancel mypipelinerun -n myspace
5.3.5.3. pipelinerun supprimer
Supprimer un pipeline.
Exemple : Suppression de l'exécution d'un pipeline à partir d'un espace de noms
$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
Exemple : Supprimer toutes les exécutions de pipeline d'un espace de noms, à l'exception des cinq exécutions les plus récentes
$ tkn pipelinerun delete -n myspace --keep 5 1
- 1
- Remplacez
5par le nombre d'exécutions les plus récentes du pipeline que vous souhaitez conserver.
Exemple : Supprimer tous les pipelines
$ tkn pipelinerun delete --all
À partir de Red Hat OpenShift Pipelines 1.6, la commande tkn pipelinerun delete --all ne supprime pas les ressources qui sont en cours d'exécution.
5.3.5.4. pipelinerun décrire
Décrire un parcours de canalisation.
Exemple : Décrire le pipeline mypipelinerun exécuté dans un espace de noms
$ tkn pipelinerun describe mypipelinerun -n myspace
5.3.5.5. liste des pipelines
Liste de l'exécution des pipelines.
Exemple : Afficher une liste d'exécutions de pipeline dans un espace de noms
$ tkn pipelinerun list -n myspace
5.3.5.6. journaux de bord pipelinerun
Affiche les journaux d'un pipeline.
Exemple : Afficher les journaux du pipeline mypipelinerun exécuté avec toutes les tâches et étapes d'un espace de noms
$ tkn pipelinerun logs mypipelinerun -a -n myspace
5.3.6. Commandes de gestion des tâches
5.3.6.1. tâche
Gérer les tâches.
Exemple : Afficher l'aide
$ tkn task -h
5.3.6.2. suppression d'une tâche
Supprimer une tâche.
Exemple : Supprimer les tâches mytask1 et mytask2 d'un espace de noms
$ tkn task delete mytask1 mytask2 -n myspace
5.3.6.3. description de la tâche
Décrire une tâche.
Exemple : Décrire la tâche mytask dans un espace de noms
$ tkn task describe mytask -n myspace
5.3.6.4. liste de tâches
Dresser la liste des tâches.
Exemple : Liste de toutes les tâches d'un espace de noms
$ tkn task list -n myspace
5.3.6.5. journaux des tâches
Afficher les journaux des tâches.
Exemple : Afficher les journaux de l'exécution de la tâche mytaskrun de la tâche mytask
$ tkn task logs mytask mytaskrun -n myspace
5.3.6.6. début de la tâche
Démarrer une tâche.
Exemple : Démarrer la tâche mytask dans un espace de noms
$ tkn task start mytask -s <ServiceAccountName> -n myspace
5.3.7. Commandes d'exécution des tâches
5.3.7.1. course à pied
Gérer l'exécution des tâches.
Exemple : Afficher l'aide
$ tkn taskrun -h
5.3.7.2. annulation de la course à pied
Annuler l'exécution d'une tâche.
Exemple : Annuler la tâche mytaskrun exécutée à partir d'un espace de noms
$ tkn taskrun cancel mytaskrun -n myspace
5.3.7.3. taskrun supprimer
Supprimer une TaskRun.
Exemple : Supprimer les tâches mytaskrun1 et mytaskrun2 d'un espace de noms
$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
Exemple : Supprimer d'un espace de noms toutes les tâches exécutées, à l'exception des cinq dernières
$ tkn taskrun delete -n myspace --keep 5 1
- 1
- Remplacez
5par le nombre d'exécutions de tâches les plus récentes que vous souhaitez conserver.
5.3.7.4. description de la course
Décrire l'exécution d'une tâche.
Exemple : Décrire la tâche mytaskrun exécutée dans un espace de noms
$ tkn taskrun describe mytaskrun -n myspace
5.3.7.5. liste des courses
Liste des tâches exécutées.
Exemple : Liste de toutes les tâches exécutées dans un espace de noms
$ tkn taskrun list -n myspace
5.3.7.6. carnets de route
Afficher les journaux d'exécution des tâches.
Exemple : Afficher les journaux en direct de la tâche mytaskrun exécutée dans un espace de noms
$ tkn taskrun logs -f mytaskrun -n myspace
5.3.8. Commandes de gestion des conditions
5.3.8.1. condition
Gérer les conditions.
Exemple : Afficher l'aide
$ tkn condition --help
5.3.8.2. condition supprimer
Supprimer une condition.
Exemple : Supprimer la condition mycondition1 d'un espace de noms
$ tkn condition delete mycondition1 -n myspace
5.3.8.3. décrire l'état
Décrire une condition.
Exemple : Décrire la condition mycondition1 dans un espace de noms
$ tkn condition describe mycondition1 -n myspace
5.3.8.4. liste des conditions
Conditions de la liste.
Exemple : Liste des conditions dans un espace de noms
$ tkn condition list -n myspace
5.3.9. Pipeline Commandes de gestion des ressources
5.3.9.1. ressource
Gérer les ressources du pipeline.
Exemple : Afficher l'aide
$ tkn resource -h
5.3.9.2. créer des ressources
Créer une ressource de pipeline.
Exemple : Créer une ressource de pipeline dans un espace de noms
$ tkn resource create -n myspace
Il s'agit d'une commande interactive qui demande des informations sur le nom de la ressource, son type et les valeurs basées sur le type de la ressource.
5.3.9.3. suppression des ressources
Supprimer une ressource du pipeline.
Exemple : Supprimer la ressource myresource Pipeline d'un espace de noms
$ tkn resource delete myresource -n myspace
5.3.9.4. description des ressources
Décrire une ressource du pipeline.
Exemple : Décrire la ressource myresource Pipeline
$ tkn resource describe myresource -n myspace
5.3.9.5. liste de ressources
Ressources pour le pipeline de la liste.
Exemple : Liste de toutes les ressources de pipeline d'un espace de noms
$ tkn resource list -n myspace
5.3.10. Commandes de gestion ClusterTask
Dans Red Hat OpenShift Pipelines 1.10, la fonctionnalité ClusterTask de l'utilitaire de ligne de commande tkn est dépréciée et il est prévu de la supprimer dans une prochaine version.
5.3.10.1. tâche en grappe
Gérer les tâches de cluster.
Exemple : Afficher l'aide
$ tkn clustertask --help
5.3.10.2. clustertask delete
Supprimer une ressource ClusterTask dans un cluster.
Exemple : Supprimer mytask1 et mytask2 ClusterTasks
$ tkn clustertask delete mytask1 mytask2
5.3.10.3. description de la tâche en grappe
Décrire une ClusterTask.
Exemple : Décrire la tâche mytask ClusterTask
$ tkn clustertask describe mytask1
5.3.10.4. liste de tâches en grappe
Liste des tâches de cluster.
Exemple : Liste des tâches de cluster
$ tkn clustertask list
5.3.10.5. clustertask start
Démarrer ClusterTasks.
Exemple : Démarrer la tâche mytask ClusterTask
$ tkn clustertask start mytask
5.3.11. Déclencher des commandes de gestion
5.3.11.1. générateur d'événements
Gérer les écouteurs d'événements.
Exemple : Afficher l'aide
$ tkn eventlistener -h
5.3.11.2. eventlistener supprimer
Supprimer un EventListener.
Exemple : Supprimer les EventListeners mylistener1 et mylistener2 dans un espace de noms
$ tkn eventlistener delete mylistener1 mylistener2 -n myspace
5.3.11.3. eventlistener décrire
Décrire un écouteur d'événements.
Exemple : Décrire l'écouteur d'événements mylistener dans un espace de noms
$ tkn eventlistener describe mylistener -n myspace
5.3.11.4. liste d'événements
Liste des écouteurs d'événements.
Exemple : Liste de tous les EventListeners d'un espace de noms
$ tkn eventlistener list -n myspace
5.3.11.5. journaux d'événements
Afficher les journaux d'un EventListener.
Exemple : Afficher les journaux de mylistener EventListener dans un espace de noms
$ tkn eventlistener logs mylistener -n myspace
5.3.11.6. liaison de déclenchement
Gérer les TriggerBindings.
Exemple : Afficher l'aide sur les TriggerBindings
$ tkn triggerbinding -h
5.3.11.7. triggerbinding delete
Supprimer un TriggerBinding.
Exemple : Supprimer les TriggerBindings mybinding1 et mybinding2 dans un espace de noms
$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace
5.3.11.8. description de l'obligation de déclenchement
Décrire un TriggerBinding.
Exemple : Décrire le lien mybinding TriggerBinding dans un espace de noms
$ tkn triggerbinding describe mybinding -n myspace
5.3.11.9. liste des déclencheurs (triggerbinding)
Liste des TriggerBindings.
Exemple : Lister tous les TriggerBindings d'un espace de noms
$ tkn triggerbinding list -n myspace
5.3.11.10. modèle de déclenchement
Gérer les modèles de déclenchement.
Exemple : Afficher l'aide de TriggerTemplate
$ tkn triggertemplate -h
5.3.11.11. modèle de déclenchement supprimer
Supprimer un TriggerTemplate.
Exemple : Supprimer les TriggerTemplates mytemplate1 et mytemplate2 dans un espace de noms
$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
5.3.11.12. modèle de déclenchement décrire
Décrire un TriggerTemplate.
Exemple : Décrire le mytemplate TriggerTemplate dans un espace de noms
$ tkn triggertemplate describe mytemplate -n `myspace`
5.3.11.13. liste de modèles de déclenchement
Liste des modèles de déclenchement.
Exemple : Liste de tous les TriggerTemplates d'un espace de noms
$ tkn triggertemplate list -n myspace
5.3.11.14. clustertriggerbinding (liaison de déclenchement de cluster)
Gérer les ClusterTriggerBindings.
Exemple : Afficher l'aide sur les ClusterTriggerBindings
$ tkn clustertriggerbinding -h
5.3.11.15. clustertriggerbinding delete
Supprimer un ClusterTriggerBinding.
Exemple : Supprimer myclusterbinding1 et myclusterbinding2 ClusterTriggerBindings
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
5.3.11.16. clustertriggerbinding describe
Décrire un ClusterTriggerBinding.
Exemple : Décrire le lien myclusterbinding ClusterTriggerBinding
$ tkn clustertriggerbinding describe myclusterbinding
5.3.11.17. liste des déclencheurs de clusters
Liste des ClusterTriggerBindings.
Exemple : Liste de tous les ClusterTriggerBindings
$ tkn clustertriggerbinding list
5.3.12. Commandes d'interaction avec le Hub
Interagir avec Tekton Hub pour les ressources telles que les tâches et les pipelines.
5.3.12.1. plaque tournante
Interagir avec le hub.
Exemple : Afficher l'aide
$ tkn hub -h
Exemple : Interagir avec un serveur API hub
$ tkn hub --api-server https://api.hub.tekton.dev
Pour chaque exemple, pour obtenir les sous-commandes et les drapeaux correspondants, exécutez tkn hub <command> --help.
5.3.12.2. rétrogradation de la plaque tournante
Rétrograder une ressource installée.
Exemple : Rétrograder la tâche mytask dans l'espace de noms mynamespace vers son ancienne version
$ tkn hub downgrade task mytask --to version -n mynamespace
5.3.12.3. hub get
Obtenir le manifeste d'une ressource par son nom, son type, son catalogue et sa version.
Exemple : Obtenir le manifeste d'une version spécifique du pipeline ou de la tâche myresource dans le catalogue tekton
$ tkn hub get [pipeline | task] myresource --from tekton --version version
5.3.12.4. info sur le moyeu
Afficher des informations sur une ressource en fonction de son nom, de son type, de son catalogue et de sa version.
Exemple : Afficher des informations sur une version spécifique de la tâche mytask à partir du catalogue tekton
$ tkn hub info task mytask --from tekton --version version
5.3.12.5. installation du moyeu
Installer une ressource à partir d'un catalogue en fonction de son type, de son nom et de 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
5.3.12.6. réinstallation du moyeu
Réinstaller une ressource en fonction de son type et de 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
5.3.12.7. recherche de moyeu
Recherche d'une ressource par une combinaison de nom, de type et d'étiquettes.
Exemple : Rechercher une ressource avec une étiquette cli
$ tkn hub search --tags cli
5.3.12.8. mise à niveau du moyeu
Mettre à jour une ressource installée.
Exemple : Mettre à jour 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
