From 1c9328772a4dbbd85fe5a91f9f83d92f63955114 Mon Sep 17 00:00:00 2001
From: donal <donalspring@gmail.com>
Date: Fri, 06 Apr 2018 23:09:45 +0200
Subject: [PATCH] WIP - Jenkins and s2i, bit of a refactor too
---
images/exercise1/ci-cd-deployments-yml.png | 0
custom.css | 7 +
images/exercise1/ci-cd-project-namespace.png | 0
images/exercise1/gitlab-new-project.png | 0
images/exercise1/new-item.png | 0
images/exercise1/green-balls.png | 0
README.md | 4
/dev/null | 0
images/exercise1/nexus-up-and-running.png | 0
1-the-manual-menace/README.md | 204 +++++++++++++++++++++++++++++++++++++++++---------
images/exercise1/play-book-success.png | 0
index.html | 5 +
images/exercise1/project-request-yml.png | 0
images/exercise1/gitlab-ui.png | 0
images/exercise1/gitlab-up-and-running.png | 0
15 files changed, 180 insertions(+), 40 deletions(-)
diff --git a/1-the-manual-menace/README.md b/1-the-manual-menace/README.md
index 5effa74..e7f4578 100644
--- a/1-the-manual-menace/README.md
+++ b/1-the-manual-menace/README.md
@@ -79,26 +79,26 @@
Open the `inventory/group_vars/all.yml` file; you should see a 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
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.
-
+
3. Create another two params files for `params/project-requests-dev` & `params/project-requests-test` and add the `NAMESPACE=<YOUR_NAME>-dev` && `NAMESPACE=<YOUR_NAME>-test` and update their Display names.
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 eg
```yaml
- - name: <YOUR_NAME>-dev
- template: "{{ inventory_dir }}/../templates/project-requests.yml"
- template_action: create
- params: "{{ inventory_dir }}/../params/project-requests-dev"
- tags:
- - projects
- - name: <YOUR_NAME>-test
- template: "{{ inventory_dir }}/../templates/project-requests.yml"
- template_action: create
- params: "{{ inventory_dir }}/../params/project-requests-test"
- tags:
- - projects
+ - name: <YOUR_NAME>-dev
+ template: "{{ inventory_dir }}/../templates/project-requests.yml"
+ template_action: create
+ params: "{{ inventory_dir }}/../params/project-requests-dev"
+ tags:
+ - projects
+ - name: <YOUR_NAME>-test
+ template: "{{ inventory_dir }}/../templates/project-requests.yml"
+ template_action: create
+ params: "{{ inventory_dir }}/../params/project-requests-test"
+ tags:
+ - projects
```
-
+
3. With the configuration in place; install the OpenShift Applier dependency
```bash
@@ -111,7 +111,7 @@
$ ansible-playbook roles/openshift-applier/playbooks/openshift-cluster-seed.yml -i inventory/
```
-3. Once successful you should see an output similar to this 
+3. Once successful you should see an output similar to this 
### Part 2 - Nexus and GitLab
> _Now that we have our Projects setup; we can start to populate them with Apps to be used in our dev lifecycle_
@@ -133,28 +133,28 @@
MEMORY_LIMIT=2Gi
```
-4. Create a new object in the inventory variables called `ci-cd-tools` and populate it's `content` is as follows (swapping `<YOUR_NAME>-ci-cd` for the namespace you created earlier)
+4. Create a new object in the inventory variables called `ci-cd-deployments` and populate it's `content` is as follows (swapping `<YOUR_NAME>-ci-cd` for the namespace you created earlier)
```yaml
-- object: ci-cd-tools
- content:
- - name: "nexus"
- namespace: "<YOUR_NAME>-ci-cd"
- template: "{{ inventory_dir }}/../templates/nexus.yml"
- params: "{{ inventory_dir }}/../params/nexus"
- tags:
- - nexus
+ - object: ci-cd-deployments
+ content:
+ - name: "nexus"
+ namespace: "<YOUR_NAME>-ci-cd"
+ template: "{{ inventory_dir }}/../templates/nexus.yml"
+ params: "{{ inventory_dir }}/../params/nexus"
+ tags:
+ - nexus
```
-
+
4. Run the OpenShift applier, specifying the tag `nexus` to speed up it's execution.
```bash
$ ansible-playbook roles/openshift-applier/playbooks/openshift-cluster-seed.yml \
-i inventory/ \
- -e="filter_tags=nexus"
+ -e "filter_tags=nexus"
```
-4. Once successful; login to the cluster and navigate to the `<YOUR_NAME>-ci-cd`. You should see Nexus up and running. You can login with default credentials (admin / admin123) 
+4. Once successful; login to the cluster and navigate to the `<YOUR_NAME>-ci-cd`. You should see Nexus up and running. You can login with default credentials (admin / admin123) 
4. Now lets do the same thing for GitLab to get it up and running. Checkout the template provided by running
```bash
@@ -195,35 +195,159 @@
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
```yaml
- - name: "gitlab"
- namespace: "<YOUR_NAME>-ci-cd"
- template: "{{ inventory_dir }}/../templates/gitlab.yml"
- params: "{{ inventory_dir }}/../params/gitlab"
- tags:
- - gitlab
+ - name: "gitlab"
+ namespace: "<YOUR_NAME>-ci-cd"
+ template: "{{ inventory_dir }}/../templates/gitlab.yml"
+ params: "{{ inventory_dir }}/../params/gitlab"
+ tags:
+ - gitlab
```
4. Run the OpenShift applier, specifying the tag `gitlab` to speed up it's execution.
```bash
$ ansible-playbook roles/openshift-applier/playbooks/openshift-cluster-seed.yml \
-i inventory/ \
- -e="filter_tags=gitlab"
+ -e "filter_tags=gitlab"
```
-4. Once successful; login to the cluster and navigate to the `<YOUR_NAME>-ci-cd`. You should see GitLab up and running. 
+4. Once successful; login to the cluster and navigate to the `<YOUR_NAME>-ci-cd`. You should see GitLab up and running. 
4. Navigate to gitlab. You can login with using your cluster credentials using the LDAP tab displaying your `<LDAP_DESCRIPTION>` from previous steps
-
+
+4. Once logged in create a new project called `enablement-ci-cd` and mark it as public. Once created; copy out the `git remote add origin ...` instructions for use on the next step.
+
+<p class="tip">
+Note - we would not normally make the project public here on residency but are for simplicity of the exercise
+</p>
+
+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
+```bash
+$ git remote remove origin
+$ git remote add origin <YOUR_NEW_GIT_PROJECT>
+$ git add .
+$ git commit -m "Adding git and nexus config"
+$ git push -u origin --all
+```
### Part 3 - Jenkins & s2i
-5. Add new plugin ...
+5. Add the Jenkins Build & Deployment configs to the `enablement-ci-cd` repo by merging the contents `exercise1/jenkins` in
+```bash
+$ git checkout exercise1/jenkins templates/jenkins.yml
+```
-### Part 4 - live, die repeat
+5. Add the Jenkins Build & Deployment configs to the `enablement-ci-cd` repo by merging the contents `exercise1/jenkins` in
+```bash
+$ git checkout exercise1/jenkins templates/jenkins.yml
+```
+The Jenkins template is essentially the standard persistent jenkins one with OpenShift.
+
+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.
+```bash
+MEMORY_LIMIT=8Gi
+VOLUME_CAPACITY=5Gi
+JVM_ARCH=x86_64
+NAMESPACE=<YOUR_NAME>-ci-cd
+JENKINS_OPTS=--sessionTimeout=720
+```
+5. Add a `jenkins` variable to the ansible inventory underneath the git and nexus ones. Remember to replace `<YOUR_NAME>` with the appropriate value.
+```yaml
+ - name: "jenkins"
+ namespace: "<YOUR_NAME>-ci-cd"
+ template: "{{ inventory_dir }}/../templates/jenkins.yml"
+ params: "{{ inventory_dir }}/../params/jenkins"
+ tags:
+ - jenkins
+```
+This configuration if applied now; it will create the deployment configuration needed for Jenkins but the `${NAMESPACE}:${JENKINS_IMAGE_STREAM_TAG}` in the template won't exist yet.
+
+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
+```bash
+$ git checkout exercise1/jenkins-s2i jenkins-s2i
+```
+The structure of the jenkins s2i config is
+```
+jenkins-s2i
+��������� README.md
+��������� configuration
+������� ��������� build-failure-analyzer.xml
+������� ��������� init.groovy
+������� ��������� jenkins.plugins.slack.SlackNotifier.xml
+������� ��������� jobs
+������� ��������� seed-multibranch-job
+������� ��������� config.xml
+��������� plugins.txt
+```
+ * `plugins.txt` is a list of `pluginId:version` for Jenkins to pre-install when starting
+ * `./configuration` contains content that is placed in `${JENKINS_HOME}`. A `config.xml` could be placed in here to control the bulk of Jenkins configuration.
+ * `./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.
+ * `build-failure-analyzer.xml` is config for the plugin to read the logs and look for key items based on a Regex
+ * `init.groovy` contains a collection of settings jenkins configures itself with when launching
+
+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
+```txt
+greenballs:1.15
+```
+
+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/)
+
+5. Before building and deploying Jenkins; add git credentials to the s2i by either adding them to the `template/jenkins.yml` and `params/jenkins` or for simplicity just replace the `<USERNAME>` && `<PASSWORD>` with your ldap credentials.
+<p class="tip">
+Note in a residency we would not use your GitCredentials for pushing and pulling from Git, A service user would be created here.
+</p>
+```groovy
+gitUsername = System.getenv("GIT_USERNAME") ?: "<USERNAME>"
+gitPassword = System.getenv("GIT_PASSWORD") ?: "<PASSWORD>"
+```
+
+5. Add a new params file in the `params` folder called `jenkins-s2i`
+```bash
+$ touch params/jenkins-s2i
+```
+
+5. Open the `params/jenkins-s2i` file and add the following content; replacing variables as appropriate
+```
+SOURCE_REPOSITORY_URL=<YOUR_ENABLEMENT_REPO>
+NAME=jenkins
+SOURCE_REPOSITORY_CONTEXT_DIR=jenkins-s2i
+IMAGE_STREAM_NAMESPACE=<YOUR_NAME>-ci-cd
+```
+where
+ * `<YOUR_ENABLEMENT_REPO>` is the full path clone path of the repo where this project is stored (including the https && .git)
+ * `<YOUR_NAME>` is the prefix for your `-ci-cd` project.
+ * Explore some of the other parameters in `templates/jenkins-s2i.yml`
+
+5. Create a new object `ci-cd-builds` in the ansible `all.yml` to drive the s2i build configuration.
+```yaml
+ - object: ci-cd-builds
+ content:
+ - name: "jenkins-s2i"
+ namespace: "<YOUR_NAME>-ci-cd"
+ template: "{{ inventory_dir }}/../templates/jenkins-s2i.yml"
+ params: "{{ inventory_dir }}/../params/jenkins-s2i"
+ tags:
+ - jenkins
+```
+
+5. Commit your code to your GitLab instance
+```bash
+$ git add .
+$ git commit -m "Adding Jenkins and Jenkins s2i"
+$ git push
+```
+
+5. When your code is commited; run the OpenShift Applier to add the config to the cluster
+```bash
+$ ansible-playbook roles/openshift-applier/playbooks/openshift-cluster-seed.yml \
+ -i inventory/ \
+ -e "filter_tags=jenkins"
+```
+
+### Part 4 - Live, Die, Repeat
6. Commit your code to the new repo in GitLab
-6. Burn your OCP content to the ground
+6. Burn your OCP content to the ground
6. Re-apply the inventory!
@@ -233,6 +357,8 @@
> 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.
- Add more secure access for Nexus (ie not admin / admin123) using the automation to drive secret creation
+ - Add a SonarQube persistent deployment to the `ci-cd-deployments` section.
+ - Add `jenkins.plugins.slack.SlackNotifier.xml` to `jenkins-s2i/configuration` to include URL of Slack for team build notifications and rebuild Jenkins S2I
_____
diff --git a/README.md b/README.md
index 0e037bb..8b2c3ea 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,14 @@
# Enablement Material
-## Pre-requisites
+## Learner pre-requisites
- OCP CLI <version> installed
- Ansible <version> installed
- NodeJS <version>
- Git Installed
- Access to cluster `oc login -u <username> -p <password> <cluster_url>`
+> Or Download the tools-container containing most of these (TODO)
+
______
## Day 1 Content
diff --git a/custom.css b/custom.css
new file mode 100644
index 0000000..50cd171
--- /dev/null
+++ b/custom.css
@@ -0,0 +1,7 @@
+p.tip {
+ border-left-color: #f66;
+}
+p.tip:before {
+ content: "!";
+ background-color: #f66;
+}
diff --git a/images/ci-cd-tools-yml.png b/images/ci-cd-tools-yml.png
deleted file mode 100644
index ba0d714..0000000
--- a/images/ci-cd-tools-yml.png
+++ /dev/null
Binary files differ
diff --git a/images/exercise1/ci-cd-deployments-yml.png b/images/exercise1/ci-cd-deployments-yml.png
new file mode 100644
index 0000000..446c7b8
--- /dev/null
+++ b/images/exercise1/ci-cd-deployments-yml.png
Binary files differ
diff --git a/images/ci-cd-project-namespace.png b/images/exercise1/ci-cd-project-namespace.png
similarity index 100%
rename from images/ci-cd-project-namespace.png
rename to images/exercise1/ci-cd-project-namespace.png
Binary files differ
diff --git a/images/exercise1/gitlab-new-project.png b/images/exercise1/gitlab-new-project.png
new file mode 100644
index 0000000..dfefdb1
--- /dev/null
+++ b/images/exercise1/gitlab-new-project.png
Binary files differ
diff --git a/images/gitlab-ui.png b/images/exercise1/gitlab-ui.png
similarity index 100%
rename from images/gitlab-ui.png
rename to images/exercise1/gitlab-ui.png
Binary files differ
diff --git a/images/gitlab-up-and-running.png b/images/exercise1/gitlab-up-and-running.png
similarity index 100%
rename from images/gitlab-up-and-running.png
rename to images/exercise1/gitlab-up-and-running.png
Binary files differ
diff --git a/images/exercise1/green-balls.png b/images/exercise1/green-balls.png
new file mode 100644
index 0000000..d5bc6e5
--- /dev/null
+++ b/images/exercise1/green-balls.png
Binary files differ
diff --git a/images/new-item.png b/images/exercise1/new-item.png
similarity index 100%
rename from images/new-item.png
rename to images/exercise1/new-item.png
Binary files differ
diff --git a/images/nexus-up-and-running.png b/images/exercise1/nexus-up-and-running.png
similarity index 100%
rename from images/nexus-up-and-running.png
rename to images/exercise1/nexus-up-and-running.png
Binary files differ
diff --git a/images/play-book-success.png b/images/exercise1/play-book-success.png
similarity index 100%
rename from images/play-book-success.png
rename to images/exercise1/play-book-success.png
Binary files differ
diff --git a/images/project-request-yml.png b/images/exercise1/project-request-yml.png
similarity index 100%
rename from images/project-request-yml.png
rename to images/exercise1/project-request-yml.png
Binary files differ
diff --git a/index.html b/index.html
index 5b0d615..a7ad528 100644
--- a/index.html
+++ b/index.html
@@ -7,6 +7,7 @@
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css">
+ <link rel="stylesheet" href="./custom.css">
</head>
<body>
<div id="app"></div>
@@ -18,5 +19,9 @@
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+ <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
+ <script src="//unpkg.com/prismjs/components/prism-javascript.min.js"></script>
+ <script src="//unpkg.com/prismjs/components/prism-groovy.min.js"></script>
+ <script src="//unpkg.com/prismjs/components/prism-yaml.min.js"></script>
</body>
</html>
--
Gitblit v1.9.3