diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-15 00:10:36 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-15 00:10:36 +0300 |
commit | beabc7d164276a8bb35c2b497a0c4dc0dc824e3c (patch) | |
tree | be60f7d352225862e3404fe89c39374fd4e64a1e /doc | |
parent | 14160fad80415337f8c08755af53ee994b4a7518 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/packages/index.md | 85 | ||||
-rw-r--r-- | doc/api/saml.md | 37 | ||||
-rw-r--r-- | doc/api/scim.md | 34 | ||||
-rw-r--r-- | doc/user/crm/index.md | 40 |
4 files changed, 172 insertions, 24 deletions
diff --git a/doc/administration/packages/index.md b/doc/administration/packages/index.md index f0f238aa5ba..b735204c323 100644 --- a/doc/administration/packages/index.md +++ b/doc/administration/packages/index.md @@ -57,6 +57,91 @@ When downloading packages as dependencies in downstream projects, many requests Packages API. You may therefore reach enforced user and IP rate limits. To address this issue, you can define specific rate limits for the Packages API. For more details, see [Package Registry Rate Limits](../../user/admin_area/settings/package_registry_rate_limits.md). +## Enable or disable the Package Registry + +The Package Registry is enabled by default. To disable it: + +::Tabs + +:::TabTitle Linux package (Omnibus) + +1. Edit `/etc/gitlab/gitlab.rb`: + + ```ruby + # Change to true to enable packages - enabled by default if not defined + gitlab_rails['packages_enabled'] = false + ``` + +1. Save the file and reconfigure GitLab: + + ```shell + sudo gitlab-ctl reconfigure + ``` + +:::TabTitle Helm chart (Kubernetes) + +1. Export the Helm values: + + ```shell + helm get values gitlab > gitlab_values.yaml + ``` + +1. Edit `gitlab_values.yaml`: + + ```yaml + global: + appConfig: + packages: + enabled: false + ``` + +1. Save the file and apply the new values: + + ```shell + helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab + ``` + +:::TabTitle Docker + +1. Edit `docker-compose.yml`: + + ```yaml + version: "3.6" + services: + gitlab: + environment: + GITLAB_OMNIBUS_CONFIG: | + gitlab_rails['packages_enabled'] = false + ``` + +1. Save the file and restart GitLab: + + ```shell + docker compose up -d + ``` + +:::TabTitle Self-compiled (source) + +1. Edit `/home/git/gitlab/config/gitlab.yml`: + + ```yaml + production: &base + packages: + enabled: false + ``` + +1. Save the file and restart GitLab: + + ```shell + # For systems running systemd + sudo systemctl restart gitlab.target + + # For systems running SysV init + sudo service gitlab restart + ``` + +::EndTabs + ## Change the storage path By default, the packages are stored locally, but you can change the default diff --git a/doc/api/saml.md b/doc/api/saml.md index 6b2e7cffaab..b1d7692fbaf 100644 --- a/doc/api/saml.md +++ b/doc/api/saml.md @@ -22,7 +22,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:------------------|:--------|:---------|:----------------------| -| `id` | integer | Yes | Group ID for the group to return SAML identities. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | If successful, returns [`200`](rest/index.md#status-codes) and the following response attributes: @@ -49,6 +49,36 @@ Example response: ] ``` +## Get a single SAML identity + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123591) in GitLab 16.1. + +```plaintext +GET /groups/:id/saml/:uid +``` + +Supported attributes: + +| Attribute | Type | Required | Description | +| --------- | -------------- | -------- | ------------------------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `uid` | string | yes | External UID of the user. | + +Example request: + +```shell +curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/saml/sydney_jones" --header "<PRIVATE TOKEN>" +``` + +Example response: + +```json +{ + "extern_uid": "4", + "user_id": 48 +} +``` + ## Update `extern_uid` field for a SAML identity Update `extern_uid` field for a SAML identity: @@ -58,13 +88,14 @@ Update `extern_uid` field for a SAML identity: | `id/externalId` | `extern_uid` | ```plaintext -PATCH groups/:groups_id/saml/:uid +PATCH /groups/:id/saml/:uid ``` -Parameters: +Supported attributes: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ------------------------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | | `uid` | string | yes | External UID of the user. | Example request: diff --git a/doc/api/scim.md b/doc/api/scim.md index 6e022afb2f5..df0d90756d2 100644 --- a/doc/api/scim.md +++ b/doc/api/scim.md @@ -28,7 +28,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:------------------|:--------|:---------|:----------------------| -| `id` | integer | Yes | Return SCIM identities for the given group ID. | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | If successful, returns [`200`](rest/index.md#status-codes) and the following response attributes: @@ -58,6 +58,37 @@ curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/scim/ --header "PRIVATE-TOKEN: <PRIVATE-TOKEN>" ``` +## Get a single SCIM identity + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123591) in GitLab 16.1. + +```plaintext +GET /groups/:id/scim/:uid +``` + +Supported attributes: + +| Attribute | Type | Required | Description | +| --------- | ------- | -------- | ------------------------- | +| `id` | integer | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `uid` | string | yes | External UID of the user. | + +Example request: + +```shell +curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/scim/sydney_jones" --header "<PRIVATE TOKEN>" +``` + +Example response: + +```json +{ + "extern_uid": "4", + "user_id": 48, + "active": true +} +``` + ## Update `extern_uid` field for a SCIM identity > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227841) in GitLab 15.5. @@ -76,6 +107,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ------------------------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | | `uid` | string | yes | External UID of the user. | Example request: diff --git a/doc/user/crm/index.md b/doc/user/crm/index.md index 54e87118361..c81cf6762e3 100644 --- a/doc/user/crm/index.md +++ b/doc/user/crm/index.md @@ -36,8 +36,8 @@ you must enable CRM features for the subgroup. To enable customer relations management in a group or subgroup: -1. On the top bar, select **Main menu > Groups** and find your group or subgroup. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group or subgroup. +1. Select **Settings > General**. 1. Expand the **Permissions and group features** section. 1. Select **Customer relations is enabled**. 1. Select **Save changes**. @@ -52,8 +52,8 @@ Prerequisites: To view a group's contacts: -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Customer relations > Contacts**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. Select **Plan > Customer contacts**. ![Contacts list](crm_contacts_v14_10.png) @@ -65,8 +65,8 @@ Prerequisites: To create a contact: -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Customer relations > Contacts**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. Select **Plan > Customer contacts**. 1. Select **New contact**. 1. Complete all required fields. 1. Select **Create new contact**. @@ -82,8 +82,8 @@ Prerequisites: To edit an existing contact: -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Customer relations > Contacts**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. Select **Plan > Customer contacts**. 1. Next to the contact you wish to edit, select **Edit** (**{pencil}**). 1. Edit the required fields. 1. Select **Save changes**. @@ -100,8 +100,8 @@ Each contact can be in one of two states: To change the state of a contact: -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Customer relations > Contacts**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. Select **Plan > Customer contacts**. 1. Next to the contact you wish to edit, select **Edit** (**{pencil}**). 1. Select or clear the **Active** checkbox. 1. Select **Save changes**. @@ -116,8 +116,8 @@ Prerequisites: To view a group's organizations: -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Customer relations > Organizations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. Select **Plan > Customer organizations**. ![Organizations list](crm_organizations_v14_10.png) @@ -129,8 +129,8 @@ Prerequisites: To create an organization: -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Customer relations > Organizations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. Select **Plan > Customer organizations**. 1. Select **New organization**. 1. Complete all required fields. 1. Select **Create new organization**. @@ -146,8 +146,8 @@ Prerequisites: To edit an existing organization: -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Customer relations > Organizations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. Select **Plan > Customer organizations**. 1. Next to the organization you wish to edit, select **Edit** (**{pencil}**). 1. Edit the required fields. 1. Select **Save changes**. @@ -168,8 +168,8 @@ Prerequisites: To view a contact's issues, select a contact from the issue sidebar, or: -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Customer relations > Contacts**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. Select **Plan > Customer contacts**. 1. Next to the contact whose issues you wish to view, select **View issues** (**{issues}**). ### View issues linked to an organization @@ -180,8 +180,8 @@ Prerequisites: To view an organization's issues: -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Customer relations > Organizations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. Select **Plan > Customer organizations**. 1. Next to the organization whose issues you wish to view, select **View issues** (**{issues}**). ### View contacts linked to an issue |