mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2025-10-22 02:35:22 +00:00
Clean up config environment variables for server and agent (#218)
The goal here is to make consistent use of configuration environment variables prefixed `WOODPECKER_`. Where several variants existed, this PR aims to remove all but one option, leaving the most explicit. This PR only changes server and agent code, but not documentation, in order to keep the PR digestible. Once we have consensus that this is correct, I'll change docs accordingly. User (rather: admin) facing changes in this PR: - In general, support for all server and agent config environment variables (env vars) starting with `DRONE_` is removed. The according `WOODPECKER_*` variables must be used instead. - The env var `WOODPECKER_HOST` replaces `DRONE_HOST`, and `DRONE_SERVER_HOST`. - The env var `WOODPECKER_AGENT_SECRET` is used to configure the shared secret which agents use to authenticate against the server. It replaces `WOODPECKER_SECRET`, `DRONE_SECRET`, `WOODPECKER_PASSWORD`, `DRONE_PASSWORD`, and `DRONE_AGENT_SECRET`. - The env var `WOODPECKER_DATABASE_DRIVER` replaces `DRONE_DATABASE_DRIVER` and `DATABASE_DRIVER`. - The env var `WOODPECKER_DATABASE_DATASOURCE` replaces `DRONE_DATABASE_DATASOURCE` and `DATABASE_CONFIG`.
This commit is contained in:
@@ -22,83 +22,83 @@ import (
|
||||
|
||||
var flags = []cli.Flag{
|
||||
cli.StringFlag{
|
||||
EnvVar: "DRONE_SERVER,WOODPECKER_SERVER",
|
||||
EnvVar: "WOODPECKER_SERVER",
|
||||
Name: "server",
|
||||
Usage: "drone server address",
|
||||
Usage: "server address",
|
||||
Value: "localhost:9000",
|
||||
},
|
||||
cli.StringFlag{
|
||||
EnvVar: "DRONE_USERNAME,WOODPECKER_USERNAME",
|
||||
EnvVar: "WOODPECKER_USERNAME",
|
||||
Name: "username",
|
||||
Usage: "drone auth username",
|
||||
Usage: "auth username",
|
||||
Value: "x-oauth-basic",
|
||||
},
|
||||
cli.StringFlag{
|
||||
EnvVar: "DRONE_PASSWORD,DRONE_SECRET,WOODPECKER_PASSWORD,WOODPECKER_SECRET",
|
||||
EnvVar: "WOODPECKER_AGENT_SECRET",
|
||||
Name: "password",
|
||||
Usage: "server-agent shared password",
|
||||
},
|
||||
cli.BoolTFlag{
|
||||
EnvVar: "DRONE_DEBUG,WOODPECKER_DEBUG",
|
||||
EnvVar: "WOODPECKER_DEBUG",
|
||||
Name: "debug",
|
||||
Usage: "enable agent debug mode",
|
||||
},
|
||||
cli.BoolFlag{
|
||||
EnvVar: "DRONE_DEBUG_PRETTY,WOODPECKER_DEBUG_PRETTY",
|
||||
EnvVar: "WOODPECKER_DEBUG_PRETTY",
|
||||
Name: "pretty",
|
||||
Usage: "enable pretty-printed debug output",
|
||||
},
|
||||
cli.BoolTFlag{
|
||||
EnvVar: "DRONE_DEBUG_NOCOLOR,WOODPECKER_DEBUG_NOCOLOR",
|
||||
EnvVar: "WOODPECKER_DEBUG_NOCOLOR",
|
||||
Name: "nocolor",
|
||||
Usage: "disable colored debug output",
|
||||
},
|
||||
cli.StringFlag{
|
||||
EnvVar: "DRONE_HOSTNAME,HOSTNAME,WOODPECKER_HOSTNAME,HOSTNAME",
|
||||
EnvVar: "WOODPECKER_HOSTNAME",
|
||||
Name: "hostname",
|
||||
Usage: "agent hostname",
|
||||
},
|
||||
cli.StringFlag{
|
||||
EnvVar: "DRONE_PLATFORM,WOODPECKER_PLATFORM",
|
||||
EnvVar: "WOODPECKER_PLATFORM",
|
||||
Name: "platform",
|
||||
Usage: "restrict builds by platform conditions",
|
||||
Value: "linux/amd64",
|
||||
},
|
||||
cli.StringFlag{
|
||||
EnvVar: "DRONE_FILTER,WOODPECKER_FILTER",
|
||||
EnvVar: "WOODPECKER_FILTER",
|
||||
Name: "filter",
|
||||
Usage: "filter expression to restrict builds by label",
|
||||
},
|
||||
cli.IntFlag{
|
||||
EnvVar: "DRONE_MAX_PROCS,WOODPECKER_MAX_PROCS",
|
||||
EnvVar: "WOODPECKER_MAX_PROCS",
|
||||
Name: "max-procs",
|
||||
Usage: "agent parallel builds",
|
||||
Value: 1,
|
||||
},
|
||||
cli.BoolTFlag{
|
||||
EnvVar: "DRONE_HEALTHCHECK,WOODPECKER_HEALTHCHECK",
|
||||
EnvVar: "WOODPECKER_HEALTHCHECK",
|
||||
Name: "healthcheck",
|
||||
Usage: "enable healthcheck endpoint",
|
||||
},
|
||||
cli.DurationFlag{
|
||||
EnvVar: "DRONE_KEEPALIVE_TIME,WOODPECKER_KEEPALIVE_TIME",
|
||||
EnvVar: "WOODPECKER_KEEPALIVE_TIME",
|
||||
Name: "keepalive-time",
|
||||
Usage: "after a duration of this time of no activity, the agent pings the server to check if the transport is still alive",
|
||||
},
|
||||
cli.DurationFlag{
|
||||
EnvVar: "DRONE_KEEPALIVE_TIMEOUT,WOODPECKER_KEEPALIVE_TIMEOUT",
|
||||
EnvVar: "WOODPECKER_KEEPALIVE_TIMEOUT",
|
||||
Name: "keepalive-timeout",
|
||||
Usage: "after pinging for a keepalive check, the agent waits for a duration of this time before closing the connection if no activity",
|
||||
Value: time.Second * 20,
|
||||
},
|
||||
cli.BoolFlag{
|
||||
EnvVar: "WOODPECKER_GRPC_SECURE",
|
||||
Name: "secure-grpc",
|
||||
Usage: "should the connection to DRONE_SERVER be made using a secure transport",
|
||||
EnvVar: "DRONE_GRPC_SECURE,WOODPECKER_GRPC_SECURE",
|
||||
Usage: "should the connection to WOODPECKER_SERVER be made using a secure transport",
|
||||
},
|
||||
cli.BoolTFlag{
|
||||
EnvVar: "WOODPECKER_GRPC_VERIFY",
|
||||
Name: "skip-insecure-grpc",
|
||||
Usage: "should the grpc server certificate be verified, only valid when DRONE_GRPC_SECURE is true",
|
||||
EnvVar: "DRONE_GRPC_VERIFY,WOODPECKER_GRPC_VERIFY",
|
||||
Usage: "should the grpc server certificate be verified, only valid when WOODPECKER_GRPC_SECURE is true",
|
||||
},
|
||||
}
|
||||
|
Reference in New Issue
Block a user