woodpecker/cmd/agent/flags.go

// Copyright 2019 Laszlo Fogas
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package main

import (
	"time"

	"github.com/urfave/cli"
)

var flags = []cli.Flag{
	cli.StringFlag{
		EnvVar: "WOODPECKER_SERVER",
		Name:   "server",
		Usage:  "server address",
		Value:  "localhost:9000",
	},
	cli.StringFlag{
		EnvVar: "WOODPECKER_USERNAME",
		Name:   "username",
		Usage:  "auth username",
		Value:  "x-oauth-basic",
	},
	cli.StringFlag{
		EnvVar: "WOODPECKER_AGENT_SECRET",
		Name:   "password",
		Usage:  "server-agent shared password",
	},
	cli.BoolTFlag{
		EnvVar: "WOODPECKER_DEBUG",
		Name:   "debug",
		Usage:  "enable agent debug mode",
	},
	cli.BoolFlag{
		EnvVar: "WOODPECKER_DEBUG_PRETTY",
		Name:   "pretty",
		Usage:  "enable pretty-printed debug output",
	},
	cli.BoolTFlag{
		EnvVar: "WOODPECKER_DEBUG_NOCOLOR",
		Name:   "nocolor",
		Usage:  "disable colored debug output",
	},
	cli.StringFlag{
		EnvVar: "WOODPECKER_HOSTNAME",
		Name:   "hostname",
		Usage:  "agent hostname",
	},
	cli.StringFlag{
		EnvVar: "WOODPECKER_PLATFORM",
		Name:   "platform",
		Usage:  "restrict builds by platform conditions",
		Value:  "linux/amd64",
	},
	cli.StringFlag{
		EnvVar: "WOODPECKER_FILTER",
		Name:   "filter",
		Usage:  "filter expression to restrict builds by label",
	},
	cli.IntFlag{
		EnvVar: "WOODPECKER_MAX_PROCS",
		Name:   "max-procs",
		Usage:  "agent parallel builds",
		Value:  1,
	},
	cli.BoolTFlag{
		EnvVar: "WOODPECKER_HEALTHCHECK",
		Name:   "healthcheck",
		Usage:  "enable healthcheck endpoint",
	},
	cli.DurationFlag{
		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: "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 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 WOODPECKER_GRPC_SECURE is true",
	},
}