RedHatTraining/rht-labs-docs.git

Rob Harris

2018-04-23 01c4da7a2011689d41eaaf26fabd62b6fb5fc3d3

commit \| author \| age
2b8436	1	# Attack of the Pipelines
c951f7	2
2b8436	3	> In this lab we will explore the sample TODO List application and create a pipeline in Jenkins to build and deploy our code.
D	4
	5	![jenkins-time](../images/exercise2/jenkins-time.jpg)
	6
43f2f2	7	_____
c951f7	8
D	9	## Learning Outcomes
2b8436	10	As a learner by the end of this lesson you will be able to
D	11
	12	- Build and run the full stack of the TODO List application locally
	13	- Create an un-gated pipeline using the Jenkins UI for the backend and frontend
	14	- Add branching to the pipeline to target specific namespace
c951f7	15
D	16	## Tools and Frameworks
2b8436	17	> The following tools are used throughout this exercise. Familiarity with them is not required but knowing what they are may help!
c951f7	18
D	19	1. [Jenkins](https://jenkins.io/) - OpenSource build automation server; highly customisable through plugins
2b8436	20	1. [NodeJS](https://nodejs.org/en/) - Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. Node.js uses an event-driven, non-blocking I/O model that makes it lightweight and efficient. Node.js' package ecosystem, npm, is the largest ecosystem of open source libraries in the world.
D	21	1. [MongoDB](https://www.mongodb.com/what-is-mongodb) - MongoDB stores data in flexible, JSON-like documents, meaning fields can vary from document to document and data structure can be changed over time
	22	1. [VueJS](https://vuejs.org/) - Vue (pronounced /vjuː/, like view) is a progressive framework for building user interfaces. It is designed from the ground up to be incrementally adoptable, and can easily scale between a library and a framework depending on different use cases. It consists of an approachable core library that focuses on the view layer only, and an ecosystem of supporting libraries that helps you tackle complexity in large Single-Page Applications.
c951f7	23
43f2f2	24	## Big Picture
2b8436	25	> From the previous exercise; we created some supporting tooling needed by our app/
43f2f2	26
D	27	_____
c951f7	28
D	29	## 10,000 Ft View
2b8436	30	> _This lab requires users to take the sample TODO app and create a build pipeline in Jenkins by clicking your way to success ending up with an app deployed to each of the namespaces created previously_
43f2f2	31
2b8436	32	2. Import the projects into your gitlab instance. See README of each for build instructions
43f2f2	33
2b8436	34	2. Deploy a `MongoDB` using the provided template to all project namespace.
D	35
	36	2. Create 2 pipline with three stages (`build`, `bake`, `deploy`) in jenkins for `develop` & `master` branches on the `todolist-fe` such that:
e919d0	37	* a `Build` job is responsible for compiling and packaging our code:
2b8436	38	1. Checkout from source code (`develop` for `<yourname>-dev` & `master` for `<yourname>-test`)
D	39	2. Install node dependencies and run a build / package
e919d0	40	3. Send the package to Nexus
D	41	4. Archive the workspace to persist the workspace in case of failure
	42	4. Tag the GitLab repository with the `${JOB_NAME}.${BUILD_NUMBER}` from Jenkins. This is our `${BUILD_TAG}` which will be used on downstream jobs.
	43	5. Trigger the `bake` job with the `${BUILD_TAG}` param
	44	* a `Bake` job should take the package and put it in a Linux Container
2b8436	45	1. Take an input of the previous jobs `${BUILD_TAG}` ie `${JOB_NAME}.${BUILD_NUMBER}`.
D	46	2. Checkout the binary from Nexus and unzip it's contents
e919d0	47	3. Run an oc start-build of the App's BuildConfig and tag it's imagestream with the provided `${BUILD_TAG}`
2b8436	48	4. Trigger a deploy job using the parameter `${BUILD_TAG}`
e919d0	49	* a `deploy` job should roll out the changes by updating the image tag in the DC:
2b8436	50	1. Take an input of the `${BUILD_TAG}`
D	51	2. Patch / set the DeploymentConfig to the image's `${BUILD_TAG}`
	52	3. Rollout the changes
	53	4. Verify the deployment
	54
	55	2. Repeat the above setup for the backend `todolist-fe`. TIP - use the copy config to speed things up!
	56
	57	2. Verify that both apps and the DB are talking to one another as expected.
c951f7	58
D	59	## Step by Step Instructions
7383de	60	> This is a fairly structured guide with references to exact filenames and sections of text to be added.
c951f7	61
f016b7	62	### Part 1 - Explore the Todo List App
7383de	63	> _In this part of the exercise we will explore the sample application, become familiar with it locally before building and deploying in OCP Land_
43f2f2	64
4c8010	65	#### Part 1a Todolist-fe
A	66
7383de	67	2. Git clone the `todolist-fe` project to somewhere sensible and checkout the `develop` branch.
D	68	```bash
4acca2	69	$ git clone https://github.com/rht-labs/todolist-fe.git
91cc51	70	$ cd todolist-fe
7383de	71	$ git checkout develop
4c8010	72	```
A	73	Followed by;
	74	```
	75	$ for branch in `git branch -a \| grep remotes \| grep -v HEAD \| grep -v master`; do
	76	git branch --track ${branch#remotes/origin/} $branch
	77	done
c951f7	78	```
7383de	79
10416f	80	2. Open up Gitlab and login. Create a new project (internal) in GitLab called `todolist-fe` to host your clone of the project and copy it's remote address. ![new-gitlab-proj](../images/exercise2/new-gitlab-proj.png)
7383de	81
D	82	2. In your local clone of the `todolist-fe`, remove the origin and add the GitLab origin by replacing `<YOUR_GIT_LAB_PROJECT>`. Push your app to GitLab
	83	```bash
10416f	84	$ git remote set-url origin <YOUR_GIT_LAB_PROJECT>
A	85	# verify the origin has been updated
	86	$ git remote -v
7383de	87	$ git push -u origin --all
c951f7	88	```
7383de	89
D	90	2. To get the app running locally; first check you've got node and npm installed
	91	```bash
	92	$ node -v
	93	$ npm -v
	94	```
	95	<p class="tip" >
	96	NOTE - If you are missing these dependencies; install them with ease using the [Node Version Manager](https://github.com/creationix/nvm)
	97	</p>
	98	![node-version](../images/exercise2/node-version.png)
	99
	100	2. The `todolist-fe` has a package.json at the root of the project, this defines some configuration for the app including it's dependencies, dev dependencies, scripts and other configuration. Install the apps dependencies
	101	```bash
	102	$ npm install
	103	```
	104
76d54e	105	2. The `todolist-fe` has some scripts defined in the package.json at the root of the project. To run any of these scripts run `npm run <SCRIPT_NAME>`. Let's start by serving our application
7383de	106	![npm-scripts](../images/exercise2/npm-scripts.png)
D	107	```bash
	108	npm run serve
	109	```
	110
10416f	111	2. This will take sometime to execute; but once done it should open the browser for you displaying the homepage of the `todolist-fe` app.
7383de	112	![todo-list-app](../images/exercise2/todo-list-app.png)
10416f	113	* Click 'Todo' at the top of the home page to get to the above page.
7383de	114	* The server hosting it live reloads; so as you make changes to your code; the app will live update
D	115	* The Data you see in the screen is dummy / stubbed data. This is served up when there is no backend connection found
	116
034b0f	117	2. The app is a todolist manager built in Vue.js. Play around with the App. You will notice when you add todos they appear and clear as expected. If you refresh the page you'll lose all additions. This is because there is persistence
7383de	118
D	119	3. The structure of the `todolist-fe` is as follows.
	120	```bash
	121	todolist-fe
	122	├── jest.config.js
	123	├── jsconfig.json
	124	├── nightwatch.config.js
	125	├── node_modules
	126	├── package.json
	127	├── public
	128	│ ├── favicon.ico
	129	│ ├── img
	130	│ ├── index.html
	131	│ └── manifest.json
	132	├── src
	133	│ ├── App.vue
	134	│ ├── assets
	135	│ ├── components
10416f	136	│ │ └── *
7383de	137	│ ├── config
D	138	│ ├── main.js
	139	│ ├── registerServiceWorker.js
	140	│ ├── router.js
	141	│ ├── scss
	142	│ ├── services
	143	│ ├── store
10416f	144	│ │ └── *
7383de	145	│ └── views
10416f	146	│ └── *
7383de	147	├── tests
D	148	│ ├── e2e
	149	│ └── unit
	150	└── vue.config.js
	151	```
	152	where the following are the important things:
	153	* `./src` is the main collection of files needed by the app. The entrypoint is the `main.js` which is used to load the root `App.vue` file.
	154	* `./node_modules` is where the dependencies are stored
	155	* `./test` contains our end-to-end tests and unit tests. More covered on these in later labs.
10416f	156	* `./src/components` contains small, lightweight reusable components for our app. For example, the `NewTodo` component which encapsulates the styling, logic and data for adding a new todo to our list
7383de	157	* `./src/store` is the `vuex` files for managing application state and backend connectivity
D	158	* `./src/views` is the view containers; which are responsible for loading components and managing their interactions.
	159	* the `./src/router.js` controls routing logic. In our case the app only has one real endpoint.
	160	* `./src/scss` contains custom SCSS used in the application.
	161	* `./*.js` is mostly config files for running and managing the app and the tests
c951f7	162
4c8010	163	2. To prepare Nexus to host the binaries created by the frontend and backend builds we need to run a prepare-nexus script. Before we do this we need to export some variables.
A	164	```bash
	165	export NEXUS_SERVICE_HOST=nexus-<YOUR_NAME>-ci-cd.apps.somedomain.com
	166	export NEXUS_SERVICE_PORT=80
	167	npm run prepare-nexus
	168	```
	169	<p class="tip">
	170	NOTE - This step in a residency would be automated by a more complex nexus deployment in the ci-cd project
	171	</p>
	172
	173	#### Part 1b Todolist-api
456daa	174
d2e708	175	2. Now let's move on to the `todolist-api` and wire them together. As with the `todolist-fe` we need to clone the repo and add it to our GitLab in the cluster.
D	176	```bash
4acca2	177	$ git clone https://github.com/rht-labs/todolist-api.git
10416f	178	$ git cd todolist-api
d2e708	179	$ git checkout develop
4c8010	180	```
A	181	Followed by;
	182	```
	183	$ for branch in `git branch -a \| grep remotes \| grep -v HEAD \| grep -v master`; do
	184	git branch --track ${branch#remotes/origin/} $branch
	185	done
d2e708	186	```
D	187
	188	2. Create a new project (internal) in GitLab called `todolist-api` to host your clone of the project and copy it's remote address.
	189
	190	2. In your local clone of the `todolist-api`, remove the origin and add the GitLab origin by replacing `<YOUR_GIT_LAB_PROJECT>`. Push your app to GitLab
	191	```bash
10416f	192	$ git remote set-url origin <YOUR_GIT_LAB_PROJECT>
d2e708	193	$ git push -u origin --all
D	194	```
	195
	196	2. Once pushed; explore the application. It is a NodeJS application with the Express.js framework and MongoDB for persistent storage. Same as before, the `package.json` defines most of the configuration etc. Install the dependencies
	197	```bash
10416f	198	# npm i === npm install
d2e708	199	$ npm i
D	200	```
	201
	202	2. While the dependencies are being installed; explore the project structure.
	203	```bash
	204	todolist-api
	205	├── Dockerfile
	206	├── Gruntfile.js
	207	├── README.md
	208	├── node_modules
	209	├── package-lock.json
	210	├── package.json
	211	├── server
	212	│ ├── api
	213	│ │ └── todo
	214	│ ├── app.js
	215	│ ├── components
	216	│ │ └── errors
	217	│ ├── config
	218	│ │ ├── environment
	219	│ │ ├── express.js
	220	│ │ ├── local.env.sample.js
	221	│ │ └── seed.js
	222	│ ├── mocks
	223	│ │ ├── mock-routes-config.json
	224	│ │ ├── mock-routes.js
	225	│ │ └── mock-routes.spec.js
	226	│ ├── routes.js
	227	│ └── views
	228	│ └── 404.html
	229	└── tasks
	230	└── perf-test.js
	231	```
	232	where the following are the important things:
	233	* `./server` is the main collection of files needed by the app. The entrypoint is the `app.js`
	234	* `./node_modules` is where the dependencies are stored
	235	* `./server/api` is where the api's controller, data model & unit test are stored.
	236	* `./server/mocks` is a mock server used for when there is no DB access
10416f	237	* `./server/config` stores our Express JS config, header information and other middleware.
A	238	* `./server/config/environment` stores enviromnent specific config; such as connectivity to backend services like MongoDB.
d2e708	239	* `./tasks` is a collection of additional `Grunt` tasks which will be used in later labs
10416f	240	* `Grunt` is a taskrunner for use with Node.JS projects
d2e708	241	* `package.json` contains the dependency list and a lot of very helpful scripts for managing the app lifecycle
D	242
	243	2. The npm scripts are shown below. There are application start scripts, build and test items which will be used in the build. The ones for MongoDB are just provided for convenience and require Docker installed to execute.
	244	```json
	245	"scripts": {
	246	"start": "node server/app.js",
	247	"dev": "./node_modules/.bin/grunt serve",
	248	"jshint": "./node_modules/.bin/grunt jshint",
	249	"jshint:ci": "./node_modules/.bin/grunt jshint:ci_server",
	250	"clean": "rm -rf reports package-contents*",
	251	"build": "mkdir -p package-contents && cp -vr server Dockerfile package.json package-contents",
	252	"package": "zip -r package-contents.zip package-contents",
	253	"test": "node_modules/.bin/nyc node_modules/.bin/mocha server/*/.spec.js --exit",
	254	"test:ci": "export MOCHA_FILE='reports/server/mocha/test-results.xml' && export NODE_ENV=ci && node_modules/.bin/nyc node_modules/.bin/mocha server/*/.spec.js -R mocha-junit-reporter --exit",
	255	"mongo" : "docker run -i -d --name mongo-local -p 27017:27017 mongo",
	256	"mongo:drop" : "npm run mongo:stop && docker rm mongo-local",
	257	"mongo:stop" : "docker stop mongo-local",
	258	"mongo:start" : "docker start mongo-local"
	259	},
456daa	260	```
A	261
d2e708	262
D	263	2. To run the application; start a new instance of the MongoDB by running.
	264	```bash
	265	$ npm run mongo
	266	```
	267	<p class="tip">
60ff08	268	NOTE - `npm run mongo:drop` is used to completely remove the running container. `npm run mongo:stop` & `npm run mongo:start` will preserve data in the container
d2e708	269	</p>
D	270
	271	2. Fire up the `todolist-api` by running.
	272	```bash
	273	$ npm run start
	274	```
	275	![node-app-started](../images/exercise2/node-app-started.png)
	276
10416f	277	2. Check things are up and running by testing the API with a `curl`. The API should return some seeded data (stored in `server/config/seed.js`)
d2e708	278	```bash
D	279	$ curl localhost:9000/api/todos
	280	```
	281	```json
	282	[{
	283	"_id": "5ac8ff1fdfafb02138698948",
	284	"title": "Learn some stuff about MongoDB",
	285	"completed": false,
	286	"__v": 0
	287	},
	288	{
	289	"_id": "5ac8ff1fdfafb02138698949",
	290	"title": "Play with NodeJS",
	291	"completed": true,
	292	"__v": 0
	293	}]
	294	```
	295
10416f	296	2. Now let's check out `todolist-fe` app by reloading the browser. We should now see our dummy front end data is replaced by the backend seed data. Adding new todos will add them in the backend, these will persist when the page is refreshed.
d2e708	297	![fullstack-app](../images/exercise2/fullstack-app.png)
D	298
	299
9fc88c	300	### Part 2 - Create a NodeJS Build slave
399baa	301	> _In this exercise; we will create a build configuration to generate a slave for Jenkins to use in it's builds_
9fc88c	302
399baa	303	3. In order for Jenkins to be able to run `npm` builds and installs as we have done locally, we must configure a `jenkins-build-slave` for Jenkins to use. This slave will be dynamically provisioned when we run a build. It needs to have NodeJS and npm installed in it. In your `enablement-cd-cd` repository, checkout the template and configuration. This will bring in the template, the params & the `Dockerfile`.
9fc88c	304	```bash
D	305	$ git checkout exercise2/jenkins-slave docker/ templates/ params/
	306	```
	307
	308	3. Open the `params/jenkins-slave-npm` file and update `<YOUR_ENABLEMENT_GIT_REPO>` accordingly. This set of parameters will clone from the enablement repo and run a docker build of the Dockerfile stored in `docker/jenkins-slave-npm`.
	309	```bash
	310	SOURCE_REPOSITORY_URL=<YOUR_ENABLEMENT_GIT_REPO>
	311	SOURCE_CONTEXT_DIR=docker/jenkins-slave-npm
	312	NAME=npm-jenkins-slave
	313	```
	314
06fc7b	315	3. Create an item in the `inventory/host_vars/ci-cd-tooling.yml` under the `ci-cd-builds` object to run the template with.
9fc88c	316	```yaml
D	317	- name: "jenkins-npm-slave"
06fc7b	318	namespace: "{{ ci_cd_namespace }}"
D	319	template: "{{ playbook_dir }}/templates/jenkins-slave-generic-template.yml"
	320	params: "{{ playbook_dir }}/params/jenkins-slave-npm"
9fc88c	321	tags:
D	322	- jenkins-slave
	323	```
	324	![jenkins-slave-ansible](../images/exercise2/jenkins-slave-ansible.png)
	325
	326	3. Run the OpenShift Applier to trigger a build of this jenkins slave image.
	327	```bash
06fc7b	328	$ ansible-playbook apply.yml -e target=tools \
9fc88c	329	-i inventory/ \
D	330	-e "filter_tags=jenkins-slave"
	331	```
	332
	333	3. Verify the build executed successfully by logging into the cluster and checking the `builds` tab of the `<YOUR_NAME>-ci-cd` project.
	334	![jenkins-slave-npm-build](../images/exercise2/jenkins-slave-npm-build.png)
	335
	336	3. You should now be able to apply the label `jenkins-slave-npm` to a build job to run a build on this newly created slave as we will see in the rest of this lab
	337	<p class="tip">
	338	NOTE - Jenkins may need to be restarted for the configuration to appear. To do this; navigate to your jenkins instance and add `/restart` to the url.
	339	</p>
	340
	341	### Part 3 - Add configs to cluster
f016b7	342	> _In this exercise; we will use the OpenShift Applier to drive the creation of cluster content required by the app such as MongoDB and the Apps Build / Deploy Config_
9fc88c	343
f016b7	344	4. On your terminal navigate to the root of the `todolist-fe` application. The app contains a hidden folder called `.openshift-applier`. Move `cd .openshift-applier` into this directory and you should see a familiar looking directory structure for an ansible playbook.
cdcafd	345	```
D	346	.openshift-applier
	347	├── README.md
	348	├── apply.yml
	349	├── inventory
	350	│ ├── group_vars
	351	│ │ └── all.yml
	352	│ └── hosts
	353	├── params
	354	│ ├── build
	355	│ ├── dev
	356	│ └── test
	357	├── requirements.yml
	358	└── templates
	359	├── todolist-api-build.yml
	360	└── todolist-api-deploy.yml
	361	```
	362	where the following
bc2216	363	* the `apply.yml` file is the entrypoint.
cdcafd	364	* the `inventory` contains the objects to populate the cluster with.
D	365	* the `params` contains the variables we'll apply to the `templates`
f016b7	366	* the `templates` required by the app. These include the Build, Deploy configs as well as the services, health checks, and other app definitions.
cdcafd	367
bc2216	368	4. There are a few updates to these manifests we need to make before applying the cluster content. In the `apply.yml` update the namespace `<YOUR_NAME>` variables accordingly.
cdcafd	369	```yaml
D	370	ci_cd_namespace: donal-ci-cd
	371	dev_namespace: donal-dev
	372	test_namespace: donal-test
	373	```
	374
bc2216	375	4. In the `params` folder update the `dev` and `test` files with the correct `<YOUR_NAME>` as you've done above. Example for the `dev` file:
cdcafd	376	```bash
D	377	PIPELINES_NAMESPACE=donal-ci-cd
c58300	378	NAME=todolist-fe
cdcafd	379	DEPLOYER_USER=jenkins
D	380	APP_TAG=latest
	381	NAMESPACE=donal-dev
	382	```
	383
f016b7	384	4. With those changes in place we can now run the playbook. First install the `openshift-applier` dependency and then run the playbook (from the `.openshift-applier` directory). This will populate the cluster with all the config needed for the front end app.
cdcafd	385	```bash
D	386	$ ansible-galaxy install -r requirements.yml --roles-path=roles
	387	$ ansible-playbook apply.yml -i inventory/
	388	```
071905	389	![ansible-success](../images/exercise2/ansible-success.png)
cdcafd	390
f016b7	391	4. Once successful, `commit` and `push` your changes to gitlab.
A	392
e90e9c	393	4. Back on your terminal navigate to the root of the `todolist-api` application. Open the `.openshift-applier` directory. The same layout as seen in `todolist-fe` should be visible with one noticeable difference; the api requires `MongoDB` to connect to at runtime.
c58300	394
D	395	4. In the `apply.yml` update the namespace `<YOUR_NAME>` variables accordingly. For example:
	396	```yaml
	397	ci_cd_namespace: donal-ci-cd
	398	dev_namespace: donal-dev
	399	test_namespace: donal-test
	400	```
	401
	402	4. In the `params` folder update the `dev` and `test` files with the correct `<YOUR_NAME>` as you've done above. Example for the `dev` file:
	403	```bash
	404	PIPELINES_NAMESPACE=donal-ci-cd
	405	NAME=todolist-api
	406	DEPLOYER_USER=jenkins
	407	APP_TAG=latest
	408	NAMESPACE=donal-dev
	409	```
	410
bfd54c	411	4. Finally; run the Openshift Applier and install its dependencies to run the content into the cluster
c58300	412	```bash
D	413	$ ansible-galaxy install -r requirements.yml --roles-path=roles
	414	$ ansible-playbook apply.yml -i inventory/
	415	```
9fc88c	416
e90e9c	417	4. Validate the build and deploy configs have been created in Openshift by checking `<YOUR_NAME> CI-CD builds` for the `BuildConfigs`
A	418
	419	4. Check `<YOUR_NAME>-dev` for the deployment ![ocp-app-deployment-overview](../images/exercise2/ocp-app-deployment-overview.jpeg)
	420
9fc88c	421	### Part 4 - Build > Bake > Deploy
0e648a	422	> _In this exercise; we take what we have working locally and get it working in OpenShift_
9fc88c	423
41217d	424	This exercise will involve creating three stages (or items) in our pipeline, each of these is detailed below at a very high level. Move on to the next step to begin implementation.
D	425	* a build job is responsible for compiling and packaging our code:
	426	1. Checkout from source code (`develop` for `<yourname>-dev` & `master` for `<yourname>-test`)
	427	2. Install node dependencies and run a build / package
	428	3. Send the package to Nexus
	429	4. Archive the workspace to persist the workspace in case of failure
	430	4. Tag the GitLab repository with the `${JOB_NAME}.${BUILD_NUMBER}` from Jenkins. This is our `${BUILD_TAG}` which will be used on downstream jobs.
	431	5. Trigger the `bake` job with the `${BUILD_TAG}` param
	432	* a bake job should take the package and put it in a Linux Container
	433	1. Take an input of the previous jobs `${BUILD_TAG}` ie `${JOB_NAME}.${BUILD_NUMBER}`.
	434	2. Checkout the binary from Nexus and unzip it's contents
	435	3. Run an oc start-build of the App's BuildConfig and tag it's imagestream with the provided `${BUILD_TAG}`
	436	4. Trigger a deploy job using the parameter `${BUILD_TAG}`
	437	* a deploy job should roll out the changes by updating the image tag in the DC:
	438	1. Take an input of the `${BUILD_TAG}`
	439	2. Patch / set the DeploymentConfig to the image's `${BUILD_TAG}`
	440	3. Rollout the changes
	441	4. Verify the deployment
76d54e	442	* We will now go through these steps in detail.
9fc88c	443
41217d	444	#### Part 4a - Build
9fc88c	445
c58300	446	5. With the BuildConfig and DeployConfig in place for both our apps (`-fe` & `-api`) from previous steps; Log into Jenkins and create a `New Item`. This is just jenkins speak for a new job configuration. ![new-item](../images/exercise2/new-item.png)
9fc88c	447
579436	448	5. Name this job `dev-todolist-fe-build` and select `Freestyle Job`. All our jobs will take the form of `<ENV>-<APP_NAME>-<JOB_PURPOSE>`. ![freestyle-job](../images/exercise2/freestyle-job.png)
9fc88c	449
034b0f	450	5. The page that loads is the Job Configuration page and it can be returned to at anytime from Jenkins. Let's start configuring our job. To conserve space; we will make sure Jenkins only keeps the last builds artifacts. Tick the `Discard old builds` checkbox and set `Max # of builds to keep with artifacts` to 1 as below ![keep-artifacts](../images/exercise2/keep-artifacts.png)
43f2f2	451
579436	452	5. Our NodeJS build needs to be run on the `jenkins-slave-npm` we created earlier. Specify this in the box labelled `Restrict where this project can be run` ![label-jenkins-slave](../images/exercise2/label-jenkins-slave.png)
c951f7	453
1b285d	454	5. On the Source Code Management tab, select the Git radio button, specify the endpoint for our GitLab `todolist-fe` Project and specify your credentials from the dropdown box. Set the Branch Specifier to `develop`. ![git-scm](../images/exercise2/git-scm.png)
c951f7	455
579436	456	5. Scroll down to the Build Environment tab and select the `Color ANSI Console Output` checkbox ![ansi](../images/exercise2/ansi.png)
e919d0	457
76d54e	458	5. Move on to the Build section and select `Add build step`. From the dropdown select `Execute Shell`. On the box that appears; insert the following, to build package and deploy our app to Nexus:
e919d0	459	```bash
D	460	set -o xtrace
4acca2	461	npm install
D	462	npm run build:ci:dev
	463	npm run package
	464	npm run publish
e919d0	465	```
D	466	![build-step](../images/exercise2/build-step.png)
	467
579436	468	5. Scroll to the final section; the Post-build Actions. Add a new post-build action from the dropdown called `Archive the artifacts` and specify `**` in the box. This will zip the entire workspace and copy it back to Jenkins for inspection if needed. ![archive-artifacts](../images/exercise2/archive-artifacts.png)
e919d0	469
579436	470	5. On the Post-build Actions; Add another post-build action from the dropdown called `Git Publisher`. This is useful for tying the git check-in to the feature in your tracking tool to the built product.
e919d0	471	* Tick the box `Push Only If Build Succeeds`
D	472	* Add the Tag to push of
	473	```bash
	474	${JOB_NAME}.${BUILD_NUMBER}
	475	```
	476	* Specify the commit message to be
	477	```bash
	478	Automated commit by jenkins from ${JOB_NAME}.${BUILD_NUMBER}
	479	```
1b285d	480
A	481	* Check `Create New Tag` and set `Target remote name` to `origin`
e919d0	482	![git-publisher](../images/exercise2/git-publisher.png)
D	483
1b285d	484	5. Finally; add the trigger for the next job in the pipeline. This is to trigger the bake job with the current build tag. Add another post-build action from the dropdown called `Trigger parameterized build on other projects`.
e919d0	485	* Set the project to build to be `dev-todolist-fe-bake`
D	486	* Set the condition to be `Stable or unstable but not failed`.
	487	* Click Add Parameters dropdown and select Predefined parameters.
	488	* In the box, insert our BUILD_TAG as follows
	489	```bash
	490	BUILD_TAG=${JOB_NAME}.${BUILD_NUMBER}
	491	```
	492	![param-trigger](../images/exercise2/param-trigger.png)
	493	<p class="tip">
3b5f91	494	NOTE - Jenkins might say "No such project ‘dev-todolist-fe-bake’. Did you mean ...." at this point. Don't worry; it's because we have not created the next job yet.
e919d0	495	</p>
D	496
579436	497	5. Hit `save` which will take you to the job overview page - and that's it; our build phase is complete!
e919d0	498
41217d	499	#### Part 4b - Bake
D	500
579436	501	5. Next we will setup our bake phase; which is a little simpler. Go to Jenkins home and create another Freestyle Job (as before) called `dev-todolist-fe-bake`.
e919d0	502
1b285d	503	5. This job will take in the BUILD_TAG from the previous one so check the `This project is parameterized` box on the General tab.
3b5f91	504	* Add string parameter type
1b285d	505	* set the Name to `BUILD_TAG`. This will be available to the job as an Enviroment Variable.
3b5f91	506	* You can set `dev-todolist-fe-build.` as the default value for ease when triggering manually.
D	507	* The description is not required but a handy one for reference would be `${JOB_NAME}.${BUILD_NUMBER} of previous build eg dev-todolist-fe-build.1232`
	508	![param-trigger-bake](../images/exercise2/param-trigger-bake.png)
c951f7	509
579436	510	5. This time set the `Restrict where this project can be run` label to `master`.
3b5f91	511	<p class="tip">
1b285d	512	`Master` is the default node that jobs run on. We don't want jenkins to execute the bake on any other nodes if the `master` is busy so it is always safer to specify it here.
3b5f91	513	</p>
D	514
579436	515	5. There is no Git or SCM needed for this job so move down to the Build Environment and tick `Delete workspace before build starts`
3b5f91	516
579436	517	5. Scroll down to the Build Environment tab and select the `Color ANSI Console Output` checkbox ![delete-ansi](../images/exercise2/delete-ansi.png)
3b5f91	518
579436	519	5. Move on to the Build section and select `Add build step`. From the dropdown select `Execute Shell`. On the box the appears; insert the following, to pull the package from Nexus. We patch the BuildConfig with the Jenkins Tag to get traceablility from feature to source code to built item. Finally; the oc start-build command is run:
1b285d	520	Remember to replace `<YOUR_NAME>` accordingly.
3b5f91	521	```bash
D	522	#!/bin/bash
d00794	523	curl -v -f http://admin:admin123@${NEXUS_SERVICE_HOST}:${NEXUS_SERVICE_PORT}/repository/zip/com/redhat/todolist/${BUILD_TAG}/package-contents.zip -o package-contents.zip
3b5f91	524	unzip package-contents.zip
D	525	oc project <YOUR_NAME>-ci-cd # probs not needed
	526	NAME=todolist-fe
9adaf7	527	oc patch bc ${NAME} -p "{\"spec\":{\"output\":{\"to\":{\"kind\":\"ImageStreamTag\",\"name\":\"${NAME}:${BUILD_TAG}\"}}}}"
3b5f91	528	oc start-build ${NAME} --from-dir=package-contents/ --follow
D	529	```
	530	![bake-step](../images/exercise2/bake-step.png)
	531
579436	532	5. Finally; add the trigger for the next job in the pipeline. Add a post-build action from the dropdown called `Trigger parameterized build on other projects`.
3b5f91	533	* Set the project to build to be `dev-todolist-fe-deploy`
D	534	* Set the condition to be `Stable`.
	535	* Click Add Parameters dropdown and select Current build parameters. This will pass the ${BUILD_TAG} to the downstream job which we will create next.
	536	![downstream-trigger-deploy](../images/exercise2/downstream-trigger-deploy.png)
	537
579436	538	5. Hit save! That's our bake phase done! Finally; on to our deploy
3b5f91	539
41217d	540	#### Part 4c - Deploy
D	541
1b285d	542	5. Next we will setup our deploy phase. This job is very similar in setup to the bake phase so this time go to Jenkins home and create `dev-todolist-fe-deploy` Job but scroll to the bottom and Copy from `dev-todolist-fe-bake`.
579436	543	![copy-from](../images/exercise2/copy-from.png)
D	544
1b285d	545	5. The only two differences between these jobs is the Build Step and there are no Post Build Actions. First to the Build tab and add the following to the shell box. The process for running the deploy is to tag the image created previously for use in the `ci-cd` namespace for use in the dev project. Then update the DeploymentConfig to use the Jenkins Tag which kicked the process off. Once successful; the changes are rolled out. Remember to change `<YOUR_NAME>` accordingly.
579436	546	```bash
D	547	#!/bin/bash
	548	set -o xtrace
	549	# VARS
1b285d	550	PIPELINES_NAMESPACE=<YOUR_NAME>-ci-cd
A	551	NAMESPACE=<YOUR_NAME>-dev
579436	552	NAME=todolist-fe
D	553	oc project ${NAMESPACE}
	554	oc tag ${PIPELINES_NAMESPACE}/${NAME}:${BUILD_TAG} ${NAMESPACE}/${NAME}:${BUILD_TAG}
	555	oc set env dc ${NAME} NODE_ENV=dev
	556	oc set image dc/${NAME} ${NAME}=docker-registry.default.svc:5000/${NAMESPACE}/${NAME}:${BUILD_TAG}
	557	oc rollout latest dc/${NAME}
	558	```
	559	![deploy-step](../images/exercise2/deploy-step.png)
	560
1b285d	561	5. Secondly, add another build step called `Verify OpenShift Deployment` including the following:
579436	562	* Set the Project to your `<YOUR_NAME>-dev`
D	563	* Set the DeploymentConfig to your app's name `todolist-fe`
	564	* Set the replica count to `1`
	565	![verify-deployment](../images/exercise2/verify-deployment.png)
	566
	567	5. Finally; delete the Post Build Action to trigger another job (by hitting the red X). Save the configuration. We're almost ready to run the pipeline!
	568
41217d	569	#### Part 4d - Pipeline
D	570
1b285d	571	5. With our Jenkins setup in place; now move to our `todolist-fe` app. We need to add our configuration to the frontend to tell it where the API layer is hosted. Open in it your favourite editor and navigate to `src/config/dev.js`. Update `<YOUR_NAME>` accordingly with the root where the Todo List API will live. For example:
41217d	572	![fe-dev-config](../images/exercise2/fe-dev-config.png)
D	573
	574	5. Repeat this for `src/config/test.js` file. Once done; commit your chanages and push them to GitLab
	575	```bash
	576	$ git add .
	577	$ git commit -m "ADD config for api"
	578	$ git push
	579	```
	580
1b285d	581	5. Back on Jenkins; We can tie all the jobs in the pipeline together into a nice single view using the Build Pipeline view. Back on the Jenkins home screen Click the + beside the all tab on the top. Give the new view a sensible name like `dev-todolist-fe-pipeline`
579436	582	![add-view](../images/exercise2/add-view.png).
D	583
	584	5. Set the Pipeline Flow's Inital Job to `dev-todolist-fe-build` and save.
1b285d	585	TODO - change below sscreenshot
579436	586	![pipeline-flow](../images/exercise2/pipeline-flow.png)
D	587
1b285d	588	5. You should now see the pipeline view. Run the pipeline by hitting run (you can move onto the next part while it is running as it may take some time).
579436	589	![dev-pipeline-view](../images/exercise2/dev-pipeline-view.png)
D	590
	591	### Part 5 - Backend Pipeline
1b285d	592	> In this exercise we will use the Jobs created for the `todolist-fe` as a template to create a pipeline for the `todolist-api` app by copying the config.
579436	593
1b285d	594	6. On Jenkins home; create a new job for our backend build called `dev-todolist-api-build`. Use the `Copy from` section to copy all the configuration from the `dev-todolist-fe-build`.
d00794	595	![copy-fe-build](../images/exercise2/copy-fe-build.png)
579436	596
d00794	597	6. When this has loaded; find and replace both occurrences `-fe` with `-api` within the Job's configuration. Places to make sure you check are:
D	598	* The GitLab project URL
	599	* Projects to build on the Post Build Action
579436	600
1b285d	601	6. On the Build tab; remove the `:dev` from the `npm run build:ci:dev` so the line reads.
A	602	The rest of the instructions can be left as they are.
d00794	603	```bash
4acca2	604	npm run build:ci
d00794	605	```
579436	606
d00794	607	6. Save the configuration for `dev-todolist-api-build`
579436	608
1b285d	609	6. On Jenkins home; create a new job for our backend bake called `dev-todolist-api-bake`. Use the Copy from section to copy all the configuration from the `dev-todolist-fe-bake` as you've just done.
d00794	610
D	611	6. When this has loaded; find and replace the occurrences `-fe` with `-api` within the Job's configuration. Places to make sure you check are:
	612	* The BUILD_TAG default value and description
	613	* NAME in the execute shell step
	614	* Projects to build on the Post Build Action
	615
	616	6. Save the configuration for `dev-todolist-api-build`
	617
	618	6. On Jenkins home; create a new job for our backend build called `dev-todolist-api-deploy`. Use the Copy from section to copy all the configuration from the `dev-todolist-fe-deploy` as you've just done.
	619
	620	6. When this has loaded; find and replace the occurrences `-fe` with `-api` within the Job's configuration. Places to make sure you check are:
	621	* The BUILD_TAG default value and description
	622	* NAME in the execute shell step
	623	* The name of the DeploymentConfig to validate in the Verify OpenShift Deployment
	624
	625	6. Save the configuration for `dev-todolist-api-build` and that's it for wiring together our `todolist-api` pipeline.
	626
456daa	627	6. Run the `dev-todolist-api-build` to trigger the backend pipeline. While this is building, check our front end app and see if it has deployed successfully. Check the deployment in OpenShift and load the url. If it has been a success we should see our dummyData. This is because there is no backend deployed.
d00794	628	![no-backend-app](../images/exercise2/no-backend-app.png)
D	629
456daa	630	6. When `dev-todolist-api-build` has completed we should see the sample data has changed on refresh.
d00794	631	![with-backend-app](../images/exercise2/with-backend-app.png)
c951f7	632
106095	633	### Part 6 - GitLab Webhooks
b00f5a	634	> _In this exercise we will link GitLab to Jenkins so that new build jobs are triggered on each push to the `develop` branch._
11b338	635
b00f5a	636	<p class="tip" >
D	637	NOTE - This section is optional! Git webhooks are useful but not needed for course completion.
	638	</p>
	639
b311e1	640	7. In order to allow GitLab trigger Jenkins (because of the OpenShift Auth Plugin), we need to allow the `Annoymous` user trigger builds. Head to your Jenkins Dashboard and click on `Manage Jenkins` on the left hand side. Then scroll down and click `Configure Global Security`. Alternatively, type in `https://jenkins-<YOUR_NAME>-ci-cd.apps.some.domain.com/configureSecurity/` . You should see a screen like so:
106095	641	![jenkins-global-security](../images/exercise2/jenkins-global-security.png)
A	642
	643	7. Scroll down to the `Authorization` section and allow `Anonymous` to create jobs. Do this by navigating through the matrix of checkboxes and check `Build` and `Cancel` under the Job heading. Leave all other user behaviour as is. Anonymous is the user that GitLab will act as so this allows the WebHook to trigger builds. (The screenshot has been cropped to bring Job further to the left.) Hit `Save` or `Apply`.
	644	![jenkins-anon-permissions](../images/exercise2/jenkins-anon-permissions.png)
	645
b311e1	646	7. Go to your `dev-todolist-fe-build` and head to the `configure` section (`https://jenkins-<YOUR_NAME>-ci-cd.apps.some.domain.com/job/dev-todolist-fe-build/configure`). Scroll down to the `Build Triggers` section and check the `Build when a change is pushed to GitLab` box. Leave all the other settings as they are but copy the `GitLab webhook URL`. `https://jenkins-<YOUR_NAME>-ci-cd.apps.some.domain.com/project/dev-todolist-fe-build`.
0c725b	647	![jenkins-build-triggers-gitlab](../images/exercise2/jenkins-build-triggers-gitlab.png)
11b338	648
b311e1	649	7. Switch over to GitLab and select your `todolist-fe` repository. On the left hand task bar hover over the settings cog and select `integrations`. (`https://gitlab-<YOUR_NAME>-ci-cd.apps.some.domain.com/<YOUR_NAME>/todolist-fe/settings/integrations`)
0c725b	650	![gitlab-integrations](../images/exercise2/gitlab-integrations.png)
11b338	651
0c725b	652	7. Paste the `GitLab webhook URL` that we copied earlier into the `URL` field. Check Push events as the trigger, and make sure you `uncheck` the `SSL verification` checkbox. Click Add webhook at the bottom.
A	653	![gitlab-integrations-details](../images/exercise2/gitlab-integrations-details.png)
11b338	654
0c725b	655	7. Before we move on let's test the webhook. Select the Test drop down and click `Push events`. This will trigger the test and return a status code at the top of the page. If all goes well it should be a cool blue 200.
A	656	![gitlab-integrations-details](../images/exercise2/gitlab-webhook-test.png)
11b338	657
0c725b	658	7. We can now test this properly by heading into the `todolist-fe` repository through <YOUR_FAVOURITE_EDITOR>. Make a small change to your code, then commit and push it, ensuring you're on the develop branch. Then head over to Jenkins and wait until the `dev-todolist-fe-build` job has been triggered.
11b338	659
0c725b	660	7. All that's left to do is to repeat the same steps for `todolist-api`:
A	661	Create Build Trigger:
b311e1	662	`https://jenkins-<YOUR_NAME>-ci-cd.apps.some.domain.com/job/dev-todolist-api-build/configure`
0c725b	663	Create GitLab Integration:
b311e1	664	`https://gitlab-<YOUR_NAME>-ci-cd.apps.some.domain.com/donal/todolist-api/settings/integrations`
0c725b	665	Check your build status and you should see something like this. With `Started by Gitlab push by <YOUR_NAME>`:
A	666	![jenkins-gitlab-webhook-success](../images/exercise2/jenkins-gitlab-webhook-success.png)
11b338	667
0c725b	668	7. We now have a working GitLab webhook so any time we push code it will automatically build! Next up we'll show you how to add tests to your pipeline.
b00f5a	669
43f2f2	670	_____
D	671
c951f7	672	## Extension Tasks
cf415b	673	> _Ideas for go-getters. Advanced topic for doers to get on with if they finish early. These will usually not have a solution available and are provided for additional scope._
c951f7	674
d00794	675	- Pipeline Tasks
456daa	676	* Add pipeline for `master` branch for each project. Use `test-` instead of `dev-` across all config and names in the pipeline
A	677	* Do the `.openshift-applier` steps as part of the pipeline for greater end to end automation.
e919d0	678	- Promote build
456daa	679	* Create a _promote-to-uat_ phase after the `master` branch deploy
cf415b	680	* Create a `uat` env using the OpenShift Applier as seen before
e919d0	681	* Tag and promote the image without rebuilding after the `test-**-deploy`
c58300	682	- MongoDB tasks
e919d0	683	* Add MongoDB Stateful set for the UAT environment (or test)
D	684	* Inject MongoDB config into the NodeJS app using config map & secrets.
cf415b	685	* Improve the security of the DB by making the user /passwords randomly generated
e919d0	686	- Setup Nexus as an `npm` mirror registry and use it in the builds to speed up the build time
c951f7	687
D	688	## Additional Reading
43f2f2	689	> List of links or other reading that might be of use / reference for the exercise
D	690
7383de	691	- What's in a package.json?
D	692
43f2f2	693	## Slide links
7c832b	694
01c4da	695	- [Intro](https://docs.google.com/presentation/d/1t1CONuy-_IRPZYmU010Qgk2rshiDJTennvLyQR8GllE)
RH	696	- [Wrap-up](https://docs.google.com/presentation/d/1kZ8SV6iJnrKk_AqPpyPuNZifv7VzItHOB9HYdOnNJjI)
	697	- [All Material](https://drive.google.com/drive/folders/1lf66ks2tT0eQ4A9RSU48u0ZhvBXzoHWJ)