Skip to content

Commit

Permalink
chore(docs): fix k8s and configuration (#2184)
Browse files Browse the repository at this point in the history
  • Loading branch information
shahargl authored Oct 13, 2024
1 parent 5e55ce7 commit 3e6d63f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/deployment/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Elasticsearch configuration controls Keep's integration with Elasticsearch for a
| **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 Configuration
### Redis
<Info>
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.
</Info>
Expand All @@ -187,7 +187,7 @@ Redis configuration specifies the connection details for Keep's Redis instance.
| **REDIS_USERNAME** | Redis username | No | None | Valid username string |
| **REDIS_PASSWORD** | Redis password | No | None | Valid password string |

### ARQ Configuration
### ARQ
<Info>
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.
</Info>
Expand Down
4 changes: 2 additions & 2 deletions docs/deployment/kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Keep's Kubernetes architecture is composed of several components, each with its
| 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
<Tip>Database components are optional. You can spin up Keep with external database that doesn't by Keep or event not deployed in Kubernetes</Tip>
<Tip>Database components are optional. You can spin up Keep with your own database.</Tip>

| Kubernetes Resource | Purpose | Required/Optional | Source |
|:-------------------:|:-------:|:-----------------:|:------:|
Expand All @@ -63,7 +63,7 @@ Keep's Kubernetes architecture is composed of several components, each with its
| 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
<Tip>WebSocket components are optional. You can spin up Keep with external database that doesn't by Keep or event not deployed in Kubernetes</Tip>
<Tip>WebSocket components are optional. You can spin up Keep with your own *Pusher compatible* WebSocket server.</Tip>

| Kubernetes Resource | Purpose | Required/Optional | Source |
|:-------------------:|:-------:|:-----------------:|:------:|
Expand Down

0 comments on commit 3e6d63f

Please sign in to comment.