atc

Documentation

Index

• type Atc
• type Container
• type GithubAuth
• type Postgresql
• type Retention
• type Riemann
• type Role
• type Yeller

Types

type Atc

type Atc struct {

	/*Retention - Descr: The duration to keep a failed step's containers before expiring them.
	Default: 1h
	*/
	Retention Retention `yaml:"retention,omitempty"`

	/*PostgresqlDatabase - Descr: Name of the database to use from the `postgresql` link.
	Default: <nil>
	*/
	PostgresqlDatabase interface{} `yaml:"postgresql_database,omitempty"`

	/*BindIp - Descr: IP address on which the ATC should listen for HTTP traffic.
	Default: 0.0.0.0
	*/
	BindIp interface{} `yaml:"bind_ip,omitempty"`

	/*ExternalUrl - Descr: Externally reachable URL of the ATCs. Required for OAuth.

	Typically this is the URL that you as a user would use to reach your CI.
	For multiple ATCs it would go to some sort of load balancer.
	 Default: <nil>
	*/
	ExternalUrl interface{} `yaml:"external_url,omitempty"`

	/*PubliclyViewable - Descr: Allow viewing of pipelines as an anonymous user. Destructive operations
	still require auth, and the output of builds will only be visible if
	their job is configured with `public: true`.

	This is useful for open-source projects, or as a convenience to make
	monitoring your pipeline status easier.
	 Default: false
	*/
	PubliclyViewable interface{} `yaml:"publicly_viewable,omitempty"`

	/*OldResourceGracePeriod - Descr: How long to cache the result of a get step after a newer version of the
	resource is found. Use Go duration format (1m = 1 minute).
	 Default: 5m
	*/
	OldResourceGracePeriod interface{} `yaml:"old_resource_grace_period,omitempty"`

	/*GithubAuth - Descr: Override default access token endpoint for Github Enterprise.
	Default: <nil>
	*/
	GithubAuth GithubAuth `yaml:"github_auth,omitempty"`

	/*DevelopmentMode - Descr: Loosen up security for development purposes. This allows the ATC to be
	configured with no authentication methods.
	 Default: false
	*/
	DevelopmentMode interface{} `yaml:"development_mode,omitempty"`

	/*BasicAuthPassword - Descr: Password for HTTP basic auth, in plaintext.
	Default:
	*/
	BasicAuthPassword interface{} `yaml:"basic_auth_password,omitempty"`

	/*BindPort - Descr: Port on which the ATC should listen for HTTP traffic.
	Default: 8080
	*/
	BindPort interface{} `yaml:"bind_port,omitempty"`

	/*BasicAuthUsername - Descr: Username for HTTP basic auth.
	Default:
	*/
	BasicAuthUsername interface{} `yaml:"basic_auth_username,omitempty"`

	/*Riemann - Descr: If configured, detailed metrics will be emitted to the specified Riemann
	server.
	 Default:
	*/
	Riemann Riemann `yaml:"riemann,omitempty"`

	/*ResourceCacheCleanupInterval - Descr: The interval, in Go duration format (1m = 1 minute), on which to check
	for and release old caches of resource versions.
	 Default: 30s
	*/
	ResourceCacheCleanupInterval interface{} `yaml:"resource_cache_cleanup_interval,omitempty"`

	/*Postgresql - Descr: Address of a PostgreSQL server to connect to, in `HOST:PORT` format.

	If not specified, one will be autodiscovered via BOSH links.
	 Default: <nil>
	*/
	Postgresql Postgresql `yaml:"postgresql,omitempty"`

	/*DefaultCheckInterval - Descr: The interval, in Go duration format (1m = 1 minute), on which to check
	for new versions of resources.

	This can also be specified on a per-resource basis by specifying
	`check_every` on the resource config.
	 Default: 1m
	*/
	DefaultCheckInterval interface{} `yaml:"default_check_interval,omitempty"`

	/*Yeller - Descr: If configured, errors emitted to the logs will also be emitted to Yeller.
	This is only really useful for Concourse developers.
	 Default:
	*/
	Yeller Yeller `yaml:"yeller,omitempty"`

	/*PeerUrl - Descr: Address used internally to reach the ATC. This will be auto-generated
	using the IP of each ATC VM if not specified.

	Note that this refers to an *individual ATC*, not the whole cluster. This
	property is only useful if you're deploying in a way that cannot
	autodetect its own IP, e.g. a `bosh-init` deployment.

	You should otherwise leave this value blank.
	 Default: <nil>
	*/
	PeerUrl interface{} `yaml:"peer_url,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Container

type Container struct {

	/*SuccessDuration - Descr: The duration to keep a succeeded step's containers before expiring them.
	Default: 5m
	*/
	SuccessDuration interface{} `yaml:"success_duration,omitempty"`

	/*FailureDuration - Descr: The duration to keep a failed step's containers before expiring them.
	Default: 1h
	*/
	FailureDuration interface{} `yaml:"failure_duration,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type GithubAuth

type GithubAuth struct {

	/*Authorize - Descr: An array of different criteria to check for when authorizing a GitHub
	user. If empty, GitHub authorization is effectively disabled.
	 Default: []
	*/
	Authorize interface{} `yaml:"authorize,omitempty"`

	/*ApiUrl - Descr: Override default API endpoint URL for Github Enterprise. Must end in a
	trailing slash.
	 Default: <nil>
	*/
	ApiUrl interface{} `yaml:"api_url,omitempty"`

	/*ClientSecret - Descr: GitHub client secret to use for OAuth.

	The application must be configured with its callback URL as
	`{external_url}/auth/github/callback` (replacing `{external_url}`
	with the actual value).
	 Default:
	*/
	ClientSecret interface{} `yaml:"client_secret,omitempty"`

	/*TokenUrl - Descr: Override default access token endpoint for Github Enterprise.
	Default: <nil>
	*/
	TokenUrl interface{} `yaml:"token_url,omitempty"`

	/*ClientId - Descr: GitHub client ID to use for OAuth.

	The application must be configured with its callback URL as
	`{external_url}/auth/github/callback` (replacing `{external_url}`
	with the actual value).
	 Default:
	*/
	ClientId interface{} `yaml:"client_id,omitempty"`

	/*AuthUrl - Descr: Override default OAuth endpoint for Github Enterprise.
	Default: <nil>
	*/
	AuthUrl interface{} `yaml:"auth_url,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Postgresql

type Postgresql struct {

	/*Role - Descr: Password to use when connecting.
	Default: <nil>
	*/
	Role Role `yaml:"role,omitempty"`

	/*Database - Descr: Name of the database to use.
	Default: atc
	*/
	Database interface{} `yaml:"database,omitempty"`

	/*Address - Descr: Address of a PostgreSQL server to connect to, in `HOST:PORT` format.

	If not specified, one will be autodiscovered via BOSH links.
	 Default: <nil>
	*/
	Address interface{} `yaml:"address,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Retention

type Retention struct {

	/*Container - Descr: The duration to keep a failed step's containers before expiring them.
	Default: 1h
	*/
	Container Container `yaml:"container,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Riemann

type Riemann struct {

	/*Host - Descr: If configured, detailed metrics will be emitted to the specified Riemann
	server.
	 Default:
	*/
	Host interface{} `yaml:"host,omitempty"`

	/*Port - Descr: Port of the Riemann server to emit events to.
	Default: 5555
	*/
	Port interface{} `yaml:"port,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Role

type Role struct {

	/*Password - Descr: Password to use when connecting.
	Default: <nil>
	*/
	Password interface{} `yaml:"password,omitempty"`

	/*Name - Descr: Name of role to connect with.
	Default: atc
	*/
	Name interface{} `yaml:"name,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Yeller

type Yeller struct {

	/*EnvironmentName - Descr: Environment name to specify for errors emitted to Yeller.
	Default:
	*/
	EnvironmentName interface{} `yaml:"environment_name,omitempty"`

	/*ApiKey - Descr: If configured, errors emitted to the logs will also be emitted to Yeller.
	This is only really useful for Concourse developers.
	 Default:
	*/
	ApiKey interface{} `yaml:"api_key,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!