Skip to content

Commit 681fed9

Browse files
authored
update credentialName docs for DestinationRule and Gateway (#2714)
* update credentialName docs for DestinationRule and Gateway * address comments
1 parent 17d87a9 commit 681fed9

17 files changed

+67
-76
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.

networking/v1alpha3/destination_rule.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.

networking/v1alpha3/destination_rule.pb.go

Lines changed: 6 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

networking/v1alpha3/destination_rule.pb.html

Lines changed: 6 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

networking/v1alpha3/destination_rule.proto

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1093,16 +1093,15 @@ message ClientTLSSettings {
10931093
string ca_certificates = 4;
10941094

10951095
// The name of the secret that holds the TLS certs for the
1096-
// client including the CA certificates. Secret must exist in the
1097-
// same namespace with the proxy using the certificates.
1098-
// The secret (of type `generic`)should contain the
1099-
// following keys and values: `key: <privateKey>`,
1100-
// `cert: <clientCert>`, `cacert: <CACertificate>`.
1096+
// client including the CA certificates. This secret must exist in
1097+
// the namespace of the proxy using the certificates.
1098+
// An Opaque secret should contain the following keys and values:
1099+
// `key: <privateKey>`, `cert: <clientCert>`, `cacert: <CACertificate>`.
11011100
// Here CACertificate is used to verify the server certificate.
11021101
// For mutual TLS, `cacert: <CACertificate>` can be provided in the
11031102
// same secret or a separate secret named `<secret>-cacert`.
1104-
// Secret of type tls for client certificates along with
1105-
// ca.crt key for CA certificates is also supported.
1103+
// A TLS secret for client certificates with an additional
1104+
// `ca.crt` key for CA certificates is also supported.
11061105
// Only one of client certificates and CA certificate
11071106
// or credentialName can be specified.
11081107
//

networking/v1alpha3/gateway.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.

networking/v1alpha3/gateway.pb.go

Lines changed: 6 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

networking/v1alpha3/gateway.pb.html

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

networking/v1alpha3/gateway.proto

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -672,13 +672,12 @@ message ServerTLSSettings {
672672

673673
// For gateways running on Kubernetes, the name of the secret that
674674
// holds the TLS certs including the CA certificates. Applicable
675-
// only on Kubernetes. The secret (of type `generic`) should
676-
// contain the following keys and values: `key:
677-
// <privateKey>` and `cert: <serverCert>`. For mutual TLS,
678-
// `cacert: <CACertificate>` can be provided in the same secret or
679-
// a separate secret named `<secret>-cacert`.
680-
// Secret of type tls for server certificates along with
681-
// ca.crt key for CA certificates is also supported.
675+
// only on Kubernetes. An Opaque secret should contain the following
676+
// keys and values: `key: <privateKey>` and `cert: <serverCert>`.
677+
// For mutual TLS, `cacert: <CACertificate>` can be provided in the
678+
// same secret or a separate secret named `<secret>-cacert`.
679+
// A TLS secret for server certificates with an additional `ca.crt`
680+
// key for CA certificates is also supported.
682681
// Only one of server certificates and CA certificate
683682
// or credentialName can be specified.
684683
string credential_name = 10;

networking/v1alpha3/sidecar.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.

0 commit comments

Comments
 (0)