The kubernetes-ci-cd project is Kenzan's crossword puzzle application that runs as several containers in Kubernetes (we call it the Kr8sswordz Puzzle). It showcases Kubernetes features like spinning up multiple pods and running a load test at scale. It also features Jenkins running on its own a container and a JenkinsFile script to demonstrate how Kubernetes can be integrated into a full CI/CD pipeline.
To get it up and running, see the following week-by-week Linux.com blog posts, or simply follow the directions below.
To generate this readme: node readme.js
To complete the tutorial using the interactive script:
-
Clone this repository.
-
To ensure you are starting with a clean slate:
minikube delete; sudo rm -rf ~/.minikube; sudo rm -rf ~/.kube -
To run:
npm install
Begin the desired section:
-
npm run part1 -
npm run part2 -
npm run part3 -
npm run part4
To complete the tutorial manually, follow the steps below.
Start up the Kubernetes cluster with Minikube, giving it some extra resources.
minikube start --memory 8000 --cpus 2 --kubernetes-version v1.6.0
Enable the Minikube add-ons Heapster and Ingress.
minikube addons enable heapster; minikube addons enable ingress
Wait 20 seconds, and then view the Minikube Dashboard, a web UI for managing deployments.
sleep 20; minikube service kubernetes-dashboard --namespace kube-system
Deploy the public nginx image from DockerHub into a pod. Nginx is an open source web server that will automatically download from Docker Hub if it’s not available locally.
kubectl run nginx --image nginx --port 80
Create a service for deployment. This will expose the nginx pod so you can access it with a web browser.
kubectl expose deployment nginx --type NodePort --port 80
Launch a web browser to test the service. The nginx welcome page displays, which means the service is up and running.
minikube service nginx
Set up the cluster registry by applying a .yml manifest file.
kubectl apply -f manifests/registry.yml
Wait for the registry to finish deploying. Note that this may take several minutes.
kubectl rollout status deployments/registry
View the registry user interface in a web browser.
minikube service registry-ui
Let’s make a change to an HTML file in the cloned project. Open the /applications/hello-kenzan/index.html file in your favorite text editor (for example, you can use nano by running the command 'nano applications/hello-kenzan/index.html' in a separate terminal). Change some text inside one of the
tags. For example, change “Hello from Kenzan!” to “Hello from Me!”. Save the file.
echo ''
Now let’s build an image, giving it a special name that points to our local cluster registry.
docker build -t 127.0.0.1:30400/hello-kenzan:latest -f applications/hello-kenzan/Dockerfile applications/hello-kenzan
We’ve built the image, but before we can push it to the registry, we need to set up a temporary proxy. By default the Docker client can only push to HTTP (not HTTPS) via localhost. To work around this, we’ll set up a container that listens on 127.0.0.1:30400 and forwards to our cluster.
docker stop socat-registry; docker rm socat-registry; docker run -d -e "REGIP=minikube ip" --name socat-registry -p 30400:5000 chadmoon/socat:latest bash -c "socat TCP4-LISTEN:5000,fork,reuseaddr TCP4:minikube ip:30400"
With our proxy container up and running, we can now push our image to the local repository.
docker push 127.0.0.1:30400/hello-kenzan:latest
The proxy’s work is done, so you can go ahead and stop it.
docker stop socat-registry;
With the image in our cluster registry, the last thing to do is apply the manifest to create and deploy the hello-kenzan pod based on the image.
kubectl apply -f applications/hello-kenzan/k8s/deployment.yaml
Launch a web browser and view the service.
minikube service hello-kenzan
Install Jenkins, which we’ll use to create our automated CI/CD pipeline. It will take the pod a minute or two to roll out.
kubectl apply -f manifests/jenkins.yml; kubectl rollout status deployment/jenkins
Open the Jenkins UI in a web browser.
minikube service jenkins
Display the Jenkins admin password with the following command, and right-click to copy it. IMPORTANT: BE CAREFUL NOT TO PRESS CTRL-C TO COPY THE PASSWORD AS THIS WILL STOP THE SCRIPT.
kubectl exec -it kubectl get pods --selector=app=jenkins --output=jsonpath={.items..metadata.name} cat /root/.jenkins/secrets/initialAdminPassword
Switch back to the Jenkins UI. Paste the Jenkins admin password in the box and click Continue. Click Install suggested plugins and wait for the process to complete.
echo ''
Create an admin user and credentials, and click Save and Finish. (Make sure to remember these credentials as you will need them for repeated logins.) Click Start using Jenkins.
echo ''
We now want to create a new pipeline for use with our Hello-Kenzan app. On the left, click New Item. Enter the item name as "Hello-Kenzan Pipeline", select Pipeline, and click OK.
echo ''
Under the Pipeline section at the bottom, change the Definition to be "Pipeline script from SCM".
echo ''
Change the SCM to Git.
echo ''
Change the Repository URL to be the URL of your forked Git repository, such as https://github.com/[GIT USERNAME]/kubernetes-ci-cd. Click Save. On the left, click Build Now to run the new pipeline.
echo ''
Now view the Hello-Kenzan application.
minikube service hello-kenzan
Push a change to your fork. Run job again. View the changes.
minikube service hello-kenzan
Start the etcd operator and service on the cluster. You may notice errors showing up as it is waiting to start up the cluster. This is normal until it starts.
scripts/etcd.sh
Now that we have an etcd service, we need an etcd client. The following command will set up a directory within etcd for storing key-value pairs, and then run the etcd client.
kubectl create -f manifests/etcd-job.yml
Check the status of the job in step 2 to make sure it deployed.
kubectl describe jobs/etcd-job
The crossword application is a multi-tier application whose services depend on each other. We will create three services in Kubernetes ahead of time, so that the deployments are aware of them.
kubectl apply -f manifests/all-services.yml
Now we're going to walk through an initial build of the monitor-scale service.
docker build -t 127.0.0.1:30400/monitor-scale:git rev-parse --short HEAD -f applications/monitor-scale/Dockerfile applications/monitor-scale
Set up a proxy so we can push the monitor-scale Docker image we just built to our cluster's registry.
docker stop socat-registry; docker rm socat-registry; docker run -d -e "REGIP=minikube ip" --name socat-registry -p 30400:5000 chadmoon/socat:latest bash -c "socat TCP4-LISTEN:5000,fork,reuseaddr TCP4:minikube ip:30400"
Push the monitor-scale image to the registry.
docker push 127.0.0.1:30400/monitor-scale:git rev-parse --short HEAD``
The proxy’s work is done, so go ahead and stop it.
docker stop socat-registry
Open the registry UI and verify that the monitor-scale image is in our local registry.
minikube service registry-ui
Create the monitor-scale deployment and service.
sed 's#127.0.0.1:30400/monitor-scale:latest#127.0.0.1:30400/monitor-scale:'git rev-parse --short HEAD'#' applications/monitor-scale/k8s/deployment.yaml | kubectl apply -f -
Wait for the monitor-scale deployment to finish.
kubectl rollout status deployment/monitor-scale
View pods to see the monitor-scale pod running.
kubectl get pods
View services to see the monitor-scale service.
kubectl get services
View ingress rules to see the monitor-scale ingress rule.
kubectl get ingress
View deployments to see the monitor-scale deployment.
kubectl get deployments
We will run a script to bootstrap the puzzle and mongo services, creating Docker images and storing them in the local registry. The puzzle.sh script runs through the same build, proxy, push, and deploy steps we just ran through manually for both services.
scripts/puzzle.sh
Check to see if the puzzle and mongo services have been deployed.
kubectl rollout status deployment/puzzle
Bootstrap the kr8sswordz frontend web application. This script follows the same build proxy, push, and deploy steps that the other services followed.
scripts/kr8sswordz-pages.sh
Check to see if the frontend has been deployed.
kubectl rollout status deployment/kr8sswordz
Check out all the pods that are running.
kubectl get pods
Start the web application in your default browser. You may have to refresh your browser so that the puzzle appears properly.
minikube service kr8sswordz
Enter the following command to open the Jenkins UI in a web browser. Log in to Jenkins using the username and password you previously set up.
minikube service jenkins
We’ll want to create a new pipeline for the puzzle service that we previously deployed. On the left in Jenkins, click New Item.
echo ''
Enter the item name as "Puzzle-Service", click Pipeline, and click OK.
echo ''
Under the Build Triggers section, select Poll SCM. For the Schedule, enter the the string H/5 * * * * which will poll the Git repo every 5 minutes for changes.
echo ''
In the Pipeline section, change the Definition to "Pipeline script from SCM". Set the SCM property to GIT. Set the Repository URL to your forked repo (created in Part 2), such as https://github.com/[GIT USERNAME]/kubernetes-ci-cd.git. Set the Script Path to applications/puzzle/Jenkinsfile
echo ''
When you are finished, click Save. On the left, click Build Now to run the new pipeline. You should see it successfully run through the build, push, and deploy steps in a few minutes.
echo ''
View the Kr8sswordz application.
minikube service kr8sswordz
Spin up several instances of the puzzle service by moving the slider to the right and clicking Scale. For reference, click on the Submit button, noting that the green hit does not register on the puzzle services.
echo ''
Edit applications/puzzle/common/models/crossword.js in your favorite text editor (for example, you can use nano by running the command 'nano applications/puzzle/common/models/crossword.js' in a separate terminal). You'll see a commented section on lines 42-43 that indicates to uncomment a specific line. Uncomment line 43 by deleting the forward slashes and save the file.
echo ''
Commit and push the change to your forked Git repo.
echo ''
In Jenkins, open up the Puzzle-Service pipeline and wait until it triggers a build. It should trigger every 5 minutes.
echo ''
After it triggers, observe how the puzzle services disappear in the Kr8sswordz Puzzle app, and how new ones take their place.
echo ''
Try clicking Submit to test that hits now register as light green.
echo ''
Copyright 2017 Kenzan, LLC http://kenzan.com
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.