Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Names associated with the services are inconsistent. #10

Open
bb233 opened this issue Feb 6, 2019 · 3 comments
Open

Names associated with the services are inconsistent. #10

bb233 opened this issue Feb 6, 2019 · 3 comments

Comments

@bb233
Copy link
Contributor

bb233 commented Feb 6, 2019

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:

  • The executable `archival_storage_ingest_server_sfs_fixity_check
  • The worker class SFSFixityGenerator
  • The log file fixity_sfs.log
  • The configuration environment variables asi_sfs_fixity_*
  • The SQS queues cular_development_fixity_sfs* and the associated ruby constants Queues::QUEUE_FIXITY_SFS*
  • The systemd service fixity_check_sfs.service and associated script fixity_check_sfs.script

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
Copy link
Contributor

sk274 commented Feb 6, 2019

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
Copy link
Contributor Author

bb233 commented Feb 6, 2019

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

@sk274
Copy link
Contributor

sk274 commented Feb 27, 2019

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'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants