Skip to content

Commit

Permalink
docs: fix wrong description on ALSEnvoyProxyAccessLog (#4751)
Browse files Browse the repository at this point in the history
Signed-off-by: zirain <[email protected]>
  • Loading branch information
zirain authored Nov 21, 2024
1 parent 6c6633c commit 2def6a4
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 14 deletions.
5 changes: 1 addition & 4 deletions api/v1alpha1/accesslogging_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -138,10 +138,7 @@ const (
// The service must implement the Envoy gRPC Access Log Service streaming API:
// https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/accesslog/v3/als.proto
// Access log format information is passed in the form of gRPC metadata when the
// stream is established. Specifically, the following metadata is passed:
//
// - `x-accesslog-text` - The access log format string when a Text format is used.
// - `x-accesslog-attr` - JSON encoded key/value pairs when a JSON format is used.
// stream is established.
//
// +kubebuilder:validation:XValidation:rule="self.type == 'HTTP' || !has(self.http)",message="The http field may only be set when type is HTTP."
// +kubebuilder:validation:XValidation:message="BackendRefs must be used, backendRef is not supported.",rule="!has(self.backendRef)"
Expand Down
6 changes: 1 addition & 5 deletions site/content/en/latest/api/extension_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,7 @@ ALSEnvoyProxyAccessLog defines the gRPC Access Log Service (ALS) sink.
The service must implement the Envoy gRPC Access Log Service streaming API:
https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/accesslog/v3/als.proto
Access log format information is passed in the form of gRPC metadata when the
stream is established. Specifically, the following metadata is passed:


- `x-accesslog-text` - The access log format string when a Text format is used.
- `x-accesslog-attr` - JSON encoded key/value pairs when a JSON format is used.
stream is established.

_Appears in:_
- [ProxyAccessLogSink](#proxyaccesslogsink)
Expand Down
6 changes: 1 addition & 5 deletions site/content/zh/latest/api/extension_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,7 @@ ALSEnvoyProxyAccessLog defines the gRPC Access Log Service (ALS) sink.
The service must implement the Envoy gRPC Access Log Service streaming API:
https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/accesslog/v3/als.proto
Access log format information is passed in the form of gRPC metadata when the
stream is established. Specifically, the following metadata is passed:


- `x-accesslog-text` - The access log format string when a Text format is used.
- `x-accesslog-attr` - JSON encoded key/value pairs when a JSON format is used.
stream is established.

_Appears in:_
- [ProxyAccessLogSink](#proxyaccesslogsink)
Expand Down

0 comments on commit 2def6a4

Please sign in to comment.