edit | blame | history | raw

An Enslaved Hope

In this exercise we'll break free from the chains of point'n'click Jenkins by introducing pipeline as code in the form of Jenkinsfile. Following this we will introduce some new Jenkins slaves that will be used in later labs.

There are a number of ways pipeline as code can be achieved in Jenkins.
* The Job DSL Plugin - this is a slightly older but very functional DSL mechanism to create reusable pipelines. Create a groovy file to run Jenkins Domain Specific Language to create jobs, functions and other items. In Jenkins; you then can execute this file which will build all of the config.xml files needed for each Job.
* The Scripted Pipeline - The scripted pipeline introduced the Jenkinsfile and the ability for developers to write their jenkins setup as groovy code. A repo with a Jenkinsfile in it's root can be pointed to by Jenkins and it will automatically build out each of the stages described within. The scripted pipeline is ultimately Groovy at it's core.
* The Declarative Pipeline - This approach looks to simplify and opinionate what you can do and when you can do it in a pipeline. It does this by giving you top level block which define sections, directives and steps. The declarative syntax is not run as groovy but you can execute groovy inside script blocks. The advantage of it over scripted is validation of the config and lighter approach with requirement to understand all of the groovy syntax

Learning Outcomes

As a learner you will be able to
- Use a Jenkinsfile to create a declarative pipeline to build, bake and deploy the Todolist App
- Identify the differences between scripted, declarative and DSL pipelines
- Create Jenkins slave nodes for use in builds in future labs

Tools and Frameworks

Name of tool - short description and link to docs or website

Pipeline - Overview of the Jenkinsfile approach
Pipeline Syntax - Documentation for the declarative pipeline
Groovy - Groovy is a powerful, optionally typed and dynamic language, with static-typing and static compilation capabilities, for the Java platform aimed at improving developer productivity thanks to a concise, familiar and easy to learn syntax. It integrates smoothly with any Java program, and immediately delivers to your application powerful features, including scripting capabilities, Domain-Specific Language authoring, runtime and compile-time meta-programming and functional programming.

Big Picture

This exercise begins cluster containing blah blah

10,000 Ft View

The goal of this exercise is to move to using the Jenkinsfile in the todolist-api and todolist-fe projects. Additionally we will create new slaves for use in the next lab

On Jenkins; create a multibranch pipeline project to scan the GitLab endpoint for each app. Use the Jenkinsfile provided to run the stages. Replace the <YOUR_NAME> with appropriate variable.
Create two new Jenkins slaves for the OWASP ZAP scanner and the Arachni WebCrawler

Step by Step Instructions

This is a fairly structured guide with references to exact filenames and sections of text to be added.

Part 1 - The Jenkinsfile

In this exercise we'll replace the Pipeline we created in Lab 2 with a Jenkinsfile approach

On your terminal navigate to your todolist-api project and checkout the pipeline feature branch that's been already created for you.
bash $ git checkout feature/jenkinsfile
Open up your todolist-api application in your favourite editor and move to the Jenkinsfile in the root of the project. The highlevel structure of the file is shown collapsed below.

Some of the key things to note:
- pipeline {} is how all declarative jenkins pipelines begin.
- environment {} defines environment varibales to be used across all build stages
- options {} contains specific Job specs you want to run globally across the jobs eg setting the terminal colour
- stage {} all jobs must have one stage. This is the logical part of the build that will be executed eg bake-image
- steps {} each stage has one or more steps involved. These could be execute shell or git checkout etc.
- agent {} specifies the node the build should be run on eg jenkins-slave-npm
- post {} hook is used to specify the post-build-actions. Jenkins declarative provides very useful callbacks for success, failure and always which are useful for controlling the job flow
- when {} is used for flow control. It can be used at stage level and be used to stop pipeline entering that stage. eg when branch is master; deploy to test environment.
The Jenkinsfile is mostly complete to do all the testing etc that was done in previous labs. Some minor changes will be needed to orchestrate namespaces. Find and replace all instances of <YOUR_NAME> in the Jenkinsfile and update the GITLAB_DOMAIN accordingly.
```groovy
environment {
// GLobal Vars
PIPELINES_NAMESPACE = "-ci-cd"
APP_NAME = "todolist-api"
```
JENKINS_TAG = "${JOB_NAME}.${BUILD_NUMBER}".replace("/", "-")
JOB_NAME = "${JOB_NAME}".replace("/", "-")

GIT_SSL_NO_VERIFY = true
GIT_CREDENTIALS = credentials('jenkins-git-creds')
GITLAB_DOMAIN = "gitlab-<YOUR_NAME>-ci-cd.apps.somedomain.com"
GITLAB_PROJECT = "<YOUR_NAME>"
```
}
```
With these changes in place, push your changes to the feature/jenkinsfile branch.
bash $ git add Jenkinsfile $ git commit -m "ADD - namespace and git repo to pipeline" $ git push
When the changes have been successfully pushed; Open Jenkins.
Create a New Item on Jenkins. Give it the name todolist-api and select Multibranch Pipeline from the bottom of the list as the job type.
On the job's configure page; set the Branch Sources to git
Fill in the Git settings with your todolist-api project url and setting the credentials
Set the Scan Multibranch Pipeline Triggers to be periodical and the internal to 1 minute. This will poll the gitlab instance for new branches or change sets to build.
Save the Job configuration to run the intial scan. The log will show scans for master and develop branch which have no Jenkinsfile so are skipped. The resulting view will show the feature/jenkisifle job corresponding the only branch that currently has one. The build should run automatically.
The pipeline file is setup to only run bake & deploy stages when on master or develop branch. This is to provide us with very fast feedback for team members working on feature or bug fix branches. Each time someone commits or creates a new branch a basic build with testing occurs to give very rapid feedback to the team. Let's now update our branches to include the Jenkinsfile and delete the feature branch.
bash $ git checkout develop $ git merge feature/jenkinsfile $ git checkout master $ git merge develop $ git push -u origin --all # this is to delete the branch from the remote $ git push origin :feature/jenkinsfile
Back on Jenkins we should see our todolist-api pipelines have changed with the develop and master now appearing. The feature was deleted so this job should have gone away.
With the builds running for develop and master we can explore the Blue Ocean View for Jenkins. On the Job overview page, hit the Open Blue Ocean
button on the side to see what modern Jenkins looks like.
We can move on to the todolist-fe job. The process is the same as before, checkout the feature branch
bash $ cd todolist-fe $ git checkout feature/jenkinsfile
Open up your todolist-fe application in your favourite editor and move to the Jenkinsfile in the root of the project. Update all <YOUR_NAME> and GITLAB_DOMAIN references accordingly.
Commit your changes to your feature branch as you did previously.
bash $ git add Jenkinsfile $ git commit -m "ADD - namespace and git repo to pipeline" $ git push
This time update your master and develop branches before creating config in Jenkins
git checkout develop git merge feature/jenkinsfile git checkout master git merge develop git push -u origin --all
On Jenkins; create a new Multibranch Pipeline job called todolist-fe.
Add the todolist-fe git repository and set the credentials for git accordingly.
Set the trigger to scan every minute as done previously. Save the configuration and we should see the collection of Jobs as shown below.
Run the jobs and validate the app is working as expected in the test environment!

Part 2 - Security Scanning Slaves

This exercise focuses on updating the enablement-ci-cd repo with some new jenkins-slave pods for use in future exercise

Part 2a - OWASP ZAP

OWASP ZAP (Zed Attack Proxy) is a free open source security tool used for finding security vulnerabilities in web applications.

First we're going to take the generic jenkins slave template from our exercise4/zap branch and the params.
bash $ git checkout exercise4/zap-and-arachni params/ templates/jenkins-slave-generic-template.yml
This should have created the following files:
- templates/jenkins-slave-generic-template.yml
- params/ zap-build-pod arachni-build-pod
Create an object in inventory/host_vars/ci-cd-tooling.yml called zap-build-pod and add the following content:
```yaml
- name: "zap-build-pod"
  namespace: "-ci-cd"
  template: "{{ inventory_dir }}/../templates/jenkins-slave-generic-template.yml"
  params: "{{ inventory_dir }}/../params/zap-build-pod"
  tags:
  - zap
    <p class="tip"> NOTE- Install your Openshift Applier dependency if it's disappeared. bash
    ansible-galaxy install -r requirements.yml --roles-path=roles
```
Remember to login to the cluster!
bash oc login https://console.your.domain.com --token=<INSERT_LOGIN_TOKEN_HERE>
Run the ansible playbook filtering with tag zap so only the zap build pods are run.
bash ansible-playbook roles/openshift-applier/playbooks/openshift-cluster-seed.yml \ -i inventory/ \ -e "filter_tags=zap"
Head to (https://console.s8.core.rht-labs.com/console/project/-ci-cd/browse/builds) on Openshift and you should see zap-build-pod.
include screenshot here.

Part 2b - Arachni Scan

Arachni is a feature-full, modular, high-performance Ruby framework aimed towards helping penetration testers and administrators evaluate the security of web applications.

Create an object in inventory/host_vars/ci-cd-tooling.yml called arachni-build-pod with the following content:
```yaml
- name: "arachni-build-pod"
  namespace: "-ci-cd"
  template: "{{ inventory_dir }}/../templates/jenkins-slave-generic-template.yml"
  params: "{{ inventory_dir }}/../params/arachni-build-pod"
  tags:
  - arachni
```
Run the ansible playbook filtering with tag arachni so only the arachni build pods are run.
bash ansible-playbook roles/openshift-applier/playbooks/openshift-cluster-seed.yml \ -i inventory/ \ -e "filter_tags=arachni"
Head to (https://console.s8.core.rht-labs.com/console/project/-ci-cd/browse/builds) on Openshift and you should see arachni-build-pod.

Extension Tasks

Ideas for go-getters. Advanced topic for doers to get on with if they finish early. These will usually not have a solution and are provided for additional scope.

OpenShift Sync plugin
- Use the Jenkinsfile provided to create a pipeline that runs in OpenShift's pipeline ie using it as the BuildConfig.

Jenkins S2I
- Add the multi-branch configuration to the S2I to have Jenkins come alive with the todolist-api and -fe configuration cooked into it for future uses.

Jenkins Pipeline Extension
- Add an extension to the pipeline that promotes code to UAT environment once the master job has been successful.
- Use a WAIT to allow for manual input to appove the promotion

Jenkins e2e extension (blue/green)
- Add a step in the pipeline to only deploy to the test environment if the e2e tests have run successfully against which ever environemnt (blue or green) is not deployed.

Additional Reading

List of links or other reading that might be of use / reference for the exercise

Slide links

link back to the deck for the supporting material