Display build minutes (EE only)

Description

We are going to start calculating shared CI runner build minutes used per user/group; now we need to report build minute usage to users. Perhaps this should be an EE-only feature, but the current MR is in CE.

Proposal

• Maybe add a new page into group settings?
• Report shared runner build minutes used this month
• [Stretch] Show history of build minutes used each month
• [Stretch] Show max build minutes used in last X months
• [Stretch] Show build minute limit and indication of whether you are under/over
• [Stretch] Project estimated build minutes for the rest of the month
• [Stretch] Or show current build minute usage relative to prorated monthly limit
• [Stretch] Show when user/group is over limit
• [Stretch] Know if user/group has purchased Bronze package, show information about it

Design

• Pipeline list label:
• Pipeline list label tooltip:
• Group settings pipeline quote dropdown: (wording should be: Build minute quota)
• Group settings pipeline quota screen:
• When editing a group as admin at /admin/groups/groupname/edit: (With the help icon leading to an help page explaining build minutes.)
• Warning on groups and projects that have CI and shared runners enabled visible to any member:
• Same warning for group admins (stretch):
• 80% warning for group admins (stretch):

Links / references

• Per-minute MR: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7828

/cc @ayufan @dimitrieh @mikegreiling

Maybe link to customers.gitlab.com instead of putting paid plan data in page?

@markpundsack as this is more of a product question ;). From this comment I suppose we go per project? https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7828#note_19170859

In that sense it would make sense to report these minutes either in the ci/cd project settings (only visible to masters) or as a separate tab under pipelines (visible to everyone)

However if we do want this per group/user, I suppose we could show this the same way with a pipelines tab on the group page https://gitlab.com/gitlab-org/gitlab-ce/issues/18054, however for now keep it as a tab on its own: "Pipeline Statistics".

An entirely different route (if we go the visible to all way) would be to show it at https://gitlab.com/gitlab-org/gitlab-ce/graphs/master/ci

Thoughts?

@dimitrieh From https://docs.google.com/document/d/1n41Zh4yN5DTKJ_K1RUjyd_NS2JBEGcF1pxvAMn76n1M/edit we decided to limit to "2000 build minutes per group/namespace".

moved from gitlab-org/gitlab-ce#25425

Moved this to EE because it is of little value to CE.

changed title from Display build minutes (EE only?) to Display build minutes (EE only)

Update after meeting on 12-12-2017:

MVP consists of or has the following results:

• Per group based
• We need a way of excempting certain groups (Limit them either yes or no)
• Report minute usage on a group in a new view?
• Shared runners need a way of saying if they count against the limit yes or no? ( @markpundsack can you elaborate when this is needed exactly..i had this in my notes)
• Warning to group admins at 80% and 100% of limit by email and warning banner on related pages.
  • up sell bronze package?
• Warning to all users on related project pages if they use CI and have shared runners enabled with warning banner.
• If "Only allow merge requests to be merged if the build succeeds" is turned on and build limit is exceeded, they will/can never be merged.
• What happens when a build is not run due to exceeding build minute limits:
  • Build fails/skips/pending
  • Build doesn't run again automatically when limit gets updated
  • Build has a tag of "Exceeds minute limit

@markpundsack correct me if you spot any mistakes

assigned to @dimitrieh

The warnings at 80% and 100%, upsell to bronze, and other warnings can probably be considered stretch. The minimum is that pipelines get blocked after 100%, and they will show up as pending with something like an "quota exceed" label, and then after ~24hrs they will fail.

added feature proposal label

Pipeline list:

Pipeline list tootlip:

Group settings:

Group settings with progress bar.. (stretch):

Group settings pipeline quota screen: (the calendar icon is non-applicable for now)

When editing a group as admin at /admin/groups/groupname/edit:

With the help icon leading to an help page explaining build minutes.

[GitLab.com only!] If the group has bronze package enabled:

Warning on groups and projects that have CI and shared runners enabled visible to any member:

Same warning for group admins (stretch):

80% warning for group admins (stretch):

@markpundsack I am not entirely sure on the wording. Please see if it fits your vision.

@mikegreiling would this be doable in your mind :)

Great aspirational stuff in there. The group settings page can't show a graph though since that data is not available. Just a simple count and limit, if applicable. At most we might be able to show a sorted list of projects using up build minutes.

I'm not sure about the admin interface to setting quotas. @ayufan is that feasible? If so, I think we should have and show a global group limit, and then be able to override for each group or project, but on that override, we should probably show what the default is.

There's no point putting anything about bronze package in the admin side, if that's for GitLab.com and it's controlled by customers.gitlab.com.

@tauriedavis Can you help with the wording?

Here are my copy suggestions

• Tooltip: Build minutes quota exceeded

• Warning on groups and projects that have CI and shared runners enabled visible to any member: Your group has exceeded their build minutes quota. Pipelines will not run anymore.

• Same warning for group admins (stretch): Your group has exceeded their build minutes quota. Pipelines will not run anymore. Upgrade to the bronze package.

• 80% warning for group admins (stretch): Your group has used 80% of their build minutes quota. Pipelines will stop running after your quota is exceeded. Upgrade to the bronze package.

@dimitrieh I think this all looks doable, though the graph page seems like it should be a separate project.

mentioned in issue #1414

@mikegreiling in that sense, let's keep it at:

• Pipeline list label:
• Pipeline list label tooltip:
• Group settings pipeline quota screen:
• When editing a group as admin at /admin/groups/groupname/edit: (With the help icon leading to an help page explaining build minutes.)
• Warning on groups and projects that have CI and shared runners enabled visible to any member:
• Same warning for group admins (stretch):
• 80% warning for group admins (stretch):

I updated the main issue body with these same designs and notes

I created a separate issue for the graph if we ever come to that: https://gitlab.com/gitlab-org/gitlab-ee/issues/1414

added frontend and removed ~126459 labels

assigned to @mikegreiling

Here's what I've got so far

Project within a Group namespace:

Project within a User namespace:

I changed "Don't show again" to "Don't show again this month" because I imagine if someone hides this and then runs out in some future period, they'd want to be notified again... any thoughts on this?

Also I've added the following statuses to the admin group page:

I've also added the following setting to the "Edit Group" page:

should the "over limit" warning be displayed on pages other than the main project homepage? that is currently the only place the warning will get rendered.

@ayufan the "Edit Group" action does not currently do anything with the :shared_runners_minutes_limit value returned by the form... I'll need you to wire up the logic within the controller.

Also the Namespace helper methods will nee to be updated to account for the new setting which would override the global application setting.

Are we also going to let users and group owners put limits on individual projects, or is that something that we're waiting on for the next iteration of the feature?

@ayufan lastly, how can I get the shared_runners_minutes value for an individual project to implement the pipeline quote overview page? are these going to be tracked on a per-project basis or only on a namespace basis for now?

@mikegreiling

Currently you can't get that on per-project basis. I will have to figure out how to add that.

But, I'm impressed by your changes. Thanks for that :)

mentioned in merge request !965 (merged)

changed milestone to %8.16

closed via merge request !965 (merged)

mentioned in commit ed31055c

mentioned in commit 71165067

mentioned in commit 86bc9cd9