Aller au contenu principal

Afficher l'onglet Jenkins sur un composant

Chaque composant annoté reçoit un onglet Jenkins avec ses builds, et une carte Latest master build sur sa Vue d'ensemble.

Comment faire​

1. Allume le plugin​

  1. Dans Administration, sous PLATEFORME, clique sur Plugins.
  2. Sur la carte Jenkins, allume l'interrupteur Activer Jenkins.

Si la carte dit Configurez d'abord l'intégration Jenkins, clique dessus : l'intégration s'ouvre dans Connexions de l'entreprise. Ajoute-la (Ajouter l'intégration Jenkins). Le plugin s'allume tout seul quand tu enregistres l'intégration : passe à l'étape 2.

2. Annote le composant​

Dans le catalog-info.yaml du composant, ajoute le nom complet de son job Jenkins :

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: shop-api
  annotations:
    jenkins.io/job-full-name: shop-api
spec:
  type: service
  lifecycle: production
  owner: team-a
Où est le nom complet ?

C'est le chemin du job dans la barre d'adresse de Jenkins, sans job/. Le job https://jenkins.exemple.com/job/shop/job/shop-api/ s'écrit shop/shop-api.

3. Vérifie​

Ouvre le composant dans Catalogue. Un onglet Jenkins est à côté de Vue d'ensemble. Clique dessus : le job est listé avec son dernier build.

✅ C'est fait.

Ce que ça affiche, et pour qui​

Les libellés de l'onglet et de la carte restent en anglais, même quand Astrolabe est en français.

ColonneQuoi
BuildLe nom du job, avec un lien. Un dossier de branches donne une ligne par branche, par exemple shop » master
TestsLes résultats des tests, ou n/a
StatusPar exemple Completed
Last Run DurationPar exemple 0.1 s
ActionsView build ouvre le build dans Jenkins

Sur Vue d'ensemble, la carte Latest master build montre le Status, le Build, le Latest Run et la Duration du dernier build du job master, avec un lien See more on Jenkins. Elle lit le job nommé master dans ton job : utilise un job qui a une branche master.

Toute personne qui peut ouvrir le composant voit l'onglet et la carte. Astrolabe lit Jenkins avec l'utilisateur et le jeton de l'intégration, les mêmes pour tout le monde.

Plusieurs jobs sur un composant​

Écris les noms complets séparés par une virgule. Ils doivent être sur le même Jenkins.

metadata:
  annotations:
    jenkins.io/job-full-name: shop-api,shop/shop-api-tests

L'onglet liste les builds de chaque job.

Tu as plusieurs Jenkins​

Commence l'annotation par la clé d'instance de l'intégration, puis :, puis le nom du job :

metadata:
  annotations:
    jenkins.io/job-full-name: prod:shop-api

Ici, prod est la Clé de l'instance Jenkins de l'intégration du Jenkins de production.

La suite : Ajouter les cartes Jenkins à ton tableau de bord.

Un souci ? Voir Problèmes courants avec Jenkins.