Commit d1b99a96 authored by Nick Gaskill's avatar Nick Gaskill

Merge branch 'russell/improve-licence-details-info' into 'master'

Improve licence details info

See merge request gitlab-org/gitlab!49920
parents b15f4a3f 9827b6fc
......@@ -45,13 +45,6 @@ billable user, with the following exceptions:
- 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).
### Users statistics
To view a breakdown of the users within your instance, including active, billable,
and blocked, go to **Admin Area > Overview > Dashboard** and select **Users statistics**
in the **Users** section. For more details, see
[Users statistics](../../user/admin_area/index.md#users-statistics).
### Tips for managing users and subscription seats
Managing the number of users against the number of subscription seats can be a challenge:
......@@ -69,6 +62,7 @@ GitLab has several features which can help you manage the number of users:
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.
- View a breakdown of users by role in the [Users statistics](../../user/admin_area/index.md#users-statistics) page.
## Obtain a subscription
......@@ -86,13 +80,25 @@ instance, ensure you're purchasing enough seats to
## View your subscription
If you are an administrator, to view the status of your self-managed subscription,
log in to the your GitLab instance and go to the **License** page:
If you are an administrator, you can view the status of your subscription:
1. Go to **Admin Area**.
1. From the left-hand menu, select **License**.
Read more about the [license admin area](../../user/admin_area/license.md).
The **License** page includes the following details:
- Licensee
- Plan
- When it was uploaded, started, and when it expires
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. |
## Renew your subscription
......@@ -116,9 +122,9 @@ 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 fail if you
attempt to renew a subscription for too few users.
- 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 can be a security risk. A regular review helps reduce this risk.
#### Users over License
......@@ -129,6 +135,10 @@ 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.
To view the number of _Users over License_ go to the **Admin Area**.
### Add users to a subscription
Self-managed instances can add users to a subscription any time during the
subscription period. The cost of additional users added during the subscription
period is prorated from the date of purchase through the end of the subscription period.
......@@ -163,19 +173,6 @@ We recommend following these steps during renewal:
1. In the first box, enter the total number of user licenses you’ll need for the upcoming year. Be sure this number is at least **equal to, or greater than** the number of billable users in the system at the time of performing the renewal.
1. Enter the number of [users over license](#users-over-license) in the second box for the user overage incurred in your previous subscription term.
NOTE:
You can find the _users over license_ in your instance's **Admin** dashboard by clicking on the **Admin Area** in the top bar, or navigating to `/admin`.
The following table describes details of your admin dashboard and renewal terms:
| 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. |
1. Review your renewal details and complete the payment process.
1. A license for the renewal term is available for download on the [Manage Purchases](https://customers.gitlab.com/subscriptions) page on the relevant subscription card. Select **Copy license to clipboard** or **Download license** to get a copy.
1. [Upload](../../user/admin_area/license.md#uploading-your-license) your new license to your instance.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment