Commit cbb7ee56 authored by Evan Read's avatar Evan Read

Merge branch 'group-level-integrations-documentation' into 'master'

Docs: Group-level management of integrations

See merge request gitlab-org/gitlab!47384
parents 7294a77a df0ed0d2
...@@ -8,51 +8,87 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,51 +8,87 @@ info: To determine the technical writer assigned to the Stage/Group associated w
Project integrations can be configured and enabled by project administrators. As a GitLab instance 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 administrator, you can set default configuration parameters for a given integration that all projects
can inherit and use. This enables the integration for all projects that are not already using custom can inherit and use, enabling the integration for all projects that are not already using custom
settings. settings.
You can update these default settings at any time, changing the settings used for all projects that You can update these default settings at any time, changing the settings used for all projects that
are set to use instance-level defaults. Updating the default settings also enables the integration are set to use instance-level or group-level defaults. Updating the default settings also enables the integration
for all projects that didn't have it already enabled. for all projects that didn't have it already enabled.
Only the complete settings for an integration can be inherited. Per-field inheritance is Only the complete settings for an integration can be inherited. Per-field inheritance is [planned](https://gitlab.com/groups/gitlab-org/-/epics/2137).
[planned](https://gitlab.com/groups/gitlab-org/-/epics/2137) as is
[group-level management](https://gitlab.com/groups/gitlab-org/-/epics/2543) of integration settings.
## Manage instance-level default settings for a project integration **(CORE ONLY)** ## Manage instance-level default settings for a project integration **(CORE ONLY)**
> [Introduced in](https://gitlab.com/groups/gitlab-org/-/epics/2137) GitLab 13.3. > - [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. Navigate to **Admin Area > Settings > Integrations**. 1. Navigate to **Admin Area > Settings > Integrations**.
1. Select a project integration. 1. Select an integration.
1. Enter configuration details and click **Save changes**. 1. Enter configuration details and click **Save changes**.
CAUTION: **Caution:** CAUTION: **Caution:**
This may affect all or most of the projects on your GitLab instance. Please review the details This may affect all or most of the groups and projects on your GitLab instance. Please review the details
below. below.
If this is the first time you are setting up instance-level settings for an integration: If this is the first time you are setting up instance-level settings for an integration:
- The integration is enabled for all projects that don't already have this integration configured, - The integration is enabled for all groups and projects that don't already have this integration configured,
if you have the **Enable integration** toggle turned on in the instance-level settings. 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 - Groups and projects that already have the integration configured are not affected, but can choose to use the
inherited settings at any time. inherited settings at any time.
When you make further changes to the instance defaults: When you make further changes to the instance defaults:
- They are immediately applied to all projects that have the integration set to use default settings. - They are immediately applied to all groups and projects that have the integration set to use default settings.
- They are immediately applied to newer projects, created since you last saved defaults for the - They are immediately applied to newer groups and projects, created since you last saved defaults for the
integration. If your instance-level default setting has the **Enable integration** toggle turned integration. If your instance-level default setting has the **Enable integration** toggle turned
on, the integration is automatically enabled for all such projects. on, the integration is automatically enabled for all such groups and projects.
- Projects with custom settings selected for the integration are not immediately affected and may - Groups and projects with custom settings selected for the integration are not immediately affected and may
choose to use the latest defaults at any time. choose to use the latest defaults at any time.
Only the complete settings for an integration can be inherited. Per-field inheritance Only the complete settings for an integration can be inherited. Per-field inheritance
is [planned](https://gitlab.com/groups/gitlab-org/-/epics/2137). This would allow is [planned](https://gitlab.com/groups/gitlab-org/-/epics/2137). This would allow
administrators to update settings inherited by projects without enabling the administrators to update settings inherited by groups and projects without enabling the
integration on all non-configured projects by default. integration on all non-configured groups and projects by default.
## Use instance-level default settings for a project integration ## Manage group-level default settings for a project integration
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2543) in GitLab 13.6.
1. Navigate to the group's **Settings > Integrations**.
1. Select an integration.
1. Enter configuration details and click **Save changes**.
CAUTION: **Caution:**
This may affect all or most of the subgroups and projects belonging to the group. Please review the details below.
If this is the first time you are setting up group-level settings for an integration:
- The integration is enabled for all subgroups and projects belonging to the group that don't already have
this integration configured, if you have the **Enable integration** toggle turned on in the group-level
settings.
- Subgroups and 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 group defaults:
- They are immediately applied to all subgroups and projects belonging to the group that have the integration
set to use default settings.
- They are immediately applied to newer subgroups and projects, created since you last saved defaults for the
integration. If your group-level default setting has the **Enable integration** toggle turned on,
the integration is automatically enabled for all such subgroups and projects.
- Subgroups and projects with custom settings selected for the integration are not immediately affected and
may choose to use the latest defaults at any time.
Only the complete settings for an integration can be inherited. Per-field inheritance
is [planned](https://gitlab.com/groups/gitlab-org/-/epics/2137). This would allow
administrators to update settings inherited by subgroups and projects without enabling the
integration on all non-configured groups and projects by default.
## Use instance-level or group-level default settings for a project integration
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2543) in GitLab 13.6 for group-level settings.
1. Navigate to **Project > Settings > Integrations**. 1. Navigate to **Project > Settings > Integrations**.
1. Choose the integration you want to enable or update. 1. Choose the integration you want to enable or update.
...@@ -60,9 +96,9 @@ integration on all non-configured projects by default. ...@@ -60,9 +96,9 @@ integration on all non-configured projects by default.
1. Ensure the toggle is set to **Enable integration**. 1. Ensure the toggle is set to **Enable integration**.
1. Click **Save changes**. 1. Click **Save changes**.
## Use custom settings for a project integration ## Use custom settings for a group or project integration
1. Navigate to project's **Settings > Integrations**. 1. Navigate to project or group's **Settings > Integrations**.
1. Choose the integration you want to enable or update. 1. Choose the integration you want to enable or update.
1. From the drop-down, select **Use custom settings**. 1. From the drop-down, select **Use custom settings**.
1. Ensure the toggle is set to **Enable integration** and enter all required settings. 1. Ensure the toggle is set to **Enable integration** and enter all required settings.
......
...@@ -745,6 +745,7 @@ To enable prevent project forking: ...@@ -745,6 +745,7 @@ To enable prevent project forking:
- **Audit Events**: View [Audit Events](../../administration/audit_events.md) - **Audit Events**: View [Audit Events](../../administration/audit_events.md)
for the group. **(STARTER ONLY)** for the group. **(STARTER ONLY)**
- **Pipelines quota**: Keep track of the [pipeline quota](../admin_area/settings/continuous_integration.md) for the group. - **Pipelines quota**: Keep track of the [pipeline quota](../admin_area/settings/continuous_integration.md) for the group.
- **Integrations**: Configure [integrations](../admin_area/settings/project_integration_management.md) for your group.
#### Storage usage quota **(STARTER)** #### Storage usage quota **(STARTER)**
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment