Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 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: Username for HTTP basic auth to the varz/status endpoint. Default: <nil>
*/
Router *Router `yaml:"router,omitempty"`
/*Nats - Descr: Default: <nil>
*/
Nats *Nats `yaml:"nats,omitempty"`
/*Metron - Descr: The port used to emit dropsonde messages to the Metron agent. Default: 3457
*/
Metron *Metron `yaml:"metron,omitempty"`
/*RoutingApi - Descr: When false, Routing API requires OAuth tokens for authentication. Default: false
*/
RoutingApi *RoutingApi `yaml:"routing_api,omitempty"`
/*Uaa - Descr: Default:
*/
Uaa *Uaa `yaml:"uaa,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
func (*GorouterJob) MarshalYAML ¶
func (j *GorouterJob) MarshalYAML() (interface{}, error)
MarshalYAML implements the yaml.Marshaler interface.
type Logrotate ¶
type Logrotate struct {
/*FreqMin - Descr: The frequency in minutes which logrotate will rotate VM logs Default: 5
*/
FreqMin interface{} `yaml:"freq_min,omitempty"`
/*Size - Descr: The size at which logrotate will decide to rotate the log file Default: 2M
*/
Size interface{} `yaml:"size,omitempty"`
/*Rotate - Descr: The number of files that logrotate will keep around on the VM Default: 7
*/
Rotate interface{} `yaml:"rotate,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Metron ¶
type Metron struct {
/*Port - Descr: The port used to emit dropsonde messages to the Metron agent. Default: 3457
*/
Port interface{} `yaml:"port,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Nats ¶
type Nats struct {
/*User - Descr: Default: <nil>
*/
User interface{} `yaml:"user,omitempty"`
/*Port - Descr: Default: <nil>
*/
Port interface{} `yaml:"port,omitempty"`
/*Machines - Descr: IP of each NATS cluster member. Default: <nil>
*/
Machines interface{} `yaml:"machines,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 {
/*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"`
/*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"`
/*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"`
/*SslKey - Descr: The private ssl key for ssl termination Default:
*/
SslKey interface{} `yaml:"ssl_key,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"`
/*Offset - Descr: Default: 0
*/
Offset interface{} `yaml:"offset,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"`
/*SslSkipValidation - Descr: Skip SSL client cert validation Default: false
*/
SslSkipValidation interface{} `yaml:"ssl_skip_validation,omitempty"`
/*Port - Descr: Listening Port for Router. Default: 80
*/
Port interface{} `yaml:"port,omitempty"`
/*SslCert - Descr: The public ssl cert for ssl termination Default:
*/
SslCert interface{} `yaml:"ssl_cert,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"`
/*DebugAddress - Descr: Address at which to serve debug info Default: 0.0.0.0:17002
*/
DebugAddress interface{} `yaml:"debug_address,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"`
/*EnableProxy - Descr: Enables support for the popular PROXY protocol, allowing downstream load balancers that do not support HTTP to pass along client information. Default: false
*/
EnableProxy interface{} `yaml:"enable_proxy,omitempty"`
/*Logrotate - Descr: The number of files that logrotate will keep around on the VM Default: 7
*/
Logrotate *Logrotate `yaml:"logrotate,omitempty"`
/*LoggingLevel - Descr: Log level for router Default: info
*/
LoggingLevel interface{} `yaml:"logging_level,omitempty"`
/*EnableSsl - Descr: Enable ssl termination on the router Default: false
*/
EnableSsl interface{} `yaml:"enable_ssl,omitempty"`
/*RouteServicesTimeout - Descr: Expiry time of a route service signature in seconds Default: 60
*/
RouteServicesTimeout interface{} `yaml:"route_services_timeout,omitempty"`
/*ExtraHeadersToLog - Descr: A list of headers that log events will be annotated with Default: []
*/
ExtraHeadersToLog interface{} `yaml:"extra_headers_to_log,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"`
/*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"`
/*SecureCookies - Descr: Set secure flag on http cookies Default: false
*/
SecureCookies interface{} `yaml:"secure_cookies,omitempty"`
/*Status - Descr: Username for HTTP basic auth to the varz/status endpoint. Default: <nil>
*/
Status *Status `yaml:"status,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"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type RoutingApi ¶
type RoutingApi struct {
/*Port - Descr: Port on which Routing API is running. Default: 3000
*/
Port interface{} `yaml:"port,omitempty"`
/*Enabled - Descr: When enabled, GoRouter will fetch HTTP routes from the Routing API in addition to routes obtained via NATS. Default: false
*/
Enabled interface{} `yaml:"enabled,omitempty"`
/*AuthDisabled - Descr: When false, Routing API requires OAuth tokens for authentication. Default: false
*/
AuthDisabled interface{} `yaml:"auth_disabled,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 {
/*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"`
/*Port - Descr: Port for the Router varz/status endpoint. Default: 8080
*/
Port interface{} `yaml:"port,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Tracing ¶
type Tracing struct {
/*EnableZipkin - Descr: Enables the addition of the X-B3-Trace-Id header to incoming requests. If the header already exists on the incoming request, it will not be overwritten. Default: false
*/
EnableZipkin interface{} `yaml:"enable_zipkin,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Uaa ¶
type Uaa struct {
/*Port - Descr: Port on which UAA is running. Default: 8080
*/
Port interface{} `yaml:"port,omitempty"`
/*Clients - Descr: Password for UAA client for the gorouter. Default: <nil>
*/
Clients *Clients `yaml:"clients,omitempty"`
/*Ssl - Descr: Secure Port on which UAA is running. Default: <nil>
*/
Ssl *Ssl `yaml:"ssl,omitempty"`
/*CaCert - Descr: Default:
*/
CaCert interface{} `yaml:"ca_cert,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!