view | history | commit | commitdiff
Rob Harris
2018-04-26 4836fea6ac27ec0fa38dc20ca36ffc88789590ad
commit | author | age
e36a5b 1 # An Enslaved Hope
43f2f2 2
dd12d4 3 > 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. 
e36a5b 4
D 5 There are a number of ways pipeline as code can be achieved in Jenkins.
6  * 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. 
dd12d4 7  * 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.
A 8  * 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
e36a5b 9
43f2f2 10 _____
D 11
12 ## Learning Outcomes
13 As a learner you will be able to
e36a5b 14 - Use a Jenkinsfile to create a declarative pipeline to build, bake and deploy the Todolist App 
D 15 - Identify the differences between scripted, declarative and DSL pipelines 
16 - Create Jenkins slave nodes for use in builds in future labs
43f2f2 17
D 18 ## Tools and Frameworks
19 > Name of tool - short description and link to docs or website
20
e36a5b 21 1. [Pipeline](https://jenkins.io/doc/book/pipeline/) - Overview of the Jenkinsfile approach
D 22 1. [Pipeline Syntax](https://jenkins.io/doc/book/pipeline/syntax/) - Documentation for the declarative pipeline
23 1. [Groovy](http://groovy-lang.org/) - 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.
b664dc 24 1. [Zed Attack Proxy](https://www.owasp.org/index.php/OWASP_Zed_Attack_Proxy_Project) - The OWASP Zed Attack Proxy (ZAP) is one of the world’s most popular free security tools and is actively maintained by hundreds of international volunteers*. It can help you automatically find security vulnerabilities in your web applications while you are developing and testing your applications. Its also a great tool for experienced pentesters to use for manual security testing.
D 25 1. [Arachni Crawler](http://www.arachni-scanner.com/) - Arachni is a feature-full, modular, high-performance Ruby framework aimed towards helping penetration testers and administrators evaluate the security of modern web applications. It is free, with its source code public and available for review. It is versatile enough to cover a great deal of use cases, ranging from a simple command line scanner utility, to a global high performance grid of scanners, to a Ruby library allowing for scripted audits, to a multi-user multi-scan web collaboration platform. In addition, its simple REST API makes integration a cinch.
43f2f2 26
D 27 ## Big Picture
28 This exercise begins cluster containing blah blah
29
30 _____
31
32 ## 10,000 Ft View
e36a5b 33 > 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
43f2f2 34
e36a5b 35 2. 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.
43f2f2 36
e36a5b 37 2. Create two new Jenkins slaves for the `OWASP ZAP` scanner and the `Arachni` WebCrawler
43f2f2 38
D 39 ## Step by Step Instructions
e36a5b 40 > This is a fairly structured guide with references to exact filenames and sections of text to be added. 
43f2f2 41
e36a5b 42 ### Part 1 - The Jenkinsfile
D 43 > _In this exercise we'll replace the Pipeline we created in Lab 2 with a Jenkinsfile approach_
43f2f2 44
e36a5b 45 2. On your terminal navigate to your `todolist-api` project and checkout the pipeline feature branch that's been already created for you.
D 46 ```bash
47 $ git checkout feature/jenkinsfile
43f2f2 48 ```
D 49
e36a5b 50 2. 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. 
D 51 ![pipeline-overview](../images/exercise4/pipeline-overview.png)
52 Some of the key things to note:
53     * `pipeline {}` is how all declarative jenkins pipelines begin.
db509f 54     * `environment {}` defines environment variables to be used across all build stages
A 55     * `options {}` contains specific Job specs you want to run globally across the jobs e.g. setting the terminal colour
56     * `stage {}` all jobs must have one stage. This is the logical part of the build that will be executed e.g. `bake-image`
e36a5b 57     * `steps {}` each `stage` has one or more steps involved. These could be execute shell or git checkout etc.
D 58     * `agent {}` specifies the node the build should be run on eg `jenkins-slave-npm`
59     * `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
60     * `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.
61
70ba2a 62 2. 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. Update the `<GIT_USERNAME>` to the one you login to the cluster with; this variable is used in the namespace of your git projects when checking out code etc. Ensure the `GITLAB_DOMAIN` matches your git host.
e36a5b 63 ```groovy
D 64     environment {
65         // GLobal Vars
dd12d4 66         PIPELINES_NAMESPACE = "<YOUR_NAME>-ci-cd"
e36a5b 67         APP_NAME = "todolist-api"
D 68
69         JENKINS_TAG = "${JOB_NAME}.${BUILD_NUMBER}".replace("/", "-")
70         JOB_NAME = "${JOB_NAME}".replace("/", "-")
71
72         GIT_SSL_NO_VERIFY = true
73         GIT_CREDENTIALS = credentials('jenkins-git-creds')
70ba2a 74         GITLAB_DOMAIN = "gitlab.apps.lader.rht-labs.com"
D 75         GITLAB_PROJECT = "<GIT_USERNAME>"
e36a5b 76     }
D 77 ```
78
79 2. With these changes in place, push your changes to the `feature/jenkinsfile` branch.
80 ```bash
81 $ git add Jenkinsfile
82 $ git commit -m "ADD - namespace and git repo to pipeline"
83 $ git push
84 ```
85
86 2. When the changes have been successfully pushed; Open Jenkins.
87
88 2. 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.
89 ![multibranch-select](../images/exercise4/multibranch-select.png)
90
91 2. On the job's configure page; set the Branch Sources to `git`
92 ![multibranch-select-git](../images/exercise4/multibranch-select-git.png)
93
44d41c 94 2. Fill in the Git settings with your `todolist-api` GitLab url and set the credentials as you've done before. `https://gitlab.apps.<SOMEDOMAIN>.com/<YOUR_NAME>/todolist-api.git`
e36a5b 95 ![multibranch-git](../images/exercise4/multibranch-git.png)
D 96
44d41c 97 2. Set the `Scan Multibranch Pipeline Triggers` to be periodic and the interval to 1 minute. This will poll the gitlab instance for new branches or change sets to build.
e36a5b 98 ![multibranch-scan-time](../images/exercise4/multibranch-scan-time.png)
D 99
2ff842 100 2. 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/jenkinsfile` job corresponding the only branch that currently has one. The build should run automatically. 
e36a5b 101 ![todolist-api-multi](../images/exercise4/todolist-api-multi.png)
D 102
ed472a 103 2. 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  `master` and `develop` branches to include the Jenkinsfile and delete the feature branch.
e36a5b 104 ```bash
D 105 $ git checkout develop
106 $ git merge feature/jenkinsfile
ed472a 107 # you may get merge conflicts at this point
D 108 $ git add .
109 $ git commit -m "Jenkinsfile updates"
e36a5b 110 $ git checkout master
D 111 $ git merge develop
112 $ git push -u origin --all
113 # this is to delete the branch from the remote
114 $ git push origin :feature/jenkinsfile
115 ```
116
117 2. 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.
118 ![todolist-api-multi-dev-test](../images/exercise4/todolist-api-multi-dev-test.png)
119
120 2. 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 ![open-blue-ocean](../images/exercise4/open-blue-ocean.png)
121  button on the side to see what modern Jenkins looks like.
122 ![blue-ocean-todolist-api](../images/exercise4/blue-ocean-todolist-api.png)
123
124 2.  We can move on to the `todolist-fe` job. The process is the same as before, checkout the feature branch
125 ```bash
126 $ cd todolist-fe
127 $ git checkout feature/jenkinsfile
128 ```
129
ed472a 130 2. 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 `<GIT_USERNAME>` as you did before, including in the prepare environment steps. Check the  `GITLAB_DOMAIN` is set too. 
D 131 ![jenkinsfile-prep](../images/exercise4/jenkinsfile-prep.png)
e36a5b 132
D 133 2. Commit your changes to your feature branch as you did previously. 
134 ```bash
135 $ git add Jenkinsfile
136 $ git commit -m "ADD - namespace and git repo to pipeline"
137 $ git push
138 ```
139
140 2. This time update your master and develop branches before creating config in Jenkins
141 ```
ed472a 142 $ git checkout develop
D 143 $ git merge feature/jenkinsfile
144 # you may get merge conflicts at this point
145 $ git add .
146 $ git commit -m "Jenkinsfile updates"
147 $ git checkout master
148 $ git merge develop
149 # this is to delete the branch from the remote
150 $ git push origin :feature/jenkinsfile
151 $ git push -u origin --all
e36a5b 152 ```
D 153
154 2. On Jenkins; create a new `Multibranch Pipeline` job called `todolist-fe`.
155
156 2. Add the `todolist-fe` git repository and set the credentials for git accordingly. 
157
158 2. Set the trigger to scan every minute as done previously. Save the configuration and we should see the collection of Jobs as shown below.
159 ![todolist-fe-multi](../images/exercise4/todolist-fe-multi.png)
160
6769e3 161 2. Run the jobs and validate the app is working as expected in the `test` environment!
ed472a 162 ![todolist-test](../images/exercise4/todolist-test.png)
34fb36 163
D 164 ### Part 2 - OCP Pipeline
165 > _This exercise adds a new BuildConfig to our cluster for the todolist-apps to run their pipelines in OpenShift using the OpenShift Jenkins Sync Plugin. We will use the OpenShift Applier to create the content in the cluster_
166
b2ce13 167 2. Open the `todolist-fe` app in your favourite editor. Move to the `.openshift-applier` directory. Explore the `template/ocp-pipeline`. This template creates a BuildConfig for OpenShift with a Jenkinsfile from a given repo. In this case; it will be the `Jenkinsfile` at the root of our application.
34fb36 168
D 169 2. Open the `params/ocp-pipeline` file and update `PIPELINE_SOURCE_REPOSITORY_URL` with the git url of your project (Don't forget to add the `.git` at the end). For example:
170 ```
70ba2a 171 PIPELINE_SOURCE_REPOSITORY_URL=https://gitlab.apps.lader.rht-labs.com/<GIT_USERNAME>/todolist-fe.git
34fb36 172 PIPELINE_SOURCE_REPOSITORY_REF=develop
D 173 NAME=todolist-fe
174 ```
175
b2ce13 176 2. Create a new object in `inventory/group_vars/all.yml` to drive the `ocp-pipeline` template with the parameters file you've just created. It can be put under the existing `todolist-fe-build` object.
34fb36 177 ```yaml
D 178   - name: todolist-ocp-pipeline
179     template: "{{ playbook_dir }}/templates/ocp-pipeline.yml"
180     params: "{{ playbook_dir }}/params/ocp-pipeline"
181     namespace: "{{ ci_cd_namespace }}"
182     tags:
183     - pipeline
184 ```
185 ![ocp-pipeline-applier](../images/exercise4/ocp-pipeline-applier.png)
186
187 2. Use the OpenShift Applier to create the cluster content 
188 ```bash
189 $ cd .openshift-applier
190 $ ansible-playbook apply.yml -i inventory/ \
191      -e "filter_tags=pipeline"
192 ```
193
d4f1fa 194 2. With these changes in place, commit your changes to GitLab
D 195 ```bash
196 $ git add .
197 $ git commit -m "ADD - ocp pipeline in git repo"
198 $ git push
199 ```
200
34fb36 201 2. Login to your OpenShift Cluster and go to the `<YOUR_NAME>-ci-cd` namespace. On the side menu; hit Builds > Pipeline to see your newly created pipeline running in OCP Land.
D 202 ![ocp-pipeline-view](../images/exercise4/ocp-pipeline-view.png)
203
204 2. Running the pipeline from here will run it in Jenkins. You can see the job sync between OpenShift and Jenkins if you login to Jenkins. You should see a folder with `<YOUR_NAME>-ci-cd` and your pipeline jobs inside of it.
205 ![ocp-pipeline-jenkins](../images/exercise4/ocp-pipeline-jenkins.png)
206
207 2. With the configuration in place for the `todolist-fe`; repeat the process for the `todolist-api`. Update the `todolist-api/.openshift-applier/inventory/group_vars/all.yml` with a new object to drive the params and template
208 ```yaml
d4f1fa 209   - name: todolist-ocp-pipeline
34fb36 210     template: "{{ playbook_dir }}/templates/ocp-pipeline.yml"
D 211     params: "{{ playbook_dir }}/params/ocp-pipeline"
212     namespace: "{{ ci_cd_namespace }}"
213     tags:
214     - pipeline
215 ```
216
217 2. Update the `todolist-api/.openshift-applier/params/ocp-pipeline`
218 ```
70ba2a 219 PIPELINE_SOURCE_REPOSITORY_URL=https://gitlab.apps.lader.rht-labs.com/<GIT_USERNAME>/todolist-api.git
34fb36 220 PIPELINE_SOURCE_REPOSITORY_REF=develop
D 221 NAME=todolist-api
222 ```
223
224 2. Use the OpenShift Applier to create the cluster content 
225 ```bash
d4f1fa 226 $ cd todolist-api/.openshift-applier
34fb36 227 $ ansible-playbook apply.yml -i inventory/ \
D 228      -e "filter_tags=pipeline"
229 ```
230
231 2. Login to your OpenShift Cluster and go to the `<YOUR_NAME>-ci-cd` namespace. On the side menu; hit Builds > Pipeline to see your newly created pipeline running in OCP Land.
232 ![ocp-pipeline-view2](../images/exercise4/ocp-pipeline-view2.png)
233
d4f1fa 234 2. Commit your changes to GitLab
D 235 ```bash
236 $ git add .
237 $ git commit -m "ADD - ocp pipeline in git repo"
238 $ git push
239 ```
34fb36 240
D 241 ### Part 3 - Security Scanning Slaves
e36a5b 242 > _This exercise focuses on updating the `enablement-ci-cd` repo with some new jenkins-slave pods for use in future exercise_
43f2f2 243
d4f1fa 244 #### 3a - OWASP ZAP
6769e3 245 > _OWASP ZAP (Zed Attack Proxy) is a free open source security tool used for finding security vulnerabilities in web applications._
A 246
e32e5c 247 3. On your  terminal; move to the `enablement-ci-cd` repo. We already have the `templates/jenkins-slave-generic-template.yml` template we're going to re-use from the previous lab so all we need is to check out the params file
6769e3 248 ```bash
e32e5c 249 $ git checkout exercise4/zap-and-arachni params/jenkins-slave-zap
6769e3 250 ```
A 251
e32e5c 252 3. This should have created the following files which we will fill out. We will use a `ZAP` image hosted on the `rht-labs/ci-cd` repo so there will be no `Dockerfile` needed as we did with the `jenkins-slave-npm` in exercise 2:
D 253     - `params/jenkins-slave-zap`
6769e3 254
da9923 255 3. Create an object in `inventory/host_vars/ci-cd-tooling.yml` called `jenkins-slave-zap` and add the following content:
054490 256 ```yaml
da9923 257     - name: "jenkins-slave-zap"
b664dc 258       namespace: "{{ ci_cd_namespace }}"
D 259       template: "{{ playbook_dir }}/templates/jenkins-slave-generic-template.yml"
da9923 260       params: "{{ playbook_dir }}/params/jenkins-slave-zap"
b664dc 261       tags:
D 262       - zap
6769e3 263 ```
2c15b7 264 ![zap-object](../images/exercise4/zap-object.png)
6769e3 265
A 266 3. Run the ansible playbook filtering with tag `zap` so only the zap build pods are run.
267 ```bash
b664dc 268 $ ansible-playbook apply.yml -e target=tools \
D 269      -i inventory/ \
270      -e "filter_tags=zap"
6769e3 271 ```
A 272
da9923 273 3. Head to (https://console.somedomain.com/console/project/<YOUR_NAME>-ci-cd/browse/builds) on Openshift and you should see `jenkins-slave-zap`.
e32e5c 274 ![zap-build](../images/exercise4/zap-build.png)
6769e3 275
d4f1fa 276 #### 3b - Arachni Scan
6769e3 277 > _Arachni is a feature-full, modular, high-performance Ruby framework aimed towards helping penetration testers and administrators evaluate the security of web applications._
e32e5c 278
D 279 3. On your terminal; checkout the params and Docker file. The Dockerfile for the `Arachni` scanner is included here and we will point the build to it. 
280 ```bash
281 $ git checkout exercise4/zap-and-arachni params/jenkins-slave-arachni docker/jenkins-slave-arachni 
282 ```
6769e3 283
da9923 284 3. Create an object in `inventory/host_vars/ci-cd-tooling.yml` called `jenkins-slave-arachni` with the following content:
054490 285 ```yaml
da9923 286     - name: "jenkins-slave-arachni"
b664dc 287       namespace: "{{ ci_cd_namespace }}"
D 288       template: "{{ playbook_dir }}/templates/jenkins-slave-generic-template.yml"
da9923 289       params: "{{ playbook_dir }}/params/jenkins-slave-arachni"
b664dc 290       tags:
D 291       - arachni
6769e3 292 ```
A 293
2ff842 294 3. Update the `jenkins-slave-arachni` files `SOURCE_REPOSITORY_URL` to point to your gitlab's hosted version of the `enablement-ci-cd` repo.
e32e5c 295 ```
D 296 SOURCE_REPOSITORY_URL=https://gitlab.apps.lader.rht-labs.com/<GIT_USERNAME>/enablement-ci-cd.git
297 SOURCE_CONTEXT_DIR=docker/jenkins-slave-arachni
298 BUILDER_IMAGE_NAME=registry.access.redhat.com/openshift3/jenkins-slave-base-rhel7:latest
299 NAME=jenkins-slave-arachni
300 SOURCE_REPOSITORY_REF=master
301 ```
302
303 3. With these changes in place, push your changes to the `master` branch.
304 ```bash
305 $ git add .
306 $ git commit -m "ADD - Arachni scanning image"
307 $ git push
308 ```
309
fd433b 310 3. Run the ansible playbook filtering with tag `arachni` so only the arachni build pods are run.
6769e3 311 ```bash
b664dc 312 $ ansible-playbook apply.yml -e target=tools \
D 313      -i inventory/ \
314      -e "filter_tags=arachni"
6769e3 315 ```
A 316
da9923 317 3. Head to (https://console.somedomain.com/console/project/<YOUR_NAME>-ci-cd/browse/builds) on Openshift and you should see `jenkins-slave-arachni`.
054490 318 ![todolist-fe-multi](../images/exercise4/builds-zap-arachni.png)
43f2f2 319
D 320 _____
321
322 ## Extension Tasks
323 > _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._
e36a5b 324
D 325 Jenkins S2I
326  - 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.
327
d608d6 328 Jenkins Pipeline Extension
D 329  - Add an extension to the pipeline that promotes code to UAT environment once the master job has been successful. 
330  - Use a WAIT to allow for manual input to appove the promotion
331
332 Jenkins e2e extension (blue/green)
db509f 333  - Add a step in the pipeline to only deploy to the `test` environment if the e2e tests have run successfully against which ever environment (blue or green) is not deployed.
43f2f2 334
D 335 ## Additional Reading
336 > List of links or other reading that might be of use / reference for the exercise
337
01c4da 338 ## Slide Links
RH 339
340 - [Intro](https://docs.google.com/presentation/d/1B3Fv4g66zZ8ZkqBq9TYmImJhUDvMecXCt4q3DXGWhjc/)
341 - [Wrap-up](https://docs.google.com/presentation/d/1EOk6y798Xh1hsaQlxRuqyr23FIIf7sNY4any_yXIL7A/)
342 - [All Material](https://drive.google.com/drive/folders/1oCjpl33Db7aPocmpu3NNF0B9czRvFq3m)