​
High Level Architecture

Keep architecture composes of two main components:

  1. Keep API - A FastAPI-based backend server that handles business logic and API endpoints.
  2. Keep Frontend - A Next.js-based frontend interface for user interaction.
  3. Websocket Server - A Soketi server for real-time updates without page refreshes.
  4. Database Server - A database used to store and manage persistent data. Supported databases include SQLite, PostgreSQL, MySQL, and SQL Server.

​
Kubernetes Architecture

Keep uses a single unified NGINX ingress controller to route traffic to all components (frontend, backend, and websocket). The ingress handles path-based routing:

By default:

  • / routed to Frontend (configurable via global.ingress.frontendPrefix)
  • /v2 routed to Backend (configurable via global.ingress.backendPrefix)
  • /websocket routed to WebSocket (configurable via global.ingress.websocketPrefix)

​
General Components

Keep uses kubernetes secret manager to store secrets such as integrations credentials.
Kubernetes ResourcePurposeRequired/OptionalSource
ServiceAccountProvides an identity for processes that run in a Pod. Used mainly for Keep API to access kubernetes secret managerRequiredserviceaccount.yaml
RoleDefines permissions for the ServiceAccount to manage secretsRequiredrole-secret-manager.yaml
RoleBindingAssociates the Role with the ServiceAccountRequiredrole-binding-secret-manager.yaml
Secret Deletion JobCleans up Keep-related secrets when the Helm release is deletedRequireddelete-secret-job.yaml

​
Ingress Component

Kubernetes ResourcePurposeRequired/OptionalSource
Shared NGINX IngressRoutes all external traffic via one entry pointOptionalnginx-ingress.yaml

​
Frontend Components

Kubernetes ResourcePurposeRequired/OptionalSource
Frontend DeploymentManages the frontend application containersRequiredfrontend.yaml
Frontend ServiceExposes the frontend deployment within the clusterRequiredfrontend-service.yaml
Frontend Route (OpenShift)Exposes the frontend service to external traffic on OpenShiftOptionalfrontend-route.yaml
Frontend HorizontalPodAutoscalerAutomatically scales the number of frontend podsOptionalfrontend-hpa.yaml

​
Backend Components

Kubernetes ResourcePurposeRequired/OptionalSource
Backend DeploymentManages the backend application containersRequired (if backend enabled)backend.yaml
Backend ServiceExposes the backend deployment within the clusterRequired (if backend enabled)backend-service.yaml
Backend Route (OpenShift)Exposes the backend service to external traffic on OpenShiftOptionalbackend-route.yaml
Backend HorizontalPodAutoscalerAutomatically scales the number of backend podsOptionalbackend-hpa.yaml

​
Database Components

Database components are optional. You can spin up Keep with your own database.
Kubernetes ResourcePurposeRequired/OptionalSource
Database DeploymentManages the database containers (e.g. MySQL or Postgres)Optionaldb.yaml
Database ServiceExposes the database deployment within the clusterRequired (if deployment enabled)db-service.yaml
Database PersistentVolumeProvides persistent storage for the databaseOptionaldb-pv.yaml
Database PersistentVolumeClaimClaims the persistent storage for the databaseOptionaldb-pvc.yaml

​
WebSocket Components

WebSocket components are optional. You can spin up Keep with your own Pusher compatible WebSocket server.
Kubernetes ResourcePurposeRequired/OptionalSource
WebSocket DeploymentManages the WebSocket server containers (Soketi)Optionalwebsocket-server.yaml
WebSocket ServiceExposes the WebSocket deployment within the clusterRequired (if WebSocket enabled)websocket-server-service.yaml
WebSocket Route (OpenShift)Exposes the WebSocket service to external traffic on OpenShiftOptionalwebsocket-server-route.yaml
WebSocket HorizontalPodAutoscalerAutomatically scales the number of WebSocket server podsOptionalwebsocket-server-hpa.yaml

These tables provide a comprehensive overview of the Kubernetes resources used in the Keep architecture, organized by component type. Each table describes the purpose of each resource, indicates whether it’s required or optional, and provides a direct link to the source template in the Keep Helm charts GitHub repository.

​
Kubernetes Configuration

This sections covers only kubernetes-specific configuration. To learn about Keep-specific configuration, controlled by environment variables, see Keep Configuration

Each of these components can be customized via the values.yaml file in the Helm chart.

Below are key configurations that can be adjusted for each component.

​
1. Frontend Configuration

frontend:
  enabled: true                 # Enable or disable the frontend deployment.
  replicaCount: 1               # Number of frontend replicas.
  image:
    repository: us-central1-docker.pkg.dev/keephq/keep/keep-ui
    pullPolicy: Always          # Image pull policy (Always, IfNotPresent).
    tag: latest
  serviceAccount:
    create: true                # Create a new service account.
    name: ""                    # Service account name (empty for default).
  podAnnotations: {}            # Annotations for frontend pods.
  podSecurityContext: {}        # Security context for the frontend pods.
  securityContext: {}           # Security context for the containers.
  service:
    type: ClusterIP              # Service type (ClusterIP, NodePort, LoadBalancer).
    port: 3000                  # Port on which the frontend service is exposed.

​
2. Backend Configuration

backend:
  enabled: true                # Enable or disable the backend deployment.
  replicaCount: 1              # Number of backend replicas.
  image:
    repository: us-central1-docker.pkg.dev/keephq/keep/keep-api
    pullPolicy: Always         # Image pull policy (Always, IfNotPresent).
  serviceAccount:
    create: true               # Create a new service account.
    name: ""                   # Service account name (empty for default).
  podAnnotations: {}           # Annotations for backend pods.
  podSecurityContext: {}       # Security context for backend pods.
  securityContext: {}          # Security context for containers.
  service:
    type: ClusterIP      # Service type (ClusterIP, NodePort, LoadBalancer).
    port: 8080           # Port on which the backend API is exposed.

​
3. WebSocket Server Configuration

Keep uses Soketi as its websocket server. To learn how to configure it, please see Soketi docs.

​
4. Database Configuration

Keep supports plenty of database (e.g. postgresql, mysql, sqlite, etc). It is out of scope to describe here how to deploy all of them to k8s. If you have specific questions - contact us and we will be happy to help.

InstallationOpenshift