APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

CanaryTemplateSpec defines the desired state of CanaryTemplate

Analysis defines the validation process of a release

AutoscalerRef references an autoscaling resource

Deprecated: replaced by Analysis

if set true,we will rollback canary workload modify

Reference to NGINX ingress resource

MetricsServer overwrites the -metrics-server flag for this particular canary

ProgressDeadlineSeconds represents the maximum time in seconds for a canary deployment to make progress before it is considered to be failed

Service defines how ClusterIP services, service mesh or ingress routing objects are generated

SkipAnalysis promotes the canary without analysing it

TargetRef references a target resource

Schedule interval for this canary analysis

Number of checks to run for A/B Testing and Blue/Green

A/B testing HTTP header match conditions

Max traffic percentage routed to canary

Metric check list for this canary analysis

Enable traffic mirroring for Blue/Green

Incremental traffic percentage step

Incremental traffic percentage step for promotion phase

Max number of failed checks before the canary is terminated

Webhook list for this canary analysis

HTTP Authority values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match

Names of gateways where the rule should be applied to. Gateway names at the top of the VirtualService (if any) are overridden. The gateway match is independent of sourceLabels.

The header keys must be lowercase and use hyphen as the separator, e.g. x-request-id. Header values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match Note: The keys uri, scheme, method, and authority will be ignored.

HTTP Method values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match

Specifies the ports on the host that is being addressed. Many services only expose a single port or label ports with the protocols they support, in these cases it is not required to explicitly select the port.

URI Scheme values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match

One or more labels that constrain the applicability of a rule to workloads with the given labels. If the VirtualService has a list of gateways specified at the top, it should include the reserved gateway mesh in order for this field to be applicable.

URI to match values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match

exact string match

prefix-based match

ECMAscript style regex-based match

suffix-based match.

exact string match

prefix-based match

ECMAscript style regex-based match

suffix-based match.

exact string match

prefix-based match

ECMAscript style regex-based match

suffix-based match.

exact string match

prefix-based match

ECMAscript style regex-based match

suffix-based match.

Interval represents the windows size

Name of the metric

Prometheus query for this metric (deprecated in favor of TemplateRef)

TemplateRef references a metric template object

Max value accepted for this metric

Range value accepted for this metric

API version of the referent

Kind of the referent

Name of the referent

Namespace of the referent

Maximum value

Minimum value

Metadata (key-value pairs) for this webhook

Name of this webhook

Request timeout for this webhook

Type of this webhook

URL address of this webhook

API version of the referent

Kind of the referent

Name of the referent

Namespace of the referent

Schedule interval for this canary analysis

Number of checks to run for A/B Testing and Blue/Green

A/B testing HTTP header match conditions

Max traffic percentage routed to canary

Metric check list for this canary analysis

Enable traffic mirroring for Blue/Green

Incremental traffic percentage step

Incremental traffic percentage step for promotion phase

Max number of failed checks before the canary is terminated

Webhook list for this canary analysis

HTTP Authority values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match

Names of gateways where the rule should be applied to. Gateway names at the top of the VirtualService (if any) are overridden. The gateway match is independent of sourceLabels.

The header keys must be lowercase and use hyphen as the separator, e.g. x-request-id. Header values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match Note: The keys uri, scheme, method, and authority will be ignored.

HTTP Method values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match

Specifies the ports on the host that is being addressed. Many services only expose a single port or label ports with the protocols they support, in these cases it is not required to explicitly select the port.

URI Scheme values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match

One or more labels that constrain the applicability of a rule to workloads with the given labels. If the VirtualService has a list of gateways specified at the top, it should include the reserved gateway mesh in order for this field to be applicable.

URI to match values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match

exact string match

prefix-based match

ECMAscript style regex-based match

suffix-based match.

exact string match

prefix-based match

ECMAscript style regex-based match

suffix-based match.

exact string match

prefix-based match

ECMAscript style regex-based match

suffix-based match.

exact string match

prefix-based match

ECMAscript style regex-based match

suffix-based match.

Interval represents the windows size

Name of the metric

Prometheus query for this metric (deprecated in favor of TemplateRef)

TemplateRef references a metric template object

Max value accepted for this metric

Range value accepted for this metric

API version of the referent

Kind of the referent

Name of the referent

Namespace of the referent

Maximum value

Minimum value

Metadata (key-value pairs) for this webhook

Name of this webhook

Request timeout for this webhook

Type of this webhook

URL address of this webhook

API version of the referent

Kind of the referent

Name of the referent

Namespace of the referent

Backends of the generated App Mesh virtual nodes

Cross-Origin Resource Sharing policy for the generated Istio virtual service

Gateways attached to the generated Istio virtual service Defaults to the internal mesh gateway

Headers operations for the generated Istio virtual service

Hosts attached to the generated Istio virtual service Defaults to the service name

URI match conditions for the generated service

Mesh name of the generated App Mesh virtual nodes and virtual service

Name of the Kubernetes service generated by Flagger Defaults to CanarySpec.TargetRef.Name

Port of the generated Kubernetes service

PortDiscovery adds all container ports to the generated Kubernetes service

Port name of the generated Kubernetes service Defaults to http

Retries policy for the generated virtual service

Rewrite HTTP URIs for the generated service

Target port number or name of the generated Kubernetes service Defaults to CanaryService.Port

Timeout of the HTTP or gRPC request

TrafficPolicy attached to the generated Istio destination rules

Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials. Translates to Access-Control-Allow-Credentials header.

List of HTTP headers that can be used when requesting the resource. Serialized to Access-Control-Allow-Methods header.

List of HTTP methods allowed to access the resource. The content will be serialized into the Access-Control-Allow-Methods header.

The list of origins that are allowed to perform CORS requests. The content will be serialized into the Access-Control-Allow-Origin header. Wildcard * will allow all origins.

A white list of HTTP headers that the browsers are allowed to access. Serialized into Access-Control-Expose-Headers header.

Specifies how long the the results of a preflight request can be cached. Translates to the Access-Control-Max-Age header.

Header manipulation rules to apply before forwarding a request to the destination service

Header manipulation rules to apply before returning a response to the caller

Append the given values to the headers specified by keys (will create a comma-separated list of values)

Remove the specified headers

Overwrite the headers specified by key with the given values

Append the given values to the headers specified by keys (will create a comma-separated list of values)

Remove the specified headers

Overwrite the headers specified by key with the given values

HTTP Authority values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match

Names of gateways where the rule should be applied to. Gateway names at the top of the VirtualService (if any) are overridden. The gateway match is independent of sourceLabels.

The header keys must be lowercase and use hyphen as the separator, e.g. x-request-id. Header values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match Note: The keys uri, scheme, method, and authority will be ignored.

HTTP Method values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match

Specifies the ports on the host that is being addressed. Many services only expose a single port or label ports with the protocols they support, in these cases it is not required to explicitly select the port.

URI Scheme values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match

One or more labels that constrain the applicability of a rule to workloads with the given labels. If the VirtualService has a list of gateways specified at the top, it should include the reserved gateway mesh in order for this field to be applicable.

URI to match values are case-sensitive and formatted as follows:

• exact: "value" for exact string match
• prefix: "value" for prefix-based match
• regex: "value" for ECMAscript style regex-based match

exact string match

prefix-based match

ECMAscript style regex-based match

suffix-based match.

exact string match

prefix-based match

ECMAscript style regex-based match

suffix-based match.

exact string match

prefix-based match

ECMAscript style regex-based match

suffix-based match.

exact string match

prefix-based match

ECMAscript style regex-based match

suffix-based match.

REQUIRED. Number of retries for a given request. The interval between retries will be determined automatically (25ms+). Actual number of retries attempted depends on the httpReqTimeout.

Timeout per retry attempt for a given request. format: 1h/1m/1s/1ms. MUST BE >=1ms.

Specifies the conditions under which retry takes place. One or more policies can be specified using a ‘,’ delimited list. The supported policies can be found in https://www.envoyproxy.io/docs/envoy/latest/configuration/http_filters/router_filter#x-envoy-retry-on and https://www.envoyproxy.io/docs/envoy/latest/configuration/http_filters/router_filter#x-envoy-retry-grpc-on

rewrite the Authority/Host header with this value.

rewrite the path (or the prefix) portion of the URI with this value. If the original URI was matched based on prefix, the value provided in this field will replace the corresponding matched prefix.

Settings controlling the volume of connections to an upstream service

Settings controlling the load balancer algorithms.

Settings controlling eviction of unhealthy hosts from the load balancing pool

Traffic policies specific to individual ports. Note that port level settings will override the destination-level settings. Traffic settings specified at the destination-level will not be inherited when overridden by port-level settings, i.e. default values will be applied to fields omitted in port-level traffic policies.

TLS related settings for connections to the upstream service.

HTTP connection pool settings.

Settings common to both HTTP and TCP upstream connections.

Specify if http1.1 connection should be upgraded to http2 for the associated destination. DEFAULT - Use the global default. DO_NOT_UPGRADE - Do not upgrade the connection to http2. UPGRADE - Upgrade the connection to http2.

Maximum number of pending HTTP requests to a destination. Default 2^32-1.

Maximum number of requests to a backend. Default 2^32-1.

The idle timeout for upstream connection pool connections. The idle timeout is defined as the period in which there are no active requests. If not set, the default is 1 hour. When the idle timeout is reached the connection will be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive. Applies to both HTTP1.1 and HTTP2 connections.

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.

Maximum number of retries that can be outstanding to all hosts in a cluster at a given time. Defaults to 2^32-1.

TCP connection timeout.

Maximum number of HTTP1 /TCP connections to a destination host.

Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service.

It is required to specify exactly one of the fields: Simple or ConsistentHash

Hash based on HTTP cookie.

It is required to specify exactly one of the fields as hash key: HTTPHeaderName, HTTPCookie, or UseSourceIP. Hash based on a specific HTTP header.

The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.

Hash based on the source IP address.

REQUIRED. Name of the cookie.

Path to set for the cookie.

REQUIRED. Lifetime of the cookie.

Minimum ejection duration. A host will remain ejected for a period equal to the product of minimum ejection duration and the number of times the host has been ejected. This technique allows the system to automatically increase the ejection period for unhealthy upstream servers. format: 1h/1m/1s/1ms. MUST BE >=1ms. Default is 30s.

Number of 5xx errors before a host is ejected from the connection pool. When the upstream host is accessed over an opaque TCP connection, connect timeouts, connection error/failure and request failure events qualify as a 5xx error. This feature defaults to 5 but can be disabled by setting the value to 0. Note that consecutive_gateway_errors and consecutive_5xx_errors can be used separately or together. Because the errors counted by consecutive_gateway_errors are also included in consecutive_5xx_errors, if the value of consecutive_gateway_errors is greater than or equal to the value of consecutive_5xx_errors, consecutive_gateway_errors will have no effect.

Number of errors before a host is ejected from the connection pool. Defaults to 5. When the upstream host is accessed over HTTP, a 5xx return code qualifies as an error. When the upstream host is accessed over an opaque TCP connection, connect timeouts and connection error/failure events qualify as an error.

Number of gateway errors before a host is ejected from the connection pool. When the upstream host is accessed over HTTP, a 502, 503, or 504 return code qualifies as a gateway error. When the upstream host is accessed over an opaque TCP connection, connect timeouts and connection error/failure events qualify as a gateway error. This feature is disabled by default or when set to the value 0. Note that consecutive_gateway_errors and consecutive_5xx_errors can be used separately or together. Because the errors counted by consecutive_gateway_errors are also included in consecutive_5xx_errors, if the value of consecutive_gateway_errors is greater than or equal to the value of consecutive_5xx_errors, consecutive_gateway_errors will have no effect.

Time interval between ejection sweep analysis. format: 1h/1m/1s/1ms. MUST BE >=1ms. Default is 10s.

Maximum % of hosts in the load balancing pool for the upstream service that can be ejected. Defaults to 10%.

Outlier detection will be enabled as long as the associated load balancing pool has at least min_health_percent hosts in healthy mode. When the percentage of healthy hosts in the load balancing pool drops below this threshold, outlier detection will be disabled and the proxy will load balance across all hosts in the pool (healthy and unhealthy). The threshold can be disabled by setting it to 0%. The default is 0% as it's not typically applicable in k8s environments with few pods per service.

Settings controlling the volume of connections to an upstream service

Settings controlling the load balancer algorithms.

Settings controlling eviction of unhealthy hosts from the load balancing pool

Specifies the port name or number of a port on the destination service on which this policy is being applied. Names must comply with DNS label syntax (rfc1035) and therefore cannot collide with numbers. If there are multiple ports on a service with the same protocol the names should be of the form -.

TLS related settings for connections to the upstream service.

HTTP connection pool settings.

Settings common to both HTTP and TCP upstream connections.

Specify if http1.1 connection should be upgraded to http2 for the associated destination. DEFAULT - Use the global default. DO_NOT_UPGRADE - Do not upgrade the connection to http2. UPGRADE - Upgrade the connection to http2.

Maximum number of pending HTTP requests to a destination. Default 2^32-1.

Maximum number of requests to a backend. Default 2^32-1.

The idle timeout for upstream connection pool connections. The idle timeout is defined as the period in which there are no active requests. If not set, the default is 1 hour. When the idle timeout is reached the connection will be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive. Applies to both HTTP1.1 and HTTP2 connections.

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.

Maximum number of retries that can be outstanding to all hosts in a cluster at a given time. Defaults to 2^32-1.

TCP connection timeout.

Maximum number of HTTP1 /TCP connections to a destination host.

Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service.

It is required to specify exactly one of the fields: Simple or ConsistentHash

Hash based on HTTP cookie.

It is required to specify exactly one of the fields as hash key: HTTPHeaderName, HTTPCookie, or UseSourceIP. Hash based on a specific HTTP header.

The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.

Hash based on the source IP address.

REQUIRED. Name of the cookie.

Path to set for the cookie.

REQUIRED. Lifetime of the cookie.

Minimum ejection duration. A host will remain ejected for a period equal to the product of minimum ejection duration and the number of times the host has been ejected. This technique allows the system to automatically increase the ejection period for unhealthy upstream servers. format: 1h/1m/1s/1ms. MUST BE >=1ms. Default is 30s.

Number of 5xx errors before a host is ejected from the connection pool. When the upstream host is accessed over an opaque TCP connection, connect timeouts, connection error/failure and request failure events qualify as a 5xx error. This feature defaults to 5 but can be disabled by setting the value to 0. Note that consecutive_gateway_errors and consecutive_5xx_errors can be used separately or together. Because the errors counted by consecutive_gateway_errors are also included in consecutive_5xx_errors, if the value of consecutive_gateway_errors is greater than or equal to the value of consecutive_5xx_errors, consecutive_gateway_errors will have no effect.

Number of errors before a host is ejected from the connection pool. Defaults to 5. When the upstream host is accessed over HTTP, a 5xx return code qualifies as an error. When the upstream host is accessed over an opaque TCP connection, connect timeouts and connection error/failure events qualify as an error.

Number of gateway errors before a host is ejected from the connection pool. When the upstream host is accessed over HTTP, a 502, 503, or 504 return code qualifies as a gateway error. When the upstream host is accessed over an opaque TCP connection, connect timeouts and connection error/failure events qualify as a gateway error. This feature is disabled by default or when set to the value 0. Note that consecutive_gateway_errors and consecutive_5xx_errors can be used separately or together. Because the errors counted by consecutive_gateway_errors are also included in consecutive_5xx_errors, if the value of consecutive_gateway_errors is greater than or equal to the value of consecutive_5xx_errors, consecutive_gateway_errors will have no effect.

Time interval between ejection sweep analysis. format: 1h/1m/1s/1ms. MUST BE >=1ms. Default is 10s.

Maximum % of hosts in the load balancing pool for the upstream service that can be ejected. Defaults to 10%.

Outlier detection will be enabled as long as the associated load balancing pool has at least min_health_percent hosts in healthy mode. When the percentage of healthy hosts in the load balancing pool drops below this threshold, outlier detection will be disabled and the proxy will load balance across all hosts in the pool (healthy and unhealthy). The threshold can be disabled by setting it to 0%. The default is 0% as it's not typically applicable in k8s environments with few pods per service.

Valid port name

Valid port number

OPTIONAL: The path to the file containing certificate authority certificates to use in verifying a presented server certificate. If omitted, the proxy will not verify the server's certificate. Should be empty if mode is ISTIO_MUTUAL.

REQUIRED if mode is MUTUAL. The path to the file holding the client-side TLS certificate to use. Should be empty if mode is ISTIO_MUTUAL.

REQUIRED: Indicates whether connections to this port should be secured using TLS. The value of this field determines how TLS is enforced.

REQUIRED if mode is MUTUAL. The path to the file holding the client's private key. Should be empty if mode is ISTIO_MUTUAL.

SNI string to present to the server during TLS handshake. Should be empty if mode is ISTIO_MUTUAL.

A list of alternate names to verify the subject identity in the certificate. If specified, the proxy will verify that the server certificate's subject alt name matches one of the specified values. Should be empty if mode is ISTIO_MUTUAL.

OPTIONAL: The path to the file containing certificate authority certificates to use in verifying a presented server certificate. If omitted, the proxy will not verify the server's certificate. Should be empty if mode is ISTIO_MUTUAL.

REQUIRED if mode is MUTUAL. The path to the file holding the client-side TLS certificate to use. Should be empty if mode is ISTIO_MUTUAL.

REQUIRED: Indicates whether connections to this port should be secured using TLS. The value of this field determines how TLS is enforced.

REQUIRED if mode is MUTUAL. The path to the file holding the client's private key. Should be empty if mode is ISTIO_MUTUAL.

SNI string to present to the server during TLS handshake. Should be empty if mode is ISTIO_MUTUAL.

A list of alternate names to verify the subject identity in the certificate. If specified, the proxy will verify that the server certificate's subject alt name matches one of the specified values. Should be empty if mode is ISTIO_MUTUAL.

API version of the referent

Kind of the referent

Name of the referent

Namespace of the referent