Add the Jenkins cards to your dashboard
The Jenkins cards of My Dashboards show the builds of the components of the catalog, so you see at a glance what ran and what failed, without opening Jenkins.
Before you start
- Your administrator has added the Jenkins integration. The cards need nothing from you: no token to enter, Astrolabe reads Jenkins with the integration.
- Your components are annotated
jenkins.io/job-full-name. See Show the Jenkins tab on a component.
The cards
| Key | What it shows |
|---|---|
| Builds | The builds of the Jenkins job of each component of the catalog, with their status and date |
| Detailed Builds | The same builds, with their duration and the stages of each build |
Both cards list every component of the catalog that carries the jenkins.io/job-full-name
annotation, whoever owns it. A component without the annotation does not appear. Both cards show five
rows at a time, with the most recent build of each job first.
To keep only your components, filter the column Mine (Mine or Others) and save the filter with the card: see Keep only your rows.
A card with builds in it was not checked on a live instance: no Jenkins was connected.
The columns
| Column | What it says | Cards |
|---|---|---|
| Resource | The full name of the Jenkins job, for example catalog-api or shop/shop-api | Both |
| Title | The build, for example catalog-api #3 on Builds, and the name of the job on Detailed Builds | Both |
| Key | The number of the build, for example #3 | Both |
| Owner | The owner of the component | Both |
| Mine | Mine when the component is yours (you or one of your groups own it), Others otherwise | Both |
| Status | success, failed or another word of Jenkins in a coloured badge | Both |
| Date | The day of the build | Both |
| Duration | How long the build took | Detailed Builds |
| Stages | The stages of the build, each with its status | Detailed Builds |
| Last column | A link that opens the build in Jenkins | Both |
A job in a folder shows with its whole path in Resource, for example shop/shop-api. A job that is
not a pipeline has no stages: the build is on both cards, and Stages shows -.
➕ Add a card
-
In the left sidebar, click My Dashboards, then the tab of the dashboard you want.
-
Click Add a card, at the top of the page.
-
In Add a card, pick Source
jenkins, then a Key: Builds or Detailed Builds. The description under the key tells what the card shows. -
Enter a Card Name, then click Add.
The card fills in a few seconds.
✅ That's it!
What the cards say when something is wrong
| What the card says | What it means |
|---|---|
| Nothing here yet and "No build to show: no component of the catalog has a jenkins.io/job-full-name annotation, or its job has no build yet." | No component of the catalog has a jenkins.io/job-full-name annotation, or its job has no build yet |
| Jenkins refused the token. and "The token may have expired or been revoked: replace it in Administration › Company connections › Jenkins (or in My account › My accounts if it is your own)." | Jenkins no longer accepts the token of the integration. The button Open the Jenkins integration takes you to the screen where it is replaced. See Common problems with Jenkins. |
| Jenkins refuses the connection. and "Check the host and port in Administration › Company connections › Jenkins, and that the service runs." | Astrolabe cannot reach Jenkins. The button Open the Jenkins integration opens the integration. |
| Jenkins does not know what is asked. and "Check the name in the component's annotation, and that the token may see it." | Jenkins knows none of the jobs written in your components. Check the names. See Common problems with Jenkins. |
A job Jenkins does not know is left out while the others still show.
Notifications
This step was not checked on a live instance. You choose what you receive in My Account › Notifications.
Next: Jenkins FAQ.