@@ -37,23 +37,9 @@ Activity history for projects and individuals' profiles was limited to one year
...
@@ -37,23 +37,9 @@ Activity history for projects and individuals' profiles was limited to one year
## Number of webhooks
## Number of webhooks
A maximum number of webhooks applies to each GitLab.com tier. Limits apply to project and group webhooks.
On GitLab.com, the [maximum number of webhooks](../user/gitlab_com/index.md#maximum-number-of-webhooks) per project, and per group, is limited.
### Project Webhooks
To set this limit on a self-managed installation, run the following in the
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20730) in GitLab 12.6.
Check the [Maximum number of project webhooks (per tier)](../user/project/integrations/webhooks.md#maximum-number-of-project-webhooks-per-tier) section in the Webhooks page.
### Group Webhooks
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25129) in GitLab 12.9.
Check the [Maximum number of group webhooks (per tier)](../user/project/integrations/webhooks.md#maximum-number-of-group-webhooks-per-tier) section in the Webhooks page.
### Setting the limit on a self-hosted installation
To set this limit on a self-hosted installation, run the following in the
@@ -15,7 +15,7 @@ Epics are available only in the [Ultimate/Gold tier](https://about.gitlab.com/pr
...
@@ -15,7 +15,7 @@ Epics are available only in the [Ultimate/Gold tier](https://about.gitlab.com/pr
Gets all child epics of an epic.
Gets all child epics of an epic.
```
```plaintext
GET /groups/:id/epics/:epic_iid/epics
GET /groups/:id/epics/:epic_iid/epics
```
```
...
@@ -69,7 +69,7 @@ Example response:
...
@@ -69,7 +69,7 @@ Example response:
Creates an association between two epics, designating one as the parent epic and the other as the child epic. A parent epic can have multiple child epics. If the new child epic already belonged to another epic, it is unassigned from that previous parent.
Creates an association between two epics, designating one as the parent epic and the other as the child epic. A parent epic can have multiple child epics. If the new child epic already belonged to another epic, it is unassigned from that previous parent.
```
```plaintext
POST /groups/:id/epics/:epic_iid/epics
POST /groups/:id/epics/:epic_iid/epics
```
```
...
@@ -122,7 +122,7 @@ Example response:
...
@@ -122,7 +122,7 @@ Example response:
Creates a a new epic and associates it with provided parent epic. The response is LinkedEpic object.
Creates a a new epic and associates it with provided parent epic. The response is LinkedEpic object.
```
```plaintext
POST /groups/:id/epics/:epic_iid/epics
POST /groups/:id/epics/:epic_iid/epics
```
```
...
@@ -155,7 +155,7 @@ Example response:
...
@@ -155,7 +155,7 @@ Example response:
## Re-order a child epic
## Re-order a child epic
```
```plaintext
PUT /groups/:id/epics/:epic_iid/epics/:child_epic_id
PUT /groups/:id/epics/:epic_iid/epics/:child_epic_id
| `variables` | array | no | An array containing the variables available in the pipeline, matching the structure `[{ 'key' => 'UPLOAD_TO_S3', 'variable_type' => 'file', 'value' => 'true' }]` |
| `variables` | array | no | An array containing the variables available in the pipeline, matching the structure `[{ 'key' => 'UPLOAD_TO_S3', 'variable_type' => 'file', 'value' => 'true' }]` |
```
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/1/pipeline?ref=master"
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/1/pipeline?ref=master"
```
```
...
@@ -182,7 +182,7 @@ Example of response
...
@@ -182,7 +182,7 @@ Example of response
> [Introduced][ce-5837] in GitLab 8.11
> [Introduced][ce-5837] in GitLab 8.11
```
```plaintext
POST /projects/:id/pipelines/:pipeline_id/retry
POST /projects/:id/pipelines/:pipeline_id/retry
```
```
...
@@ -191,7 +191,7 @@ POST /projects/:id/pipelines/:pipeline_id/retry
...
@@ -191,7 +191,7 @@ POST /projects/:id/pipelines/:pipeline_id/retry
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `pipeline_id` | integer | yes | The ID of a pipeline |
| `pipeline_id` | integer | yes | The ID of a pipeline |
```
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/1/pipelines/46/retry"
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/1/pipelines/46/retry"
```
```
...
@@ -229,7 +229,7 @@ Response:
...
@@ -229,7 +229,7 @@ Response:
> [Introduced][ce-5837] in GitLab 8.11
> [Introduced][ce-5837] in GitLab 8.11
```
```plaintext
POST /projects/:id/pipelines/:pipeline_id/cancel
POST /projects/:id/pipelines/:pipeline_id/cancel
```
```
...
@@ -238,7 +238,7 @@ POST /projects/:id/pipelines/:pipeline_id/cancel
...
@@ -238,7 +238,7 @@ POST /projects/:id/pipelines/:pipeline_id/cancel
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `pipeline_id` | integer | yes | The ID of a pipeline |
| `pipeline_id` | integer | yes | The ID of a pipeline |
```
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/1/pipelines/46/cancel"
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/1/pipelines/46/cancel"
```
```
...
@@ -276,7 +276,7 @@ Response:
...
@@ -276,7 +276,7 @@ Response:
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22988) in GitLab 11.6.
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22988) in GitLab 11.6.
Add a new alias for a project. Responds with a 201 when successful,
Add a new alias for a project. Responds with a 201 when successful,
400 when there are validation errors (e.g. alias already exists):
400 when there are validation errors (e.g. alias already exists):
```
```plaintext
POST /project_aliases
POST /project_aliases
```
```
...
@@ -73,13 +73,13 @@ POST /project_aliases
...
@@ -73,13 +73,13 @@ POST /project_aliases
| `project_id` | integer/string | yes | The ID or path of the project. |
| `project_id` | integer/string | yes | The ID or path of the project. |
| `name` | string | yes | The name of the alias. Must be unique. |
| `name` | string | yes | The name of the alias. Must be unique. |
```
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/project_aliases"--form"project_id=1"--form"name=gitlab"
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/project_aliases"--form"project_id=1"--form"name=gitlab"
```
```
or
or
```
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/project_aliases"--form"project_id=gitlab-org/gitlab"--form"name=gitlab"
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/project_aliases"--form"project_id=gitlab-org/gitlab"--form"name=gitlab"
```
```
...
@@ -98,7 +98,7 @@ Example response:
...
@@ -98,7 +98,7 @@ Example response:
Removes a project aliases. Responds with a 204 when project alias
Removes a project aliases. Responds with a 204 when project alias
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
@@ -44,7 +44,7 @@ GET /projects/:id/variables/:key
...
@@ -44,7 +44,7 @@ GET /projects/:id/variables/:key
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `key` | string | yes | The `key` of a variable |
| `key` | string | yes | The `key` of a variable |
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `key` | string | yes | The `key` of a variable |
| `key` | string | yes | The `key` of a variable |
@@ -23,7 +23,7 @@ visibility setting keep this setting. You can read more about the change in the
...
@@ -23,7 +23,7 @@ visibility setting keep this setting. You can read more about the change in the
Get a list of project snippets.
Get a list of project snippets.
```
```plaintext
GET /projects/:id/snippets
GET /projects/:id/snippets
```
```
...
@@ -35,7 +35,7 @@ Parameters:
...
@@ -35,7 +35,7 @@ Parameters:
Get a single project snippet.
Get a single project snippet.
```
```plaintext
GET /projects/:id/snippets/:snippet_id
GET /projects/:id/snippets/:snippet_id
```
```
...
@@ -68,7 +68,7 @@ Parameters:
...
@@ -68,7 +68,7 @@ Parameters:
Creates a new project snippet. The user must have permission to create new snippets.
Creates a new project snippet. The user must have permission to create new snippets.
```
```plaintext
POST /projects/:id/snippets
POST /projects/:id/snippets
```
```
...
@@ -106,7 +106,7 @@ curl --request POST https://gitlab.com/api/v4/projects/:id/snippets \
...
@@ -106,7 +106,7 @@ curl --request POST https://gitlab.com/api/v4/projects/:id/snippets \
Updates an existing project snippet. The user must have permission to change an existing snippet.
Updates an existing project snippet. The user must have permission to change an existing snippet.
```
```plaintext
PUT /projects/:id/snippets/:snippet_id
PUT /projects/:id/snippets/:snippet_id
```
```
...
@@ -145,7 +145,7 @@ curl --request PUT https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id \
...
@@ -145,7 +145,7 @@ curl --request PUT https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id \
Deletes an existing project snippet. This returns a `204 No Content` status code if the operation was successfully or `404` if the resource was not found.
Deletes an existing project snippet. This returns a `204 No Content` status code if the operation was successfully or `404` if the resource was not found.
@@ -106,7 +106,6 @@ Example response (Dockerfile):
...
@@ -106,7 +106,6 @@ Example response (Dockerfile):
"name":"Binary",
"name":"Binary",
"content":"# This file is a template, and might need editing before it works on your project.\n# This Dockerfile installs a compiled binary into a bare system.\n# You must either commit your compiled binary into source control (not recommended)\n# or build the binary first as part of a CI/CD pipeline.\n\nFROM buildpack-deps:jessie\n\nWORKDIR /usr/local/bin\n\n# Change `app` to whatever your binary is called\nAdd app .\nCMD [\"./app\"]\n"
"content":"# This file is a template, and might need editing before it works on your project.\n# This Dockerfile installs a compiled binary into a bare system.\n# You must either commit your compiled binary into source control (not recommended)\n# or build the binary first as part of a CI/CD pipeline.\n\nFROM buildpack-deps:jessie\n\nWORKDIR /usr/local/bin\n\n# Change `app` to whatever your binary is called\nAdd app .\nCMD [\"./app\"]\n"
| `KUBECONFIG` | Path to a file containing `kubeconfig` for this deployment. CA bundle would be embedded if specified. This config also embeds the same token defined in `KUBE_TOKEN` so you likely will only need this variable. This variable name is also automatically picked up by `kubectl` so you won't actually need to reference it explicitly if using `kubectl`. |
| `KUBECONFIG` | Path to a file containing `kubeconfig` for this deployment. CA bundle would be embedded if specified. This config also embeds the same token defined in `KUBE_TOKEN` so you likely will only need this variable. This variable name is also automatically picked up by `kubectl` so you won't actually need to reference it explicitly if using `kubectl`. |
| `KUBE_INGRESS_BASE_DOMAIN` | From GitLab 11.8, this variable can be used to set a domain per cluster. See [cluster domains](#base-domain) for more information. |
| `KUBE_INGRESS_BASE_DOMAIN` | From GitLab 11.8, this variable can be used to set a domain per cluster. See [cluster domains](#base-domain) for more information. |
NOTE: **NOTE:**
NOTE: **Note:**
Prior to GitLab 11.5, `KUBE_TOKEN` was the Kubernetes token of the main
Prior to GitLab 11.5, `KUBE_TOKEN` was the Kubernetes token of the main
service account of the cluster integration.
service account of the cluster integration.
NOTE: **Note:**
NOTE: **Note:**
If your cluster was created before GitLab 12.2, default `KUBE_NAMESPACE` will be set to `<project_name>-<project_id>`.
If your cluster was created before GitLab 12.2, default `KUBE_NAMESPACE` will be set to `<project_name>-<project_id>`.
When deploying a custom namespace:
### Custom namespace
> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/27630) in GitLab 12.6.
The Kubernetes integration defaults to project-environment-specific namespaces
of the form `<project_name>-<project_id>-<environment>` (see [Deployment
variables](#deployment-variables)).
- The custom namespace must exist in your cluster.
For **non**-GitLab-managed clusters, the namespace can be customized using
- The project's deployment service account must have permission to deploy to the namespace.
-`KUBECONFIG` must be updated to use the custom namespace instead of the GitLab-provided default (this is [not automatic](https://gitlab.com/gitlab-org/gitlab/issues/31519)).
in `.gitlab-ci.yml`.
- If deploying with Auto DevOps, you must *also* override `KUBE_NAMESPACE` with the custom namespace.
CAUTION: **Caution:**
NOTE: **Note:** When using a [GitLab-managed cluster](#gitlab-managed-clusters), the
GitLab does not save custom namespaces in the database. So while deployments work with custom namespaces, GitLab's integration for already-deployed environments will not pick up the customized values. For example, [Deploy Boards](../deploy_boards.md) will not work as intended for those deployments. For more information, see the [related issue](https://gitlab.com/gitlab-org/gitlab/issues/27630).
namespaces are created automatically prior to deployment and [can not be