How to: Add new Archives

Follow these instructions to configure a new Archive in FarEarth

Prerequisites

• You need to have the Admin role in FarEarth

Step 1

• Navigate to the ARCHIVES page

• Click CATALOGUE CONFIG

Step 2

• Click CREATE ARCHIVE

• In the NEW ARCHIVE window, enter the required fields

  Field	Details
  App	The FarEarth application ID where the archive will be created
  ID	A unique ID for the archive
  Protocol	The protocol that this archive will use (see Archive configuration)

• Click CREATE

• FarEarth automatically creates additional fields to the archive that you need to edit

  Field	Details
  Enabled	Controls if the archive is enabled or not
  File Name	The JSON filename of the archive as stored on disk
  Shareable	Controls if the archive may be shared with other subscriptions
  Exclusive	Limits the archive to be shared with only one subscription

Edit archive

To edit the archive, click FILE NAME in the archive list.

note

Each archive protocol has unique fields in the configuration file

Below is an example of an archive configuration.

{
    "id": "farearth.my-archive",
    "protocol": "amazon-s3",
    "displayName": "My Archive",    
    "prefix": "archive/{spacecraft}/{year}/{month}/{day}/{productType}/{productId}/{version}",
    "properties": {
        "baseUrl": "https://<region>.amazonaws.com",
        "bucketName": "mybucketname",
        "region": "<insert region>",
        "accessKey": "<insert access key>",
        "secretKey": "<insert secret key>",
        "enableCopyObject": true
    },
    "maxJobs": 5
}

Expected outcome

• Outcome #1

Related links

• Related links #1
• Related links #2