diff options
Diffstat (limited to 'doc/subscriptions')
| -rw-r--r-- | doc/subscriptions/bronze_starter.md | 18 | ||||
| -rw-r--r-- | doc/subscriptions/gitlab_com/index.md | 286 | ||||
| -rw-r--r-- | doc/subscriptions/quarterly_reconciliation.md | 22 | ||||
| -rw-r--r-- | doc/subscriptions/self_managed/index.md | 5 |
4 files changed, 143 insertions, 188 deletions
diff --git a/doc/subscriptions/bronze_starter.md b/doc/subscriptions/bronze_starter.md index 327fb8887ad..bb2a2303d29 100644 --- a/doc/subscriptions/bronze_starter.md +++ b/doc/subscriptions/bronze_starter.md @@ -68,7 +68,7 @@ the tiers are no longer mentioned in GitLab documentation: - [Full code quality reports in the code quality tab](../user/project/merge_requests/code_quality.md#code-quality-reports) - [Merge request approvals](../user/project/merge_requests/approvals/index.md) - [Multiple assignees](../user/project/merge_requests/getting_started.md#multiple-assignees) - - [Approval Rule information for Reviewers](../user/project/merge_requests/reviews/index.md#approval-rule-information-for-reviewers) **(PREMIUM)** + - [Approval Rule information for Reviewers](../user/project/merge_requests/reviews/index.md#approval-rule-information-for-reviewers) - [Required Approvals](../user/project/merge_requests/approvals/index.md#required-approvals) - [Code Owners as eligible approvers](../user/project/merge_requests/approvals/rules.md#code-owners-as-eligible-approvers) - [Approval rules](../user/project/merge_requests/approvals/rules.md) features @@ -89,14 +89,14 @@ the tiers are no longer mentioned in GitLab documentation: - Repositories: - [Repository size limit](../user/admin_area/settings/account_and_limit_settings.md#repository-size-limit) - Repository mirroring: - - [Pull mirroring](../user/project/repository/repository_mirroring.md#pull-from-a-remote-repository) outside repositories in a GitLab repository - - [Overwrite diverged branches](../user/project/repository/repository_mirroring.md#overwrite-diverged-branches) - - [Trigger pipelines for mirror updates](../user/project/repository/repository_mirroring.md#trigger-pipelines-for-mirror-updates) - - [Hard failures](../user/project/repository/repository_mirroring.md#hard-failure) when mirroring fails - - [Trigger pull mirroring from the API](../user/project/repository/repository_mirroring.md#trigger-an-update-using-the-api) - - [Mirror only protected branches](../user/project/repository/repository_mirroring.md#mirror-only-protected-branches) - - [Bidirectional mirroring](../user/project/repository/repository_mirroring.md#bidirectional-mirroring) - - [Mirror with Perforce Helix via Git Fusion](../user/project/repository/repository_mirroring.md#mirror-with-perforce-helix-via-git-fusion) + - [Pull mirroring](../user/project/repository/mirror/pull.md) outside repositories in a GitLab repository + - [Overwrite diverged branches](../user/project/repository/mirror/pull.md#overwrite-diverged-branches) + - [Trigger pipelines for mirror updates](../user/project/repository/mirror/pull.md#trigger-pipelines-for-mirror-updates) + - [Hard failures](../user/project/repository/mirror/pull.md#hard-failure) when mirroring fails + - [Trigger pull mirroring from the API](../user/project/repository/mirror/pull.md#trigger-an-update-by-using-the-api) + - [Mirror only protected branches](../user/project/repository/mirror/index.md#mirror-only-protected-branches) + - [Bidirectional mirroring](../user/project/repository/mirror/bidirectional.md) + - [Mirror with Perforce Helix via Git Fusion](../user/project/repository/mirror/bidirectional.md#mirror-with-perforce-helix-via-git-fusion) - Runners: - Run pipelines in the parent project [for merge requests from a forked project](../ci/pipelines/merge_request_pipelines.md#run-pipelines-in-the-parent-project-for-merge-requests-from-a-forked-project) - [Shared runners pipeline minutes quota](../user/admin_area/settings/continuous_integration.md#shared-runners-pipeline-minutes-quota) diff --git a/doc/subscriptions/gitlab_com/index.md b/doc/subscriptions/gitlab_com/index.md index cecbb362cb9..a8e02251b64 100644 --- a/doc/subscriptions/gitlab_com/index.md +++ b/doc/subscriptions/gitlab_com/index.md @@ -9,115 +9,85 @@ type: index, reference GitLab SaaS is the GitLab software-as-a-service offering, which is available at GitLab.com. You don't need to install anything to use GitLab SaaS, you only need to -[sign up](https://gitlab.com/users/sign_up). +[sign up](https://gitlab.com/users/sign_up). When you sign up, you choose: -This page reviews the details of your GitLab SaaS subscription. +- [A license tier](https://about.gitlab.com/pricing/). +- [The number of seats you want](#how-seat-usage-is-determined). -## Choose a GitLab SaaS tier - -Pricing is [tier-based](https://about.gitlab.com/pricing/), so you can choose -the features that fit your budget. For information on the features available -for each tier, see the -[GitLab SaaS feature comparison](https://about.gitlab.com/pricing/gitlab-com/feature-comparison/). - -## Choose the number of users - -NOTE: -Applied only to groups. - -A GitLab SaaS subscription uses a concurrent (_seat_) model. You pay for a -subscription according to the maximum number of users enabled at once. You can -add and remove users during the subscription period, as long as the total users -at any given time doesn't exceed the subscription count. - -Every occupied seat is counted in the subscription, with the following exception: - -- Members with Guest permissions on an Ultimate subscription. - -NOTE: -To support the open source community and encourage the development of open -source projects, GitLab grants access to **Ultimate** features for all GitLab SaaS -**public** projects, regardless of the subscription. GitLab also provides qualifying -open source projects with 50,000 CI minutes and free access to the Ultimate tier for -groups through the [GitLab for Open Source program](https://about.gitlab.com/solutions/open-source/). +All GitLab SaaS public projects, regardless of the subscription, get access to features in the **Ultimate** tier. +Qualifying open source projects also get 50,000 CI minutes and free access to the **Ultimate** tier +through the [GitLab for Open Source program](https://about.gitlab.com/solutions/open-source/). ## Obtain a GitLab SaaS subscription To subscribe to GitLab SaaS: -1. Create a user account for yourself using our +1. View the [GitLab SaaS feature comparison](https://about.gitlab.com/pricing/gitlab-com/feature-comparison/) + and decide which tier you want. +1. Create a user account for yourself by using the [sign up page](https://gitlab.com/users/sign_up). -1. Create a [group](../../user/group/index.md). GitLab groups help assemble related - projects together allowing you to grant members access to several projects - at once. A group is not required if you plan on having projects inside a personal - namespace. +1. Create a [group](../../user/group/index.md#create-a-group). You use the group to grant users access to several projects + at once. A group is not required if you plan to have projects in a personal namespace instead. 1. Create additional users and [add them to the group](../../user/group/index.md#add-users-to-a-group). -1. Select the GitLab SaaS plan through the - [Customers Portal](https://customers.gitlab.com/). -1. Link your GitLab SaaS account with your Customers Portal account. - Once a plan has been selected, if your account is not - already linked, GitLab prompts you to link your account with a - **Sign in to GitLab.com** button. -1. Select the namespace from the drop-down list to associate the subscription. -1. Proceed to checkout. - -NOTE: -You can also go to the [**My Account**](https://customers.gitlab.com/customers/edit) -page to add or change the GitLab SaaS account link. +1. On the left sidebar, select **Billing** and choose a tier. +1. Fill out the form to complete your purchase. ## View your GitLab SaaS subscription -To see the status of your GitLab SaaS subscription, log in to GitLab SaaS and go -to the **Billing** section: +Prerequisite: + +- You must have the Owner [role](../../user/permissions.md) for the group. -NOTE: -You must have Owner level [permissions](../../user/permissions.md) to view the billing page. +To see the status of your GitLab SaaS subscription: + +1. On the top bar, select **Menu > Groups** and find your group. +1. On the left sidebar, select **Settings > Billing**. -The following table describes details of your subscription: +The following information is displayed: | 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). | +| **Seats currently in use** | Number of seats in use. Select **See usage** to see a list of the users using these seats. | | **Max seats used** | Highest number of seats you've used. | -| **Seats owed** | _Seats owed_ = _Max seats used_ - _Seats in subscription_. | +| **Seats owed** | **Max seats used** minus **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 +## How seat usage is determined > - [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 [user settings](../../user/profile/index.md#access-your-user-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. +A GitLab SaaS subscription uses a concurrent (_seat_) model. You pay for a +subscription according to the maximum number of users enabled at one time. You can +add and remove users during the subscription period, as long as the total users +at any given time doesn't exceed the subscription count. Every user is included in seat usage, with the following exceptions: - Users who are pending approval. - Members with the Guest role on an Ultimate subscription. -- Users without project or group memberships on an Ultimate subscription. - 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.) +Seat usage is reviewed [quarterly or annually](../quarterly_reconciliation.md). + ### View seat usage To view a list of seats being used: 1. On the top bar, select **Menu > Groups** and find your group. 1. On the left sidebar, select **Settings > Usage Quotas**. -1. Under the **Seats** tab, view usage information. +1. On the **Seats** tab, view usage information. + +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 @@ -149,53 +119,14 @@ To export seat usage data as a CSV file: The generated list contains all seats being used, and is not affected by the current search. -## Subscription expiry +## Seats owed -When your subscription expires, you can continue to use paid features of GitLab for 14 days. -On the 15th day, paid features are no longer available. You can -continue to use free features. +A GitLab subscription is valid for a specific number of users. -To resume paid feature functionality, purchase a new subscription. +If the number of billable users exceeds the number included in the subscription, known +as the number of **seats owed**, you must pay for the excess number of users before renewal. -## Renew your GitLab SaaS subscription - -To renew your subscription: - -1. [Prepare for renewal by reviewing your account.](#prepare-for-renewal-by-reviewing-your-account) -1. [Renew your GitLab SaaS subscription.](#renew-or-change-a-gitlab-saas-subscription) - -### Prepare for renewal by reviewing your account - -The [Customers Portal](https://customers.gitlab.com/customers/sign_in) is your -tool for renewing and modifying your subscription. Before going ahead with renewal, -log in and verify or update: - -- The invoice contact details on the **Account details** page. -- The credit card on file on the **Payment Methods** page. - -NOTE: -Contact our [support team](https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=360000071293) -if you need assistance accessing the Customers Portal or if you need to change -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 could 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. - -#### Seats owed - -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 number of [billable users](#view-your-gitlab-saas-subscription) exceeds the number included in the subscription, known -as the number of _seats owed_, you must pay for the excess number of users before renewal. - -##### Seats owed example - -You purchase a subscription for 10 users. +For example, if you purchase a subscription for 10 users: | Event | Billable members | Maximum users | |:---------------------------------------------------|:-----------------|:--------------| @@ -205,44 +136,7 @@ You purchase a subscription for 10 users. Seats owed = 12 - 10 (Maximum users - users in subscription) -### Renew or change a GitLab SaaS subscription - -Starting 30 days before a subscription expires, GitLab notifies group owners -of the date of expiry with a banner in the GitLab user interface. - -We recommend following these steps during renewal: - -1. Prune any [inactive or unwanted users](#remove-billable-user). -1. Determine if you have a need for user growth in the upcoming subscription. -1. Log in to the [Customers Portal](https://customers.gitlab.com/customers/sign_in) and beneath your existing subscription, select the **Renew** button. -1. Review your renewal details and complete the payment process. -1. Select **Confirm purchase**. - -Your updated subscription is applied to your namespace on the renewal period start date. - -An invoice is generated for the renewal and available for viewing or download on the [View invoices](https://customers.gitlab.com/receipts) page. If you have difficulty during the renewal process, contact our [support team](https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=360000071293) for assistance. - -For details on upgrading your subscription tier, see -[Upgrade your GitLab SaaS subscription tier](#upgrade-your-gitlab-saas-subscription-tier). - -#### Automatic renewal - -To view or change automatic subscription renewal (at the same tier as the -previous period), log in to the [Customers Portal](https://customers.gitlab.com/customers/sign_in), and: - -- If you see a **Resume subscription** button, your subscription was canceled - previously. Click it to resume automatic renewal. -- If you see **Cancel subscription**, your subscription is set to automatically - renew at the end of the subscription period. Click it to cancel automatic renewal. - -With automatic renewal enabled, the subscription automatically renews on the -expiration date without a gap in available service. An invoice is -generated for the renewal and available for viewing or download in the -[View invoices](https://customers.gitlab.com/receipts) page. If you have difficulty -during the renewal process, contact our -[support team](https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=360000071293) for assistance. - -## Add users to your subscription +### Add users to your subscription You can add users to your subscription at any time during the subscription period. The cost of additional users added during the subscription period is prorated from the date of purchase through @@ -264,6 +158,21 @@ The following is emailed to you: - A payment receipt. You can also access this information in the Customers Portal under [**View invoices**](https://customers.gitlab.com/receipts). +### Remove users from your subscription + +To remove a billable user from your subscription: + +1. On the top bar, select **Menu > Groups** and find your group. +1. On the left sidebar, select **Settings > Billing**. +1. In the **Seats currently in use** section, select **See usage**. +1. In the row for the user you want to remove, on the right side, select the ellipsis and **Remove user**. +1. Re-type the username and select **Remove user**. + +If you add a member to a group by using the [share a group with another group](../../user/group/index.md#share-a-group-with-another-group) feature, you can't remove the member by using this method. Instead, you can either: + +- Remove the member from the shared group. You must be a group owner to do this. +- From the group's membership page, remove access from the entire shared group. + ## Upgrade your GitLab SaaS subscription tier To upgrade your [GitLab tier](https://about.gitlab.com/pricing/): @@ -278,26 +187,73 @@ To upgrade your [GitLab tier](https://about.gitlab.com/pricing/): When the purchase has been processed, you receive confirmation of your new subscription tier. -## See your subscription and billable users in GitLab.com +## Subscription expiry -To view information about your subscription and occupied seats: +When your subscription expires, you can continue to use paid features of GitLab for 14 days. +On the 15th day, paid features are no longer available. You can +continue to use free features. -1. Go to your group's **Settings > Billing** page. -1. In the **Seats currently in use** area, select **See usage**. +To resume paid feature functionality, purchase a new subscription. -### Remove billable user +## Renew your GitLab SaaS subscription -To remove a billable user: +To renew your subscription: -1. Go to your group's **Settings > Billing** page. -1. In the **Seats currently in use** area, select **See usage**. -1. In the row for the user you want to remove, on the right side, select the ellipsis and **Remove user**. -1. Re-type the username and select **Remove user**. +1. [Prepare for renewal by reviewing your account.](#prepare-for-renewal-by-reviewing-your-account) +1. [Renew your GitLab SaaS subscription.](#renew-or-change-a-gitlab-saas-subscription) -If you add a member to a group by using the [share a group with another group](../../user/group/index.md#share-a-group-with-another-group) feature, you can't remove the member by using this method. Instead, you can either: +### Prepare for renewal by reviewing your account -- Remove the member from the shared group. You must be a group owner to do this. -- From the group's membership page, remove access from the entire shared group. +Before you renew your subscription: + +1. Log in to the [Customers Portal](https://customers.gitlab.com/customers/sign_in). +1. On the **Account details** page, verify or update the invoice contact details. +1. On the **Payment Methods** page, verify or update the credit card on file. +1. In GitLab, review your list of user accounts and [remove inactive or unwanted users](#remove-users-from-your-subscription). + +### Renew or change a GitLab SaaS subscription + +Starting 30 days before a subscription expires, GitLab notifies group owners +of the date of expiry with a banner in the GitLab user interface. + +To renew your subscription: + +1. Log in to the [Customers Portal](https://customers.gitlab.com/customers/sign_in) and beneath your existing subscription, select **Renew**. +1. Review your renewal details and complete the payment process. +1. Select **Confirm purchase**. + +Your updated subscription is applied to your namespace on the renewal period start date. + +An invoice is generated for the renewal and available for viewing or download on the [View invoices](https://customers.gitlab.com/receipts) page. +If you have difficulty during the renewal process, contact the [Support team](https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=360000071293) for assistance. + +For details on upgrading your subscription tier, see +[Upgrade your GitLab SaaS subscription tier](#upgrade-your-gitlab-saas-subscription-tier). + +### Automatic renewal + +When you enable automatic renewal, the subscription automatically renews on the +expiration date without a gap in available service. An invoice is +generated for the renewal and available for viewing or download on the +[View invoices](https://customers.gitlab.com/receipts) page. + +#### Enable automatic renewal + +To view or change automatic subscription renewal (at the same tier as the +previous period), log in to the [Customers Portal](https://customers.gitlab.com/customers/sign_in), and: + +- If a **Resume subscription** button is displayed, your subscription was canceled + previously. Click it to resume automatic renewal. +- If a **Cancel subscription** button is displayed, your subscription is set to automatically + renew at the end of the subscription period. Click it to cancel automatic renewal. + +If you have difficulty during the renewal process, contact the +[Support team](https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=360000071293) for assistance. + +## Change the contact person for your subscription + +To change the contact person who manages your subscription, +contact the GitLab [Support team](https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=360000071293). ## CI pipeline minutes @@ -389,7 +345,8 @@ Be aware that: be charged for less than one year because your subscription was previously created with the extra CI minutes. - After the extra CI minutes have been assigned to a Group, they can't be transferred - to a different Group. + to a different Group by themselves, but they will transfer along with a subscription when + changing the linked namespace for the subscription. - If you have used more minutes than your default quota, these minutes will be deducted from your Additional Minutes quota immediately after your purchase of additional minutes. @@ -426,11 +383,6 @@ To purchase more storage for either a personal or group namespace: The **Purchased storage available** total is incremented by the amount purchased. All locked projects are unlocked and their excess usage is deducted from the additional storage. -## Customers Portal - -The GitLab [Customers Portal](../index.md#customers-portal) enables you to manage your subscriptions -and account details. - ## Contact Support Learn more about: @@ -438,7 +390,7 @@ Learn more about: - The tiers of [GitLab Support](https://about.gitlab.com/support/). - [Submit a request via the Support Portal](https://support.gitlab.com/hc/en-us/requests/new). -We also encourage all users to search our project trackers for known issues and +We also encourage you to search our project trackers for known issues and existing feature requests in the [GitLab](https://gitlab.com/gitlab-org/gitlab/-/issues/) project. These issues are the best avenue for getting updates on specific product plans diff --git a/doc/subscriptions/quarterly_reconciliation.md b/doc/subscriptions/quarterly_reconciliation.md index f9cca079e76..cdac50748d0 100644 --- a/doc/subscriptions/quarterly_reconciliation.md +++ b/doc/subscriptions/quarterly_reconciliation.md @@ -4,22 +4,24 @@ 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 --- -# The quarterly subscription reconciliation process +# Quarterly reconciliation and annual true-ups **(PREMIUM)** -GitLab reviews your seat usage every quarter and sends you an invoice for -any overages. +GitLab reviews your seat usage and sends you an invoice for any overages. +This review can occur: -Annual reviews, also known as the [annual true-up process](self_managed/index.md#users-over-license), -require you to pay the full annual subscription fee for users added anytime during the year. With quarterly -reviews, you only pay for the remaining period of your subscription term. +- **Annually**, also known as the annual true-up process. This process requires you to pay the full annual subscription fee + for users added anytime during the year. +- **Quarterly**. With this process, you only pay for the remaining period of your subscription term. -For example, if you add users in the third quarter of your subscription term, you only -pay 25% of what you would have paid previously. This results in substantial savings. +## Quarterly reconciliation process + +With the quarterly reconciliation process, if you add users in the third quarter of your subscription term, for example, +you only pay 25% of what you would have paid previously. This calculation results in substantial savings. If it's not possible for you to participate in quarterly reconciliations, you can opt out of the process by using a contract amendment. In that case, you default to the annual review. -## Timeline for invoicing and payment +## Timeline for quarterly invoicing and payment At the end of each subscription quarter, GitLab notifies you about overages. The date you're notified about the overage is not the same as the date @@ -28,7 +30,7 @@ you are billed. ### GitLab SaaS Group owners receive an email **on the reconciliation date**. -The email communicates the [overage seat quantity](gitlab_com/index.md#seats-owed-example) +The email communicates the [overage seat quantity](gitlab_com/index.md#seats-owed) and expected invoice amount. **Seven days later**, the subscription is updated to include the additional diff --git a/doc/subscriptions/self_managed/index.md b/doc/subscriptions/self_managed/index.md index 72bd1c2b4f7..acdbdefc671 100644 --- a/doc/subscriptions/self_managed/index.md +++ b/doc/subscriptions/self_managed/index.md @@ -25,8 +25,8 @@ changes to their subscription. The cost of a GitLab self-managed subscription is determined by the following: -- GitLab tier -- Subscription seats +- [GitLab tier](https://about.gitlab.com/pricing/) +- [Subscription seats](#subscription-seats) ## Choose a GitLab tier @@ -108,6 +108,7 @@ 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 `block_auto_created_users` for new sign-ups via [LDAP](../../administration/auth/ldap/index.md#basic-configuration-settings) or [OmniAuth](../../integration/omniauth.md#initial-omniauth-configuration). - Enable the [User cap](../../user/admin_area/settings/sign_up_restrictions.md#user-cap) option. **Available in GitLab 13.7 and later**. - [Disable new sign-ups](../../user/admin_area/settings/sign_up_restrictions.md), and instead manage new |