From c5ab6877a7eefd92e9c174a811165b7c2196b188 Mon Sep 17 00:00:00 2001 From: Ante Javor Date: Thu, 25 Apr 2024 12:31:46 +0200 Subject: [PATCH] Update README.md and version. --- charts/memgraph/Chart.yaml | 18 ++++++------ charts/memgraph/README.md | 56 ++++++++++++++++++++++++++++---------- 2 files changed, 50 insertions(+), 24 deletions(-) diff --git a/charts/memgraph/Chart.yaml b/charts/memgraph/Chart.yaml index f157e11..945b448 100644 --- a/charts/memgraph/Chart.yaml +++ b/charts/memgraph/Chart.yaml @@ -2,17 +2,17 @@ apiVersion: v2 name: memgraph home: https://memgraph.com/ type: application -version: 0.1.1 -appVersion: "2.10.0" +version: 0.1.2 +appVersion: "2.16.0" description: MemgraphDB Helm Chart keywords: - - graph - - database - - cypher - - analytics +- graph +- database +- cypher +- analytics icon: https://public-assets.memgraph.com/memgraph-logo/logo-large.png sources: - - https://github.com/memgraph/memgraph +- https://github.com/memgraph/memgraph maintainers: - - name: Memgraph - email: tech@memgraph.com +- name: Memgraph + email: tech@memgraph.com diff --git a/charts/memgraph/README.md b/charts/memgraph/README.md index 17dfc2c..c236b59 100644 --- a/charts/memgraph/README.md +++ b/charts/memgraph/README.md @@ -18,25 +18,51 @@ Or you can modify a `values.yaml` file and override the desired values: helm install memgraph/memgraph -f values.yaml ``` -## Configuration options +## Configuration Options + The following table lists the configurable parameters of the Memgraph chart and their default values. -parameter | description | default ---- | --- | --- -`image` | Memgraph Docker image repository | `memgraph` -`persistentVolumeClaim.storagePVC` | Enable persistent volume claim for storage | `true` -`persistanceVolumeClaim.storagePVCClassName` | Storage class name for the persistent volume claim for storage. If not specified, default will be used | `""` -`persistanceVolumeClaim.storagePVCSize` | Size of the persistent volume claim for storage | `1Gi` -`persistentVolumeClaim.logPVC` | Enable persistent volume claim for logs | `true` -`persistanceVolumeClaim.logPVCClassName` | Storage class name for the persistent volume claim for logs. If not specified, default will be used | `""` -`persistanceVolumeClaim.logPVCSize` | Size of the persistent volume claim for logs | `256Mi` -`service.type` | Kubernetes service type | `NodePort` -`service.port` | Kubernetes service port | `7687` -`service.targetPort` | Kubernetes service target port | `7687` -`memgraphConfig` | Memgraph configuration settings | `["--also-log-to-stderr=true"]` +| Parameter | Description | Default | +|---------------------------------------------|-----------------------------------------------------------------------------------------------------|-----------------------------------------| +| `image.repository` | Memgraph Docker image repository | `memgraph/memgraph` | +| `image.tag` | Specific tag for the Memgraph Docker image. Overrides the image tag whose default is chart version. | `""` (Defaults to chart's app version) | +| `image.pullPolicy` | Image pull policy | `IfNotPresent` | +| `replicaCount` | Number of Memgraph instances to run. Note: no replication or HA support. | `1` | +| `service.type` | Kubernetes service type | `NodePort` | +| `service.port` | Kubernetes service port | `7687` | +| `service.targetPort` | Kubernetes service target port | `7687` | +| `service.protocol` | Protocol used by the service | `TCP` | +| `service.annotations` | Annotations to add to the service | `{}` | +| `persistentVolumeClaim.storagePVC` | Enable persistent volume claim for storage | `true` | +| `persistentVolumeClaim.storagePVCClassName` | Storage class name for the persistent volume claim for storage. If not specified, default used. | `""` | +| `persistentVolumeClaim.storagePVCSize` | Size of the persistent volume claim for storage | `1Gi` | +| `persistentVolumeClaim.logPVC` | Enable persistent volume claim for logs | `true` | +| `persistentVolumeClaim.logPVCClassName` | Storage class name for the persistent volume claim for logs. If not specified, default used. | `""` | +| `persistentVolumeClaim.logPVCSize` | Size of the persistent volume claim for logs | `256Mi` | +| `memgraphConfig` | List of strings defining Memgraph configuration settings | `["--also-log-to-stderr=true"]` | +| `statefulSetAnnotations` | Annotations to add to the stateful set | `{}` | +| `podAnnotations` | Annotations to add to the pod | `{}` | +| `resources` | CPU/Memory resource requests/limits. Left empty by default. | `{}` (See note on uncommenting) | +| `serviceAccount.create` | Specifies whether a service account should be created | `true` | +| `serviceAccount.annotations` | Annotations to add to the service account | `{}` | +| `serviceAccount.name` | The name of the service account to use. If not set and create is true, a name is generated. | `""` | + +**Note:** It's often recommended not to specify default resources and leave it as a conscious choice for the user. If you want to specify resources, uncomment the following lines in your `values.yaml`, adjust them as necessary: + +```yaml +resources: + limits: + cpu: "100m" + memory: "128Mi" + requests: + cpu: "100m" + memory: "128Mi" -The `memgraphConfig` parameter should be a list of strings defining the values of Memgraph configuration settings. For example, this is how you can define `memgraphConfig` parameter in your `values.yaml`: ``` + +The `memgraphConfig` parameter should be a list of strings defining the values of Memgraph configuration settings. For example, this is how you can define `memgraphConfig` parameter in your `values.yaml`: + +```yaml memgraphConfig: - "--also-log-to-stderr=true" - "--log-level=TRACE"