Building Autonomous Operations for Pivotal Platform with Keptn workshop given @SpringOne Platform 2019

Overview

In this workshop, you will get hands-on experience with the open source framework Keptn and see how it can help you to manage your cloud-native applications on Kubernetes.

1. For a great workshop experience, we ask you to keep track of your completed tasks. Therefore, please open this spreadsheet and enter your name.

Pre-requisites

1. Accounts

• Dynatrace - Create an account for a free trial Dynatrace SaaS tenant and create a PaaS and API token. See details in the Keptn docs.
• Cloud provider account - If you will be unable to ssh to the bastion host from your machine, a GCP account is suggested to utilize Google Cloud Shell. It is recommedned to sign up for personal free trial to have full admin rights and to not cause any issues with your enterprise account. The below link can be used to sign up for a free trial:
  • Google

2. Tools

In this workshop, we are providing two options that will have all the required tools installed. Each attendee should have a piece of paper at their seat with a workshop number that will serve as your username and a temporary password usable only during the workshop.

• Option A: Bastion host - A bastion host has been provisioned on GCP with all necessary tools installed, home directories for every workshop attendee and pre-configured kubectl contexts to access each attendee's dedicated PKS cluster.

  ssh [email protected]

• Option B: Docker in Google Cloud Shell - For those that can't utilize a local ssh client connecting to the bastion host. a docker image has been created containing the same contents of the bastion host. This docker image can be executed via Google Cloud Shell.

1. For those that can't use an ssh client, just go to Google Cloud and activate Cloud Shell as shown below:

   Activate Cloud Shell

   

2. To start the docker container you will use for this workshop, please execute:

   docker run -d -t --name keptn-workshop mvilliger/keptn-workshop:0.5

3. Afterwards, you can shell into this container. Please execute:

   docker exec -it keptn-workshop /bin/sh -c "[ -e /bin/bash ] && /bin/bash || /bin/sh"

4. Finally, utilize the pks cli to fetch the necessary configuration context for kubectl:

   pks login -k -a api.pks.gcp.aklabs.io -u <suppliedusername> -p <suppliedpassword>
   pks get-credentials <suppliedusername>

Install Keptn

1) Collect environment tokens

1. Now, it's time to set up your workshop environment. During the setup, you will need the following values. We recommend copying the following lines into an editor, fill them out and keep them as a reference for later:

   Dynatrace Host Name (e.g. abc12345.live.dynatrace.com):
   Dynatrace API Token:
   Dynatrace PaaS Token:
   

2. To retrieve the API and PaaS Token, login to your Dynatrace tenant and navigate in the left-hand menu to Settings -> Integration -> Dyantrace API and click on Generate token. Provide a name, e.g., keptn-token and make sure to create a token with the following permissions:

   Open for permissions

   • Access problem and event feed, metrics and topology
   • Access logs
   • Configure maintenance windows
   • Read configuration
   • Write configuration
   • Capture request data
   • Real user monitoring JavaScript tag management

   Copy the value of the token into your temporary file.

3. Retrieve the PaaS Token by navigating to Settings -> Integration ->Platform as a Service and generate a new token again with a name of your choice, e.g., keptn-token. Copy the value to your temporary file to keep it as a reference for later.

2) Install Keptn

Once you are logged onto the bastion host or shelled in to the container we are ready to install Keptn.

Install the Keptn control plane components into your cluster, using the Keptn CLI:

keptn install --platform=kubernetes

The install will take about 5 minutes to perform.

Details about this step

The Keptn CLI will now install all Keptn core components into your cluster, as well authenticating the Keptn CLI at the end of the installation.

Once the installation is finished you should find a couple of pods running in your keptn namespace.

$ kubectl get pods -n keptn

NAME                                                              READY   STATUS    RESTARTS   AGE
api-f7689c9d8-dj7vj                                               1/1     Running   0          2m3s
bridge-fd68b4c67-rf5dw                                            1/1     Running   0          2m3s
configuration-service-6d69f8c547-lm46q                            1/1     Running   0          2m2s
eventbroker-go-b65b9bb68-cm8c4                                    1/1     Running   0          2m3s
gatekeeper-service-665447b98b-dtmtb                               1/1     Running   0          2m3s
gatekeeper-service-evaluation-done-distributor-55cbcb5844-zpkn4   1/1     Running   0          2m1s
helm-service-5f65468cf6-2rbgt                                     1/1     Running   0          2m3s
helm-service-configuration-change-distributor-cfd57c9d9-hrq9c     1/1     Running   0          2m2s
helm-service-service-create-distributor-7bbdd68969-jwtjt          1/1     Running   0          2m2s
jmeter-service-84479f4bfd-qmfqz                                   1/1     Running   0          2m3s
jmeter-service-deployment-distributor-864bf9f745-9v2hb            1/1     Running   0          2m2s
keptn-nats-cluster-1                                              1/1     Running   0          2m31s
nats-operator-7dcd546854-mftl9                                    1/1     Running   0          2m49s
pitometer-service-6fd6c4bd9b-8vccf                                1/1     Running   0          2m3s
pitometer-service-tests-finished-distributor-5697bbd859-r48g7     1/1     Running   0          2m2s
prometheus-service-8676b7588f-j8pzj                               1/1     Running   0          53s
prometheus-service-monitoring-configure-distributor-7788487749d   1/1     Running   0          38s
remediation-service-5b486d69c-ljmfq                               1/1     Running   0          2m2s
remediation-service-problem-distributor-6d88b7d65c-8jwsm          1/1     Running   0          2m1s
servicenow-service-7cd9b8784-mrx7d                                1/1     Running   0          54s
servicenow-service-problem-distributor-7fccc4986-w9qg8            1/1     Running   0          38s
shipyard-service-7f88695b49-ncqr8                                 1/1     Running   0          2m3s
shipyard-service-create-project-distributor-7bff8fc48f-44v9l      1/1     Running   0          2m1s
shipyard-service-delete-project-distributor-786645fb7b-nw7p8      1/1     Running   0          2m1s
wait-service-55d476cd97-pfbht                                     1/1     Running   0          2m3s
wait-service-deployment-distributor-fdcf99f67-g7jl9               1/1     Running   0          2m1s

3) Install Dynatrace

This will install the Dynatrace OneAgent Operator into your cluster.

1. Navigate to the dynatrace-service folder:

   cd /usr/keptn/dynatrace-service/deploy/scripts

2. Define your credentials.

   ./defineDynatraceCredentials.sh

3. Install Dynatrace OneAgent Operator on your Cluster.

   ./deployDynatraceOnPKS.sh

The install will take about 2 minutes to perform.

4) Expose Keptn's Bridge - OPTIONAL

The Keptn’s bridge provides an easy way to browse all events that are sent within Keptn and to filter on a specific Keptn context. When you access the Keptn’s bridge, all Keptn entry points will be listed in the left column. Please note that this list only represents the start of a deployment of a new artifact. Thus, more information on the executed steps can be revealed when you click on one event.

In the default installation of Keptn, the bridge is only accessible via kubectl port-forward. To make things easier for workshop participants, we will expose it by creating a public URL for this component.

1. Navigate to the folder to expose the bridge.

   cd /usr/keptn/scripts

2. Execute the following script.

   ./exposeBridgePKS.sh

3. It will give you the URL of your Bridge at the end of the script. Open a browser and verify the bridge is running.

   

Hands-on Labs

After provision the cluster and installing Keptn, we are now ready to explore to execute the following hands-on labs. They are based on each other, why it is important to complete them according to this order:

1. Onboarding the carts service: Lab
2. Deploying the carts service: Lab
3. Introducing quality gates: Lab
4. Homework ;) Self-healing with Keptn: Lab

Keptn Community

Join the Keptn community!

Further information about Keptn you can find on the keptn.sh website. Keptn itself lives on GitHub.

Feel free to contribute or reach out to the Keptn team using a channel provided here.

Join our Slack channel!

The easiest way to get in contact with Keptn users and creaters is to join our Slack channel - we are happy to meet you there!