From 72a9c13db9e98ec2d77aa2d509808676a1546ca3 Mon Sep 17 00:00:00 2001 From: yangyang Date: Thu, 19 Oct 2023 15:15:07 +0800 Subject: [PATCH] add make generate file Signed-off-by: yangyang --- .../v1/zz_generated.deepcopy.go | 5 + .../v1alpha1/zz_generated.deepcopy.go | 5 + examples/contour/01-crds.yaml | 175 +++++++++++++++++- examples/render/contour-deployment.yaml | 175 +++++++++++++++++- .../render/contour-gateway-provisioner.yaml | 175 +++++++++++++++++- examples/render/contour-gateway.yaml | 175 +++++++++++++++++- examples/render/contour.yaml | 175 +++++++++++++++++- .../docs/main/config/api-reference.html | 70 ++++++- 8 files changed, 943 insertions(+), 12 deletions(-) diff --git a/apis/projectcontour/v1/zz_generated.deepcopy.go b/apis/projectcontour/v1/zz_generated.deepcopy.go index 22f244dd568..88e948739ea 100644 --- a/apis/projectcontour/v1/zz_generated.deepcopy.go +++ b/apis/projectcontour/v1/zz_generated.deepcopy.go @@ -799,6 +799,11 @@ func (in *OutlierDetection) DeepCopyInto(out *OutlierDetection) { *out = new(uint32) **out = **in } + if in.MaxEjectionTimeJitter != nil { + in, out := &in.MaxEjectionTimeJitter, &out.MaxEjectionTimeJitter + *out = new(string) + **out = **in + } } // DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OutlierDetection. diff --git a/apis/projectcontour/v1alpha1/zz_generated.deepcopy.go b/apis/projectcontour/v1alpha1/zz_generated.deepcopy.go index ff4f84765b9..236b058bac0 100644 --- a/apis/projectcontour/v1alpha1/zz_generated.deepcopy.go +++ b/apis/projectcontour/v1alpha1/zz_generated.deepcopy.go @@ -199,6 +199,11 @@ func (in *ContourConfigurationSpec) DeepCopyInto(out *ContourConfigurationSpec) *out = new(TracingConfig) (*in).DeepCopyInto(*out) } + if in.GlobalOutlierDetection != nil { + in, out := &in.GlobalOutlierDetection, &out.GlobalOutlierDetection + *out = new(v1.OutlierDetection) + (*in).DeepCopyInto(*out) + } } // DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ContourConfigurationSpec. diff --git a/examples/contour/01-crds.yaml b/examples/contour/01-crds.yaml index 06521e78065..cf7d5b586d1 100644 --- a/examples/contour/01-crds.yaml +++ b/examples/contour/01-crds.yaml @@ -658,6 +658,76 @@ spec: type: string type: object type: object + outlierDetection: + description: GlobalOutlierDetection defines the configuration for + outlier detection on all services. If defined, this will be used + as the default for all services. + properties: + baseEjectionTime: + description: BaseEjectionTime is the base time that a host is + ejected for. A host will remain ejected for a period of time + equal to the product of the ejection base duration and the number + of times the host has been ejected. Defaults to 30s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + consecutiveLocalOriginFailure: + description: ConsecutiveLocalOriginFailure defines the number + of consecutive local origin failures before a consecutive local + origin ejection occurs. Parameters take effect only when SplitExternalLocalOriginErrors + is true. Defaults to 5. + format: int32 + type: integer + consecutiveServerErrors: + description: ConsecutiveServerErrors defines The number of consecutive + server-side error responses before a consecutive 5xx ejection + occurs. When the backend host encounters consecutive errors + greater than or equal to ConsecutiveServerErrors, it will be + ejected from the load balancing pool. for HTTP services, a 5xx + counts as an error and for TCP services connection failures + and connection timeouts count as an error. It can be disabled + by setting the value to 0. Defaults to 5. + format: int32 + type: integer + disabled: + description: Disabled configures the Service to not use the default + global OutlierDetection policy defined by the Contour configuration. + Defaults to false. + type: boolean + interval: + description: Interval is the interval at which host status is + evaluated. Defaults to 10s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionPercent: + description: MaxEjectionPercent is the max percentage of hosts + in the load balancing pool for the upstream service that can + be ejected. But will eject at least one host regardless of the + value here. Defaults to 10%. + format: int32 + maximum: 100 + type: integer + maxEjectionTime: + description: MaxEjectionTime is the maximum time a host will be + ejected for. After this amount of time, a host will be returned + to normal operation. If not specified, the default value (300s) + or BaseEjectionTime value is applied, whatever is larger. Defaults + to 300s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount of jitter + to add to the ejection time, in order to prevent a ‘thundering + herd’ effect where all proxies try to reconnect to host at the + same time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + splitExternalLocalOriginErrors: + default: false + description: SplitExternalLocalOriginErrors defines whether to + split the local origin errors from the external origin errors. + Defaults to false. + type: boolean + type: object policy: description: Policy specifies default policy applied if not overridden by the user @@ -4134,6 +4204,79 @@ spec: type: string type: object type: object + outlierDetection: + description: GlobalOutlierDetection defines the configuration + for outlier detection on all services. If defined, this will + be used as the default for all services. + properties: + baseEjectionTime: + description: BaseEjectionTime is the base time that a host + is ejected for. A host will remain ejected for a period + of time equal to the product of the ejection base duration + and the number of times the host has been ejected. Defaults + to 30s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + consecutiveLocalOriginFailure: + description: ConsecutiveLocalOriginFailure defines the number + of consecutive local origin failures before a consecutive + local origin ejection occurs. Parameters take effect only + when SplitExternalLocalOriginErrors is true. Defaults to + 5. + format: int32 + type: integer + consecutiveServerErrors: + description: ConsecutiveServerErrors defines The number of + consecutive server-side error responses before a consecutive + 5xx ejection occurs. When the backend host encounters consecutive + errors greater than or equal to ConsecutiveServerErrors, + it will be ejected from the load balancing pool. for HTTP + services, a 5xx counts as an error and for TCP services + connection failures and connection timeouts count as an + error. It can be disabled by setting the value to 0. Defaults + to 5. + format: int32 + type: integer + disabled: + description: Disabled configures the Service to not use the + default global OutlierDetection policy defined by the Contour + configuration. Defaults to false. + type: boolean + interval: + description: Interval is the interval at which host status + is evaluated. Defaults to 10s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionPercent: + description: MaxEjectionPercent is the max percentage of hosts + in the load balancing pool for the upstream service that + can be ejected. But will eject at least one host regardless + of the value here. Defaults to 10%. + format: int32 + maximum: 100 + type: integer + maxEjectionTime: + description: MaxEjectionTime is the maximum time a host will + be ejected for. After this amount of time, a host will be + returned to normal operation. If not specified, the default + value (300s) or BaseEjectionTime value is applied, whatever + is larger. Defaults to 300s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount of + jitter to add to the ejection time, in order to prevent + a ‘thundering herd’ effect where all proxies try to reconnect + to host at the same time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + splitExternalLocalOriginErrors: + default: false + description: SplitExternalLocalOriginErrors defines whether + to split the local origin errors from the external origin + errors. Defaults to false. + type: boolean + type: object policy: description: Policy specifies default policy applied if not overridden by the user @@ -6268,7 +6411,8 @@ spec: type: string outlierDetection: description: The policy for managing outlier detection - on a service. + on a service. If not specified, the global OutlierDetection + policy will be used. properties: baseEjectionTime: description: BaseEjectionTime is the base time that @@ -6299,6 +6443,11 @@ spec: to 5. format: int32 type: integer + disabled: + description: Disabled configures the Service to not + use the default global OutlierDetection policy defined + by the Contour configuration. Defaults to false. + type: boolean interval: description: Interval is the interval at which host status is evaluated. Defaults to 10s. @@ -6322,6 +6471,14 @@ spec: 300s. pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum + amount of jitter to add to the ejection time, in + order to prevent a ‘thundering herd’ effect where + all proxies try to reconnect to host at the same + time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string splitExternalLocalOriginErrors: default: false description: SplitExternalLocalOriginErrors defines @@ -6728,7 +6885,8 @@ spec: type: string outlierDetection: description: The policy for managing outlier detection on - a service. + a service. If not specified, the global OutlierDetection + policy will be used. properties: baseEjectionTime: description: BaseEjectionTime is the base time that @@ -6759,6 +6917,11 @@ spec: to 5. format: int32 type: integer + disabled: + description: Disabled configures the Service to not + use the default global OutlierDetection policy defined + by the Contour configuration. Defaults to false. + type: boolean interval: description: Interval is the interval at which host status is evaluated. Defaults to 10s. @@ -6782,6 +6945,14 @@ spec: 300s. pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount + of jitter to add to the ejection time, in order to + prevent a ‘thundering herd’ effect where all proxies + try to reconnect to host at the same time. Defaults + to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string splitExternalLocalOriginErrors: default: false description: SplitExternalLocalOriginErrors defines diff --git a/examples/render/contour-deployment.yaml b/examples/render/contour-deployment.yaml index 50ca917cb94..6454e22f1eb 100644 --- a/examples/render/contour-deployment.yaml +++ b/examples/render/contour-deployment.yaml @@ -877,6 +877,76 @@ spec: type: string type: object type: object + outlierDetection: + description: GlobalOutlierDetection defines the configuration for + outlier detection on all services. If defined, this will be used + as the default for all services. + properties: + baseEjectionTime: + description: BaseEjectionTime is the base time that a host is + ejected for. A host will remain ejected for a period of time + equal to the product of the ejection base duration and the number + of times the host has been ejected. Defaults to 30s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + consecutiveLocalOriginFailure: + description: ConsecutiveLocalOriginFailure defines the number + of consecutive local origin failures before a consecutive local + origin ejection occurs. Parameters take effect only when SplitExternalLocalOriginErrors + is true. Defaults to 5. + format: int32 + type: integer + consecutiveServerErrors: + description: ConsecutiveServerErrors defines The number of consecutive + server-side error responses before a consecutive 5xx ejection + occurs. When the backend host encounters consecutive errors + greater than or equal to ConsecutiveServerErrors, it will be + ejected from the load balancing pool. for HTTP services, a 5xx + counts as an error and for TCP services connection failures + and connection timeouts count as an error. It can be disabled + by setting the value to 0. Defaults to 5. + format: int32 + type: integer + disabled: + description: Disabled configures the Service to not use the default + global OutlierDetection policy defined by the Contour configuration. + Defaults to false. + type: boolean + interval: + description: Interval is the interval at which host status is + evaluated. Defaults to 10s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionPercent: + description: MaxEjectionPercent is the max percentage of hosts + in the load balancing pool for the upstream service that can + be ejected. But will eject at least one host regardless of the + value here. Defaults to 10%. + format: int32 + maximum: 100 + type: integer + maxEjectionTime: + description: MaxEjectionTime is the maximum time a host will be + ejected for. After this amount of time, a host will be returned + to normal operation. If not specified, the default value (300s) + or BaseEjectionTime value is applied, whatever is larger. Defaults + to 300s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount of jitter + to add to the ejection time, in order to prevent a ‘thundering + herd’ effect where all proxies try to reconnect to host at the + same time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + splitExternalLocalOriginErrors: + default: false + description: SplitExternalLocalOriginErrors defines whether to + split the local origin errors from the external origin errors. + Defaults to false. + type: boolean + type: object policy: description: Policy specifies default policy applied if not overridden by the user @@ -4353,6 +4423,79 @@ spec: type: string type: object type: object + outlierDetection: + description: GlobalOutlierDetection defines the configuration + for outlier detection on all services. If defined, this will + be used as the default for all services. + properties: + baseEjectionTime: + description: BaseEjectionTime is the base time that a host + is ejected for. A host will remain ejected for a period + of time equal to the product of the ejection base duration + and the number of times the host has been ejected. Defaults + to 30s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + consecutiveLocalOriginFailure: + description: ConsecutiveLocalOriginFailure defines the number + of consecutive local origin failures before a consecutive + local origin ejection occurs. Parameters take effect only + when SplitExternalLocalOriginErrors is true. Defaults to + 5. + format: int32 + type: integer + consecutiveServerErrors: + description: ConsecutiveServerErrors defines The number of + consecutive server-side error responses before a consecutive + 5xx ejection occurs. When the backend host encounters consecutive + errors greater than or equal to ConsecutiveServerErrors, + it will be ejected from the load balancing pool. for HTTP + services, a 5xx counts as an error and for TCP services + connection failures and connection timeouts count as an + error. It can be disabled by setting the value to 0. Defaults + to 5. + format: int32 + type: integer + disabled: + description: Disabled configures the Service to not use the + default global OutlierDetection policy defined by the Contour + configuration. Defaults to false. + type: boolean + interval: + description: Interval is the interval at which host status + is evaluated. Defaults to 10s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionPercent: + description: MaxEjectionPercent is the max percentage of hosts + in the load balancing pool for the upstream service that + can be ejected. But will eject at least one host regardless + of the value here. Defaults to 10%. + format: int32 + maximum: 100 + type: integer + maxEjectionTime: + description: MaxEjectionTime is the maximum time a host will + be ejected for. After this amount of time, a host will be + returned to normal operation. If not specified, the default + value (300s) or BaseEjectionTime value is applied, whatever + is larger. Defaults to 300s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount of + jitter to add to the ejection time, in order to prevent + a ‘thundering herd’ effect where all proxies try to reconnect + to host at the same time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + splitExternalLocalOriginErrors: + default: false + description: SplitExternalLocalOriginErrors defines whether + to split the local origin errors from the external origin + errors. Defaults to false. + type: boolean + type: object policy: description: Policy specifies default policy applied if not overridden by the user @@ -6487,7 +6630,8 @@ spec: type: string outlierDetection: description: The policy for managing outlier detection - on a service. + on a service. If not specified, the global OutlierDetection + policy will be used. properties: baseEjectionTime: description: BaseEjectionTime is the base time that @@ -6518,6 +6662,11 @@ spec: to 5. format: int32 type: integer + disabled: + description: Disabled configures the Service to not + use the default global OutlierDetection policy defined + by the Contour configuration. Defaults to false. + type: boolean interval: description: Interval is the interval at which host status is evaluated. Defaults to 10s. @@ -6541,6 +6690,14 @@ spec: 300s. pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum + amount of jitter to add to the ejection time, in + order to prevent a ‘thundering herd’ effect where + all proxies try to reconnect to host at the same + time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string splitExternalLocalOriginErrors: default: false description: SplitExternalLocalOriginErrors defines @@ -6947,7 +7104,8 @@ spec: type: string outlierDetection: description: The policy for managing outlier detection on - a service. + a service. If not specified, the global OutlierDetection + policy will be used. properties: baseEjectionTime: description: BaseEjectionTime is the base time that @@ -6978,6 +7136,11 @@ spec: to 5. format: int32 type: integer + disabled: + description: Disabled configures the Service to not + use the default global OutlierDetection policy defined + by the Contour configuration. Defaults to false. + type: boolean interval: description: Interval is the interval at which host status is evaluated. Defaults to 10s. @@ -7001,6 +7164,14 @@ spec: 300s. pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount + of jitter to add to the ejection time, in order to + prevent a ‘thundering herd’ effect where all proxies + try to reconnect to host at the same time. Defaults + to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string splitExternalLocalOriginErrors: default: false description: SplitExternalLocalOriginErrors defines diff --git a/examples/render/contour-gateway-provisioner.yaml b/examples/render/contour-gateway-provisioner.yaml index 82d57012a32..370753896e2 100644 --- a/examples/render/contour-gateway-provisioner.yaml +++ b/examples/render/contour-gateway-provisioner.yaml @@ -669,6 +669,76 @@ spec: type: string type: object type: object + outlierDetection: + description: GlobalOutlierDetection defines the configuration for + outlier detection on all services. If defined, this will be used + as the default for all services. + properties: + baseEjectionTime: + description: BaseEjectionTime is the base time that a host is + ejected for. A host will remain ejected for a period of time + equal to the product of the ejection base duration and the number + of times the host has been ejected. Defaults to 30s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + consecutiveLocalOriginFailure: + description: ConsecutiveLocalOriginFailure defines the number + of consecutive local origin failures before a consecutive local + origin ejection occurs. Parameters take effect only when SplitExternalLocalOriginErrors + is true. Defaults to 5. + format: int32 + type: integer + consecutiveServerErrors: + description: ConsecutiveServerErrors defines The number of consecutive + server-side error responses before a consecutive 5xx ejection + occurs. When the backend host encounters consecutive errors + greater than or equal to ConsecutiveServerErrors, it will be + ejected from the load balancing pool. for HTTP services, a 5xx + counts as an error and for TCP services connection failures + and connection timeouts count as an error. It can be disabled + by setting the value to 0. Defaults to 5. + format: int32 + type: integer + disabled: + description: Disabled configures the Service to not use the default + global OutlierDetection policy defined by the Contour configuration. + Defaults to false. + type: boolean + interval: + description: Interval is the interval at which host status is + evaluated. Defaults to 10s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionPercent: + description: MaxEjectionPercent is the max percentage of hosts + in the load balancing pool for the upstream service that can + be ejected. But will eject at least one host regardless of the + value here. Defaults to 10%. + format: int32 + maximum: 100 + type: integer + maxEjectionTime: + description: MaxEjectionTime is the maximum time a host will be + ejected for. After this amount of time, a host will be returned + to normal operation. If not specified, the default value (300s) + or BaseEjectionTime value is applied, whatever is larger. Defaults + to 300s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount of jitter + to add to the ejection time, in order to prevent a ‘thundering + herd’ effect where all proxies try to reconnect to host at the + same time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + splitExternalLocalOriginErrors: + default: false + description: SplitExternalLocalOriginErrors defines whether to + split the local origin errors from the external origin errors. + Defaults to false. + type: boolean + type: object policy: description: Policy specifies default policy applied if not overridden by the user @@ -4145,6 +4215,79 @@ spec: type: string type: object type: object + outlierDetection: + description: GlobalOutlierDetection defines the configuration + for outlier detection on all services. If defined, this will + be used as the default for all services. + properties: + baseEjectionTime: + description: BaseEjectionTime is the base time that a host + is ejected for. A host will remain ejected for a period + of time equal to the product of the ejection base duration + and the number of times the host has been ejected. Defaults + to 30s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + consecutiveLocalOriginFailure: + description: ConsecutiveLocalOriginFailure defines the number + of consecutive local origin failures before a consecutive + local origin ejection occurs. Parameters take effect only + when SplitExternalLocalOriginErrors is true. Defaults to + 5. + format: int32 + type: integer + consecutiveServerErrors: + description: ConsecutiveServerErrors defines The number of + consecutive server-side error responses before a consecutive + 5xx ejection occurs. When the backend host encounters consecutive + errors greater than or equal to ConsecutiveServerErrors, + it will be ejected from the load balancing pool. for HTTP + services, a 5xx counts as an error and for TCP services + connection failures and connection timeouts count as an + error. It can be disabled by setting the value to 0. Defaults + to 5. + format: int32 + type: integer + disabled: + description: Disabled configures the Service to not use the + default global OutlierDetection policy defined by the Contour + configuration. Defaults to false. + type: boolean + interval: + description: Interval is the interval at which host status + is evaluated. Defaults to 10s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionPercent: + description: MaxEjectionPercent is the max percentage of hosts + in the load balancing pool for the upstream service that + can be ejected. But will eject at least one host regardless + of the value here. Defaults to 10%. + format: int32 + maximum: 100 + type: integer + maxEjectionTime: + description: MaxEjectionTime is the maximum time a host will + be ejected for. After this amount of time, a host will be + returned to normal operation. If not specified, the default + value (300s) or BaseEjectionTime value is applied, whatever + is larger. Defaults to 300s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount of + jitter to add to the ejection time, in order to prevent + a ‘thundering herd’ effect where all proxies try to reconnect + to host at the same time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + splitExternalLocalOriginErrors: + default: false + description: SplitExternalLocalOriginErrors defines whether + to split the local origin errors from the external origin + errors. Defaults to false. + type: boolean + type: object policy: description: Policy specifies default policy applied if not overridden by the user @@ -6279,7 +6422,8 @@ spec: type: string outlierDetection: description: The policy for managing outlier detection - on a service. + on a service. If not specified, the global OutlierDetection + policy will be used. properties: baseEjectionTime: description: BaseEjectionTime is the base time that @@ -6310,6 +6454,11 @@ spec: to 5. format: int32 type: integer + disabled: + description: Disabled configures the Service to not + use the default global OutlierDetection policy defined + by the Contour configuration. Defaults to false. + type: boolean interval: description: Interval is the interval at which host status is evaluated. Defaults to 10s. @@ -6333,6 +6482,14 @@ spec: 300s. pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum + amount of jitter to add to the ejection time, in + order to prevent a ‘thundering herd’ effect where + all proxies try to reconnect to host at the same + time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string splitExternalLocalOriginErrors: default: false description: SplitExternalLocalOriginErrors defines @@ -6739,7 +6896,8 @@ spec: type: string outlierDetection: description: The policy for managing outlier detection on - a service. + a service. If not specified, the global OutlierDetection + policy will be used. properties: baseEjectionTime: description: BaseEjectionTime is the base time that @@ -6770,6 +6928,11 @@ spec: to 5. format: int32 type: integer + disabled: + description: Disabled configures the Service to not + use the default global OutlierDetection policy defined + by the Contour configuration. Defaults to false. + type: boolean interval: description: Interval is the interval at which host status is evaluated. Defaults to 10s. @@ -6793,6 +6956,14 @@ spec: 300s. pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount + of jitter to add to the ejection time, in order to + prevent a ‘thundering herd’ effect where all proxies + try to reconnect to host at the same time. Defaults + to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string splitExternalLocalOriginErrors: default: false description: SplitExternalLocalOriginErrors defines diff --git a/examples/render/contour-gateway.yaml b/examples/render/contour-gateway.yaml index 1b25410c689..82a1bca51c3 100644 --- a/examples/render/contour-gateway.yaml +++ b/examples/render/contour-gateway.yaml @@ -880,6 +880,76 @@ spec: type: string type: object type: object + outlierDetection: + description: GlobalOutlierDetection defines the configuration for + outlier detection on all services. If defined, this will be used + as the default for all services. + properties: + baseEjectionTime: + description: BaseEjectionTime is the base time that a host is + ejected for. A host will remain ejected for a period of time + equal to the product of the ejection base duration and the number + of times the host has been ejected. Defaults to 30s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + consecutiveLocalOriginFailure: + description: ConsecutiveLocalOriginFailure defines the number + of consecutive local origin failures before a consecutive local + origin ejection occurs. Parameters take effect only when SplitExternalLocalOriginErrors + is true. Defaults to 5. + format: int32 + type: integer + consecutiveServerErrors: + description: ConsecutiveServerErrors defines The number of consecutive + server-side error responses before a consecutive 5xx ejection + occurs. When the backend host encounters consecutive errors + greater than or equal to ConsecutiveServerErrors, it will be + ejected from the load balancing pool. for HTTP services, a 5xx + counts as an error and for TCP services connection failures + and connection timeouts count as an error. It can be disabled + by setting the value to 0. Defaults to 5. + format: int32 + type: integer + disabled: + description: Disabled configures the Service to not use the default + global OutlierDetection policy defined by the Contour configuration. + Defaults to false. + type: boolean + interval: + description: Interval is the interval at which host status is + evaluated. Defaults to 10s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionPercent: + description: MaxEjectionPercent is the max percentage of hosts + in the load balancing pool for the upstream service that can + be ejected. But will eject at least one host regardless of the + value here. Defaults to 10%. + format: int32 + maximum: 100 + type: integer + maxEjectionTime: + description: MaxEjectionTime is the maximum time a host will be + ejected for. After this amount of time, a host will be returned + to normal operation. If not specified, the default value (300s) + or BaseEjectionTime value is applied, whatever is larger. Defaults + to 300s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount of jitter + to add to the ejection time, in order to prevent a ‘thundering + herd’ effect where all proxies try to reconnect to host at the + same time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + splitExternalLocalOriginErrors: + default: false + description: SplitExternalLocalOriginErrors defines whether to + split the local origin errors from the external origin errors. + Defaults to false. + type: boolean + type: object policy: description: Policy specifies default policy applied if not overridden by the user @@ -4356,6 +4426,79 @@ spec: type: string type: object type: object + outlierDetection: + description: GlobalOutlierDetection defines the configuration + for outlier detection on all services. If defined, this will + be used as the default for all services. + properties: + baseEjectionTime: + description: BaseEjectionTime is the base time that a host + is ejected for. A host will remain ejected for a period + of time equal to the product of the ejection base duration + and the number of times the host has been ejected. Defaults + to 30s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + consecutiveLocalOriginFailure: + description: ConsecutiveLocalOriginFailure defines the number + of consecutive local origin failures before a consecutive + local origin ejection occurs. Parameters take effect only + when SplitExternalLocalOriginErrors is true. Defaults to + 5. + format: int32 + type: integer + consecutiveServerErrors: + description: ConsecutiveServerErrors defines The number of + consecutive server-side error responses before a consecutive + 5xx ejection occurs. When the backend host encounters consecutive + errors greater than or equal to ConsecutiveServerErrors, + it will be ejected from the load balancing pool. for HTTP + services, a 5xx counts as an error and for TCP services + connection failures and connection timeouts count as an + error. It can be disabled by setting the value to 0. Defaults + to 5. + format: int32 + type: integer + disabled: + description: Disabled configures the Service to not use the + default global OutlierDetection policy defined by the Contour + configuration. Defaults to false. + type: boolean + interval: + description: Interval is the interval at which host status + is evaluated. Defaults to 10s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionPercent: + description: MaxEjectionPercent is the max percentage of hosts + in the load balancing pool for the upstream service that + can be ejected. But will eject at least one host regardless + of the value here. Defaults to 10%. + format: int32 + maximum: 100 + type: integer + maxEjectionTime: + description: MaxEjectionTime is the maximum time a host will + be ejected for. After this amount of time, a host will be + returned to normal operation. If not specified, the default + value (300s) or BaseEjectionTime value is applied, whatever + is larger. Defaults to 300s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount of + jitter to add to the ejection time, in order to prevent + a ‘thundering herd’ effect where all proxies try to reconnect + to host at the same time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + splitExternalLocalOriginErrors: + default: false + description: SplitExternalLocalOriginErrors defines whether + to split the local origin errors from the external origin + errors. Defaults to false. + type: boolean + type: object policy: description: Policy specifies default policy applied if not overridden by the user @@ -6490,7 +6633,8 @@ spec: type: string outlierDetection: description: The policy for managing outlier detection - on a service. + on a service. If not specified, the global OutlierDetection + policy will be used. properties: baseEjectionTime: description: BaseEjectionTime is the base time that @@ -6521,6 +6665,11 @@ spec: to 5. format: int32 type: integer + disabled: + description: Disabled configures the Service to not + use the default global OutlierDetection policy defined + by the Contour configuration. Defaults to false. + type: boolean interval: description: Interval is the interval at which host status is evaluated. Defaults to 10s. @@ -6544,6 +6693,14 @@ spec: 300s. pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum + amount of jitter to add to the ejection time, in + order to prevent a ‘thundering herd’ effect where + all proxies try to reconnect to host at the same + time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string splitExternalLocalOriginErrors: default: false description: SplitExternalLocalOriginErrors defines @@ -6950,7 +7107,8 @@ spec: type: string outlierDetection: description: The policy for managing outlier detection on - a service. + a service. If not specified, the global OutlierDetection + policy will be used. properties: baseEjectionTime: description: BaseEjectionTime is the base time that @@ -6981,6 +7139,11 @@ spec: to 5. format: int32 type: integer + disabled: + description: Disabled configures the Service to not + use the default global OutlierDetection policy defined + by the Contour configuration. Defaults to false. + type: boolean interval: description: Interval is the interval at which host status is evaluated. Defaults to 10s. @@ -7004,6 +7167,14 @@ spec: 300s. pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount + of jitter to add to the ejection time, in order to + prevent a ‘thundering herd’ effect where all proxies + try to reconnect to host at the same time. Defaults + to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string splitExternalLocalOriginErrors: default: false description: SplitExternalLocalOriginErrors defines diff --git a/examples/render/contour.yaml b/examples/render/contour.yaml index 608e99b9261..a95a30c6a1a 100644 --- a/examples/render/contour.yaml +++ b/examples/render/contour.yaml @@ -877,6 +877,76 @@ spec: type: string type: object type: object + outlierDetection: + description: GlobalOutlierDetection defines the configuration for + outlier detection on all services. If defined, this will be used + as the default for all services. + properties: + baseEjectionTime: + description: BaseEjectionTime is the base time that a host is + ejected for. A host will remain ejected for a period of time + equal to the product of the ejection base duration and the number + of times the host has been ejected. Defaults to 30s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + consecutiveLocalOriginFailure: + description: ConsecutiveLocalOriginFailure defines the number + of consecutive local origin failures before a consecutive local + origin ejection occurs. Parameters take effect only when SplitExternalLocalOriginErrors + is true. Defaults to 5. + format: int32 + type: integer + consecutiveServerErrors: + description: ConsecutiveServerErrors defines The number of consecutive + server-side error responses before a consecutive 5xx ejection + occurs. When the backend host encounters consecutive errors + greater than or equal to ConsecutiveServerErrors, it will be + ejected from the load balancing pool. for HTTP services, a 5xx + counts as an error and for TCP services connection failures + and connection timeouts count as an error. It can be disabled + by setting the value to 0. Defaults to 5. + format: int32 + type: integer + disabled: + description: Disabled configures the Service to not use the default + global OutlierDetection policy defined by the Contour configuration. + Defaults to false. + type: boolean + interval: + description: Interval is the interval at which host status is + evaluated. Defaults to 10s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionPercent: + description: MaxEjectionPercent is the max percentage of hosts + in the load balancing pool for the upstream service that can + be ejected. But will eject at least one host regardless of the + value here. Defaults to 10%. + format: int32 + maximum: 100 + type: integer + maxEjectionTime: + description: MaxEjectionTime is the maximum time a host will be + ejected for. After this amount of time, a host will be returned + to normal operation. If not specified, the default value (300s) + or BaseEjectionTime value is applied, whatever is larger. Defaults + to 300s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount of jitter + to add to the ejection time, in order to prevent a ‘thundering + herd’ effect where all proxies try to reconnect to host at the + same time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + splitExternalLocalOriginErrors: + default: false + description: SplitExternalLocalOriginErrors defines whether to + split the local origin errors from the external origin errors. + Defaults to false. + type: boolean + type: object policy: description: Policy specifies default policy applied if not overridden by the user @@ -4353,6 +4423,79 @@ spec: type: string type: object type: object + outlierDetection: + description: GlobalOutlierDetection defines the configuration + for outlier detection on all services. If defined, this will + be used as the default for all services. + properties: + baseEjectionTime: + description: BaseEjectionTime is the base time that a host + is ejected for. A host will remain ejected for a period + of time equal to the product of the ejection base duration + and the number of times the host has been ejected. Defaults + to 30s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + consecutiveLocalOriginFailure: + description: ConsecutiveLocalOriginFailure defines the number + of consecutive local origin failures before a consecutive + local origin ejection occurs. Parameters take effect only + when SplitExternalLocalOriginErrors is true. Defaults to + 5. + format: int32 + type: integer + consecutiveServerErrors: + description: ConsecutiveServerErrors defines The number of + consecutive server-side error responses before a consecutive + 5xx ejection occurs. When the backend host encounters consecutive + errors greater than or equal to ConsecutiveServerErrors, + it will be ejected from the load balancing pool. for HTTP + services, a 5xx counts as an error and for TCP services + connection failures and connection timeouts count as an + error. It can be disabled by setting the value to 0. Defaults + to 5. + format: int32 + type: integer + disabled: + description: Disabled configures the Service to not use the + default global OutlierDetection policy defined by the Contour + configuration. Defaults to false. + type: boolean + interval: + description: Interval is the interval at which host status + is evaluated. Defaults to 10s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionPercent: + description: MaxEjectionPercent is the max percentage of hosts + in the load balancing pool for the upstream service that + can be ejected. But will eject at least one host regardless + of the value here. Defaults to 10%. + format: int32 + maximum: 100 + type: integer + maxEjectionTime: + description: MaxEjectionTime is the maximum time a host will + be ejected for. After this amount of time, a host will be + returned to normal operation. If not specified, the default + value (300s) or BaseEjectionTime value is applied, whatever + is larger. Defaults to 300s. + pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount of + jitter to add to the ejection time, in order to prevent + a ‘thundering herd’ effect where all proxies try to reconnect + to host at the same time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string + splitExternalLocalOriginErrors: + default: false + description: SplitExternalLocalOriginErrors defines whether + to split the local origin errors from the external origin + errors. Defaults to false. + type: boolean + type: object policy: description: Policy specifies default policy applied if not overridden by the user @@ -6487,7 +6630,8 @@ spec: type: string outlierDetection: description: The policy for managing outlier detection - on a service. + on a service. If not specified, the global OutlierDetection + policy will be used. properties: baseEjectionTime: description: BaseEjectionTime is the base time that @@ -6518,6 +6662,11 @@ spec: to 5. format: int32 type: integer + disabled: + description: Disabled configures the Service to not + use the default global OutlierDetection policy defined + by the Contour configuration. Defaults to false. + type: boolean interval: description: Interval is the interval at which host status is evaluated. Defaults to 10s. @@ -6541,6 +6690,14 @@ spec: 300s. pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum + amount of jitter to add to the ejection time, in + order to prevent a ‘thundering herd’ effect where + all proxies try to reconnect to host at the same + time. Defaults to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string splitExternalLocalOriginErrors: default: false description: SplitExternalLocalOriginErrors defines @@ -6947,7 +7104,8 @@ spec: type: string outlierDetection: description: The policy for managing outlier detection on - a service. + a service. If not specified, the global OutlierDetection + policy will be used. properties: baseEjectionTime: description: BaseEjectionTime is the base time that @@ -6978,6 +7136,11 @@ spec: to 5. format: int32 type: integer + disabled: + description: Disabled configures the Service to not + use the default global OutlierDetection policy defined + by the Contour configuration. Defaults to false. + type: boolean interval: description: Interval is the interval at which host status is evaluated. Defaults to 10s. @@ -7001,6 +7164,14 @@ spec: 300s. pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ type: string + maxEjectionTimeJitter: + description: MaxEjectionTimeJitter is The maximum amount + of jitter to add to the ejection time, in order to + prevent a ‘thundering herd’ effect where all proxies + try to reconnect to host at the same time. Defaults + to 0s. + pattern: ^(((\d*(\.\d*)?s)|(\d*(\.\d*)?ms))+)$ + type: string splitExternalLocalOriginErrors: default: false description: SplitExternalLocalOriginErrors defines diff --git a/site/content/docs/main/config/api-reference.html b/site/content/docs/main/config/api-reference.html index 3de91278b9d..490e469b315 100644 --- a/site/content/docs/main/config/api-reference.html +++ b/site/content/docs/main/config/api-reference.html @@ -2680,7 +2680,8 @@

OutlierDetection

(Appears on: -Service) +Service, +ContourConfigurationSpec)

OutlierDetection defines the configuration for outlier detection on a service.

@@ -2695,6 +2696,21 @@

OutlierDetection +disabled +
+ +bool + + + +(Optional) +

Disabled configures the Service to not use +the default global OutlierDetection policy defined by the Contour configuration. +Defaults to false.

+ + + + consecutiveServerErrors
@@ -2782,6 +2798,7 @@

OutlierDetection +(Optional)

ConsecutiveLocalOriginFailure defines the number of consecutive local origin failures before a consecutive local origin ejection occurs. Parameters take effect only when SplitExternalLocalOriginErrors is true. Defaults to 5.

@@ -2802,6 +2819,21 @@

OutlierDetection Defaults to 10%.

+ + +maxEjectionTimeJitter +
+ +string + + + +(Optional) +

MaxEjectionTimeJitter is The maximum amount of jitter to add to the ejection time, +in order to prevent a ‘thundering herd’ effect where all proxies try to reconnect to host at the same time. +Defaults to 0s.

+ +

PathRewritePolicy @@ -4175,7 +4207,9 @@

Service -

The policy for managing outlier detection on a service.

+(Optional) +

The policy for managing outlier detection on a service. +If not specified, the global OutlierDetection policy will be used.

@@ -5275,6 +5309,22 @@

ContourConfiguration

Tracing defines properties for exporting trace data to OpenTelemetry.

+ + +outlierDetection +
+ + +OutlierDetection + + + + +(Optional) +

GlobalOutlierDetection defines the configuration for outlier detection on all services. +If defined, this will be used as the default for all services.

+ + @@ -6017,6 +6067,22 @@

ContourConfiguratio

Tracing defines properties for exporting trace data to OpenTelemetry.

+ + +outlierDetection +
+ + +OutlierDetection + + + + +(Optional) +

GlobalOutlierDetection defines the configuration for outlier detection on all services. +If defined, this will be used as the default for all services.

+ +

ContourConfigurationStatus