Skip to main content

Add the Jenkins integration

The integration gives Astrolabe the address of your Jenkins, its user and its token. You do it once, as an administrator. It is the only place where you enter Jenkins, and it also feeds the Jenkins cards of My Dashboards.

Before you start: a Jenkins user name and its API token, see Create a Jenkins API token.

How to​

1. Open the Jenkins integration​

  1. In the left sidebar, at the bottom, click Administration.
  2. Under PLATFORM, click Company connections.
  3. On the Jenkins card, click Configure.
  4. Top right, click Add Token.

2. Fill in the form​

FieldWhat to enterExample
NameA name of your choiceJenkins
Jenkins instance URLThe address of Jenkins, without https://jenkins.example.com
Jenkins userThe user of the tokenastrolabe
Jenkins tokenThe API token you created

3. Test and save​

  1. Click Test connection. The form says Connection works: the source accepted the credentials.
  2. Click Add. Astrolabe restarts on its own, in a few seconds.

The token is in the list, with State set to Connected.

✅ Done. Next: Show the Jenkins tab on a component.

You have several Jenkins​

Add one integration per Jenkins, and give each one an instance key.

  1. On the Jenkins card, click Manage, then Add Token for each Jenkins.
  2. In the form, open Optional settings and fill in Jenkins instance key with a short name: letters, digits, ., _ and -.
JenkinsNameJenkins instance key
ProductionJenkins prodprod
Other environmentsJenkins devdev

A component then picks its Jenkins in its annotation: see Show the Jenkins tab on a component.

The default Jenkins

A job name without an instance key is read from the integration whose instance key is default, otherwise from the first one in the list.

Replace a token​

When a token has expired or was revoked:

  1. On the Jenkins card, click Manage.
  2. On the line of the token, click Edit Token.
  3. Next to Jenkins token, click Replace, then paste the new token.
  4. Click Test connection, then Save. Astrolabe restarts on its own, in a few seconds.