diff options
Diffstat (limited to 'doc/subscriptions/self_managed/index.md')
| -rw-r--r-- | doc/subscriptions/self_managed/index.md | 56 |
1 files changed, 42 insertions, 14 deletions
diff --git a/doc/subscriptions/self_managed/index.md b/doc/subscriptions/self_managed/index.md index 5f232bd4ed2..a63c2830909 100644 --- a/doc/subscriptions/self_managed/index.md +++ b/doc/subscriptions/self_managed/index.md @@ -1,4 +1,7 @@ --- +stage: none +group: unassigned +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/#designated-technical-writers type: index, reference --- @@ -6,16 +9,23 @@ type: index, reference You can install, administer, and maintain your own GitLab instance. -In this page we'll go through the details of your GitLab self-managed subscription. +This page covers the details of your GitLab self-managed subscription. -## Choose a GitLab tier +## Subscription + +The cost of a GitLab self-managed subscription is determined by the following: + +- GitLab tier +- Subscription seats + +## GitLab tier Pricing is [tier-based](https://about.gitlab.com/pricing/), allowing you to choose the features which fit your budget. For information on what features are available at each tier, see the [GitLab self-managed feature comparison](https://about.gitlab.com/pricing/self-managed/feature-comparison/). -## Choose the number of users +## Subscription seats A self-managed subscription uses a hybrid model. You pay for a subscription according to the maximum number of users enabled during the subscription period. @@ -23,14 +33,17 @@ For instances that aren't offline or on a closed network, the maximum number of simultaneous users in the self-managed installation is checked each quarter, using [Seat Link](#seat-link). -Every occupied seat is counted in the subscription, with the following exceptions: +### Billable users + +A _billable user_ counts against the number of subscription seats. Every user is considered a +billable user, with the following exceptions: -- [Deactivated](../../user/admin_area/activating_deactivating_users.md#deactivating-a-user), [pending approval](../../user/admin_area/approving_users.md) and - [blocked](../../user/admin_area/blocking_unblocking_users.md) users who are restricted prior to the - renewal of a subscription won't be counted as active users for the renewal subscription. They may - count as active users in the subscription period in which they were originally added. +- [Deactivated users](../../user/admin_area/activating_deactivating_users.md#deactivating-a-user) and + [blocked users](../../user/admin_area/blocking_unblocking_users.md) don't count as billable users in the current subscription. When they are either deactivated or blocked they release a _billable user_ seat. However, they may + 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), etc.). +- 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). ### Users statistics @@ -39,8 +52,23 @@ and blocked, go to **Admin Area > Overview > Dashboard** and select **Users stat in the **Users** section. For more details, see [Users statistics](../../user/admin_area/index.md#users-statistics). -NOTE: **Note:** -If you have LDAP integration enabled, anyone in the configured domain can sign up for a GitLab account. This can result in an unexpected bill at time of renewal. Consider [disabling new signups](../../user/admin_area/settings/sign_up_restrictions.md) and managing new users manually instead. +### Tips for managing users and subscription seats + +Managing the number of users against the number of subscription seats can be a challenge: + +- If LDAP integration is enabled, anyone in the configured domain can sign up for a GitLab account. + This can result in an unexpected bill at time of renewal. +- If sign-up is enabled on your instance, anyone who can access the instance can sign up for an + account. + +GitLab has several features which can help you manage the number of users: + +- Enable the [**Require administrator approval for new sign ups**](../../user/admin_area/settings/sign_up_restrictions.md#require-administrator-approval-for-new-sign-ups) + option. +- Enable the [User cap](../../user/admin_area/settings/sign_up_restrictions.md#user-cap) + option. **Available in GitLab 13.6 and later**. +- [Disable new sign-ups](../../user/admin_area/settings/sign_up_restrictions.md), and instead manage new + users manually. ## Obtain a subscription @@ -96,10 +124,10 @@ It's important to regularly review your user accounts, because: #### Users over License A GitLab subscription is valid for a specific number of users. For details, see -[Choose the number of users](#choose-the-number-of-users). If the active user +[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 the _true up_ process. +renewal, or at the time of renewal. This is also known as the _true up_ process. Self-managed instances can add users to a subscription any time during the subscription period. The cost of additional users added during the subscription @@ -144,7 +172,7 @@ We recommend following these steps during renewal: | 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. | - | Active users | The number of current active users on your system. | + | Active users | The daily count of active users on your system. | | Maximum users | The highest number of active 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 will be incurred at the next renewal. | |