Skip to content

Commit

Permalink
Add immudb config doc
Browse files Browse the repository at this point in the history
  • Loading branch information
MathieuCesbron committed Feb 8, 2024
1 parent 6ac1776 commit f7b1d5f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 12 deletions.
15 changes: 6 additions & 9 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,10 @@ After deploying the operator, you can create a `Immudb` resource to create a dat

The following `spec values` can be updated:

| name | type | default | meaning |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| image | string | "codenotary/immudb:latest" | Immudb image |
| imagePullPolicy | string | "IfNotPresent" | ImagePullPolicy of immudb image |
| replicas | int | nil (mandatory to set) | Number of replicas of immudb image. The value can only be 1 at the moment. The immudb team is working hard in adding replication in the future. |


You can create many databases by creating multiple `Immudb`.


| image | string | "codenotary/immudb:latest" | The Immudb image. |
| imagePullPolicy | string | "IfNotPresent" | ImagePullPolicy of immudb image. |
| replicas | int | 1 | Number of replicas of immudb image. The value can only be 1 at the moment. The immudb team is working hard in adding replication in the future. |
| volume.storageClassName | string | Name of the default storageClass of your cluster | storageClassName of the database. |
| volume.size | string | No default value, mandatory to set | Size of the database, e.g., 5Mi, 10Gi. |
6 changes: 3 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ The operator Helm chart is deployed by default with [this values.yaml](/charts/o

| Name | Type | Default value
| --- | --- | --- |
| operator.image.repository | string | ghcr.io/unagex/immudb-operator/controller |
| operator.image.tag | string | default to latest version at time of installation |
| operator.image.pullPolicy | string | IfNotPresent |
| operator.image.repository | string | "ghcr.io/unagex/immudb-operator/controller" |
| operator.image.tag | string | Default to latest version at time of installation. |
| operator.image.pullPolicy | string | "IfNotPresent" |
| resources.limits.cpu | string | nil |
| resources.limits.memory | string | nil |
| resources.requests.cpu | string | nil |
Expand Down

0 comments on commit f7b1d5f

Please sign in to comment.