acammies
2018-04-11 e90e9c00de9d3592889df0181e78c5d38c0acfd3
commit | author | age
5d0992 1 # The Manual Menace
c951f7 2
5d0992 3 > In this lab learners will use Ansible to drive automated provisioning of Projects, Access Control, Git, Jenkins and Nexus
D 4
5 _____
c951f7 6
D 7 ## Learning Outcomes
8 As a learner you will be able to
5d0992 9
D 10 1. Run the OpenShift Applier to automate creating cluster content
11 1. Create and admin project namespaces in OpenShift
12 1. Deploy commonly used applications to support the development process
c951f7 13
D 14 ## Tools and Frameworks
15
5d0992 16 * [GitLab](https://about.gitlab.com/) - Community driven Git server now with integrated DevOps Toolchain.
D 17 * [Nexus](https://www.sonatype.com/nexus-repository-sonatype) - Repository manager for storing lots of application types. Can also host `npm` and `Docker` registries.
18 * [Jenkins](https://jenkins.io/) - OpenSource Build automation server. Highly customisable with plugins.
19 * [Ansible](https://www.ansible.com/) - IT Automation tool used to provision and manage state of cloud and physical infrastructure.
20 * [OpenShift Applier](https://github.com/redhat-cop/openshift-applier) - Community driven Git server
c951f7 21
5d0992 22 ## Big Picture
D 23 This exercise begins with an empty Cluster
24 > TODO - add big picture here...
25
26 _____
c951f7 27
D 28 ## 10,000 Ft View
5d0992 29 > This lab is aimed at the creation of the tooling that will be used to support the rest of the Exercises. The highlevel goal is to create a collection of project namespaces and populate them with Git, Jenkins & Nexus.
D 30
31 If you're feeling confident and don't want to follow the step-by-step guide these highlevel instructions should provide a challenge for you:
32
3b1c96 33 2. Clone the repo `https://github.com/rht-labs/enablement-ci-cd` which contains the scaffold of the project.
3558ae 34
5d0992 35 2. Create `<your-name>-ci-cd`, `<your-name>-dev` and `<your-name>-test` project namespaces using the inventory and run them with the OpenShift Applier to populate the cluster
3558ae 36
D 37 2. Use the templates provided to create build and deployment configs in `<your-name>-ci-cd` for. Templates are on a branch called `exercise1/git-nexus` && `exercise1/jenkins`:
5d0992 38     * Nexus
D 39     * GitLab
3558ae 40     * Jenkins (using an s2i to pre-configure jenkins)
D 41
5d0992 42 2. Commit your `enablement-ci-cd` repository to the GitLab Instance you've created
3558ae 43
D 44 2. Burn it all down and re-apply your inventory proving config-as-code works. 
c951f7 45
D 46 ## Step by Step Instructions
bc2e43 47 > This is a structured guide with references to exact filenames and explanations.
c951f7 48
bc2e43 49 ### Part 1 - Create OpenShift Projects
de8ebb 50 > _Using the OpenShift Applier, we will add new project namespaces to the cluster which will be used throughout the exercise._
D 51
e7c877 52 3. Clone the scaffold project to your local machine and pull all remote branches for use in later labs. Open the repo in your favourite editor.
bc2e43 53 ```bash
e7c877 54 $ git clone https://github.com/rht-labs/enablement-ci-cd && cd enablement-ci-cd
RH 55 ```
56 Followed by;
57 ```
58 $ for branch in `git branch -a | grep remotes | grep -v HEAD | grep -v master`; do
59    git branch --track ${branch#remotes/origin/} $branch
60 done
c951f7 61 ```
D 62
bc2e43 63 3. The project is laid out as follows
D 64 ```
65 .
66 ├── README.md
67 ├── docker
68 │   └── jenkins-slave-node
69 ├── inventory
70 │   ├── group_vars
71 │   │   └── all.yml
72 │   └── hosts
73 ├── jenkins-s2i
74 │   ├── configuration
75 ├── params
76 │   └── project-requests-ci-cd
77 ├── requirements.yml
78 └── templates
79         └── project-requests.yml
80 ```
81  * `docker` folder contains our jenkins-slave images that will be used by the builds.
82  * `jenkins-s2i` contains the configuration and plugins we want to bring jenkins to life with
83  * `params` houses the variables we will load the templates with
84  * `templates` is a collection of OpenShift templates
85  * `inventory/group_vars/all.yml` is the collection of objects we want to insert into the cluster.
86  * `requirements.yml` is a manifest which contains the ansible modules needed to run the playbook
f79b6f 87 Open the `inventory/group_vars/all.yml` file; you should see some variables setup to create the `ci-cd` namespace. This calls the `templates/project-requests.yml` template with the `params/project-requests-ci-cd` parameters. We will add some additional content here but first let's explore the parameters and the template
bc2e43 88
3558ae 89 3. Open the `params/project-requests-ci-cd` and replace the `<YOUR_NAME or initials>` with your name to create the correstponding projects in the cluster. 
ff1bd7 90 ![new-item](../images/exercise1/ci-cd-project-namespace.png)
bc2e43 91
e7c877 92 3. Create another two params files for `params/project-requests-dev` & `params/project-requests-test`. Add `NAMESPACE=<YOUR_NAME>-dev` & `NAMESPACE_DISPLAY_NAME=<YOUR-NAME> Dev` to `params/project-requests-dev`. Add `NAMESPACE=<YOUR_NAME>-test` & `NAMESPACE_DISPLAY_NAME=<YOUR-NAME> Test` to `params/project-requests-test`.
bc2e43 93
f79b6f 94 3. In the `inventory/group_vars/all.yml` file; add the new inventory items for the projects you want to create (dev & test) by adding another object to the content array. You can copy and paste them from the `ci-cd` example and update them accordingly e.g.
bc2e43 95 ```yaml
ff1bd7 96     - name: <YOUR_NAME>-dev
D 97       template: "{{ inventory_dir }}/../templates/project-requests.yml"
98       template_action: create
99       params: "{{ inventory_dir }}/../params/project-requests-dev"
100       tags:
101       - projects
102     - name: <YOUR_NAME>-test
103       template: "{{ inventory_dir }}/../templates/project-requests.yml"
104       template_action: create
105       params: "{{ inventory_dir }}/../params/project-requests-test"
106       tags:
107       - projects
bc2e43 108 ```
ff1bd7 109 ![project-request-yaml](../images/exercise1/project-request-yml.png)
bc2e43 110
D 111 3. With the configuration in place; install the OpenShift Applier dependency
112 ```bash
113 $ ansible-galaxy install -r requirements.yml --roles-path=roles
114 ```
115
f79b6f 116 3. Apply the inventory by logging into OpenShift and running the following: 
bc2e43 117 ```bash
D 118 $ oc login -p <password> -u <user> <cluster_url>
3558ae 119 $ ansible-playbook roles/openshift-applier/playbooks/openshift-cluster-seed.yml -i inventory/
bc2e43 120 ``` 
D 121
f79b6f 122 3. Once successful you should see an output similar to this: ![playbook-success](../images/exercise1/play-book-success.png)
bc2e43 123
D 124 ### Part 2 - Nexus and GitLab
3f16e0 125 > _Now that we have our Projects setup; we can start to populate them with Apps to be used in our dev lifecycle_
bc2e43 126
3558ae 127 4. In the `enablement-ci-cd` repo, checkout the templates for Nexus by running
3f16e0 128 ```bash
3558ae 129 $ git checkout exercise1/git-nexus templates/nexus.yml
D 130 ```
f79b6f 131 The template contains all the things needed to setup a persistent nexus server, exposing a service and route while also creating the persistent volume needed. Have a read through the template; at the bottom you'll see a collection of parameters we will pass to the template.
3558ae 132
D 133 4. Add some parameters for running the template by creating a new file in the `params` directory. 
134 ```bash
135 $ touch params/nexus
3f16e0 136 ```
D 137
3558ae 138 4. The essential params to inclue in this file are: `params` directory. 
D 139 ```bash
140 VOLUME_CAPACITY=5Gi
141 MEMORY_LIMIT=2Gi
142 ```
143
de8ebb 144 4. Create a new object in the inventory variables called `ci-cd-deployments` and populate it's `content` is as follows remembering to swap `<YOUR_NAME>-ci-cd` for the namespace you created previously
3558ae 145 ```yaml
ff1bd7 146   - object: ci-cd-deployments
D 147     content:
148     - name: "nexus"
149       namespace: "<YOUR_NAME>-ci-cd"
150       template: "{{ inventory_dir }}/../templates/nexus.yml"
151       params: "{{ inventory_dir }}/../params/nexus"
152       tags:
153       - nexus
3558ae 154 ```
ff1bd7 155 ![ci-cd-deployments-yml](../images/exercise1/ci-cd-deployments-yml.png)
3558ae 156
D 157 4. Run the OpenShift applier, specifying the tag `nexus` to speed up it's execution.
158 ```bash
159 $ ansible-playbook roles/openshift-applier/playbooks/openshift-cluster-seed.yml \
160      -i inventory/ \
ff1bd7 161      -e "filter_tags=nexus"
3558ae 162 ```
D 163
b47510 164 4. Once successful; login to the cluster through the browser (using cluster URL) and navigate to the `<YOUR_NAME>-ci-cd`. You should see Nexus up and running. You can login with default credentials (admin / admin123) ![nexus-up-and-running](../images/exercise1/nexus-up-and-running.png)
3558ae 165
f79b6f 166 4. Now let's do the same thing for GitLab to get it up and running. Checkout the template and params provided by running
3558ae 167 ```bash
aa106a 168 $ git checkout exercise1/git-nexus templates/gitlab.yml params/gitlab
3558ae 169 ``` 
D 170 Explore the template; it contains the PVC, buildConfig and services. The DeploymentConfig is made up of these apps
171  - Redis (3.2.3)
172  - PostgreSQL (9.4)
173  - GitLab CE (v10.2.3)
174
b47510 175 4. Open the `params/gitlab` file and complete the following params
RH 176 <p class="tip">
177 Note - The values here for the LDAP and BIND credentials will be provided by your tutor.
178 </p>
3558ae 179 ```
D 180 LDAP_BIND_DN=uid=<BIND_USER>,ou=People,dc=<YOUR_DOMAIN>,dc=com
181 LDAP_USER_FILTER=(memberof=CN=YourGroup,OU=Users,DC=<YOUR_DOMAIN>,DC=com)
182 LDAP_PASSWORD=<BIND_USER_PASSWORD>
183 LDAP_HOST=<LDAP_HOST>
184 LDAP_BASE=ou=People,dc=<YOUR_DOMAIN>,dc=com
185 LDAP_LABEL="<LDAP_DESCRIPTION>"
186 GITLAB_ROOT_PASSWORD=<GITLAB_ROOT_USER_PASSWORD>
187 GITLAB_DATA_VOL_SIZE=2Gi
188 POSTGRESQL_VOL_SIZE=1Gi
189 APPLICATION_HOSTNAME=<GITLAB_URL>
c41b51 190 NAMESPACE=<YOUR_NAME>-ci-cd
3558ae 191 ```
D 192 where the following need to be replaced by actual values:
193     * `<BIND_USER>` is the user used to query the LDAP
194     * `<BIND_USER_PASSWORD>` is the password used when querying the LDAP
195     * `<YOUR_DOMAIN>` is the domain the LDAP is hosted on
196     * `<LDAP_HOST>` is fqdn of the LDAP server
197     * `<LDAP_DESCRIPTION>` is the description to be used on the sign-in header for GitLab eg "Name LDAP Login"
198     * `<GITLAB_ROOT_USER_PASSWORD>` is the root user for GOD access on the GitLab instance eg password123
199     * `<GITLAB_URL>` is the endpoint for gitlab. It will take the form `gitlab-<YOUR_NAME>-ci-cd.apps.<ENV_ID>.<YOUR_DOMAIN>.com`
200
201 4. Create another object in the inventory `all_vars.yml` file to run the build & deploy of this template. Add the following and update the `namespace:` accordingly
202 ```yaml
ff1bd7 203     - name: "gitlab"
D 204       namespace: "<YOUR_NAME>-ci-cd"
205       template: "{{ inventory_dir }}/../templates/gitlab.yml"
206       params: "{{ inventory_dir }}/../params/gitlab"
207       tags:
208       - gitlab
3558ae 209 ```
D 210
211 4. Run the OpenShift applier, specifying the tag `gitlab` to speed up it's execution.
212 ```bash
213 $ ansible-playbook roles/openshift-applier/playbooks/openshift-cluster-seed.yml \
214      -i inventory/ \
ff1bd7 215      -e "filter_tags=gitlab"
3558ae 216 ```
D 217
ff1bd7 218 4. Once successful; login to the cluster and navigate to the `<YOUR_NAME>-ci-cd`. You should see GitLab up and running. ![gitlab-up-and-running](../images/exercise1/gitlab-up-and-running.png)
c41b51 219
aa106a 220 4. Navigate to gitlab. You can login using your cluster credentials using the LDAP tab displaying your `<LDAP_DESCRIPTION>` from previous steps
ff1bd7 221 ![gitlab-ui](../images/exercise1/gitlab-ui.png)
c41b51 222
de8ebb 223 4. Once logged in create a new project called `enablement-ci-cd` and mark it as internal. Once created; copy out the `git remote add origin ...` instructions for use on the next step.
ff1bd7 224 ![gitlab-new-project](../images/exercise1/gitlab-new-project.png)
D 225 <p class="tip">
de8ebb 226 Note - we would not normally make the project under your name but create an group and add the project there on residency but for simplicity of the exercise we'll do that here
ff1bd7 227 </p>
D 228
229 4. Commit your local project to this new origin by first removing the existing origin (github) where the the project was cloned from. Remember to substitute `<YOUR_NEW_GIT_PROJECT>` accordingly
230 ```bash
06e3b4 231 $ git remote set-url origin <YOUR_NEW_GIT_PROJECT>
ff1bd7 232 $ git add . 
D 233 $ git commit -m "Adding git and nexus config"
234 $ git push -u origin --all
235 ```
06e3b4 236 **Note - When making changes to enablement-ci-cd you should frequently commit the changes to git.**
bc2e43 237
D 238 ### Part 3 - Jenkins & s2i
de8ebb 239 > _Create a build and deployment config for Jenkins. Add new configuration and plugins to the OCP Stock Jenkins using s2i_
bc2e43 240
ff1bd7 241 5. Add the Jenkins Build & Deployment configs to the `enablement-ci-cd` repo by merging the contents `exercise1/jenkins` in
D 242 ```bash
243 $ git checkout exercise1/jenkins templates/jenkins.yml
244 ```
245 The Jenkins template is essentially the standard persistent jenkins one with OpenShift.
246
247 5. As before; create a new set of params by creating a `params/jenkins` file and adding some overrides to the template and updating the `NAMESPACE` value.
248 ```bash
249 MEMORY_LIMIT=8Gi
250 VOLUME_CAPACITY=5Gi
251 JVM_ARCH=x86_64
252 NAMESPACE=<YOUR_NAME>-ci-cd
253 JENKINS_OPTS=--sessionTimeout=720
254 ```
255 5. Add a `jenkins` variable to the ansible inventory underneath the git and nexus ones. Remember to replace `<YOUR_NAME>` with the appropriate value.
256 ```yaml
257     - name: "jenkins"
258       namespace: "<YOUR_NAME>-ci-cd"
259       template: "{{ inventory_dir }}/../templates/jenkins.yml"
260       params: "{{ inventory_dir }}/../params/jenkins"
261       tags:
262       - jenkins
263 ```
f79b6f 264 This configuration, if applied now, will create the deployment configuration needed for Jenkins but the `${NAMESPACE}:${JENKINS_IMAGE_STREAM_TAG}` in the template won't exist yet.
ff1bd7 265
D 266 5. To create this image we will take the supported OpenShift Jenkins Image and bake into it some extra configuration using an [s2i](https://github.com/openshift/source-to-image) builder image. More information on Jenkins s2i is found on the [openshift/jenkins](https://github.com/openshift/jenkins#installing-using-s2i-build) github page. To create an s2i configuration for jenkins, check out the pre-canned configuration source in the `enablement-ci-cd` repo
267 ```bash
268 $ git checkout exercise1/jenkins-s2i jenkins-s2i
269 ```
270 The structure of the jenkins s2i config is 
271 ```
272 jenkins-s2i
273 ├── README.md
274 ├── configuration
275 │   ├── build-failure-analyzer.xml
276 │   ├── init.groovy
277 │   ├── jenkins.plugins.slack.SlackNotifier.xml
278 │   └── jobs
279 │       └── seed-multibranch-job
280 │           └── config.xml
281 └── plugins.txt
282 ```
283  * `plugins.txt` is a list of `pluginId:version` for Jenkins to pre-install when starting
284  * `./configuration` contains content that is placed in `${JENKINS_HOME}`. A `config.xml` could be placed in here to control the bulk of Jenkins configuration.
285  * `./configuration/jobs/*` contains job names and xml config that jenkins loads when starting. The seed job in there we will return to in later lessons.
de8ebb 286  * `build-failure-analyzer.xml` is config for the plugin to read the logs and look for key items based on a Regex. More on this in later lessons.
ff1bd7 287  * `init.groovy` contains a collection of settings jenkins configures itself with when launching
D 288
289 5. Let's add a plugin for Jenkins to be started with, [green-balls](https://plugins.jenkins.io/greenballs). This simply changes the default `SUCCESS` status of Jenkins from Blue to Green. Append the `plugins.txt` file with 
290 ```txt
291 greenballs:1.15
292 ``` 
293 ![green-balls.png](../images/exercise1/green-balls.png)
294 Why does Jenkins have Blue Balls? More can be found [on reddit](https://www.reddit.com/r/programming/comments/4lu6q8/why_does_jenkins_have_blue_balls/) or the [jenkins blog](https://jenkins.io/blog/2012/03/13/why-does-jenkins-have-blue-balls/)
295
06e3b4 296 5. Before building and deploying the Jenkins s2i; add git credentials to it. These will be used by Jenkins to access the Git Repositories where our apps will be stored. We want Jenkins to be able to push tags to it so write access is required. There are a few ways we can do this; either adding them to the `template/jenkins.yml` as environment Variables and then including them in the `params/jenkins` file.  We could also create a token in GitLab and use it as the source secret in the jenkins template. 
RH 297 But for simplicity just replace the `<USERNAME>` && `<PASSWORD>` in the `jenkins-s2i/configuration/init.groovy` with your ldap credentials as seen below. This init file gets run when Jenkins launches and will setup the credentials for use in our Jobs in the next exercises
ff1bd7 298 <p class="tip">
de8ebb 299 Note in a residency we would not use your GitCredentials for pushing and pulling from Git, A service user would be created for this.
ff1bd7 300 </p>
D 301 ```groovy
302 gitUsername = System.getenv("GIT_USERNAME") ?: "<USERNAME>"
303 gitPassword = System.getenv("GIT_PASSWORD") ?: "<PASSWORD>"
304 ```
305
de8ebb 306 5. Open the `params/jenkins-s2i` file and add the following content; replacing variables as appropriate. 
ff1bd7 307 ```
D 308 SOURCE_REPOSITORY_URL=<YOUR_ENABLEMENT_REPO>
309 NAME=jenkins
310 SOURCE_REPOSITORY_CONTEXT_DIR=jenkins-s2i
311 IMAGE_STREAM_NAMESPACE=<YOUR_NAME>-ci-cd
06e3b4 312 SOURCE_REPOSITORY_USERNAME=<BASE64_YOUR_LDAP_USERNAME>
RH 313 SOURCE_REPOSITORY_PASSWORD=<BASE64_YOUR_LDAP_PASSWORD>
ff1bd7 314 ```
D 315 where 
de8ebb 316     * `<YOUR_ENABLEMENT_REPO>` is the full path clone path of the repo where this project is stored (including the https && .git)
D 317     * `<YOUR_NAME>` is the prefix for your `-ci-cd` project.
318     * Explore some of the other parameters in `templates/jenkins-s2i.yml`
06e3b4 319     * `<BASE64_YOUR_LDAP_USERNAME>` is the base64encoded username builder pod will use to login and clone the repo with
RH 320     * `<BASE64_YOUR_LDAP_PASSWORD>` is the base64encoded password the builder pod will use to authenticate and clone the repo using
f79b6f 321 You can use `echo -n '<YOUR_LDAP_PASSWORD>' | openssl base64` to encode your username and password accordingly. For example 'password' base64 encoded will look like `cGFzc3dvcmQ=`.
de8ebb 322 <p class="tip">
D 323 Note in a residency we would not use your GitCredentials for pushing and pulling from Git, A service user would be created for this.
324 </p>
ff1bd7 325
D 326 5. Create a new object `ci-cd-builds` in the ansible `all.yml` to drive the s2i build configuration.
327 ```yaml
328   - object: ci-cd-builds
329     content:
330     - name: "jenkins-s2i"
331       namespace: "<YOUR_NAME>-ci-cd"
332       template: "{{ inventory_dir }}/../templates/jenkins-s2i.yml"
333       params: "{{ inventory_dir }}/../params/jenkins-s2i"
334       tags:
335       - jenkins
336 ```
337
338 5. Commit your code to your GitLab instance
339 ```bash
de8ebb 340 $ git add .
ff1bd7 341 $ git commit -m "Adding Jenkins and Jenkins s2i"
D 342 $ git push
343 ```
344
345 5. When your code is commited; run the OpenShift Applier to add the config to the cluster
346 ```bash
347 $ ansible-playbook roles/openshift-applier/playbooks/openshift-cluster-seed.yml \
348      -i inventory/ \
349      -e "filter_tags=jenkins"
350 ```
351
de8ebb 352 5. This will trigger a build of the s2i and when it's complete it will add an imagestream of `<YOUR_NAME>-ci-cd/jenkins:latest` to the project. The Deployment config should kick in and deploy the image once it arrives. You can follow the build of the s2i by going to the OpenShift console's project
D 353 ![jenkins-s2i-log](../images/exercise1/jenkins-s2i-log.png)
bc2e43 354
de8ebb 355 5. When the Jenkins deployment has completed; login (using your openshift credentials) and accept the role permissions. You should now see a fairly empty Jenkins with just the seed job
3558ae 356
de8ebb 357 ### Part 4 - Jenkins Hello World 
D 358 > _To test things are working end-to-end; create a hello world job that doesn't do much but proves we can pull code from git and that our balls are green._
359
360 6. Log in to Jenkins and hit `New Item` ![new-item](../images/exercise1/new-item.png).
361
e90e9c 362 6. Create a freestyle job called `hello-world` ![jenkins-new-hello-world](../images/exercise1/jenkins-new-hello-world.png).
de8ebb 363
f79b6f 364 6. On the Source Code Management tab; add your `enablement-ci-cd` git repo and hit the dropdown to add your credentials we baked into the s2i on previous steps ![jenkins-scm-git](../images/exercise1/jenkins-scm-git.png)
de8ebb 365
D 366 6. On the build tab add an Execute Shell step and fill it with `echo "Hello World"` ![jenkins-hello-world](../images/exercise1/jenkins-hello-world.png).
367
368 6. Run the build and we should see if pass succesfully and with Green Balls! ![jenkins-green-balls](../images/exercise1/jenkins-green-balls.png)
369
370 ### Part 5 - Live, Die, Repeat
371 > _TOOD - improve & flesh out this section ...._
372
373 7. Commit your code to the new repo in GitLab
374
375 7. Burn your OCP content to the ground
376
377 7. Re-apply the inventory!
c951f7 378
5d0992 379 _____
D 380
c951f7 381 ## Extension Tasks
de8ebb 382 > _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._
c951f7 383
3558ae 384  - Add more secure access for Nexus (ie not admin / admin123) using the automation to drive secret creation
ff1bd7 385  - Add a SonarQube persistent deployment to the `ci-cd-deployments` section.
D 386  - Add `jenkins.plugins.slack.SlackNotifier.xml` to `jenkins-s2i/configuration` to include URL of Slack for team build notifications and rebuild Jenkins S2I
c951f7 387
5d0992 388 _____
D 389
c951f7 390 ## Additional Reading
D 391  > List of links or other reading that might be of use / reference for the exercise