Create Helm deployment values files
You create a Helm deployment YAML file for each Neo4j cluster member with all the configuration settings.
Important configuration parameters
neo4j.name
-
All Neo4j cluster members (cores or read-replicas) are linked together by the value of the parameter
neo4j.name
. When installed via the Neo4j Helm charts, they will join the cluster identified byneo4j.name
.
neo4j.name
is different from the Helm release name, which is used to reference a specific cluster member elsewhere in Kubernetes.
All other names and labels of K8s objects created by the helm charts derive from bothneo4j.name
and release name. If no name is specified, the cluster gets the default nameneo4j-cluster
. neo4j.resources
-
The size of a Neo4j cluster member is defined by the values of the
neo4j.resources.cpu
andneo4j.resources.memory
parameters. The minimum for a Neo4j instance is0.5
CPU and2GB
memory. If invalid or less than the minimum values are provided, Helm will throw an error, for example:Error: template: neo4j-cluster-core/templates/_helpers.tpl:157:11: executing "neo4j.resources.evaluateCPU" at <fail (printf "Provided cpu value %s is less than minimum. \n %s" (.Values.neo4j.resources.cpu) (include "neo4j.resources.invalidCPUMessage" .))>: error calling fail: Provided cpu value 0.25 is less than minimum. cpu value cannot be less than 0.5 or 500m
For more information, see Configure resource allocation.
neo4j.password
-
The password for the
neo4j
user. The same password must be set on all cluster members.
If you do not provide a password, the Neo4j Helm chart will automatically generate one for you. (Make a note of it.)You cannot use
neo4j
as the initial password as this is the default password. neo4j.edition
andneo4j.acceptLicenseAgreement
-
By default, the cluster Helm charts install Neo4j Enterprise Edition since clusters are not available in Community Edition. This means that you do not have to explicitly set the configuration parameter
edition:
to"enterprise"
, as it would be the case if you want to install a standalone server of Neo4j Enterprise Edition. However, you must acknowledge license compliance by settingneo4j.acceptLicenseAgreement
to"yes"
. For more information on how to obtain a valid license for Neo4j Enterprise Edition, see https://neo4j.com/licensing/ or write to licensing@neo4j.com. volumes.data
-
The
volumes.data
parameter maps thedata
volume mount of each cluster member to the persistent volume for that member. For more information, see Volume mounts and persistent volumes.
For details of all Neo4j Helm chart configuration options, see Configure a Neo4j Helm deployment. |
Create a values.yaml file for each cluster member
Select the tab as per your Kubernetes environment and using the provided example, create a YAML file for each of your cluster members (both cores and the read replica) with all the configuration settings.
This guide assumes that the YAML files are named core-1.values.yaml, core-2.values.yaml, core-3.values.yaml, and rr-1.values.yaml.
The examples use storage classes provided by the vendor. If you want to use a different type of storage class, such as regional disks, consult the cloud vendor documentation on creating new storage classes.
neo4j:
name: "my-cluster"
resources:
cpu: "0.5"
memory: "2Gi"
password: "my-password"
acceptLicenseAgreement: "yes"
volumes:
data:
mode: "dynamic"
dynamic:
# * premium-rwo provisions SSD disks (recommended)
# * standard-rwo provisions balanced SSD-backed disks
# * standard provisions HDD disks
storageClassName: premium-rwo
neo4j:
name: "my-cluster"
resources:
cpu: "0.5"
memory: "2Gi"
password: "my-password"
acceptLicenseAgreement: "yes"
volumes:
data:
mode: "dynamic"
dynamic:
# gp2 is a general-purpose SSD volume
storageClassName: gp2
neo4j:
name: "my-cluster"
resources:
cpu: "0.5"
memory: "2Gi"
password: "my-password"
acceptLicenseAgreement: "yes"
volumes:
data:
mode: "dynamic"
dynamic:
# * managed-csi-premium provisions premium SSD disks (recommended)
# * managed-csi provisions standard SSD backed disks
storageClassName: managed-csi-premium