cul-it / archival-storage-ingest

Automated ingest application for CULAR archival storage
1 stars 0 forks source link

Names associated with the services are inconsistent. #10

Open bb233 opened 5 years ago

bb233 commented 5 years ago

For each service, there are a series of files, workers, environment variables, queues, and executables associated with them. For instance, for the service to calculate SFS fixity, we have:

While there appears to be a preference in this case (and with the other services) to refer to it as "sfs_fixity", this is mostly internal; the externally-facing usages use a mix of sfs_fixity_check, fixity_sfs, sfs_fixity, and fixity_check_sfs instead.

This same pattern of inconsistent names exists across 5 of the 6 services, the single-word named "ingest" server excepted.

I propose that one name for each service be chosen, and the code modified to be consistent with that.

In this example, by choosing sfs_fixity as the name for this service, we would rename the log file to sfs_fixity.log, the SQS queues to cular_development_sqs_fixity* and Queues::QUEUE_SFS_FIXITY*, and the systemd service to sfs_fixity.service (or perhaps asi_sfs_fixity.service so the services are grouped together in systemctl status).

sk274 commented 5 years ago

I think it is a good idea. The queue names, however, I think we can leave them as is. At some point, we will need to remove the "development" in the queue names and we should do that together.

bb233 commented 5 years ago

OK. I'll add a JIRA ticket for this.

sk274 commented 5 years ago

New proposed queue names (may have to put production after cular if Greg's team needs it)

QUEUE_INGEST = 'cular_ingest' QUEUE_INGEST_IN_PROGRESS = 'cular_ingest_in_progress'

QUEUE_TRANSFER_S3 = 'cular_transfer_s3' QUEUE_TRANSFER_S3_IN_PROGRESS = 'cular_transfer_s3_in_progress' QUEUE_TRANSFER_SFS = 'cular_transfer_sfs' QUEUE_TRANSFER_SFS_IN_PROGRESS = 'cular_transfer_sfs_in_progress'

QUEUE_INGEST_FIXITY_S3 = 'cular_ingest_fixity_s3' QUEUE_INGEST_FIXITY_S3_IN_PROGRESS = 'cular_ingest_fixity_s3_in_progress' QUEUE_INGEST_FIXITY_SFS = 'cular_ingest_fixity_sfs' QUEUE_INGEST_FIXITY_SFS_IN_PROGRESS = 'cular_ingest_fixity_sfs_in_progress' QUEUE_INGEST_FIXITY_COMPARE = 'cular_ingest_fixity_comparison' QUEUE_INGEST_FIXITY_COMPARE_IN_PROGRESS = 'cular_ingest_fixity_comparison_in_progress'

QUEUE_PERIODIC_FIXITY_S3 = 'cular_periodic_fixity_s3' QUEUE_PERIODIC_FIXITY_S3_IN_PROGRESS = 'cular_periodic_fixity_s3_in_progress' QUEUE_PERIODIC_FIXITY_SFS = 'cular_periodic_fixity_sfs' QUEUE_PERIODIC_FIXITY_SFS_IN_PROGRESS = 'cular_periodic_fixity_sfs_in_progress' QUEUE_PERIODIC_FIXITY_COMPARE = 'cular_periodic_fixity_comparison' QUEUE_PERIODIC_FIXITY_COMPARE_IN_PROGRESS = 'cular_periodic_fixity_comparison_in_progress'

QUEUE_ERROR = 'cular_error' QUEUE_COMPLETE = 'cular_done'