Chapitre 7. Déclenchement et modification des builds

Procédure

1. Créez un fichier YAML nommé add-webhooks-unauth.yaml et ajoutez le contenu suivant:

   apiVersion: rbac.authorization.k8s.io/v1
   kind: RoleBinding
   metadata:
     annotations:
       rbac.authorization.kubernetes.io/autoupdate: "true"
     name: webhook-access-unauthenticated
     namespace: <namespace> 

   1

   
   roleRef:
     apiGroup: rbac.authorization.k8s.io
     kind: Role
     name: "system:webhook"
   subjects:
     - apiGroup: rbac.authorization.k8s.io
       kind: Group
       name: "system:unauthenticated"

   Copy to Clipboard Toggle word wrap

   1

   L’espace de noms de votre BuildConfig.

2. Appliquer la configuration en exécutant la commande suivante:

   $ oc apply -f add-webhooks-unauth.yaml

   Copy to Clipboard Toggle word wrap

Procédure

1. Configurez un GitHub Webhook.

   1. Après avoir créé un objet BuildConfig à partir d’un référentiel GitHub, exécutez la commande suivante:

      $ oc describe bc/<name_of_your_BuildConfig>

      Copy to Clipboard Toggle word wrap

      Cette commande génère une URL webhook GitHub.

      Exemple de sortie

      https://api.starter-us-east-1.openshift.com:443/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/github

      Copy to Clipboard Toggle word wrap

   2. Découpez et collez cette URL dans GitHub, à partir de la console Web GitHub.
   3. Dans votre dépôt GitHub, sélectionnez Ajouter Webhook dans Paramètres Webhooks.
   4. Collez la sortie URL dans le champ URL de charge utile.
   5. Changez le type de contenu de l’application par défaut de GitHub/x-www-form-urlencoded en application/json.

   6. Cliquez sur Ajouter webhook.

      Il faut voir un message de GitHub indiquant que votre webhook a été configuré avec succès.

      Lorsque vous poussez un changement dans votre référentiel GitHub, une nouvelle version démarre automatiquement, et lors d’une construction réussie, un nouveau déploiement commence.

      Note

      Gogs prend en charge le même format de charge utile webhook que GitHub. Ainsi, si vous utilisez un serveur Gogs, vous pouvez définir un déclencheur GitHub webhook sur votre BuildConfig et le déclencher par votre serveur Gogs.

2. Compte tenu d’un fichier contenant une charge utile JSON valide, telle que payload.json, vous pouvez déclencher manuellement le webhook avec la commande curl suivante:

   $ curl -H "X-GitHub-Event: push" -H "Content-Type: application/json" -k -X POST --data-binary @payload.json https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/github

   Copy to Clipboard Toggle word wrap

   L’argument -k n’est nécessaire que si votre serveur API n’a pas de certificat signé correctement.

Procédure

1. Configurez un GitLab Webhook.

   1. Accédez à l’URL Webhook en entrant la commande suivante:

      $ oc describe bc <name>

      Copy to Clipboard Toggle word wrap
   2. Copiez l’URL Webhook en remplaçant <secret> par votre valeur secrète.
   3. Suivez les instructions de configuration de GitLab pour coller l’URL Webhook dans les paramètres de votre dépôt GitLab.

2. Compte tenu d’un fichier contenant une charge utile JSON valide, telle que payload.json, vous pouvez déclencher manuellement le webhook avec la commande curl suivante:

   $ curl -H "X-GitLab-Event: Push Hook" -H "Content-Type: application/json" -k -X POST --data-binary @payload.json https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/gitlab

   Copy to Clipboard Toggle word wrap

   L’argument -k n’est nécessaire que si votre serveur API n’a pas de certificat signé correctement.

Procédure

1. Configurez un Bitbucket Webhook.

   1. Accédez à l’URL Webhook en entrant la commande suivante:

      $ oc describe bc <name>

      Copy to Clipboard Toggle word wrap
   2. Copiez l’URL Webhook en remplaçant <secret> par votre valeur secrète.
   3. Suivez les instructions de configuration de Bitbucket pour coller l’URL Webhook dans vos paramètres de dépôt Bitbucket.

2. Étant donné un fichier contenant une charge utile JSON valide, telle que payload.json, vous pouvez déclencher manuellement le webhook en entrant la commande curl suivante:

   $ curl -H "X-Event-Key: repo:push" -H "Content-Type: application/json" -k -X POST --data-binary @payload.json https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/bitbucket

   Copy to Clipboard Toggle word wrap

   L’argument -k n’est nécessaire que si votre serveur API n’a pas de certificat signé correctement.

Procédure

1. Afin de configurer l’appelant, fournissez au système d’appel l’URL du point de terminaison webhook générique pour votre build.

   Exemple d’URL générique de point de terminaison webhook

   https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/generic

   Copy to Clipboard Toggle word wrap

   L’appelant doit appeler le webhook comme une opération POST.

2. Afin d’appeler le webhook manuellement, entrez la commande curl suivante:

   $ curl -X POST -k https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/generic

   Copy to Clipboard Toggle word wrap

   Le verbe HTTP doit être défini sur POST. Le drapeau -k non sécurisé est spécifié pour ignorer la validation du certificat. Ce second drapeau n’est pas nécessaire si votre cluster a correctement signé des certificats.

   Le point de terminaison peut accepter une charge utile optionnelle avec le format suivant:

   git:
     uri: "<url to git repository>"
     ref: "<optional git reference>"
     commit: "<commit hash identifying a specific git commit>"
     author:
       name: "<author name>"
       email: "<author e-mail>"
     committer:
       name: "<committer name>"
       email: "<committer e-mail>"
     message: "<commit message>"
   env: 

   1

   
      - name: "<variable name>"
        value: "<variable value>"

   Copy to Clipboard Toggle word wrap

   1

   Comme les variables d’environnement BuildConfig, les variables d’environnement définies ici sont mises à la disposition de votre build. Lorsque ces variables entrent en collision avec les variables d’environnement BuildConfig, ces variables priment. Les variables d’environnement transmises par webhook sont ignorées par défaut. Définissez le champ allowEnv sur true sur la définition de webhook pour activer ce comportement.

3. Afin de passer cette charge utile à l’aide de curl, définissez-la dans un fichier nommé payload_file.yaml et exécutez la commande suivante:

   $ curl -H "Content-Type: application/yaml" --data-binary @payload_file.yaml -X POST -k https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/generic

   Copy to Clipboard Toggle word wrap

   Les arguments sont les mêmes que l’exemple précédent avec l’ajout d’un en-tête et d’une charge utile. L’argument -H définit l’en-tête Content-Type sur application/yaml ou application/json en fonction de votre format de charge utile. L’argument --data-binary est utilisé pour envoyer une charge utile binaire avec des nouvelles lignes intactes avec la demande POST.