add docs for opensearch, default to single-node install

Signed-off-by: Pascal Sthamer <10992664+P4sca1@users.noreply.github.com>
This commit is contained in:
Pascal Sthamer
2025-04-04 14:13:21 +02:00
parent 557c39c8fc
commit 0880f4fffe
2 changed files with 24 additions and 1 deletions
@@ -105,6 +105,15 @@ SHUFFLE_DEFAULT_APIKEY: "72E41083-A6F6-4A1B-8538-B06B577F47F0" # Shuffle uses uu
SHUFFLE_ENCRYPTION_MODIFIER: "MyShuffleEncryptionModifier" SHUFFLE_ENCRYPTION_MODIFIER: "MyShuffleEncryptionModifier"
``` ```
## OpenSearch
Shuffle uses OpenSearch as its database. This helm chart installs a single-node OpenSearch cluster using [the Bitnami Helm Chart](https://github.com/bitnami/charts/blob/main/bitnami/opensearch/values.yaml).
You can customize the helm chart using the values of the Bitnami helm chart under the `opensearch` prefix (e.g. `opensearch.master.replicaCOunt`).
Alternatively, you can disable the built-in OpenSearch installation using `opensearch.enabled=false`.
Provide your own OpenSearch url and username with `backend.openSearch.url` and `backend.openSearch.username`.
The password should be provided with the `SHUFFLE_OPENSEARCH_PASSWORD` env variable to the backend.
## Parameters ## Parameters
### Global parameters ### Global parameters
@@ -598,4 +607,3 @@ SHUFFLE_ENCRYPTION_MODIFIER: "MyShuffleEncryptionModifier"
### Other Parameters ### Other Parameters
@@ -1744,9 +1744,24 @@ volumePermissions:
## OpenSearch chart configuration ## OpenSearch chart configuration
## ref: https://github.com/bitnami/charts/blob/main/bitnami/opensearch/values.yaml ## ref: https://github.com/bitnami/charts/blob/main/bitnami/opensearch/values.yaml
## @param opensearch.enabled Switch to enable or disable the opensearch helm chart ## @param opensearch.enabled Switch to enable or disable the opensearch helm chart
## @skip opensearch.master
## @skip opensearch.data
## @skip opensearch.coordinating
## @skip opensearch.ingest
## @skip opensearch.dashboards
## ##
opensearch: opensearch:
enabled: true enabled: true
master:
replicaCount: 1
data:
replicaCount: 1
coordinating:
replicaCount: 1
ingest:
replicaCount: 1
dashboards:
enabled: true
## @section Vault Parameters ## @section Vault Parameters
## ##