19.1.0 • Published 9 months ago

@cumulus/hyrax-metadata-updates v19.1.0

Weekly downloads
26
License
Apache-2.0
Repository
github
Last release
9 months ago

@cumulus/hyrax-metadata-updates

Description

This lambda function is responsible for augmenting granule metadata files with the correct Hyrax (OPeNDAP) URL to provide subsetting and reformatting services on your granules. The URL will convey enough information to Hyrax to discover the granule using CMR. Hyrax will then determine the archive location within Cumulus from the granule's metadata.

For example, the Hyrax URL for a granule with short name GLDAS_CLSM025_DA1_D and version 2.2 from collection ID C1233603862-GES_DISC and granule UR GLDAS_CLSM025_DA1_D.2.2:GLDAS_CLSM025_DA1_D.A20030204.022.nc4:

https://opendap.uat.earthdata.nasa.gov/collections/C1233603862-GES_DISC/GLDAS_CLSM025_DA1_D.2.2/granules/GLDAS_CLSM025_DA1_D.2.2:GLDAS_CLSM025_DA1_D.A20030204.022.nc4

/UMM-C:{ShortName}.UMM-C:{Version} between "collections" and "granules" is optional and could be included using addShortnameAndVersionIdToConceptId: true in config.json. By default, it is false.

This url will be added to the Urls portion of the granule metadata as follows,

UMM-G example

"RelatedUrls": [
    ...
    {
        "URL": "opendap.uat.earthdata.nasa.gov/collections/C1233603862-GES_DISC/GLDAS_CLSM025_DA1_D.2.2/granules/GLDAS_CLSM025_DA1_D.2.2:GLDAS_CLSM025_DA1_D.A20030204.022.nc4",
        "Type": "USE SERVICE API",
        "Subtype": "OPENDAP DATA",
        "Description": "OPeNDAP request URL"
    }
]

ECHO-10 example

<OnlineResources>
    ...
    <OnlineResource>
        <URL>https://opendap.uat.earthdata.nasa.gov/collections/C1233603862-GES_DISC/GLDAS_CLSM025_DA1_D.2.2/granules/GLDAS_CLSM025_DA1_D.2.2:GLDAS_CLSM025_DA1_D.A20030204.022.nc4</URL>
        <Description>OPeNDAP request URL</Description>
        <Type>GET DATA : OPENDAP DATA</Type>
    </OnlineResource>
</OnlineResources>

The four properties we need to construct this url are as follows, | Property | Source | Notes | ------------- | ----------------------------------- | ----- | Provider ID | Configuration config.cmr.provider | | Collection ID | Derived from retrieval of parent collection from CMR | This requires a call to the CMR search API | ShortName | --//-- | optional | Version | --//-- | optional | Granule UR | Granule metadata: UMM-G GranuleUR ECHO10 Granule->GranuleUR | Environment | process.env.CMR_ENVIRONMENT | Specifies the environment of Hyrax (e.g. SIT, UAT, PROD)

For more information on configuring a Cumulus Message Adapter task, see the Cumulus workflow input/output documentation.

Config

Config object fields:

field nametypedefaultdescription
bucketstring(required)Name of S3 bucket containing public/private key pair to decrypt CMR credentials
stackstring(required)Name of deployment stack
cmrobject(required)CMR credentials object
addShortnameAndVersionIdToConceptIdbooleanfalseOption to humanize the Hyrax URL. Humanizes when set to true.
skipMetadataValidationbooleanfalseOption to skip metadata validation

Input

Input object fields:

field nametypedefaultdescription
granulesarray\<object>(required)List of granule objects

Output

Output object fields:

field nametypedefaultdescription
granulesarray\<object>N/AList of granule objects

About Cumulus

Cumulus is a cloud-based data ingest, archive, distribution and management prototype for NASA's future Earth science data streams.

Cumulus Documentation

Contributing

To make a contribution, please see our contributing guidelines.

18.5.1

9 months ago

19.1.0

9 months ago

18.5.0

9 months ago

18.3.5

10 months ago

19.0.0

11 months ago

18.3.4

11 months ago

18.2.2

1 year ago

18.4.0

11 months ago

18.3.3

11 months ago

18.3.2

12 months ago

18.3.1

1 year ago

18.3.0

1 year ago

16.1.5

1 year ago

18.2.1

1 year ago

16.1.4

1 year ago

18.2.0

1 year ago

16.1.3

1 year ago

18.2.0-alpha.0

2 years ago

16.1.1

2 years ago

16.1.2

2 years ago

18.1.0

2 years ago

17.0.0

2 years ago

18.0.0

2 years ago

16.0.3-alpha.0

2 years ago

16.0.0

2 years ago

15.0.4

2 years ago

16.0.1-alpha.0

2 years ago

16.0.2-alpha.0

2 years ago

15.0.2

2 years ago

15.0.3

2 years ago

15.0.1

2 years ago

14.1.0

2 years ago

15.0.0

2 years ago

13.3.3-alpha.0

3 years ago

13.4.0

3 years ago

14.0.0

3 years ago

13.3.3-alpha.1

3 years ago

11.1.8

3 years ago

13.3.2

3 years ago

12.0.3

3 years ago

13.3.1

3 years ago

11.1.6

3 years ago

11.1.7

3 years ago

13.3.0

3 years ago

13.1.0

3 years ago

12.0.1

3 years ago

12.0.2

3 years ago

10.1.3

3 years ago

13.2.0

3 years ago

13.2.1

3 years ago

13.0.0

3 years ago

13.0.1

3 years ago

11.1.5

3 years ago

11.1.3

3 years ago

11.1.4

3 years ago

11.1.2

3 years ago

12.0.0

3 years ago

10.0.2

3 years ago

11.1.1

3 years ago

11.1.0

3 years ago

11.0.0

3 years ago

9.9.4

3 years ago

10.1.2

3 years ago

9.4.2

3 years ago

10.1.1

3 years ago

9.4.1

3 years ago

10.0.0

3 years ago

10.0.1

3 years ago

9.9.1

3 years ago

9.7.1

4 years ago

10.1.0

3 years ago

9.9.2

3 years ago

9.9.3

3 years ago

9.2.4

4 years ago

9.2.3

4 years ago

10.0.0-beta.0

4 years ago

9.9.0

4 years ago

9.8.0

4 years ago

9.7.0

4 years ago

9.6.0

4 years ago

9.5.0

4 years ago

9.4.0

4 years ago

9.2.2

4 years ago

8.1.2

4 years ago

9.2.1

4 years ago

9.3.0

4 years ago

9.2.0

4 years ago

8.1.1

4 years ago

9.1.0

4 years ago

8.1.0

4 years ago

9.0.1

4 years ago

9.0.0

4 years ago

8.0.0

4 years ago

6.0.1

4 years ago

7.2.0

4 years ago

7.1.0

4 years ago

7.0.0

4 years ago

6.0.0

4 years ago

5.0.1

4 years ago

5.0.0

5 years ago

4.0.0

5 years ago

3.0.1

5 years ago

2.0.8

5 years ago

3.0.0

5 years ago

2.0.7

5 years ago

2.0.6

5 years ago

2.0.5

5 years ago

2.0.4

5 years ago

2.0.3

5 years ago

2.0.2

5 years ago

2.0.1

5 years ago

2.0.0

5 years ago

1.24.0

5 years ago

1.23.2

5 years ago

1.23.1

5 years ago

1.23.0

5 years ago

1.22.1

5 years ago

1.22.0

5 years ago

1.21.0

5 years ago

1.20.0

5 years ago