Skip to content

Commit

Permalink
docs: fix rendering of links and code snippets (#3036)
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
  • Loading branch information
peterj committed Jan 5, 2024
1 parent 35153ef commit a6b42df
Show file tree
Hide file tree
Showing 8 changed files with 95 additions and 73 deletions.
48 changes: 28 additions & 20 deletions mesh/v1alpha1/config.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

48 changes: 28 additions & 20 deletions mesh/v1alpha1/config.proto
Original file line number Diff line number Diff line change
Expand Up @@ -546,8 +546,8 @@ message MeshConfig {
bool allow_partial_message = 2;

// If true, the body sent to the external authorization service in the gRPC authorization request is set with raw bytes
// in the raw_body field (https://github.com/envoyproxy/envoy/blame/cffb095d59d7935abda12b9509bcd136808367bb/api/envoy/service/auth/v3/attribute_context.proto#L153).
// Otherwise, it will be filled with UTF-8 string in the body field (https://github.com/envoyproxy/envoy/blame/cffb095d59d7935abda12b9509bcd136808367bb/api/envoy/service/auth/v3/attribute_context.proto#L147).
// in the [raw_body field](https://github.com/envoyproxy/envoy/blame/cffb095d59d7935abda12b9509bcd136808367bb/api/envoy/service/auth/v3/attribute_context.proto#L153).
// Otherwise, it will be filled with UTF-8 string in the [body field](https://github.com/envoyproxy/envoy/blame/cffb095d59d7935abda12b9509bcd136808367bb/api/envoy/service/auth/v3/attribute_context.proto#L147).
// This field only works with the envoy_ext_authz_grpc provider and has no effect for the envoy_ext_authz_http provider.
bool pack_as_bytes = 3;
}
Expand Down Expand Up @@ -593,8 +593,9 @@ message MeshConfig {
// request can include the buffered client request body (controlled by include_request_body_in_check setting),
// consequently the value of Content-Length of the authorization request reflects the size of its payload size.
//
// Exact, prefix and suffix matches are supported (similar to the authorization policy rule syntax except the presence match
// https://istio.io/latest/docs/reference/config/security/authorization-policy/#Rule):
// Exact, prefix and suffix matches are supported (similar to the
// [authorization policy rule syntax](https://istio.io/latest/docs/reference/config/security/authorization-policy/#Rule)
// except the presence match):
// - Exact match: "abc" will match on value "abc".
// - Prefix match: "abc*" will match on value "abc" and "abcd".
// - Suffix match: "*abc" will match on value "abc" and "xabc".
Expand All @@ -613,8 +614,9 @@ message MeshConfig {
// If not specified, the original request will not be modified and forwarded to backend as-is.
// Note, any existing headers will be overridden.
//
// Exact, prefix and suffix matches are supported (similar to the authorization policy rule syntax except the presence match
// https://istio.io/latest/docs/reference/config/security/authorization-policy/#Rule):
// Exact, prefix and suffix matches are supported (similar to the
// [authorization policy rule syntax](https://istio.io/latest/docs/reference/config/security/authorization-policy/#Rule)
// except the presence match):
// - Exact match: "abc" will match on value "abc".
// - Prefix match: "abc*" will match on value "abc" and "abcd".
// - Suffix match: "*abc" will match on value "abc" and "xabc".
Expand All @@ -628,8 +630,9 @@ message MeshConfig {
// automatically added.
// Note, the body from the authorization service is always included in the response to downstream.
//
// Exact, prefix and suffix matches are supported (similar to the authorization policy rule syntax except the presence match
// https://istio.io/latest/docs/reference/config/security/authorization-policy/#Rule):
// Exact, prefix and suffix matches are supported (similar to the
// [authorization policy rule syntax](https://istio.io/latest/docs/reference/config/security/authorization-policy/#Rule)
// except the presence match):
// - Exact match: "abc" will match on value "abc".
// - Prefix match: "abc*" will match on value "abc" and "abcd".
// - Suffix match: "*abc" will match on value "abc" and "xabc".
Expand All @@ -640,8 +643,9 @@ message MeshConfig {
// If not specified, the original response will not be modified and forwarded to downstream as-is.
// Note, any existing headers will be overridden.
//
// Exact, prefix and suffix matches are supported (similar to the authorization policy rule syntax except the presence match
// https://istio.io/latest/docs/reference/config/security/authorization-policy/#Rule):
// Exact, prefix and suffix matches are supported (similar to the
// [authorization policy rule syntax](https://istio.io/latest/docs/reference/config/security/authorization-policy/#Rule)
// except the presence match):
// - Exact match: "abc" will match on value "abc".
// - Prefix match: "abc*" will match on value "abc" and "abcd".
// - Suffix match: "*abc" will match on value "abc" and "xabc".
Expand Down Expand Up @@ -1069,7 +1073,7 @@ message MeshConfig {
// - cassandra
// - spark
// ```
// Refer to the [kubernetes selector docs](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors)
// Refer to the [Kubernetes selector docs](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors)
// for additional detail on selector semantics.
repeated k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector discovery_selectors = 59;

Expand Down Expand Up @@ -1139,23 +1143,26 @@ message MeshConfig {
TLSProtocol min_protocol_version = 1;
//
// Optional: If specified, the TLS connection will only support the specified ECDH curves for the DH key exchange.
// If not specified, the default curves enforced by envoy will be used. For details about the default curves, refer to
// [Ecdh Curves](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/transport_sockets/tls/v3/common.proto)
// If not specified, the default curves enforced by Envoy will be used. For details about the default curves, refer to
// [Ecdh Curves](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/transport_sockets/tls/v3/common.proto).
repeated string ecdh_curves = 2;
//
// Optional: If specified, the TLS connection will only support the specified cipher list when negotiating TLS 1.0-1.2.
// If not specified, the following cipher suites will be used:
// ECDHE-ECDSA-AES256-GCM-SHA384
// ECDHE-RSA-AES256-GCM-SHA384
// ECDHE-ECDSA-AES128-GCM-SHA256
// ECDHE-RSA-AES128-GCM-SHA256
// AES256-GCM-SHA384
// AES128-GCM-SHA256
// ```
// ECDHE-ECDSA-AES256-GCM-SHA384
// ECDHE-RSA-AES256-GCM-SHA384
// ECDHE-ECDSA-AES128-GCM-SHA256
// ECDHE-RSA-AES128-GCM-SHA256
// AES256-GCM-SHA384
// AES128-GCM-SHA256
// ```
repeated string cipher_suites = 3;
}

// The below configuration parameters can be used to specify TLSConfig for mesh traffic.
// For example, a user could enable min TLS version for ISTIO_MUTUAL traffic and specify a curve for non ISTIO_MUTUAL traffic like below:
// ```yaml
// meshConfig:
// meshMTLS:
// minProtocolVersion: TLSV1_3
Expand All @@ -1164,8 +1171,9 @@ message MeshConfig {
// ecdhCurves:
// - P-256
// - P-512
//
// ```
// Configuration of mTLS for traffic between workloads with ISTIO_MUTUAL TLS traffic.
//
// Note: Mesh mTLS does not respect ECDH curves.
TLSConfig mesh_mTLS = 63;
//
Expand Down
Loading

0 comments on commit a6b42df

Please sign in to comment.