Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 3.89 KB

README.md

File metadata and controls

77 lines (55 loc) · 3.89 KB
Raw

keptn

Keptn

GitHub release (latest by date) Github Downloads CI codecov Go Report Card CII Best Practices

Keptn is an event-based control plane for continuous delivery and automated operations for cloud-native applications. Please find the documentation on our website, and read the motivation about Keptn on our Why Keptn? page.

In addition, you can find the roadmap of the Keptn project here. It provides an overview of user stories that are currently in the focus of development for the next release.

Quickstart

To get started with keptn you need a Kubernetes cluster. Supported Kubernetes engines and versions can be found in the documentation.

Here is a quick guide on how to get started with Keptn on k3s on MacOS and Linux:

Install K3s
Download, install and run K3s (tested with versions 1.16 to 1.19):

curl -sfL https://get.k3s.io | INSTALL_K3S_VERSION=v1.19.5+k3s1 K3S_KUBECONFIG_MODE="644" sh -s - --no-deploy=traefik

Export the Kubernetes config using:

export KUBECONFIG=/etc/rancher/k3s/k3s.yaml

Download keptn CLI using Bash (e.g., Linux and Mac OS):

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

or download a release for your platform from the release page

Install keptn:

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

You can find documentation on how to get started with Keptn in our Quick Start Guide and the Installation instructions. We recommend using the latest stable release as provided in the release section.

Community

Please find details on regular hosted community events as well as our Slack workspace in the keptn/community repo.

Keptn Versions compatibilities

We manage the Keptn core components in versions. The respective images in their versions are stored on DockerHub. The versions of the Keptn core components and the services are compatible with each other. However, contributed services as well as services that are not considered core components might not follow the same versioning schema.

We are tracking compatibility of those services on our website.

Contributions

You are welcome to contribute using Pull Requests to the respective repositories. Before contributing, please read our Contributing Guidelines and our Code of Conduct. Please also check out our list of good first issues.

License

Keptn is an Open Source Project. Please see LICENSE for more information.

Adopters

For a list of users, please refer to ADOPTERS.md.

Further information