3.9. Travailler avec Red Hat OpenShift Pipelines en utilisant la perspective du développeur

Procédure

1. Dans la vue Add de la perspective Developer, cliquez sur la tuile Pipeline pour voir la page Pipeline builder.

2. Configurez le pipeline à l'aide de la vue Pipeline builder ou de la vue YAML view.

   Note

   La vue Pipeline builder prend en charge un nombre limité de champs, tandis que la vue YAML view prend en charge tous les champs disponibles. En option, vous pouvez également utiliser les snippets et échantillons réutilisables installés par l'opérateur pour créer des pipelines détaillés.

   Figure 3.1. Vue YAML

   

   View larger image

   

3. Configurez votre pipeline en utilisant Pipeline builder:

   1. Dans le champ Name, saisissez un nom unique pour la canalisation.

   2. Dans la section Tasks:

      1. Cliquez sur Add task.
      2. Recherchez une tâche à l'aide du champ de recherche rapide et sélectionnez la tâche requise dans la liste affichée.

      3. Cliquez sur Add ou Install and add. Dans cet exemple, utilisez la tâche s2i-nodejs.

         Note

         La liste de recherche contient toutes les tâches du Tekton Hub et les tâches disponibles dans le cluster. De plus, si une tâche est déjà installée, la liste affichera Add pour ajouter la tâche, tandis qu'elle affichera Install and add pour installer et ajouter la tâche. Elle affichera Update and add si vous ajoutez la même tâche avec une version mise à jour.

         • Pour ajouter des tâches séquentielles au pipeline :

           • Cliquez sur l'icône plus à droite ou à gauche de la tâche cliquez sur Add task.
           • Recherchez une tâche à l'aide du champ de recherche rapide et sélectionnez la tâche requise dans la liste affichée.

           • Cliquez sur Add ou Install and add.

             Figure 3.2. Constructeur de pipelines

             

             View larger image

             

         • Pour ajouter une tâche finale :

           • Cliquez sur Add finally task Cliquez sur Add task.
           • Recherchez une tâche à l'aide du champ de recherche rapide et sélectionnez la tâche requise dans la liste affichée.
           • Cliquez sur Add ou Install and add.

   3. Dans la section Resources, cliquez sur Add Resources pour spécifier le nom et le type de ressources pour l'exécution du pipeline. Ces ressources sont ensuite utilisées par les tâches du pipeline en tant qu'entrées et sorties. Pour cet exemple :

      1. Ajoutez une ressource d'entrée. Dans le champ Name, saisissez Source, puis dans la liste déroulante Resource Type, sélectionnez Git.

      2. Ajoutez une ressource de sortie. Dans le champ Name, saisissez Img, puis dans la liste déroulante Resource Type, sélectionnez Image.

         Note

         Une icône rouge apparaît à côté de la tâche si une ressource est manquante.

   4. Facultatif : Le site Parameters pour une tâche est pré-rempli sur la base des spécifications de la tâche. Si nécessaire, utilisez le lien Add Parameters dans la section Parameters pour ajouter des paramètres supplémentaires.
   5. Dans la section Workspaces, cliquez sur Add workspace et saisissez un nom d'espace de travail unique dans le champ Name. Vous pouvez ajouter plusieurs espaces de travail au pipeline.

   6. Dans la section Tasks, cliquez sur la tâche s2i-nodejs pour afficher le panneau latéral contenant les détails de la tâche. Dans le panneau latéral de la tâche, spécifiez les ressources et les paramètres de la tâche s2i-nodejs:

      1. Si nécessaire, dans la section Parameters, ajoutez des paramètres aux paramètres par défaut, en utilisant la syntaxe $(params.<param-name>).
      2. Dans la section Image, saisissez Img comme spécifié dans la section Resources.
      3. Sélectionnez un espace de travail dans la liste déroulante source sous la section Workspaces.
   7. Ajouter des ressources, des paramètres et des espaces de travail à la tâche openshift-client.
4. Cliquez sur Create pour créer et visualiser le pipeline dans la page Pipeline Details.
5. Cliquez sur le menu déroulant Actions puis sur Start, pour voir la page Start Pipeline.
6. La section Workspaces répertorie les espaces de travail que vous avez créés précédemment. Utilisez le menu déroulant correspondant pour spécifier la source de volume de votre espace de travail. Vous disposez des options suivantes : Empty Directory, Config Map, Secret, PersistentVolumeClaim, ou VolumeClaimTemplate.

Procédure

1. Dans la perspective du développeur, choisissez l'espace de noms ou le projet dans lequel vous souhaitez ajouter votre dépôt GitHub.
2. Naviguez vers Pipelines en utilisant le volet de navigation de gauche.
3. Cliquez sur Create Repository à droite de la page Pipelines.
4. Saisissez votre Git Repo URL et la console récupère automatiquement le nom du dépôt.

5. Cliquez sur Show configuration options. Par défaut, une seule option s'affiche Setup a webhook. Si vous avez configuré une application GitHub, deux options s'affichent :

   • Use GitHub App: Sélectionnez cette option pour installer votre application GitHub dans votre référentiel.
   • Setup a webhook: Sélectionnez cette option pour ajouter un webhook à votre application GitHub.

6. Configurez un webhook en utilisant l'une des options suivantes dans la section Secret:

   • Configurer un webhook à l'aide de Git access token:

     1. Saisissez votre code d'accès personnel.

     2. Cliquez sur Generate correspondant au champ Webhook secret pour générer un nouveau secret webhook.

        

        View larger image

        
        Note

        Vous pouvez cliquer sur le lien situé sous le champ Git access token si vous n'avez pas de jeton d'accès personnel et que vous souhaitez en créer un nouveau.

   • Configurer un webhook à l'aide de Git access token secret:

     • Sélectionnez un secret dans votre espace de noms dans la liste déroulante. En fonction du secret sélectionné, un secret de webhook est automatiquement généré.

       

       View larger image

       

7. Ajoutez les détails secrets du webhook à votre dépôt GitHub :

   1. Copiez le site webhook URL et accédez aux paramètres de votre dépôt GitHub.
   2. Cliquez sur Webhooks Add webhook.
   3. Copiez l'adresse Webhook URL depuis la console de développement et collez-la dans le champ Payload URL des paramètres du dépôt GitHub.
   4. Sélectionnez le site Content type.
   5. Copiez l'adresse Webhook secret depuis la console de développement et collez-la dans le champ Secret des paramètres du dépôt GitHub.
   6. Sélectionnez l'une des options SSL verification.
   7. Sélectionnez les événements qui déclencheront ce webhook.
   8. Cliquez sur Add webhook.
8. Retournez à la console du développeur et cliquez sur Add.
9. Lisez les détails des étapes à suivre et cliquez sur Close.
10. Affichez les détails du référentiel que vous venez de créer.

Procédure

1. Dans la vue Pipelines de la perspective Developer, sélectionnez un projet dans la liste déroulante Project pour voir les pipelines de ce projet.

2. Cliquez sur le pipeline souhaité pour afficher la page Pipeline details.

   Par défaut, l'onglet Details affiche une représentation visuelle de toutes les tâches serial, parallel, finally et when du pipeline. Les tâches et les tâches finally sont listées dans la partie inférieure droite de la page.

   Pour afficher les détails de la tâche, cliquez sur les tâches répertoriées Tasks et Finally. En outre, vous pouvez effectuer les opérations suivantes :

   • Utilisez les fonctions de zoom avant, zoom arrière, adaptation à l'écran et réinitialisation de la vue à l'aide des icônes standard affichées dans le coin inférieur gauche de la visualisation Pipeline details.
   • Modifier le facteur de zoom de la visualisation du pipeline à l'aide de la molette de la souris.

   • Survolez les tâches pour en voir les détails.

     Figure 3.3. Détails du pipeline

     

     View larger image

     

3. Facultatif : Sur la page Pipeline details, cliquez sur l'onglet Metrics pour obtenir les informations suivantes sur les pipelines :

   • Pipeline Success Ratio
   • Number of Pipeline Runs
   • Pipeline Run Duration

   • Task Run Duration

     Vous pouvez utiliser ces informations pour améliorer le flux de travail du pipeline et éliminer les problèmes dès le début du cycle de vie du pipeline.

4. Facultatif : Cliquez sur l'onglet YAML pour modifier le fichier YAML du pipeline.

5. En option, cliquez sur l'onglet pour voir les exécutions terminées ou échouées du pipeline : Cliquez sur l'onglet Pipeline Runs pour afficher les exécutions terminées, en cours ou échouées du pipeline.

   L'onglet Pipeline Runs fournit des détails sur l'exécution du pipeline, l'état de la tâche et un lien pour déboguer les exécutions de pipeline qui ont échoué. Utiliser le menu Options pour arrêter un pipeline en cours d'exécution, pour réexécuter un pipeline en utilisant les mêmes paramètres et ressources que ceux de l'exécution précédente du pipeline, ou pour supprimer un pipeline en cours d'exécution.

   • Cliquez sur l'exécution de pipeline requise pour afficher la page Pipeline Run details. Par défaut, l'onglet Details affiche une représentation visuelle de toutes les tâches en série, tâches en parallèle, tâches finally et expressions dans le pipeline. Les résultats des exécutions réussies sont affichés dans le volet Pipeline Run results au bas de la page. En outre, vous ne pourrez voir que les tâches du Tekton Hub qui sont prises en charge par le cluster. Lorsque vous regardez une tâche, vous pouvez cliquer sur le lien situé à côté pour accéder à la documentation de la tâche.

     Note

     La section Details de la page Pipeline Run Details affiche un Log Snippet de l'échec de l'exécution du pipeline. Log Snippet fournit un message d'erreur général et un extrait du journal. Un lien vers la section Logs permet d'accéder rapidement aux détails de l'échec de l'exécution.

   • Sur la page Pipeline Run details, cliquez sur l'onglet Task Runs pour voir les exécutions terminées, en cours et échouées de la tâche.

     L'onglet Task Runs fournit des informations sur l'exécution de la tâche avec les liens vers sa tâche et son pod, ainsi que le statut et la durée de l'exécution de la tâche. Utiliser le menu Options pour supprimer une tâche.

   • Cliquez sur l'exécution de la tâche requise pour afficher la page Task Run details. Les résultats des exécutions réussies sont affichés dans le volet Task Run results au bas de la page.

     Note

     La section Details de la page Task Run details affiche une Log Snippet de l'échec de l'exécution de la tâche. Log Snippet fournit un message d'erreur général et un extrait du journal. Un lien vers la section Logs permet d'accéder rapidement aux détails de l'échec de l'exécution de la tâche.

6. Cliquez sur l'onglet Parameters pour afficher les paramètres définis dans le pipeline. Vous pouvez également ajouter ou modifier des paramètres supplémentaires, si nécessaire.
7. Cliquez sur l'onglet Resources pour voir les ressources définies dans le pipeline. Vous pouvez également ajouter ou modifier des ressources supplémentaires, si nécessaire.

Procédure

1. Connectez-vous à la console web d'OpenShift Container Platform en tant qu'administrateur de cluster.

2. Dans la perspective Administrator, utilisez le panneau de navigation gauche pour aller à la section Pipelines.

   1. Dans le menu déroulant Project, sélectionnez le projet openshift. Cela garantit que les étapes suivantes seront effectuées dans l'espace de noms openshift.

   2. Dans la liste des pipelines disponibles, sélectionnez celui qui convient à la construction et au déploiement de votre application. Par exemple, si votre application nécessite un environnement d'exécution node.js, sélectionnez le pipeline s2i-nodejs.

      Note

      Ne modifiez pas le modèle de pipeline par défaut. Il pourrait devenir incompatible avec l'interface utilisateur et le back-end.

   3. Sous l'onglet YAML du pipeline sélectionné, cliquez sur Download et enregistrez le fichier YAML sur votre machine locale. Si votre fichier de configuration personnalisé échoue, vous pouvez utiliser cette copie pour restaurer une configuration fonctionnelle.

3. Désactiver (supprimer) les modèles de pipeline par défaut :

   1. Utilisez le panneau de navigation gauche pour aller à Operators Installed Operators.
   2. Cliquez sur Red Hat OpenShift Pipelines Tekton Configuration tab config YAML tab.

   3. Pour désactiver (supprimer) les modèles de pipeline par défaut dans l'espace de noms openshift, définissez le paramètre pipelineTemplates à false dans la ressource personnalisée YAML TektonConfig, et enregistrez-la.

      apiVersion: operator.tekton.dev/v1alpha1
      kind: TektonConfig
      metadata:
        name: config
      spec:
      profile: all
      targetNamespace: openshift-pipelines
      addon:
        params:
        - name: clusterTasks
          value: "true"
        - name: pipelineTemplates
          value: "false"
      ...

      Copy to Clipboard Toggle word wrap
      Note

      Si vous supprimez manuellement les modèles de pipeline par défaut, l'opérateur rétablit les valeurs par défaut lors d'une mise à niveau.

      Avertissement

      En tant qu'administrateur de cluster, vous pouvez désactiver l'installation des modèles de pipeline par défaut dans la configuration de l'opérateur. Cependant, une telle configuration supprime tous les modèles de pipeline par défaut, et pas seulement celui que vous souhaitez personnaliser.

4. Créer un modèle de pipeline personnalisé :

   1. Utilisez le panneau de navigation de gauche pour accéder à la section Pipelines.
   2. Dans la liste déroulante Create, sélectionnez Pipeline.

   3. Créez le pipeline requis dans l'espace de noms openshift. Donnez-lui un nom différent de celui par défaut (par exemple, custom-nodejs). Vous pouvez utiliser le modèle de pipeline par défaut téléchargé comme point de départ et le personnaliser.

      Note

      Comme openshift est l'espace de noms par défaut utilisé par les modèles de pipeline installés par l'opérateur, vous devez créer le modèle de pipeline personnalisé dans l'espace de noms openshift. Lorsqu'une application utilise un modèle de pipeline, celui-ci est automatiquement copié dans l'espace de noms du projet concerné.

   4. Sous l'onglet Details du pipeline créé, assurez-vous que les Labels du modèle personnalisé correspondent aux étiquettes du pipeline par défaut. Le modèle de pipeline personnalisé doit comporter les étiquettes correctes pour l'exécution, le type et la stratégie de l'application. Par exemple, les étiquettes requises pour une application node.js déployée sur OpenShift Container Platform sont les suivantes :

      ...
      pipeline.openshift.io/runtime: nodejs
      pipeline.openshift.io/type: openshift
      ...

      Copy to Clipboard Toggle word wrap
      Note

      Vous ne pouvez utiliser qu'un seul modèle de pipeline pour chaque combinaison d'environnement d'exécution et de type de déploiement.

5. Dans la perspective Developer, utilisez l'option Add Git Repository From Git pour sélectionner le type d'application que vous souhaitez créer et déployer. En fonction de la durée d'exécution requise et du type d'application, votre modèle personnalisé est automatiquement sélectionné.

1. Dans la vue Pipelines de la perspective Developer, cliquez sur le lien Options à côté d'un pipeline et sélectionnez Start.

2. La boîte de dialogue Start Pipeline affiche Git Resources et Image Resources en fonction de la définition du pipeline.

   Note

   Pour les pipelines créés à l'aide de l'option From Git, la boîte de dialogue Start Pipeline affiche également un champ APP_NAME dans la section Parameters, et tous les champs de la boîte de dialogue sont pré-remplis par le modèle de pipeline.

   1. Si vous disposez de ressources dans votre espace de noms, les champs Git Resources et Image Resources sont préremplis avec ces ressources. Si nécessaire, utilisez les menus déroulants pour sélectionner ou créer les ressources requises et personnaliser l'instance d'exécution du pipeline.

3. Facultatif : Modifiez le site Advanced Options pour ajouter les informations d'identification qui authentifient le serveur Git privé spécifié ou le registre d'images.

   1. Sous Advanced Options, cliquez sur Show Credentials Options et sélectionnez Add Secret.

   2. Dans la section Create Source Secret, indiquez ce qui suit :

      1. Une adresse unique Secret Name pour le secret.
      2. Dans la section Designated provider to be authenticated, indiquez le fournisseur à authentifier dans le champ Access to et la base Server URL.

      3. Sélectionnez le site Authentication Type et fournissez les informations d'identification :

         • Pour le champ Authentication Type Image Registry Credentials , indiquez le Registry Server Address que vous souhaitez authentifier et fournissez vos informations d'identification dans les champs Username, Password et Email.

           Sélectionnez Add Credentials si vous souhaitez spécifier un Registry Server Address supplémentaire.

         • Pour le site Authentication Type Basic Authentication , indiquez les valeurs des champs UserName et Password or Token.

         • Pour le champ Authentication Type SSH Keys , indiquez la valeur du champ SSH Private Key.

           Note

           Pour l'authentification de base et l'authentification SSH, vous pouvez utiliser des annotations telles que :

           • tekton.dev/git-0: https://github.com
           • tekton.dev/git-1: https://gitlab.com.
      4. Cochez la case pour ajouter le secret.

   Vous pouvez ajouter plusieurs secrets en fonction du nombre de ressources dans votre pipeline.

4. Cliquez sur Start pour démarrer le pipeline.

5. La page PipelineRun details affiche le pipeline en cours d'exécution. Après le démarrage du pipeline, les tâches et les étapes de chaque tâche sont exécutées. Vous pouvez :

   • Utilisez les fonctions de zoom avant, zoom arrière, adaptation à l'écran et réinitialisation de l'affichage à l'aide des icônes standard, qui se trouvent dans le coin inférieur gauche de la visualisation de la page PipelineRun details.
   • Modifiez le facteur de zoom de la visualisation pipelinerun à l'aide de la molette de la souris. À certains facteurs de zoom, la couleur de fond des tâches change pour indiquer l'état d'erreur ou d'avertissement.
   • Survolez les tâches pour en voir les détails, tels que le temps nécessaire à l'exécution de chaque étape, le nom de la tâche et son statut.
   • Survolez l'insigne des tâches pour voir le nombre total de tâches et les tâches accomplies.
   • Cliquez sur une tâche pour voir les journaux de chaque étape de la tâche.
   • Cliquez sur l'onglet Logs pour consulter les journaux relatifs à la séquence d'exécution des tâches. Vous pouvez également développer le volet et télécharger les journaux individuellement ou en masse, en utilisant le bouton correspondant.

   • Cliquez sur l'onglet Events pour voir le flux d'événements générés par l'exécution d'un pipeline.

     Vous pouvez utiliser les onglets Task Runs, Logs, et Events pour faciliter le débogage d'un pipeline ou d'une tâche dont l'exécution a échoué.

     Figure 3.4. Détails de l'exécution du pipeline

     

     View larger image

     

Procédure

1. Cliquez sur Topology dans le panneau de navigation de gauche.
2. Cliquez sur l'application pour afficher Pipeline Runs dans le panneau latéral.

3. Dans Pipeline Runs, cliquez sur Start Last Run pour lancer une nouvelle canalisation avec les mêmes paramètres et ressources que la précédente. Cette option est désactivée si aucun pipeline n'a été lancé. Vous pouvez également démarrer un pipeline lors de sa création.

   Figure 3.5. Pipelines dans la vue Topologie

   

   View larger image

   

Procédure

1. Dans la vue Pipelines de la perspective Developer, sélectionnez la canalisation que vous souhaitez modifier pour en voir les détails. Dans la page Pipeline Details, cliquez sur Actions et sélectionnez Edit Pipeline.

2. Sur la page Pipeline builder, vous pouvez effectuer les tâches suivantes :

   • Ajouter des tâches, des paramètres ou des ressources supplémentaires au pipeline.
   • Cliquez sur la tâche que vous souhaitez modifier pour afficher les détails de la tâche dans le panneau latéral et modifier les détails requis de la tâche, tels que le nom d'affichage, les paramètres et les ressources.
   • Pour supprimer la tâche, cliquez sur la tâche et, dans le panneau latéral, cliquez sur Actions et sélectionnez Remove Task.
3. Cliquez sur Save pour enregistrer le pipeline modifié.

Procédure

1. Dans la vue Pipelines de la perspective Developer, cliquez sur le lien Options à côté d'une ligne de conduite et sélectionnez Delete Pipeline.
2. Dans la demande de confirmation Delete Pipeline, cliquez sur Delete pour confirmer la suppression.