Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 2.98 KB

CLOUD_SETUP.md

File metadata and controls

56 lines (44 loc) · 2.98 KB

Cloud Setup

Permanent's local development environment makes some use of cloud resources in areas that are difficult to replicate locally. This document describes how to set up the cloud resources necessary for running a local environment. In the following instructions the string <dev_name> should be replaced with the first name of the developer whose local environment is being set up, all lowercase. <DevName> should be replaced with the first name of that developer, Pascal case (i.e. capitalized).

AWS

Create the following resources via the AWS Console

SNS

Create an SNS topic called new-access-copy-topic-local-<dev_name> with Type = Standard.

S3

In the permanent-local bucket, create a new event notification (these are found in the properties tab). It should be called new_dip_file_<dev_name>, it should filter to the prefix _<DevName>/access_copies/, it should send notifications for all object creation events, and its destination should be the SNS topic record-thumbnail-topic-local-<dev_name>.

SQS

  1. Create three AWS SQS queues (type: Standard) with the following names:

    • Local_Low_Priority_<DevName>
    • Local_Video_<DevName>
    • Local_High_Priority_<DevName>
    • metadata-attacher-local-<dev_name>
    • record-thumbnail-local-<dev_name>
    • access-copies-local-<dev_name>

  2. Subscribe the metadata-attacher, record-thumbnail, and access-copies queues to the record-thumbnail-topic-local-<dev_name> topic you created earlier.

Archivematica

  1. Open the dev environment's Archivematica storage service (Note: you may need to request access to this from another developer; access is configured in Terraform). Credentials can be found in Bitwarden
  2. Navigate to Spaces
  3. Under the S3 space pointed at the permanent-local bucket, create a new location
  4. Set
    • "Purpose" to "Transfer Source"
    • "Relative Path" to _<DevName>/originals
    • "Description" to "Original copies ('s local env)"
  5. Take the id of that location and add it to your stela .env file as ARCHIVEMATICA_ORIGINAL_LOCATION_ID
  6. Click "Create Location"
  7. Repeat steps 3-5, but this time set
    • "Purpose" to "AIP Storage"
    • "Relative Path" to _<DevName>/preservation_copies
    • "Description" to "AIP Storage in S3 ('s local env)"
  8. Repeat steps 3-5, but this time set
    • "Purpose" to "DIP Storage"
    • "Relative Path" to _<DevName>/access_copies
    • "Description" to "DIP Storage in S3 ('s local env)"
  9. Open the dev environment's Archivematica dashboard
  10. Under Administration > Processing Configuration, create a new processing configuration called local_<dev_name>. Add that to your stela .env file as ARCHIVEMATICA_PROCESSING_WORKFLOW.
  11. In your new configuration, copy the values from the default configuration, except point the "Store AIP Location" and "Store DIP Location" to the locations created above.