Introduction

Neo4j supports both a standalone and a cluster deployment of Neo4j on Kubernetes using the Neo4j Helm charts.

Helm (https://helm.sh/) is a “package manager for Kubernetes”. It usually runs on a machine outside of Kubernetes and creates resources in Kubernetes by calling the Kubernetes API. Helm installs and manages applications on Kubernetes using Helm charts, which are distributed via Helm chart repositories.

The Neo4j Helm chart repository

The Neo4j Helm chart repository contains a helm chart for the Neo4j standalone server and cluster installations (neo4j/neo4j) and support charts to simplify configuration and operations. For more details on how to configure the Neo4j Helm chart repository, see Configure the Neo4j Helm chart repository. The source code of the Neo4j Helm charts is licensed under Apache License 2.0.

Using the Neo4j Helm chart repository

When using the Neo4j Helm chart, you are responsible for defining values.yaml files. The YAML files specify what you want to achieve with the Helm chart and the Neo4j configuration. There is no neo4j.conf file in this setup.

Then, you run helm install selecting the chart to install and passing in the values.yaml file to customize the behavior. The Helm chart creates Kubernetes entities, which in some cases also spawn outside the resources in the cloud environment where they are run (e.g., cloud load balancers).

For more information about the Helm chart and the Kubernetes and Cloud resources they instantiate when installed, see Neo4j Helm chart for standalone server deployment and Neo4j Helm chart for cluster deployments.