Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pecollet committed Mar 15, 2024
1 parent beccf27 commit d8eb618
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@

**AWS Ec2 Auto-scaling-group Discovery plugin for Neo4j**
**AWS EC2 Discovery plugin for Neo4j**

This neo4j plugin implements cluster discovery for a cluster deployed on AWS EC2 VMs.
It retrieves the list of network addresses of the VMs in a neo4j cluster, and feeds it to Neo4j's cluster discovery module.
The VMs can be found by :
- The name of the AutoScaling Group they belong to
This Neo4j plugin provides a list of seed addresses to the discovery process by querying the AWS API for a list of EC2 instances matching certain criteria determined by the plugin settings.

The EC2 instances can be found by :
- the name of the AutoScaling Group they belong to
- a Tag

Notes:
Expand All @@ -18,16 +18,16 @@ Notes:
Neo4j 5.18+


**Usage**
**Installation**

- Put the jar in the plugins directory of every neo4j instance of the cluster
- In neo4j.conf, set the settings below


**Settings**

- `dbms.cluster.discovery.resolver_type=EC2` : select the discovery protocol implemented by this plugin
- `server.config.strict_validation.enabled=false` : to disable strict settings validation, which will allow the usage of the following plugin-specific settings (You may still get Warnings : "Unrecognized setting").
- `dbms.cluster.discovery.resolver_type=EC2` : enable the plugin
- `server.config.strict_validation.enabled=false` : disable strict settings validation, which will allow the usage of the following plugin-specific settings (You may still get Warnings : "Unrecognized setting").

One of the following to specify how to find the VMs:
- `dbms.cluster.discovery.aws.asg_name=<asg_name>` : the name of the Auto-scaling group which contains the VMs. Takes precedence over "vm_tag".
Expand All @@ -39,7 +39,8 @@ Optionally :
- `dbms.cluster.discovery.aws.key=<key>` : the Access Key of the user connecting to the AWS API.
- `dbms.cluster.discovery.aws.secret=<secret>` : the Secret Key of the user connecting to the AWS API.

If key/secret are not set, the plugin will try to use any InstanceProfile role attached to the EC2 instance. See below for required permissions. That can be defined in the ASG's LaunchTemplate.
If key/secret are not set, the plugin will try to use any InstanceProfile role attached to the EC2 instance. See below for required permissions. That can be defined in the ASG's LaunchTemplate.
These settings are sensitive and should be stored safely.

- `dbms.cluster.discovery.aws.address_type=<type>` : type of network address to retrieve from the VM, to use for discovery. One of PRIVATE_IP|PRIVATE_DNSNAME|PUBLIC_IP|PUBLIC_DNSNAME. Defaults to PRIVATE_IP. Must match the type of `server.discovery.advertised_address`.

Expand Down

0 comments on commit d8eb618

Please sign in to comment.