Causal Clusters (VM-based)

This chapter describes how to deploy and run Neo4j Causal Cluster from the GCP Marketplace.

Neo4j Enterprise is registered in GCP Marketplace.

1. Prerequisites

2. Deploy Neo4j via the GCP Marketplace

Deploy Neo4j Enterprise from the Google Cloud Launcher console following the interactive prompts.

Once the deploy finishes, save the URL, username, and password.

3. Start using Neo4j Browser

Use your browser to access the cloud-based database URL, and log in with the initial username and password provided. You may see an SSL warning screen because the out-of-the-box deployment uses an unsigned SSL certificate. The initial password is set to a strong, random password and is saved as a metadata entry on the VMs.

To verify that the cluster has formed correctly, run the following Cypher statement:

CALL dbms.cluster.overview().

The result is one leader and minimum two followers. The IP addresses and endpoints must be the same as the ones for your running instances, displayed by the Compute Engine.

4. Access your instance via SSH

Cluster members are regular Google Compute Engine VMs. Therefore, you can access any of them via SSH from the Deployment Manager screen, or by running the following command in the Google Cloud CLI:

gcloud compute ssh my-cluster-deploy-vm-1

For details on internals of Google VMs, including how to stop and start system services, configure Neo4j from the VM, etc., consult Neo4j cloud VMs.

5. Your cluster default configuration

The following notes are provided on your default cluster configuration.

  • Ports 7687 (bolt) and 7473 (HTTPS access) are the only ports exposed to the entire internet. Consider narrowing the access to these ports to only your needed networks. External unencrypted HTTP access is disabled by default.

  • Ports 5000, 6000, and 7000 are enabled only for internal network access (10.0.0.8), between the cluster nodes.

  • Because cloud VMs can start and stop with different IP addresses, the configuration of these VMs is driven by a file in /etc/neo4j/neo4j.template. Configuration changes must be made to the template, not to the /etc/neo4j/neo4j.conf file, which is overwritten with the template substitutions at every startup. The template allows you to configure aspects of the cluster with the VMs metadata. The template’s behavior and layout match the usual neo4j.conf file.

6. What’s next

  • Visit Clustering for more information on how to configure your cluster.

  • Add users and change passwords as necessary.

  • Consider creating DNS entries with Google to be able to address your cluster with client applications under a single hostname.

7. Terminating the deployment

You can use the deployment manager to delete the deployment. To ensure data safety, the disks that back the VMs are not removed when you delete the cluster deployment.