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

Figure out a strategy for release.json #400

Closed
ebezzi opened this issue Apr 20, 2023 · 2 comments · Fixed by #409
Closed

Figure out a strategy for release.json #400

ebezzi opened this issue Apr 20, 2023 · 2 comments · Fixed by #409
Assignees
Labels
P0 Priority 0 - Critical, fix ASAP!

Comments

@ebezzi
Copy link
Member

ebezzi commented Apr 20, 2023

release.json is the file that the census library uses to determine the location of the artifacts. This is currently hosted on the public bucket and needs to change. We have a few options:

  1. Keep it on the existing bucket (in single-cell-prod). The bucket will need to become private and a Cloudfront rule needs to be created so that the file can be publicly accessible.
    a. This has the advantage that existing clients will not break
    b. Since the builder needs to write to this file, an IAM permission could be necessary if the builder will run on the new account
  2. Move the release.json file to the new S3 bucket
    a. This will break existing clients
    b. This might pose additional security concerns, as this file is effectively vulnerable to potential injections
    c. Easiest solution since the builder will write this file after the copy is done to the same bucket
  3. Move the release.json file to a different location (API, GitHub, ...)
    a. Will still break existing clients
    b. Likely more complex than necessary.
@atolopko-czi
Copy link
Collaborator

If we care about existing api clients (but I don't think we should), we could do 1 and update the s3 urls to the new bucket, but otherwise consider it end-of-life, no further updates. New api clients will find a new release.json in the new bucket.

@pablo-gar
Copy link
Contributor

As per our conversation we should not consider existing client as the API has been flagged unstable, we will make sure to communicate the change to users once we implement it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P0 Priority 0 - Critical, fix ASAP!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants