mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-06-06 07:29:39 +00:00
Automatically determine platform of agent (#690)
* Automatically determine platform of agent * add migration hint * cleanup docs a bit
This commit is contained in:
Anbraten
GitHub
parent
04eb7935db
commit
50570cba5c
|
|
@ -19,6 +19,7 @@ import (
|
|||
"crypto/tls"
|
||||
"net/http"
|
||||
"os"
|
||||
"runtime"
|
||||
"sync"
|
||||
|
||||
"github.com/rs/zerolog"
|
||||
|
|
@ -38,7 +39,7 @@ import (
|
|||
func loop(c *cli.Context) error {
|
||||
filter := rpc.Filter{
|
||||
Labels: map[string]string{
|
||||
"platform": c.String("platform"),
|
||||
"platform": runtime.GOOS + "/" + runtime.GOARCH,
|
||||
},
|
||||
Expr: c.String("filter"),
|
||||
}
|
||||
|
|
|
|||
|
|
@ -65,12 +65,6 @@ var flags = []cli.Flag{
|
|||
Name: "hostname",
|
||||
Usage: "agent hostname",
|
||||
},
|
||||
&cli.StringFlag{
|
||||
EnvVars: []string{"WOODPECKER_PLATFORM"},
|
||||
Name: "platform",
|
||||
Usage: "restrict builds by platform conditions",
|
||||
Value: "linux/amd64",
|
||||
},
|
||||
&cli.StringFlag{
|
||||
EnvVars: []string{"WOODPECKER_FILTER"},
|
||||
Name: "filter",
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ In the above example we define two pipeline steps, `frontend` and `backend`. The
|
|||
|
||||
## Global Pipeline Conditionals
|
||||
|
||||
Woodpecker gives the ability to skip whole pipelines (not just steps) when based on certain conditions.
|
||||
Woodpecker gives the ability to skip whole pipelines (not just steps) based on certain conditions.
|
||||
|
||||
### `branches`
|
||||
Woodpecker can skip commits based on the target branch. If the branch matches the `branches:` block the pipeline is executed, otherwise it is skipped.
|
||||
|
|
@ -96,66 +96,18 @@ pipeline:
|
|||
+ exclude: [ develop, feature/* ]
|
||||
```
|
||||
|
||||
|
||||
### `when`
|
||||
|
||||
If required, Woodpecker can be made to skip whole pipelines based on `when`. This could be utilised to ensure compliance that only certain jobs run on certain agents (regional restrictions). Or targeting architectures.
|
||||
|
||||
This is achieved by ensuring the `when` block is on the root level.
|
||||
|
||||
See [when](#step-when---step-conditional-execution) above to understand all the different types of conditions that can be used.
|
||||
|
||||
> Note: You may need to set the agent environment settings, as these are not set automatically. See: [agent configuration](/docs/administration/agent-config) for more details.
|
||||
|
||||
|
||||
Example targeting a specific platform:
|
||||
|
||||
```diff
|
||||
pipeline:
|
||||
build:
|
||||
image: golang
|
||||
commands:
|
||||
- go build
|
||||
- go test
|
||||
|
||||
+when:
|
||||
+ platform: [ linux/arm* ]
|
||||
```
|
||||
|
||||
Assuming we have two agents, one `arm` and one `amd64`. Previously this pipeline would have executed on **either agent**, as Woodpecker is not fussy about where it runs the pipelines.
|
||||
Because we had our original `when` block underneath the `build` block, if it was run on the `linux/amd64` agent. It would have cloned the repository, and then skipped the build step. Resulting in a Successful build.
|
||||
|
||||
Moving the when block to the root level will ensure that the whole pipeline will run be targeted to agents that match all of the conditions.
|
||||
|
||||
This can be utilised in conjunction with other when blocks as well.
|
||||
|
||||
Example `when` pipeline & step block:
|
||||
|
||||
```diff
|
||||
pipeline:
|
||||
build:
|
||||
image: golang
|
||||
commands:
|
||||
- go build
|
||||
- go test
|
||||
|
||||
publish:
|
||||
image: plugins/docker
|
||||
settings:
|
||||
repo: foo/bar
|
||||
+ when:
|
||||
+ tag: release*
|
||||
|
||||
+when:
|
||||
+ platform: [ linux/arm* ]
|
||||
```
|
||||
|
||||
### `platform`
|
||||
|
||||
To configure your pipeline to select an agent with a specific platform, you can use `platform` key.
|
||||
To configure your pipeline to only be executed on an agent with a specific platform, you can use the `platform` key.
|
||||
Have a look at the official [go docs](https://go.dev/doc/install/source) for the available platforms. The syntax of the platform is `GOOS/GOARCH` like `linux/arm64` or `linux/amd64`.
|
||||
|
||||
Example:
|
||||
|
||||
Assuming we have two agents, one `arm` and one `amd64`. Previously this pipeline would have executed on **either agent**, as Woodpecker is not fussy about where it runs the pipelines. By setting the following option it will only be executed on an agent with the platform `linux/arm64`.
|
||||
|
||||
```diff
|
||||
+platform: linux/arm64
|
||||
|
||||
|
||||
pipeline:
|
||||
build:
|
||||
image: golang
|
||||
|
|
@ -172,14 +124,12 @@ Woodpecker gives the ability to skip individual commits by adding `[CI SKIP]` to
|
|||
git commit -m "updated README [CI SKIP]"
|
||||
```
|
||||
|
||||
|
||||
## `services`
|
||||
|
||||
Woodpecker can provide service containers. They can for example be used to run databases or cache containers during the execution of pipeline.
|
||||
|
||||
For more details check the [services docs](/docs/usage/services/).
|
||||
|
||||
|
||||
## Steps
|
||||
|
||||
Every step of your pipeline executes arbitrary commands inside a specified docker container. The defined commands are executed serially.
|
||||
|
|
@ -223,11 +173,11 @@ Woodpecker uses Docker images for the build environment, for plugins and for ser
|
|||
commands:
|
||||
- go build
|
||||
- go test
|
||||
|
||||
|
||||
publish:
|
||||
+ image: plugins/docker
|
||||
repo: foo/bar
|
||||
|
||||
|
||||
services:
|
||||
database:
|
||||
+ image: mysql
|
||||
|
|
@ -413,7 +363,7 @@ The base attribute defines a shared base volume available to all pipeline steps.
|
|||
workspace:
|
||||
+ base: /go
|
||||
path: src/github.com/octocat/hello-world
|
||||
|
||||
|
||||
pipeline:
|
||||
deps:
|
||||
image: golang:latest
|
||||
|
|
@ -462,7 +412,7 @@ Woodpecker automatically configures a default clone step if not explicitly defin
|
|||
+clone:
|
||||
+ git:
|
||||
+ image: woodpeckerci/plugin-git
|
||||
|
||||
|
||||
pipeline:
|
||||
build:
|
||||
image: golang
|
||||
|
|
@ -539,7 +489,7 @@ Woodpecker gives the ability to configure privileged mode in the Yaml. You can u
|
|||
- DOCKER_HOST=tcp://docker:2375
|
||||
commands:
|
||||
- docker --tls=false ps
|
||||
|
||||
|
||||
services:
|
||||
docker:
|
||||
image: docker:dind
|
||||
|
|
|
|||
|
|
@ -1,8 +1,6 @@
|
|||
# Conditional Step Execution
|
||||
|
||||
Woodpecker supports defining conditional pipeline steps in the `when` block. If all conditions in the `when` block evaluate to true the step is executed, otherwise it is skipped.
|
||||
|
||||
This can also be utilised on a playbook level if you have multi-arch agents and require specific pipelines to be run on specific architectures. See [platform](#platform) below.
|
||||
Woodpecker supports defining conditions for pipeline step by a `when` block. If all conditions in the `when` block evaluate to true the step is executed, otherwise it is skipped.
|
||||
|
||||
## `repo`
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,6 @@ services:
|
|||
The following are automatically set and can be overridden:
|
||||
|
||||
- WOODPECKER_HOSTNAME if not set, becomes the OS' hostname
|
||||
- WOODPECKER_PLATFORM if not set, is the architecture eg: `linux/amd64`
|
||||
- WOODPECKER_MAX_PROCS if not set, defaults to 1
|
||||
|
||||
## Processes per agent
|
||||
|
|
@ -40,30 +39,16 @@ services:
|
|||
|
||||
## Filtering agents
|
||||
|
||||
When building your pipelines as long as you have set the platform or filter, builds can be made to only run code on certain agents.
|
||||
When building your pipelines as long as you have set the platform or filter, builds can be made to only run code on certain agents.
|
||||
|
||||
```
|
||||
- WOODPECKER_HOSTNAME=mycompany-ci-01.example.com
|
||||
- WOODPECKER_PLATFORM=linux/amd64
|
||||
- WOODPECKER_FILTER=
|
||||
```
|
||||
|
||||
### Filter on Platform
|
||||
|
||||
Only want certain pipelines or steps to run on certain platforms? Such as arm vs amd64?
|
||||
|
||||
```diff
|
||||
# docker-compose.yml
|
||||
version: '3'
|
||||
|
||||
services:
|
||||
woodpecker-agent:
|
||||
[...]
|
||||
environment:
|
||||
- WOODPECKER_SERVER=localhost:9000
|
||||
- WOODPECKER_AGENT_SECRET=""
|
||||
+ - WOODPECKER_PLATFORM=linux/arm64
|
||||
```
|
||||
Only want certain pipelines or steps to run on certain agents with specific platforms? Such as arm vs amd64?
|
||||
|
||||
```yaml
|
||||
# .woodpecker.yml
|
||||
|
|
@ -93,7 +78,7 @@ See [Conditionals Pipeline](/docs/usage/pipeline-syntax#step-when---conditional-
|
|||
|
||||
## All agent configuration options
|
||||
|
||||
Here is the full list of configuration options and their default variables.
|
||||
Here is the full list of configuration options and their default variables.
|
||||
|
||||
### `WOODPECKER_SERVER`
|
||||
> Default: `localhost:9000`
|
||||
|
|
@ -163,4 +148,4 @@ Configures if the gRPC server certificate should be verified, only valid when `W
|
|||
### `WOODPECKER_BACKEND`
|
||||
> Default: `auto-detect`
|
||||
|
||||
Configures the backend engine to run pipelines on. Possible values are `auto-detect` or `docker`.
|
||||
Configures the backend engine to run pipelines on. Possible values are `auto-detect` or `docker`.
|
||||
|
|
|
|||
|
|
@ -65,6 +65,8 @@ Some versions need some changes to the server configuration or the pipeline conf
|
|||
+ setting2: bar
|
||||
```
|
||||
|
||||
- Dropped support for manually setting the agents platform with `WOODPECKER_PLATFORM`. The platform is now automatically detected.
|
||||
|
||||
## 0.14.0
|
||||
|
||||
No breaking changes
|
||||
|
|
|
|||
Loading…
Reference in a new issue