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 Copier lienLien copié sur presse-papiers!
tkn [command or options] [arguments…]
5.3.2. Options globales Copier lienLien copié sur presse-papiers!
--help, -h
5.3.3. Commandes d'utilitaires Copier lienLien copié sur presse-papiers!
5.3.3.1. tkn Copier lienLien copié sur presse-papiers!
Commande parente de tkn
CLI.
Exemple : Afficher toutes les options
tkn
$ tkn
5.3.3.2. achèvement [shell] Copier lienLien copié sur presse-papiers!
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
$ tkn completion bash
5.3.3.3. version Copier lienLien copié sur presse-papiers!
Imprimer les informations relatives à la version de l'interface CLI de tkn
.
Exemple : Vérifier la version de tkn
tkn version
$ tkn version
5.3.4. Commandes de gestion des pipelines Copier lienLien copié sur presse-papiers!
5.3.4.1. canalisation Copier lienLien copié sur presse-papiers!
Gérer les pipelines.
Exemple : Afficher l'aide
tkn pipeline --help
$ tkn pipeline --help
5.3.4.2. suppression du pipeline Copier lienLien copié sur presse-papiers!
Supprimer une canalisation.
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écrire un pipeline.
Exemple : Décrire la filière mypipeline
tkn pipeline describe mypipeline
$ tkn pipeline describe mypipeline
5.3.4.4. liste des pipelines Copier lienLien copié sur presse-papiers!
Affiche une liste de pipelines.
Exemple : Afficher une liste de pipelines
tkn pipeline list
$ tkn pipeline list
5.3.4.5. journaux de bord des pipelines Copier lienLien copié sur presse-papiers!
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
$ tkn pipeline logs -f mypipeline
5.3.4.6. démarrage du pipeline Copier lienLien copié sur presse-papiers!
Lancer un pipeline.
Exemple : Démarrer le pipeline mypipeline
tkn pipeline start mypipeline
$ tkn pipeline start mypipeline
5.3.5. Commandes d'exécution du pipeline Copier lienLien copié sur presse-papiers!
5.3.5.1. pipelinerun Copier lienLien copié sur presse-papiers!
Gérer l'exécution du pipeline.
Exemple : Afficher l'aide
tkn pipelinerun -h
$ tkn pipelinerun -h
5.3.5.2. pipelinerun annuler Copier lienLien copié sur presse-papiers!
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
$ tkn pipelinerun cancel mypipelinerun -n myspace
5.3.5.3. pipelinerun supprimer Copier lienLien copié sur presse-papiers!
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
$ 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
$ tkn pipelinerun delete -n myspace --keep 5
- 1
- Remplacez
5
par le nombre d'exécutions les plus récentes du pipeline 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 delete --all
ne supprime pas les ressources qui sont en cours d'exécution.
5.3.5.4. pipelinerun décrire Copier lienLien copié sur presse-papiers!
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
$ tkn pipelinerun describe mypipelinerun -n myspace
5.3.5.5. liste des pipelines Copier lienLien copié sur presse-papiers!
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
$ tkn pipelinerun list -n myspace
5.3.5.6. journaux de bord pipelinerun Copier lienLien copié sur presse-papiers!
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
$ 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. tâche Copier lienLien copié sur presse-papiers!
Gérer les tâches.
Exemple : Afficher l'aide
tkn task -h
$ tkn task -h
5.3.6.2. suppression d'une tâche Copier lienLien copié sur presse-papiers!
Supprimer une tâche.
Exemple : Supprimer les tâches mytask1
et mytask2
d'un espace de noms
tkn task delete mytask1 mytask2 -n myspace
$ tkn task delete mytask1 mytask2 -n myspace
5.3.6.3. description de la tâche Copier lienLien copié sur presse-papiers!
Décrire une tâche.
Exemple : Décrire 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 de tâches Copier lienLien copié sur presse-papiers!
Dresser la liste des tâches.
Exemple : Liste de toutes les tâches d'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 de l'exécution de la tâche 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ébut de la tâche Copier lienLien copié sur presse-papiers!
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
$ 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. course à pied Copier lienLien copié sur presse-papiers!
Gérer l'exécution des tâches.
Exemple : Afficher l'aide
tkn taskrun -h
$ tkn taskrun -h
5.3.7.2. annulation de la course à pied Copier lienLien copié sur presse-papiers!
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
$ tkn taskrun cancel mytaskrun -n myspace
5.3.7.3. taskrun supprimer Copier lienLien copié sur presse-papiers!
Supprimer une TaskRun.
Exemple : Supprimer les tâches mytaskrun1
et mytaskrun2
d'un espace de noms
tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
$ 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
$ tkn taskrun delete -n myspace --keep 5
- 1
- Remplacez
5
par le nombre d'exécutions de tâches les plus récentes que vous souhaitez conserver.
5.3.7.4. description de la course Copier lienLien copié sur presse-papiers!
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
$ tkn taskrun describe mytaskrun -n myspace
5.3.7.5. liste des courses Copier lienLien copié sur presse-papiers!
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
$ tkn taskrun list -n myspace
5.3.7.6. carnets de route Copier lienLien copié sur presse-papiers!
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
$ tkn taskrun logs -f mytaskrun -n myspace
5.3.8. Commandes de gestion des conditions Copier lienLien copié sur presse-papiers!
5.3.8.1. condition Copier lienLien copié sur presse-papiers!
Gérer les conditions.
Exemple : Afficher l'aide
tkn condition --help
$ tkn condition --help
5.3.8.2. condition supprimer Copier lienLien copié sur presse-papiers!
Supprimer 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. décrire l'état Copier lienLien copié sur presse-papiers!
Décrire une condition.
Exemple : Décrire 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 des conditions Copier lienLien copié sur presse-papiers!
Conditions de la liste.
Exemple : Liste des conditions dans un espace de noms
tkn condition list -n myspace
$ tkn condition list -n myspace
5.3.9. Pipeline Commandes de gestion des ressources Copier lienLien copié sur presse-papiers!
5.3.9.1. ressource Copier lienLien copié sur presse-papiers!
Gérer les ressources du pipeline.
Exemple : Afficher l'aide
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 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 Copier lienLien copié sur presse-papiers!
Supprimer une ressource du pipeline.
Exemple : Supprimer la ressource myresource
Pipeline d'un espace de noms
tkn resource delete myresource -n myspace
$ tkn resource delete myresource -n myspace
5.3.9.4. description des ressources Copier lienLien copié sur presse-papiers!
Décrire une ressource du pipeline.
Exemple : Décrire la ressource myresource
Pipeline
tkn resource describe myresource -n myspace
$ tkn resource describe myresource -n myspace
5.3.9.5. liste de ressources Copier lienLien copié sur presse-papiers!
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
$ tkn resource list -n myspace
5.3.10. Commandes de gestion 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 dépréciée et il est prévu de la supprimer dans une prochaine version.
5.3.10.1. tâche en grappe Copier lienLien copié sur presse-papiers!
Gérer les tâches de cluster.
Exemple : Afficher l'aide
tkn clustertask --help
$ tkn clustertask --help
5.3.10.2. clustertask delete Copier lienLien copié sur presse-papiers!
Supprimer 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. description de la tâche en grappe Copier lienLien copié sur presse-papiers!
Décrire une ClusterTask.
Exemple : Décrire la tâche mytask
ClusterTask
tkn clustertask describe mytask1
$ tkn clustertask describe mytask1
5.3.10.4. liste de tâches en grappe Copier lienLien copié sur presse-papiers!
Liste des tâches de cluster.
Exemple : Liste des tâches de cluster
tkn clustertask list
$ tkn clustertask list
5.3.10.5. clustertask start Copier lienLien copié sur presse-papiers!
Démarrer ClusterTasks.
Exemple : Démarrer la tâche mytask
ClusterTask
tkn clustertask start mytask
$ tkn clustertask start mytask
5.3.11. Déclencher des commandes de gestion Copier lienLien copié sur presse-papiers!
5.3.11.1. générateur d'événements Copier lienLien copié sur presse-papiers!
Gérer les écouteurs d'événements.
Exemple : Afficher l'aide
tkn eventlistener -h
$ tkn eventlistener -h
5.3.11.2. eventlistener supprimer Copier lienLien copié sur presse-papiers!
Supprimer un EventListener.
Exemple : Supprimer les EventListeners mylistener1
et mylistener2
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é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
$ tkn eventlistener describe mylistener -n myspace
5.3.11.4. liste d'événements Copier lienLien copié sur presse-papiers!
Liste des écouteurs d'événements.
Exemple : Liste de tous les EventListeners d'un espace de noms
tkn eventlistener list -n myspace
$ tkn eventlistener list -n myspace
5.3.11.5. journaux d'événements Copier lienLien copié sur presse-papiers!
Afficher les journaux d'un EventListener.
Exemple : Afficher les journaux de mylistener
EventListener dans un espace de noms
tkn eventlistener logs mylistener -n myspace
$ tkn eventlistener logs mylistener -n myspace
5.3.11.6. liaison de déclenchement Copier lienLien copié sur presse-papiers!
Gérer les TriggerBindings.
Exemple : Afficher l'aide sur les TriggerBindings
tkn triggerbinding -h
$ tkn triggerbinding -h
5.3.11.7. triggerbinding delete Copier lienLien copié sur presse-papiers!
Supprimer un TriggerBinding.
Exemple : Supprimer les TriggerBindings mybinding1
et mybinding2
dans un espace de noms
tkn triggerbinding delete mybinding1 mybinding2 -n myspace
$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace
5.3.11.8. description de l'obligation de déclenchement Copier lienLien copié sur presse-papiers!
Décrire un TriggerBinding.
Exemple : Décrire le lien mybinding
TriggerBinding dans un espace de noms
tkn triggerbinding describe mybinding -n myspace
$ tkn triggerbinding describe mybinding -n myspace
5.3.11.9. liste des déclencheurs (triggerbinding) Copier lienLien copié sur presse-papiers!
Liste des TriggerBindings.
Exemple : Lister tous les TriggerBindings d'un espace de noms
tkn triggerbinding list -n myspace
$ tkn triggerbinding list -n myspace
5.3.11.10. modèle de déclenchement Copier lienLien copié sur presse-papiers!
Gérer les modèles de déclenchement.
Exemple : Afficher l'aide de TriggerTemplate
tkn triggertemplate -h
$ tkn triggertemplate -h
5.3.11.11. modèle de déclenchement supprimer Copier lienLien copié sur presse-papiers!
Supprimer un TriggerTemplate.
Exemple : Supprimer les TriggerTemplates mytemplate1
et mytemplate2
dans un espace de noms
tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
5.3.11.12. modèle de déclenchement décrire Copier lienLien copié sur presse-papiers!
Décrire un TriggerTemplate.
Exemple : Décrire 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 modèles de déclenchement Copier lienLien copié sur presse-papiers!
Liste des modèles de déclenchement.
Exemple : Liste de tous les TriggerTemplates d'un espace de noms
tkn triggertemplate list -n myspace
$ tkn triggertemplate list -n myspace
5.3.11.14. clustertriggerbinding (liaison de déclenchement de cluster) Copier lienLien copié sur presse-papiers!
Gérer les ClusterTriggerBindings.
Exemple : Afficher l'aide sur les ClusterTriggerBindings
tkn clustertriggerbinding -h
$ tkn clustertriggerbinding -h
5.3.11.15. clustertriggerbinding delete Copier lienLien copié sur presse-papiers!
Supprimer un ClusterTriggerBinding.
Exemple : Supprimer myclusterbinding1
et myclusterbinding2
ClusterTriggerBindings
tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
5.3.11.16. clustertriggerbinding describe Copier lienLien copié sur presse-papiers!
Décrire un ClusterTriggerBinding.
Exemple : Décrire le lien myclusterbinding
ClusterTriggerBinding
tkn clustertriggerbinding describe myclusterbinding
$ tkn clustertriggerbinding describe myclusterbinding
5.3.11.17. liste des déclencheurs de clusters Copier lienLien copié sur presse-papiers!
Liste des ClusterTriggerBindings.
Exemple : Liste de tous les ClusterTriggerBindings
tkn clustertriggerbinding list
$ tkn clustertriggerbinding list
5.3.12. Commandes d'interaction avec le Hub Copier lienLien copié sur presse-papiers!
Interagir avec Tekton Hub pour les ressources telles que les tâches et les pipelines.
5.3.12.1. plaque tournante Copier lienLien copié sur presse-papiers!
Interagir avec le hub.
Exemple : Afficher l'aide
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
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 Copier lienLien copié sur presse-papiers!
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
$ tkn hub downgrade task mytask --to version -n mynamespace
5.3.12.3. hub get Copier lienLien copié sur presse-papiers!
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
$ tkn hub get [pipeline | task] myresource --from tekton --version version
5.3.12.4. info sur le moyeu Copier lienLien copié sur presse-papiers!
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
$ tkn hub info task mytask --from tekton --version version
5.3.12.5. installation du moyeu Copier lienLien copié sur presse-papiers!
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
$ tkn hub install task mytask --from tekton --version version -n mynamespace
5.3.12.6. réinstallation du moyeu Copier lienLien copié sur presse-papiers!
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
$ tkn hub reinstall task mytask --from tekton --version version -n mynamespace
5.3.12.7. recherche de moyeu Copier lienLien copié sur presse-papiers!
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
$ tkn hub search --tags cli
5.3.12.8. mise à niveau du moyeu Copier lienLien copié sur presse-papiers!
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
$ tkn hub upgrade task mytask --to version -n mynamespace