diff --git a/docs/deployment/configuration.mdx b/docs/deployment/configuration.mdx new file mode 100644 index 000000000..0785cd6a9 --- /dev/null +++ b/docs/deployment/configuration.mdx @@ -0,0 +1,242 @@ +--- +title: "Configuration" +sidebarTitle: "Configuration" +--- + +## Background + +Keep is highly configurable through environment variables. This allows you to customize various aspects of both the backend and frontend components without modifying the code. Environment variables can be set in your deployment environment, such as in your Kubernetes configuration, Docker Compose file, or directly on your host system. + + +## Backend Environment Variables + +### General + +General configuration variables control the core behavior of the Keep server. These settings determine fundamental aspects such as the server's host, port, and whether certain components like the scheduler and consumer are enabled. + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **KEEP_HOST** | Specifies the host for the Keep server | No | "0.0.0.0" | Valid hostname or IP address | +| **PORT** | Specifies the port on which the backend server runs | No | 8080 | Any valid port number | +| **SCHEDULER** | Enables or disables the workflow scheduler | No | "true" | "true" or "false" | +| **CONSUMER** | Enables or disables the consumer | No | "true" | "true" or "false" | +| **KEEP_VERSION** | Specifies the Keep version | No | "unknown" | Valid version string | +| **KEEP_API_URL** | Specifies the Keep API URL | No | Constructed from HOST and PORT | Valid URL | +| **KEEP_STORE_RAW_ALERTS** | Enables storing of raw alerts | No | "false" | "true" or "false" | +| **TENANT_CONFIGURATION_RELOAD_TIME** | Time in minutes to reload tenant configurations | No | 5 | Positive integer | + +### Logging and Environment + +Logging and environment configuration determines how Keep generates and formats log output. These settings are crucial for debugging, monitoring, and understanding the behavior of your Keep instance in different environments. + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **LOG_LEVEL** | Sets the logging level for the application | No | "INFO" | "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL" | +| **ENVIRONMENT** | Specifies the environment the application is running in | No | "production" | "development", "staging", "production" | +| **LOG_FORMAT** | Specifies the log format | No | "open_telemetry" | "open_telemetry", "dev_terminal" | +| **LOG_AUTH_PAYLOAD** | Enables logging of authentication payload | No | "false" | "true" or "false" | + + +### Database + +Database configuration is crucial for Keep's data persistence. Keep supports various database backends through SQLAlchemy, allowing flexibility in choosing and configuring your preferred database system. + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **DATABASE_CONNECTION_STRING** | Specifies the database connection URL | Yes | None | Valid SQLAlchemy connection string | +| **DATABASE_POOL_SIZE** | Sets the database connection pool size | No | 5 | Positive integer | +| **DATABASE_MAX_OVERFLOW** | Sets the maximum overflow for the connection pool | No | 10 | Positive integer | +| **DATABASE_ECHO** | Enables SQLAlchemy echo mode for debugging | No | False | Boolean (True/False) | +| **DB_CONNECTION_NAME** | Specifies the Cloud SQL connection name | No | "keephq-sandbox:us-central1:keep" | Valid Cloud SQL connection string | +| **DB_SERVICE_ACCOUNT** | Service account for database impersonation | No | None | Valid service account email | +| **SKIP_DB_CREATION** | Skips database creation and migrations | No | "false" | "true" or "false" | + +### Resource Provisioning + +Resource provisioning settings control how Keep sets up initial resources. This configuration is particularly important for automating the setup process and ensuring that necessary resources are available when Keep starts. + +To elaborate on resource provisioning and its configuration, please see [provisioning docs](/deployment/provision/overview). + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **PROVISION_RESOURCES** | Enables or disables resource provisioning | No | "true" | "true" or "false" | + + +### Authentication + +Authentication configuration determines how Keep verifies user identities and manages access control. These settings are essential for securing your Keep instance and integrating with various authentication providers. + +For specifc authentication type configuration, please see [authentication docs](/deployment/authentication/overview). + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **AUTH_TYPE** | Specifies the authentication type | No | "noauth" | "auth0", "keycloak", "db", "noauth", "oauth2proxy" | +| **JWT_SECRET** | Secret key for JWT token generation and validation | Yes | None | Any strong secret string | +| **JWT_ALGORITHM** | Algorithm used for JWT | No | "HS256" | Any valid JWT algorithm | +| **KEEP_DEFAULT_USERNAME** | Default username for the admin user | No | "keep" | Any valid username string | +| **KEEP_DEFAULT_PASSWORD** | Default password for the admin user | No | "keep" | Any strong password string | +| **KEEP_FORCE_RESET_DEFAULT_PASSWORD** | Forces reset of default user password | No | "false" | "true" or "false" | +| **KEEP_DEFAULT_API_KEYS** | Comma-separated list of default API keys to provision | No | "" | Format: "name:role:secret,name:role:secret" | + +### Secrets Management + +Secrets Management configuration specifies how Keep handles sensitive information. This is crucial for securely storing and accessing confidential data such as API keys and integrations credentials. + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **SECRET_MANAGER_TYPE** | Defines the type of secret manager to use | Yes | "FILE" | "FILE", "GCP", "K8S", "VAULT" | +| **SECRET_MANAGER_DIRECTORY** | Directory for storing secrets when using file-based secret management | No | "/state" | Any valid directory path | + +### OpenTelemetry + +OpenTelemetry configuration enables comprehensive observability for Keep. These settings allow you to integrate Keep with various monitoring and tracing systems, enhancing your ability to debug and optimize performance. + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **OTEL_SERVICE_NAME** | OpenTelemetry service name | No | "keep-api" | Valid service name string | +| **SERVICE_NAME** | Alternative for OTEL_SERVICE_NAME | No | "keep-api" | Valid service name string | +| **OTEL_EXPORTER_OTLP_ENDPOINT** | OpenTelemetry collector endpoint | No | None | Valid URL | +| **OTLP_ENDPOINT** | Alternative for OTEL_EXPORTER_OTLP_ENDPOINT | No | None | Valid URL | +| **OTEL_EXPORTER_OTLP_TRACES_ENDPOINT** | OpenTelemetry traces endpoint | No | None | Valid URL | +| **OTEL_EXPORTER_OTLP_LOGS_ENDPOINT** | OpenTelemetry logs endpoint | No | None | Valid URL | +| **OTEL_EXPORTER_OTLP_METRICS_ENDPOINT** | OpenTelemetry metrics endpoint | No | None | Valid URL | +| **CLOUD_TRACE_ENABLED** | Enables Google Cloud Trace exporter | No | "false" | "true" or "false" | +| **METRIC_OTEL_ENABLED** | Enables OpenTelemetry metrics | No | "" | "true" or "false" | + +### WebSocket Server (Pusher/Soketi) + +WebSocket server configuration controls real-time communication capabilities in Keep. These settings are important for enabling features that require instant updates and notifications. + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **PUSHER_DISABLED** | Disables Pusher integration | No | "false" | "true" or "false" | +| **PUSHER_HOST** | Hostname of the Pusher server | No | None | Valid hostname or IP address | +| **PUSHER_PORT** | Port of the Pusher server | No | None | Any valid port number | +| **PUSHER_APP_ID** | Pusher application ID | Yes (if using Pusher) | None | Valid Pusher App ID | +| **PUSHER_APP_KEY** | Pusher application key | Yes (if using Pusher) | None | Valid Pusher App Key | +| **PUSHER_APP_SECRET** | Pusher application secret | Yes (if using Pusher) | None | Valid Pusher App Secret | +| **PUSHER_USE_SSL** | Enables SSL for Pusher connection | No | False | Boolean (True/False) | +| **PUSHER_CLUSTER** | Pusher cluster | No | None | Valid Pusher cluster name | + + +### OpenAPI + +OpenAPI configuration is used for integrating with OpenAI services. These settings are important if you're utilizing OpenAI capabilities within Keep for tasks such as natural language processing or AI-assisted operations. + + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **OPENAI_API_KEY** | API key for OpenAI services | No | None | Valid OpenAI API key | + + +### Posthog + +Posthog configuration controls Keep's integration with the Posthog analytics platform. These settings are useful for tracking usage patterns and gathering insights about how your Keep instance is being used. + + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **POSTHOG_API_KEY** | API key for PostHog analytics | No | "phc_muk9qE3TfZsX3SZ9XxX52kCGJBclrjhkP9JxAQcm1PZ" | Valid PostHog API key | +| **ENABLE_POSTHOG_API** | Enables or disables PostHog API | No | "false" | "true" or "false" | +| **DISABLE_POSTHOG** | Disables PostHog integration | No | "false" | "true" or "false" | + +### Ngrok + +Ngrok configuration enables secure tunneling to your Keep instance. These settings are particularly useful for development or when you need to expose your local Keep instance to the internet securely. + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **USE_NGROK** | Enables ngrok for tunneling | No | "false" | "true" or "false" | +| **NGROK_AUTH_TOKEN** | Authentication token for ngrok | No | None | Valid ngrok auth token | +| **NGROK_DOMAIN** | Custom domain for ngrok | No | None | Valid domain name | + + +### Elasticsearch + +Elasticsearch configuration controls Keep's integration with Elasticsearch for advanced search capabilities. These settings are important if you're using Elasticsearch to enhance Keep's search functionality and performance. + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **ELASTIC_ENABLED** | Enables Elasticsearch integration | No | "false" | "true" or "false" | +| **ELASTIC_API_KEY** | API key for Elasticsearch | Yes (if using Elasticsearch) | None | Valid Elasticsearch API key | +| **ELASTIC_HOSTS** | Comma-separated list of Elasticsearch hosts | Yes (if using Elasticsearch) | None | Valid Elasticsearch host URLs | +| **ELASTIC_USER** | Username for Elasticsearch basic auth | No | None | Valid username | +| **ELASTIC_PASSWORD** | Password for Elasticsearch basic auth | No | None | Valid password | +| **ELASTIC_INDEX_SUFFIX** | Suffix for Elasticsearch index names | Yes (for single tenant) | None | Any valid string | + +### Redis + +Redis configuration specifies the connection details for Keep's Redis instance. Redis is used for various caching and queueing purposes, making these settings important for optimizing Keep's performance and scalability. + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **REDIS_HOST** | Redis server hostname | No | "localhost" | Valid hostname or IP address | +| **REDIS_PORT** | Redis server port | No | 6379 | Valid port number | +| **REDIS_USERNAME** | Redis username | No | None | Valid username string | +| **REDIS_PASSWORD** | Redis password | No | None | Valid password string | + +### ARQ + +ARQ (Asynchronous Task Queue) configuration controls Keep's background task processing. These settings are crucial for managing how Keep handles long-running or scheduled tasks, ensuring efficient resource utilization and responsiveness. + + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **ARQ_BACKGROUND_FUNCTIONS** | Comma-separated list of background functions to run | No | None | Valid function names | +| **ARQ_KEEP_RESULT** | Duration to keep job results (in seconds) | No | 3600 | Positive integer | +| **ARQ_EXPIRES** | Default job expiration time (in seconds) | No | 3600 | Positive integer | +| **ARQ_EXPIRES_AI** | AI job expiration time (in seconds) | No | 3600000 | Positive integer | + +## Frontend Environment Variables + +Frontend configuration variables control the behavior and features of Keep's user interface. These settings are crucial for customizing the frontend's appearance, functionality, and integration with the backend services. + + +### General + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **API_URL** | Specifies the URL of the Keep backend API | Yes | None | Valid URL | + +### Authentication + +Authentication configuration determines how Keep verifies user identities and manages access control. These settings are essential for securing your Keep instance and integrating with various authentication providers. + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **AUTH_TYPE** | Specifies the authentication type | No | "noauth" | "auth0", "keycloak", "db", "noauth", "oauth2proxy" | +| **NEXTAUTH_URL** | URL for NextAuth authentication | Yes | None | Valid URL | +| **NEXTAUTH_SECRET** | Secret key for NextAuth | Yes | None | Strong secret string + +### Posthog +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **POSTHOG_KEY** | PostHog API key for frontend analytics | No | None | Valid PostHog API key | +| **POSTHOG_HOST** | PostHog Host for frontend analytics | No | None | Valid PostHog Host | + +### Pusher + +Pusher configuration is essential for enabling real-time updates and communication in Keep's frontend. These settings allow the frontend to establish a WebSocket connection with the Pusher server, facilitating instant updates and notifications. + + +| Env var | Purpose | Required | Default Value | Valid options | +|:-------------------:|:-------:|:----------:|:-------------:|:-------------:| +| **PUSHER_DISABLED** | Disables Pusher integration | No | "false" | "true" or "false" | +| **PUSHER_HOST** | Hostname of the Pusher server | No | "localhost" | Valid hostname or IP address | +| **PUSHER_PORT** | Port of the Pusher server | No | 6001 | Valid port number | +| **PUSHER_APP_KEY** | Pusher application key | Yes (if Pusher enabled) | "keepappkey" | Valid Pusher App Key | +| **PUSHER_CLUSTER** | Pusher cluster | No | None | Valid Pusher cluster name | diff --git a/docs/deployment/gke.mdx b/docs/deployment/gke.mdx index 3eea2b7db..dad98f3cd 100644 --- a/docs/deployment/gke.mdx +++ b/docs/deployment/gke.mdx @@ -119,7 +119,7 @@ This ingress supports real-time communication and push updates for the frontend -### Prerequisits +### Prerequisites #### Domain e.g. keep.yourcomapny.com will be used to access Keep UI. diff --git a/docs/deployment/kubernetes.mdx b/docs/deployment/kubernetes.mdx index 593cd15ae..3a7dc2902 100644 --- a/docs/deployment/kubernetes.mdx +++ b/docs/deployment/kubernetes.mdx @@ -3,25 +3,286 @@ title: "Kubernetes" sidebarTitle: "Kubernetes" --- -Keep can be installed via Helm Chart. -First, add the Helm repository of Keep and pull the latest version of the chart: +## Overview + +### High Level Architecture +Keep architecture composes of two main components: + +1. **Keep API** (aka keep backend) - a pythonic server (FastAPI) which serves as Keep's backend +2. **Keep Frontend** - (aka keep ui) - a nextjs server which serves as Keep's frontend + +Keep is also using the following (optional) components: + +3. **Websocket Server** - a soketi server serves as the websocket server to allow real time updates from the server to the browser without refreshing the page +4. **Database Server** - a database which Keep reads/writes for persistency. Keep currently supports sqlite, postgres, mysql and sql server (enterprise) + +### Kubernetes Architecture +Keep's Kubernetes architecture is composed of several components, each with its own set of Kubernetes resources. Here's a detailed breakdown of each component and its associated resources: + +#### General Components +Keep uses kubernetes secret manager to store secrets such as integrations credentials. + +| Kubernetes Resource | Purpose | Required/Optional | Source | +|:-------------------:|:-------:|:-----------------:|:------:| +| ServiceAccount | Provides an identity for processes that run in a Pod. Used mainly for Keep API to access kubernetes secret manager | Required | [serviceaccount.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/serviceaccount.yaml) | +| Role | Defines permissions for the ServiceAccount to manage secrets | Required | [role-secret-manager.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/role-secret-manager.yaml) | +| RoleBinding | Associates the Role with the ServiceAccount | Required | [role-binding-secret-manager.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/role-binding-secret-manager.yaml) | +| Secret Deletion Job | Cleans up Keep-related secrets when the Helm release is deleted | Required | [delete-secret-job.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/delete-secret-job.yaml) | + +#### Frontend Components + +| Kubernetes Resource | Purpose | Required/Optional | Source | +|:-------------------:|:-------:|:-----------------:|:------:| +| Frontend Deployment | Manages the frontend application containers | Required | [frontend.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/frontend.yaml) | +| Frontend Service | Exposes the frontend deployment within the cluster | Required | [frontend-service.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/frontend-service.yaml) | +| Frontend Ingress | Exposes the frontend service to external traffic | Optional | [frontend-ingress.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/frontend-ingress.yaml) | +| Frontend Route (OpenShift) | Exposes the frontend service to external traffic on OpenShift | Optional | [frontend-route.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/frontend-route.yaml) | +| Frontend HorizontalPodAutoscaler | Automatically scales the number of frontend pods | Optional | [frontend-hpa.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/frontend-hpa.yaml) | +| Frontend BackendConfig (GKE) | Configures health checks for Google Cloud Load Balancing | Optional (GKE only) | [backendconfig.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/gke/frontend-gke-healthcheck-config.yaml) | + +#### Backend Components + +| Kubernetes Resource | Purpose | Required/Optional | Source | +|:-------------------:|:-------:|:-----------------:|:------:| +| Backend Deployment | Manages the backend application containers | Required (if backend enabled) | [backend.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/backend.yaml) | +| Backend Service | Exposes the backend deployment within the cluster | Required (if backend enabled) | [backend-service.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/backend-service.yaml) | +| Backend Ingress | Exposes the backend service to external traffic | Optional | [backend-ingress.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/backend-ingress.yaml) | +| Backend Route (OpenShift) | Exposes the backend service to external traffic on OpenShift | Optional | [backend-route.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/backend-route.yaml) | +| Backend HorizontalPodAutoscaler | Automatically scales the number of backend pods | Optional | [backend-hpa.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/backend-hpa.yaml) | +| BackendConfig (GKE) | Configures health checks for Google Cloud Load Balancing | Optional (GKE only) | [backendconfig.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/gke/backend-gke-healthcheck-config.yaml) | + +#### Database Components +Database components are optional. You can spin up Keep with your own database. + +| Kubernetes Resource | Purpose | Required/Optional | Source | +|:-------------------:|:-------:|:-----------------:|:------:| +| Database Deployment | Manages the database containers (e.g. MySQL or Postgres) | Optional | [db.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/db.yaml) | +| Database Service | Exposes the database deployment within the cluster | Required (if deployment enabled) | [db-service.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/db-service.yaml) | +| Database PersistentVolume | Provides persistent storage for the database | Optional | [db-pv.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/db-pv.yaml) | +| Database PersistentVolumeClaim | Claims the persistent storage for the database | Optional | [db-pvc.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/db-pvc.yaml) | + +#### WebSocket Components +WebSocket components are optional. You can spin up Keep with your own *Pusher compatible* WebSocket server. + +| Kubernetes Resource | Purpose | Required/Optional | Source | +|:-------------------:|:-------:|:-----------------:|:------:| +| WebSocket Deployment | Manages the WebSocket server containers (Soketi) | Optional | [websocket-server.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/websocket-server.yaml) | +| WebSocket Service | Exposes the WebSocket deployment within the cluster | Required (if WebSocket enabled) | [websocket-server-service.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/websocket-server-service.yaml) | +| WebSocket Ingress | Exposes the WebSocket service to external traffic | Optional | [websocket-server-ingress.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/websocket-server-ingress.yaml) | +| WebSocket Route (OpenShift) | Exposes the WebSocket service to external traffic on OpenShift | Optional | [websocket-server-route.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/websocket-server-route.yaml) | +| WebSocket HorizontalPodAutoscaler | Automatically scales the number of WebSocket server pods | Optional | [websocket-server-hpa.yaml](https://github.com/keephq/helm-charts/blob/main/charts/keep/templates/websocket-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](/deployment/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 +```yaml +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. + # Enable or disable frontend ingress. + ingress: + enabled: true + hosts: + - host: keep.yourcompany.com + paths: + - path: / + pathType: Prefix + tls: + - hosts: + - keep.yourcompany.com + secretName: frontend-tls # Secret for TLS certificates. +``` + +#### 2. Backend Configuration +```yaml +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. + ingress: + enabled: true # Enable or disable backend ingress. + hosts: + - paths: + - path: / + pathType: Prefix ``` + +#### 3. WebSocket Server Configuration +Keep uses Soketi as its websocket server. To learn how to configure it, please see [Soketi docs](https://github.com/soketi/charts/tree/master/charts/soketi). + + +#### 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](https://slack.keephq.dev) and we will be happy to help. + + + +## Installation +The recommended way to install Keep in kubernetes is via Helm Chart. + +First, add the Helm repository of Keep and pull the latest version of the chart: +```bash helm repo add keephq https://keephq.github.io/helm-charts helm pull keephq/keep ``` -Next, install using: -``` -helm install keep keephq/keep +Next, install Keep using: +```bash + +# it is always recommended to install Keep in a seperate namespace +kubectl create ns keep + +helm install -n keep keep keephq/keep --set namespace=keep ``` + +## Expose Keep with port-forward Notice for it to work locally, you'll need this port forwarding: ``` # expose the UI -kubectl port-forward svc/keep-frontend 3000:3000 +kubectl -n keep port-forward svc/keep-frontend 3000:3000 +``` + +## Expose Keep with ingress (HTTP) +Once you are ready to expose Keep to the outer world, Keep's helm chart comes with pre-configured ingress + +```bash +kubectl -n keep get ingress +NAME CLASS HOSTS ADDRESS PORTS AGE +keep-backend 34.54.XXX.XXX 80 75m +keep-frontend 34.54.XXX.XXX 80 70m +``` + +## Expose Keep with ingress (HTTPS) + +#### Prerequisites + +1. Domain -e.g. keep.yourcomapny.com will be used to access Keep UI. +2. Certificate - both private key (.pem) and certificate (.crt) + +#### Store the certificate as kubernetes secret +Assuming the private key stored as `tls.key` and the certificate stored as `tls.crt`: + +```bash +kubectl create secret tls frontend-tls --cert=./tls.crt --key=./tls.key -n keep + +# you should see: +secret/frontend-tls created +``` + +#### Upgrade Keep to use TLS + +Create this `values.yaml`: +** Note to change keep.yourcomapny.com to your domain ** + +```yaml +namespace: keep +frontend: + ingress: + enabled: true + hosts: + - host: keep.yourcompany.com + paths: + - path: / + pathType: Prefix + tls: + - hosts: + - keep.yourcompany.com + secretName: frontend-tls + env: + - name: NEXTAUTH_SECRET + value: secret + # Changed the NEXTAUTH_URL + - name: NEXTAUTH_URL + value: https://keep.yourcompany.com + # https://github.com/nextauthjs/next-auth/issues/600 + - name: VERCEL + value: 1 + - name: API_URL + value: http://keep-backend:8080 + - name: NEXT_PUBLIC_POSTHOG_KEY + value: "phc_muk9qE3TfZsX3SZ9XxX52kCGJBclrjhkP9JxAQcm1PZ" + - name: NEXT_PUBLIC_POSTHOG_HOST + value: https://app.posthog.com + - name: ENV + value: development + - name: NODE_ENV + value: development + - name: HOSTNAME + value: 0.0.0.0 + - name: PUSHER_HOST + value: keep-websocket.default.svc.cluster.local + - name: PUSHER_PORT + value: 6001 + - name: PUSHER_APP_KEY + value: "keepappkey" + +backend: + env: + # Added the KEEP_API_URL + - name: KEEP_API_URL + value: https://keep.yourcompany.com/backend + - name: DATABASE_CONNECTION_STRING + value: mysql+pymysql://root@keep-database:3306/keep + - name: SECRET_MANAGER_TYPE + value: k8s + - name: PORT + value: "8080" + - name: PUSHER_APP_ID + value: 1 + - name: PUSHER_APP_KEY + value: keepappkey + - name: PUSHER_APP_SECRET + value: keepappsecret + - name: PUSHER_HOST + value: keep-websocket + - name: PUSHER_PORT + value: 6001 +database: + # this is needed since o/w helm install fails. if you are using different storageClass, edit the value here. + pvc: + storageClass: "standard-rwo" ``` +Now, update Keep: +``` +helm upgrade -n keep keep keephq/keep -f values.yaml +``` + + To learn more about Keep's helm chart, see https://github.com/keephq/helm-charts/blob/main/README.md To discover about how to configure Keep using Helm, see auto generated helm-docs at https://github.com/keephq/helm-charts/blob/main/charts/keep/README.md diff --git a/docs/mint.json b/docs/mint.json index 2ac018933..d1518d4dd 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -56,6 +56,7 @@ { "group": "Deployment", "pages": [ + "deployment/configuration", { "group": "Authentication", "pages": [ diff --git a/keep-ui/next.config.js b/keep-ui/next.config.js index d1d4e6025..bf8da95e9 100644 --- a/keep-ui/next.config.js +++ b/keep-ui/next.config.js @@ -66,4 +66,8 @@ const nextConfig = { }, }; -module.exports = nextConfig; +const withBundleAnalyzer = require("@next/bundle-analyzer")({ + enabled: process.env.ANALYZE === "true", +}); + +module.exports = withBundleAnalyzer(nextConfig); diff --git a/keep-ui/package-lock.json b/keep-ui/package-lock.json index f20805261..8466408b8 100644 --- a/keep-ui/package-lock.json +++ b/keep-ui/package-lock.json @@ -372,6 +372,7 @@ "zod": "^3.22.3" }, "devDependencies": { + "@next/bundle-analyzer": "^14.2.15", "@tailwindcss/typography": "^0.5.12", "@types/d3-time-format": "^4.0.3", "@types/js-cookie": "^3.0.3", @@ -3417,6 +3418,15 @@ "node": ">17.0.0" } }, + "node_modules/@discoveryjs/json-ext": { + "version": "0.5.7", + "resolved": "https://registry.npmjs.org/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz", + "integrity": "sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==", + "dev": true, + "engines": { + "node": ">=10.0.0" + } + }, "node_modules/@dnd-kit/accessibility": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/@dnd-kit/accessibility/-/accessibility-3.1.0.tgz", @@ -4977,6 +4987,15 @@ "resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz", "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==" }, + "node_modules/@next/bundle-analyzer": { + "version": "14.2.15", + "resolved": "https://registry.npmjs.org/@next/bundle-analyzer/-/bundle-analyzer-14.2.15.tgz", + "integrity": "sha512-W6iyrp/3G7WbIztDcNt+owYX1iv37m9f4RJs0fa/Ayw4EDdjNPX6qKQrC7gBrESHV3FuchED+8R+CNiw1i78eQ==", + "dev": true, + "dependencies": { + "webpack-bundle-analyzer": "4.10.1" + } + }, "node_modules/@next/env": { "version": "14.2.13", "resolved": "https://registry.npmjs.org/@next/env/-/env-14.2.13.tgz", @@ -5355,6 +5374,12 @@ "pick-by-alias": "^1.2.0" } }, + "node_modules/@polka/url": { + "version": "1.0.0-next.28", + "resolved": "https://registry.npmjs.org/@polka/url/-/url-1.0.0-next.28.tgz", + "integrity": "sha512-8LduaNlMZGwdZ6qWrKlfa+2M4gahzFkprZiAt2TF8uS0qQgBizKXpXURqvTJ4WtmupWxaLqjRb2UCTe72mu+Aw==", + "dev": true + }, "node_modules/@popperjs/core": { "version": "2.11.8", "resolved": "https://registry.npmjs.org/@popperjs/core/-/core-2.11.8.tgz", @@ -6964,6 +6989,18 @@ "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" } }, + "node_modules/acorn-walk": { + "version": "8.3.4", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.4.tgz", + "integrity": "sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==", + "dev": true, + "dependencies": { + "acorn": "^8.11.0" + }, + "engines": { + "node": ">=0.4.0" + } + }, "node_modules/add": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/add/-/add-2.0.6.tgz", @@ -9079,6 +9116,12 @@ "resolved": "https://registry.npmjs.org/dayjs/-/dayjs-1.11.11.tgz", "integrity": "sha512-okzr3f11N6WuqYtZSvm+F776mB41wRZMhKP+hc34YdW+KmtYYK9iqvHSwo2k9FEH3fhGXvOPV6yz2IcSrfRUDg==" }, + "node_modules/debounce": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/debounce/-/debounce-1.2.1.tgz", + "integrity": "sha512-XRRe6Glud4rd/ZGQfiV1ruXSfbvfJedlV9Y6zOlP+2K04vBYiJEte6stfFkCP03aMnY5tsipamumUjL14fofug==", + "dev": true + }, "node_modules/debug": { "version": "4.3.7", "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz", @@ -9492,6 +9535,12 @@ "resolved": "https://registry.npmjs.org/dup/-/dup-1.0.0.tgz", "integrity": "sha512-Bz5jxMMC0wgp23Zm15ip1x8IhYRqJvF3nFC0UInJUDkN1z4uNPk9jTnfCUJXbOGiQ1JbXLQsiV41Fb+HXcj5BA==" }, + "node_modules/duplexer": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", + "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==", + "dev": true + }, "node_modules/duplexify": { "version": "3.7.1", "resolved": "https://registry.npmjs.org/duplexify/-/duplexify-3.7.1.tgz", @@ -11622,6 +11671,21 @@ "node": ">= 8" } }, + "node_modules/gzip-size": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/gzip-size/-/gzip-size-6.0.0.tgz", + "integrity": "sha512-ax7ZYomf6jqPTQ4+XCpUGyXKHk5WweS+e05MBO4/y3WJ5RkmPXNKvX+bx1behVILVwr6JSQvZAku021CHPXG3Q==", + "dev": true, + "dependencies": { + "duplexer": "^0.1.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/has": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/has/-/has-1.0.4.tgz", @@ -11873,6 +11937,12 @@ "resolved": "https://registry.npmjs.org/hsluv/-/hsluv-0.0.3.tgz", "integrity": "sha512-08iL2VyCRbkQKBySkSh6m8zMUa3sADAxGVWs3Z1aPcUkTJeK0ETG4Fc27tEmQBGUAXZjIsXOZqBvacuVNSC/fQ==" }, + "node_modules/html-escaper": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", + "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", + "dev": true + }, "node_modules/html-url-attributes": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/html-url-attributes/-/html-url-attributes-3.0.0.tgz", @@ -14920,6 +14990,15 @@ "node": ">=4" } }, + "node_modules/mrmime": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mrmime/-/mrmime-2.0.0.tgz", + "integrity": "sha512-eu38+hdgojoyq63s+yTpN4XMBdt5l8HhMhc4VKLO9KM5caLIBvUm4thi7fFaxyTmCKeNnXZ5pAlBwCUnhA09uw==", + "dev": true, + "engines": { + "node": ">=10" + } + }, "node_modules/ms": { "version": "2.1.3", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", @@ -15514,6 +15593,15 @@ "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz", "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==" }, + "node_modules/opener": { + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/opener/-/opener-1.5.2.tgz", + "integrity": "sha512-ur5UIdyw5Y7yEj9wLzhqXiy6GZ3Mwx0yGI+5sMn2r0N0v3cKJvUmFH5yPP+WXh9e0xfyzyJX95D8l088DNFj7A==", + "dev": true, + "bin": { + "opener": "bin/opener-bin.js" + } + }, "node_modules/openid-client": { "version": "5.6.5", "resolved": "https://registry.npmjs.org/openid-client/-/openid-client-5.6.5.tgz", @@ -18470,6 +18558,20 @@ "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.2.tgz", "integrity": "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ==" }, + "node_modules/sirv": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/sirv/-/sirv-2.0.4.tgz", + "integrity": "sha512-94Bdh3cC2PKrbgSOUqTiGPWVZeSiXfKOVZNJniWoqrWrRkB1CJzBU3NEbiTsPcYy1lDsANA/THzS+9WBiy5nfQ==", + "dev": true, + "dependencies": { + "@polka/url": "^1.0.0-next.24", + "mrmime": "^2.0.0", + "totalist": "^3.0.0" + }, + "engines": { + "node": ">= 10" + } + }, "node_modules/slash": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", @@ -19445,6 +19547,15 @@ "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==" }, + "node_modules/totalist": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/totalist/-/totalist-3.0.1.tgz", + "integrity": "sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, "node_modules/tr46": { "version": "0.0.3", "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", @@ -20206,6 +20317,63 @@ "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==" }, + "node_modules/webpack-bundle-analyzer": { + "version": "4.10.1", + "resolved": "https://registry.npmjs.org/webpack-bundle-analyzer/-/webpack-bundle-analyzer-4.10.1.tgz", + "integrity": "sha512-s3P7pgexgT/HTUSYgxJyn28A+99mmLq4HsJepMPzu0R8ImJc52QNqaFYW1Z2z2uIb1/J3eYgaAWVpaC+v/1aAQ==", + "dev": true, + "dependencies": { + "@discoveryjs/json-ext": "0.5.7", + "acorn": "^8.0.4", + "acorn-walk": "^8.0.0", + "commander": "^7.2.0", + "debounce": "^1.2.1", + "escape-string-regexp": "^4.0.0", + "gzip-size": "^6.0.0", + "html-escaper": "^2.0.2", + "is-plain-object": "^5.0.0", + "opener": "^1.5.2", + "picocolors": "^1.0.0", + "sirv": "^2.0.3", + "ws": "^7.3.1" + }, + "bin": { + "webpack-bundle-analyzer": "lib/bin/analyzer.js" + }, + "engines": { + "node": ">= 10.13.0" + } + }, + "node_modules/webpack-bundle-analyzer/node_modules/commander": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", + "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", + "dev": true, + "engines": { + "node": ">= 10" + } + }, + "node_modules/webpack-bundle-analyzer/node_modules/ws": { + "version": "7.5.10", + "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.10.tgz", + "integrity": "sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ==", + "dev": true, + "engines": { + "node": ">=8.3.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": "^5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, "node_modules/whatwg-url": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", @@ -20409,6 +20577,28 @@ "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==" }, + "node_modules/ws": { + "version": "8.18.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.0.tgz", + "integrity": "sha512-8VbfWfHLbbwu3+N6OKsOMpBdT4kXPDDB9cJk2bJ6mh9ucxdlnNvH1e+roYkKmN9Nxw2yjz7VzeO9oOz2zJ04Pw==", + "optional": true, + "peer": true, + "engines": { + "node": ">=10.0.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": ">=5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, "node_modules/xss": { "version": "1.0.15", "resolved": "https://registry.npmjs.org/xss/-/xss-1.0.15.tgz", diff --git a/keep-ui/package.json b/keep-ui/package.json index 291950118..f24d81fcf 100644 --- a/keep-ui/package.json +++ b/keep-ui/package.json @@ -373,6 +373,7 @@ "zod": "^3.22.3" }, "devDependencies": { + "@next/bundle-analyzer": "^14.2.15", "@tailwindcss/typography": "^0.5.12", "@types/d3-time-format": "^4.0.3", "@types/js-cookie": "^3.0.3", diff --git a/scripts/docs_get_providers_list.py b/scripts/docs_get_providers_list.py index 03107213c..851b32417 100644 --- a/scripts/docs_get_providers_list.py +++ b/scripts/docs_get_providers_list.py @@ -27,7 +27,6 @@ "keep", "bigquery", "parseable", - "smtp", ] # known not documented providers https://github.com/keephq/keep/issues/2033 @@ -58,11 +57,15 @@ def validate_all_providers_are_documented(documented_providers): for provider in ProvidersFactory.get_all_providers(): provider_name = provider.display_name.lower() if provider_name not in documented_providers and provider_name not in NON_DOCUMENTED_PROVIDERS: - print( - f"""Provider {provider_name} is not documented in the docs/providers/documentation folder, -please document it and run the scripts/docs_get_providers_list.py --validate script again.""" - ) - raise Exception(f"Provider {provider_name} is not documented.") + raise Exception(f"""Provider "{provider_name}" is not documented in the docs/providers/documentation folder, +please document it and run the scripts/docs_get_providers_list.py --validate script again. + +Provider's PROVIDER_DISPLAY_NAME should match the title in the documentation file: {{PROVIDER_DISPLAY_NAME}}-provider.mdx. + +{provider_name}-provider.mdx not found. + +Documented providers: {documented_providers} +Excluded list: {NON_DOCUMENTED_PROVIDERS}""") def main(): """