bbs

Documentation

Index

• type Auctioneer
• type Bbs
• type BbsJob
• type Convergence
• type Diego
• type Etcd
• type Sql

Types

type Auctioneer

type Auctioneer struct {

	/*ApiUrl - Descr: Address of the auctioneer API Default: http://auctioneer.service.cf.internal:9016
	 */
	ApiUrl interface{} `yaml:"api_url,omitempty"`
}

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

type Bbs

type Bbs struct {

	/*Auctioneer - Descr: Address of the auctioneer API Default: http://auctioneer.service.cf.internal:9016
	 */
	Auctioneer *Auctioneer `yaml:"auctioneer,omitempty"`

	/*LogLevel - Descr: Log level Default: info
	 */
	LogLevel interface{} `yaml:"log_level,omitempty"`

	/*DropsondePort - Descr: local metron agent's port Default: 3457
	 */
	DropsondePort interface{} `yaml:"dropsonde_port,omitempty"`

	/*ServerKey - Descr: PEM-encoded client key Default: <nil>
	 */
	ServerKey interface{} `yaml:"server_key,omitempty"`

	/*DesiredLrpCreationTimeout - Descr: expected maximum time to create all components of a desired LRP Default: <nil>
	 */
	DesiredLrpCreationTimeout interface{} `yaml:"desired_lrp_creation_timeout,omitempty"`

	/*DebugAddr - Descr: address at which to serve debug info Default: 127.0.0.1:17017
	 */
	DebugAddr interface{} `yaml:"debug_addr,omitempty"`

	/*AdvertisementBaseHostname - Descr: Suffix for the BBS advertised hostname Default: bbs.service.cf.internal
	 */
	AdvertisementBaseHostname interface{} `yaml:"advertisement_base_hostname,omitempty"`

	/*EncryptionKeys - Descr: List of encryption keys to be used Default: []
	 */
	EncryptionKeys interface{} `yaml:"encryption_keys,omitempty"`

	/*Etcd - Descr: Addresses pointing to the ETCD cluster Default: [etcd.service.cf.internal]
	 */
	Etcd *Etcd `yaml:"etcd,omitempty"`

	/*RequireSsl - Descr: require ssl for all communication the bbs Default: true
	 */
	RequireSsl interface{} `yaml:"require_ssl,omitempty"`

	/*HealthAddr - Descr: address at which to serve API requests Default: 127.0.0.1:8890
	 */
	HealthAddr interface{} `yaml:"health_addr,omitempty"`

	/*ActiveKeyLabel - Descr: Label of the encryption key to be used when writing to the database Default: <nil>
	 */
	ActiveKeyLabel interface{} `yaml:"active_key_label,omitempty"`

	/*EnableAccessLog - Descr: Enable access log, i.e. log every request made to the bbs Default: false
	 */
	EnableAccessLog interface{} `yaml:"enable_access_log,omitempty"`

	/*CaCert - Descr: PEM-encoded CA certificate Default: <nil>
	 */
	CaCert interface{} `yaml:"ca_cert,omitempty"`

	/*Convergence - Descr: unclaimed tasks are marked as failed, after this duration in seconds Default: 1800
	 */
	Convergence *Convergence `yaml:"convergence,omitempty"`

	/*ListenAddr - Descr: address at which to serve API requests Default: 0.0.0.0:8889
	 */
	ListenAddr interface{} `yaml:"listen_addr,omitempty"`

	/*Sql - Descr: Database driver to use for SQL backend (for example: mysql,postgres) Default: mysql
	 */
	Sql *Sql `yaml:"sql,omitempty"`

	/*ServerCert - Descr: PEM-encoded client certificate Default: <nil>
	 */
	ServerCert interface{} `yaml:"server_cert,omitempty"`
}

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

type BbsJob

type BbsJob struct {

	/*Diego - Descr: Addresses pointing to the ETCD cluster Default: [etcd.service.cf.internal]
	 */
	Diego *Diego `yaml:"diego,omitempty"`
}

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

type Convergence

type Convergence struct {

	/*KickTaskDurationInSeconds - Descr: the interval, in seconds, between kicks to tasks in seconds Default: 30
	 */
	KickTaskDurationInSeconds interface{} `yaml:"kick_task_duration_in_seconds,omitempty"`

	/*RepeatIntervalInSeconds - Descr: the interval between runs of the converge process Default: 30
	 */
	RepeatIntervalInSeconds interface{} `yaml:"repeat_interval_in_seconds,omitempty"`

	/*ExpireCompletedTaskDurationInSeconds - Descr: completed, unresolved tasks are deleted after this duration in seconds Default: 120
	 */
	ExpireCompletedTaskDurationInSeconds interface{} `yaml:"expire_completed_task_duration_in_seconds,omitempty"`

	/*ExpirePendingTaskDurationInSeconds - Descr: unclaimed tasks are marked as failed, after this duration in seconds Default: 1800
	 */
	ExpirePendingTaskDurationInSeconds interface{} `yaml:"expire_pending_task_duration_in_seconds,omitempty"`
}

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

type Diego

type Diego struct {

	/*Bbs - Descr: Addresses pointing to the ETCD cluster Default: [etcd.service.cf.internal]
	 */
	Bbs *Bbs `yaml:"bbs,omitempty"`
}

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

type Etcd

type Etcd struct {

	/*MaxIdleConnsPerHost - Descr: maximum number of idle http connections Default: <nil>
	 */
	MaxIdleConnsPerHost interface{} `yaml:"max_idle_conns_per_host,omitempty"`

	/*RequireSsl - Descr: enable ssl for all communication with etcd Default: true
	 */
	RequireSsl interface{} `yaml:"require_ssl,omitempty"`

	/*CaCert - Descr: PEM-encoded CA certificate Default: <nil>
	 */
	CaCert interface{} `yaml:"ca_cert,omitempty"`

	/*ClientSessionCacheSize - Descr: capacity of the tls client cache Default: <nil>
	 */
	ClientSessionCacheSize interface{} `yaml:"client_session_cache_size,omitempty"`

	/*ClientKey - Descr: PEM-encoded client key Default: <nil>
	 */
	ClientKey interface{} `yaml:"client_key,omitempty"`

	/*ClientCert - Descr: PEM-encoded client certificate Default: <nil>
	 */
	ClientCert interface{} `yaml:"client_cert,omitempty"`

	/*Machines - Descr: Addresses pointing to the ETCD cluster Default: [etcd.service.cf.internal]
	 */
	Machines interface{} `yaml:"machines,omitempty"`
}

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

type Sql

type Sql struct {

	/*DbConnectionString - Descr: Connection string to use for SQL backend (for example, username:password@tcp(1.1.1.1:1234)/database) Default: <nil>
	 */
	DbConnectionString interface{} `yaml:"db_connection_string,omitempty"`

	/*RequireSsl - Descr: Whether to require SSL for BBS communication to the SQL backend Default: false
	 */
	RequireSsl interface{} `yaml:"require_ssl,omitempty"`

	/*CaCert - Descr: Bundle of CA certificates for the BBS to verify the SQL server SSL certificate when connecting via SSL Default: <nil>
	 */
	CaCert interface{} `yaml:"ca_cert,omitempty"`

	/*MaxOpenConnections - Descr: Maximum number of open connections to the SQL database Default: <nil>
	 */
	MaxOpenConnections interface{} `yaml:"max_open_connections,omitempty"`

	/*DbDriver - Descr: Database driver to use for SQL backend (for example: mysql,postgres) Default: mysql
	 */
	DbDriver interface{} `yaml:"db_driver,omitempty"`
}

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