3.8. Utiliser les pipelines comme du code

Procédure

1. Configurez le webhook et créez une ressource personnalisée (CR) Repository.

   • Pour configurer un webhook et créer un CR Repository automatically à l'aide de l'outil CLI tkn pac, utilisez la commande suivante :

     $ tkn pac create repo

     Exemple de sortie interactive

     ? Enter the Git repository url (default: https://github.com/owner/repo):
     ? Please enter the namespace where the pipeline should run (default: repo-pipelines):
     ! Namespace repo-pipelines is not found
     ? Would you like me to create the namespace repo-pipelines? Yes
     ✓ Repository owner-repo has been created in repo-pipelines namespace
     ✓ Setting up GitHub Webhook for Repository https://github.com/owner/repo
     👀 I have detected a controller url: https://pipelines-as-code-controller-openshift-pipelines.apps.example.com
     ? Do you want me to use it? Yes
     ? Please enter the secret to configure the webhook for payload validation (default: sJNwdmTifHTs):  sJNwdmTifHTs
     ℹ ️You now need to create a GitHub personal access token, please checkout the docs at https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token for the required scopes
     ? Please enter the GitHub access token:  ****************************************
     ✓ Webhook has been created on repository owner/repo
     🔑 Webhook Secret owner-repo has been created in the repo-pipelines namespace.
     🔑 Repository CR owner-repo has been updated with webhook secret in the repo-pipelines namespace
     ℹ Directory .tekton has been created.
     ✓ We have detected your repository using the programming language Go.
     ✓ A basic template has been created in /home/Go/src/github.com/owner/repo/.tekton/pipelinerun.yaml, feel free to customize it.

   • Pour configurer un webhook et créer un Repository CR manually, procédez comme suit :

     1. Sur votre cluster OpenShift, extrayez l'URL publique du contrôleur Pipelines as Code.

        $ echo https://$(oc get route -n pipelines-as-code pipelines-as-code-controller -o jsonpath='{.spec.host}')

     2. Sur votre dépôt ou organisation GitHub, effectuez les étapes suivantes :

        1. Allez sur Settings -> Webhooks et cliquez sur Add webhook.
        2. Définissez l'adresse Payload URL sur l'URL publique du contrôleur Pipelines as Code.
        3. Sélectionnez le type de contenu application/json.

        4. Ajoutez un secret pour le webhook et notez-le dans un autre emplacement. Avec openssl installé sur votre machine locale, générez un secret aléatoire.

           $ openssl rand -hex 20

        5. Cliquez sur Let me select individual events et sélectionnez les événements suivants : Commit comments, Issue comments, Pull request, et Pushes.
        6. Cliquez sur Add webhook.

     3. Sur votre cluster OpenShift, créez un objet Secret avec le jeton d'accès personnel et le secret du webhook.

        $ oc -n target-namespace create secret generic github-webhook-config \
          --from-literal provider.token="<GITHUB_PERSONAL_ACCESS_TOKEN>" \
          --from-literal webhook.secret="<WEBHOOK_SECRET>"

     4. Créer un CR Repository.

        Exemple : Repository CR

        apiVersion: "pipelinesascode.tekton.dev/v1alpha1"
        kind: Repository
        metadata:
          name: my-repo
          namespace: target-namespace
        spec:
          url: "https://github.com/owner/repo"
          git_provider:
            secret:
              name: "github-webhook-config"
              key: "provider.token" # Set this if you have a different key in your secret
            webhook_secret:
              name: "github-webhook-config"
              key: "webhook.secret" # Set this if you have a different key for your secret

        Note

        Pipelines as Code suppose que l'objet OpenShift Secret et le CR Repository sont dans le même espace de noms.

2. Facultatif : Pour un CR Repository existant, ajoutez plusieurs secrets GitHub Webhook ou fournissez un substitut pour un secret supprimé.

   1. Ajoutez un webhook à l'aide de l'outil CLI tkn pac.

      Exemple : Webhook supplémentaire à l'aide de la CLI de tkn pac

      $ tkn pac webhook add -n repo-pipelines

      Exemple de sortie interactive

      ✓ Setting up GitHub Webhook for Repository https://github.com/owner/repo
      👀 I have detected a controller url: https://pipelines-as-code-controller-openshift-pipelines.apps.example.com
      ? Do you want me to use it? Yes
      ? Please enter the secret to configure the webhook for payload validation (default: AeHdHTJVfAeH):  AeHdHTJVfAeH
      ✓ Webhook has been created on repository owner/repo
      🔑 Secret owner-repo has been updated with webhook secert in the repo-pipelines namespace.

   2. Mettre à jour la clé webhook.secret dans l'objet OpenShift Secret existant.

3. Facultatif : Pour un CR Repository existant, mettez à jour le jeton d'accès personnel.

   • Mettez à jour le jeton d'accès personnel à l'aide de l'outil CLI tkn pac.

     Exemple : Mise à jour du jeton d'accès personnel à l'aide du CLI tkn pac

     $ tkn pac webhook update-token -n repo-pipelines

     Exemple de sortie interactive

     ? Please enter your personal access token:  ****************************************
     🔑 Secret owner-repo has been updated with new personal access token in the repo-pipelines namespace.

   • Vous pouvez également mettre à jour le jeton d'accès personnel en modifiant le CR Repository.

     1. Trouvez le nom du secret sur le site Repository CR.

        ...
        spec:
          git_provider:
            secret:
              name: "github-webhook-config"
        ...

     2. Utilisez la commande oc patch pour mettre à jour les valeurs de $NEW_TOKEN dans l'espace de noms $target_namespace.

        $ oc -n $target_namespace patch secret github-webhook-config -p "{\"data\": {\"provider.token\": \"$(echo -n $NEW_TOKEN|base64 -w0)\"}}"

Procédure

1. Configurez le webhook et créez une ressource personnalisée (CR) Repository.

   • Pour configurer un webhook et créer un CR Repository automatically à l'aide de l'outil CLI tkn pac, utilisez la commande suivante :

     $ tkn pac create repo

     Exemple de sortie interactive

     ? Enter the Git repository url (default: https://gitlab.com/owner/repo):
     ? Please enter the namespace where the pipeline should run (default: repo-pipelines):
     ! Namespace repo-pipelines is not found
     ? Would you like me to create the namespace repo-pipelines? Yes
     ✓ Repository repositories-project has been created in repo-pipelines namespace
     ✓ Setting up GitLab Webhook for Repository https://gitlab.com/owner/repo
     ? Please enter the project ID for the repository you want to be configured,
       project ID refers to an unique ID (e.g. 34405323) shown at the top of your GitLab project : 17103
     👀 I have detected a controller url: https://pipelines-as-code-controller-openshift-pipelines.apps.example.com
     ? Do you want me to use it? Yes
     ? Please enter the secret to configure the webhook for payload validation (default: lFjHIEcaGFlF):  lFjHIEcaGFlF
     ℹ ️You now need to create a GitLab personal access token with `api` scope
     ℹ ️Go to this URL to generate one https://gitlab.com/-/profile/personal_access_tokens, see https://is.gd/rOEo9B for documentation
     ? Please enter the GitLab access token:  **************************
     ? Please enter your GitLab API URL::  https://gitlab.com
     ✓ Webhook has been created on your repository
     🔑 Webhook Secret repositories-project has been created in the repo-pipelines namespace.
     🔑 Repository CR repositories-project has been updated with webhook secret in the repo-pipelines namespace
     ℹ Directory .tekton has been created.
     ✓ A basic template has been created in /home/Go/src/gitlab.com/repositories/project/.tekton/pipelinerun.yaml, feel free to customize it.

   • Pour configurer un webhook et créer un Repository CR manually, procédez comme suit :

     1. Sur votre cluster OpenShift, extrayez l'URL publique du contrôleur Pipelines as Code.

        $ echo https://$(oc get route -n pipelines-as-code pipelines-as-code-controller -o jsonpath='{.spec.host}')

     2. Sur votre projet GitLab, effectuez les étapes suivantes :

        1. Utilisez la barre latérale gauche pour aller à Settings -> Webhooks.
        2. Définissez l'adresse URL sur l'URL publique du contrôleur Pipelines as Code.

        3. Ajoutez un secret pour le webhook et notez-le dans un autre emplacement. Avec openssl installé sur votre machine locale, générez un secret aléatoire.

           $ openssl rand -hex 20

        4. Cliquez sur Let me select individual events et sélectionnez les événements suivants : Commit comments, Issue comments, Pull request, et Pushes.
        5. Cliquez sur Save changes.

     3. Sur votre cluster OpenShift, créez un objet Secret avec le jeton d'accès personnel et le secret du webhook.

        $ oc -n target-namespace create secret generic gitlab-webhook-config \
          --from-literal provider.token="<GITLAB_PERSONAL_ACCESS_TOKEN>" \
          --from-literal webhook.secret="<WEBHOOK_SECRET>"

     4. Créer un CR Repository.

        Exemple : Repository CR

        apiVersion: "pipelinesascode.tekton.dev/v1alpha1"
        kind: Repository
        metadata:
          name: my-repo
          namespace: target-namespace
        spec:
          url: "https://gitlab.com/owner/repo" 1
          git_provider:
            secret:
              name: "gitlab-webhook-config"
              key: "provider.token" # Set this if you have a different key in your secret
            webhook_secret:
              name: "gitlab-webhook-config"
              key: "webhook.secret" # Set this if you have a different key for your secret

        1

        Actuellement, Pipelines as Code ne détecte pas automatiquement les instances privées pour GitLab. Dans ce cas, spécifiez l'URL de l'API sous la spécification git_provider.url. En général, vous pouvez utiliser la spécification git_provider.url pour remplacer manuellement l'URL de l'API.

   Note

   • Pipelines as Code suppose que l'objet OpenShift Secret et le CR Repository sont dans le même espace de noms.

2. Facultatif : Pour un CR Repository existant, ajoutez plusieurs secrets GitLab Webhook ou fournissez un substitut pour un secret supprimé.

   1. Ajoutez un webhook à l'aide de l'outil CLI tkn pac.

      Exemple : Ajout d'un webhook supplémentaire à l'aide du CLI tkn pac

      $ tkn pac webhook add -n repo-pipelines

      Exemple de sortie interactive

      ✓ Setting up GitLab Webhook for Repository https://gitlab.com/owner/repo
      👀 I have detected a controller url: https://pipelines-as-code-controller-openshift-pipelines.apps.example.com
      ? Do you want me to use it? Yes
      ? Please enter the secret to configure the webhook for payload validation (default: AeHdHTJVfAeH):  AeHdHTJVfAeH
      ✓ Webhook has been created on repository owner/repo
      🔑 Secret owner-repo has been updated with webhook secert in the repo-pipelines namespace.

   2. Mettre à jour la clé webhook.secret dans l'objet OpenShift Secret existant.

3. Facultatif : Pour un CR Repository existant, mettez à jour le jeton d'accès personnel.

   • Mettez à jour le jeton d'accès personnel à l'aide de l'outil CLI tkn pac.

     Exemple : Mise à jour du jeton d'accès personnel à l'aide du CLI tkn pac

     $ tkn pac webhook update-token -n repo-pipelines

     Exemple de sortie interactive

     ? Please enter your personal access token:  ****************************************
     🔑 Secret owner-repo has been updated with new personal access token in the repo-pipelines namespace.

   • Vous pouvez également mettre à jour le jeton d'accès personnel en modifiant le CR Repository.

     1. Trouvez le nom du secret sur le site Repository CR.

        ...
        spec:
          git_provider:
            secret:
              name: "gitlab-webhook-config"
        ...

     2. Utilisez la commande oc patch pour mettre à jour les valeurs de $NEW_TOKEN dans l'espace de noms $target_namespace.

        $ oc -n $target_namespace patch secret gitlab-webhook-config -p "{\"data\": {\"provider.token\": \"$(echo -n $NEW_TOKEN|base64 -w0)\"}}"

Procédure

1. Configurez le webhook et créez un CR Repository.

   • Pour configurer un webhook et créer un CR Repository automatically à l'aide de l'outil CLI tkn pac, utilisez la commande suivante :

     $ tkn pac create repo

     Exemple de sortie interactive

     ? Enter the Git repository url (default: https://bitbucket.org/workspace/repo):
     ? Please enter the namespace where the pipeline should run (default: repo-pipelines):
     ! Namespace repo-pipelines is not found
     ? Would you like me to create the namespace repo-pipelines? Yes
     ✓ Repository workspace-repo has been created in repo-pipelines namespace
     ✓ Setting up Bitbucket Webhook for Repository https://bitbucket.org/workspace/repo
     ? Please enter your bitbucket cloud username:  <username>
     ℹ ️You now need to create a Bitbucket Cloud app password, please checkout the docs at https://is.gd/fqMHiJ for the required permissions
     ? Please enter the Bitbucket Cloud app password:  ************************************
     👀 I have detected a controller url: https://pipelines-as-code-controller-openshift-pipelines.apps.example.com
     ? Do you want me to use it? Yes
     ✓ Webhook has been created on repository workspace/repo
     🔑 Webhook Secret workspace-repo has been created in the repo-pipelines namespace.
     🔑 Repository CR workspace-repo has been updated with webhook secret in the repo-pipelines namespace
     ℹ Directory .tekton has been created.
     ✓ A basic template has been created in /home/Go/src/bitbucket/repo/.tekton/pipelinerun.yaml, feel free to customize it.

   • Pour configurer un webhook et créer un Repository CR manually, procédez comme suit :

     1. Sur votre cluster OpenShift, extrayez l'URL publique du contrôleur Pipelines as Code.

        $ echo https://$(oc get route -n pipelines-as-code pipelines-as-code-controller -o jsonpath='{.spec.host}')

     2. Sur Bitbucket Cloud, effectuez les étapes suivantes :

        1. Utilisez le volet de navigation gauche de votre référentiel Bitbucket Cloud pour aller sur Repository settings -> Webhooks et cliquez sur Add webhook.
        2. Définir un site Title. Par exemple, "Pipelines as Code".
        3. Définissez l'adresse URL sur l'URL publique du contrôleur Pipelines as Code.
        4. Sélectionnez ces événements : Repository: Push, Pull Request: Created, Pull Request: Updated, et Pull Request: Comment created.
        5. Cliquez sur Save.

     3. Sur votre cluster OpenShift, créez un objet Secret avec le mot de passe de l'application dans l'espace de noms cible.

        $ oc -n target-namespace create secret generic bitbucket-cloud-token \
          --from-literal provider.token="<BITBUCKET_APP_PASSWORD>"

     4. Créer un CR Repository.

        Exemple : Repository CR

        apiVersion: "pipelinesascode.tekton.dev/v1alpha1"
        kind: Repository
        metadata:
          name: my-repo
          namespace: target-namespace
        spec:
          url: "https://bitbucket.com/workspace/repo"
          branch: "main"
          git_provider:
            user: "<BITBUCKET_USERNAME>" 1
            secret:
              name: "bitbucket-cloud-token" 2
              key: "provider.token" # Set this if you have a different key in your secret

        1

        Vous ne pouvez faire référence à un utilisateur que par l'adresse ACCOUNT_ID dans un fichier propriétaire.

        2

        Pipelines as Code suppose que le secret mentionné dans la spécification git_provider.secret et la CR Repository se trouve dans le même espace de noms.

   Note

   • Les commandes tkn pac create et tkn pac bootstrap ne sont pas prises en charge sur Bitbucket Cloud.

   • Bitbucket Cloud ne prend pas en charge les secrets des webhooks. Pour sécuriser la charge utile et empêcher le détournement de l'IC, Pipelines as Code récupère la liste des adresses IP de Bitbucket Cloud et s'assure que les réceptions de webhook proviennent uniquement de ces adresses IP.

     • Pour désactiver le comportement par défaut, définissez bitbucket-cloud-check-source-ip key comme false dans la carte de configuration de Pipelines as Code pour l'espace de noms pipelines-as-code.
     • Pour autoriser d'autres adresses IP ou réseaux sûrs, ajoutez-les sous forme de valeurs séparées par des virgules à la clé bitbucket-cloud-additional-source-ip dans la carte de configuration Pipelines as Code pour l'espace de noms pipelines-as-code.

2. Facultatif : Pour un CR Repository existant, ajoutez plusieurs secrets Bitbucket Cloud Webhook ou fournissez un substitut pour un secret supprimé.

   1. Ajoutez un webhook à l'aide de l'outil CLI tkn pac.

      Exemple : Ajout d'un webhook supplémentaire à l'aide du CLI tkn pac

      $ tkn pac webhook add -n repo-pipelines

      Exemple de sortie interactive

      ✓ Setting up Bitbucket Webhook for Repository https://bitbucket.org/workspace/repo
      ? Please enter your bitbucket cloud username:  <username>
      👀 I have detected a controller url: https://pipelines-as-code-controller-openshift-pipelines.apps.example.com
      ? Do you want me to use it? Yes
      ✓ Webhook has been created on repository workspace/repo
      🔑 Secret workspace-repo has been updated with webhook secret in the repo-pipelines namespace.

      Note

      Utilisez l'option [-n <namespace>] avec la commande tkn pac webhook add uniquement lorsque le CR Repository existe dans un espace de noms autre que l'espace de noms par défaut.

   2. Mettre à jour la clé webhook.secret dans l'objet OpenShift Secret existant.

3. Facultatif : Pour un CR Repository existant, mettez à jour le jeton d'accès personnel.

   • Mettez à jour le jeton d'accès personnel à l'aide de l'outil CLI tkn pac.

     Exemple : Mise à jour du jeton d'accès personnel à l'aide du CLI tkn pac

     $ tkn pac webhook update-token -n repo-pipelines

     Exemple de sortie interactive

     ? Please enter your personal access token:  ****************************************
     🔑 Secret owner-repo has been updated with new personal access token in the repo-pipelines namespace.

     Note

     Utilisez l'option [-n <namespace>] avec la commande tkn pac webhook update-token uniquement lorsque le CR Repository existe dans un espace de noms autre que l'espace de noms par défaut.

   • Vous pouvez également mettre à jour le jeton d'accès personnel en modifiant le CR Repository.

     1. Trouvez le nom du secret sur le site Repository CR.

        ...
        spec:
          git_provider:
            user: "<BITBUCKET_USERNAME>"
            secret:
              name: "bitbucket-cloud-token"
              key: "provider.token"
        ...

     2. Utilisez la commande oc patch pour mettre à jour les valeurs de $password dans l'espace de noms $target_namespace.

        $ oc -n $target_namespace patch secret bitbucket-cloud-token -p "{\"data\": {\"provider.token\": \"$(echo -n $NEW_TOKEN|base64 -w0)\"}}"

Procédure

1. Sur votre cluster OpenShift, extrayez l'URL publique du contrôleur Pipelines as Code.

   $ echo https://$(oc get route -n pipelines-as-code pipelines-as-code-controller -o jsonpath='{.spec.host}')

2. Sur le serveur Bitbucket, effectuez les étapes suivantes :

   1. Utilisez le volet de navigation gauche de votre référentiel Bitbucket Data Center pour aller sur Repository settings -> Webhooks et cliquez sur Add webhook.
   2. Définir un site Title. Par exemple, "Pipelines as Code".
   3. Définissez l'adresse URL sur l'URL publique du contrôleur Pipelines as Code.

   4. Ajoutez un secret pour le webhook et sauvegardez-en une copie dans un autre emplacement. Si openssl est installé sur votre machine locale, générez un secret aléatoire à l'aide de la commande suivante :

      $ openssl rand -hex 20

   5. Sélectionnez les événements suivants :

      • Repository: Push
      • Repository: Modified
      • Pull Request: Opened
      • Pull Request: Source branch updated
      • Pull Request: Comment added
   6. Cliquez sur Save.

3. Sur votre cluster OpenShift, créez un objet Secret avec le mot de passe de l'application dans l'espace de noms cible.

   $ oc -n target-namespace create secret generic bitbucket-server-webhook-config \
     --from-literal provider.token="<PERSONAL_TOKEN>" \
     --from-literal webhook.secret="<WEBHOOK_SECRET>"

4. Créer un CR Repository.

   Exemple : Repository CR

   ---
     apiVersion: "pipelinesascode.tekton.dev/v1alpha1"
     kind: Repository
     metadata:
       name: my-repo
       namespace: target-namespace
     spec:
       url: "https://bitbucket.com/workspace/repo"
       git_provider:
         url: "https://bitbucket.server.api.url/rest" 1
         user: "<BITBUCKET_USERNAME>" 2
         secret: 3
           name: "bitbucket-server-webhook-config"
           key: "provider.token" # Set this if you have a different key in your secret
         webhook_secret:
           name: "bitbucket-server-webhook-config"
           key: "webhook.secret" # Set this if you have a different key for your secret

   1

   Assurez-vous que vous avez la bonne URL de l'API du serveur Bitbucket sans le suffixe /api/v1.0. En général, l'installation par défaut a un suffixe /rest.

   2

   Vous ne pouvez faire référence à un utilisateur que par l'adresse ACCOUNT_ID dans un fichier propriétaire.

   3

   Pipelines as Code suppose que le secret mentionné dans la spécification git_provider.secret et la CR Repository se trouve dans le même espace de noms.

   Note

   Les commandes tkn pac create et tkn pac bootstrap ne sont pas prises en charge par le serveur Bitbucket.