debian-mirror-gitlab/doc/administration/external_pipeline_validation.md

152 lines
4 KiB
Markdown
Raw Normal View History

2020-06-23 00:09:42 +05:30
---
stage: Verify
2021-09-04 01:27:46 +05:30
group: Pipeline Execution
2021-02-22 17:27:13 +05:30
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/#assignments
2020-06-23 00:09:42 +05:30
type: reference, howto
---
2021-09-30 23:02:18 +05:30
# External pipeline validation **(FREE SELF)**
2020-01-01 13:55:28 +05:30
2021-04-29 21:17:54 +05:30
You can use an external service to validate a pipeline before it's created.
2020-01-01 13:55:28 +05:30
2021-02-22 17:27:13 +05:30
WARNING:
2020-01-01 13:55:28 +05:30
This is an experimental feature and subject to change without notice.
2021-02-22 17:27:13 +05:30
GitLab sends a POST request to the external service URL with the pipeline
2021-06-08 01:23:25 +05:30
data as payload. The response code from the external service determines if GitLab
should accept or reject the pipeline. If the response is:
- `200`, the pipeline is accepted.
2021-09-04 01:27:46 +05:30
- `406`, the pipeline is rejected.
2021-06-08 01:23:25 +05:30
- Other codes, the pipeline is accepted and logged.
2020-01-01 13:55:28 +05:30
2021-06-08 01:23:25 +05:30
If there's an error or the request times out, the pipeline is accepted.
2020-01-01 13:55:28 +05:30
2021-06-08 01:23:25 +05:30
Pipelines rejected by the external validation service aren't created, and don't
appear in pipeline lists in the GitLab UI or API. If you create a pipeline in the
UI that is rejected, `Pipeline cannot be run. External validation failed` is displayed.
2020-01-01 13:55:28 +05:30
2021-06-08 01:23:25 +05:30
## Configure external pipeline validation
2020-01-01 13:55:28 +05:30
2021-04-29 21:17:54 +05:30
To configure external pipeline validation, add the
[`EXTERNAL_VALIDATION_SERVICE_URL` environment variable](environment_variables.md)
and set it to the external service URL.
By default, requests to the external service time out after five seconds. To override
the default, set the `EXTERNAL_VALIDATION_SERVICE_TIMEOUT` environment variable to the
required number of seconds.
2020-01-01 13:55:28 +05:30
2021-06-08 01:23:25 +05:30
## Payload schema
2020-01-01 13:55:28 +05:30
```json
{
"type": "object",
"required" : [
"project",
"user",
"pipeline",
2021-04-29 21:17:54 +05:30
"builds",
"namespace"
2020-01-01 13:55:28 +05:30
],
"properties" : {
"project": {
"type": "object",
"required": [
"id",
2021-04-29 21:17:54 +05:30
"path",
2022-07-23 23:45:48 +05:30
"created_at",
"shared_runners_enabled",
"group_runners_enabled"
2020-01-01 13:55:28 +05:30
],
"properties": {
"id": { "type": "integer" },
2021-04-29 21:17:54 +05:30
"path": { "type": "string" },
"created_at": { "type": ["string", "null"], "format": "date-time" }
2020-01-01 13:55:28 +05:30
}
},
"user": {
"type": "object",
"required": [
"id",
"username",
2021-04-29 21:17:54 +05:30
"email",
"created_at"
2020-01-01 13:55:28 +05:30
],
"properties": {
"id": { "type": "integer" },
"username": { "type": "string" },
2021-04-29 21:17:54 +05:30
"email": { "type": "string" },
2021-09-04 01:27:46 +05:30
"created_at": { "type": ["string", "null"], "format": "date-time" },
"current_sign_in_ip": { "type": ["string", "null"] },
2021-11-18 22:05:49 +05:30
"last_sign_in_ip": { "type": ["string", "null"] },
"sign_in_count": { "type": "integer" }
2020-01-01 13:55:28 +05:30
}
},
"pipeline": {
"type": "object",
"required": [
"sha",
"ref",
"type"
],
"properties": {
"sha": { "type": "string" },
"ref": { "type": "string" },
"type": { "type": "string" }
}
},
"builds": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"stage",
"image",
"services",
"script"
],
"properties": {
"name": { "type": "string" },
"stage": { "type": "string" },
"image": { "type": ["string", "null"] },
"services": {
"type": ["array", "null"],
"items": { "type": "string" }
},
"script": {
"type": "array",
"items": { "type": "string" }
}
}
}
2021-04-29 21:17:54 +05:30
},
"namespace": {
"type": "object",
"required": [
"plan",
"trial"
],
"properties": {
"plan": { "type": "string" },
"trial": { "type": "boolean" }
}
2021-09-04 01:27:46 +05:30
},
"provisioning_group": {
"type": "object",
"required": [
"plan",
"trial"
],
"properties": {
"plan": { "type": "string" },
"trial": { "type": "boolean" }
}
2020-01-01 13:55:28 +05:30
}
2021-04-29 21:17:54 +05:30
}
2020-01-01 13:55:28 +05:30
}
```
2021-04-29 21:17:54 +05:30
The `namespace` field is only available in [GitLab Premium](https://about.gitlab.com/pricing/)
and higher.