contra-hdsl

Archived

This repo is no longer actively maintained / updated.

Summary

This repo contains a Jenkins shared library, referred to as the Contra HDSL, which provides global variables representing a set of CI/CD primatives. These global variables are intended to simplify the creation of Jenkinsfiles. Additionally, the underlying methods in the shared library can be imported and used on an ad hoc basis in the creation of more complex Jenkinsfiles or in the creation of other libraries or global variables.

Requirements

• Usage of shared libraries requires Jenkins 2.x. The Contra HDSL was written primarily against Jenkins 2.89.4
• Openshift 3.x. The Contra HDSL was written primarily against Openshift 3.6
• Some Contra HDSL global variables are executed inside of specific containers, inside of an Openshift pod.
  • The s2i templates for these containers are in the config/s2i/ansible and config/s2i/linchpin directories and need to be built on your Openshift instance prior to implementing the Contra HDSL.

Configuration

Please see https://contra-hdsl.readthedocs.io for the most up to date configuration instructions and Getting Started documentation.

OpenShift Configuration

Add Container Templates

The Contra HDSL makes use of three containers, linchpin-executor, ansible-executor, and jenkins-contra-slave. These containers must exist within OpenShift and can be added by performing the following steps:

• Checkout the contra-hdsl repo, if you haven't already: $ git clone https://github.com/openshift/contra-hdsl.git
• Login to your OpenShift instance: $ oc login
• Select your project namespace: $ oc project <your project namespace>
• Change to the root of the contra-hdsl repo: $ cd /path/to/contra-hdsl
• Add the linchpin-executor buildconfig template: $ oc create -f config/s2i/linchpin/linchpin-buildconfig-template.yaml
• Add the ansible-executor buildconfig template: $ oc create -f config/s2i/ansible/ansible-buildconfig-template.yaml
• Add the jenkins-contra-slave buildconfig template: $ oc create -f config/s2i/jslave/jslave-buildconfig-template.yaml

Create Container Imagestreams

The Contra HDSL requires that the necessary container imagestreams exist.

• Deploy the linchpin-executor imagestream: $ oc new-app linchpin-executor
• Create the ansible-executor imagestream: $ oc new-app ansible-executor
• Create the jenkins-contra-slave imagestream: $ oc new-app jenkins-contra-slave-builder

Tag Container Imagestreams

The Contra HDSL expects that the necessary container imagestreams should be tagged as "stable" by default, although this can be overridden.

• Tag the linchpin-executor imagestream: $ oc tag <project namespace>/ansible-executor:latest <project namespace>/ansible-executor:stable
• Tag the ansible-executor imagestream: $ oc tag <project namespace>/linchpin-executor:latest <project namespace>/linchpin-executor:stable
• Tag the jenkins-contra-slave imagestream: $ oc tag <project namespace>/jenkins-contra-slave:latest <project namespace>/jenkins-contra-slave:stable

Global Library Configuration

The Contra HDSL needs to be configured on the Jenkins master. The necessary steps are below.

• Click on Jenkins -> Manage Jenkins -> Configure System
• Scroll to Global Pipeline Libraries and click Add
• Provide a Name for the library (we use contraHDSL, but the name is arbitrary)
• For Default Version, enter master
• Ensure that Load Implicitly is checked.
• Under Retrieval Method select Modern SCM
• Under Source Code Management select Git
• In the Project Repository field, select https://github.com/openshift/contra-hdsl.git
• Click Save at the bottom of the page.

Credential configuration

Certain methods, such as deployInfra, configureInfra, and executeTests expect credentials and SSH keys to be configured on the Jenkins master to allow for communication with provider services and provisioned resources.

For each provider, (aws, openstack, beaker, etc.) the default behavior is that there should exist two credentials:

• <provider>.ssh
  • A private key SSH credential. A username is not required to be configured, as the user to use when connecting is specified in the yaml configuration file.
  • Example file name: openstack.ssh
• <provider>.creds
  • A secret file credential. This file should contain the necessary data to authenticate against the provider service.
  • Example file name: aws.creds

Usage

Usage in your project

The Contra HDSL makes use of a yaml format configuration file. This file should reside at the root of your workspace in Jenkins and can be stored in your project repository, or another repository, provided that it ultimately arrives at the root of your workspace.

The default name for this file is contra.yml, but any file name can be used. See the docs for further details on using non-default file names.

Links

• Contra HDSL Documentation:
  • https://contra-hdsl.readthedocs.io
• ContraDSL GitHub repository:
  • This repository contains the contraDSL shared library
  • https://github.com/openshift/contra-hdsl
• Contra HDSL sample repository:
  • This repo contains sample yaml configuration files, along with Jenkinsfile examples
  • https://github.com/robnester-rh/hdsl_sample

How to contribute to the Project

If you would like to submit a PR, please ensure you have a current version of the development branch and submit a PR targeted to it.

We typically merge to development and then cut periodic releases from that to master, we never do a merge direct to master.