diff options
Diffstat (limited to 'doc/subscriptions')
| -rw-r--r-- | doc/subscriptions/gitlab_com/index.md | 53 | ||||
| -rw-r--r-- | doc/subscriptions/index.md | 4 | ||||
| -rw-r--r-- | doc/subscriptions/self_managed/index.md | 67 |
3 files changed, 85 insertions, 39 deletions
diff --git a/doc/subscriptions/gitlab_com/index.md b/doc/subscriptions/gitlab_com/index.md index 7dd08da74f9..aef1c1127c5 100644 --- a/doc/subscriptions/gitlab_com/index.md +++ b/doc/subscriptions/gitlab_com/index.md @@ -1,6 +1,6 @@ --- -stage: fulfillment -group: fulfillment +stage: Fulfillment +group: Purchase info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments type: index, reference --- @@ -106,15 +106,46 @@ to the **Billing** section of the relevant namespace: The following table describes details of your subscription for groups: - | Field | Description | - |-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| - | **Seats in subscription** | If this is a paid plan, represents the number of seats you've paid to support in your group. | - | **Seats currently in use** | Number of seats in use. | - | **Max seats used** | Highest number of seats you've used. If this exceeds the seats in subscription, you may owe an additional fee for the additional users. | - | **Seats owed** | If your maximum seats used exceeds the seats in your subscription, you owe an additional fee for the users you've added. | - | **Subscription start date** | Date your subscription started. If this is for a Free plan, is the date you transitioned off your group's paid plan. | - | **Subscription end date** | Date your current subscription ends. Does not apply to Free plans. | - | **Billable users list** | List of users that belong to your group subscription. Does not apply to Free plans. | + | Field | Description | + |-----------------------------|-------------| + | **Seats in subscription** | If this is a paid plan, represents the number of seats you've bought for this group. | + | **Seats currently in use** | Number of seats in use. Select **See usage** to see a list of the users using these seats. For more details, see [Seat usage](#seat-usage). | + | **Max seats used** | Highest number of seats you've used. | + | **Seats owed** | _Seats owed_ = _Max seats used_ - _Seats in subscription_. | + | **Subscription start date** | Date your subscription started. If this is for a Free plan, it's the date you transitioned off your group's paid plan. | + | **Subscription end date** | Date your current subscription ends. Does not apply to Free plans. | + +## Seat usage + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216899) in GitLab 13.5. +> - [Updated](https://gitlab.com/gitlab-org/gitlab/-/issues/292086) in GitLab 13.8 to include public + email address. + +The **Seat usage** page lists all users occupying seats. Details for each user include: + +- Full name +- Username +- Public email address (if they have provided one in their [profile settings](../../user/profile/index.md#profile-settings)) + +The Seat usage listing is updated live, but the usage statistics on the billing page are updated +only once per day. For this reason there can be a minor difference between the seat usage listing +and the billing page. + +### Search seat usage + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/262875) in GitLab 13.8. + +To search users in the **Seat usage** page, enter a string in the search field. A minimum of 3 +characters are required. + +The search returns those users whose first name, last name, or username contain the search string. + +For example: + +| First name | Search string | Match ? | +|:-----------|:--------------|:--------| +| Amir | `ami` | Yes | +| Amir | `amr` | No | ## Renew your GitLab.com subscription diff --git a/doc/subscriptions/index.md b/doc/subscriptions/index.md index d80a2ebe179..383ba471df4 100644 --- a/doc/subscriptions/index.md +++ b/doc/subscriptions/index.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Fulfillment +group: Purchase info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments type: index, reference --- diff --git a/doc/subscriptions/self_managed/index.md b/doc/subscriptions/self_managed/index.md index 301d78b708a..a9c0337509a 100644 --- a/doc/subscriptions/self_managed/index.md +++ b/doc/subscriptions/self_managed/index.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Fulfillment +group: Purchase info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments type: index, reference --- @@ -11,6 +11,16 @@ You can install, administer, and maintain your own GitLab instance. This page covers the details of your GitLab self-managed subscription. +GitLab subscription management requires access to the Customers Portal. + +## Customers Portal + +GitLab provides the [Customers Portal](../index.md#customers-portal) where you can +manage your subscriptions and your account details. + +Customers of resellers do not have access to this portal and should contact their reseller for any +changes to their subscription. + ## Subscription The cost of a GitLab self-managed subscription is determined by the following: @@ -43,7 +53,7 @@ billable user, with the following exceptions: count toward overages in the subscribed seat count. - Users who are [pending approval](../../user/admin_area/approving_users.md). - Members with Guest permissions on an Ultimate subscription. -- GitLab-created service accounts: `Ghost User` and bots (`Support Bot`, [`Project bot users`](../../user/project/settings/project_access_tokens.md#project-bot-users), and so on). +- GitLab-created service accounts: `Ghost User` and bots [(`Support Bot`](../../user/project/service_desk.md#support-bot-user), [`Project bot users`](../../user/project/settings/project_access_tokens.md#project-bot-users), and so on). ### Tips for managing users and subscription seats @@ -95,10 +105,10 @@ It also displays the following important statistics: | Field | Description | |:-------------------|:------------| -| Users in License | The number of users you've paid for in the current license loaded on the system. This does not include the amount you've paid for `Users over license` during renewal. | -| Billable users | The daily count of billable users on your system. | -| Maximum users | The highest number of billable users on your system during the term of the loaded license. If this number exceeds your users in license count at any point, you incur users over license. | -| Users over license | The number of users that exceed the `Users in License` for the current license term. Charges for this number of users are incurred at the next renewal. | +| Users in License | The number of users you've paid for in the current license loaded on the system. The number does not change unless you [add seats](#add-seats-to-a-subscription) during your current subscription period. | +| Billable users | The daily count of billable users on your system. The count may change as you block or add users to your instance. | +| Maximum users | The highest number of billable users on your system during the term of the loaded license. | +| Users over license | Calculated as `Maximum users` - `Users in License` for the current license term. This number incurs a retroactive charge that needs to be paid for at renewal. | ## Renew your subscription @@ -122,28 +132,38 @@ the contact person who manages your subscription. It's important to regularly review your user accounts, because: -- A GitLab subscription is based on the number of users. You pay more than you should if you renew - for too many users, while the renewal fails if you attempt to renew a subscription for too few - users. +- Stale user accounts that are not blocked count as billable users. You may pay more than you should + if you renew for too many users. - Stale user accounts can be a security risk. A regular review helps reduce this risk. #### Users over License -A GitLab subscription is valid for a specific number of users. For details, see -[Billable users](#billable-users). If the billable user -count exceeds the number included in the subscription, known as the number of -_users over license_, you must pay for the excess number of users either before -renewal, or at the time of renewal. This is also known as the _true up_ process. +A GitLab subscription is valid for a specific number of seats. The number of users over license +is the number of _Maximum users_ that exceed the _Users in License_ for the current license term. +You must pay for this number of users either before renewal, or at the time of renewal. This is +known as the _true up_ process. + +To view the number of _users over license_ go to the **Admin Area**. -To view the number of _Users over License_ go to the **Admin Area**. +##### Users over license example -### Add users to a subscription +You purchase a license for 10 users. -Self-managed instances can add users to a subscription any time during the -subscription period. The cost of additional users added during the subscription +| Event | Billable members | Maximum users | +|:---------------------------------------------------|:-----------------|:--------------| +| Ten people (users) occupy all 10 seats. | 10 | 10 | +| Two new people join. | 12 | 12 | +| Three people leave and their accounts are removed. | 9 | 12 | + +Users over license = 12 - 10 (Maximum users - users in license) + +### Add seats to a subscription + +The users in license count can be increased by adding seats to a subscription any time during the +subscription period. The cost of seats added during the subscription period is prorated from the date of purchase through the end of the subscription period. -To add users to a subscription: +To add seats to a subscription: 1. Log in to the [Customers Portal](https://customers.gitlab.com/). 1. Navigate to the **Manage Purchases** page. @@ -185,7 +205,7 @@ An invoice is generated for the renewal and available for viewing or download on Seat Link allows GitLab Inc. to provide our self-managed customers with prorated charges for user growth throughout the year using a quarterly reconciliation process. -Seat Link daily sends a count of all users in connected self-managed instances to GitLab. That information is used to automate prorated reconciliations. The data is sent securely through an encrypted HTTPS connection. +Seat Link daily sends a count of all users in connected self-managed instances to GitLab. That information is used to automate prorated reconciliations. The data is sent securely through an encrypted HTTPS connection to `customers.gitlab.com` on port `443`. Seat Link provides **only** the following information to GitLab: @@ -312,11 +332,6 @@ only. However, if you remove the license, you immediately revert to Core features, and the instance become read / write again. -## Customers Portal - -GitLab provides the [Customers Portal](../index.md#customers-portal) where you can -manage your subscriptions and your account details. - ## Contact Support Learn more about: |