gorouter

package
v1.0.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 6, 2017 License: Apache-2.0 Imports: 0 Imported by: 0

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 {

	/*Router - 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:
	 */
	Router *Router `yaml:"router,omitempty"`

	/*Nats - Descr: IP of each NATS cluster member. Default: <nil>
	 */
	Nats *Nats `yaml:"nats,omitempty"`

	/*Uaa - Descr: Port on which UAA is running. Default: 8080
	 */
	Uaa *Uaa `yaml:"uaa,omitempty"`

	/*RoutingApi - Descr: When enabled, GoRouter will fetch HTTP routes from the Routing API in addition to routes obtained via NATS. Default: false
	 */
	RoutingApi *RoutingApi `yaml:"routing_api,omitempty"`

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

	/*Metron - Descr: The port used to emit dropsonde messages to the Metron agent. Default: 3457
	 */
	Metron *Metron `yaml:"metron,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"`

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

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

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

type Router 

type Router struct {

	/*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"`

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

	/*DebugAddress - Descr: Address at which to serve debug info Default: 0.0.0.0:17002
	 */
	DebugAddress interface{} `yaml:"debug_address,omitempty"`

	/*SslCert - Descr: The public ssl cert for ssl termination Default:
	 */
	SslCert interface{} `yaml:"ssl_cert,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"`

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

	/*Offset - Descr:  Default: 0
	 */
	Offset interface{} `yaml:"offset,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: {Value of router.healthcheck_user_agent}.
	This accommodates requests in transit sent during the time the health
	check responded with `ok`.
	 Default: 0
	*/
	DrainWait interface{} `yaml:"drain_wait,omitempty"`

	/*SuspendPruningIfNatsUnavailable - Descr: Suspend pruning of routes when NATs is unavailable and maintain the
	current routing table. WARNING: This strategy favors availability over
	consistency and there is a possibility of routing to an incorrect
	endpoint in the case of port re-use. To be used with caution."
	 Default: false
	*/
	SuspendPruningIfNatsUnavailable interface{} `yaml:"suspend_pruning_if_nats_unavailable,omitempty"`

	/*HealthcheckUserAgent - Descr: User-Agent for the health check agent (usually the Load Balancer). Default: HTTP-Monitor/1.1
	 */
	HealthcheckUserAgent interface{} `yaml:"healthcheck_user_agent,omitempty"`

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

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

	/*Logrotate - Descr: The number of files that logrotate will keep around on the VM Default: 7
	 */
	Logrotate *Logrotate `yaml:"logrotate,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"`

	/*EnableSsl - Descr: Enable ssl termination on the router Default: false
	 */
	EnableSsl interface{} `yaml:"enable_ssl,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"`

	/*BalancingAlgorithm - Descr: Algorithm used to distribute requests for a route across backends. Supported values are round-robin and least-connection Default: round-robin
	 */
	BalancingAlgorithm interface{} `yaml:"balancing_algorithm,omitempty"`

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

	/*Port - Descr: Listening Port for Router. Default: 80
	 */
	Port interface{} `yaml:"port,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"`

	/*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"`

	/*Status - Descr: Port for the Router varz/status endpoint. Default: 8080
	 */
	Status *Status `yaml:"status,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"`

	/*LoadBalancerHealthyThreshold - Descr: Time period in seconds to wait until declaring the router instance started after starting the listener socket. This allows an external load balancer time to register the instance as healthy. Default: 20
	 */
	LoadBalancerHealthyThreshold interface{} `yaml:"load_balancer_healthy_threshold,omitempty"`

	/*Tracing - 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
	 */
	Tracing *Tracing `yaml:"tracing,omitempty"`

	/*ForceForwardedProtoHttps - Descr: Enables setting X-Forwarded-Proto header if SSL termination happened upstream and incorrectly set the header value. When this property is set to true gorouter sets the header X-Forwarded-Proto to https. When this value set to false, gorouter set the header X-Forwarded-Proto to the protocol of the incoming request Default: false
	 */
	ForceForwardedProtoHttps interface{} `yaml:"force_forwarded_proto_https,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"`

	/*EnableAccessLogStreaming - Descr: Enables streaming of access log to syslog. 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"`

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

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

type RoutingApi 

type RoutingApi struct {

	/*AuthDisabled - Descr: When false, Routing API requires OAuth tokens for authentication. Default: false
	 */
	AuthDisabled interface{} `yaml:"auth_disabled,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"`

	/*Port - Descr: Port on which Routing API is running. Default: 3000
	 */
	Port interface{} `yaml:"port,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 {

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

	/*CaCert - Descr: Certificate authority for communication between clients and uaa. Default:
	 */
	CaCert interface{} `yaml:"ca_cert,omitempty"`

	/*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"`
}

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.