Commit 33670bf0 authored by Evan Read's avatar Evan Read

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

Group-level integration documentation

See merge request gitlab-org/gitlab!44279
parents 023a6086 6c1faaac
......@@ -4,40 +4,76 @@ 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 integration management
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.
You can update these default settings at any time, changing the settings used for all
projects that 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.
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.
Only the complete settings for an integration can be inherited. Per-field inheritance is [planned](https://gitlab.com/groups/gitlab-org/-/epics/2137).
## Manage default settings for a project integration
## Manage instance-level default settings for a project integration **(CORE ONLY)**
> [Introduced in](https://gitlab.com/groups/gitlab-org/-/epics/2137) GitLab 13.3.
1. Navigate to **Admin Area > Settings > Integrations**.
1. Select a project integration.
1. Select an 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.
This may affect all or most of the groups and 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.
- The integration is enabled for all groups and projects that do not already have this integration configured if you have the **Enable integration** toggle turned on in the instance-level settings.
- Groups 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 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.
- They are immediately applied to all groups and projects that have the integration set to use default settings.
- 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 on, the integration is automatically enabled for
all such groups and projects.
- 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.
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 groups and projects without enabling the
integration on all non-configured groups and projects by default.
## Manage group-level default settings for a project integration
> [Introduced in](https://gitlab.com/groups/gitlab-org/-/epics/2543) GitLab 13.5.
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:
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.
- The integration is enabled for all subgroups and projects belonging to the group that do not 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.
## Use instance-level default settings for a project integration
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
1. Navigate to **Project > Settings > Integrations**.
1. Choose the integration you want to enable or update.
......@@ -45,9 +81,9 @@ It is only possible to inherit the complete settings for an integration. Per-fie
1. Ensure the toggle is set to **Enable integration**.
1. Click **Save changes**.
## Use custom settings for a project integration
## Use custom settings for a group or project integration
1. Navigate to **Project > Settings > Integrations**.
1. Navigate to project or group's **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.
......
......@@ -697,6 +697,7 @@ To enable prevent project forking:
- **Audit Events**: View [Audit Events](../../administration/audit_events.md)
for the group. **(STARTER ONLY)**
- **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)**
......
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