Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated standalone helm chart config options. #888

Merged
merged 1 commit into from
Jul 16, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 50 additions & 11 deletions pages/getting-started/install-memgraph/kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,17 +81,56 @@ Lab](/data-visualization).
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.storagePVCSize` | Size of the persistent volume claim for storage | `1Gi`
`persistentVolumeClaim.logPVC` | Enable persistent volume claim for logs | `true`
`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` |
| `useImagePullSecrets` | Override the default imagePullSecrets | `false` |
| `imagePullSecrets` | Specify image pull secrets | `- name: regcred` |
| `replicaCount` | Number of Memgraph instances to run. Note: no replication or HA support. | `1` |
| `affinity.nodeKey` | Key for node affinity (Preferred) | `""` |
| `affinity.nodeValue` | Value for node affinity (Preferred) | `""` |
| `service.type` | Kubernetes service type | `ClusterIP` |
| `service.enableBolt` | Enable Bolt protocol | `true` |
| `service.boltPort` | Bolt protocol port | `7687` |
| `service.boltProtocol` | Protocol used by Bolt | `TCP` |
| `service.enableWebsocketMonitoring` | Enable WebSocket monitoring | `false` |
| `service.websocketPortMonitoring` | WebSocket monitoring port | `7444` |
| `service.websocketPortMonitoringProtocol` | Protocol used by WebSocket monitoring | `TCP` |
| `service.enableHttpMonitoring` | Enable HTTP monitoring | `false` |
| `service.httpPortMonitoring` | HTTP monitoring port | `9091` |
| `service.httpPortMonitoringProtocol` | Protocol used by HTTP monitoring | `http` |
| `service.annotations` | Annotations to add to the service | `{}` |
| `persistentVolumeClaim.createStorageClaim` | Enable creation of a Persistent Volume Claim for storage | `true` |
| `persistentVolumeClaim.storageClassName` | Storage class name for the persistent volume claim | `""` |
| `persistentVolumeClaim.storageSize` | Size of the persistent volume claim for storage | `10Gi` |
| `persistentVolumeClaim.existingClaim` | Use an existing Persistent Volume Claim | `memgraph-0` |
| `persistentVolumeClaim.storageVolumeName` | Name of an existing Volume to create a PVC for | `""` |
| `persistentVolumeClaim.createLogStorage` | Enable creation of a Persistent Volume Claim for logs | `true` |
| `persistentVolumeClaim.logStorageClassName` | Storage class name for the persistent volume claim for logs | `""` |
| `persistentVolumeClaim.logStorageSize` | Size of the persistent volume claim for logs | `1Gi` |
| `memgraphConfig` | List of strings defining Memgraph configuration settings | `["--also-log-to-stderr=true"]` |
| `memgraphUser` | User for the Memgraph database | `""` |
| `memgraphPassword` | Password for the Memgraph database | `""` |
| `memgraphEnterpriseLicense` | Memgraph Enterprise License | `""` |
| `memgraphOrganizationName` | Organization name for Memgraph Enterprise License | `""` |
| `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. | `{}` |
| `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. | `""` |
| `container.terminationGracePeriodSeconds` | Grace period for pod termination | `1800` |
| `probes.liveliness.initialDelaySeconds` | Initial delay for liveliness probe | `10` |
| `probes.liveliness.periodSeconds` | Period seconds for liveliness probe | `60` |
| `probes.liveliness.failureThreshold` | Failure threshold for liveliness probe | `3` |
| `probes.readiness.initialDelaySeconds` | Initial delay for readiness probe | `10` |
| `probes.readiness.periodSeconds` | Period seconds for readiness probe | `30` |
| `probes.readiness.failureThreshold` | Failure threshold for readiness probe | `3` |
| `probes.startup.initialDelaySeconds` | Initial delay for startup probe | `10` |
| `probes.startup.periodSeconds` | Period seconds for startup probe | `10` |
| `probes.startup.failureThreshold` | Failure threshold for startup probe | `30` |

To change the default chart values, provide your own `values.yaml` file during
the installation:
Expand Down