gorouter

Documentation

Index

• type Clients
• type Dropsonde
• type Gorouter
• type GorouterJob
• type Logrotate
• type MetronEndpoint
• type Nats
• type Router
• type RoutingApi
• type Ssl
• type Status
• type Uaa

Types

type Clients

type Clients struct {

	/*Gorouter - Descr: Password for UAA client for the gorouter. Default: <nil>
	 */
	Gorouter *Gorouter `yaml:"gorouter,omitempty"`
}

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

type Dropsonde

type Dropsonde struct {

	/*Enabled - Descr: Enable the dropsonde emitter library Default: false
	 */
	Enabled interface{} `yaml:"enabled,omitempty"`
}

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

type Gorouter

type Gorouter struct {

	/*Secret - Descr: Password for UAA client for the gorouter. Default: <nil>
	 */
	Secret interface{} `yaml:"secret,omitempty"`
}

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

type GorouterJob

type GorouterJob struct {

	/*RequestTimeoutInSeconds - Descr: Timeout in seconds for Router -> Endpoint roundtrip. Default: 900
	 */
	RequestTimeoutInSeconds interface{} `yaml:"request_timeout_in_seconds,omitempty"`

	/*Router - Descr: A list of headers that log events will be annotated with Default: []
	 */
	Router *Router `yaml:"router,omitempty"`

	/*Nats - Descr:  Default: <nil>
	 */
	Nats *Nats `yaml:"nats,omitempty"`

	/*RoutingApi - Descr: Enable the GoRouter to receive routes from the Routing API Default: false
	 */
	RoutingApi *RoutingApi `yaml:"routing_api,omitempty"`

	/*MetronEndpoint - Descr: The port used to emit legacy messages to the Metron agent. Default: 3456
	 */
	MetronEndpoint *MetronEndpoint `yaml:"metron_endpoint,omitempty"`

	/*Dropsonde - Descr: Enable the dropsonde emitter library Default: false
	 */
	Dropsonde *Dropsonde `yaml:"dropsonde,omitempty"`

	/*Uaa - Descr: Secure Port on which UAA is running. Default: <nil>
	 */
	Uaa *Uaa `yaml:"uaa,omitempty"`
}

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

type Logrotate

type Logrotate struct {

	/*Rotate - Descr: The number of files that logrotate will keep around on the VM Default: 7
	 */
	Rotate interface{} `yaml:"rotate,omitempty"`

	/*Size - Descr: The size at which logrotate will decide to rotate the log file Default: 2M
	 */
	Size interface{} `yaml:"size,omitempty"`

	/*FreqMin - Descr: The frequency in minutes which logrotate will rotate VM logs Default: 5
	 */
	FreqMin interface{} `yaml:"freq_min,omitempty"`
}

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

type MetronEndpoint

type MetronEndpoint struct {

	/*DropsondePort - Descr: The port used to emit dropsonde messages to the Metron agent. Default: 3457
	 */
	DropsondePort interface{} `yaml:"dropsonde_port,omitempty"`

	/*Host - Descr: The host used to emit messages to the Metron agent. Default: 127.0.0.1
	 */
	Host interface{} `yaml:"host,omitempty"`

	/*Port - Descr: The port used to emit legacy messages to the Metron agent. Default: 3456
	 */
	Port interface{} `yaml:"port,omitempty"`
}

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

type Nats

type Nats struct {

	/*Port - Descr:  Default: <nil>
	 */
	Port interface{} `yaml:"port,omitempty"`

	/*Machines - Descr: IP of each NATS cluster member. Default: <nil>
	 */
	Machines interface{} `yaml:"machines,omitempty"`

	/*User - Descr:  Default: <nil>
	 */
	User interface{} `yaml:"user,omitempty"`

	/*Password - Descr:  Default: <nil>
	 */
	Password interface{} `yaml:"password,omitempty"`
}

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

type Router

type Router struct {

	/*RouteServicesTimeout - Descr: Expiry time of a route service signature in seconds Default: 60
	 */
	RouteServicesTimeout interface{} `yaml:"route_services_timeout,omitempty"`

	/*DrainWait - Descr: Delay in seconds after drain begins before server stops listening.
	During this time the server will respond with 503 Service Unavailable to
	requests having header User-Agent: HTTP-Monitor/1.1. This accommodates
	requests in transit sent while health check responded ok.
	 Default: 0
	*/
	DrainWait interface{} `yaml:"drain_wait,omitempty"`

	/*LoggingLevel - Descr: Log level for router Default: info
	 */
	LoggingLevel interface{} `yaml:"logging_level,omitempty"`

	/*Offset - Descr:  Default: 0
	 */
	Offset interface{} `yaml:"offset,omitempty"`

	/*SslSkipValidation - Descr: Skip SSL client cert validation Default: false
	 */
	SslSkipValidation interface{} `yaml:"ssl_skip_validation,omitempty"`

	/*RouteServicesSecret - Descr: Support for route services is disabled when no value is configured. A robust passphrase is recommended. Default:
	 */
	RouteServicesSecret interface{} `yaml:"route_services_secret,omitempty"`

	/*RouteServicesSecretDecryptOnly - Descr: To rotate keys, add your new key here and deploy. Then swap this key with the value of route_services_secret and deploy again. Default:
	 */
	RouteServicesSecretDecryptOnly interface{} `yaml:"route_services_secret_decrypt_only,omitempty"`

	/*Logrotate - Descr: The size at which logrotate will decide to rotate the log file Default: 2M
	 */
	Logrotate *Logrotate `yaml:"logrotate,omitempty"`

	/*Port - Descr: Listening Port for Router. Default: 80
	 */
	Port interface{} `yaml:"port,omitempty"`

	/*SslKey - Descr: The private ssl key for ssl termination Default:
	 */
	SslKey interface{} `yaml:"ssl_key,omitempty"`

	/*RouteServicesRecommendHttps - Descr: Route Services are told where to send requests after processing using the X-CF-Forwarded-Url header. When this property is true, the scheme for this URL is https. When false, the scheme is http. As requests from Route Services to applications on CF transit load balancers and gorouter, disable this property for deployments that have TLS termination disabled. Default: true
	 */
	RouteServicesRecommendHttps interface{} `yaml:"route_services_recommend_https,omitempty"`

	/*EnableAccessLogStreaming - Descr: Enables streaming of access log to syslog. Warning: this comes with a performance cost; due to higher I/O, max request rate is reduced. Default: false
	 */
	EnableAccessLogStreaming interface{} `yaml:"enable_access_log_streaming,omitempty"`

	/*NumberOfCpus - Descr: Number of CPUs to utilize, the default (-1) will equal the number of available CPUs Default: -1
	 */
	NumberOfCpus interface{} `yaml:"number_of_cpus,omitempty"`

	/*ExtraHeadersToLog - Descr: A list of headers that log events will be annotated with Default: []
	 */
	ExtraHeadersToLog interface{} `yaml:"extra_headers_to_log,omitempty"`

	/*Status - Descr: Port for the Router varz/status endpoint. Default: 8080
	 */
	Status *Status `yaml:"status,omitempty"`

	/*SslCert - Descr: The public ssl cert for ssl termination Default:
	 */
	SslCert interface{} `yaml:"ssl_cert,omitempty"`

	/*SkipOauthTlsVerification - Descr: Skip TLS verification when talking to UAA Default: false
	 */
	SkipOauthTlsVerification interface{} `yaml:"skip_oauth_tls_verification,omitempty"`

	/*CipherSuites - Descr: An ordered list of supported SSL cipher suites containing golang tls constants separated by colons The cipher suite will be chosen according to this order during SSL handshake Default: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256:TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256:TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA:TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA:TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA:TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA:TLS_RSA_WITH_AES_128_CBC_SHA:TLS_RSA_WITH_AES_256_CBC_SHA
	 */
	CipherSuites interface{} `yaml:"cipher_suites,omitempty"`

	/*SecureCookies - Descr: Set secure flag on http cookies Default: false
	 */
	SecureCookies interface{} `yaml:"secure_cookies,omitempty"`

	/*DebugAddr - Descr: Address at which to serve debug info Default: 0.0.0.0:17001
	 */
	DebugAddr interface{} `yaml:"debug_addr,omitempty"`

	/*DnsHealthCheckHost - Descr: Host to ping for confirmation of DNS resolution, only used when Routing API is enabled Default: consul.service.cf.internal
	 */
	DnsHealthCheckHost interface{} `yaml:"dns_health_check_host,omitempty"`

	/*RequestedRouteRegistrationIntervalInSeconds - Descr: On startup, the router will delay listening for requests by this duration to increase likelihood that it has a complete routing table before serving requests. The router also broadcasts the same duration as a recommended interval to registering clients via NATS. Default: 20
	 */
	RequestedRouteRegistrationIntervalInSeconds interface{} `yaml:"requested_route_registration_interval_in_seconds,omitempty"`

	/*EnableSsl - Descr: Enable ssl termination on the router Default: false
	 */
	EnableSsl interface{} `yaml:"enable_ssl,omitempty"`

	/*TraceKey - Descr: If the X-Vcap-Trace request header is set and has this value, trace headers are added to the response. Default: 22
	 */
	TraceKey interface{} `yaml:"trace_key,omitempty"`
}

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

type RoutingApi

type RoutingApi struct {

	/*AuthDisabled - Descr: Disables UAA authentication Default: false
	 */
	AuthDisabled interface{} `yaml:"auth_disabled,omitempty"`

	/*Port - Descr: Port on which routing-api is running. Default: 3000
	 */
	Port interface{} `yaml:"port,omitempty"`

	/*Enabled - Descr: Enable the GoRouter to receive routes from the Routing API Default: false
	 */
	Enabled interface{} `yaml:"enabled,omitempty"`
}

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

type Ssl

type Ssl struct {

	/*Port - Descr: Secure Port on which UAA is running. Default: <nil>
	 */
	Port interface{} `yaml:"port,omitempty"`
}

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

type Status

type Status struct {

	/*Port - Descr: Port for the Router varz/status endpoint. Default: 8080
	 */
	Port interface{} `yaml:"port,omitempty"`

	/*Password - Descr: Password for HTTP basic auth to the varz/status endpoint. Default: <nil>
	 */
	Password interface{} `yaml:"password,omitempty"`

	/*User - Descr: Username for HTTP basic auth to the varz/status endpoint. Default: <nil>
	 */
	User interface{} `yaml:"user,omitempty"`
}

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

type Uaa

type Uaa struct {

	/*Clients - Descr: Password for UAA client for the gorouter. Default: <nil>
	 */
	Clients *Clients `yaml:"clients,omitempty"`

	/*Port - Descr: Port on which UAA is running. Default: 8080
	 */
	Port interface{} `yaml:"port,omitempty"`

	/*Ssl - Descr: Secure Port on which UAA is running. Default: <nil>
	 */
	Ssl *Ssl `yaml:"ssl,omitempty"`
}

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