Neo4j is a highly scalable, native graph database purpose-built to leverage not only data but also its relationships. Neo4j's native graph storage and processing engine deliver constant, real-time performance, helping enterprises build intelligent applications to meet today’s evolving data challenges.
- Estimated time for completion: 5 minutes
- Target audience: Anyone who wants to deploy a clustered graph-model database on DC/OS. Beginner level.
- Scope: Covers the basics in order to get you started with Neo4j on DC/OS.
- A running DC/OS 1.8 cluster with at least 3 nodes having 3 CPU, 6GB of memory and 12GB of persistent disk storage in total. (Suggested: 3 nodes having 6 CPU, 24GB of memory and 24GB)
- DC/OS CLI installed.
The DC/OS CLI provides a convenient way to deploy applications on your DC/OS cluster:
$ dcos package install neo4j
The default configuration requires at least 3 nodes having 3 CPU, 6GB of memory and 12GB of persistent disk storage in total. This DC/OS Service is currently EXPERIMENTAL. There may be bugs, incomplete features, incorrect documentation, or other discrepancies. Default credentials are neo4j/dcos. Please change them on first use.
Continue installing? [yes/no] yes
Installing Marathon app for package [neo4j] version [1.0.0-3.1.0-RC1]
Neo4j has been successfully installed.
Documentation can be found at https://neo4j.com/docs and https://neo4j.com/developer
If you want to install read replica servers as well, please do:
$ dcos package install neo4j-replica
The default configuration requires at least 2 nodes having 2 CPU, 4GB of memory and 8GB of persistent disk storage in total. This DC/OS Service is currently EXPERIMENTAL. There may be bugs, incomplete features, incorrect documentation, or other discrepancies. Default credentials are neo4j/dcos. Please change them on first use.
Continue installing? [yes/no] yes
Installing Marathon app for package [neo4j-replica] version [1.0.0-3.1.0-RC1]
Neo4j has been successfully installed.
Documentation can be found at https://neo4j.com/docs and https://neo4j.com/developer
Now click on the Services tab in the DC/OS UI to watch Neo4j start up:
Click on the Neo4j group and the core App to reveal the tasks that the framework has started:
Congratulations, you now have Neo4j running on DC/OS!
If you want to access your Neo4j cluster from outside your DC/OS cluster, you need to install the public proxy:
$ dcos package install neo4j-proxy
This DC/OS Service is currently EXPERIMENTAL. There may be bugs, incomplete features, incorrect documentation, or other discrepancies. Default credentials are neo4j/dcos. Please change them on first use.
Continue installing? [yes/no] yes
Installing Marathon app for package [neo4j-proxy] version [1.0.0]
Neo4j has been successfully installed.
Documentation can be found at https://neo4j.com/docs and https://neo4j.com/developer
After installation, point your web browser to the public IP of the agent running the proxy on port 7474. If you login and enter :sysinfo you will see all your running cluster nodes.
Important: Please check in the configuration sidebar Do not use Bolt. Only http via port 7474 is exported through this proxy, therefore the binary Bolt protocol is not working on the outside. Inside DC/OS Bolt works as expected.
To scale out your Neo4j cluster, just use the functionality in the DC/OS service section. Select either neo4j/core or neo4j/replica and do Scale and select the required numbers of instances.
Use the following commands to delete your Neo4j service and the:
$ dcos package uninstall neo4j; dcos package uninstall neo4j-replica; dcos package uninstall neo4j-proxyThere are a number of configuration options, which can be specified in the following way:
$ dcos package install --config=<JSON_FILE> neo4jwhere JSON_FILE is the path to a JSON file. For a list of possible
attribute values and their documentation see
$ dcos package describe --config neo4j-
neo4j-core.auth-password[=dcos]
Password for authentication
-
neo4j-core.auth-username[=neo4j]
Username for authentication
-
neo4j-core.cpus[=2]
CPU shares allocated to one neo4j core instance.
-
neo4j-core.disk[=8000]
Disk size [mb] allocated to one neo4j core instance.
-
neo4j-core.expected-cluster-size[=3]
Expected core cluster size.
-
neo4j-core.instances[=3]
Amount of neo4j core instances.
-
neo4j-core.network-name=[dcos]
The name of your existing DC/OS overlay network.
-
neo4j-core.mem[=4000]
Memory [mb] allocated to one neo4j core instance.
-
neo4j-replica.auth-password[=dcos]
Password for authentication
-
neo4j-replica.auth-username[=neo4j]
Username for authentication
-
neo4j-replica.cpus[=2]
CPU shares allocated to one neo4j replica instance.
-
neo4j-replica.disk[=8000]
Disk size [mb] allocated to one neo4j replica instance.
-
neo4j-replica.instances[=3]
Amount of neo4j replica instances.
-
neo4j-core.network-name=[dcos]
The name of your existing DC/OS overlay network.
-
neo4j-replica.mem[=4000]
Memory [mb] allocated to one neo4j replica instance.
-
neo4j-replica.auth-password[=dcos]
Password for authentication
-
neo4j-replica.auth-username[=neo4j]
Username for authentication
The Neo4j Mesos, Marathon and DC/OS integrations are supported by Neo Technology, the company developing Neo4j, the most widely used graph database. If you need help or have feedback or suggestions, just ask via one of the following channels:
- Slack in the #neo4j-dcos channel
- Google Group
- Stack Overflow tagged
neo4janddcosormesos [email protected]: Neo4j Feedback email alias[email protected]: Direct email for the neo4j developer relations team
We manage issues, bug reports, and questions via GitHub issues
- neo4j-dcos: Neo4j DC/OS repository
- neo4j: Neo4j itself
- neo4j docker: The Docker Images