Create Helm deployment values files
You create a Helm deployment YAML file for each Neo4j cluster member with all the configuration settings.
All Neo4j cluster servers are linked together by the value of the parameter
neo4j.name. When installed via the Neo4j Helm chart, they will join the cluster identified by
neo4j.nameis different from the Helm release name, which is used to reference a cluster server elsewhere in Kubernetes.
All other names and labels of K8s objects created by the Helm chart derive from both
neo4j.nameand release name. The
neo4j.nameparameter is mandatory, and the installation will fail if it is not specified.
neo4j.namemust be unique within a namespace.
If you want to install 2 clusters in the same namespace, they must have different values for
Starting from Neo4j 5.0.0, standalone servers and cluster servers have no distinction. By default, servers in a cluster can host primary and secondary databases. See the Operational view for more details.
neo4j.minimumClusterSizeis set to 1 by default, which means the server starts without waiting for the other servers. When installing a cluster, you should set
neo4j.minimumClusterSizeto the number of desired members in the cluster. If you later decide to add an extra cluster server in excess of
neo4j.minimumClusterSize, you need to manually enable it using the Cypher command
ENABLE SERVER. For more information on enabling new servers, see Add a server to the cluster.
The size of a Neo4j cluster member is defined by the values of the
neo4j.resources.memoryparameters. The minimum for a Neo4j instance is
2GBmemory. If invalid or less than the minimum values are provided, Helm will throw an error, for example:
Error: template: neo4j/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.
The password for the
neo4juser. The same password must be set for 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
neo4jas the initial password as this is the default password.
By default, the Neo4j Helm chart installs Neo4j Enterprise Edition since clusters are not available in Community Edition. This means that you do not have to explicitly set the configuration parameter
"enterprise", as you would do for a standalone server of Neo4j Enterprise Edition. However, you must acknowledge license compliance by setting
"yes". For more information on how to obtain a valid license for Neo4j Enterprise Edition, see https://neo4j.com/licensing/ or use the form Contact Neo4j.
volumes.dataparameter maps the
datavolume 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.
Select the tab as per your Kubernetes environment, and using the provided example, create a YAML file for each of your cluster servers with all the configuration settings.
This guide assumes that the YAML files are named server-1.values.yaml, server-2.values.yaml and server-3.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" minimumClusterSize: 3 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" minimumClusterSize: 3 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" minimumClusterSize: 3 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