Skip to content

README.md

Latest commit

 

History

History
92 lines (66 loc) · 5.64 KB

README.md

File metadata and controls

92 lines (66 loc) · 5.64 KB

Neo4j

Neo4j is a highly scalable native graph database that leverages data relationships as first-class entities, helping enterprises build intelligent applications to meet today’s evolving data challenges.

TL;DR;

$ helm install stable/neo4j

Introduction

This chart bootstraps a Neo4j deployment on a Kubernetes cluster using the Helm package manager.

Prerequisites

  • Kubernetes 1.6+ with Beta APIs enabled
  • PV provisioner support in the underlying infrastructure

Installing the Chart

To install the chart with the release name neo4j-helm:

$ helm install --name neo4j-helm stable/neo4j --set neo4jPassword=mySecretPassword

The command deploys Neo4j on the Kubernetes cluster in the default configuration but with the password set to mySecretPassword. The configuration section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the neo4j-helm deployment:

$ helm delete neo4j-helm --purge

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following tables lists the configurable parameters of the Neo4j chart and their default values.

Parameter Description Default
image Neo4j image neo4j
imageTag Neo4j version {VERSION}
imagePullPolicy Image pull policy IfNotPresent
authEnabled Is login/password required? true
core.numberOfServers Number of machines in CORE mode 3
core.sideCarContainers Sidecar containers to add to the core pod. Example use case is a sidecar which identifies and labels the leader when using the http API {}
core.initContainers Init containers to add to the core pod. Example use case is a script that installs the APOC library {}
core.persistentVolume.storageClass Storage class of backing PVC standard (uses beta storage class annotation)
core.persistentVolume.size Size of data volume 10Gi
core.persistentVolume.mountPath Persistent Volume mount root path /data
core.persistentVolume.annotations Persistent Volume Claim annotations {}
readReplica.numberOfServers Number of machines in READ_REPLICA mode 0
readReplica.initContainers Init containers to add to the replica pod. Example use case is a script that installs the APOC library {}
resources Resources required (e.g. CPU, memory) {}

The above parameters map to the env variables defined in the Neo4j docker image.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name neo4j-helm --set core.numberOfServers=5,readReplica.numberOfServers=3 stable/neo4j

The above command creates a cluster containing 5 core servers and 3 read replicas.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install --name neo4j-helm -f values.yaml stable/neo4j

Tip: You can use the default values.yaml