keptn

(β˜… 1,775)

Cloud-native application life-cycle orchestration. Keptn automates your SLO-driven multi-stage delivery and operations & remediation of your applications.

  • .gitignore
  • .gitmodules
  • .release-please-manifest.json
  • .reviewdog.yml
  • .snyk
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • codecov.yml
  • CODEOWNERS
  • CONTRIBUTING.md
  • CONTRIBUTORS.md
  • LICENSE
  • MAINTAINERS
  • README.md
  • release-please-config.json
  • specification
  • VERSIONING.MD

# Installation Guide

1. Get the code
git clone https://github.com/keptn/keptn

Downloads the entire project code from GitHub to your computer.

cd keptn

Moves into the project folder you just downloaded.

2. Official Install Script

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

Downloads and runs the official install script in one line β€” this handles the full setup automatically.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f api/Dockerfile -t keptn .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 keptn

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd bridge

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

5. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
cd api

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.
// repository documentation