Skip to content

Commit

Permalink
chore(deps): update docs from repo source
Browse files Browse the repository at this point in the history 
Signed-off-by: kumahq[bot] <110050114+kumahq[bot]@users.noreply.github.com>
  • Loading branch information
@kumahq
kumahq[bot] committed Dec 7, 2023
1 parent 58bbbac commit f892686
Show file tree
Hide file tree
Showing 9 changed files with 190 additions and 45 deletions.
5 changes: 5 additions & 0 deletions app/docs/2.5.x/kuma-cp.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
19 changes: 19 additions & 0 deletions app/docs/2.5.x/protos/Dataplane.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
19 changes: 19 additions & 0 deletions app/docs/2.5.x/protos/DataplaneOverview.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
13 changes: 13 additions & 0 deletions app/docs/dev/crds/kuma.io_meshloadbalancingstrategies.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
95 changes: 68 additions & 27 deletions app/docs/dev/crds/kuma.io_meshretries.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -104,23 +105,26 @@ 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
backoff which will be used when the upstream returns
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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -219,23 +236,28 @@ 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
backoff which will be used when the upstream returns
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
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
Loading

0 comments on commit f892686

Please sign in to comment.