From f8926863d6592a803662c7461413b2dc112970c7 Mon Sep 17 00:00:00 2001 From: "kumahq[bot]" <110050114+kumahq[bot]@users.noreply.github.com> Date: Thu, 7 Dec 2023 09:56:59 +0000 Subject: [PATCH] chore(deps): update docs from repo source Signed-off-by: kumahq[bot] <110050114+kumahq[bot]@users.noreply.github.com> --- app/docs/2.5.x/kuma-cp.yaml | 5 + app/docs/2.5.x/protos/Dataplane.json | 19 ++++ app/docs/2.5.x/protos/DataplaneOverview.json | 19 ++++ .../kuma.io_meshloadbalancingstrategies.yaml | 13 +++ app/docs/dev/crds/kuma.io_meshretries.yaml | 95 +++++++++++++------ app/docs/dev/crds/kuma.io_meshtraces.yaml | 41 ++++---- app/docs/dev/kuma-cp.yaml | 5 + app/docs/dev/protos/Dataplane.json | 19 ++++ app/docs/dev/protos/DataplaneOverview.json | 19 ++++ 9 files changed, 190 insertions(+), 45 deletions(-) diff --git a/app/docs/2.5.x/kuma-cp.yaml b/app/docs/2.5.x/kuma-cp.yaml index bba9600f6..8c716dcb9 100644 --- a/app/docs/2.5.x/kuma-cp.yaml +++ b/app/docs/2.5.x/kuma-cp.yaml @@ -364,6 +364,11 @@ runtime: tcAttachIface: "" # ENV: KUMA_RUNTIME_KUBERNETES_INJECTOR_EBPF_TC_ATTACH_IFACE # Path where compiled eBPF programs are placed programsSourcePath: /kuma/ebpf # ENV: KUMA_RUNTIME_KUBERNETES_INJECTOR_EBPF_PROGRAMS_SOURCE_PATH + # IgnoredServiceSelectorLabels defines a list ignored labels in Service selector. + # If Pod matches a Service with ignored labels, but does not match it fully, it gets Ignored inbound. + # It is useful when you change Service selector and expect traffic to be sent immediately. + # An example of this is ArgoCD's BlueGreen deployment and "rollouts-pod-template-hash" selector. + ignoredServiceSelectorLabels: [] # ENV: KUMA_RUNTIME_KUBERNETES_INJECTOR_IGNORED_SERVICE_SELECTOR_LABELS marshalingCacheExpirationTime: 5m # ENV: KUMA_RUNTIME_KUBERNETES_MARSHALING_CACHE_EXPIRATION_TIME # Kubernetes's resources reconciliation concurrency configuration controllersConcurrency: diff --git a/app/docs/2.5.x/protos/Dataplane.json b/app/docs/2.5.x/protos/Dataplane.json index a6888446a..29b8197c1 100644 --- a/app/docs/2.5.x/protos/Dataplane.json +++ b/app/docs/2.5.x/protos/Dataplane.json @@ -136,6 +136,25 @@ "$ref": "#/definitions/kuma.mesh.v1alpha1.Dataplane.Networking.Inbound.ServiceProbe", "additionalProperties": true, "description": "ServiceProbe defines parameters for probing the service next to sidecar. When service probe is defined, Envoy will periodically health check the application next to it and report the status to the control plane. On Kubernetes, Kuma deployments rely on Kubernetes probes so this is not used. See https://kuma.io/docs/latest/documentation/health for more information." + }, + "state": { + "enum": [ + "Ready", + 0, + "NotReady", + 1, + "Ignored", + 2 + ], + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "title": "State" } }, "additionalProperties": true, diff --git a/app/docs/2.5.x/protos/DataplaneOverview.json b/app/docs/2.5.x/protos/DataplaneOverview.json index 04e4385b8..fa880156a 100644 --- a/app/docs/2.5.x/protos/DataplaneOverview.json +++ b/app/docs/2.5.x/protos/DataplaneOverview.json @@ -152,6 +152,25 @@ "$ref": "#/definitions/kuma.mesh.v1alpha1.Dataplane.Networking.Inbound.ServiceProbe", "additionalProperties": true, "description": "ServiceProbe defines parameters for probing the service next to sidecar. When service probe is defined, Envoy will periodically health check the application next to it and report the status to the control plane. On Kubernetes, Kuma deployments rely on Kubernetes probes so this is not used. See https://kuma.io/docs/latest/documentation/health for more information." + }, + "state": { + "enum": [ + "Ready", + 0, + "NotReady", + 1, + "Ignored", + 2 + ], + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "title": "State" } }, "additionalProperties": true, diff --git a/app/docs/dev/crds/kuma.io_meshloadbalancingstrategies.yaml b/app/docs/dev/crds/kuma.io_meshloadbalancingstrategies.yaml index 83d193e81..f3c76905f 100644 --- a/app/docs/dev/crds/kuma.io_meshloadbalancingstrategies.yaml +++ b/app/docs/dev/crds/kuma.io_meshloadbalancingstrategies.yaml @@ -91,6 +91,19 @@ spec: hosts as specified in 'choiceCount' (2 by default) and picks the host which has the fewest active requests properties: + activeRequestBias: + anyOf: + - type: integer + - type: string + description: ActiveRequestBias refers to dynamic + weights applied when hosts have varying load balancing + weights. A higher value here aggressively reduces + the weight of endpoints that are currently handling + active requests. In essence, the higher the ActiveRequestBias + value, the more forcefully it reduces the load + balancing weight of endpoints that are actively + serving requests. + x-kubernetes-int-or-string: true choiceCount: description: ChoiceCount is the number of random healthy hosts from which the host with the fewest diff --git a/app/docs/dev/crds/kuma.io_meshretries.yaml b/app/docs/dev/crds/kuma.io_meshretries.yaml index d724395a3..80148b12c 100644 --- a/app/docs/dev/crds/kuma.io_meshretries.yaml +++ b/app/docs/dev/crds/kuma.io_meshretries.yaml @@ -87,14 +87,15 @@ spec: properties: backOff: description: BackOff is a configuration of durations - which will be used in exponential backoff strategy + which will be used in an exponential backoff strategy between retries. properties: baseInterval: + default: 25ms description: BaseInterval is an amount of time which should be taken between retries. Must be greater than zero. Values less than 1 ms are rounded up - to 1 ms. Default is 25ms. + to 1 ms. type: string maxInterval: description: MaxInterval is a maximal amount of @@ -104,13 +105,16 @@ spec: type: object numRetries: description: NumRetries is the number of attempts that - will be made on failed (and retriable) requests. + will be made on failed (and retriable) requests. If + not set, the default value is 1. format: int32 type: integer perTryTimeout: - description: PerTryTimeout is the amount of time after - which retry attempt should timeout. Setting this timeout - to 0 will disable it. Default is 15s. + description: PerTryTimeout is the maximum amount of + time each retry attempt can take before it times out. + If not set, the global request timeout for the route + will be used. Setting this value to 0 will disable + the per-try timeout. type: string rateLimitedBackOff: description: RateLimitedBackOff is a configuration of @@ -118,9 +122,9 @@ spec: one of the headers configured. properties: maxInterval: + default: 300s description: MaxInterval is a maximal amount of - time which will be taken between retries. Default - is 300 seconds. + time which will be taken between retries. type: string resetHeaders: description: ResetHeaders specifies the list of @@ -133,8 +137,7 @@ spec: items: properties: format: - description: The format of the reset header, - either Seconds or UnixTimestamp. + description: The format of the reset header. enum: - Seconds - UnixTimestamp @@ -152,10 +155,21 @@ spec: type: array type: object retryOn: - description: 'RetryOn is a list of conditions which - will cause a retry. Available values are: [Canceled, - DeadlineExceeded, Internal, ResourceExhausted, Unavailable].' + description: RetryOn is a list of conditions which will + cause a retry. + example: + - Canceled + - DeadlineExceeded + - Internal + - ResourceExhausted + - Unavailable items: + enum: + - Canceled + - DeadlineExceeded + - Internal + - ResourceExhausted + - Unavailable type: string type: array type: object @@ -166,13 +180,14 @@ spec: backOff: description: BackOff is a configuration of durations which will be used in exponential backoff strategy - between retries + between retries. properties: baseInterval: + default: 25ms description: BaseInterval is an amount of time which should be taken between retries. Must be greater than zero. Values less than 1 ms are rounded up - to 1 ms. Default is 25ms. + to 1 ms. type: string maxInterval: description: MaxInterval is a maximal amount of @@ -188,8 +203,10 @@ spec: properties: predicate: description: Type is requested predicate mode. - Available values are OmitPreviousHosts, OmitHostsWithTags, - and OmitPreviousPriorities. + enum: + - OmitPreviousHosts + - OmitHostsWithTags + - OmitPreviousPriorities type: string tags: additionalProperties: @@ -199,10 +216,10 @@ spec: if Type is OmitHostsWithTags type: object updateFrequency: + default: 2 description: UpdateFrequency is how often the priority load should be updated based on previously attempted priorities. Used for OmitPreviousPriorities. - Default is 2 if not set. format: int32 type: integer required: @@ -219,13 +236,18 @@ spec: type: integer numRetries: description: NumRetries is the number of attempts that - will be made on failed (and retriable) requests + will be made on failed (and retriable) requests. If + not set, the default value is 1. format: int32 type: integer perTryTimeout: description: PerTryTimeout is the amount of time after - which retry attempt should timeout. Setting this timeout - to 0 will disable it. Default is 15s. + which retry attempt should time out. If left unspecified, + the global route timeout for the request will be used. + Consequently, when using a 5xx based retry policy, + a request that times out will not be retried as the + total timeout budget would have been exhausted. Setting + this timeout to 0 will disable it. type: string rateLimitedBackOff: description: RateLimitedBackOff is a configuration of @@ -233,9 +255,9 @@ spec: one of the headers configured. properties: maxInterval: + default: 300s description: MaxInterval is a maximal amount of - time which will be taken between retries. Default - is 300 seconds. + time which will be taken between retries. type: string resetHeaders: description: ResetHeaders specifies the list of @@ -248,8 +270,7 @@ spec: items: properties: format: - description: The format of the reset header, - either Seconds or UnixTimestamp. + description: The format of the reset header. enum: - Seconds - UnixTimestamp @@ -306,7 +327,7 @@ spec: description: RetriableResponseHeaders is an HTTP response headers that trigger a retry if present in the response. A retry will be triggered if any of the header matches - match the upstream response headers. + the upstream response headers. items: description: HeaderMatch describes how to select an HTTP route by matching HTTP request headers. @@ -346,7 +367,27 @@ spec: RefusedStream, Http3PostConnectFailure, HttpMethodConnect, HttpMethodDelete, HttpMethodGet, HttpMethodHead, HttpMethodOptions, HttpMethodPatch, HttpMethodPost, HttpMethodPut, HttpMethodTrace]. - Also, any HTTP status code (500, 503, etc).' + Also, any HTTP status code (500, 503, etc.).' + example: + - 5XX + - GatewayError + - Reset + - Retriable4xx + - ConnectFailure + - EnvoyRatelimited + - RefusedStream + - Http3PostConnectFailure + - HttpMethodConnect + - HttpMethodDelete + - HttpMethodGet + - HttpMethodHead + - HttpMethodOptions + - HttpMethodPatch + - HttpMethodPost + - HttpMethodPut + - HttpMethodTrace + - "500" + - "503" items: type: string type: array diff --git a/app/docs/dev/crds/kuma.io_meshtraces.yaml b/app/docs/dev/crds/kuma.io_meshtraces.yaml index 0e8b08c9d..69a6536a2 100644 --- a/app/docs/dev/crds/kuma.io_meshtraces.yaml +++ b/app/docs/dev/crds/kuma.io_meshtraces.yaml @@ -59,13 +59,14 @@ spec: description: Datadog backend configuration. properties: splitService: + default: false description: 'Determines if datadog service name should be split based on traffic direction and destination. For example, with `splitService: true` and a `backend` service that communicates with a couple of databases, you would get service names like `backend_INBOUND`, `backend_OUTBOUND_db1`, and `backend_OUTBOUND_db2` - in Datadog. Default: false' + in Datadog.' type: boolean url: description: Address of Datadog collector, only host @@ -96,18 +97,19 @@ spec: properties: apiVersion: default: httpJson - description: 'Version of the API. values: httpJson, - httpProto. Default: httpJson see https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/trace/v3/zipkin.proto#L66' + description: Version of the API. https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/trace/v3/zipkin.proto#L66 enum: - httpJson - httpProto type: string sharedSpanContext: - description: 'Determines whether client and server spans - will share the same span context. Default: true. https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/trace/v3/zipkin.proto#L63' + default: true + description: Determines whether client and server spans + will share the same span context. https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/trace/v3/zipkin.proto#L63 type: boolean traceId128bit: - description: 'Generate 128bit traces. Default: false' + default: false + description: Generate 128bit traces. type: boolean url: description: Address of Zipkin collector. @@ -118,6 +120,7 @@ spec: required: - type type: object + maxItems: 1 type: array sampling: description: Sampling configuration. Sampling is the process by @@ -128,34 +131,36 @@ spec: anyOf: - type: integer - type: string - description: 'Target percentage of requests that will be force - traced if the ''x-client-trace-id'' header is set. Default: - 100% Mirror of client_sampling in Envoy https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#L127-L133 - Either int or decimal represented as string.' + default: 100% + description: Target percentage of requests that will be force + traced if the 'x-client-trace-id' header is set. Mirror + of client_sampling in Envoy https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#L127-L133 + Either int or decimal represented as string. x-kubernetes-int-or-string: true overall: anyOf: - type: integer - type: string - description: 'Target percentage of requests will be traced + default: 100% + description: Target percentage of requests will be traced after all other sampling checks have been applied (client, force tracing, random sampling). This field functions as an upper limit on the total configured sampling rate. For instance, setting client_sampling to 100% but overall_sampling to 1% will result in only 1% of client requests with the - appropriate headers to be force traced. Default: 100% Mirror - of overall_sampling in Envoy https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#L142-L150 - Either int or decimal represented as string.' + appropriate headers to be force traced. Mirror of overall_sampling + in Envoy https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#L142-L150 + Either int or decimal represented as string. x-kubernetes-int-or-string: true random: anyOf: - type: integer - type: string - description: 'Target percentage of requests that will be randomly + default: 100% + description: Target percentage of requests that will be randomly selected for trace generation, if not requested by the client - or not forced. Default: 100% Mirror of random_sampling in - Envoy https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#L135-L140 - Either int or decimal represented as string.' + or not forced. Mirror of random_sampling in Envoy https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#L135-L140 + Either int or decimal represented as string. x-kubernetes-int-or-string: true type: object tags: diff --git a/app/docs/dev/kuma-cp.yaml b/app/docs/dev/kuma-cp.yaml index 7c7df697e..7fc8602ad 100644 --- a/app/docs/dev/kuma-cp.yaml +++ b/app/docs/dev/kuma-cp.yaml @@ -366,6 +366,11 @@ runtime: tcAttachIface: "" # ENV: KUMA_RUNTIME_KUBERNETES_INJECTOR_EBPF_TC_ATTACH_IFACE # Path where compiled eBPF programs are placed programsSourcePath: /kuma/ebpf # ENV: KUMA_RUNTIME_KUBERNETES_INJECTOR_EBPF_PROGRAMS_SOURCE_PATH + # IgnoredServiceSelectorLabels defines a list ignored labels in Service selector. + # If Pod matches a Service with ignored labels, but does not match it fully, it gets Ignored inbound. + # It is useful when you change Service selector and expect traffic to be sent immediately. + # An example of this is ArgoCD's BlueGreen deployment and "rollouts-pod-template-hash" selector. + ignoredServiceSelectorLabels: [] # ENV: KUMA_RUNTIME_KUBERNETES_INJECTOR_IGNORED_SERVICE_SELECTOR_LABELS marshalingCacheExpirationTime: 5m # ENV: KUMA_RUNTIME_KUBERNETES_MARSHALING_CACHE_EXPIRATION_TIME # Kubernetes's resources reconciliation concurrency configuration controllersConcurrency: diff --git a/app/docs/dev/protos/Dataplane.json b/app/docs/dev/protos/Dataplane.json index a6888446a..29b8197c1 100644 --- a/app/docs/dev/protos/Dataplane.json +++ b/app/docs/dev/protos/Dataplane.json @@ -136,6 +136,25 @@ "$ref": "#/definitions/kuma.mesh.v1alpha1.Dataplane.Networking.Inbound.ServiceProbe", "additionalProperties": true, "description": "ServiceProbe defines parameters for probing the service next to sidecar. When service probe is defined, Envoy will periodically health check the application next to it and report the status to the control plane. On Kubernetes, Kuma deployments rely on Kubernetes probes so this is not used. See https://kuma.io/docs/latest/documentation/health for more information." + }, + "state": { + "enum": [ + "Ready", + 0, + "NotReady", + 1, + "Ignored", + 2 + ], + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "title": "State" } }, "additionalProperties": true, diff --git a/app/docs/dev/protos/DataplaneOverview.json b/app/docs/dev/protos/DataplaneOverview.json index 04e4385b8..fa880156a 100644 --- a/app/docs/dev/protos/DataplaneOverview.json +++ b/app/docs/dev/protos/DataplaneOverview.json @@ -152,6 +152,25 @@ "$ref": "#/definitions/kuma.mesh.v1alpha1.Dataplane.Networking.Inbound.ServiceProbe", "additionalProperties": true, "description": "ServiceProbe defines parameters for probing the service next to sidecar. When service probe is defined, Envoy will periodically health check the application next to it and report the status to the control plane. On Kubernetes, Kuma deployments rely on Kubernetes probes so this is not used. See https://kuma.io/docs/latest/documentation/health for more information." + }, + "state": { + "enum": [ + "Ready", + 0, + "NotReady", + 1, + "Ignored", + 2 + ], + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "title": "State" } }, "additionalProperties": true,