In this tutorial we are going to learn how to install Keptn in your OpenShift cluster.

Please download and install the following tools if you do not have them installed on your machine already.

• kubectl
• Linux or MacOS (preferred as some instructions are targeted for this platforms)
• On Windows: Git Bash 4 Windows, WSL

1. Install local tools if not already present on your machine.
   • oc CLI - v3.11
2. Make sure you are connected with your oc CLI to your OpenShift cluster.
3. On the OpenShift master node, execute the following steps:

• Set up the required permissions for your user:

  oc adm policy --as system:admin add-cluster-role-to-user cluster-admin <OPENSHIFT_USER_NAME>
  

• Set up the required permissions for the installer pod:

  oc adm policy  add-cluster-role-to-user cluster-admin system:serviceaccount:default:default
  oc adm policy  add-cluster-role-to-user cluster-admin system:serviceaccount:kube-system:default
  

• Enable admission WebHooks on your OpenShift master node:

  sudo -i
  cp -n /etc/origin/master/master-config.yaml /etc/origin/master/master-config.yaml.backup
  oc ex config patch /etc/origin/master/master-config.yaml --type=merge -p '{
  "admissionConfig": {
      "pluginConfig": {
      "ValidatingAdmissionWebhook": {
          "configuration": {
          "apiVersion": "apiserver.config.k8s.io/v1alpha1",
          "kind": "WebhookAdmission",
          "kubeConfigFile": "/dev/null"
          }
      },
      "MutatingAdmissionWebhook": {
          "configuration": {
          "apiVersion": "apiserver.config.k8s.io/v1alpha1",
          "kind": "WebhookAdmission",
          "kubeConfigFile": "/dev/null"
          }
      }
      }
  }
  }' >/etc/origin/master/master-config.yaml.patched
  if [ $? == 0 ]; then
  mv -f /etc/origin/master/master-config.yaml.patched /etc/origin/master/master-config.yaml
  /usr/local/bin/master-restart api && /usr/local/bin/master-restart controllers
  else
  exit
  fi
  

Find a full compatibility matrix for supported Kubernetes versions here.

Every release of Keptn provides binaries for the Keptn CLI. These binaries are available for Linux, macOS, and Windows.

There are multiple options how to get the Keptn CLI on your machine.

• Easiest option, if you are running on a Linux or Mac OS:

  curl -sL https://get.keptn.sh | sudo -E bash
  

  This will download and install the Keptn CLI automatically.
• Another option is to manually download the current release of the Keptn CLI:
  1. Download the version for your operating system from Download CLI
  2. Unpack the download
  3. Find the keptn binary in the unpacked directory
  4. Linux / macOS: Add executable permissions (chmod +x keptn), and move it to the desired destination (e.g. mv keptn /usr/local/bin/keptn)
  • Windows: Copy the executable to the desired folder and add the executable to your PATH environment variable.

Now, you should be able to run the Keptn CLI:

• Linux / macOS

  keptn --help
  

• Windows

  .\keptn.exe --help
  

To install the latest release of Keptn with full quality gate + continuous delivery capabilities in your Kubernetes cluster, execute the keptn install command.

keptn install --endpoint-service-type=ClusterIP --use-case=continuous-delivery

Installation details

In the Keptn namespace, the following deployments should be found:

kubectl get deployments -n keptn

Here is the output of the command:

NAME                                             READY   UP-TO-DATE   AVAILABLE   AGE
api-gateway-nginx                                1/1     1            1           2m44s
api-service                                      1/1     1            1           2m44s
bridge                                           1/1     1            1           2m44s
configuration-service                            1/1     1            1           2m44s
eventbroker-go                                   1/1     1            1           2m44s
gatekeeper-service                               1/1     1            1           2m44s
helm-service                                     1/1     1            1           2m44s
helm-service-continuous-deployment-distributor   1/1     1            1           2m44s
jmeter-service                                   1/1     1            1           2m44s
lighthouse-service                               1/1     1            1           2m44s
mongodb                                          1/1     1            1           2m44s
mongodb-datastore                                1/1     1            1           2m44s
remediation-service                              1/1     1            1           2m44s
shipyard-service                                 1/1     1            1           2m44s

Expose the Keptn endpoint via the following command to be able to access on localhost. Please note that the port-forward must be kept open for the next commands to succeed, therefore we recommend doing this in a separate terminal.

kubectl -n keptn port-forward service/api-gateway-nginx 8080:80

Set the following variables to make it easy to connect to Keptn.

KEPTN_ENDPOINT=http://localhost:8080/api
KEPTN_API_TOKEN=$(kubectl get secret keptn-api-token -n keptn -ojsonpath='{.data.keptn-api-token}' | base64 --decode)

To authenticate the CLI against the Keptn cluster, use the keptn auth command:

keptn auth --endpoint=$KEPTN_ENDPOINT --api-token=$KEPTN_API_TOKEN

Starting to authenticate
Successfully authenticated

Now that you have installed Keptn you can take a look at its user interface aka the Keptn's Bridge.

Keptn's Bridge

Open a browser and navigate to http://localhost:8080 to take look. The bridge will be empty at this point but when using Keptn it will be populated with events.

If asked for credentials, you can get them by executing the following command.

keptn configure bridge --output

Keptn API

Besides the Keptn's Bridge, please consider also taking a look at the Keptn API endpoint if you are interested to interact with Keptn via the API. Keptn comes with a fully documented swagger-API that can be found under the /api endpoint.

Now that you have successfully installed Keptn, you can explore other tutorials!

Here are some possibilities:

• Take a full tour on Keptn with either Prometheus or Dynatrace
• Explore Keptn Quality Gates
• Explore Automated Operations with Keptn