On this page

ConnectionPolicy

ConnectionPolicy API reference.

Proto: connection_policy.proto

Package: resilience.policy.gloo.solo.io

ConnectionPolicyReport

Field	Description
`workspaces`	(`repeated ConnectionPolicyReport.WorkspacesEntry`) A list of workspaces in which the policy can apply to workloads.
`selectedDestinationPorts`	(`repeated common.gloo.solo.io.DestinationReference`) A list of destination ports selected by this policy.

Field	Description
`key`	(`string`)
`value`	(`common.gloo.solo.io.Report`)

ConnectionPolicy provides settings to apply low-level settings on selected TCP connections.

Field	Description
`applyToDestinations`	(`repeated common.gloo.solo.io.DestinationSelector`) select the destinations where the policy will be applied. If empty, this will apply to all destinations in the workspace.
`config`	(`ConnectionPolicySpec.Config`) The details of the low-level network connection settings to apply to the destinations.

Field	Description
`tcp`	(`ConnectionPolicySpec.Config.TCPConfig`) The low-level TCP connection settings to apply to the destinations selected.
`http`	(`ConnectionPolicySpec.Config.HTTPConfig`) The low-level HTTP connection settings to apply to the destination selected.

Field	Description
`maxRequestsPerConnection`	(`int32`) Maximum number of requests per connection to a backend. Setting this parameter to 1 disables keep alive. Default 0, meaning “unlimited”, up to 2^29.
`maxRetries`	(`int32`) Maximum number of retries that can be outstanding to all hosts in a cluster at a given time. Defaults to 2^32-1.
`maxRequests`	(`int32`) Maximum number of active requests to a destination. Default 1024. Applicable to both HTTP/1.1 and HTTP2.
`maxPendingRequests`	(`int32`) Maximum number of requests that will be queued while waiting for a ready connection pool connection. Default 1024. If the limit is reached, the request will fail and a 503 error will be returned. Applicable to both HTTP/1.1 and HTTP2.
`idleTimeout`	(`google.protobuf.Duration`) The idle timeout for upstream connection pool connections. The idle timeout is defined as the period in which there are no active requests. If omitted, the default is 1 hour. When the idle timeout is reached, the connection will be closed. If the connection is an HTTP/2 connection a drain sequence will occur prior to closing the connection. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive. Applies to both HTTP1.1 and HTTP2 connections. For more information about the value format, see the Google protocol buffer documentation.

Field	Description
`tcpKeepalive`	(`common.gloo.solo.io.TCPKeepalive`) Sets the TCP keep-alive settings to apply to selected destinations. If the EnableDefaultTcpKeepalive feature gate is enabled, TCP keep-alive is configured on all VirtualDestinations by default, with the probes field set to 9 and the time and interval fields set to 180s, and setting these values will override the defaults for selected VirtualDestinations.
`maxConnections`	(`int32`) Sets the maximum allowed connections to the destination host.
`connectTimeout`	(`google.protobuf.Duration`) Sets the TCP connection timeout. It must be greater than or equal to 1ms. For information about the value format, see the Google protocol buffer documentation.

The status of the policy after it is applied to your Gloo environment.

Field	Description
`common`	(`common.gloo.solo.io.Status`) The state and workspace conditions of the applied resource.
`numSelectedDestinationPorts`	(`uint32`) The number of destination ports selected by this policy.