atccmd

Documentation

Index

• Variables
• type ATCCommand
  • func (cmd *ATCCommand) WireDynamicFlags(commandFlags *flags.Command)
• type Migration
  • func (m *Migration) Execute(args []string) error
• type RunCommand
  • func (cmd *RunCommand) Execute(args []string) error
  • func (cmd *RunCommand) PeerURLOrDefault() flag.URL
  • func (cmd *RunCommand) Runner(positionalArguments []string) (ifrit.Runner, bool, error)
  • func (cmd *RunCommand) WireDynamicFlags(commandFlags *flags.Command)

Variables

var HelpError = errors.New("must specify one of `--current-db-version`, `--supported-db-version`, or `--migrate-db-to-version`")

var Version = "0.0.0-dev"

overridden via linker flags

var WorkerVersion = ""

overridden via linker flags

Types

type ATCCommand

type ATCCommand struct {
	RunCommand RunCommand `command:"run"`
	Migration  Migration  `command:"migrate"`
}

func (*ATCCommand) WireDynamicFlags

func (cmd *ATCCommand) WireDynamicFlags(commandFlags *flags.Command)

type Migration

type Migration struct {
	Postgres           flag.PostgresConfig `group:"PostgreSQL Configuration" namespace:"postgres"`
	EncryptionKey      flag.Cipher         `` /* 134-byte string literal not displayed */
	CurrentDBVersion   bool                `long:"current-db-version" description:"Print the current database version and exit"`
	SupportedDBVersion bool                `long:"supported-db-version" description:"Print the max supported database version and exit"`
	MigrateDBToVersion int                 `long:"migrate-db-to-version" description:"Migrate to the specified database version and exit"`
}

func (*Migration) Execute

func (m *Migration) Execute(args []string) error

type RunCommand

type RunCommand struct {
	Logger flag.Lager

	BindIP   flag.IP `long:"bind-ip"   default:"0.0.0.0" description:"IP address on which to listen for web traffic."`
	BindPort uint16  `long:"bind-port" default:"8080"    description:"Port on which to listen for HTTP traffic."`

	TLSBindPort uint16    `long:"tls-bind-port" description:"Port on which to listen for HTTPS traffic."`
	TLSCert     flag.File `long:"tls-cert"      description:"File containing an SSL certificate."`
	TLSKey      flag.File `long:"tls-key"       description:"File containing an RSA private key, used to encrypt HTTPS traffic."`

	ExternalURL flag.URL `long:"external-url" description:"URL used to reach any ATC from the outside world."`
	PeerURL     flag.URL `long:"peer-url"     description:"URL used to reach this ATC from other ATCs in the cluster."`

	Postgres flag.PostgresConfig `group:"PostgreSQL Configuration" namespace:"postgres"`

	CredentialManagement struct{} `group:"Credential Management"`
	CredentialManagers   creds.Managers

	EncryptionKey    flag.Cipher `` /* 134-byte string literal not displayed */
	OldEncryptionKey flag.Cipher `` /* 208-byte string literal not displayed */

	DebugBindIP   flag.IP `long:"debug-bind-ip"   default:"127.0.0.1" description:"IP address on which to listen for the pprof debugger endpoints."`
	DebugBindPort uint16  `long:"debug-bind-port" default:"8079"      description:"Port on which to listen for the pprof debugger endpoints."`

	InterceptIdleTimeout time.Duration `` /* 128-byte string literal not displayed */

	GlobalResourceCheckTimeout   time.Duration `long:"global-resource-check-timeout" default:"1h" description:"Time limit on checking for new versions of resources."`
	ResourceCheckingInterval     time.Duration `long:"resource-checking-interval" default:"1m" description:"Interval on which to check for new versions of resources."`
	ResourceTypeCheckingInterval time.Duration `` /* 128-byte string literal not displayed */

	ContainerPlacementStrategy        string        `` /* 181-byte string literal not displayed */
	BaggageclaimResponseHeaderTimeout time.Duration `` /* 133-byte string literal not displayed */

	CLIArtifactsDir flag.Dir `long:"cli-artifacts-dir" description:"Directory containing downloadable CLI binaries."`

	Developer struct {
		Noop bool `short:"n" long:"noop"              description:"Don't actually do any automatic scheduling or checking."`
	} `group:"Developer Options"`

	Worker struct {
		GardenURL       flag.URL          `long:"garden-url"       description:"A Garden API endpoint to register as a worker."`
		BaggageclaimURL flag.URL          `long:"baggageclaim-url" description:"A Baggageclaim API endpoint to register with the worker."`
		ResourceTypes   map[string]string `` /* 139-byte string literal not displayed */
	} `group:"Static Worker (optional)" namespace:"worker"`

	Metrics struct {
		HostName   string            `long:"metrics-host-name"   description:"Host string to attach to emitted metrics."`
		Attributes map[string]string `` /* 149-byte string literal not displayed */
	} `group:"Metrics & Diagnostics"`

	Server struct {
		XFrameOptions string `long:"x-frame-options" description:"The value to set for X-Frame-Options. If omitted, the header is not set."`
	} `group:"Web Server"`

	LogDBQueries bool `long:"log-db-queries" description:"Log database queries."`

	GC struct {
		Interval               time.Duration `long:"interval" default:"30s" description:"Interval on which to perform garbage collection."`
		OneOffBuildGracePeriod time.Duration `long:"one-off-grace-period" default:"5m" description:"Grace period before reaping one-off task containers"`
	} `group:"Garbage Collection" namespace:"gc"`

	BuildTrackerInterval time.Duration `long:"build-tracker-interval" default:"10s" description:"Interval on which to run build tracking."`

	TelemetryOptIn bool `long:"telemetry-opt-in" hidden:"true" description:"Enable anonymous concourse version reporting."`

	DefaultBuildLogsToRetain uint64 `long:"default-build-logs-to-retain" description:"Default build logs to retain, 0 means all"`
	MaxBuildLogsToRetain     uint64 `` /* 138-byte string literal not displayed */

	DefaultCpuLimit    *int    `long:"default-task-cpu-limit" description:"Default max number of cpu shares per task, 0 means unlimited"`
	DefaultMemoryLimit *string `long:"default-task-memory-limit" description:"Default maximum memory per task, 0 means unlimited"`

	Syslog struct {
		Hostname      string        `` /* 142-byte string literal not displayed */
		Address       string        `long:"syslog-address" description:"Remote syslog server address with port (Example: 0.0.0.0:514)."`
		Transport     string        `long:"syslog-transport" description:"Transport protocol for syslog messages (Currently supporting tcp, udp & tls)."`
		DrainInterval time.Duration `` /* 192-byte string literal not displayed */
		CACerts       []string      `` /* 128-byte string literal not displayed */
	} ` group:"Syslog Drainer Configuration"`

	Auth struct {
		AuthFlags     skycmd.AuthFlags
		MainTeamFlags skycmd.AuthTeamFlags `group:"Authentication (Main Team)" namespace:"main-team"`
	} `group:"Authentication"`
}

func (*RunCommand) Execute

func (cmd *RunCommand) Execute(args []string) error

func (*RunCommand) PeerURLOrDefault

func (cmd *RunCommand) PeerURLOrDefault() flag.URL

func (*RunCommand) Runner

func (cmd *RunCommand) Runner(positionalArguments []string) (ifrit.Runner, bool, error)

func (*RunCommand) WireDynamicFlags

func (cmd *RunCommand) WireDynamicFlags(commandFlags *flags.Command)