Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@tewnut
tewnut committed Jan 24, 2024
1 parent 3bb9cf6 commit e11a9fe
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 15 deletions.
64 changes: 51 additions & 13 deletions charts/memgraph-platform/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,58 @@ helm install <resource-name> memgraph/memgraph-platform -f values.yaml
```

## 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.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"]` |
When working with Memgraph Platform Docker image, you should pass configuration flags inside of environment variables.

For example, you can start the memgraph Docker image with docker run memgraph/memgraph --bolt-port=7687 --log-level=TRACE, but you should start memgraph-platform Docker image with docker run -p 7687:7687 -p 7444:7444 -p 3000:3000 -e MEMGRAPH="--bolt-port=7687 --log-level=TRACE" memgraph/memgraph-platform.

Each configuration setting is in the form: --setting-name=value.

For all available database settings, refer to the [Configuration settings reference guide](https://memgraph.com/docs/memgraph/reference-guide/configuration).

The following table lists the configurable parameters of the Memgraph Platform chart and their default values.

| Parameter | Description | Default |
| -------------------------------------------- | ----------------------------------------------------------- | --------------------------- |
| `replicaCount` | Number of replicas | `1` |
| `image.repository` | Memgraph Platform Docker image repository | `memgraph-platform` |
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
| `image.tag` | Image tag (overrides chart appVersion) | `""` |
| `imagePullSecrets` | Image pull secrets | `[]` |
| `nameOverride` | Override chart name | `""` |
| `fullnameOverride` | Override full chart name | `""` |
| `serviceAccount.create` | Create service account | `true` |
| `serviceAccount.automount` | Automatically mount service account API credentials | `true` |
| `serviceAccount.annotations` | Service account annotations | `{}` |
| `serviceAccount.name` | Service account name | (auto-generated if not set) |
| `podAnnotations` | Annotations to add to the pods | `{}` |
| `podLabels` | Labels to add to the pods | `{}` |
| `podSecurityContext` | Pod-level security context | `{}` |
| `securityContext` | Container security context | `{}` |
| `service.type` | Kubernetes service type | `ClusterIP` |
| `service.portBolt` | Service port for Bolt protocol | `7687` |
| `service.portLab` | Service port for Lab UI | `3000` |
| `service.portLog` | Service port for logs | `7444` |
| `env.MEMGRAPH` | Memgraph environment variable | `{}` |
| `persistentVolumeClaim.storagePVC` | Enable persistent volume claim for storage | `true` |
| `persistentVolumeClaim.storagePVCSize` | Size of the persistent volume claim for storage | `1Gi` |
| `persistentVolumeClaim.logPVC` | Enable persistent volume claim for logs | `true` |
| `persistentVolumeClaim.logPVCSize` | Size of the persistent volume claim for logs | `256Mi` |
| `ingress.enabled` | Enable Ingress | `false` |
| `ingress.className` | Ingress class name | `""` |
| `ingress.annotations` | Ingress annotations | `{}` |
| `ingress.hosts` | Ingress hosts | `[]` |
| `resources` | Resource requests and limits | `{}` |
| `livenessProbe` | Liveness probe settings | `{}` |
| `readinessProbe` | Readiness probe settings | `{}` |
| `autoscaling.enabled` | Enable Horizontal Pod Autoscaler | `false` |
| `autoscaling.minReplicas` | Minimum number of replicas for autoscaling | `1` |
| `autoscaling.maxReplicas` | Maximum number of replicas for autoscaling | `100` |
| `autoscaling.targetCPUUtilizationPercentage` | Target CPU utilization percentage for autoscaling | `80` |
| `volumes` | Additional volumes on the output Deployment definition | `[]` |
| `volumeMounts` | Additional volumeMounts on the output Deployment definition | `[]` |
| `nodeSelector` | Node selector for pods | `{}` |
| `tolerations` | Tolerations for pods | `[]` |
| `affinity` | Affinity settings for pods | `{}` |



4 changes: 2 additions & 2 deletions charts/memgraph-platform/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ service:
portLog: 7444


env:
MEMGRAPH: "--bolt-server-name-for-init=Neo4j/"
env: {}
# MEMGRAPH: "--bolt-server-name-for-init=Neo4j/"

persistentVolumeClaim:
storagePVC: true
Expand Down

0 comments on commit e11a9fe

Please sign in to comment.