diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-20 18:09:36 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-20 18:09:36 +0300 |
commit | a5d7e614fe1d038a7f9e2af76106773b98e2b5e8 (patch) | |
tree | 4f8f59ace31f8e84a60f9512755a1efe0287a157 /doc | |
parent | d00cd98a2b1b3f0899677f61257821c94cde8e31 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/architecture/blueprints/ci_pipeline_components/index.md | 3 | ||||
-rw-r--r-- | doc/development/internal_users.md | 1 | ||||
-rw-r--r-- | doc/user/admin_area/settings/account_and_limit_settings.md | 16 | ||||
-rw-r--r-- | doc/user/enterprise_user/index.md | 44 | ||||
-rw-r--r-- | doc/user/group/manage.md | 2 | ||||
-rw-r--r-- | doc/user/project/members/share_project_with_groups.md | 1 | ||||
-rw-r--r-- | doc/user/project/repository/code_suggestions.md | 160 |
7 files changed, 179 insertions, 48 deletions
diff --git a/doc/architecture/blueprints/ci_pipeline_components/index.md b/doc/architecture/blueprints/ci_pipeline_components/index.md index 667c8d225db..88c24e01a6c 100644 --- a/doc/architecture/blueprints/ci_pipeline_components/index.md +++ b/doc/architecture/blueprints/ci_pipeline_components/index.md @@ -12,6 +12,9 @@ participating-stages: [] # CI/CD Catalog +NOTE: +This document covers the future plans for the CI/CD Catalog feature. For information on the features already available for use in GitLab, see the [CI/CD Components documentation](../../../ci/components/index.md). + ## Summary ## Goals diff --git a/doc/development/internal_users.md b/doc/development/internal_users.md index ce13324507d..d9f40d6f5d4 100644 --- a/doc/development/internal_users.md +++ b/doc/development/internal_users.md @@ -40,6 +40,7 @@ For this bot: Other examples of internal users: +- [GitLab Admin Bot](https://gitlab.com/gitlab-org/gitlab/-/blob/278bc9018dd1515a10cbf15b6c6cd55cb5431407/app/models/user.rb#L950-960) - [Alert Bot](../operations/incident_management/alerts.md#trigger-actions-from-alerts) - [Ghost User](../user/profile/account/delete_account.md#associated-records) - [Support Bot](../user/project/service_desk.md#support-bot-user) diff --git a/doc/user/admin_area/settings/account_and_limit_settings.md b/doc/user/admin_area/settings/account_and_limit_settings.md index 293decc438e..ae0dc184bc7 100644 --- a/doc/user/admin_area/settings/account_and_limit_settings.md +++ b/doc/user/admin_area/settings/account_and_limit_settings.md @@ -18,7 +18,7 @@ To configure the maximum number of projects in personal namespaces for new users 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). 1. Select **Admin Area**. -1. Select **Settings > Network**. +1. Select **Settings > General**. 1. Expand **Account and limit**. 1. Increase or decrease that **Default projects limit** value. @@ -46,7 +46,7 @@ To change the maximum attachment size: 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). 1. Select **Admin Area**. -1. Select **Settings > Network**. +1. Select **Settings > General**. 1. Expand **Account and limit**. 1. Increase or decrease by changing the value in **Maximum attachment size (MB)**. @@ -62,7 +62,7 @@ You can change the maximum push size for your instance: 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). 1. Select **Admin Area**. -1. Select **Settings > Network**. +1. Select **Settings > General**. 1. Expand **Account and limit**. 1. Increase or decrease by changing the value in **Maximum push size (MB)**. @@ -94,7 +94,7 @@ To modify the maximum file size for imports in GitLab: 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). 1. Select **Admin Area**. -1. Select **Settings > Network**. +1. Select **Settings > General**. 1. Expand **Account and limit**. 1. Increase or decrease by changing the value in **Maximum import size (MB)**. @@ -317,7 +317,7 @@ To do this: 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). 1. Select **Admin Area**. -1. Select **Settings > Network**. +1. Select **Settings > General**. 1. Expand **Account and limit**. 1. Select the **Prevent users from changing their profile name** checkbox. @@ -339,7 +339,7 @@ By default, new users can create top-level groups. GitLab administrators can pre 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). 1. Select **Admin Area**. -1. Select **Settings > Network**. +1. Select **Settings > General**. 1. Expand **Account and limit**. 1. Clear the **Allow new users to create top-level groups** checkbox. @@ -351,7 +351,7 @@ By default, newly created users have a public profile. GitLab administrators can 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). 1. Select **Admin Area**. -1. Select **Settings > Network**. +1. Select **Settings > General**. 1. Expand **Account and limit**. 1. Select the **Make new users' profiles private by default** checkbox. @@ -364,7 +364,7 @@ users from deleting their own accounts: 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). 1. Select **Admin Area**. -1. Select **Settings > Network**. +1. Select **Settings > General**. 1. Expand **Account and limit**. 1. Clear the **Allows users to delete their own accounts** checkbox. diff --git a/doc/user/enterprise_user/index.md b/doc/user/enterprise_user/index.md index 36f698daf81..ea320402dd7 100644 --- a/doc/user/enterprise_user/index.md +++ b/doc/user/enterprise_user/index.md @@ -47,17 +47,29 @@ Prerequisites: - A project in the group. - You must have the Owner role in the top-level group. -Setting up a verified domain is similar to [setting up a custom domain on GitLab Pages](../project/pages/custom_domains_ssl_tls_certification/index.md). However, you must: +Domain verification applies at the top-level group and to all subgroups and projects +nested under that top-level parent group. -- Link the domain to a single project. -- Configure the `TXT` only in the DNS record to verify the domain's ownership. +Setting up a verified domain is similar to [setting up a custom domain on GitLab Pages](../project/pages/custom_domains_ssl_tls_certification/index.md). However, you: -Domain verification is tied to the project you choose. A project is required because domain verification reuses the GitLab Pages verification feature, which requires a project. Domain verification applies at the top-level group and to all subgroups and projects nested under that top-level parent group. -A member in the chosen project with [at least the Maintainer role](../permissions.md#project-members-permissions) can modify or remove the domain verification. -If needed, you can create a new project to set up domain verification directly under your top-level group. This limits the ability to modify the domain verification to members with at least the Maintainer role. -For more information on group-level domain verification, see [epic 5299](https://gitlab.com/groups/gitlab-org/-/epics/5299). +- Do not need to have a GitLab Pages website. +- Must link the domain to a single project, despite domain verification applying + at the top-level group and to all nested subgroups and projects, because domain + verification: + - Is tied to the project you choose. + - Reuses the GitLab Pages custom domain verification feature, which requires a project. +- Must configure the `TXT` only in the DNS record to verify the domain's ownership. + +In addition to appearing in the top-level group Domain Verification list, the +domain will also appear in the chosen project. A member in this project with +[at least the Maintainer role](../permissions.md#project-members-permissions) +can modify or remove the domain verification. -Steps: +If needed, you can create a new project to set up domain verification directly +under your top-level group. This limits the ability to modify the domain verification +to members with at least the Maintainer role. + +For more information on group-level domain verification, see [epic 5299](https://gitlab.com/groups/gitlab-org/-/epics/5299). #### 1. Add a custom domain for the matching email domain @@ -96,21 +108,13 @@ After you have added all the DNS records: ![Verify your domain](../img/retry_domain_verification_v16_0.png) WARNING: -For GitLab instances with domain verification enabled, -if the domain cannot be verified for 7 days, that domain is removed -from the GitLab project. +For GitLab instances with domain verification enabled, if the domain cannot be verified for 7 days, that domain is removed from the GitLab project. > **Notes:** > -> - Domain verification is **required for GitLab.com users**; - for GitLab self-managed instances, your GitLab administrator has the option - to [disabled custom domain verification](../../administration/pages/index.md#custom-domain-verification). -> - [DNS propagation may take some time (up to 24 hours)](https://www.inmotionhosting.com/support/domain-names/dns-nameserver-changes/complete-guide-to-dns-records/), - although it's usually a matter of minutes to complete. Until it does, verification - fails, and attempts to visit your domain result in a 404. -> - Once your domain has been verified, leave the verification record - in place. Your domain is periodically reverified, and may be - disabled if the record is removed. +> - Domain verification is **required for GitLab.com users** to be marked as enterprise users. +> - [DNS propagation can take up to 24 hours](https://www.inmotionhosting.com/support/domain-names/dns-nameserver-changes/complete-guide-to-dns-records/), although it's usually a couple of minutes to complete. Until it completes, the domain shows as unverified. +> - Once your domain has been verified, leave the verification record in place. Your domain is periodically reverified, and may be disabled if the record is removed. > - A valid certificate is not required for domain verification. ### View domains in group diff --git a/doc/user/group/manage.md b/doc/user/group/manage.md index 284fb8b3d7c..1de2f075592 100644 --- a/doc/user/group/manage.md +++ b/doc/user/group/manage.md @@ -131,7 +131,7 @@ After sharing the `Frontend` group with the `Engineering` group: - The **Groups** tab lists the `Engineering` group. - The **Groups** tab lists a group regardless of whether it is a public or private group. - All direct members of the `Engineering` group have access to the `Frontend` group. Direct members of `Engineering` that gain access to the `Frontend` group keep their same access level as in `Engineering`, but up to the maximum access level selected when sharing the group. Inherited members of the `Engineering` group do not gain access to the `Frontend` group. -- All direct members of the `Engineering` group count towards the billable members of the `Frontend` group. +- Direct members of the `Engineering` group who have the **Group Invite** badge next to their profile on the group's usage quota page count towards the billable members of the `Frontend` group. ## Remove a shared group diff --git a/doc/user/project/members/share_project_with_groups.md b/doc/user/project/members/share_project_with_groups.md index aadc27fb2d3..15c5935648f 100644 --- a/doc/user/project/members/share_project_with_groups.md +++ b/doc/user/project/members/share_project_with_groups.md @@ -76,6 +76,7 @@ In addition: - On the group's page, the project is listed on the **Shared projects** tab. - On the project's **Members** page, the group is listed on the **Groups** tab. - Each user is assigned a maximum role. +- Members who have the **Project Invite** badge next to their profile on the usage quota page count towards the billable members of the shared project's top-level group. ## Maximum role diff --git a/doc/user/project/repository/code_suggestions.md b/doc/user/project/repository/code_suggestions.md index dd1fa3f4c8b..33ef10c9c3d 100644 --- a/doc/user/project/repository/code_suggestions.md +++ b/doc/user/project/repository/code_suggestions.md @@ -5,17 +5,18 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: index, reference --- -# Code Suggestions (Beta) **(FREE SAAS)** +# Code Suggestions (Beta) **(FREE)** -> - [Introduced](https://about.gitlab.com/releases/2023/02/22/gitlab-15-9-released/#code-suggestions-available-in-closed-beta) in GitLab 15.9 as [Beta](/ee/policy/experiment-beta-support.md#beta) for early access Ultimate customers. -> - [Enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/408104) as opt-in with GitLab 15.11 as [Beta](/ee/policy/experiment-beta-support.md#beta). +> - [Introduced](https://about.gitlab.com/releases/2023/02/22/gitlab-15-9-released/#code-suggestions-available-in-closed-beta) in GitLab 15.9 as [Beta](../../../policy/experiment-beta-support.md#beta) for early access Ultimate customers on GitLab.com. +> - [Enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/408104) as opt-in with GitLab 15.11 as [Beta](../../../policy/experiment-beta-support.md#beta). > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/408158) from GitLab Ultimate to GitLab Premium in 16.0. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/410801) from GitLab Premium to GitLab Free in 16.0. > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121079) in GitLab 16.1. > - [Default to third-party AI services](https://gitlab.com/groups/gitlab-org/-/epics/10562) in GitLab 16.1. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10653) in GitLab 16.1 as [Beta](../../../policy/experiment-beta-support.md#beta) on self-managed GitLab. WARNING: -This feature is in [Beta](/ee/policy/experiment-beta-support.md#beta). +This feature is in [Beta](../../../policy/experiment-beta-support.md#beta). Due to high demand, this feature may have unscheduled downtime and Code Suggestions in IDEs may be delayed. Code Suggestions may produce [low-quality or incomplete suggestions](#model-accuracy-and-quality). Beta users should read about the [known limitations](#known-limitations). We look forward to hearing your feedback. @@ -50,9 +51,15 @@ We are making improvements to the Code Suggestions underlying AI model weekly to Usage of Code Suggestions is governed by the [GitLab Testing Agreement](https://about.gitlab.com/handbook/legal/testing-agreement/). Learn about [data usage when using Code Suggestions](#code-suggestions-data-usage). -## Enable Code Suggestions for an individual user +Code Suggestions are available on both GitLab SaaS and self-managed GitLab. -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121079) in GitLab 16.1 as [Beta](/ee/policy/experiment-beta-support.md#beta). +## Enable Code Suggestions on GitLab SaaS **(FREE SAAS)** + +There are different scenarios in which you can enable code suggestions. + +### Enable Code Suggestions for an individual user + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121079) in GitLab 16.1 as [Beta](../../../policy/experiment-beta-support.md#beta). Each user can enable Code Suggestions for themselves: @@ -64,7 +71,7 @@ Each user can enable Code Suggestions for themselves: NOTE: If Code Suggestions is [enabled for the group](../../group/manage.md#enable-code-suggestions), the group setting overrides the user setting. -## Enable Code Suggestions in WebIDE +### Enable Code Suggestions in WebIDE Prerequisites: @@ -72,12 +79,14 @@ Prerequisites: - Code Suggestions must be [enabled for your user account](#enable-code-suggestions-for-an-individual-user). - You must be a GitLab team member. -Code Suggestions work automatically in the [GitLab WebIDE](../../project/web_ide/index.md) if the above prerequisites are met. To disable Code Suggestions in the WebIDE, disable the user account setting. +Code Suggestions work automatically in the GitLab WebIDE if the prerequisites are met. + +To disable Code Suggestions in the WebIDE, disable the user account setting. NOTE: Disabling in the WebIDE will also disable in any other IDEs you use locally like VS Code. Support for [more granular control per IDE](https://gitlab.com/groups/gitlab-org/-/epics/10624) is proposed. -## Enable Code Suggestions in VS Code +### Enable Code Suggestions in VS Code Prerequisites: @@ -85,15 +94,115 @@ Prerequisites: - Code Suggestions must be [enabled for your user account](#enable-code-suggestions-for-an-individual-user). - Completed the [setup instructions](https://gitlab.com/gitlab-org/gitlab-vscode-extension#setup) for the GitLab Visual Studio Code Extension. -To enable Code Suggestions in VS Code: +Start typing in VS Code and you receive suggestions for your GitLab projects. + +<div class="video-fallback"> + See an end-to-end demo: <a href="https://www.youtube.com/watch?v=WnxBYxN2-p4">Get started with GitLab Code Suggestions in VS Code</a>. +</div> +<figure class="video-container"> + <iframe src="https://www.youtube-nocookie.com/embed/WnxBYxN2-p4" frameborder="0" allowfullscreen> </iframe> +</figure> + +## Enable Code Suggestions on self-managed GitLab **(FREE SELF)** + +> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10653) in GitLab 16.1 as [Beta](../../../policy/experiment-beta-support.md#beta). + +To enable Code Suggestions on a self-managed GitLab instance: + +- The instance administrator enables Code Suggestions for the instance. +- The user enables Code Suggestions in Visual Studio (VS) Code. -1. Download and install the - [GitLab Workflow extension](https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow) - for Visual Studio Code. -1. Complete the [setup instructions](https://gitlab.com/gitlab-org/gitlab-vscode-extension#setup) for the extension. -1. After your GitLab account connects successfully, in the left sidebar, select **Extensions**. -1. Find the **GitLab workflow** extension, select **Settings** (**{settings}**), and select **Extension Settings**. -1. Enable **GitLab > AI Assisted Code Suggestions**. +### Enable Code Suggestions for the instance + +Prerequisites: + +You must: + +- Be an administrator for your self-managed instance. +- Have a [GitLab SaaS account](https://gitlab.com/users/sign_up). + You do not need to have a GitLab SaaS subscription. + +You, as an administrator, must: + +1. Enable Code Suggestions: + - In your SaaS account. + - At the self-managed instance level. +1. Request early access to the Code Suggestions Beta for self-managed instances. + +#### Enable Code Suggestions in your GitLab SaaS account + +In your GitLab SaaS account: + +1. Create a [personal access token](../../profile/personal_access_tokens.md#create-a-personal-access-token) + with the `api` scope. +1. On the left sidebar, select your avatar. +1. Select **Preferences**. +1. In the **Code Suggestions** section, select **Enable Code Suggestions**. +1. Select **Save changes**. + +#### Enable Code Suggestions in your self-managed GitLab instance + +In your self-managed GitLab instance: + +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. On the left sidebar, select **Settings > General**. +1. Expand **Code Suggestions** and: + - Select **Turn on Code Suggestions for this instance**. + - In **Personal access token**, enter your GitLab SaaS personal access token. +1. Select **Save changes**. + +This setting is only visible in self-managed GitLab instances. + +By turning on this feature, you: + +- Agree to the [GitLab testing agreement](https://about.gitlab.com/handbook/legal/testing-agreement/). +- Acknowledge that GitLab: + - Sends data from the instance, including personal data, to Google for cloud hosting. + - Might send data to third-party AI providers. + +WARNING: +If you clear the **Turn on code suggestions for this instance** checkbox, the users in your instance can still use Code Suggestions for up to one hour, until the issued JSON web token (JWT) expires. + +#### Request access to Code Suggestions + +GitLab provisions access on a customer-by-customer basis for Code Suggestions +on self-managed instances. To request access: + +1. Sign into your GitLab SaaS account. +1. Comment on [issue 415393](https://gitlab.com/gitlab-org/gitlab/-/issues/415393) + and tag your customer success manager. + +After GitLab has provisioned access to Code Suggestions for your instance, +the users in your instance can now enable Code Suggestions in VS Code. + +### Enable Code Suggestions in WebIDE + +Prerequisites: + +- Code Suggestions must be [enabled for the top-level group](../../group/manage.md#enable-code-suggestions). +- Code Suggestions must be [enabled for your user account](#enable-code-suggestions-for-an-individual-user). +- You are a GitLab team member. + +You should check that AI assisted code suggestions in the +[GitLab WebIDE](../../project/web_ide/index.md) are enabled: + +1. In the left sidebar, select **Extensions > GitLab Workflow**. +1. Select **Settings** (**{settings}**), and then select **Extension Settings**. +1. In **GitLab > AI Assisted Code Suggestions**, select the **Enable code completion (Beta)** + checkbox. + +### Enable Code Suggestions in VS Code + +Prerequisites: + +- You are a user in a self-managed instance. +- Your instance administrator has enabled Code Suggestions for the instance. + +To use Code Suggestions in your self-managed instance, +[enable it in VS Code](#enable-code-suggestions-in-vs-code). + +To start using Code Suggestions with your GitLab project, open your GitLab project in VS Code. Start typing and receive suggestions for your GitLab projects. @@ -130,7 +239,7 @@ To confirm that your account is enabled, go to [https://gitlab.com/api/v4/ml/ai- If the above steps do not solve your issue, the problem may be related to the recent changes in authentication, specifically the token system. To resolve the issue, please follow these troubleshooting steps: - Remove the existing PAT from your GitLab account settings. -- Reauthorize your GitLab account in VSCode using OAuth. +- Reauthorize your GitLab account in VS Code using OAuth. - Test the code suggestions feature with different file extensions to verify if the issue is resolved. ## Third-party AI services controls @@ -143,7 +252,7 @@ To use Code Suggestions entirely within GitLab’s cloud infrastructure, disable ## Stability and performance -This feature is currently in [Beta](/ee/policy/experiment-beta-support.md#beta). +This feature is currently in [Beta](../../../policy/experiment-beta-support.md#beta). While the Code Suggestions inference API operates completely within the GitLab.com enterprise infrastructure, we expect a high demand for this Beta feature, which may cause degraded performance or unexpected downtime of the feature. We have built this feature to gracefully degrade and have controls in place to allow us to @@ -173,6 +282,19 @@ Your data also never leaves GitLab.com. All training and inference is done in Gi [Read more about the security of GitLab.com](https://about.gitlab.com/security/faq/). +### Self-managed instance data privacy + +A self-managed GitLab instance does not generate the code suggestion. After successful +authentication to the self-managed instance, a token is generated. + +The VS Code plugin then uses this token to securely transmit data directly to +GitLab.com's Code Suggestions service for processing. + +The Code Suggestion service then securely returns an AI-generated code suggestion. + +GitLab does not have any visibility into a self-managed customer's code other than +what is sent to generate the code suggestion. + ### Training data This section applies only to customers who have third-party AI services disabled. |