Skip to content

Commit 6b0cffc

Browse files
authored
Document how to configure proxy config (#1998)
* Document how to configure proxy config * document merge
1 parent 8e3314c commit 6b0cffc

File tree

4 files changed

+65
-4
lines changed

4 files changed

+65
-4
lines changed

mesh/v1alpha1/istio.mesh.v1alpha1.gen.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

mesh/v1alpha1/istio.mesh.v1alpha1.pb.html

Lines changed: 20 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

mesh/v1alpha1/proxy.pb.go

Lines changed: 22 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

mesh/v1alpha1/proxy.proto

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,28 @@ message Topology {
291291
ForwardClientCertDetails forward_client_cert_details = 2;
292292
}
293293

294-
// ProxyConfig defines variables for individual Envoy instances.
294+
// ProxyConfig defines variables for individual Envoy instances. This can be configured on a per-workload basis
295+
// as well as by the mesh-wide defaults.
296+
// To set the mesh wide defaults, configure the `defaultConfig` section of `meshConfig`. For example:
297+
//
298+
// ```
299+
// meshConfig:
300+
// defaultConfig:
301+
// discoveryAddress: istiod:15012
302+
// ```
303+
//
304+
// This can also be configured on a per-workload basis by configuring the `proxy.istio.io/config` annotation on the pod. For example:
305+
//
306+
// ```
307+
// annotations:
308+
// proxy.istio.io/config: |
309+
// discoveryAddress: istiod:15012
310+
// ```
311+
//
312+
// If both are configured, the two are merged with per field semantics; the field set in annotation will fully replace the field from mesh config defaults.
313+
// This is different than a deep merge provided by protobuf.
314+
// For example, `"tracing": { "sampling": 5 }` would completely override a setting configuring a tracing provider
315+
// such as `"tracing": { "zipkin": { "address": "..." } }`.
295316
message ProxyConfig {
296317
// Path to the generated configuration file directory.
297318
// Proxy agent generates the actual configuration and stores it in this directory.

0 commit comments

Comments
 (0)