Keptn v1 reached EOL December 22, 2023. For more information see https://bit.ly/keptn

Installation

How to install and configure your Keptn environment. Scroll down for a reference list of tasks.

Create or bring a Kubernetes cluster

Install Keptn on your Kubernetes cluster and expose it

Kubernetes support & Cluster size

Keptn and Kubernetes compatibility overview and required cluster size.

Choose access options

Choose the method to use to access Keptn

Install Keptn CLI

Install binaries for the Keptn CLI

Install Keptn using the Helm chart

Install Keptn on a single cluster using the Helm chart

Multi-cluster setup

Install Keptn control-plane and execution-plane on separate clusters

Authenticate Keptn CLI and Bridge

Authenticate the Keptn CLI and Bridge to your Keptn cluster

Install Job Executor

Install the Job Executor Service to run Keptn customizable tasks as Kubernetes jobs

Install and configure Istio

Configure Istio and create a ConfigMap to expose services deployed by Keptn.

Monitoring

Install service to attach observability platform as data source for quality gates

Configure Webhook Service

Configuration for Webhook Service.

Troubleshooting the installation

Tips for troubleshooting installation problems.

Upgrade Keptn

Upgrade your Keptn

Uninstall Keptn

Uninstall Keptn from a Kubernetes cluster.

Note: Keptn v1 is not compatible with ARM-based machines (eg. Mac M1 and M2) due to the use of the Bitnami MongoDB which isn’t built for ARM. We recommend the newer Keptn Lifecycle Toolkit instead.

The steps to install and configure your Keptn instance are:

  1. Create or bring a Kubernetes cluster

    • Check Kubernetes support and cluster size to ensure that your version of Kubernetes is compatible with the Keptn version you are installing and that you have adequate resources.
  2. Decide how you want to access Keptn. Kubernetes supports exposing Keptn via a LoadBalancer, a NodePort, an Ingress or using a Port-forward.

  3. Install Keptn CLI on the cloud shell machine that is used to access your cloud provider, Kubernetes cluster, etc (recommended).

  4. Install the Helm CLI.

  5. Install Keptn using a Helm chart

    • All on one cluster
    • Install using a Multi-cluster setup, meaning that the Keptn Control Plane is installed in one Kubernetes cluster and the Keptn Execution Plane is installed in one or more other Kubernetes clusters.
  6. Authenticate CLI and Bridge

  7. Install software to run Keptn tasks

  8. If you are using Quality Gates, install the monitoring service you want to use.

  9. Configure webhooks (optional)

  10. If you have problems with your installation, check out the hints in Troubleshooting the installation

You may also be interested in the following topics: