diff options
Diffstat (limited to 'doc/user/admin_area/settings')
| -rw-r--r-- | doc/user/admin_area/settings/account_and_limit_settings.md | 26 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/gitaly_timeouts.md | 4 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/img/import_export_rate_limits_v13_2.png | bin | 54802 -> 18320 bytes | |||
| -rw-r--r-- | doc/user/admin_area/settings/index.md | 11 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/instance_template_repository.md | 19 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/project_integration_management.md | 54 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/push_event_activities_limit.md | 3 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/visibility_and_access_controls.md | 7 |
8 files changed, 92 insertions, 32 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 167016f1cb5..4651a548ff9 100644 --- a/doc/user/admin_area/settings/account_and_limit_settings.md +++ b/doc/user/admin_area/settings/account_and_limit_settings.md @@ -1,4 +1,7 @@ --- +stage: Create +group: Source Code +info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers" type: reference --- @@ -26,20 +29,6 @@ If you choose a size larger than what is currently configured for the web server you will likely get errors. See the [troubleshooting section](#troubleshooting) for more details. -## Maximum namespace storage size - -This sets a maximum size limit on each namespace. The following are included in the namespace size: - -- Repository -- Wiki -- LFS objects -- Build artifacts -- Packages -- Snippets - -NOTE: **Note:** -This limit is not currently enforced but will be in a future release. - ## Repository size limit **(STARTER ONLY)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/740) in [GitLab Enterprise Edition 8.12](https://about.gitlab.com/releases/2016/09/22/gitlab-8-12-released/#limit-project-size-ee). @@ -86,7 +75,8 @@ The first push of a new project, including LFS objects, will be checked for size and **will** be rejected if the sum of their sizes exceeds the maximum allowed repository size. -**Note:** The repository size limit includes repository files and LFS, and does not include artifacts. +NOTE: **Note:** +The repository size limit includes repository files and LFS, and does not include artifacts. For details on manually purging files, see [reducing the repository size using Git](../../project/repository/reducing_the_repo_size_using_git.md). @@ -159,19 +149,19 @@ To do this: ### Enable or disable optional enforcement of Personal Access Token expiry Feature **(CORE ONLY)** -Optional Enforcement of Personal Access Token Expiry is under development and not ready for production use. It is deployed behind a feature flag that is **disabled by default**. +Optional Enforcement of Personal Access Token Expiry is deployed behind a feature flag and is **disabled by default**. [GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md) can enable it for your instance from the [rails console](../../../administration/feature_flags.md#start-the-gitlab-rails-console). To enable it: ```ruby -Feature.enable(:enforce_personal_access_token_expiration) +Feature.enable(:enforce_pat_expiration) ``` To disable it: ```ruby -Feature.disable(:enforce_personal_access_token_expiration) +Feature.disable(:enforce_pat_expiration) ``` ## Disabling user profile name changes **(PREMIUM ONLY)** diff --git a/doc/user/admin_area/settings/gitaly_timeouts.md b/doc/user/admin_area/settings/gitaly_timeouts.md index 68f359368f0..2003d02c9b3 100644 --- a/doc/user/admin_area/settings/gitaly_timeouts.md +++ b/doc/user/admin_area/settings/gitaly_timeouts.md @@ -1,4 +1,8 @@ --- +stage: Create +group: Gitaly +info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers" +type: reference type: reference --- diff --git a/doc/user/admin_area/settings/img/import_export_rate_limits_v13_2.png b/doc/user/admin_area/settings/img/import_export_rate_limits_v13_2.png Binary files differindex 78c94b3803c..76015ce0ee3 100644 --- a/doc/user/admin_area/settings/img/import_export_rate_limits_v13_2.png +++ b/doc/user/admin_area/settings/img/import_export_rate_limits_v13_2.png diff --git a/doc/user/admin_area/settings/index.md b/doc/user/admin_area/settings/index.md index 8c1e82f838b..db6dbb7f38b 100644 --- a/doc/user/admin_area/settings/index.md +++ b/doc/user/admin_area/settings/index.md @@ -4,7 +4,7 @@ type: index # Admin Area settings **(CORE ONLY)** -As an administrator of a GitLab self-managed instance, you can manage the behavior of your deployment. To do so, select **{admin}** **Admin Area > Settings**. +As an administrator of a GitLab self-managed instance, you can manage the behavior of your deployment. To do so, select **Admin Area > Settings**. The admin area is not accessible on GitLab.com, and settings can only be changed by the GitLab.com administrators. See the [GitLab.com settings](../../gitlab_com/index.md) @@ -12,8 +12,7 @@ documentation for all current settings and limits on the GitLab.com instance. ## General -Access the default page for admin area settings by navigating to -**{admin}** **Admin Area > Settings > General**: +Access the default page for admin area settings by navigating to **Admin Area > Settings > General**: | Option | Description | | ------ | ----------- | @@ -62,7 +61,7 @@ Access the default page for admin area settings by navigating to | ------ | ----------- | | [Continuous Integration and Deployment](continuous_integration.md) | Auto DevOps, runners and job artifacts. | | [Required pipeline configuration](continuous_integration.md#required-pipeline-configuration-premium-only) **(PREMIUM ONLY)** | Set an instance-wide auto included [pipeline configuration](../../../ci/yaml/README.md). This pipeline configuration will be run after the project's own configuration. | -| [Package Registry](continuous_integration.md#package-registry-configuration-premium-only) **(PREMIUM ONLY)**| Settings related to the use and experience of using GitLab's Package Registry. Note there are [risks involved](./../../packages/container_registry/index.md#use-with-external-container-registries) in enabling some of these settings. | +| [Package Registry](continuous_integration.md#package-registry-configuration-premium-only) | Settings related to the use and experience of using GitLab's Package Registry. Note there are [risks involved](./../../packages/container_registry/index.md#use-with-external-container-registries) in enabling some of these settings. | ## Reporting @@ -90,13 +89,13 @@ Access the default page for admin area settings by navigating to | [User and IP rate limits](user_and_ip_rate_limits.md) | Configure limits for web and API requests. | | [Outbound requests](../../../security/webhooks.md) | Allow requests to the local network from hooks and services. | | [Protected Paths](protected_paths.md) | Configure paths to be protected by Rack Attack. | -| [Incident Management](../../incident_management/index.md) Limits | Configure limits on the number of inbound alerts able to be sent to a project. | +| [Incident Management](../../../operations/incident_management/index.md) Limits | Configure limits on the number of inbound alerts able to be sent to a project. | ## Geo | Option | Description | | ------ | ----------- | -| Geo | Geo allows you to replicate your GitLab instance to other geographical locations. Redirects to **{admin}** **Admin Area >** **{location-dot}** **Geo >** **{settings}** **Settings**, and will no longer be available at **{admin}** **Admin Area >** **{settings}** **Settings >** **{location-dot}** **Geo** in [GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/36896). | +| Geo | Geo allows you to replicate your GitLab instance to other geographical locations. Redirects to **Admin Area > Geo > Settings**, and will no longer be available at **Admin Area > Settings > Geo** in [GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/36896). | ## Preferences diff --git a/doc/user/admin_area/settings/instance_template_repository.md b/doc/user/admin_area/settings/instance_template_repository.md index ae56c67f0ab..97380b93295 100644 --- a/doc/user/admin_area/settings/instance_template_repository.md +++ b/doc/user/admin_area/settings/instance_template_repository.md @@ -1,4 +1,7 @@ --- +stage: Create +group: Source Code +info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers" type: reference --- @@ -30,12 +33,13 @@ Templates must be added to a specific subdirectory in the repository, corresponding to the kind of template. The following types of custom templates are supported: -| Type | Directory | Extension | -| :---------------: | :-----------: | :-----------: | -| `Dockerfile` | `Dockerfile` | `.dockerfile` | -| `.gitignore` | `gitignore` | `.gitignore` | -| `.gitlab-ci.yml` | `gitlab-ci` | `.yml` | -| `LICENSE` | `LICENSE` | `.txt` | +| Type | Directory | Extension | +| :---------------: | :-----------: | :-----------: | +| `Dockerfile` | `Dockerfile` | `.dockerfile` | +| `.gitignore` | `gitignore` | `.gitignore` | +| `.gitlab-ci.yml` | `gitlab-ci` | `.yml` | +| `LICENSE` | `LICENSE` | `.txt` | +| `metrics-dashboard.yml` | `metrics-dashboards` | `.yml` | Each template must go in its respective subdirectory, have the correct extension and not be empty. So, the hierarchy should look like this: @@ -54,6 +58,9 @@ extension and not be empty. So, the hierarchy should look like this: |-- LICENSE |-- custom_license.txt |-- another_license.txt +|-- metrics-dashboards + |-- custom_metrics-dashboard.yml + |-- another_metrics-dashboard.yml ``` Once this is established, the list of custom templates will be included when diff --git a/doc/user/admin_area/settings/project_integration_management.md b/doc/user/admin_area/settings/project_integration_management.md new file mode 100644 index 00000000000..e4fe7e36139 --- /dev/null +++ b/doc/user/admin_area/settings/project_integration_management.md @@ -0,0 +1,54 @@ +--- +stage: Create +group: Ecosystem +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +--- + +# Project integration management **(CORE ONLY)** + +> [Introduced in](https://gitlab.com/groups/gitlab-org/-/epics/2137) GitLab 13.3. + +Project integrations can be configured and enabled by project administrators. As a GitLab instance administrator, you can set default configuration parameters for a given integration that all projects can inherit and use, enabling the integration for all projects that are not already using custom settings. + +You can update these default settings at any time, changing the settings in use for all projects that are set to use instance-level defaults. This also enables the integration for all projects on which it was not already enabled. + +It is only possible to inherit the complete settings for an integration. Per-field inheritance is [planned](https://gitlab.com/groups/gitlab-org/-/epics/2137), as well as [group-level management](https://gitlab.com/groups/gitlab-org/-/epics/2543) of integration settings. + +## Manage default settings for a project integration + +1. Navigate to **Admin Area > Settings > Integrations**. +1. Select a project integration. +1. Enter configuration details and click **Save changes**. + +CAUTION: **Caution:** +This may affect all or most of the projects on your GitLab instance. Please review the details below. + +If this is the first time you are setting up instance-level settings for an integration: + +- The integration is enabled for all projects that do not already have this integration configured if you have the **Enable integration** toggle turned on in the instance-level settings. +- Projects that already have the integration configured are not affected, but can choose to use the inherited settings at any time. + +When you make further changes to the instance defaults: + +- They are immediately applied to all projects that have the integration set to use instance-level default settings. +- They are immediately applied to newer projects, created since you last saved defaults for the integration. + - If your instance-level default setting has the **Enable integration** toggle turned on, the integration is automatically enabled for all such projects. +- Projects with custom settings selected for the integration are not immediately affected and may choose to use the latest instance-level defaults at any time. + +It is only possible to inherit the complete settings for an integration. Per-field inheritance is [planned](https://gitlab.com/groups/gitlab-org/-/epics/2137). This would allow instance administrators to update settings inherited by projects without enabling the integration on all non-configured projects by default. + +## Use instance-level default settings for a project integration + +1. Navigate to **Project > Settings > Integrations**. +1. Choose the integration you want to enable or update. +1. From the drop-down, select **Use default settings**. +1. Ensure the toggle is set to **Enable integration**. +1. Click **Save changes**. + +## Use custom settings for a project integration + +1. Navigate to **Project > Settings > Integrations**. +1. Choose the integration you want to enable or update. +1. From the drop-down, select **Use custom settings**. +1. Ensure the toggle is set to **Enable integration** and enter all required settings. +1. Click **Save changes**. 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 bbc5ed04202..cf23ea12ef4 100644 --- a/doc/user/admin_area/settings/push_event_activities_limit.md +++ b/doc/user/admin_area/settings/push_event_activities_limit.md @@ -1,4 +1,7 @@ --- +stage: Create +group: Source Code +info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers" type: reference --- 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 92eeb6a04b7..e5c7947399d 100644 --- a/doc/user/admin_area/settings/visibility_and_access_controls.md +++ b/doc/user/admin_area/settings/visibility_and_access_controls.md @@ -1,4 +1,7 @@ --- +stage: Create +group: Source Code +info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers" type: reference --- @@ -64,7 +67,7 @@ To ensure only admin users can delete projects: 1. Check the **Default project deletion protection** checkbox. 1. Click **Save changes**. -## Default deletion adjourned period **(PREMIUM ONLY)** +## Default deletion delay **(PREMIUM ONLY)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32935) in GitLab 12.6. @@ -85,7 +88,7 @@ To change this period: 1. Select the desired option. 1. Click **Save changes**. -### Override default deletion adjourned period +### Override default deletion delayed period Alternatively, projects that are marked for removal can be deleted immediately. To do so: |
