Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): update docs from repo source #1543

Merged
merged 1 commit into from
Dec 5, 2023
Merged

chore(deps): update docs from repo source #1543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 55 additions & 1 deletion app/docs/dev/crds/kuma.io_meshaccesslogs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ spec:
available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
properties:
json:
example:
- key: start_time
value: '%START_TIME%'
- key: bytes_received
value: '%BYTES_RECEIVED%'
items:
properties:
key:
Expand All @@ -72,8 +77,10 @@ spec:
type: object
type: array
omitEmptyValues:
default: false
type: boolean
plain:
example: '[%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST%'
type: string
type:
enum:
Expand All @@ -86,6 +93,8 @@ spec:
path:
description: Path to a file that logs will be
written to
example: /tmp/access.log
minLength: 1
type: string
required:
- path
Expand All @@ -96,6 +105,9 @@ spec:
attributes:
description: Attributes can contain placeholders
available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
example:
- key: mesh
value: '%KUMA_MESH%'
items:
properties:
key:
Expand All @@ -108,6 +120,12 @@ spec:
description: Body is a raw string or an OTLP any
value as described at https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#field-body
It can contain placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
example:
kvlistValue:
values:
- key: mesh
value:
stringValue: '%KUMA_MESH%'
x-kubernetes-preserve-unknown-fields: true
endpoint:
description: Endpoint of OpenTelemetry collector.
Expand All @@ -123,12 +141,19 @@ spec:
properties:
address:
description: Address of the TCP logging backend
example: 127.0.0.1:5000
minLength: 1
type: string
format:
description: Format of access logs. Placeholders
available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
properties:
json:
example:
- key: start_time
value: '%START_TIME%'
- key: bytes_received
value: '%BYTES_RECEIVED%'
items:
properties:
key:
Expand All @@ -138,8 +163,10 @@ spec:
type: object
type: array
omitEmptyValues:
default: false
type: boolean
plain:
example: '[%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST%'
type: string
type:
enum:
Expand Down Expand Up @@ -200,7 +227,7 @@ spec:
targetRef:
description: TargetRef is a reference to the resource the policy takes
an effect on. The resource could be either a real store object or
virtual resource defined inplace.
virtual resource defined in-place.
properties:
kind:
description: Kind of the referenced resource
Expand Down Expand Up @@ -248,6 +275,11 @@ spec:
available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
properties:
json:
example:
- key: start_time
value: '%START_TIME%'
- key: bytes_received
value: '%BYTES_RECEIVED%'
items:
properties:
key:
Expand All @@ -257,8 +289,10 @@ spec:
type: object
type: array
omitEmptyValues:
default: false
type: boolean
plain:
example: '[%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST%'
type: string
type:
enum:
Expand All @@ -271,6 +305,8 @@ spec:
path:
description: Path to a file that logs will be
written to
example: /tmp/access.log
minLength: 1
type: string
required:
- path
Expand All @@ -281,6 +317,9 @@ spec:
attributes:
description: Attributes can contain placeholders
available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
example:
- key: mesh
value: '%KUMA_MESH%'
items:
properties:
key:
Expand All @@ -293,6 +332,12 @@ spec:
description: Body is a raw string or an OTLP any
value as described at https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#field-body
It can contain placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
example:
kvlistValue:
values:
- key: mesh
value:
stringValue: '%KUMA_MESH%'
x-kubernetes-preserve-unknown-fields: true
endpoint:
description: Endpoint of OpenTelemetry collector.
Expand All @@ -308,12 +353,19 @@ spec:
properties:
address:
description: Address of the TCP logging backend
example: 127.0.0.1:5000
minLength: 1
type: string
format:
description: Format of access logs. Placeholders
available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators
properties:
json:
example:
- key: start_time
value: '%START_TIME%'
- key: bytes_received
value: '%BYTES_RECEIVED%'
items:
properties:
key:
Expand All @@ -323,8 +375,10 @@ spec:
type: object
type: array
omitEmptyValues:
default: false
type: boolean
plain:
example: '[%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST%'
type: string
type:
enum:
Expand Down
46 changes: 27 additions & 19 deletions app/docs/dev/crds/kuma.io_meshtimeouts.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,46 +52,50 @@ spec:
of clients referenced in 'targetRef'
properties:
connectionTimeout:
default: 5s
description: ConnectionTimeout specifies the amount of time
proxy will wait for an TCP connection to be established.
Default value is 5 seconds. Cannot be set to 0.
Cannot be set to "0".
type: string
http:
description: Http provides configuration for HTTP specific
timeouts
properties:
maxConnectionDuration:
default: 0s
description: MaxConnectionDuration is the time after
which a connection will be drained and/or closed,
starting from when it was first established. Setting
this timeout to 0 will disable it. Disabled by default.
this timeout to "0s" will disable it.
type: string
maxStreamDuration:
default: 0s
description: MaxStreamDuration is the maximum time that
a stream’s lifetime will span. Setting this timeout
to 0 will disable it. Disabled by default.
to "0s" will disable it.
type: string
requestTimeout:
default: 15s
description: RequestTimeout The amount of time that
proxy will wait for the entire request to be received.
The timer is activated when the request is initiated,
and is disarmed when the last byte of the request
is sent, OR when the response is initiated. Setting
this timeout to 0 will disable it. Default is 15s.
this timeout to "0s" will disable it.
type: string
streamIdleTimeout:
default: 30s
description: StreamIdleTimeout is the amount of time
that proxy will allow a stream to exist with no activity.
Setting this timeout to 0 will disable it. Default
is 30m
Setting this timeout to "0s" will disable it.
type: string
type: object
idleTimeout:
default: 1h
description: IdleTimeout is defined as the period in which
there are no bytes sent or received on connection Setting
this timeout to 0 will disable it. Be cautious when disabling
it because it can lead to connection leaking. Default
value is 1h.
this timeout to "0s" will disable it. Be cautious when
disabling it because it can lead to connection leaking.
type: string
type: object
targetRef:
Expand Down Expand Up @@ -131,7 +135,7 @@ spec:
targetRef:
description: TargetRef is a reference to the resource the policy takes
an effect on. The resource could be either a real store object or
virtual resource defined inplace.
virtual resource defined in-place.
properties:
kind:
description: Kind of the referenced resource
Expand Down Expand Up @@ -168,46 +172,50 @@ spec:
of destinations referenced in 'targetRef'
properties:
connectionTimeout:
default: 5s
description: ConnectionTimeout specifies the amount of time
proxy will wait for an TCP connection to be established.
Default value is 5 seconds. Cannot be set to 0.
Cannot be set to "0".
type: string
http:
description: Http provides configuration for HTTP specific
timeouts
properties:
maxConnectionDuration:
default: 0s
description: MaxConnectionDuration is the time after
which a connection will be drained and/or closed,
starting from when it was first established. Setting
this timeout to 0 will disable it. Disabled by default.
this timeout to "0s" will disable it.
type: string
maxStreamDuration:
default: 0s
description: MaxStreamDuration is the maximum time that
a stream’s lifetime will span. Setting this timeout
to 0 will disable it. Disabled by default.
to "0s" will disable it.
type: string
requestTimeout:
default: 15s
description: RequestTimeout The amount of time that
proxy will wait for the entire request to be received.
The timer is activated when the request is initiated,
and is disarmed when the last byte of the request
is sent, OR when the response is initiated. Setting
this timeout to 0 will disable it. Default is 15s.
this timeout to "0s" will disable it.
type: string
streamIdleTimeout:
default: 30s
description: StreamIdleTimeout is the amount of time
that proxy will allow a stream to exist with no activity.
Setting this timeout to 0 will disable it. Default
is 30m
Setting this timeout to "0s" will disable it.
type: string
type: object
idleTimeout:
default: 1h
description: IdleTimeout is defined as the period in which
there are no bytes sent or received on connection Setting
this timeout to 0 will disable it. Be cautious when disabling
it because it can lead to connection leaking. Default
value is 1h.
this timeout to "0s" will disable it. Be cautious when
disabling it because it can lead to connection leaking.
type: string
type: object
targetRef:
Expand Down
Loading