Backup & Restore Neo4j

[chrisammon3000]

Description

• Adds functionality for backing up and restoring Neo4j Community Edition to and from S3. Also includes minor improvements, bug fixes, and updated documentation.
• Deploys SNS topic for email notifications and alarms for Lambdas and State Machine and automates subscriptions.

Usage

Backups & Restore

Backups

Backups are orchestrated by Systems Manager and automated everyday at midnight US/Central time by default. To create a backup, run the command.

make database.backup

This will create a backup of the Neo4j database and store it in S3 under the path s3://<data bucket name>/backups/neo4j/YYYY/MM/DD/HH/gfedb.zip.

Restore

To see a list of available backup dates that can be restored, run the command.

make database.backup.list

To restore from a backup, pass the date of the backup you wish to restore using the format YYYY/MM/DD/HH.

make database.restore from_date=<YYYY/MM/DD/HH>

Alarm Notifications

Subscribe on Deployment

1. Add a comma-separated list of email strings to .env.

   # .env
   SUBSCRIBE_EMAILS=<email>,<email>,<email>,...

2. Redeploy the base infrastructure layer to add the topic and subscribe the emails.

   make infrastructure.deploy

3. Log into your email and confirm the subscription.

Individual Subscription

# Subscribe an email for notifications (unsubscribe using console)
make monitoring.subscribe-email email=<email>

Next Tasks

• [x] SNS Topics and notification service for alerts and reports
• [x] Update Bitnami Neo4j AMI to 5.0

[mmaiers-nmdp]

Waiting for this to be merged before upgrading to 5.0