quickstart.adoc 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. = Quick Start
  2. [abstract]
  3. Get started fast for common scenarios
  4. == Download a Release
  5. Find the URL of a https://github.com/neo4j-contrib/neo4j-helm/releases[copy of a release]; it will be named `neo4j-$RELEASEVERSION.tgz`
  6. [NOTE]
  7. You must set `acceptLicenseAgreement=yes` to accept the license, or your deployment will not succeed.
  8. == Standalone (Single Server)
  9. [NOTE]
  10. ====
  11. **For Neo4j standalone (i.e . excluding Neo4j Causal Cluster) productized Helm charts for are available for Neo4j 4.3 and above.**
  12. That is the recommended way to run a standalone Neo4j server in Kubernetes. Full details are in the https://neo4j.com/docs/operations-manual/current/kubernetes/[Kubernetes section of the Neo4j operations manual]
  13. ====
  14. ```shell
  15. helm install mygraph RELEASE_URL \
  16. --set core.standalone=true \
  17. --set acceptLicenseAgreement=yes \
  18. --set neo4jPassword=mySecretPassword
  19. ```
  20. == Causal Cluster
  21. ```shell
  22. helm install mygraph RELEASE_URL \
  23. --set acceptLicenseAgreement=yes \
  24. --set neo4jPassword=mySecretPassword \
  25. --set core.numberOfServers=3 \
  26. --set readReplica.numberOfServers=0
  27. ```
  28. == Uninstalling
  29. ```shell
  30. helm uninstall mygraph
  31. ```
  32. == Where to Go For Help
  33. If you have a question not covered in this user guide in the other sections, the
  34. https://community.neo4j.com/c/neo4j-graph-platform/cloud/76[Neo4j Community Site] is a great place
  35. to ask for help.