keep-api

Chainguard Container for keep-api

Keep is an open-source AIOps and alert management platform.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/keep-api:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

This image packages the open-source Keep AIOps platform. It includes two components: keep-api (Python/FastAPI backend) and keep-ui (Next.js frontend).

Enterprise Edition

This image does not include Keep's Enterprise Edition (EE) features. The upstream EE_PATH environment variable is not set. This is intentional: the EE module is not included for licensing reasons. All open-source Keep functionality is fully supported.

Upstream Telemetry

The upstream Keep images include baked-in PostHog analytics and Sentry error reporting endpoints. These are not included in the Chainguard image as a privacy improvement. To re-enable upstream telemetry, set the POSTHOG_KEY, POSTHOG_HOST, and NEXT_PUBLIC_SENTRY_DSN environment variables at runtime.

Deployment

Docker Compose

Create a Docker network and start the services:

docker network create keep-net

# Start keep-api backend
docker run -d --name keep-backend --network keep-net \
  -e AUTH_TYPE=DB \
  -e KEEP_JWT_SECRET=changeme \
  -e SECRET_MANAGER_DIRECTORY=/state \
  -e "DATABASE_CONNECTION_STRING=sqlite:////state/db.sqlite3?check_same_thread=False" \
  -v keep-state:/state \
  cgr.dev/ORGANIZATION/keep:latest-api

# Start keep-ui frontend
docker run -d --name keep-frontend --network keep-net \
  -p 3000:3000 \
  -e AUTH_TYPE=DB \
  -e NEXTAUTH_SECRET=changeme \
  -e API_URL=http://keep-backend:8080 \
  cgr.dev/ORGANIZATION/keep:latest-ui

The UI will be available at http://localhost:3000. Log in with the default credentials keep/keep.

For real-time WebSocket updates, add a soketi server and configure the PUSHER_* environment variables on both containers.

Helm Chart

Add the Keep Helm repository and install with Chainguard images:

helm repo add keephq https://keephq.github.io/helm-charts
helm repo update

Create a keep-values.yaml to override the default images:

backend:
  image:
    repository: cgr.dev/ORGANIZATION/keep
    tag: latest-api
  env:
    - name: AUTH_TYPE
      value: "DB"
    - name: KEEP_JWT_SECRET
      value: "changeme"
    - name: SECRET_MANAGER_TYPE
      value: "k8s"
    - name: DATABASE_CONNECTION_STRING
      value: "mysql+pymysql://root:keeproot@mysql:3306/keep"

frontend:
  image:
    repository: cgr.dev/ORGANIZATION/keep
    tag: latest-ui
  env:
    - name: AUTH_TYPE
      value: "DB"
    - name: NEXTAUTH_SECRET
      value: "changeme"
    - name: API_URL
      value: "http://keep-backend:8080"

Install the chart:

helm install keep keephq/keep -f keep-values.yaml

Note: The Helm chart requires an external MySQL database. Deploy one before installing the chart (e.g., via the Bitnami MySQL Helm chart).

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.