@cumulus/checksum

@cumulus/checksum

Checksum

The @cumulus/checksum library provides checksum functionality used by Cumulus packages and tasks. Currently the supported input includes file streams, and supported checksum algorithms include cksum and the algorithms available to the crypto package, as documented here.

Usage

const fs = require('fs');
const { generateChecksumFromStream } = require('@cumulus/checksum');

const stream = fs.createReadStream('myDataFile.hdf');
const myCksum = generateChecksumFromStream('cksum', stream);

API

checksum

• checksum
  • .generateChecksumFromStream(algorithm, stream, [options]) ⇒ Promise.<(number|string)>
  • .validateChecksumFromStream(algorithm, stream, expectedSum, [options]) ⇒ Promise.<boolean>

checksum.generateChecksumFromStream(algorithm, stream, [options]) ⇒ Promise.<(number|string)>

Create file checksum from readable stream

Kind: static method of checksum
Returns: Promise.<(number|string)> - the file checksum

Param	Type	Description
algorithm	string	Checksum algorithm type
stream	stream.Readable	A readable file stream
[options]	Object	Checksum options, see crypto.createHash()

checksum.validateChecksumFromStream(algorithm, stream, expectedSum, [options]) ⇒ Promise.<boolean>

Validate expected checksum against calculated checksum

Kind: static method of checksum
Returns: Promise.<boolean> - whether expectedSum === calculatedSum

Param	Type	Description
algorithm	string	Checksum algorithm
stream	stream.Readable	A readable file stream
expectedSum	number | string	expected checksum
[options]	Object	Checksum options

About Cumulus

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

Cumulus Documentation

---

Generated automatically using npm run build-docs

Changelog

[v13.1.0] 2022-7-22

MIGRATION notes

• The changes introduced in CUMULUS-2962 will re-introduce a files_granules_cumulus_id_index on the files table in the RDS database. This index will be automatically created as part of the bootstrap lambda function on deployment of the data-persistence module.

  In cases where the index is already applied, this update will have no effect.

  Please Note: In some cases where ingest is occurring at high volume levels and/or the files table has > 150M file records, the migration may fail on deployment due to timing required to both acquire the table state needed for the migration and time to create the index given the resources available.

  For reference a rx.5 large Aurora/RDS database with no activity took roughly 6 minutes to create the index for a file table with 300M records and no active ingest, however timed out when the same migration was attempted in production with possible activity on the table.

  If you believe you are subject to the above consideration, you may opt to manually create the files table index prior to deploying this version of Core with the following procedure:

  ---

  • Verify you do not have the index:

  select * from pg_indexes where tablename = 'files';
  
   schemaname | tablename |        indexname        | tablespace |                                       indexdef
  ------------+-----------+-------------------------+------------+---------------------------------------------------------------------------------------
   public     | files     | files_pkey              |            | CREATE UNIQUE INDEX files_pkey ON public.files USING btree (cumulus_id)
   public     | files     | files_bucket_key_unique |            | CREATE UNIQUE INDEX files_bucket_key_unique ON public.files USING btree (bucket, key)
  

  In this instance you should not see an indexname row with files_granules_cumulus_id_index as the value. If you do, you should be clear to proceed with the installation.

  • Quiesce ingest

  Stop all ingest operations in Cumulus Core according to your operational procedures. You should validate that it appears there are no active queries that appear to be inserting granules/files into the database as a secondary method of evaluating the database system state:

  select pid, query, state, wait_event_type, wait_event from pg_stat_activity where state = 'active';
  

  If query rows are returned with a query value that involves the files table, make sure ingest is halted and no other granule-update activity is running on the system.

  Note: In rare instances if there are hung queries that are unable to resolve, it may be necessary to manually use psql Server Signaling Functions pg_cancel_backend and/or pg_terminate_backend if the migration will not complete in the next step.

  • Create the Index

  Run the following query to create the index. Depending on the situation this may take many minutes to complete, and you will note your CPU load and disk I/O rates increase on your cluster:

  CREATE INDEX files_granule_cumulus_id_index ON files (granule_cumulus_id);
  

  You should see a response like:

  CREATE INDEX
  

  and can verify the index files_granule_cumulus_id_index was created:

  => select * from pg_indexes where tablename = 'files';
  schemaname | tablename |           indexname            | tablespace |                                           indexdef
   ------------+-----------+--------------------------------+------------+----------------------------------------------------------------------------------------------
   public     | files     | files_pkey                     |            | CREATE UNIQUE INDEX files_pkey ON public.files USING btree (cumulus_id)
   public     | files     | files_bucket_key_unique        |            | CREATE UNIQUE INDEX files_bucket_key_unique ON public.files USING btree (bucket, key)
   public     | files     | files_granule_cumulus_id_index |            | CREATE INDEX files_granule_cumulus_id_index ON public.files USING btree (granule_cumulus_id)
  (3 rows)
  

  • Once this is complete, you may deploy this version of Cumulus as you normally would. If you are unable to stop ingest for the above procedure and cannot migrate with deployment, you may be able to manually create the index while writes are ongoing using postgres's CONCURRENTLY option for CREATE INDEX. This can have significant impacts on CPU/write IO, particularly if you are already using a significant amount of your cluster resources, and may result in failed writes or an unexpected index/database state.

  PostgreSQL's documentation provides more information on this option. Please be aware it is unsupported by Cumulus at this time, so community members that opt to go this route should proceed with caution.

  ---

Notable changes

• CUMULUS-2962
  • Re-added database structural migration to files table to add an index on granule_cumulus_id
• CUMULUS-2929
  • Updated move-granule task to check the optional collection configuration parameter meta.granuleMetadataFileExtension to determine the granule metadata file. If none is specified, the granule CMR metadata or ISO metadata file is used.

Changed

• Updated Moment.js package to 2.29.4 to address security vulnerability
• CUMULUS-2967
  • Added fix example/spec/helpers/Provider that doesn't fail deletion 404 in case of deletion race conditions

Fixed

• CUMULUS-2995

  • Updated Lerna package to 5.1.8 to address security vulnerability

• CUMULUS-2863

  • Fixed @cumulus/api validateAndUpdateSqsRule method to allow 0 retries and 0 visibilityTimeout in rule's meta.

• CUMULUS-2959

  • Fixed @cumulus/api granules module to convert numeric productVolume to string when an old granule record is retrieved from DynamoDB

• Fixed the following links on Cumulus docs' Getting Started page:

  • Cumulus Deployment
  • Terraform Best Practices
  • Integrator Common Use Cases

• Also corrected the How to Deploy Cumulus link in the Glossary