Setup EFS Restore Procedures

[nickumia-reisys]

User Story

In order to restore an EFS Backup and recover solr, the data.gov Solr/SSB team wants to implement a procedure to restore EFS backups from AWS Backup.

Acceptance Criteria

[ACs should be clearly demoable/verifiable whenever possible. Try specifying them using BDD.]

• GIVEN a solr crashes
  AND a good backup exists
  WHEN we want to restore it with cf update-service
  THEN it recovers

Background

[Any helpful contextual notes or links to artifacts/evidence, if needed]

Security Considerations (required)

[Any security concerns that might be implicated in the change. "None" is OK, just be explicit here!]

Sketch

[Notes or a checklist reflecting our understanding of the selected approach]
Will update later.

[nickumia-reisys]

Process to restore a backup:

• Turn off Harvesting
• Follow AWS Documentation for restoring an EFS Backup
• Wait for backup to restore
• Perform an update-service (see below) on the solr instance referencing the restore script as the "setupLink" in the service configuration,
  • https://github.com/GSA/catalog.data.gov/blob/main/solr/restore_backups.sh
• Wait for the update to complete and verify that Solr is started by inspecting the logs in the AWS Console.

cf update-service catalog-solr -c "\
{
    "solrImageRepo": unchanged,
    "solrImageTag": unchanged,
    "solrMem": unchanged,
    "solrCpu": unchanged,
    "setupLink": "https://raw.githubusercontent.com/GSA/catalog.data.gov/main/solr/restore_backups.sh",
    "efsProvisionedThroughput": unchanged
}

[nickumia-reisys]

Documentation is available here: https://github.com/GSA/data.gov/wiki/Solr-on-ECS---EFS