Showback / Consumption Reporting

Customer Problem: As of today users in Quay have very little control to contain unbounded growth of storage consumption and utilization of the registry. There is no monitoring of growth available for scarce / expensive system resources like backend storage capacity. It Is also hard to attribute utilization to a particular set of content owners in Quay.

Goal: Provide usage reporting as a basis for quota management capabilities in Quay

Why is this important: Various customers are running Quay in large deployments providing Quay as a service to several internal and external customers. Many of those want to run some kind of showback for Quay (mostly reporting) and defining quotas to warn users when reaching thresholds with the eventual goal to cap utilization of the platform.

Dependencies (internal and external):

1. n/a

Prioritized epics + deliverables:

Usage / Quota Reporting

1. As a Quay superuser I can see an overview of all organizations which depicts the aggregate storage consumption of images of the org
2. As a Quay superuser I can see the overall storage consumption of the entire registry
3. As a Quay user with access to an organization I want to see the aggregate storage consumption of all content in the context of that organization
4. As a Quay users with access to an organization I want to see a list of all image repositories and their aggregate storage consumption of all contained tags at the level of that organization 

Soft Quota Management

1. As a user I can define soft quotas on an org / repo level for all of the data points mentioned above.
2. As a user I can configure notifications if the soft quota has been reached which might include a list of email addresses or any other supported notification method as well.
3. As a user I can configure a reminder interval to send out follow-up notifications that a (soft) quota has been reached after the initial notification has been sent out until either the quota has been changed or the values are below the threshold

Estimate (XS, S, M, L, XL, XXL): XXL

Previous Work:

Open questions:

• we may want to add additional quota / showback metrics in the future, e.g. aggregate count of image pulls - are there any infrastructure / design decisions to be made now to enable such a use case in the future?