mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-12-24 17:30:30 +00:00
948b4224c7
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Anbraten <anton@ju60.de>
106 lines
3.3 KiB
Markdown
106 lines
3.3 KiB
Markdown
# External Configuration API
|
|
|
|
To provide additional management and preprocessing capabilities for pipeline configurations Woodpecker supports an HTTP API which can be enabled to call an external config service.
|
|
Before the run or restart of any pipeline Woodpecker will make a POST request to an external HTTP API sending the current repository, build information and all current config files retrieved from the repository. The external API can then send back new pipeline configurations that will be used immediately or respond with `HTTP 204` to tell the system to use the existing configuration.
|
|
|
|
Every request sent by Woodpecker is signed using a [http-signature](https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures) by a private key (ed25519) generated on the first start of the Woodpecker server. You can get the public key for the verification of the http-signature from `http(s)://your-woodpecker-server/api/signature/public-key`.
|
|
|
|
A simplistic example configuration service can be found here: [https://github.com/woodpecker-ci/example-config-service](https://github.com/woodpecker-ci/example-config-service)
|
|
|
|
:::warning
|
|
You need to trust the external config service as it is getting secret information about the repository and pipeline and has the ability to change pipeline configs that could run malicious tasks.
|
|
:::
|
|
|
|
## Config
|
|
|
|
```bash
|
|
# Server
|
|
# ...
|
|
WOODPECKER_CONFIG_SERVICE_ENDPOINT=https://example.com/ciconfig
|
|
```
|
|
|
|
### Example request made by Woodpecker
|
|
|
|
```json
|
|
{
|
|
"repo": {
|
|
"id": 100,
|
|
"uid": "",
|
|
"user_id": 0,
|
|
"namespace": "",
|
|
"name": "woodpecker-testpipe",
|
|
"slug": "",
|
|
"scm": "git",
|
|
"git_http_url": "",
|
|
"git_ssh_url": "",
|
|
"link": "",
|
|
"default_branch": "",
|
|
"private": true,
|
|
"visibility": "private",
|
|
"active": true,
|
|
"config": "",
|
|
"trusted": false,
|
|
"protected": false,
|
|
"ignore_forks": false,
|
|
"ignore_pulls": false,
|
|
"cancel_pulls": false,
|
|
"timeout": 60,
|
|
"counter": 0,
|
|
"synced": 0,
|
|
"created": 0,
|
|
"updated": 0,
|
|
"version": 0
|
|
},
|
|
"pipeline": {
|
|
"author": "myUser",
|
|
"author_avatar": "https://myforge.com/avatars/d6b3f7787a685fcdf2a44e2c685c7e03",
|
|
"author_email": "my@email.com",
|
|
"branch": "main",
|
|
"changed_files": ["somefilename.txt"],
|
|
"commit": "2fff90f8d288a4640e90f05049fe30e61a14fd50",
|
|
"created_at": 0,
|
|
"deploy_to": "",
|
|
"enqueued_at": 0,
|
|
"error": "",
|
|
"event": "push",
|
|
"finished_at": 0,
|
|
"id": 0,
|
|
"link_url": "https://myforge.com/myUser/woodpecker-testpipe/commit/2fff90f8d288a4640e90f05049fe30e61a14fd50",
|
|
"message": "test old config\n",
|
|
"number": 0,
|
|
"parent": 0,
|
|
"ref": "refs/heads/main",
|
|
"refspec": "",
|
|
"clone_url": "",
|
|
"reviewed_at": 0,
|
|
"reviewed_by": "",
|
|
"sender": "myUser",
|
|
"signed": false,
|
|
"started_at": 0,
|
|
"status": "",
|
|
"timestamp": 1645962783,
|
|
"title": "",
|
|
"updated_at": 0,
|
|
"verified": false
|
|
},
|
|
"configs": [
|
|
{
|
|
"name": ".woodpecker.yml",
|
|
"data": "steps:\n backend:\n image: alpine\n commands:\n - echo \"Hello there from Repo (.woodpecker.yml)\"\n"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### Example response structure
|
|
|
|
```json
|
|
{
|
|
"configs": [
|
|
{
|
|
"name": "central-override",
|
|
"data": "steps:\n backend:\n image: alpine\n commands:\n - echo \"Hello there from ConfigAPI\"\n"
|
|
}
|
|
]
|
|
}
|
|
```
|