Internal CI Jenkins

Note: CI is only internally accessible. It is not possible, at this time, to access build information externally.

Brief

ASC has a Jenkins CI server that runs in a local kubernetes cloud. All of the CI builds are executed inside of docker containers. As of 5.13.19, the CI is running internally, but is not being triggered from Github or pushing build results back to Github.

Accessing the CI

The CI server run at https://jenkins-dev.wr.usgs.gov. It can take a minute or so for the server to respond the first time it is accessed. The server login is the standard login that is used for all internal accounts.

The CI project that stores ISIS3 is called docker-testing.

CI Jobs

ISIS3 CI is broken into X different processing steps for each operating system:

1. The Jenkins manager launches one or more build containers that are isolated environments.
2. The kernel makes a shallow checkout (-depth=50) of the Github repository
3. The environment.yml file that is in the ISIS3 repository is used to create an environment that is used for the build and testing.
4. ISIS3 is built. (This takes ~20 minutes with -j4. The machines have 4 CPUs.)
5. ISIS3 tests are executed.

Containers

The build containers are all stored on GitHub in the jenkins. The /workers/isisdeps/<os> directories contain the Dockerfile associated with each operating system. As of 5.13.19, the Ubuntu containers is functioning as desired.

Updating containers

When a container should be updated, we can simply push/merge the change to the jenkins repository. A web hook has already been set up to have the pushed changes built on Docker Hub. The CI will pull the newest version of the container that is available on Docker Hub at the start of each build.

As of 5.16.19: The jenkins repository has been restructured so that each container is located within its own branch. This allows containers to be built individually only when they are modified, rather than all containers being rebuilt when any of them are modified.

Data directories

The containers all mount the standard path to the ISIS3 test data area. The ISISROOT is set to the current build directory inside of the checked out repo.

Webhook

New Jenkins URL: https://astroservices.usgs.gov/jenkins/ The webhook is now working on the new publicly accessible Jenkins server. This updates on pull requests and on push to ISIS branches that are specified.

Multibranch Instructions

Setup Branches:

1. Copy the Jenkinsfile and build.groovy files into your branch from https://github.com/DOI-USGS/ISIS3/tree/jenkins and push them, these are both required as Jenkins uses them both.

2. Navigate to https://astroservices.usgs.gov/jenkins/job/DOI-USGS/configure and login. Once you are here: Include your branch in builds

• Navigate to "Projects" box
• In the "Behaviors" section find the section "Filter by name (with wildcards)"
• In the text box enter your branch at the end (it is space separated)
• Done!

Include your branch in webhook

• Navigate to "Automatic branch project triggering" box
• In the "Branch names to build automatically" section
• Enter your branch into this box which is seperated by vertical bars (ex. branch1|branch2)
• You are now configured with the webhook.

2. Navigate to each of the OS Jenkins Configurations:
   • https://astroservices.usgs.gov/jenkins/job/ISIS-Builds/job/CentOS/configure
   • https://astroservices.usgs.gov/jenkins/job/ISIS-Builds/job/Fedora/configure
   • https://astroservices.usgs.gov/jenkins/job/ISIS-Builds/job/Ubuntu/configure
   • For each OS:
     1. Navigate to the Pipeline sections
     2. Find "Branches to build"
     3. Click the button "Add Branch"
     4. In the new Branch Specifier Box, enter the name of your branch
     5. You are all set to run jobs!

NOTE: We can have this done automatically in the future, with any branch that has a Jenkinsfile in it, but as of now every branch has a Jenkinsfile, so therefore it will trigger every branch.

The flow for the multibranch is as follows:

1. When you build from https://astroservices.usgs.gov/jenkins/job/DOI-USGS/job/ISIS3/ this will spawn three parallel jobs one for each OS currently: centOS, Fedora, and Ubuntu. Pushing or PR should trigger this automatically.

2. You can then check the status of each individual OS build at: https://astroservices.usgs.gov/jenkins/job/ISIS-Builds/

3. On these builds it uses the 'build.groovy' script so to make changes, you must make changes to that script.