search

neo4j-contrib / neo4j-helm

Helm Charts for running Neo4j on Kubernetes [DEPRECATED]
https://neo4j-contrib.github.io/neo4j-helm/user-guide/USER-GUIDE.html
Apache License 2.0
88 stars 81 forks source link

Mirror Neo4j Operations Manual in Documentation #11

Closed moxious closed 3 years ago

moxious commented 4 years ago

The following is the table of Contents of the Neo4j Operations Manual. In order for the helm template to be operable for people on Kubernetes, some k8s-specific translations or considerations are going to be necessary for each section.

This ticket is suggesting a revamp of the existing user guide to parallel the structure of the operations manual, omitting sections or just referring back to it where the information is the same.

For example, instructions on how to use via docker is not relevant for the helm chart because you're already there. The clustering section does not need to be repeated because everything in the ops manual applies here. But the backup, restore, and upgrade sections need particular attention.

Chapter 1, Introduction — Introduction of Neo4j Community and Enterprise Editions. Chapter 2, Installation — Instructions on how to install Neo4j in different deployment contexts. Chapter 3, Cloud deployments — Information on how to deploy Neo4j on cloud platforms. Chapter 4, Docker — Instructions on how to use Neo4j on Docker. Chapter 5, Configuration — Instructions on how to configure certain parts of Neo4j. Chapter 6, Manage databases — Instructions on how to manage multiple active databases with Neo4j. Chapter 7, Clustering — Comprehensive descriptions of Neo4j Causal Clustering. Chapter 8, Fabric — Instructions on how to configure and use Neo4j Fabric. Chapter 9, Upgrade — Instructions on upgrading Neo4j. Chapter 10, Backup — Instructions on setting up Neo4j backups. Chapter 11, Authentication and authorization — Instructions on user management and role-based access control. Chapter 12, Security — Instructions on server security. Chapter 13, Monitoring — Instructions on setting up Neo4j monitoring. Chapter 14, Performance — Instructions on how to go about performance tuning for Neo4j. Chapter 15, Tools — Description of Neo4j tools.

moxious commented 4 years ago

Related: Rolling Upgrades https://github.com/neo4j-contrib/neo4j-helm/pull/33

moxious commented 4 years ago

Related: Backup & Restore https://github.com/neo4j-contrib/neo4j-helm/pull/23

moxious commented 4 years ago

Related: Neo4j Fabric https://github.com/neo4j-contrib/neo4j-helm/pull/34

moxious commented 4 years ago

Related: docs organization & TOC https://github.com/neo4j-contrib/neo4j-helm/pull/43

moxious commented 3 years ago

Enough of this one has been accomplished that its intent has been met, while an exact mirror of the content structure isn't desirable. See above linked PRs.