Packages:

- projectcontour.io/v1

## projectcontour.io/v1

Package v1 is the v1 version of the API.

Resource Types:

- HTTPProxy
- TLSCertificateDelegation

### HTTPProxy

HTTPProxy is an Ingress CRD specification

Field | Description
--- | ---
`apiVersion` string | `projectcontour.io/v1`
`kind` string | `HTTPProxy`
`metadata` Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the `metadata` field.
`spec` HTTPProxySpec |
`virtualhost` VirtualHost | (Optional) Virtualhost appears at most once. If it is present, the object is considered to be a “root”.
`routes` []Route | (Optional) Routes are the ingress routes. If TCPProxy is present, Routes is ignored.
`tcpproxy` TCPProxy | (Optional) TCPProxy holds TCP proxy information.
`includes` []Include | (Optional) Includes allow for specific routing configuration to be appended to another HTTPProxy in another namespace.
`status` Status | (Optional)

### TLSCertificateDelegation

TLSCertificateDelegation is an TLS Certificate Delegation CRD specification. See design/tls-certificate-delegation.md for details.

Field | Description
--- | ---
`apiVersion` string | `projectcontour.io/v1`
`kind` string | `TLSCertificateDelegation`
`metadata` Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the `metadata` field.
`spec` TLSCertificateDelegationSpec |
`delegations` []CertificateDelegation |

### CertificateDelegation

(Appears on: TLSCertificateDelegationSpec)

CertificateDelegation maps the authority to reference a secret in the current namespace to a set of namespaces.

Field | Description
--- | ---
`secretName` string | required, the name of a secret in the current namespace.
`targetNamespaces` []string | required, the namespaces the authority to reference the the secret will be delegated to. If TargetNamespaces is nil or empty, the CertificateDelegation’ is ignored. If the TargetNamespace list contains the character, “*” the secret will be delegated to all namespaces.

### Condition

(Appears on: Include, Route)

Condition are policies that are applied on top of HTTPProxies. One of Prefix or Header must be provided.

Field | Description
--- | ---
`prefix` string | (Optional) Prefix defines a prefix match for a request.
`header` HeaderCondition | (Optional) Header specifies the header condition to match.

### DownstreamValidation

(Appears on: TLS)

DownstreamValidation defines how to verify the client certificate.

Field | Description
--- | ---
`caSecret` string | Name of a Kubernetes secret that contains a CA certificate bundle. The client certificate must validate against the certificates in the bundle.

### HTTPHealthCheckPolicy

(Appears on: Route)

HTTPHealthCheckPolicy defines health checks on the upstream service.

Field | Description
--- | ---
`path` string | HTTP endpoint used to perform health checks on upstream service
`host` string | The value of the host header in the HTTP health check request. If left empty (default value), the name “contour-envoy-healthcheck” will be used.
`intervalSeconds` int64 | (Optional) The interval (seconds) between health checks
`timeoutSeconds` int64 | (Optional) The time to wait (seconds) for a health check response
`unhealthyThresholdCount` int64 | (Optional) The number of unhealthy health checks required before a host is marked unhealthy
`healthyThresholdCount` int64 | (Optional) The number of healthy health checks required before a host is marked healthy

### HTTPProxySpec

(Appears on: HTTPProxy)

HTTPProxySpec defines the spec of the CRD.

Field | Description
--- | ---
`virtualhost` VirtualHost | (Optional) Virtualhost appears at most once. If it is present, the object is considered to be a “root”.
`routes` []Route | (Optional) Routes are the ingress routes. If TCPProxy is present, Routes is ignored.
`tcpproxy` TCPProxy | (Optional) TCPProxy holds TCP proxy information.
`includes` []Include | (Optional) Includes allow for specific routing configuration to be appended to another HTTPProxy in another namespace.

### HeaderCondition

(Appears on: Condition)

HeaderCondition specifies how to conditionally match against HTTP headers. The Name field is required, but only one of the remaining fields should be be provided.

Field | Description
--- | ---
`name` string | Name is the name of the header to match against. Name is required. Header names are case insensitive.
`present` bool | (Optional) Present specifies that condition is true when the named header is present, regardless of its value. Note that setting Present to false does not make the condition true if the named header is absent.
`contains` string | (Optional) Contains specifies a substring that must be present in the header value.
`notcontains` string | (Optional) NotContains specifies a substring that must not be present in the header value.
`exact` string | (Optional) Exact specifies a string that the header value must be equal to.
`notexact` string | (Optional) NoExact specifies a string that the header value must not be equal to. The condition is true if the header has any other value.

### HeaderValue

(Appears on: HeadersPolicy)

HeaderValue represents a header name/value pair

Field | Description
--- | ---
`name` string | Name represents a key of a header
`value` string | Value represents the value of a header specified by a key

### HeadersPolicy

(Appears on: Route, Service)

HeadersPolicy defines how headers are managed during forwarding

Field | Description
--- | ---
`set` []HeaderValue | (Optional) Set specifies a list of HTTP header values that will be set in the HTTP header
`remove` []string | (Optional) Remove specifies a list of HTTP header names to remove

### Include

(Appears on: HTTPProxySpec)

Include describes a set of policies that can be applied to an HTTPProxy in a namespace.

Field | Description
--- | ---
`name` string | Name of the HTTPProxy
`namespace` string | (Optional) Namespace of the HTTPProxy to include. Defaults to the current namespace if not supplied.
`conditions` []Condition | (Optional) Conditions are a set of routing properties that is applied to an HTTPProxy in a namespace.

### LoadBalancerPolicy

(Appears on: Route, TCPProxy)

LoadBalancerPolicy defines the load balancing policy.

Field | Description
--- | ---
`strategy` string | Strategy specifies the policy used to balance requests across the pool of backend pods. Valid policy names are `Random`, `RoundRobin`, `WeightedLeastRequest`, `Random` and `Cookie`. If an unknown strategy name is specified or no policy is supplied, the default `RoundRobin` policy is used.

### PathRewritePolicy

(Appears on: Route)

PathRewritePolicy specifies how a request URL path should be rewritten. This rewriting takes place after a request is routed and has no subsequent effects on the proxy’s routing decision. No HTTP headers or body content is rewritten.

Exactly one field in this struct may be specified.

Field | Description
--- | ---
`replacePrefix` []ReplacePrefix | (Optional) ReplacePrefix describes how the path prefix should be replaced.

### ReplacePrefix

(Appears on: PathRewritePolicy)

ReplacePrefix describes a path prefix replacement.

Field | Description
--- | ---
`prefix` string | (Optional) Prefix specifies the URL path prefix to be replaced. If Prefix is specified, it must exactly match the Condition prefix that is rendered by the chain of including HTTPProxies and only that path prefix will be replaced by Replacement. This allows HTTPProxies that are included through multiple roots to only replace specific path prefixes, leaving others unmodified. If Prefix is not specified, all routing prefixes rendered by the include chain will be replaced.
`replacement` string | Replacement is the string that the routing path prefix will be replaced with. This must not be empty.

### RetryPolicy

(Appears on: Route)

RetryPolicy defines the attributes associated with retrying policy.

Field | Description
--- | ---
`count` int64 | (Optional) NumRetries is maximum allowed number of retries. If not supplied, the number of retries is one.
`perTryTimeout` string | PerTryTimeout specifies the timeout per retry attempt. Ignored if NumRetries is not supplied.

### Route

(Appears on: HTTPProxySpec)

Route contains the set of routes for a virtual host.

Field | Description
--- | ---
`conditions` []Condition | (Optional) Conditions are a set of routing properties that is applied to an HTTPProxy in a namespace.
`services` []Service | Services are the services to proxy traffic.
`enableWebsockets` bool | (Optional) Enables websocket support for the route.
`permitInsecure` bool | (Optional) Allow this path to respond to insecure requests over HTTP which are normally not permitted when a `virtualhost.tls` block is present.
`timeoutPolicy` TimeoutPolicy | (Optional) The timeout policy for this route.
`retryPolicy` RetryPolicy | (Optional) The retry policy for this route.
`healthCheckPolicy` HTTPHealthCheckPolicy | (Optional) The health check policy for this route.
`loadBalancerPolicy` LoadBalancerPolicy | (Optional) The load balancing policy for this route.
`pathRewritePolicy` PathRewritePolicy | (Optional) The policy for rewriting the path of the request URL after the request has been routed to a Service.
`requestHeadersPolicy` HeadersPolicy | (Optional) The policy for managing request headers during proxying
`responseHeadersPolicy` HeadersPolicy | (Optional) The policy for managing response headers during proxying

### Service

(Appears on: Route, TCPProxy)

Service defines an Kubernetes Service to proxy traffic.

Field | Description
--- | ---
`name` string | Name is the name of Kubernetes service to proxy traffic. Names defined here will be used to look up corresponding endpoints which contain the ips to route.
`port` int | Port (defined as Integer) to proxy traffic to since a service can have multiple defined.
`protocol` string | (Optional) Protocol may be used to specify (or override) the protocol used to reach this Service. Values may be tls, h2, h2c. If omitted, protocol-selection falls back on Service annotations.
`weight` int64 | (Optional) Weight defines percentage of traffic to balance traffic
`validation` UpstreamValidation | (Optional) UpstreamValidation defines how to verify the backend service’s certificate
`mirror` bool | If Mirror is true the Service will receive a read only mirror of the traffic for this route.
`requestHeadersPolicy` HeadersPolicy | (Optional) The policy for managing request headers during proxying
`responseHeadersPolicy` HeadersPolicy | (Optional) The policy for managing response headers during proxying

### Status

(Appears on: HTTPProxy)

Status reports the current state of the HTTPProxy.

Field | Description
--- | ---
`currentStatus` string | (Optional)
`description` string | (Optional)

### TCPHealthCheckPolicy

(Appears on: TCPProxy)

TCPHealthCheckPolicy defines health checks on the upstream service.

Field | Description
--- | ---
`intervalSeconds` int64 | (Optional) The interval (seconds) between health checks
`timeoutSeconds` int64 | (Optional) The time to wait (seconds) for a health check response
`unhealthyThresholdCount` uint32 | (Optional) The number of unhealthy health checks required before a host is marked unhealthy
`healthyThresholdCount` uint32 | (Optional) The number of healthy health checks required before a host is marked healthy

### TCPProxy

(Appears on: HTTPProxySpec)

TCPProxy contains the set of services to proxy TCP connections.

Field | Description
--- | ---
`loadBalancerPolicy` LoadBalancerPolicy | (Optional) The load balancing policy for the backend services.
`services` []Service | Services are the services to proxy traffic
`include` TCPProxyInclude | (Optional) Include specifies that this tcpproxy should be delegated to another HTTPProxy.
`includes` TCPProxyInclude | (Optional) IncludesDeprecated allow for specific routing configuration to be appended to another HTTPProxy in another namespace. Exists due to a mistake when developing HTTPProxy and the field was marked plural when it should have been singular. This field should stay to not break backwards compatibility to v1 users.
`healthCheckPolicy` TCPHealthCheckPolicy | (Optional) The health check policy for this tcp proxy

### TCPProxyInclude

(Appears on: TCPProxy)

TCPProxyInclude describes a target HTTPProxy document which contains the TCPProxy details.

Field | Description
--- | ---
`name` string | Name of the child HTTPProxy
`namespace` string | (Optional) Namespace of the HTTPProxy to include. Defaults to the current namespace if not supplied.

### TLS

(Appears on: VirtualHost)

TLS describes tls properties. The SNI names that will be matched on are described in fqdn, the tls.secretName secret must contain a matching certificate unless tls.passthrough is set to true.

Field | Description
--- | ---
`secretName` string | required, the name of a secret in the current namespace
`minimumProtocolVersion` string | (Optional) Minimum TLS version this vhost should negotiate
`passthrough` bool | (Optional) If Passthrough is set to true, the SecretName will be ignored and the encrypted handshake will be passed through to the backing cluster.
`clientValidation` DownstreamValidation | (Optional) ClientValidation defines how to verify the client certificate when an external client establishes a TLS connection to Envoy. This setting: 1. Enables TLS client certificate validation. 2. Requires clients to present a TLS certificate (i.e. not optional validation). 3. Specifies how the client certificate will be validated.

### TLSCertificateDelegationSpec

(Appears on: TLSCertificateDelegation)

TLSCertificateDelegationSpec defines the spec of the CRD

Field | Description
--- | ---
`delegations` []CertificateDelegation |

### TimeoutPolicy

(Appears on: Route)

TimeoutPolicy defines the attributes associated with timeout.

Field | Description
--- | ---
`response` string | (Optional) Timeout for receiving a response from the server after processing a request from client. If not supplied the timeout duration is undefined.
`idle` string | (Optional) Timeout after which if there are no active requests for this route, the connection between Envoy and the backend will be closed. If not specified, there is no per-route idle timeout.

### UpstreamValidation

(Appears on: Service)

UpstreamValidation defines how to verify the backend service’s certificate

Field | Description
--- | ---
`caSecret` string | Name of the Kubernetes secret be used to validate the certificate presented by the backend
`subjectName` string | Key which is expected to be present in the ‘subjectAltName’ of the presented certificate

### VirtualHost

(Appears on: HTTPProxySpec)

VirtualHost appears at most once. If it is present, the object is considered to be a “root”.

Field | Description
--- | ---
`fqdn` string | The fully qualified domain name of the root of the ingress tree all leaves of the DAG rooted at this object relate to the fqdn
`tls` TLS | (Optional) If present describes tls properties. The SNI names that will be matched on are described in fqdn, the tls.secretName secret must contain a matching certificate

Generated with `gen-crd-api-reference-docs`.