diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-15 12:07:57 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-15 12:07:57 +0300 |
| commit | 5a14a0fe63ac7dace9821be554ad3b3951529708 (patch) | |
| tree | 44804ea0e8e62f858c82566301acc0111452103f /doc/user | |
| parent | b4610c51192adc832d25192038a781d2aa1ebb98 (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
56 files changed, 588 insertions, 441 deletions
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 af9c88e9044..293decc438e 100644 --- a/doc/user/admin_area/settings/account_and_limit_settings.md +++ b/doc/user/admin_area/settings/account_and_limit_settings.md @@ -16,8 +16,10 @@ the [project limits for existing users](#projects-limit-for-a-user). To configure the maximum number of projects in personal namespaces for new users: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, then expand **Account and limit**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **Account and limit**. 1. Increase or decrease that **Default projects limit** value. If you set **Default projects limit** to 0, users are not allowed to create projects @@ -28,8 +30,9 @@ in their users personal namespace. However, projects can still be created in a g You can edit a specific user, and change the maximum number of projects this user can create in their personal namespace: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview** > **Users**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Overview** > **Users**. 1. From the list of users, select a user. 1. Select **Edit**. 1. Increase or decrease the **Projects limit** value. @@ -41,8 +44,10 @@ can create in their personal namespace: The maximum file size for attachments in GitLab comments and replies is 100 MB. To change the maximum attachment size: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, then expand **Account and limit**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **Account and limit**. 1. Increase or decrease by changing the value in **Maximum attachment size (MB)**. If you choose a size larger than the configured value for the web server, @@ -55,8 +60,10 @@ For GitLab.com repository size limits, read [accounts and limit settings](../../ You can change the maximum push size for your instance: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, then expand **Account and limit**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **Account and limit**. 1. Increase or decrease by changing the value in **Maximum push size (MB)**. For GitLab.com push size limits, read [accounts and limit settings](../../gitlab_com/index.md#account-and-limit-settings). @@ -74,8 +81,9 @@ Use [Git LFS](../../../topics/git/lfs/index.md) to add large files to a reposito To modify the maximum file size for exports in GitLab: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, then expand **Account and limit**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**, then expand **Account and limit**. 1. Increase or decrease by changing the value in **Maximum export size (MB)**. ## Max import size @@ -84,8 +92,10 @@ To modify the maximum file size for exports in GitLab: To modify the maximum file size for imports in GitLab: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, then expand **Account and limit**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **Account and limit**. 1. Increase or decrease by changing the value in **Maximum import size (MB)**. This setting applies only to repositories @@ -114,8 +124,9 @@ The default prefix is `glpat-` but administrators can change it. To change the default global prefix: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Account and limit** section. 1. Fill in the **Personal Access Token prefix** field. 1. Select **Save changes**. @@ -160,8 +171,9 @@ These settings can be found in: 1. Fill in the **Repository size limit (MB)** field in the **Naming, visibility** section. 1. Select **Save changes**. - GitLab global settings: - 1. On the top bar, select **Main menu > Admin**. - 1. On the left sidebar, select **Settings > General**. + 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). + 1. Select **Admin Area**. + 1. Select **Settings > General**. 1. Expand the **Account and limit** section. 1. Fill in the **Size limit per repository (MB)** field. 1. Select **Save changes**. @@ -182,8 +194,9 @@ For details on manually purging files, see [reducing the repository size using G You can change how long users can remain signed in without activity. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand **Account and limit**. The set duration is in **Session duration (minutes)**. If [Remember me](#turn-remember-me-on-or-off) is enabled, users' sessions can remain active for an indefinite period of time. @@ -196,8 +209,9 @@ For details, see [cookies used for sign-in](../../profile/index.md#cookies-used- Users can select the **Remember me** checkbox on sign-in, and their session will remain active for an indefinite period of time when accessed from that specific browser. You can turn off this setting if you need sessions to expire for security or compliance purposes. Turning off this setting will ensure users' sessions expire after the number of minutes of inactivity set when you [customize your session duration](#customize-the-default-session-duration). -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand **Account and limit**. 1. Select or clear the **Remember me** checkbox to turn this setting on or off. @@ -213,8 +227,9 @@ GitLab administrators can choose to customize the session duration (in minutes) To set a limit on how long these sessions are valid: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Account and limit** section. 1. Fill in the **Session duration for Git operations when 2FA is enabled (minutes)** field. 1. Select **Save changes**. @@ -240,8 +255,9 @@ there are no restrictions. To set a lifetime on how long SSH keys are valid: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Account and limit** section. 1. Fill in the **Maximum allowable lifetime for SSH keys (days)** field. 1. Select **Save changes**. @@ -276,8 +292,9 @@ there are no restrictions. To set a lifetime on how long access tokens are valid: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Account and limit** section. 1. Fill in the **Maximum allowable lifetime for access tokens (days)** field. 1. Select **Save changes**. @@ -298,8 +315,10 @@ To maintain integrity of user details in [Audit Events](../../../administration/ To do this: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, then expand **Account and limit**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **Account and limit**. 1. Select the **Prevent users from changing their profile name** checkbox. NOTE: @@ -318,8 +337,10 @@ By default, new users can create top-level groups. GitLab administrators can pre - The [application setting API](../../../api/settings.md#change-application-settings). - In GitLab 15.4 and earlier, a [configuration file](../../../administration/user_settings.md#use-configuration-files-to-prevent-new-users-from-creating-top-level-groups). -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, then expand **Account and limit**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **Account and limit**. 1. Clear the **Allow new users to create top-level groups** checkbox. ## Set profiles of new users to private by default @@ -328,8 +349,10 @@ By default, new users can create top-level groups. GitLab administrators can pre By default, newly created users have a public profile. GitLab administrators can set new users to have a private profile by default: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, then expand **Account and limit**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **Account and limit**. 1. Select the **Make new users' profiles private by default** checkbox. ## Prevent users from deleting their accounts **(PREMIUM SELF)** @@ -339,8 +362,10 @@ By default, newly created users have a public profile. GitLab administrators can By default, users can delete their own accounts. GitLab administrators can prevent users from deleting their own accounts: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, then expand **Account and limit**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **Account and limit**. 1. Clear the **Allows users to delete their own accounts** checkbox. ## Troubleshooting diff --git a/doc/user/admin_area/settings/continuous_integration.md b/doc/user/admin_area/settings/continuous_integration.md index 2aec441dc76..853a299cdec 100644 --- a/doc/user/admin_area/settings/continuous_integration.md +++ b/doc/user/admin_area/settings/continuous_integration.md @@ -15,8 +15,9 @@ job artifacts. To enable (or disable) [Auto DevOps](../../../topics/autodevops/index.md) for all projects: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Check (or uncheck to disable) the box that says **Default to Auto DevOps pipeline for all projects**. 1. Optionally, set up the [Auto DevOps base domain](../../../topics/autodevops/requirements.md#auto-devops-base-domain) which is used for Auto Deploy and Auto Review Apps. @@ -32,8 +33,9 @@ If you want to disable it for a specific project, you can do so in You can set all new projects to have the instance's shared runners available by default. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Expand **Continuous Integration and Deployment**. 1. Select the **Enable shared runners for new projects** checkbox. @@ -51,7 +53,8 @@ you can assign that runner to other projects. To enable a project runner for more than one project: -1. On the top bar, select **Main menu > Admin**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. 1. From the left sidebar, select **CI/CD > Runners**. 1. Select the runner you want to edit. 1. In the upper-right corner, select **Edit** (**{pencil}**). @@ -64,8 +67,9 @@ To enable a project runner for more than one project: To display details about the instance's shared runners in all projects' runner settings: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Expand **Continuous Integration and Deployment**. 1. Enter text, including Markdown if you want, in the **Shared runner details** field. For example: @@ -73,10 +77,8 @@ runner settings: To view the rendered details: -1. On the top bar, select **Main menu**, and: - - For a project, select **Projects** and find your project. - - For a group, select **Groups** and find your group. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project or group. +1. Select **Settings > CI/CD**. 1. Expand **Runners**.  @@ -95,7 +97,8 @@ The value is in MB and the default is 100 MB per job. To change it at the: - Instance level: - 1. On the top bar, select **Main menu > Admin**. + 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). + 1. Select **Admin Area**. 1. On the left sidebar, select **Settings > CI/CD > Continuous Integration and Deployment**. 1. Change the value of **Maximum artifacts size (MB)**. 1. Select **Save changes** for the changes to take effect. @@ -122,8 +125,9 @@ can be set in the Admin Area of your GitLab instance. The syntax of duration is described in [`artifacts:expire_in`](../../../ci/yaml/index.md#artifactsexpire_in) and the default value is `30 days`. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Change the value of default expiration time. 1. Select **Save changes** for the changes to take effect. @@ -153,8 +157,9 @@ If disabled at the instance level, you cannot enable this per-project. To disable the setting: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Expand **Continuous Integration and Deployment**. 1. Clear the **Keep the latest artifacts for all jobs in the latest successful pipelines** checkbox. 1. Select **Save changes** @@ -173,8 +178,9 @@ but persisting the traces and artifacts for auditing purposes. To set the duration for which the jobs are considered as old and expired: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Expand the **Continuous Integration and Deployment** section. 1. Set the value of **Archive jobs**. 1. Select **Save changes** for the changes to take effect. @@ -190,8 +196,9 @@ For the value set for GitLab.com, see [Scheduled job archiving](../../gitlab_com To set all new [CI/CD variables](../../../ci/variables/index.md) as [protected](../../../ci/variables/index.md#protect-a-cicd-variable) by default: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Select **Protect CI/CD variables by default**. ## Maximum includes @@ -201,8 +208,9 @@ To set all new [CI/CD variables](../../../ci/variables/index.md) as The maximum number of [includes](../../../ci/yaml/includes.md) per pipeline can be set at the instance level. The default is `150`. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Change the value of **Maximum includes**. 1. Select **Save changes** for the changes to take effect. @@ -213,8 +221,9 @@ The default is `150`. The default CI/CD configuration file and path for new projects can be set in the Admin Area of your GitLab instance (`.gitlab-ci.yml` if not set): -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Input the new file and path in the **Default CI/CD configuration file** field. 1. Select **Save changes** for the changes to take effect. @@ -227,8 +236,9 @@ It is also possible to specify a [custom CI/CD configuration file for a specific You can configure some [CI/CD limits](../../../administration/instance_limits.md#cicd-limits) from the Admin Area: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Expand the **Continuous Integration and Deployment** section. 1. In the **CI/CD limits** section, you can set the following limits: - **Maximum number of jobs in a single pipeline** @@ -250,8 +260,9 @@ walkthrough on how to add one. To enable or disable the banner: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Select or clear the **Enable pipeline suggestion banner** checkbox. 1. Select **Save changes**. @@ -286,8 +297,9 @@ in the pipeline editor. To select a CI/CD template for the required pipeline configuration: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Expand the **Required pipeline configuration** section. 1. Select a CI/CD template from the dropdown list. 1. Select **Save changes**. @@ -300,8 +312,9 @@ GitLab administrators can disable the forwarding of Maven requests to [Maven Cen To disable forwarding Maven requests: -1. On the top bar, select **Menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Expand the **Package Registry** section. 1. Clear the checkbox **Forward Maven package requests to the Maven Registry if the packages are not found in the GitLab Package Registry**. 1. Select **Save changes**. @@ -312,8 +325,9 @@ GitLab administrators can disable the forwarding of npm requests to [npmjs.com]( To disable it: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Expand the **Package Registry** section. 1. Clear the checkbox **Forward npm package requests to the npm Registry if the packages are not found in the GitLab Package Registry**. 1. Select **Save changes**. @@ -324,8 +338,9 @@ GitLab administrators can disable the forwarding of PyPI requests to [pypi.org]( To disable it: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Expand the **Package Registry** section. 1. Clear the checkbox **Forward PyPI package requests to the PyPI Registry if the packages are not found in the GitLab Package Registry**. 1. Select **Save changes**. @@ -336,8 +351,9 @@ GitLab administrators can adjust the maximum allowed file size for each package To set the maximum file size: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Expand the **Package Registry** section. 1. Find the package type you would like to adjust. 1. Enter the maximum file size, in bytes. @@ -356,8 +372,9 @@ By default, all members of a project and group are able to register runners. To restrict all users in an instance from registering runners: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Expand **Runners**. 1. In the **Runner registration** section, clear the **Members of the project can register runners** and **Members of the group can register runners** checkboxes to remove runner registration from the UI. @@ -378,8 +395,9 @@ GitLab administrators can adjust group permissions to restrict runner registrati To restrict runner registration by members in a specific group: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview > Groups** and find your group. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Overview > Groups** and find your group. 1. Select **Edit**. 1. Clear the **New group runners can be registered** checkbox if you want to disable runner registration by all members in the group. If the setting is read-only, you must enable runner registration for the [instance](#restrict-runner-registration-by-all-users-in-an-instance). 1. Select **Save changes**. @@ -392,8 +410,9 @@ By default, GitLab instances periodically fetch official runner version data fro To disable your instance fetching this data: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Expand **Runners**. 1. In the **Runner version management** section, clear the **Fetch GitLab Runner release version data from GitLab.com** checkbox. 1. Select **Save changes**. diff --git a/doc/user/admin_area/settings/deprecated_api_rate_limits.md b/doc/user/admin_area/settings/deprecated_api_rate_limits.md index 13f8bc008e3..e813d8fe2b1 100644 --- a/doc/user/admin_area/settings/deprecated_api_rate_limits.md +++ b/doc/user/admin_area/settings/deprecated_api_rate_limits.md @@ -34,8 +34,9 @@ Prerequisite: To override the general user and IP rate limits for requests to deprecated API endpoints: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. 1. Expand **Deprecated API Rate Limits**. 1. Select the checkboxes for the types of rate limits you want to enable: - **Unauthenticated API request rate limit** diff --git a/doc/user/admin_area/settings/email.md b/doc/user/admin_area/settings/email.md index 57e6c94913f..1caa1728ea4 100644 --- a/doc/user/admin_area/settings/email.md +++ b/doc/user/admin_area/settings/email.md @@ -21,8 +21,9 @@ address in the body of the email instead. To include the author's email address in the email body: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences** (`/admin/application_settings/preferences`). +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand **Email**. 1. Select the **Include author name in email notification email body** checkbox. 1. Select **Save changes**. @@ -33,8 +34,9 @@ GitLab can send email in multipart format (HTML and plain text) or plain text on To enable multipart email: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences** (`/admin/application_settings/preferences`). +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand **Email**. 1. Select **Enable multipart email**. 1. Select **Save changes**. @@ -48,8 +50,9 @@ This configuration option sets the email hostname for [private commit emails](.. To change the hostname used in private commit emails: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences** (`/admin/application_settings/preferences`). +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand **Email**. 1. Enter the desired hostname in the **Custom hostname (for private commit emails)** field. 1. Select **Save changes**. @@ -66,8 +69,9 @@ can be used for legal, auditing, or compliance reasons, for example. To add additional text to emails: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences** (`/admin/application_settings/preferences`). +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand **Email**. 1. Enter your text in the **Additional text** field. 1. Select **Save changes**. @@ -78,8 +82,9 @@ GitLab sends email notifications to users when their account has been deactivate To disable these notifications: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences** (`/admin/application_settings/preferences`). +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand **Email**. 1. Clear the **Enable user deactivation emails** checkbox. 1. Select **Save changes**. @@ -100,8 +105,9 @@ setting. To add additional text to deactivation emails: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences** (`/admin/application_settings/preferences`). +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand **Email**. 1. Enter your text in the **Additional text for deactivation email** field. 1. Select **Save changes**. diff --git a/doc/user/admin_area/settings/external_authorization.md b/doc/user/admin_area/settings/external_authorization.md index 2e62670fa00..c15062dd518 100644 --- a/doc/user/admin_area/settings/external_authorization.md +++ b/doc/user/admin_area/settings/external_authorization.md @@ -45,8 +45,9 @@ Alternatively, learn where to install custom certificates by using The external authorization service can be enabled by an administrator: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand **External authorization**. 1. Complete the fields. 1. Select **Save changes**. @@ -65,8 +66,9 @@ Prerequisites: To allow authorization with deploy tokens and keys: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand **External authorization**, and: - Leave the service URL field empty. - Select **Allow deploy tokens and deploy keys to be used with external authorization**. diff --git a/doc/user/admin_area/settings/files_api_rate_limits.md b/doc/user/admin_area/settings/files_api_rate_limits.md index 8677e3d86bf..9f7a2d13b8e 100644 --- a/doc/user/admin_area/settings/files_api_rate_limits.md +++ b/doc/user/admin_area/settings/files_api_rate_limits.md @@ -30,8 +30,9 @@ Prerequisite: To override the general user and IP rate limits for requests to the Repository files API: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. 1. Expand **Files API Rate Limits**. 1. Select the checkboxes for the types of rate limits you want to enable: - **Unauthenticated API request rate limit** diff --git a/doc/user/admin_area/settings/floc.md b/doc/user/admin_area/settings/floc.md index 451acc07240..6bd5a6dfed4 100644 --- a/doc/user/admin_area/settings/floc.md +++ b/doc/user/admin_area/settings/floc.md @@ -22,8 +22,9 @@ Permissions-Policy: interest-cohort=() To enable it: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand **Federated Learning of Cohorts (FLoC)**. 1. Select the **Participate in FLoC** checkbox. 1. Select **Save changes**. diff --git a/doc/user/admin_area/settings/git_lfs_rate_limits.md b/doc/user/admin_area/settings/git_lfs_rate_limits.md index e0476f1e333..c9b294417ee 100644 --- a/doc/user/admin_area/settings/git_lfs_rate_limits.md +++ b/doc/user/admin_area/settings/git_lfs_rate_limits.md @@ -21,8 +21,9 @@ rate limits. Git LFS rate limits are disabled by default. If enabled and configured, these limits supersede the [general user and IP rate limits](user_and_ip_rate_limits.md): -1. On the top bar, select **Main menu >** **{admin}** **Admin**. -1. On the left sidebar, select **Settings > Network**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. 1. Expand **Git LFS Rate Limits**. 1. Select **Enable authenticated Git LFS request rate limit**. 1. Enter a value for **Max authenticated Git LFS requests per period per user**. diff --git a/doc/user/admin_area/settings/gitaly_timeouts.md b/doc/user/admin_area/settings/gitaly_timeouts.md index d18fe0d74cd..d28e9ec0249 100644 --- a/doc/user/admin_area/settings/gitaly_timeouts.md +++ b/doc/user/admin_area/settings/gitaly_timeouts.md @@ -11,8 +11,9 @@ configured to make sure that long-running Gitaly calls don't needlessly take up To access Gitaly timeout settings: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand the **Gitaly timeouts** section. ## Available timeouts diff --git a/doc/user/admin_area/settings/help_page.md b/doc/user/admin_area/settings/help_page.md index 5d9fc23aaff..febd794b04c 100644 --- a/doc/user/admin_area/settings/help_page.md +++ b/doc/user/admin_area/settings/help_page.md @@ -16,8 +16,9 @@ the GitLab sign-in page. You can add a help message, which is shown at the top of the GitLab `/help` page (for example, <https://gitlab.com/help>): -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand **Sign-in and Help page**. 1. In **Additional text to show on the Help page**, enter the information you want to display on `/help`. 1. Select **Save changes**. @@ -33,8 +34,9 @@ is restricted, `/help` is visible only to authenticated users. You can add a help message, which is shown on the GitLab sign-in page. The message appears on the sign-in page: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand **Sign-in and Help page**. 1. In **Additional text to show on the sign-in page**, enter the information you want to display on the sign-in page. @@ -46,8 +48,9 @@ You can now see the message on the sign-in page. GitLab marketing-related entries are occasionally shown on the Help page. To hide these entries: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand **Sign-in and Help page**. 1. Select the **Hide marketing-related entries from the Help page** checkbox. 1. Select **Save changes**. @@ -59,8 +62,9 @@ You can specify a custom URL to which users are directed when they: - Select **Support** from the Help dropdown list. - Select **See our website for help** on the Help page. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand **Sign-in and Help page**. 1. In the **Support page URL** field, enter the URL. 1. Select **Save changes**. @@ -73,8 +77,9 @@ You can specify a custom URL to which users are directed when they: You can redirect all `/help` links to a destination that meets the [necessary requirements](#destination-requirements). -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand **Sign-in and Help page**. 1. In the **Documentation pages URL** field, enter the URL. 1. Select **Save changes**. diff --git a/doc/user/admin_area/settings/import_export_rate_limits.md b/doc/user/admin_area/settings/import_export_rate_limits.md index 36a8b340957..99385c77cdf 100644 --- a/doc/user/admin_area/settings/import_export_rate_limits.md +++ b/doc/user/admin_area/settings/import_export_rate_limits.md @@ -12,8 +12,10 @@ You can configure the rate limits for imports and exports of projects and groups To change a rate limit: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**, then expand **Import and export rate limits**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **Import and export rate limits**. 1. Change the value of any rate limit. The rate limits are per minute per user, not per IP address. Set to `0` to disable a rate limit. diff --git a/doc/user/admin_area/settings/incident_management_rate_limits.md b/doc/user/admin_area/settings/incident_management_rate_limits.md index 295569dafee..0b6e572837e 100644 --- a/doc/user/admin_area/settings/incident_management_rate_limits.md +++ b/doc/user/admin_area/settings/incident_management_rate_limits.md @@ -30,8 +30,9 @@ Requests that exceed the limit are logged into `auth.log`. To set inbound incident management alert limits: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. 1. Expand **Incident Management Limits**. 1. Select the **Enable Incident Management inbound alert limit** checkbox. 1. Optional. Input a custom value for **Maximum requests per project per rate limit period**. Default is 3600. diff --git a/doc/user/admin_area/settings/index.md b/doc/user/admin_area/settings/index.md index c91b8f0b6b0..c74d39feb33 100644 --- a/doc/user/admin_area/settings/index.md +++ b/doc/user/admin_area/settings/index.md @@ -19,8 +19,9 @@ read [GitLab.com settings](../../gitlab_com/index.md). To access the **Admin Area**: 1. Sign in to your GitLab instance as an administrator. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings**, and the group of settings to view: +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings**, and the group of settings to view: - [General](#general) - [Geo](#geo) - [CI/CD](#cicd) @@ -199,8 +200,9 @@ The **Templates** settings contain: You can change the [Default first day of the week](../../profile/preferences.md) for the entire GitLab instance: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Scroll to the **Localization** section, and select your desired first day of the week. ## Default language @@ -208,6 +210,7 @@ for the entire GitLab instance: You can change the [Default language](../../profile/preferences.md) for the entire GitLab instance: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Scroll to the **Localization** section, and select your desired default language. diff --git a/doc/user/admin_area/settings/instance_template_repository.md b/doc/user/admin_area/settings/instance_template_repository.md index dc80fd88820..a5148c41b74 100644 --- a/doc/user/admin_area/settings/instance_template_repository.md +++ b/doc/user/admin_area/settings/instance_template_repository.md @@ -20,8 +20,9 @@ while the project remains secure. To select a project to serve as the custom template repository: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Templates**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Templates**. 1. Expand **Templates** 1. From the dropdown list, select the project to use as the template repository. 1. Select **Save changes**. diff --git a/doc/user/admin_area/settings/package_registry_rate_limits.md b/doc/user/admin_area/settings/package_registry_rate_limits.md index a5c5536f22d..61abf68e75c 100644 --- a/doc/user/admin_area/settings/package_registry_rate_limits.md +++ b/doc/user/admin_area/settings/package_registry_rate_limits.md @@ -30,8 +30,10 @@ no difference in functionality compared to the general user and IP rate limits. To enable the unauthenticated request rate limit: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**, and expand **Package registry rate limits**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **Package registry rate limits**. 1. Select **Enable unauthenticated request rate limit**. - Optional. Update the **Maximum unauthenticated requests per rate limit period per IP** value. @@ -43,8 +45,10 @@ To enable the unauthenticated request rate limit: To enable the authenticated API request rate limit: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**, and expand **Package registry rate limits**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network** +1. Expand **Package registry rate limits**. 1. Select **Enable authenticated API request rate limit**. - Optional. Update the **Maximum authenticated API requests per rate limit period per user** value. diff --git a/doc/user/admin_area/settings/project_integration_management.md b/doc/user/admin_area/settings/project_integration_management.md index dd4349fca2e..1bb4465020c 100644 --- a/doc/user/admin_area/settings/project_integration_management.md +++ b/doc/user/admin_area/settings/project_integration_management.md @@ -22,8 +22,9 @@ Only the complete settings for an integration can be inherited. Per-field inheri > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2137) in GitLab 13.3 for project-level integrations. > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2543) in GitLab 13.6 for group-level integrations. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Integrations**. 1. Select an integration. 1. Enter configuration details and select **Save changes**. @@ -54,8 +55,9 @@ integration on all non-configured groups and projects by default. ### Remove an instance-level default setting -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Integrations**. 1. Select an integration. 1. Select **Reset** and confirm. @@ -68,8 +70,9 @@ Resetting an instance-level default setting removes the integration from all pro You can view which projects in your instance use custom settings that [override the instance-level default settings](#use-custom-settings-for-a-group-or-project-integration) for an integration. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Integrations**. 1. Select an integration. 1. Select the **Projects using custom settings** tab. diff --git a/doc/user/admin_area/settings/push_event_activities_limit.md b/doc/user/admin_area/settings/push_event_activities_limit.md index 0c3f299e9ec..572f965bde9 100644 --- a/doc/user/admin_area/settings/push_event_activities_limit.md +++ b/doc/user/admin_area/settings/push_event_activities_limit.md @@ -26,8 +26,10 @@ the activity feed. To modify this setting: - In the Admin Area: - 1. On the top bar, select **Main menu > Admin**. - 1. On the left sidebar, select **Settings > Network**, then expand **Performance optimization**. + 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). + 1. Select **Admin Area**. + 1. Select **Settings > Network**. + 1. Expand **Performance optimization**. - Through the [Application settings API](../../../api/settings.md#list-of-settings-that-can-be-accessed-via-api-calls) as `push_event_activities_limit`. diff --git a/doc/user/admin_area/settings/rate_limit_on_issues_creation.md b/doc/user/admin_area/settings/rate_limit_on_issues_creation.md index 547e543ab88..09a1e023c2b 100644 --- a/doc/user/admin_area/settings/rate_limit_on_issues_creation.md +++ b/doc/user/admin_area/settings/rate_limit_on_issues_creation.md @@ -12,8 +12,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w This setting allows you to rate limit the requests to the issue and epic creation endpoints. To can change its value: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. 1. Expand **Issues Rate Limits**. 1. Under **Max requests per minute**, enter the new value. 1. Select **Save changes**. diff --git a/doc/user/admin_area/settings/rate_limit_on_notes_creation.md b/doc/user/admin_area/settings/rate_limit_on_notes_creation.md index 8465dccdbf3..59548836e78 100644 --- a/doc/user/admin_area/settings/rate_limit_on_notes_creation.md +++ b/doc/user/admin_area/settings/rate_limit_on_notes_creation.md @@ -13,8 +13,9 @@ You can configure the per-user rate limit for requests to the note creation endp To change the note creation rate limit: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. 1. Expand **Notes rate limit**. 1. In the **Maximum requests per minute** box, enter the new value. 1. Optional. In the **Users to exclude from the rate limit** box, list users allowed to exceed the limit. diff --git a/doc/user/admin_area/settings/rate_limit_on_pipelines_creation.md b/doc/user/admin_area/settings/rate_limit_on_pipelines_creation.md index 152ef535ff8..2d0c4405211 100644 --- a/doc/user/admin_area/settings/rate_limit_on_pipelines_creation.md +++ b/doc/user/admin_area/settings/rate_limit_on_pipelines_creation.md @@ -26,8 +26,9 @@ Requests that exceed the limit are logged in the `application_json.log` file. To limit the number of pipeline requests: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. 1. Expand **Pipelines Rate Limits**. 1. Under **Max requests per minute**, enter a value greater than `0`. 1. Select **Save changes**. diff --git a/doc/user/admin_area/settings/rate_limit_on_projects_api.md b/doc/user/admin_area/settings/rate_limit_on_projects_api.md index 29e72daf579..326dd3b4706 100644 --- a/doc/user/admin_area/settings/rate_limit_on_projects_api.md +++ b/doc/user/admin_area/settings/rate_limit_on_projects_api.md @@ -16,8 +16,9 @@ You can configure the rate limit per IP address for unauthenticated requests to To change the rate limit: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. 1. Expand **Projects API rate limit**. 1. In the **Maximum requests per 10 minutes per IP address** text box, enter the new value. 1. Select **Save changes**. diff --git a/doc/user/admin_area/settings/rate_limit_on_users_api.md b/doc/user/admin_area/settings/rate_limit_on_users_api.md index f61c381a4fb..112518131bf 100644 --- a/doc/user/admin_area/settings/rate_limit_on_users_api.md +++ b/doc/user/admin_area/settings/rate_limit_on_users_api.md @@ -13,8 +13,9 @@ You can configure the per user rate limit for requests to [Users API](../../../a To change the rate limit: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. 1. Expand **Users API rate limit**. 1. In the **Maximum requests per 10 minutes** text box, enter the new value. 1. Optional. In the **Users to exclude from the rate limit** box, list users allowed to exceed the limit. diff --git a/doc/user/admin_area/settings/rate_limits_on_raw_endpoints.md b/doc/user/admin_area/settings/rate_limits_on_raw_endpoints.md index 7e262c45f48..78e65f7ba7b 100644 --- a/doc/user/admin_area/settings/rate_limits_on_raw_endpoints.md +++ b/doc/user/admin_area/settings/rate_limits_on_raw_endpoints.md @@ -11,8 +11,9 @@ type: reference This setting defaults to `300` requests per minute, and allows you to rate limit the requests to raw endpoints: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. 1. Expand **Performance optimization**. For example, requests over `300` per minute to `https://gitlab.com/gitlab-org/gitlab-foss/raw/master/app/controllers/application_controller.rb` are blocked. Access to the raw file is released after 1 minute. diff --git a/doc/user/admin_area/settings/scim_setup.md b/doc/user/admin_area/settings/scim_setup.md index 7c2993a7174..0471dffe442 100644 --- a/doc/user/admin_area/settings/scim_setup.md +++ b/doc/user/admin_area/settings/scim_setup.md @@ -26,8 +26,9 @@ Prerequisites: To configure GitLab SCIM: -1. On the top bar, select **Main menu > Admin area**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **SCIM Token** section and select **Generate a SCIM token**. 1. For configuration of your identity provider, save the: - Token from the **Your SCIM token** field. diff --git a/doc/user/admin_area/settings/security_and_compliance.md b/doc/user/admin_area/settings/security_and_compliance.md index c7f4d6a3ede..54fd04f6521 100644 --- a/doc/user/admin_area/settings/security_and_compliance.md +++ b/doc/user/admin_area/settings/security_and_compliance.md @@ -17,8 +17,9 @@ We are actively working on reducing this data size in [epic 10415](https://gitla To choose the packages you want to synchronize with the GitLab License Database for [License Compliance](../../compliance/license_scanning_of_cyclonedx_files/index.md): -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Security and Compliance**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Security and Compliance**. 1. Expand **License Compliance**. 1. Select or clear checkboxes for the package registries that you want to sync. 1. Select **Save changes**. diff --git a/doc/user/admin_area/settings/sidekiq_job_limits.md b/doc/user/admin_area/settings/sidekiq_job_limits.md index a25bc0e85e4..08c3ced4c4e 100644 --- a/doc/user/admin_area/settings/sidekiq_job_limits.md +++ b/doc/user/admin_area/settings/sidekiq_job_limits.md @@ -17,8 +17,9 @@ Redis. To avoid excessive memory for Redis, we: To access Sidekiq job size limits: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand **Sidekiq job size limits**. 1. Adjust the compression threshold or size limit. The compression can be disabled by selecting the **Track** mode. diff --git a/doc/user/admin_area/settings/sign_in_restrictions.md b/doc/user/admin_area/settings/sign_in_restrictions.md index df719004062..3b79e55f998 100644 --- a/doc/user/admin_area/settings/sign_in_restrictions.md +++ b/doc/user/admin_area/settings/sign_in_restrictions.md @@ -12,8 +12,9 @@ You can use **Sign-in restrictions** to customize authentication restrictions fo To access sign-in restriction settings: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Sign-in restrictions** section. ## Password authentication enabled @@ -75,8 +76,9 @@ Open the [Rails console](../../../administration/operations/rails_console.md) an To enable Admin Mode through the UI: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand **Sign-in restrictions**. 1. In the **Admin Mode** section, select the **Require additional authentication for administrative tasks** checkbox. @@ -84,7 +86,8 @@ To enable Admin Mode through the UI: To turn on Admin Mode for your current session and access potentially dangerous resources: -1. On the top bar, select **Main menu > Enter Admin Mode**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Enter Admin Mode**. 1. Try to access any part of the UI with `/admin` in the URL (which requires administrator access). When Admin Mode status is disabled or turned off, administrators cannot access resources unless @@ -99,7 +102,10 @@ authentication are supported by Admin Mode. Admin Mode status is stored in the c ### Turn off Admin Mode for your session -To turn off Admin Mode for your current session, on the top bar, select **Main menu > Leave Admin mode**. +To turn off Admin Mode for your current session: + +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Leave Admin Mode**. ### Limitations of Admin Mode @@ -173,8 +179,10 @@ For example, if you include the following information in the noted text box: To access this text box: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, and expand the **Sign-in restrictions** section. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. +1. Expand the **Sign-in restrictions** section. ``` Your users see the **Custom sign-in text** when they navigate to the sign-in screen for your diff --git a/doc/user/admin_area/settings/sign_up_restrictions.md b/doc/user/admin_area/settings/sign_up_restrictions.md index c0a7b40cb2f..0dcca5e7518 100644 --- a/doc/user/admin_area/settings/sign_up_restrictions.md +++ b/doc/user/admin_area/settings/sign_up_restrictions.md @@ -22,8 +22,10 @@ you do not expect public users to sign up for an account. To disable sign ups: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, and expand **Sign-up restrictions**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. +1. Expand **Sign-up restrictions**. 1. Clear the **Sign-up enabled** checkbox, then select **Save changes**. ## Require administrator approval for new sign ups @@ -38,8 +40,10 @@ enabled by default for new GitLab instances. It is only applicable if sign ups a To require administrator approval for new sign ups: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, and expand **Sign-up restrictions**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. +1. Expand **Sign-up restrictions**. 1. Select the **Require admin approval for new sign-ups** checkbox, then select **Save changes**. In [GitLab 13.7 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/273258), if an administrator disables this setting, the users in pending approval state are @@ -62,8 +66,10 @@ their email address before they are allowed to sign in. For example, to enforce confirmation of the email address used for new sign ups: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, and expand **Sign-up restrictions**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. +1. Expand **Sign-up restrictions**. 1. Under **Email confirmation settings**, select **Hard**. The following settings are available: @@ -97,8 +103,9 @@ User cap can be used instead. As noted above, set the cap to value that ensures ### Set the user cap number -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand **Sign-up restrictions**. 1. Enter a number in **User cap**. 1. Select **Save changes**. @@ -107,8 +114,9 @@ New user sign ups are subject to the user cap restriction. ## Remove the user cap -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand **Sign-up restrictions**. 1. Remove the number from **User cap**. 1. Select **Save changes**. @@ -135,8 +143,9 @@ You can add additional complexity requirements. Changes to password complexity r Existing passwords are unaffected. To change password complexity requirements: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand **Sign-up restrictions**. 1. Under **Minimum password length (number of characters)**, select additional password complexity requirements. You can require numbers, uppercase letters, lowercase letters, and symbols. @@ -164,8 +173,10 @@ reduce the risk of malicious users creating spam accounts with disposable email To create an email domain allowlist or denylist: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**, and expand **Sign-up restrictions**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. +1. Expand **Sign-up restrictions**. 1. For the allowlist, you must enter the list manually. For the denylist, you can enter the list manually or upload a `.txt` file that contains list entries. diff --git a/doc/user/admin_area/settings/terms.md b/doc/user/admin_area/settings/terms.md index 85927bad8ad..8563f778292 100644 --- a/doc/user/admin_area/settings/terms.md +++ b/doc/user/admin_area/settings/terms.md @@ -17,8 +17,9 @@ for example `https://gitlab.example.com/-/users/terms`. To enforce acceptance of a Terms of Service and Privacy Policy: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Terms of Service and Privacy Policy** section. 1. Check the **All users must accept the Terms of Service and Privacy Policy to access GitLab** checkbox. 1. Input the text of the **Terms of Service and Privacy Policy**. You can use [Markdown](../../markdown.md) diff --git a/doc/user/admin_area/settings/terraform_limits.md b/doc/user/admin_area/settings/terraform_limits.md index 05b1f2d8838..0e620bb84ce 100644 --- a/doc/user/admin_area/settings/terraform_limits.md +++ b/doc/user/admin_area/settings/terraform_limits.md @@ -15,8 +15,9 @@ state file version, and is checked whenever a new version is created. To add a storage limit: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Preferences**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Preferences**. 1. Expand **Terraform limits**. 1. Adjust the size limit. diff --git a/doc/user/admin_area/settings/third_party_offers.md b/doc/user/admin_area/settings/third_party_offers.md index 6037b24a294..39e2275f411 100644 --- a/doc/user/admin_area/settings/third_party_offers.md +++ b/doc/user/admin_area/settings/third_party_offers.md @@ -18,8 +18,10 @@ questions when creating a group. To toggle the display of customer experience improvement content and third-party offers: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings**, and expand **Customer experience improvement & third-party offers**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. +1. Expand **Customer experience improvement and third-party offers**. 1. Select **Do not display content for customer experience improvement and offers from third parties**. 1. Select **Save changes**. diff --git a/doc/user/admin_area/settings/usage_statistics.md b/doc/user/admin_area/settings/usage_statistics.md index ec9fda1ed07..4cd71a31c76 100644 --- a/doc/user/admin_area/settings/usage_statistics.md +++ b/doc/user/admin_area/settings/usage_statistics.md @@ -64,8 +64,9 @@ Registration is not yet required for participation, but may be added in a future ### Enable registration features 1. Sign in as a user with administrator access. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Metrics and profiling**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Metrics and profiling**. 1. Expand the **Usage statistics** section. 1. If not enabled, select the **Enable Service Ping** checkbox. 1. Select the **Enable Registration Features** checkbox. @@ -121,8 +122,9 @@ If your GitLab instance is behind a proxy, set the appropriate To enable or disable Service Ping and version check: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Metrics and profiling**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Metrics and profiling**. 1. Expand **Usage statistics**. 1. Select or clear the **Enable version check** and **Enable Service Ping** checkboxes. 1. Select **Save changes**. @@ -178,8 +180,9 @@ the Admin Area: You can view the exact JSON payload sent to GitLab Inc. in the Admin Area. To view the payload: 1. Sign in as a user with administrator access. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Metrics and profiling**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Metrics and profiling**. 1. Expand the **Usage statistics** section. 1. Select **Preview payload**. @@ -196,8 +199,9 @@ or if the Service Ping [cron job](../../../development/service_ping/index.md#how To upload the payload manually: 1. Sign in as a user with administrator access. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Service** usage data. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Service** usage data. 1. Select **Download payload**. 1. Save the JSON file. 1. Visit [Service usage data center](https://version.gitlab.com/usage_data/new). diff --git a/doc/user/admin_area/settings/user_and_ip_rate_limits.md b/doc/user/admin_area/settings/user_and_ip_rate_limits.md index 4fc44c94b4a..d145c351f3e 100644 --- a/doc/user/admin_area/settings/user_and_ip_rate_limits.md +++ b/doc/user/admin_area/settings/user_and_ip_rate_limits.md @@ -31,8 +31,10 @@ counted as web traffic. To enable the unauthenticated request rate limit: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**, and expand **User and IP rate limits**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **User and IP rate limits**. 1. Select **Enable unauthenticated API request rate limit**. - Optional. Update the **Maximum unauthenticated API requests per rate limit period per IP** value. @@ -44,8 +46,10 @@ To enable the unauthenticated request rate limit: To enable the unauthenticated request rate limit: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**, and expand **User and IP rate limits**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **User and IP rate limits**. 1. Select **Enable unauthenticated web request rate limit**. - Optional. Update the **Maximum unauthenticated web requests per rate limit period per IP** value. @@ -57,8 +61,10 @@ To enable the unauthenticated request rate limit: To enable the authenticated API request rate limit: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**, and expand **User and IP rate limits**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **User and IP rate limits**. 1. Select **Enable authenticated API request rate limit**. - Optional. Update the **Maximum authenticated API requests per rate limit period per user** value. @@ -70,8 +76,10 @@ To enable the authenticated API request rate limit: To enable the unauthenticated request rate limit: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**, and expand **User and IP rate limits**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **User and IP rate limits**. 1. Select **Enable authenticated web request rate limit**. - Optional. Update the **Maximum authenticated web requests per rate limit period per user** value. @@ -88,8 +96,10 @@ plain-text body, which by default is `Retry later`. To use a custom response: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Network**, and expand **User and IP rate limits**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Network**. +1. Expand **User and IP rate limits**. 1. In the **Plain-text response to send to clients that hit a rate limit** text box, add the plain-text response message. diff --git a/doc/user/admin_area/settings/visibility_and_access_controls.md b/doc/user/admin_area/settings/visibility_and_access_controls.md index 381f985e923..dd53efaf518 100644 --- a/doc/user/admin_area/settings/visibility_and_access_controls.md +++ b/doc/user/admin_area/settings/visibility_and_access_controls.md @@ -13,8 +13,9 @@ specific controls on branches, projects, snippets, groups, and more. To access the visibility and access control options: 1. Sign in to GitLab as a user with Administrator access level. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Visibility and access controls** section. ## Define which roles can create projects @@ -24,8 +25,9 @@ Instance-level protections for project creation define which roles can on the instance. To alter which roles have permission to create projects: 1. Sign in to GitLab as a user with Administrator access level. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Visibility and access controls** section. 1. For **Default project creation protection**, select the desired roles: - No one. @@ -40,8 +42,9 @@ on the instance. To alter which roles have permission to create projects: By default both administrators and anyone with the **Owner** role can delete a project. To restrict project deletion to only administrators: 1. Sign in to GitLab as a user with administrator access. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Visibility and access controls** section. 1. Scroll to: - (GitLab 15.1 and later) **Allowed to delete projects**, and select **Administrators**. @@ -77,8 +80,9 @@ then it gets automatically changed to `1` while also disabling deletion protecti To configure delayed project deletion: 1. Sign in to GitLab as a user with administrator access. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Visibility and access controls** section. 1. Scroll to: - (In GitLab 15.11 and later with `always_perform_delayed_deletion` feature flag enabled, or GitLab 16.0 and later) **Deletion protection** and set the retention period to a value between `1` and `90`. @@ -117,8 +121,9 @@ Alternatively, projects that are marked for removal can be deleted immediately. To set the default [visibility levels for new projects](../../public_access.md): 1. Sign in to GitLab as a user with Administrator access level. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Visibility and access controls** section. 1. Select the desired default project visibility: - **Private** - Project access must be granted explicitly to each user. If this @@ -132,8 +137,9 @@ To set the default [visibility levels for new projects](../../public_access.md): To set the default visibility levels for new [snippets](../../snippets.md): 1. Sign in to GitLab as a user with Administrator access level. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Visibility and access controls** section. 1. Select the desired default snippet visibility. 1. Select **Save changes**. @@ -146,8 +152,9 @@ For more details on snippet visibility, read To set the default visibility levels for new groups: 1. Sign in to GitLab as a user with Administrator access level. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Visibility and access controls** section. 1. Select the desired default group visibility: - **Private** - The group and its projects can only be viewed by members. @@ -167,8 +174,9 @@ the item you're changing. To restrict visibility levels for groups, projects, snippets, and selected pages: 1. Sign in to GitLab as a user with Administrator access level. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Visibility and access controls** section. 1. In the **Restricted visibility levels** section, select the desired visibility levels to restrict. - If you restrict the **Public** level: @@ -192,8 +200,9 @@ Before you can import projects from other systems, you must enable the [import source](../../gitlab_com/index.md#default-import-sources) for that system. 1. Sign in to GitLab as a user with Administrator access level. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Visibility and access controls** section. 1. Select each of **Import sources** to allow. 1. Select **Save changes**. @@ -204,8 +213,9 @@ To enable the export of [projects and their data](../../project/settings/import_export.md#export-a-project-and-its-data): 1. Sign in to GitLab as a user with Administrator access level. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Visibility and access controls** section. 1. Scroll to **Project export**. 1. Select the **Enabled** checkbox. @@ -220,8 +230,9 @@ You can enable migration of groups by direct transfer using the UI. To enable migration of groups by direct transfer: 1. Sign in to GitLab as a user with Administrator access level. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Visibility and access controls** section. 1. Scroll to **Allow migrating GitLab groups and projects by direct transfer**. 1. Select the **Enabled** checkbox. @@ -241,8 +252,9 @@ The GitLab restrictions apply at the application level. To specify the enabled Git access protocols: 1. Sign in to GitLab as a user with Administrator access level. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Visibility and access controls** section. 1. Select the desired Git access protocols: - Both SSH and HTTP(S) @@ -327,8 +339,9 @@ include the `10.0.0.0/24` range. To add a IP address range to the group-level allowlist: 1. Sign in to GitLab as a user with Administrator access level. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand the **Visibility and access controls** section. 1. In **Globally-allowed IP ranges**, provide a list of IP address ranges. This list: - Has no limit on the number of IP address ranges. diff --git a/doc/user/clusters/agent/gitops/flux_tutorial.md b/doc/user/clusters/agent/gitops/flux_tutorial.md index bdb772ac14e..c6c9ed9e373 100644 --- a/doc/user/clusters/agent/gitops/flux_tutorial.md +++ b/doc/user/clusters/agent/gitops/flux_tutorial.md @@ -6,31 +6,28 @@ info: A tutorial using Flux # Tutorial: Set up Flux for GitOps **(FREE)** -This tutorial teaches you how to set up Flux for GitOps. You'll set up a sample project, -complete a bootstrap Flux installation, and authenticate your installation with a -[project deploy token](../../../project/deploy_tokens/index.md). - -You can find the fully configured tutorial project [in this GitLab repository](https://gitlab.com/gitlab-org/configure/examples/flux/flux-config). -It works in conjunction with [this repository](https://gitlab.com/gitlab-org/configure/examples/flux/web-app-manifests/-/tree/main), which contains the example Kubernetes manifests. +This tutorial teaches you how to set up Flux for GitOps. You'll complete a bootstrap installation, +install `agentk` in your cluster, and deploy a simple `nginx` application. To set up Flux for GitOps: 1. [Create a personal access token](#create-a-personal-access-token) -1. [Create the Flux repository](#create-the-flux-repository) -1. [Create the Kubernetes manifest repository](#create-the-kubernetes-manifest-repository) -1. [Configure Flux to sync your manifests](#configure-flux-to-sync-your-manifests) -1. [Verify your configuration](#verify-your-configuration) +1. [Complete a bootstrap installation](#complete-a-bootstrap-installation) +1. [Register `agentk`](#register-agentk) +1. [Install `agentk`](#install-agentk) +1. [Deploy an example project](#deploy-an-example-project) Prerequisites: -- You must have a Kubernetes cluster running. +- You must have a Kubernetes cluster you can access locally with `kubectl`. +- You must [install the Flux CLI](https://fluxcd.io/flux/installation/#install-the-flux-cli). Be sure to install Flux v2 or higher. ## Create a personal access token -To authenticate with the Flux CLI, you must create a personal access token -with the `api` scope: +To authenticate with the Flux CLI, create a personal access token with +the `api` scope: -1. In the upper-right corner, select your avatar. +1. On the left sidebar, select your avatar. 1. Select **Edit profile**. 1. On the left sidebar, select **Access Tokens**. 1. Enter a name and optional expiry date for the token. @@ -39,154 +36,172 @@ with the `api` scope: You can also use a [project](../../../project/settings/project_access_tokens.md) or [group access token](../../../group/settings/group_access_tokens.md) with the `api` scope. -## Create the Flux repository +## Complete a bootstrap installation -Create a Git repository, install Flux, and authenticate Flux with your repo: +In this section, you'll bootstrap Flux into an empty GitLab repository with the +[`flux bootstrap`](https://fluxcd.io/flux/installation/#gitlab-and-gitlab-enterprise) +command. -1. Make sure your `kubectl` is configured to access your cluster. -1. [Install the Flux CLI](https://fluxcd.io/flux/installation/#install-the-flux-cli). You must install Flux v2 or higher. -1. In GitLab, create a new empty project called `flux-config`. -1. From your shell, export a `GITLAB_TOKEN` environment variable with the value of your personal access token. - For example, `export GITLAB_TOKEN=<personal-access-token>`. -1. Run the `bootstrap` command. The exact command depends on whether you are - creating the Flux repository under a GitLab user, group, or subgroup. For more information, - see the [Flux bootstrap documentation](https://fluxcd.io/flux/installation/#gitlab-and-gitlab-enterprise). +To bootstrap a Flux installation: - In this tutorial, you're working with a public project in a subgroup. The bootstrap command looks like this: +- Run the `flux bootstrap gitlab` command. For example: - ```shell - flux bootstrap gitlab \ - --owner=gitlab-org/configure/examples/flux \ - --repository=flux-config \ - --branch=main \ - --path=clusters/my-cluster \ - --deploy-token-auth - ``` + ```shell + flux bootstrap gitlab \ + --owner=example-org \ + --repository=my-repository \ + --branch=master \ + --path=clusters/testing \ + --deploy-token-auth + ``` - This command installs Flux on the Kubernetes cluster and configures it to manage itself from the repository `flux-config`. - The command also automatically creates the project deploy token required to access the `flux-config` repository. +The bootstrap script does the following: -Great work! You now have a repository bootstrapped with a Flux configuration. Any updates to your repository are automatically synced to the cluster. +1. Creates a deploy token and saves it as a Kubernetes `secret`. +1. Creates an empty GitLab project, if the project specified by `--repository` doesn't exist. +1. Generates Flux definition files for your project. +1. Commits the definition files to the specified branch. +1. Applies the definition files to your cluster. -## Create the Kubernetes manifest repository +After you run the script, Flux will be ready to manage itself and any other resources +you add to the GitLab project and path. -Next, create a repository for your Kubernetes manifests: +The rest of this tutorial assumes your path is `clusters/testing`. -1. In GitLab, create a new repository called `web-app-manifests`. -1. Add a file to `web-app-manifests` named `nginx-deployment.yaml` with the following contents: +### Upgrade Flux - ```yaml - apiVersion: apps/v1 +You might need to upgrade Flux some time after you install it. To do so: + +- Rerun the `flux bootstrap gitlab` command. + +## Register `agentk` + +You must register `agentk` before you install it in your cluster. + +To register `agentk`: + +- Complete the steps in [Register the agent with GitLab](../install/index.md#register-the-agent-with-gitlab). + Be sure to save the agent registration token and `kas` address. + +## Install `agentk` + +Next, use Flux to create a namespace for `agentk` and install it in your cluster. + +This tutorial uses the namespace `gitlab` for `agentk`. - kind: Deployment +To install `agentk`: +1. Commit and push the following file to `clusters/testing/namespace-gitlab.yaml`: + + ```yaml + apiVersion: v1 + kind: Namespace metadata: - name: nginx-deployment - labels: - app: nginx - spec: - replicas: 3 - selector: - matchLabels: - app: nginx - template: - metadata: - labels: - app: nginx - spec: - containers: - - name: nginx - image: nginx:1.14.2 - ports: - - containerPort: 80 + name: gitlab ``` -1. In the new repository, [create a deploy token](../../../project/deploy_tokens/index.md#create-a-deploy-token) with only the `read_repository` scope. -1. Store your deploy token username and password somewhere safe. -1. In Flux CLI, create a secret with your deploy token and point the secret to the new repository. For example: +1. Apply the agent registration token as a secret in the cluster: ```shell - flux create secret git flux-deploy-authentication \ - --url=https://gitlab.com/gitlab-org/configure/examples/flux/web-app-manifests \ - --namespace=default \ - --username=<token-user-name> \ - --password=<token-password> + kubectl create secret generic gitlab-agent-token -n gitlab --from-literal=token=YOUR-TOKEN-HERE ``` -1. To check if your secret was generated successfully, run: + Although this step does not follow GitOps principles, it simplifies configuration for new Flux users. + For a proper GitOps setup, you should use a secret management solution. See the [Flux documentation](https://fluxcd.io/flux/guides). - ```shell - kubectl -n default get secrets flux-deploy-authentication -o yaml +1. Commit and push the following file to `clusters/testing/agentk.yaml`, replacing the values of + `.spec.values.config.kasAddress` and `.spec.values.config.secretName` with your saved `kas` address and secret `name`: + + ```yaml + --- + apiVersion: source.toolkit.fluxcd.io/v1beta2 + kind: HelmRepository + metadata: + labels: + app.kubernetes.io/component: agentk + app.kubernetes.io/created-by: gitlab + app.kubernetes.io/name: agentk + app.kubernetes.io/part-of: gitlab + name: gitlab-agent + namespace: gitlab + spec: + interval: 1h0m0s + url: https://charts.gitlab.io + --- + apiVersion: helm.toolkit.fluxcd.io/v2beta1 + kind: HelmRelease + metadata: + name: gitlab-agent + namespace: gitlab + spec: + chart: + spec: + chart: gitlab-agent + sourceRef: + kind: HelmRepository + name: gitlab-agent + namespace: gitlab-agent + interval: 1h0m0s + values: + config: + kasAddress: "wss://kas.gitlab.example.com" + secretName: "gitlab-agent-token" ``` - Under `data`, you should see base64-encoded values associated with your token username and password. +1. To verify that `agentk` is installed and running in the cluster, run the following command: -Congratulations! You now have a manifest repository, a deploy token, and a secret generated directly on your cluster. + ```shell + kubectl -n gitlab get pods + ``` + +Great work! You've successfully set up Flux with `agentk`. You can repeat the steps from this section +to deploy more applications from this project. In the next section, we'll discuss how to scale Flux across projects. -## Configure Flux to sync your manifests +## Deploy an example project -Next, tell `flux-config` to sync with the `web-app-manifests` repository. +You can scale Flux deployments across multiple GitLab projects by adding a Flux `GitRepository` and `Kustomization` that points to another project. +You can use this feature to store manifests related to a particular GitLab group in that group. -To do so, create a [`GitRepository`](https://fluxcd.io/flux/components/source/gitrepositories/) resource: +To demonstrate, deploy an `nginx` application and point Flux at it: -1. Clone the `flux-config` repo to your machine. -1. In your local clone of `flux-config`, add the `GitRepository` file `clusters/my-cluster/web-app-manifests-source.yaml`: +1. Commit and push the following file to `clusters/testing/example-nginx-app.yaml`: ```yaml --- - apiVersion: source.toolkit.fluxcd.io/v1beta2 + apiVersion: source.toolkit.fluxcd.io/v1 kind: GitRepository metadata: - name: web-app-manifests - namespace: default + name: example-nginx-app + namespace: flux-system spec: interval: 1m0s ref: branch: main secretRef: - name: flux-deploy-authentication - url: https://gitlab.com/gitlab-org/configure/examples/flux/web-app-manifests - ``` - - This file uses `secretRef` to refer back to the deploy token secret you created in the last step. - -1. In your local clone of `flux-config`, add the `GitRepository` file `clusters/my-cluster/web-app-manifests-kustomization.yaml`: - - ```yaml + name: example-nginx-app + url: https://gitlab.com/gitlab-examples/ops/gitops-demo/example-mini-flux-deployment.git --- - apiVersion: kustomize.toolkit.fluxcd.io/v1beta2 + apiVersion: kustomize.toolkit.fluxcd.io/v1 kind: Kustomization metadata: - name: nginx-source-kustomization - namespace: default + name: example-nginx-app + namespace: flux-system spec: - interval: 1m0s - path: ./ + interval: 10m0s + path: ./manifests prune: true sourceRef: kind: GitRepository - name: web-app-manifests - namespace: default - targetNamespace: default + name: example-nginx-app ``` - This file adds a [`Kustomization`](https://fluxcd.io/flux/components/kustomize/kustomization/) resource that tells Flux to sync the manifests from - `web-app-manifests` with `kustomize`. - -1. Commit the new files and push. +1. To verify that the application was deployed correctly and `agentk` is running, run the following command: -## Verify your configuration - -You should see a newly created `nginx-deployment` pod in your cluster. - -To check whether the `nginx-deployment` pod is running in the default namespace, run the following: - -```shell -kubectl -n default get pods -n default -``` + ```shell + kubectl -n example-nginx get pods + ``` -If you want to see the deployment sync again, try updating the number of replicas in the -`nginx-deployment.yaml` file and push to your `main` branch. If all is working well, it -should sync to the cluster. +This tutorial deploys an application from a public project. If you want to add a non-public project, you should create a [project deploy token](../../../project/deploy_tokens/index.md) +and save it as a Flux secret. Be sure to save the namespace and secret name. -Excellent work! You've successfully set up a complete Flux project. +Congratulations! You have successfully scaled Flux to multiple groups and projects. diff --git a/doc/user/project/file_lock.md b/doc/user/project/file_lock.md index c81ba4b7dd3..71b4bff41d1 100644 --- a/doc/user/project/file_lock.md +++ b/doc/user/project/file_lock.md @@ -219,8 +219,8 @@ To view the user who locked the file (if it was not you), hover over the button. To view and remove file locks: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Repository > Locked files**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Code > Locked files**. This list shows all the files locked either through LFS or GitLab UI. diff --git a/doc/user/project/import/bitbucket.md b/doc/user/project/import/bitbucket.md index b523e007f0e..dc17a3646a8 100644 --- a/doc/user/project/import/bitbucket.md +++ b/doc/user/project/import/bitbucket.md @@ -70,8 +70,7 @@ For user contributions to be mapped, each user must complete the following befor > Ability to re-import projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23905) in GitLab 15.9. 1. Sign in to GitLab. -1. On the top bar, select **New** (**{plus}**). -1. Select **New project/repository**. +1. On the left sidebar, at the top, select **Create new...** (**{plus}**) and **New project/repository**. 1. Select **Import project**. 1. Select **Bitbucket Cloud**. 1. Log in to Bitbucket and grant GitLab access to your Bitbucket account. diff --git a/doc/user/project/import/bitbucket_server.md b/doc/user/project/import/bitbucket_server.md index 4d3a6eb87e0..fce9ca7d147 100644 --- a/doc/user/project/import/bitbucket_server.md +++ b/doc/user/project/import/bitbucket_server.md @@ -41,8 +41,7 @@ You can import Bitbucket repositories to GitLab. To import your Bitbucket repositories: 1. Sign in to GitLab. -1. On the top bar, select **New** (**{plus}**). -1. Select **New project/repository**. +1. On the left sidebar, at the top, select **Create new...** (**{plus}**) and **New project/repository**. 1. Select **Import project**. 1. Select **Bitbucket Server**. 1. Log in to Bitbucket and grant GitLab access to your Bitbucket account. diff --git a/doc/user/project/import/fogbugz.md b/doc/user/project/import/fogbugz.md index 692ec1390d2..30c4249e0d6 100644 --- a/doc/user/project/import/fogbugz.md +++ b/doc/user/project/import/fogbugz.md @@ -29,8 +29,7 @@ users. To import your project from FogBugz: 1. Sign in to GitLab. -1. On the top bar, select **New** (**{plus}**). -1. Select **New project/repository**. +1. On the left sidebar, at the top, select **Create new...** (**{plus}**) and **New project/repository**. 1. Select **Import project**. 1. Select **FogBugz**. 1. Enter your FogBugz URL, email address, and password. diff --git a/doc/user/project/import/index.md b/doc/user/project/import/index.md index 38df9202209..9fdb8eed5aa 100644 --- a/doc/user/project/import/index.md +++ b/doc/user/project/import/index.md @@ -41,8 +41,9 @@ with a malicious `.gitlab-ci.yml` file could allow an attacker to exfiltrate gro GitLab self-managed administrators can reduce their attack surface by disabling import sources they don't need: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. 1. Expand **Visibility and access controls**. 1. Scroll to **Import sources**. 1. Clear checkboxes for importers that are not required. @@ -113,8 +114,7 @@ You can view all project imports created by you. This list includes the followin To view project import history: 1. Sign in to GitLab. -1. On the top bar, select **Create new...** (**{plus-square}**). -1. Select **New project/repository**. +1. On the left sidebar, at the top, select **Create new...** (**{plus}**) and **New project/repository**. 1. Select **Import project**. 1. In the upper-right corner, select **History**. 1. If there are any errors for a particular import, you can see them by selecting **Details**. diff --git a/doc/user/project/import/repo_by_url.md b/doc/user/project/import/repo_by_url.md index 4ad51ccb97f..230113581f8 100644 --- a/doc/user/project/import/repo_by_url.md +++ b/doc/user/project/import/repo_by_url.md @@ -19,7 +19,8 @@ You can import your existing repositories by providing the Git URL. ## Import project by URL -1. In GitLab, on the top bar, select **Main menu > Projects > View all projects**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **View all your projects**. 1. On the right of the page, select **New project**. 1. Select the **Import project** tab. 1. Select **Repository by URL**. diff --git a/doc/user/project/index.md b/doc/user/project/index.md index 1512039fb25..67b96efe9a4 100644 --- a/doc/user/project/index.md +++ b/doc/user/project/index.md @@ -12,8 +12,7 @@ You can create a project in many ways in GitLab. To create a blank project: -1. On the top bar, select **Main menu > Projects > View all projects**. -1. On the right of the page, select **New project**. +1. On the left sidebar, at the top, select **Create new...** (**{plus}**) and **New project/repository**. 1. Select **Create blank project**. 1. Enter the project details: - In the **Project name** field, enter the name of your project. The name must start with a lowercase or uppercase letter (`a-zA-Z`), digit (`0-9`), emoji, or underscore (`_`). It can also contain dots (`.`), pluses (`+`), dashes (`-`), or spaces. @@ -42,8 +41,7 @@ Anyone can [contribute a built-in template](../../development/project_templates. To create a project from a built-in template: -1. On the top bar, select **Main menu > Projects > View all projects**. -1. On the right of the page, select **New project**. +1. On the left sidebar, at the top, select **Create new...** (**{plus}**) and **New project/repository**. 1. Select **Create from template**. 1. Select the **Built-in** tab. 1. From the list of templates: @@ -73,8 +71,7 @@ Custom project templates are available at: - The [instance-level](../../user/admin_area/custom_project_templates.md) - The [group-level](../../user/group/custom_project_templates.md) -1. On the top bar, select **Main menu > Projects > View all projects**. -1. On the right of the page, select **New project**. +1. On the left sidebar, at the top, select **Create new...** (**{plus}**) and **New project/repository**. 1. Select **Create from template**. 1. Select the **Instance** or **Group** tab. 1. From the list of templates: @@ -99,8 +96,7 @@ HIPAA Audit Protocol published by the U.S Department of Health and Human Service To create a project from the HIPAA Audit Protocol template: -1. On the top bar, select **Main menu > Projects > View all projects**. -1. On the right of the page, select **New project**. +1. On the left sidebar, at the top, select **Create new...** (**{plus}**) and **New project/repository**. 1. Select **Create from template**. 1. Select the **Built-in** tab. 1. Locate the **HIPAA Audit Protocol** template: @@ -138,7 +134,7 @@ Prerequisites: [added to your GitLab account](../ssh.md#add-an-ssh-key-to-your-gitlab-account). - You must have permission to add new projects to a namespace. To check if you have permission: - 1. On the top bar, select **Main menu > Groups** and find your group. + 1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. 1. In the upper-right corner, confirm that **New project** is visible. Contact your GitLab administrator if you require permission. diff --git a/doc/user/project/members/index.md b/doc/user/project/members/index.md index 8b2cacf084e..7a1d9d6e6e3 100644 --- a/doc/user/project/members/index.md +++ b/doc/user/project/members/index.md @@ -118,8 +118,8 @@ Prerequisite: To add a user to a project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Project information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Manage > Members**. 1. Select **Invite members**. 1. If the user: @@ -176,8 +176,8 @@ Prerequisites: To add a group to a project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Project information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Manage > Members**. 1. Select **Invite a group**. 1. Select a group. 1. Select the highest [role](../../permissions.md) for users in the group. @@ -207,8 +207,8 @@ If the importing member's role in the target project is: To import users: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Project information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Manage > Members**. 1. Select **Import from a project**. 1. Select the project. You can view only the projects for which you're a maintainer. 1. Select **Import project members**. @@ -232,8 +232,8 @@ Prerequisites: To remove a member from a project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Project information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Manage > Members**. 1. Next to the project member you want to remove, select **Remove member**. 1. Optional. In the confirmation box, select the **Also unassign this user from related issues and merge requests** checkbox. @@ -269,8 +269,8 @@ You can filter and sort members in a project. ### Display inherited members -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Project information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Manage > Members**. 1. In the **Filter members** box, select `Membership` `=` `Inherited`. 1. Press <kbd>Enter</kbd>. @@ -278,8 +278,8 @@ You can filter and sort members in a project. ### Display direct members -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Project information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Manage > Members**. 1. In the **Filter members** box, select `Membership` `=` `Direct`. 1. Press <kbd>Enter</kbd>. @@ -301,8 +301,8 @@ You can sort members by **Account**, **Access granted**, **Max role**, or **Last GitLab users can request to become a member of a project. -1. On the top bar, select **Main menu > Projects** and find the project you want to be a member of. -1. By the project name, select **Request Access**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find the project you want to be a member of. +1. By the project's name, select **Request Access**.  @@ -325,8 +325,8 @@ Prerequisite: - You must be the project owner. -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > General**. 1. Expand **Visibility, project features, permissions**. 1. Under **Project visibility**, select **Users can request access**. 1. Select **Save changes**. diff --git a/doc/user/project/members/share_project_with_groups.md b/doc/user/project/members/share_project_with_groups.md index 1b1c4b6d9be..aadc27fb2d3 100644 --- a/doc/user/project/members/share_project_with_groups.md +++ b/doc/user/project/members/share_project_with_groups.md @@ -57,8 +57,8 @@ You can share a project with a group by inviting that group to the project. To invite a group to a project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Project information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Manage > Members**. 1. Select **Invite a group**. 1. **Select a group** you want to add to the project. 1. **Select a role** you want to assign to the group. @@ -98,8 +98,8 @@ For example, if a group member has the role of Developer, and the group is invit To view the maximum role assigned to a member: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Project information > Members**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Manage > Members**. 1. In the **Max role** column, view the user's maximum assigned role. ## View a group's shared projects @@ -108,7 +108,7 @@ In a group, a shared project is a project to which the group members gained acce To view a group's shared projects: -1. On the top bar, select **Main menu > Group** and find your group. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. 1. On the group page, select the **Shared projects** tab. A list of shared projects is displayed. diff --git a/doc/user/project/ml/experiment_tracking/index.md b/doc/user/project/ml/experiment_tracking/index.md index 9e7479fadc2..81c4bc20301 100644 --- a/doc/user/project/ml/experiment_tracking/index.md +++ b/doc/user/project/ml/experiment_tracking/index.md @@ -70,8 +70,8 @@ Prerequisites: To list the current active experiments, either go to `https/-/ml/experiments` or: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Packages & registries > Model experiments**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Deploy > Model experiments**. 1. To display all candidates that have been logged, along with their metrics, parameters, and metadata, select an experiment. 1. To display details for a candidate, select **Details**. diff --git a/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md b/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md index a97fc1171fc..606f0474cb1 100644 --- a/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md +++ b/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md @@ -53,8 +53,8 @@ this document for an [overview on DNS records](dns_concepts.md). To add your custom domain to GitLab Pages: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Pages**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Pages**. If this path is not visible, select **Deployments > Pages**. [This location is part of an experiment](../index.md#menu-position-test). @@ -165,10 +165,10 @@ If you're using Cloudflare, check #### 4. Verify the domain's ownership -Once you have added all the DNS records: +After you have added all the DNS records: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Pages**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Pages**. If this path is not visible, select **Deployments > Pages**. [This location is part of an experiment](../index.md#menu-position-test). @@ -262,8 +262,8 @@ meet these requirements. - To add the certificate at the time you add a new domain: - 1. On the top bar, select **Main menu > Projects** and find your project. - 1. On the left sidebar, select **Settings > Pages**. + 1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. + 1. Select **Settings > Pages**. If this path is not visible, select **Deployments > Pages**. [This location is part of an experiment](../index.md#menu-position-test). @@ -274,8 +274,8 @@ meet these requirements. - To add the certificate to a domain previously added: - 1. On the top bar, select **Main menu > Projects** and find your project. - 1. On the left sidebar, select **Settings > Pages**. + 1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. + 1. Select **Settings > Pages**. If this path is not visible, select **Deployments > Pages**. [This location is part of an experiment](../index.md#menu-position-test). @@ -308,8 +308,8 @@ domain (as long as you've set a valid certificate for it). To enable this setting: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Pages**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Pages**. If this path is not visible, select **Deployments > Pages**. [This location is part of an experiment](../index.md#menu-position-test). diff --git a/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md b/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md index 91633e01ad2..15152efb80c 100644 --- a/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md +++ b/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md @@ -42,8 +42,8 @@ For **self-managed** GitLab instances, make sure your administrator has Once you've met the requirements, enable Let's Encrypt integration: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Pages**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Pages**. If this path is not visible, select **Deployments > Pages**. [This location is part of an experiment](../index.md#menu-position-test). @@ -72,8 +72,8 @@ associated Pages domain. GitLab also renews it automatically. If you get an error **Something went wrong while obtaining the Let's Encrypt certificate**, first, make sure that your pages site is set to "Everyone" in your project's **Settings > General > Visibility**. This allows the Let's Encrypt Servers reach your pages site. Once this is confirmed, you can try obtaining the certificate again by following these steps: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Pages**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Pages**. If this path is not visible, select **Deployments > Pages**. [This location is part of an experiment](../index.md#menu-position-test). @@ -90,8 +90,8 @@ If you get an error **Something went wrong while obtaining the Let's Encrypt cer If you've enabled Let's Encrypt integration, but a certificate is absent after an hour and you see the message, "GitLab is obtaining a Let's Encrypt SSL certificate for this domain. This process can take some time. Please try again later.", try to remove and add the domain for GitLab Pages again by following these steps: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Pages**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Pages**. If this path is not visible, select **Deployments > Pages**. [This location is part of an experiment](../index.md#menu-position-test). diff --git a/doc/user/project/pages/getting_started/pages_ci_cd_template.md b/doc/user/project/pages/getting_started/pages_ci_cd_template.md index 17618146350..167c72fdc89 100644 --- a/doc/user/project/pages/getting_started/pages_ci_cd_template.md +++ b/doc/user/project/pages/getting_started/pages_ci_cd_template.md @@ -16,8 +16,7 @@ Use a `.gitlab-ci.yml` template when you have an existing project that you want Your GitLab repository should contain files specific to an SSG, or plain HTML. After you complete these steps, you may have to do additional configuration for the Pages site to generate properly. -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select the project's name. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. 1. From the **Add** (**{plus}**) dropdown list, select **New file**. 1. From the **Select a template type** dropdown list, select `.gitlab-ci.yml`. 1. From the **Apply a template** dropdown list, in the **Pages** section, select the name of your SSG. diff --git a/doc/user/project/pages/getting_started/pages_ui.md b/doc/user/project/pages/getting_started/pages_ui.md index 00635fe6db2..3888cafbab2 100644 --- a/doc/user/project/pages/getting_started/pages_ui.md +++ b/doc/user/project/pages/getting_started/pages_ui.md @@ -33,8 +33,8 @@ a pipeline deploys your Pages website. To complete the setup and generate a GitLab Pages deployment: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Pages**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Pages**. If this path is not visible, select **Deployments > Pages**. [This location is part of an experiment](../index.md#menu-position-test). diff --git a/doc/user/project/pages/introduction.md b/doc/user/project/pages/introduction.md index f7d273d198d..73bfe018a7d 100644 --- a/doc/user/project/pages/introduction.md +++ b/doc/user/project/pages/introduction.md @@ -66,8 +66,8 @@ You can configure redirects for your site using a `_redirects` file. For more in To remove your pages: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Pages**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Pages**. If this path is not visible, select **Deployments > Pages**. [This location is part of an experiment](index.md#menu-position-test). @@ -108,8 +108,8 @@ By default, every project in a group shares the same domain, for example, `group To ensure your project uses a unique Pages domain, enable the unique domains feature for the project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Pages**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Pages**. 1. Select the **Use unique domain** checkbox. 1. Select **Save changes**. diff --git a/doc/user/project/releases/index.md b/doc/user/project/releases/index.md index d0c44b7e837..6bcc57d5916 100644 --- a/doc/user/project/releases/index.md +++ b/doc/user/project/releases/index.md @@ -74,8 +74,8 @@ Prerequisites: To create a release in the Releases page: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Deployments > Releases** and select **New release**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. On the left sidebar, select **Build > Releases** and select **New release**. 1. From the [**Tag name**](release_fields.md#tag-name) dropdown list, either: - Select an existing Git tag. Selecting an existing tag that is already associated with a release results in a validation error. @@ -215,8 +215,8 @@ To delete a release, use either the In the UI: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Deployments > Releases**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. On the left sidebar, select **Deploy > Releases**. 1. In the upper-right corner of the release you want to delete, select **Edit this release** (**{pencil}**). 1. On the **Edit Release** page, select **Delete**. diff --git a/doc/user/project/repository/code_suggestions.md b/doc/user/project/repository/code_suggestions.md index f8ed115054f..63dee06c042 100644 --- a/doc/user/project/repository/code_suggestions.md +++ b/doc/user/project/repository/code_suggestions.md @@ -56,7 +56,7 @@ Usage of Code Suggestions is governed by the [GitLab Testing Agreement](https:// Each user can enable Code Suggestions for themselves: -1. On the top bar, in the upper-right corner, select your avatar. +1. On the left sidebar, select your avatar. 1. On the left sidebar, select **Preferences**. 1. In the **Code Suggestions** section, select **Enable Code Suggestions**. 1. Select **Save changes**. diff --git a/doc/user/project/repository/file_finder.md b/doc/user/project/repository/file_finder.md index e22dc549a4a..dece959bdc9 100644 --- a/doc/user/project/repository/file_finder.md +++ b/doc/user/project/repository/file_finder.md @@ -14,8 +14,8 @@ File finder is powered by the [`fuzzaldrin-plus`](https://github.com/jeancroy/fu To search for a file: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Repository > Files**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Code > Repository**. 1. In the upper right, select **Find file**. 1. In the search box, start typing the filename. 1. From the dropdown list, select the file. diff --git a/doc/user/project/service_desk.md b/doc/user/project/service_desk.md index 249a83ff022..8d525965f96 100644 --- a/doc/user/project/service_desk.md +++ b/doc/user/project/service_desk.md @@ -59,8 +59,8 @@ Prerequisites: To enable Service Desk in your project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > General**. 1. Expand **Service Desk**. 1. Turn on the **Activate Service Desk** toggle. 1. Optional. Complete the fields. @@ -171,8 +171,8 @@ Prerequisite: To use a custom description template with Service Desk: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > General**. 1. Expand **Service Desk**. 1. From the dropdown list **Template to append to all Service Desk issues**, search or select your template. @@ -194,8 +194,8 @@ this name in the `From` header. The default display name is `GitLab Support Bot` To edit the custom email display name: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > General**. 1. Expand **Service Desk**. 1. Below **Email display name**, enter a new name. 1. Select **Save changes**. @@ -469,8 +469,8 @@ Prerequisites: - You must have configured a [custom mailbox](#configure-a-custom-mailbox). -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > General**. 1. Expand **Service Desk**. 1. Below **Email address suffix**, enter the suffix to use. 1. Select **Save changes**. @@ -627,8 +627,8 @@ In these issues, you can also see our friendly neighborhood [Support Bot](#suppo To check what the Service Desk email address is for your project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Issues > Service Desk**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Service Desk**. The email address is available at the top of the issue list. @@ -679,8 +679,8 @@ Prerequisites: To view Service Desk issues: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Issues > Service Desk**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Monitor > Service Desk**. ### Email contents and formatting diff --git a/doc/user/project/system_notes.md b/doc/user/project/system_notes.md index 1eee4364d95..56873c328fa 100644 --- a/doc/user/project/system_notes.md +++ b/doc/user/project/system_notes.md @@ -31,23 +31,23 @@ The filtering options are: ### On an epic -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Epics** (**{epic}**). +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Plan > Epics**. 1. Identify your desired epic, and select its title. 1. Go to the **Activity** section. 1. For **Sort or filter**, select **Show all activity**. ### On an issue -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Issues** and find your issue. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Plan > Issues** and find your issue. 1. Go to **Activity**. 1. For **Sort or filter**, select **Show all activity**. ### On a merge request -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Merge requests** and find your merge request. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Code > Merge requests** and find your merge request. 1. Go to **Activity**. 1. For **Sort or filter**, select **Show all activity**. diff --git a/doc/user/search/index.md b/doc/user/search/index.md index 2d0d1fa72bf..4a0d9210913 100644 --- a/doc/user/search/index.md +++ b/doc/user/search/index.md @@ -106,7 +106,7 @@ For example, the search query: - `gitlab-org/gitlab` searches for the `gitlab` project in the `gitlab-org` namespace. - `gitlab-org/` displays autocomplete suggestions for projects that belong to the `gitlab-org` namespace. -### Search archived projects +### Exclude archived projects from project search results > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121981) in GitLab 16.1 [with a flag](../../administration/feature_flags.md) named `search_projects_hide_archived`. Disabled by default. @@ -114,7 +114,9 @@ FLAG: On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../../administration/feature_flags.md) named `search_projects_hide_archived`. On GitLab.com, this feature is not available. -By default, archived projects are excluded from the search results. To include archived projects, add the parameter `include_archived=true` to the URL. +Archived projects are included in project search results by default. To exclude archived projects, ensure the `search_projects_hide_archived` flag is enabled. + +To include archived projects with `search_projects_hide_archived` enabled, you must add the parameter `include_archived=true` to the URL. ## Search for a SHA |