RedHatTraining/rht-labs-docs.git

Changes to the order for clicky stuff; removed be pipeine

donal

2018-05-16 35ca14577bc35e7e19d0c4817a46aad2188d532d

commit \| author \| age
3772d9	1	# Attack of the Pipelines
0f4d08	2
867471	3	> In this exercise we will explore the sample TODO List application and create a pipeline in Jenkins to build and deploy our code.
3772d9	4
D	5	![jenkins-time](../images/exercise2/jenkins-time.jpg)
	6
78b569	7	## Exercise Intro
D	8	This lesson is focused on creating a pipeline for our application. What is a pipeline? A pipeline is a series of steps or stages that takes our code from source to a deployed application. There can be many stages to a pipeline but a simple flow is to run a `build > bake > deploy`. Usually the first stage is trigger by something like a git commit. There could be many steps in each of these stages; such as compiling code, running tests and linting. All of these are done to try and drive up code quality and give more assurance that what is deployed is behaving as expected. In the exercise we will create Jenkins pipeline by configuring it through the UI, this will create an un-gated pathway to production
	9
	10	First we will explore the sample application and get it running locally. The sample app is a `todolist` app - the `Hello World` app of the modern day.
	11
	12	#### Why create pipelines
	13	* Assurance - drive up code quality and remove the need for dedicated deployment / release management teams
	14	* Freedom - allow developers to take ownership of how and when code gets built and shipped
2059d3	15	* Reliability - pipelines are a bit boring; they execute the same way each and every time they're run!
78b569	16	* A pathway to production:
D	17	- Puts the product in the hands of the customer quicker
	18	- Enables seamless and repeatable deploys
	19	- More prod like infrastructure increases assurance
	20	- “We have already done it” behavior de-risks go live
	21
5a16fd	22	_____
0f4d08	23
D	24	## Learning Outcomes
3772d9	25	As a learner by the end of this lesson you will be able to
D	26
	27	- Build and run the full stack of the TODO List application locally
	28	- Create an un-gated pipeline using the Jenkins UI for the backend and frontend
	29	- Add branching to the pipeline to target specific namespace
0f4d08	30
D	31	## Tools and Frameworks
8a47e6	32	> The following tools are used throughout this exercise. Familiarity with them is not required but knowing what they are may help. You will not need to install Vue or Mongodb they are taken care of by our `todolist` app.
0f4d08	33
D	34	1. [Jenkins](https://jenkins.io/) - OpenSource build automation server; highly customisable through plugins
3772d9	35	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	36	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
	37	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.
0f4d08	38
5a16fd	39	## Big Picture
3772d9	40	> From the previous exercise; we created some supporting tooling needed by our app/
5a16fd	41
D	42	_____
0f4d08	43
D	44	## 10,000 Ft View
3772d9	45	> _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_
5a16fd	46
3772d9	47	2. Import the projects into your gitlab instance. See README of each for build instructions
5a16fd	48
3772d9	49	2. Deploy a `MongoDB` using the provided template to all project namespace.
D	50
	51	2. Create 2 pipline with three stages (`build`, `bake`, `deploy`) in jenkins for `develop` & `master` branches on the `todolist-fe` such that:
c3a934	52	* a `Build` job is responsible for compiling and packaging our code:
3772d9	53	1. Checkout from source code (`develop` for `<yourname>-dev` & `master` for `<yourname>-test`)
D	54	2. Install node dependencies and run a build / package
c3a934	55	3. Send the package to Nexus
D	56	4. Archive the workspace to persist the workspace in case of failure
	57	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.
	58	5. Trigger the `bake` job with the `${BUILD_TAG}` param
	59	* a `Bake` job should take the package and put it in a Linux Container
3772d9	60	1. Take an input of the previous jobs `${BUILD_TAG}` ie `${JOB_NAME}.${BUILD_NUMBER}`.
D	61	2. Checkout the binary from Nexus and unzip it's contents
c3a934	62	3. Run an oc start-build of the App's BuildConfig and tag it's imagestream with the provided `${BUILD_TAG}`
3772d9	63	4. Trigger a deploy job using the parameter `${BUILD_TAG}`
c3a934	64	* a `deploy` job should roll out the changes by updating the image tag in the DC:
3772d9	65	1. Take an input of the `${BUILD_TAG}`
D	66	2. Patch / set the DeploymentConfig to the image's `${BUILD_TAG}`
	67	3. Rollout the changes
	68	4. Verify the deployment
	69
	70	2. Repeat the above setup for the backend `todolist-fe`. TIP - use the copy config to speed things up!
	71
	72	2. Verify that both apps and the DB are talking to one another as expected.
0f4d08	73
D	74	## Step by Step Instructions
f2b1b4	75	> This is a fairly structured guide with references to exact filenames and sections of text to be added.
0f4d08	76
14268c	77	### Part 1 - Explore the Todo List App
f2b1b4	78	> _In this part of the exercise we will explore the sample application, become familiar with it locally before building and deploying in OCP Land_
5a16fd	79
752f2a	80	#### 1a Todolist-fe
256ca9	81
45eb81	82	2. Git clone the `todolist-fe` project to somewhere sensible and checkout the `develop` branch using the following.
f2b1b4	83	```bash
58480f	84	cd ~/innovation-labs
D	85	```
	86	```bash
ad8436	87	git clone https://github.com/rht-labs/todolist-fe.git
58480f	88	```
D	89	```bash
ad8436	90	cd todolist-fe
256ca9	91	```
ad8436	92	```bash
D	93	./git-pull-all.sh
58480f	94	```
D	95	```bash
	96	git checkout develop
0f4d08	97	```
f2b1b4	98
486224	99	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)
f2b1b4	100
D	101	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
	102	```bash
ad8436	103	git remote set-url origin <YOUR_GIT_LAB_PROJECT>
486224	104	# verify the origin has been updated
ad8436	105	git remote -v
D	106	git push -u origin --all
0f4d08	107	```
f2b1b4	108
D	109	2. To get the app running locally; first check you've got node and npm installed
	110	```bash
ad8436	111	node -v
D	112	npm -v
f2b1b4	113	```
D	114	<p class="tip" >
	115	NOTE - If you are missing these dependencies; install them with ease using the [Node Version Manager](https://github.com/creationix/nvm)
	116	</p>
	117	![node-version](../images/exercise2/node-version.png)
	118
	119	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
	120	```bash
ad8436	121	npm install
f2b1b4	122	```
D	123
514d1d	124	2. The `todolist-fe` has some scripts defined in the package.json at the root of the project. A snippet of the npm scripts are shown below. To run any of these scripts run `npm run <SCRIPT_NAME>`. Let's start by serving our application
f2b1b4	125	![npm-scripts](../images/exercise2/npm-scripts.png)
D	126	```bash
	127	npm run serve
	128	```
	129
486224	130	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.
f2b1b4	131	![todo-list-app](../images/exercise2/todo-list-app.png)
486224	132	* Click 'Todo' at the top of the home page to get to the above page.
514d1d	133	* The server hosting it live reloads; so if you make changes to your code base the app will live update
f2b1b4	134	* The Data you see in the screen is dummy / stubbed data. This is served up when there is no backend connection found
D	135
514d1d	136	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 no persistence layer. We will add one in the next part.
f2b1b4	137
D	138	3. The structure of the `todolist-fe` is as follows.
	139	```bash
	140	todolist-fe
	141	├── jest.config.js
	142	├── jsconfig.json
	143	├── nightwatch.config.js
	144	├── node_modules
	145	├── package.json
	146	├── public
	147	│ ├── favicon.ico
	148	│ ├── img
	149	│ ├── index.html
	150	│ └── manifest.json
	151	├── src
	152	│ ├── App.vue
	153	│ ├── assets
	154	│ ├── components
486224	155	│ │ └── *
f2b1b4	156	│ ├── config
D	157	│ ├── main.js
	158	│ ├── registerServiceWorker.js
	159	│ ├── router.js
	160	│ ├── scss
	161	│ ├── services
	162	│ ├── store
486224	163	│ │ └── *
f2b1b4	164	│ └── views
486224	165	│ └── *
f2b1b4	166	├── tests
D	167	│ ├── e2e
	168	│ └── unit
	169	└── vue.config.js
	170	```
	171	where the following are the important things:
	172	* `./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.
	173	* `./node_modules` is where the dependencies are stored
867471	174	* `./test` contains our end-to-end tests and unit tests. More covered on these in later exercises.
486224	175	* `./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
f2b1b4	176	* `./src/store` is the `vuex` files for managing application state and backend connectivity
D	177	* `./src/views` is the view containers; which are responsible for loading components and managing their interactions.
	178	* the `./src/router.js` controls routing logic. In our case the app only has one real endpoint.
	179	* `./src/scss` contains custom SCSS used in the application.
	180	* `./*.js` is mostly config files for running and managing the app and the tests
0f4d08	181
45eb81	182	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 and change `<YOUR_NAME>` accordingly in the below commands.
256ca9	183	```bash
12ca4a	184	export NEXUS_SERVICE_HOST=$(oc get route nexus --template='{{.spec.host}}' -n <YOUR_NAME>-ci-cd)
45eb81	185	```
D	186	```bash
256ca9	187	export NEXUS_SERVICE_PORT=80
45eb81	188	```
D	189	```bash
	190	```
256ca9	191	npm run prepare-nexus
A	192	```
	193	<p class="tip">
	194	NOTE - This step in a residency would be automated by a more complex nexus deployment in the ci-cd project
	195	</p>
	196
752f2a	197	#### 1b Todolist-api
f9e311	198
3691a1	199	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	200	```bash
58480f	201	cd ~/innovation-labs
D	202	```
	203	```bash
ad8436	204	git clone https://github.com/rht-labs/todolist-api.git
58480f	205	```
D	206	```bash
ad8436	207	cd todolist-api
256ca9	208	```
ad8436	209	```bash
D	210	./git-pull-all.sh
58480f	211	```
D	212	```bash
	213	git checkout develop
3691a1	214	```
D	215
514d1d	216	2. On GitLab; create a new project (internal) called `todolist-api` to host your clone of the project and copy it's remote address as you did for the previous repositories.
3691a1	217
D	218	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
	219	```bash
ad8436	220	git remote set-url origin <YOUR_GIT_LAB_PROJECT>
D	221	```
	222	```bash
	223	git push -u origin --all
3691a1	224	```
D	225
	226	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
	227	```bash
ad8436	228	npm i
3691a1	229	```
D	230
	231	2. While the dependencies are being installed; explore the project structure.
	232	```bash
	233	todolist-api
	234	├── Dockerfile
	235	├── Gruntfile.js
	236	├── README.md
	237	├── node_modules
	238	├── package-lock.json
	239	├── package.json
	240	├── server
	241	│ ├── api
	242	│ │ └── todo
	243	│ ├── app.js
	244	│ ├── components
	245	│ │ └── errors
	246	│ ├── config
	247	│ │ ├── environment
	248	│ │ ├── express.js
	249	│ │ ├── local.env.sample.js
	250	│ │ └── seed.js
	251	│ ├── mocks
	252	│ │ ├── mock-routes-config.json
	253	│ │ ├── mock-routes.js
	254	│ │ └── mock-routes.spec.js
	255	│ ├── routes.js
	256	│ └── views
	257	│ └── 404.html
	258	└── tasks
	259	└── perf-test.js
	260	```
	261	where the following are the important things:
	262	* `./server` is the main collection of files needed by the app. The entrypoint is the `app.js`
	263	* `./node_modules` is where the dependencies are stored
	264	* `./server/api` is where the api's controller, data model & unit test are stored.
	265	* `./server/mocks` is a mock server used for when there is no DB access
486224	266	* `./server/config` stores our Express JS config, header information and other middleware.
A	267	* `./server/config/environment` stores enviromnent specific config; such as connectivity to backend services like MongoDB.
867471	268	* `./tasks` is a collection of additional `Grunt` tasks which will be used in later exercises
486224	269	* `Grunt` is a taskrunner for use with Node.JS projects
3691a1	270	* `package.json` contains the dependency list and a lot of very helpful scripts for managing the app lifecycle
D	271
1d9ebc	272	2. A snippet of 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.
3691a1	273	```json
D	274	"scripts": {
	275	"start": "node server/app.js",
	276	"dev": "./node_modules/.bin/grunt serve",
	277	"jshint": "./node_modules/.bin/grunt jshint",
	278	"clean": "rm -rf reports package-contents*",
	279	"package": "zip -r package-contents.zip package-contents",
	280	"test": "node_modules/.bin/nyc node_modules/.bin/mocha server/*/.spec.js --exit",
	281	"mongo" : "docker run -i -d --name mongo-local -p 27017:27017 mongo",
	282	"mongo:drop" : "npm run mongo:stop && docker rm mongo-local",
	283	"mongo:stop" : "docker stop mongo-local",
	284	"mongo:start" : "docker start mongo-local"
	285	},
f9e311	286	```
A	287
514d1d	288	2. To run the application; start a new instance of the MongoDB by running the following. This will pull a mongodb image from Dockerhub and then start it for our API to connect to.
3691a1	289	```bash
ad8436	290	npm run mongo
3691a1	291	```
D	292	<p class="tip">
e8cd20	293	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
3691a1	294	</p>
D	295
	296	2. Fire up the `todolist-api` by running.
	297	```bash
ad8436	298	npm run start
3691a1	299	```
D	300	![node-app-started](../images/exercise2/node-app-started.png)
	301
486224	302	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`)
3691a1	303	```bash
ad8436	304	curl localhost:9000/api/todos
3691a1	305	```
D	306	```json
	307	[{
	308	"_id": "5ac8ff1fdfafb02138698948",
	309	"title": "Learn some stuff about MongoDB",
	310	"completed": false,
	311	"__v": 0
	312	},
	313	{
	314	"_id": "5ac8ff1fdfafb02138698949",
	315	"title": "Play with NodeJS",
	316	"completed": true,
	317	"__v": 0
	318	}]
	319	```
	320
486224	321	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.
3691a1	322	![fullstack-app](../images/exercise2/fullstack-app.png)
D	323
	324
273e4c	325	### Part 2 - Create a NodeJS Build slave
374f63	326	> _In this exercise; we will create a build configuration to generate a slave for Jenkins to use in it's builds_
273e4c	327
7dca92	328	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-ci-cd` repository, checkout the template and configuration. This will bring in the template, the params & the `Dockerfile`.
273e4c	329	```bash
ad8436	330	git checkout exercise2/jenkins-slave docker/ templates/ params/jenkins-slave-npm
273e4c	331	```
D	332
45eb81	333	3. Open the `params/jenkins-slave-npm` file and update `<GIT_URL>` accordingly. The `<GIT_URL>` is the full path of the repository where this project is stored (including the https && .git) eg `https://gitlab.apps.lader.rht-labs.com/<YOUR_NAME>/enablement-ci-cd.git`. This set of parameters will clone from the enablement repo and run a docker build of the Dockerfile stored in `docker/jenkins-slave-npm`.
273e4c	334	```bash
d82125	335	SOURCE_REPOSITORY_URL=<GIT_URL>
273e4c	336	SOURCE_CONTEXT_DIR=docker/jenkins-slave-npm
1937a3	337	NAME=jenkins-slave-npm
273e4c	338	```
D	339
b92135	340	3. Create an item in the `inventory/host_vars/ci-cd-tooling.yml` under the `ci-cd-builds` object to run the template with.
273e4c	341	```yaml
1937a3	342	- name: "jenkins-slave-npm"
b92135	343	namespace: "{{ ci_cd_namespace }}"
D	344	template: "{{ playbook_dir }}/templates/jenkins-slave-generic-template.yml"
	345	params: "{{ playbook_dir }}/params/jenkins-slave-npm"
273e4c	346	tags:
D	347	- jenkins-slave
	348	```
	349	![jenkins-slave-ansible](../images/exercise2/jenkins-slave-ansible.png)
	350
e23af1	351	3. Commit your changes to the `enablement-ci-cd` repository!
D	352	```bash
ad8436	353	git add .
D	354	```
	355	```bash
	356	git commit -m "ADD npm slave node for Jenkins"
	357	```
	358	```bash
	359	git push
e23af1	360	```
D	361
273e4c	362	3. Run the OpenShift Applier to trigger a build of this jenkins slave image.
D	363	```bash
ad8436	364	ansible-playbook apply.yml -e target=tools \
273e4c	365	-i inventory/ \
D	366	-e "filter_tags=jenkins-slave"
	367	```
	368
	369	3. Verify the build executed successfully by logging into the cluster and checking the `builds` tab of the `<YOUR_NAME>-ci-cd` project.
	370	![jenkins-slave-npm-build](../images/exercise2/jenkins-slave-npm-build.png)
	371
867471	372	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 exercise
273e4c	373	<p class="tip">
D	374	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.
	375	</p>
	376
	377	### Part 3 - Add configs to cluster
14268c	378	> _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_
273e4c	379
ac41ef	380	4. On your terminal navigate to the root of the `todolist-fe` application. The app contains a hidden folder called `.openshift-applier`. Move into this `.openshift-applier` directory and you should see a familiar looking directory structure for an ansible playbook.
d98f40	381	```
D	382	.openshift-applier
	383	├── README.md
	384	├── apply.yml
	385	├── inventory
	386	│ ├── group_vars
	387	│ │ └── all.yml
	388	│ └── hosts
	389	├── params
	390	│ ├── build
	391	│ ├── dev
3f9666	392	│ ├── ocp-pipeline
d98f40	393	│ └── test
D	394	├── requirements.yml
	395	└── templates
3f9666	396	├── ocp-pipeline.yml
D	397	├── todolist-fe-build.yml
	398	└── todolist-fe-deploy.yml
d98f40	399	```
2310e7	400	with the following
d1565e	401	* the `apply.yml` file is the entrypoint.
d98f40	402	* the `inventory` contains the objects to populate the cluster with.
D	403	* the `params` contains the variables we'll apply to the `templates`
14268c	404	* the `templates` required by the app. These include the Build, Deploy configs as well as the services, health checks, and other app definitions.
d98f40	405
d1565e	406	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.
d98f40	407	```yaml
D	408	ci_cd_namespace: donal-ci-cd
	409	dev_namespace: donal-dev
	410	test_namespace: donal-test
	411	```
	412
d1565e	413	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:
d98f40	414	```bash
D	415	PIPELINES_NAMESPACE=donal-ci-cd
261f19	416	NAME=todolist-fe
d98f40	417	DEPLOYER_USER=jenkins
D	418	APP_TAG=latest
	419	NAMESPACE=donal-dev
	420	```
	421
14268c	422	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.
d98f40	423	```bash
ad8436	424	ansible-galaxy install -r requirements.yml --roles-path=roles
D	425	```
	426	```bash
	427	ansible-playbook apply.yml -i inventory/
d98f40	428	```
69a4e4	429	![ansible-success](../images/exercise2/ansible-success.png)
d98f40	430
14268c	431	4. Once successful, `commit` and `push` your changes to gitlab.
3f9666	432	```bash
ad8436	433	git add .
D	434	```
	435	```bash
	436	git commit -m "UPDATE - change namespace vars to donal"
	437	```
	438	```bash
	439	git push
3f9666	440	```
14268c	441
45eb81	442	4. Back on your terminal navigate to the root of the `todolist-api` application. Open the `.openshift-applier` directory in your editor. The same layout as seen in `todolist-fe` should be visible with one noticeable difference; the api requires `MongoDB` to connect to at runtime.
261f19	443
D	444	4. In the `apply.yml` update the namespace `<YOUR_NAME>` variables accordingly. For example:
	445	```yaml
	446	ci_cd_namespace: donal-ci-cd
	447	dev_namespace: donal-dev
	448	test_namespace: donal-test
	449	```
	450
	451	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:
	452	```bash
	453	PIPELINES_NAMESPACE=donal-ci-cd
	454	NAME=todolist-api
	455	DEPLOYER_USER=jenkins
	456	APP_TAG=latest
	457	NAMESPACE=donal-dev
	458	```
	459
d362dc	460	4. Finally; run the Openshift Applier and install its dependencies to run the content into the cluster
261f19	461	```bash
ad8436	462	ansible-galaxy install -r requirements.yml --roles-path=roles
D	463	```
	464	```bash
	465	ansible-playbook apply.yml -i inventory/
261f19	466	```
273e4c	467
3f9666	468	4. Once successful, `commit` and `push` your changes to gitlab.
D	469	```bash
ad8436	470	git add .
D	471	```
	472	```bash
	473	git commit -m "UPDATE - change namespace vars to donal"
	474	```
	475	```bash
	476	git push
3f9666	477	```
176e08	478
3f9666	479	4. Validate the build and deploy configs have been created in Openshift by checking `<YOUR_NAME> CI-CD builds` for the `BuildConfigs`
D	480	![ocp-app-bc](../images/exercise2/ocp-app-bc.png)
	481
	482	4. Check `<YOUR_NAME>-dev` to see the deployment configs are in place
ee4a9b	483	![ocp-app-dc](../images/exercise2/ocp-app-dc.png)
176e08	484
273e4c	485	### Part 4 - Build > Bake > Deploy
b15f06	486	> _In this exercise; we take what we have working locally and get it working in OpenShift_
273e4c	487
40ab32	488	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	489	* a build job is responsible for compiling and packaging our code:
	490	1. Checkout from source code (`develop` for `<yourname>-dev` & `master` for `<yourname>-test`)
	491	2. Install node dependencies and run a build / package
	492	3. Send the package to Nexus
	493	4. Archive the workspace to persist the workspace in case of failure
	494	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.
	495	5. Trigger the `bake` job with the `${BUILD_TAG}` param
	496	* a bake job should take the package and put it in a Linux Container
	497	1. Take an input of the previous jobs `${BUILD_TAG}` ie `${JOB_NAME}.${BUILD_NUMBER}`.
	498	2. Checkout the binary from Nexus and unzip it's contents
	499	3. Run an oc start-build of the App's BuildConfig and tag it's imagestream with the provided `${BUILD_TAG}`
	500	4. Trigger a deploy job using the parameter `${BUILD_TAG}`
	501	* a deploy job should roll out the changes by updating the image tag in the DC:
	502	1. Take an input of the `${BUILD_TAG}`
	503	2. Patch / set the DeploymentConfig to the image's `${BUILD_TAG}`
	504	3. Rollout the changes
	505	4. Verify the deployment
19df4d	506	* We will now go through these steps in detail.
273e4c	507
752f2a	508	#### 4a - Build
273e4c	509
261f19	510	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)
273e4c	511
dd060d	512	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)
273e4c	513
1937a3	514	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, then `Advanced` and set `Max # of builds to keep with artifacts` to 1 as indicated below
D	515	![keep-artifacts](../images/exercise2/keep-artifacts.png)
5a16fd	516
dd060d	517	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)
0f4d08	518
19f0bd	519	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)
0f4d08	520
dd060d	521	5. Scroll down to the Build Environment tab and select the `Color ANSI Console Output` checkbox ![ansi](../images/exercise2/ansi.png)
c3a934	522
19df4d	523	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:
c3a934	524	```bash
D	525	set -o xtrace
7a3088	526	npm install
D	527	npm run build:ci:dev
	528	npm run package
	529	npm run publish
c3a934	530	```
D	531	![build-step](../images/exercise2/build-step.png)
	532
dd060d	533	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)
c3a934	534
dd060d	535	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.
c3a934	536	* Tick the box `Push Only If Build Succeeds`
D	537	* Add the Tag to push of
	538	```bash
	539	${JOB_NAME}.${BUILD_NUMBER}
	540	```
	541	* Specify the commit message to be
	542	```bash
	543	Automated commit by jenkins from ${JOB_NAME}.${BUILD_NUMBER}
	544	```
19f0bd	545
A	546	* Check `Create New Tag` and set `Target remote name` to `origin`
c3a934	547	![git-publisher](../images/exercise2/git-publisher.png)
D	548
19f0bd	549	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`.
c3a934	550	* Set the project to build to be `dev-todolist-fe-bake`
D	551	* Set the condition to be `Stable or unstable but not failed`.
	552	* Click Add Parameters dropdown and select Predefined parameters.
	553	* In the box, insert our BUILD_TAG as follows
	554	```bash
	555	BUILD_TAG=${JOB_NAME}.${BUILD_NUMBER}
	556	```
	557	![param-trigger](../images/exercise2/param-trigger.png)
	558	<p class="tip">
eaf747	559	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.
c3a934	560	</p>
D	561
dd060d	562	5. Hit `save` which will take you to the job overview page - and that's it; our build phase is complete!
c3a934	563
752f2a	564	#### 4b - Bake
40ab32	565
dd060d	566	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`.
c3a934	567
19f0bd	568	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.
eaf747	569	* Add string parameter type
19f0bd	570	* set the Name to `BUILD_TAG`. This will be available to the job as an Enviroment Variable.
eaf747	571	* You can set `dev-todolist-fe-build.` as the default value for ease when triggering manually.
D	572	* 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`
363974	573	<p class="tip">
A	574	NOTE - Don't forget to include the `.` after `dev-todolist-fe-build` in the Default Value box.
	575	</p>
	576
eaf747	577	![param-trigger-bake](../images/exercise2/param-trigger-bake.png)
0f4d08	578
dd060d	579	5. This time set the `Restrict where this project can be run` label to `master`.
eaf747	580	<p class="tip">
363974	581	NOTE - `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.
eaf747	582	</p>
D	583
dd060d	584	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`
eaf747	585
dd060d	586	5. Scroll down to the Build Environment tab and select the `Color ANSI Console Output` checkbox ![delete-ansi](../images/exercise2/delete-ansi.png)
eaf747	587
dd060d	588	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:
19f0bd	589	Remember to replace `<YOUR_NAME>` accordingly.
eaf747	590	```bash
D	591	#!/bin/bash
35ca14	592	curl -v -f \
D	593	http://admin:admin123@${NEXUS_SERVICE_HOST}:${NEXUS_SERVICE_PORT}/repository/zip/com/redhat/todolist/${BUILD_TAG}/package-contents.zip \
	594	-o package-contents.zip
eaf747	595	unzip package-contents.zip
8a47e6	596	oc project <YOUR_NAME>-ci-cd
eaf747	597	NAME=todolist-fe
62d4b9	598	oc patch bc ${NAME} -p "{\"spec\":{\"output\":{\"to\":{\"kind\":\"ImageStreamTag\",\"name\":\"${NAME}:${BUILD_TAG}\"}}}}"
eaf747	599	oc start-build ${NAME} --from-dir=package-contents/ --follow
D	600	```
	601	![bake-step](../images/exercise2/bake-step.png)
	602
dd060d	603	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`.
eaf747	604	* Set the project to build to be `dev-todolist-fe-deploy`
D	605	* Set the condition to be `Stable`.
ac41ef	606	* Click Add Parameters dropdown and select `Current build parameters`. This will pass the `${BUILD_TAG}` to the downstream job which we will create next.
eaf747	607	![downstream-trigger-deploy](../images/exercise2/downstream-trigger-deploy.png)
D	608
dd060d	609	5. Hit save! That's our bake phase done! Finally; on to our deploy
eaf747	610
752f2a	611	#### 4c - Deploy
40ab32	612
19f0bd	613	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`.
dd060d	614	![copy-from](../images/exercise2/copy-from.png)
D	615
19f0bd	616	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.
dd060d	617	```bash
D	618	#!/bin/bash
	619	set -o xtrace
	620	# VARS
19f0bd	621	PIPELINES_NAMESPACE=<YOUR_NAME>-ci-cd
A	622	NAMESPACE=<YOUR_NAME>-dev
dd060d	623	NAME=todolist-fe
D	624	oc project ${NAMESPACE}
	625	oc tag ${PIPELINES_NAMESPACE}/${NAME}:${BUILD_TAG} ${NAMESPACE}/${NAME}:${BUILD_TAG}
	626	oc set env dc ${NAME} NODE_ENV=dev
	627	oc set image dc/${NAME} ${NAME}=docker-registry.default.svc:5000/${NAMESPACE}/${NAME}:${BUILD_TAG}
	628	oc rollout latest dc/${NAME}
	629	```
	630	![deploy-step](../images/exercise2/deploy-step.png)
	631
ac41ef	632	5. When a deployment has completed; OpenShift can verify it's success. Add another step by clicking the `Add build Step` on the Build tab then `Verify OpenShift Deployment` including the following:
dd060d	633	* Set the Project to your `<YOUR_NAME>-dev`
D	634	* Set the DeploymentConfig to your app's name `todolist-fe`
	635	* Set the replica count to `1`
	636	![verify-deployment](../images/exercise2/verify-deployment.png)
	637
	638	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!
	639
752f2a	640	#### 4d - Pipeline
40ab32	641
ac41ef	642	5. With our Jenkins setup in place; now move to our `todolist-fe` app's source code. We have to add our configuration to the frontend to tell it where the API layer will be hosted. Open the source in your favourite editor and navigate to `src/config/dev.js`.
D	643
45eb81	644	5. Update `<YOUR_NAME>` accordingly with the route where the Todo List API will live when it is deployed. The correct full URL can also be found on the OpenShift Console; if you copy it from there remember to append `/api/todos` to the URL. For example:
40ab32	645	![fe-dev-config](../images/exercise2/fe-dev-config.png)
D	646
45eb81	647	5. Repeat this for `src/config/test.js` file. If you copy the URL from the previous step; change `dev` to `test`.
D	648	For example:
	649	![fe-test-config](../images/exercise2/fe-test-config.png)
	650
c9032c	651	5. With the config in place; commit your changes and push them to GitLab:
40ab32	652	```bash
ad8436	653	git add .
D	654	```
	655	```bash
	656	git commit -m "ADD config for api"
	657	```
	658	```bash
	659	git push
40ab32	660	```
D	661
8a47e6	662	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.
D	663	![add-view](../images/exercise2/add-view.png)
	664
	665	5. On the view that loads; Give the new view a sensible name like `dev-todolist-fe-pipeline` and select Build Pipeline
	666	![new-pipeline](../images/exercise2/new-pipeline.png)
dd060d	667
D	668	5. Set the Pipeline Flow's Inital Job to `dev-todolist-fe-build` and save.
	669	![pipeline-flow](../images/exercise2/pipeline-flow.png)
	670
8a47e6	671	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).
204a7b	672	![dev-pipeline-view](../images/exercise2/dev-pipeline-view.jpeg)
dd060d	673
35ca14	674	6. To check the deployment in OpenShift; open the web console and go to your `dev` namespace. You should see the deployment was successful; hit the URL to open the app (the screenshot below has both apps deployed).
8a47e6	675	![ocp-deployment](../images/exercise2/ocp-deployment.png)
D	676
35ca14	677	6. If it has been a success we should see our dummyData. This is because there is no backend deployed, in later labs we will deploy the backend and the mongodb for persistence but to do this we will use Jenkins Pipeline as code.
436657	678	![no-backend-app](../images/exercise2/no-backend-app.png)
0f4d08	679
45eb81	680	### Part 6 - (Optional) GitLab Webhooks
b770c6	681	> _In this exercise we will link GitLab to Jenkins so that new build jobs are triggered on each push to the `develop` branch._
13e8fd	682
b770c6	683	<p class="tip" >
570732	684	NOTE - This section is optional! Git webhooks are useful but not needed for Enablement completion.
b770c6	685	</p>
D	686
1937a3	687	7. In order to allow GitLab trigger Jenkins (because of the OpenShift Auth Plugin), we need to allow the `Anonymous` 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:
f50a94	688	![jenkins-global-security](../images/exercise2/jenkins-global-security.png)
A	689
	690	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`.
	691	![jenkins-anon-permissions](../images/exercise2/jenkins-anon-permissions.png)
	692
30f5d9	693	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`. Remember to Save and Apply this change.
c50c7b	694	![jenkins-build-triggers-gitlab](../images/exercise2/jenkins-build-triggers-gitlab.png)
13e8fd	695
db60b7	696	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`)
c50c7b	697	![gitlab-integrations](../images/exercise2/gitlab-integrations.png)
13e8fd	698
c50c7b	699	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	700	![gitlab-integrations-details](../images/exercise2/gitlab-integrations-details.png)
13e8fd	701
c50c7b	702	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	703	![gitlab-integrations-details](../images/exercise2/gitlab-webhook-test.png)
13e8fd	704
c50c7b	705	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.
13e8fd	706
30f5d9	707	7. All that's left to do is to repeat the same steps for `todolist-api` (Starting from step 3):
c50c7b	708	Create Build Trigger:
db60b7	709	`https://jenkins-<YOUR_NAME>-ci-cd.apps.some.domain.com/job/dev-todolist-api-build/configure`
c50c7b	710	Create GitLab Integration:
db60b7	711	`https://gitlab-<YOUR_NAME>-ci-cd.apps.some.domain.com/donal/todolist-api/settings/integrations`
c50c7b	712	Check your build status and you should see something like this. With `Started by Gitlab push by <YOUR_NAME>`:
A	713	![jenkins-gitlab-webhook-success](../images/exercise2/jenkins-gitlab-webhook-success.png)
13e8fd	714
c50c7b	715	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.
b770c6	716
5a16fd	717	_____
D	718
0f4d08	719	## Extension Tasks
a4f42c	720	> _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._
0f4d08	721
436657	722	- Pipeline Tasks
f9e311	723	* Add pipeline for `master` branch for each project. Use `test-` instead of `dev-` across all config and names in the pipeline
A	724	* Do the `.openshift-applier` steps as part of the pipeline for greater end to end automation.
c3a934	725	- Promote build
f9e311	726	* Create a _promote-to-uat_ phase after the `master` branch deploy
a4f42c	727	* Create a `uat` env using the OpenShift Applier as seen before
c3a934	728	* Tag and promote the image without rebuilding after the `test-**-deploy`
261f19	729	- MongoDB tasks
c3a934	730	* Add MongoDB Stateful set for the UAT environment (or test)
D	731	* Inject MongoDB config into the NodeJS app using config map & secrets.
a4f42c	732	* Improve the security of the DB by making the user /passwords randomly generated
c3a934	733	- Setup Nexus as an `npm` mirror registry and use it in the builds to speed up the build time
0f4d08	734
D	735	## Additional Reading
5a16fd	736	> List of links or other reading that might be of use / reference for the exercise
f2b1b4	737
5a16fd	738	## Slide links
9eed0b	739
4f0295	740	- [Intro](https://docs.google.com/presentation/d/1t1CONuy-_IRPZYmU010Qgk2rshiDJTennvLyQR8GllE)
RH	741	- [Wrap-up](https://docs.google.com/presentation/d/1kZ8SV6iJnrKk_AqPpyPuNZifv7VzItHOB9HYdOnNJjI)
3207b9	742	- [All Material](https://drive.google.com/drive/folders/1lf66ks2tT0eQ4A9RSU48u0ZhvBXzoHWJ)