Skip to content

Score Server Profiles - Introduce s3 profile to replace collaboratory, amazon, and aws #474

@joneubank

Description

@joneubank

Summary of request

Continuing the effort to remove project specific references...

There are 3 different profiles that are used in an unclear way to indicate that the server is running with an S3 compatible backend. Those profiles are:

  • collaboratory
  • amazon
  • aws

We want to simplify the Score Server code base and operation to use the single profile s3 instead.

s3 is chosen instead of amazon or aws since the Score server is compatible with any S3 API, such as minio or Ceph, in addition to the Amazon AWS service.

This work will replace references to these profiles in @Profile annotations within java files, and replace their sections in the application.yaml default config.

Details

In the following classes, update the @Profile annotations to remove the profile names collaboratory, amazon, and aws and replace then with s3:

  • BackendHealth
  • ServerConfig
  • S3Config
  • S3DownloadService
  • S3ListingService
  • S3UploadService

In the server application.yaml:

  • Remove the sections for amazon and collaboratory
  • Add a new section for the profile s3.
    • Include every property that could be provided to configure our s3 connection (refer to S3Config class)
    • Comment out any properties that should not have a default (url, encryption key, etc.)

Add some documentation to the score-server/README.md:

  • Section for S3
  • name the spring profile required
  • list the configuration properties and what they do

Additional context

With these changes, we will need to update any documentation we have on score profiles, including overture.bio .

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions