Skip to content

Latest commit

 

History

History
375 lines (250 loc) · 17 KB

README.md

File metadata and controls

375 lines (250 loc) · 17 KB
Raw

Build a CI/CD Tekton Pipeline for deploying an OpenLiberty application

IBM

Red Hat OpenShift on IBM Cloud is an extension of the IBM Cloud Kubernetes Service, where IBM manages an OpenShift Container Platform for you.

Tekton Pipelines is an open source framework used for creating cloud-native continuous integration and continuous delivery (CI/CD) pipelines that run on Kubernetes. Tekton Pipelines was built specifically for container environments, supports the software lifecycle, and uses a serverless approach.

In this tutorial, you will become familiar with CI/CD pipelines and webhooks on Red Hat OpenShift 4.3 and Kubernetes 1.17 and higher using Tekton Pipelines.

Prerequisites

Before you begin this tutorial, please complete the following steps:

  1. Register for an IBM Cloud account.
  2. Create a free Kubernetes v1.17 cluster on IBM Cloud.
  3. Create an OpenShift 4.3 cluster on IBM Cloud.
  4. Install and configure the IBM Cloud CLI.
  5. Configure the standard IBM Cloud Container Registry by creating in Dallas region (us.icr.io) a namespace called: tekton-pipeline
  6. Optional : create a free LogDNA service on IBM Cloud for log analysis

Optional: Download Visual Studio Code IDE for editing the Node.js project.

Optional: Download tkn command line for easy command line interation with Tekton

Now that you’ve set up your environment, please note that IBM Cloud offers a free Kubernetes 1.17 cluster for one month for testing purposes. You will also receive a free IBM Cloud Image Registry with 512MB of storage and 5GB of pull traffic each month.

Estimated time

It should take you approximately 1 hour to provision the OpenShift / K8s cluster and to perform this tutorial.

Steps

Before you get started, it’s important to understand how the application image is built. Using Tekton Pipelines involves building the application image inside the OpenShift/Kubernetes cluster. When using OpenShift, you use the standard S2I Build task and for Kubernetes you use the Kaniko Build task. For OpenShift you need to use an Open Liberty image compatible. Application is based on the Java Application created by N. Heidloff

It’s also important to know what each Git folder contains:

  • .s2i/bin - folder contains custom s2i scripts for assembling and running the application image for OpenShift v4. When s2i build is performed, the whole repository content is upload as binary imput for the OpenShift build. There, the repository is mounted as a volume in mountPath /tmp/src/.

  • .m2/settings.xml - optional custom Maven settings.xml config file.

  • tekton-openshift - contains the OpenShift Pipeline implementation and yaml resources.

  • tekton-kubernetes - contains the Kubernetes Pipeline implementation and yaml resources.

  • tekton-triggers - contains the Tekton Triggers implementation for creating a Git WebHook to OpenShift / K8s.

  • tekton-cleanup - contains the Tekton Triggers cleanup K8s CronJob.

If you’d like to use Visual Studio Code to edit and run the OpenLiberty application locally, you can. From the repo root folder run:

# 1. start docker 

# 2. from repo root folder run 

mvn --settings=.m2/settings.xml clean package dockerfile:build

# 3. check docker image is created 

docker images | grep author

# 4. run application image 

docker run -p 9080:9080 -e ENVIRONMENT=DEV tekton-demo/openliberty-author:1.1-SNAPSHOT

# 5. check application health 

curl http://localhost:9080/health

# 6. test API via curl or open in browser : http://localhost:9080/openapi/ui/

curl -X GET "http://localhost:9080/api/v1/getauthor?name=Vlad%20Sancira&apikey=YW5hYXJlbWVyZXNpcGVyZQ%3D%3D" -H "accept: application/json"

IBM IBM

Cloud native CI/CD Pipeline on OpenShift 4.3

OpenShift Pipelines is a cloud-native, continuous integration and continuous delivery (CI/CD) solution based on Kubernetes resources. It uses Tekton building blocks to automate deployments across multiple platforms by abstracting away the underlying implementation details. Tekton introduces a number of standard Custom Resource Definitions (CRDs) for defining CI/CD pipelines that are portable across Kubernetes distributions.

More information can be found here: https://docs.openshift.com/container-platform/4.4/pipelines/understanding-openshift-pipelines.html

Prerequisites for creating the Tekton CI/CD pipeline

  1. Install OpenShift Pipeline Operator
  2. Create env-ci, env-dev and env-stage Projects
oc new-project env-ci
oc new-project env-dev
oc new-project env-stage
  1. Create Image Stream liberty-tekton for storing OpenLiberty image
oc create is liberty-tekton -n env-dev
oc create is liberty-tekton -n env-stage
  1. Allow pipeline ServiceAccount to make deploys on other Projects
oc project env-ci
oc adm policy add-scc-to-user privileged system:serviceaccount:env-ci:pipeline -n env-ci
oc adm policy add-scc-to-user privileged system:serviceaccount:env-ci:pipeline -n env-dev
oc adm policy add-scc-to-user privileged system:serviceaccount:env-ci:pipeline -n env-stage
oc adm policy add-role-to-user edit system:serviceaccount:env-ci:pipeline -n env-ci
oc adm policy add-role-to-user edit system:serviceaccount:env-ci:pipeline -n env-dev
oc adm policy add-role-to-user edit system:serviceaccount:env-ci:pipeline -n env-stage

The image below illustrates what the OpenShift Pipeline design looks like.

Pipeline Design

Create the Tekton CI/CD pipeline

  1. Clone git project
git clone https://github.com/vladsancira/openliberty-tekton.git
cd openliberty-tekton
  1. Create Tekton Resources , Tasks and Pipeline
oc create -f ci-cd-pipeline/tekton-openshift/resources.yaml        -n env-ci
oc create -f ci-cd-pipeline/tekton-openshift/task-build-s2i.yaml   -n env-ci
oc create -f ci-cd-pipeline/tekton-openshift/task-deploy.yaml      -n env-ci
oc create -f ci-cd-pipeline/tekton-openshift/task-test.yaml        -n env-ci
oc create -f ci-cd-pipeline/tekton-openshift/task-promote.yaml     -n env-ci
oc create -f ci-cd-pipeline/tekton-openshift/pipeline.yaml         -n env-ci
  1. Execute the Pipeline either by using tkn command line or via OpenShift Pipelines UI :
tkn t ls -n env-ci
tkn p ls -n env-ci
tkn p start openliberty-pipeline -n env-ci

Pipeline Run

  1. List PipelineRun from CI environment :
tkn pr ls -n env-ci
NAME                                         STARTED        DURATION    STATUS
openliberty-pipeline-run-4fe564430272f1ea78cad   15 hours ago   2 minutes   Succeeded

IBM IBM

Cloud native CI/CD Pipeline on Kubernetes 1.17

The Tekton Pipelines project provides k8s-style resources for declaring CI/CD-style pipelines.

More information can be found here : https://github.com/tektoncd/pipeline

Prerequisites for creating the Tekton CI/CD pipeline

  1. Clone git project
git clone https://github.com/vladsancira/openliberty-tekton.git
cd openliberty-tekton
  1. Install Tekton pipelines in default tekton-pipelines namespace :
kubectl apply --filename https://storage.googleapis.com/tekton-releases/pipeline/latest/release.yaml
kubectl get pods --namespace tekton-pipelines
  1. Create new env-stage,env-dev and env-ci namespaces. In env-ci we will store the CI/CD pipeline and all pipeline resources. In env-dev and env-stage namespaces, we will deploy the application via image promotion.
kubectl create namespace env-stage
kubectl create namespace env-dev
kubectl create namespace env-ci
  1. Create <API_KEY> for IBM Cloud Registry and export PullImage secret from default namespace. The <API_KEY> is used for pushing images into IBM Cloud Registry. When creating a K8s cluster, am IBM Cloud Registry pull secrect will be created in default namespace (for all regions ) that is used for pulling images from IBM Cloud Registry.
ibmcloud iam api-key-create MyKey -d "this is my API key" --file key_file.json
cat key_file.json | grep apikey

kubectl create secret generic ibm-cr-secret  -n env-ci --type="kubernetes.io/basic-auth" --from-literal=username=iamapikey --from-literal=password=<API_KEY>
kubectl annotate secret ibm-cr-secret  -n env-ci tekton.dev/docker-0=us.icr.io

kubectl get secret default-us-icr-io --export -o yaml > default-us-icr-io.yaml
kubectl create -f  default-us-icr-io.yaml -n env-dev
kubectl create -f  default-us-icr-io.yaml -n env-stage
  1. Create a new ServiceAccount to allow the Pipeline to run and deploy to env-dev namespace. We specify this ServiceAccount in pipeline definition. Also we will bind a custom Role to this ServiceAccount that will enable it to create/delete/edit/.. resources in env-dev and env-stage namespaces.
kubectl apply -f ci-cd-pipeline/tekton-kubernetes/service-account.yaml         -n env-ci
kubectl apply -f ci-cd-pipeline/tekton-kubernetes/service-account-binding.yaml -n env-dev
kubectl apply -f ci-cd-pipeline/tekton-kubernetes/service-account-binding.yaml -n env-stage

Below is an image of the Kubernetes Pipeline design.

Pipeline Design

Create the Tekton CI/CD pipeline

  1. Create Tekton resources , taks and pipeline:
kubectl create -f ci-cd-pipeline/tekton-kubernetes/resources.yaml          -n env-ci
kubectl create -f ci-cd-pipeline/tekton-kubernetes/task-build.yaml         -n env-ci
kubectl create -f ci-cd-pipeline/tekton-kubernetes/task-deploy.yaml        -n env-ci
kubectl create -f ci-cd-pipeline/tekton-kubernetes/task-test.yaml          -n env-ci
kubectl create -f ci-cd-pipeline/tekton-kubernetes/task-promote.yaml       -n env-ci
kubectl create -f ci-cd-pipeline/tekton-kubernetes/pipeline.yaml           -n env-ci
  1. Execute Pipeline via Pipeline Run and watch :
kubectl create -f ci-cd-pipeline/tekton-kubernetes/pipeline-run.yaml -n env-ci
kubectl get pipelinerun -n env-ci -w
  1. Check Pods and logs :
kubectl get pods                             -n env-dev
kubectl logs liberty-app-76fcdc6759-pjxs7 -f -n env-dev

Optional : create Horizontal Pod Autoscaler :

kubectl autoscale deploy liberty-app  --min=1 --max=2 --cpu-percent=90 -n env-dev
kubectl autoscale deploy liberty-app  --min=1 --max=2 --cpu-percent=90 -n env-stage
  1. View the OpenLiberty application health status:

Retrieve the Kubernetes cluster EXTERNAL-IP using following command:

kubectl get nodes -o wide

Then open following URL in a Browser to view the OpenLiberty application UI :

  • from DEV environment: http://<EXTERNAL-IP>:32427/health
  • from STAGE environment: http://<EXTERNAL-IP>:32527/health

Create a WebHook connection from a Git repo

In order to create a WebHook from Git to our Tekton Pipeline we need to install TektonCD Triggers in our K8s cluster. Triggers is a Kubernetes Custom Resource Defintion (CRD) controller that allows you to extract information from events payloads (a "trigger") to create Kubernetes resources. More information can be found in the TektonCD Triggers Project. Also we can use Tekton Dashboard as a web console for viewing all Tekton Resources.

On OpenShift 4.3 , TektonCD Triggers are already installed as part of the OpenShift Pipelines Operator, in openshift-pipelines project (namespace), but Tekton Dashboard is not installed. Instead, we can use the OpenShift Pipeline Web Console.

The mechanism for triggering builds via WebHooks is the same and involves creating an EventListener and exposing that EventListener Service to outside. The EventListener handles external events and recieves a Git payload. This payload is parsed via the TriggerBinding resource for certain information, like gitrevision or gitrepositoryurl. These variables are then sent to TriggerTemplate resource that will call the Tekton Pipeline via a PipelineRun definition (with optional arguments).

Tekton Architecture

For OpenShift:

  1. Create Pipeline's trigger_template, trigger_binding & event_listener
oc create -f ci-cd-pipeline/tekton-triggers/webhook-event-listener-openshift.yaml -n env-ci
  1. Create a Route for the event_listener service
oc expose svc/el-liberty-pipeline-listener -n env-ci
oc get route -n env-ci
  1. Add this route to out Git WebHook then perfom a push.

Finally, the new PipelineRun will be triggered automatically and visible in the pipelines console ci-env project.

For Kubernetes:

  1. Install Tekton Dashboard and Tekton Triggers
kubectl apply -f https://github.com/tektoncd/dashboard/releases/download/v0.6.1.2/tekton-dashboard-release.yaml
kubectl apply -f https://storage.googleapis.com/tekton-releases/triggers/latest/release.yaml
kubectl apply -f ci-cd-pipeline/tekton-triggers/tekton-dashboard.yaml -n tekton-pipelines
  1. Create a new ServiceAccount, Role and RoleBinding. In K8s this new ServiceAccount will be used for running the EventListener and starting the PipelineRun via the TriggerTemplate. The actual Pipeline will still run as the ServiceAccount defined in it.
kubectl apply  -f ci-cd-pipeline/tekton-triggers/webhook-service-account.yaml  -n env-ci
  1. Create Pipeline's trigger_template, trigger_binding & event_listener
    ( by default Event Listener service type is ClusterIP , but we set it to NodePort so it can be triggered from outside cluster )
kubectl apply -f ci-cd-pipeline/tekton-triggers/webhook-event-listener-kubernetes.yaml -n env-ci
  1. Get el-liberty-pipeline-listener Service PORT and cluster EXTERNAL-IP
kubectl get svc el-liberty-pipeline-listener -n env-ci
kubectl get nodes -o wide
  1. Add 'http://>:<EVENT_LISTNER_PORT>' to GitHib as WebHook. Then perform a push.

Webhook

  1. Open the Tekton dashboard, http://<EXTERNAL-IP>:32428/#/pipelineruns, to make sure your changes were successful. Your output should look like the following:

Webhook

Configure cleanup CronJob

You can create a K8s CronJob for deleting the PipelineRun resources that meet a specific criteria:

kubectl config set-context --current --namespace=env-ci
kubectl apply -f ci-cd-pipeline/tekton-cleanup/pipelinerun_cleanup_cronjob.yaml

Now every day, the pipelinerun-cleanup cronjob will perform a PipelineRun cleanup.

LogDNA configuration

From IBM Cloud - Observability - Logging you can create a LogDNA Lite instance:

LogDNA

LogDNA configuration for K8s and OpenShift is very simple: from "Edit log sources" run the two kubectl commands for setting up the LogDNA Agent Key and create the LogDNA agent in your K8s/OpenShift cluster. You can create the resources in any namspace:

kubectl create secret generic logdna-agent-key --from-literal=logdna-agent-key=<SECRET_KEY>
kubectl create -f https://assets.eu-gb.logging.cloud.ibm.com/clients/logdna-agent-ds.yaml

All K8s/OpenShift logs are then visible in LogDNA Dashboard.

Summary

In this tutorial , we created a Cloud-native CI/CD Tekton Pipeline for building and deploying an OpenLiberty application in an OpenShift 4.3 / Kubernetes 1.16+ cluster.