The Kind Keptn

If you're looking to try out Keptn. I now recommend the browser-based, zero install-required tutorial. See the explore Keptn page for the link.

---

docker run for a Keptn instance.

Expect install to take about 10 minutes. Once complete, Keptn is available on http://localhost

1. Create a Git personal access token with full Repo status
2. Create a new uninitialised Git upstream repo (no commits, no files, no readme). Keptn needs this for the hello-world project.
3. Set GIT_USER, GIT_REMOTE_URL and GIT_TOKEN below

GIT_USER=YourGitUsernameHere
GIT_REMOTE_URL=https://github.com/me/example.git
GIT_TOKEN=ghp_********

Now start thekindkeptn:

docker run --rm -it \
--name thekindkeptn \
-v /var/run/docker.sock:/var/run/docker.sock:ro \
--add-host=host.docker.internal:host-gateway \
--env GIT_USER=$GIT_USER \
--env GIT_REMOTE_URL=$GIT_REMOTE_URL \
--env GIT_TOKEN=$GIT_TOKEN \
--publish 7681:7681 \
gardnera/thekindkeptn:0.16.0

Keptn in a Docker Container

This demo creates a single container with:

• A k8s cluster inside
• A web-based terminal window on http://localhost:7681
• Helm is installed
• Keptn installed to the keptn namespace
• Keptn bridge and API are exposed on localhost on port 80: http://localhost
• The job executor service (installed in keptn-jes namespace)
• A demo "hello world" project is created
• Automatically runs a first "hello world" sequence for you

If you need additional Keptn services, just docker exec -it thekindkeptn /bin/sh then use helm to install services. kubectl is also available.

What Happened?

• k3d, Helm and Keptn into the docker container and exposed it to your localhost
• We also installed the job executor service. Keptn orchestrates other tools and services are a cornerstone of how it does that. Services abstract the details of dealing with the product and leave you free to get on with your day.
• Once everything was installed, a cloudevent was sent into Keptn's API (see helloevent.cloudevent.json)
• That cloudevent has a type in a specific format that tells Keptn to trigger the hello sequence in the demo stage (see shipyard.yaml)
• Keptn now knows it needs to trigger the task inside the hello sequence. So Keptn crafts and distributes another cloudevent, automatically on our behalf (sh.keptn.event.hello-world.triggered)
• It is this hello-world.triggered event that the job executor service is listening for
• The job executor looks for it's configuration (see jobconfig.yaml) and so spins up the alpine image to say hello!

The power of Keptn is that we've split our process (defined in the shipyard.yaml) from the tooling.

Want to get a Slack message instead of a container saying hello? Just swap your services and listen for the same hello-world.triggered event. You don't need to know how the Slack APIs work. Someone else has done that for you. Just uninstall the Job Executor Service and install the notification service.

Want to trigger a webhook? Just configure the webhook service to send an outbound POST to your tool.

The possibilities are endless.

Version Matrix

Kind Keptn Version	Notes	Keptn Version	Job Executor Service Version
0.16.0	Updates versioning to better match Keptn core versions. Adds web terminal. Removes jmeter-service and helm-service in favour of job executor service. Mandates Git repo details on startup as keptn 0.16.0 requires them.	0.16.0	0.2.0
0.0.16		0.15.1	0.2.0
0.0.15		0.15.0	0.2.0
0.0.14		0.14.2	0.2.0
0.0.13		0.14.1	0.1.8
0.0.12		0.13.4	0.1.8
0.0.11		0.13.4	0.1.7
0.0.10		0.13.3	0.1.7
0.0.9	Fixes #7112	0.13.2	0.1.7
0.0.8		0.13.2	0.1.7
0.0.7	Adds helm-service and jmeter-service	0.13.1	0.1.7
0.0.6		0.13.1	0.1.7
0.0.5		0.13.1	0.1.6
0.0.4		0.12.2	0.1.6
0.0.3	Single node cluster	0.12.2	0.1.6
0.0.2	2 node cluster	0.12.2	0.1.6
0.0.1	DO NOT USE	-	-

---

Troubleshooting

Windows Users

Windows users need to use WSL2 and set their .wslconfig accordingly.

wsl --status should show: Default Version: 2

Also make sure you create a file called .wslconfig and save to c:\Users\you\.wslconfig.

You can increase the limits if you have more resources available, but this is the minimum spec you need for stability:

# Settings apply across all Linux distros running on WSL 2
[wsl2]

# Limit memory to 8GB
memory=8GB

# Limit processors to 4 logical processors
processors=8

WSL Kernel Update

Docker desktop usually forces you to upgrade the WSL kernel during installation but if not:

1. Open a cmd window as Administrator and type wsl --update then wsl --shutdown and restart Docker Desktop

If in doubt, stop all running containers and run docker system prune to clean up unused stuff.

Still Stuck?

Join Keptn Slack and ask in #help