Skip to content

Commit 6aa27bd

Browse files
Add immudb config doc
1 parent 6ac1776 commit 6aa27bd

File tree

2 files changed

+9
-12
lines changed

2 files changed

+9
-12
lines changed

docs/configuration.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,10 @@ After deploying the operator, you can create a `Immudb` resource to create a dat
33

44
The following `spec values` can be updated:
55

6-
| name | type | default | meaning |
6+
| Name | Type | Default value | Description |
77
| --- | --- | --- | --- |
8-
| image | string | "codenotary/immudb:latest" | Immudb image |
9-
| imagePullPolicy | string | "IfNotPresent" | ImagePullPolicy of immudb image |
10-
| 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. |
11-
12-
13-
You can create many databases by creating multiple `Immudb`.
14-
15-
8+
| image | string | "codenotary/immudb:latest" | The Immudb image. |
9+
| imagePullPolicy | string | "IfNotPresent" | ImagePullPolicy of immudb image. |
10+
| 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. |
11+
| volume.storageClassName | string | Name of the default storageClass of your cluster. | StorageClassName of the database. |
12+
| volume.size | string | No default value, mandatory to set. | Size of the database, e.g., 5Mi, 10Gi. |

docs/installation.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ The operator Helm chart is deployed by default with [this values.yaml](/charts/o
111111

112112
| Name | Type | Default value
113113
| --- | --- | --- |
114-
| operator.image.repository | string | ghcr.io/unagex/immudb-operator/controller |
115-
| operator.image.tag | string | default to latest version at time of installation |
116-
| operator.image.pullPolicy | string | IfNotPresent |
114+
| operator.image.repository | string | "ghcr.io/unagex/immudb-operator/controller" |
115+
| operator.image.tag | string | Default to latest version at time of installation. |
116+
| operator.image.pullPolicy | string | "IfNotPresent" |
117117
| resources.limits.cpu | string | nil |
118118
| resources.limits.memory | string | nil |
119119
| resources.requests.cpu | string | nil |

0 commit comments

Comments
 (0)