atccmd

Documentation

Index

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

Variables

var Version = "0.0.0-dev"

overridden via linker flags

var WorkerVersion = ""

overridden via linker flags

Types

type ATCCommand

type ATCCommand struct {
	Migration Migration `group:"Migration Options"`

	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."`

	CookieSecure bool `long:"cookie-secure" description:"Set secure flag on auth cookies"`

	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" default:"http://127.0.0.1:8080" description:"URL used to reach any ATC from the outside world."`
	PeerURL     flag.URL `long:"peer-url"     default:"http://127.0.0.1:8080" description:"URL used to reach this ATC from other ATCs in the cluster."`

	Auth struct {
		Configs provider.AuthConfigs
	} `group:"Authentication"`

	AuthDuration time.Duration `` /* 135-byte string literal not displayed */
	OAuthBaseURL flag.URL      `long:"oauth-base-url" description:"URL used as the base of OAuth redirect URIs. If not specified, the external URL is used."`

	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."`

	SessionSigningKey *flag.PrivateKey `long:"session-signing-key" description:"File containing an RSA private key, used to sign session tokens."`

	InterceptIdleTimeout              time.Duration `` /* 128-byte string literal not displayed */
	ResourceCheckingInterval          time.Duration `long:"resource-checking-interval" default:"1m" description:"Interval on which to check for new versions of resources."`
	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 */

		YellerAPIKey      string `long:"yeller-api-key"     description:"Yeller API key. If specified, all errors logged will be emitted."`
		YellerEnvironment string `long:"yeller-environment" description:"Environment to tag on all Yeller events emitted."`
	} `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."`
		WorkerConcurrency int           `long:"worker-concurrency" default:"50" description:"Maximum number of delete operations to have in flight per worker."`
	} `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 */
}

func (*ATCCommand) Execute

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

func (*ATCCommand) RunMigrationCommand

func (cmd *ATCCommand) RunMigrationCommand() error

func (*ATCCommand) Runner

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

func (*ATCCommand) WireDynamicFlags

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

type Migration

type Migration struct {
	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) CommandProvided

func (m *Migration) CommandProvided() bool