Skip to content

Commit 4c24cc9

Browse files
Automator: update istio.io@ reference docs (istio#16364)
1 parent f4e3619 commit 4c24cc9

File tree

2 files changed

+144
-4
lines changed
  • content
    • en/docs/reference/config/networking/gateway
    • zh/docs/reference/config/networking/gateway

2 files changed

+144
-4
lines changed

content/en/docs/reference/config/networking/gateway/index.html

+72-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
generator: protoc-gen-docs
99
schema: istio.networking.v1alpha3.Gateway
1010
aliases: [/docs/reference/config/networking/v1alpha3/gateway]
11-
number_of_entries: 6
11+
number_of_entries: 7
1212
---
1313
<p><code>Gateway</code> describes a load balancer operating at the edge of the mesh
1414
receiving incoming or outgoing HTTP/TCP connections. The specification
@@ -411,6 +411,7 @@ <h2 id="Port">Port</h2>
411411
</section>
412412
<h2 id="ServerTLSSettings">ServerTLSSettings</h2>
413413
<section>
414+
414415
<table class="message-fields">
415416
<thead>
416417
<tr>
@@ -502,6 +503,27 @@ <h2 id="ServerTLSSettings">ServerTLSSettings</h2>
502503
Only one of server certificates and CA certificate
503504
or credentialName can be specified.</p>
504505

506+
</td>
507+
</tr>
508+
<tr id="ServerTLSSettings-credential_names">
509+
<td><div class="field"><div class="name"><code><a href="#ServerTLSSettings-credential_names">credentialNames</a></code></div>
510+
<div class="type">string[]</div>
511+
</div></td>
512+
<td>
513+
<p>Same as CredentialName but for multiple certificates. Mainly used for specifying
514+
RSA and ECDSA certificates for the same server.</p>
515+
516+
</td>
517+
</tr>
518+
<tr id="ServerTLSSettings-tls_certificates">
519+
<td><div class="field"><div class="name"><code><a href="#ServerTLSSettings-tls_certificates">tlsCertificates</a></code></div>
520+
<div class="type"><a href="#ServerTLSSettings-TLSCertificate">TLSCertificate[]</a></div>
521+
</div></td>
522+
<td>
523+
<p>Only one of <code>server_certificate</code>, <code>private_key</code>, <code>ca_certificates</code> or <code>credential_name</code>
524+
or <code>credential_names</code> or <code>tls_certificates</code> should be specified.
525+
This is mainly used for specifying RSA and ECDSA certificates for the same server.</p>
526+
505527
</td>
506528
</tr>
507529
<tr id="ServerTLSSettings-subject_alt_names">
@@ -511,7 +533,9 @@ <h2 id="ServerTLSSettings">ServerTLSSettings</h2>
511533
<td>
512534
<p>A list of alternate names to verify the subject identity in the
513535
certificate presented by the client.
514-
Requires TLS mode to be set to <code>MUTUAL</code>.</p>
536+
Requires TLS mode to be set to <code>MUTUAL</code>.
537+
When multiple certificates are provided via <code>credential_names</code> or <code>tls_certificates</code>,
538+
the subject alternate names are validated against the selected certificate.</p>
515539

516540
</td>
517541
</tr>
@@ -590,6 +614,52 @@ <h2 id="ServerTLSSettings">ServerTLSSettings</h2>
590614
<li><code>DES-CBC3-SHA</code></li>
591615
</ul>
592616

617+
</td>
618+
</tr>
619+
</tbody>
620+
</table>
621+
</section>
622+
<h3 id="ServerTLSSettings-TLSCertificate">TLSCertificate</h3>
623+
<section>
624+
<p>TLSCertificate describes the server&rsquo;s TLS certificate.</p>
625+
626+
<table class="message-fields">
627+
<thead>
628+
<tr>
629+
<th>Field</th>
630+
<th>Description</th>
631+
</tr>
632+
</thead>
633+
<tbody>
634+
<tr id="ServerTLSSettings-TLSCertificate-server_certificate">
635+
<td><div class="field"><div class="name"><code><a href="#ServerTLSSettings-TLSCertificate-server_certificate">serverCertificate</a></code></div>
636+
<div class="type">string</div>
637+
</div></td>
638+
<td>
639+
<p>REQUIRED if mode is <code>SIMPLE</code> or <code>MUTUAL</code>. The path to the file
640+
holding the server-side TLS certificate to use.</p>
641+
642+
</td>
643+
</tr>
644+
<tr id="ServerTLSSettings-TLSCertificate-private_key">
645+
<td><div class="field"><div class="name"><code><a href="#ServerTLSSettings-TLSCertificate-private_key">privateKey</a></code></div>
646+
<div class="type">string</div>
647+
</div></td>
648+
<td>
649+
<p>REQUIRED if mode is <code>SIMPLE</code> or <code>MUTUAL</code>. The path to the file
650+
holding the server&rsquo;s private key.</p>
651+
652+
</td>
653+
</tr>
654+
<tr id="ServerTLSSettings-TLSCertificate-ca_certificates">
655+
<td><div class="field"><div class="name"><code><a href="#ServerTLSSettings-TLSCertificate-ca_certificates">caCertificates</a></code></div>
656+
<div class="type">string</div>
657+
</div></td>
658+
<td>
659+
<p>REQUIRED if mode is <code>MUTUAL</code> or <code>OPTIONAL_MUTUAL</code>. The path to a file
660+
containing certificate authority certificates to use in verifying a presented
661+
client side certificate.</p>
662+
593663
</td>
594664
</tr>
595665
</tbody>

content/zh/docs/reference/config/networking/gateway/index.html

+72-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
generator: protoc-gen-docs
99
schema: istio.networking.v1alpha3.Gateway
1010
aliases: [/zh/docs/reference/config/networking/v1alpha3/gateway]
11-
number_of_entries: 6
11+
number_of_entries: 7
1212
---
1313
<p><code>Gateway</code> describes a load balancer operating at the edge of the mesh
1414
receiving incoming or outgoing HTTP/TCP connections. The specification
@@ -411,6 +411,7 @@ <h2 id="Port">Port</h2>
411411
</section>
412412
<h2 id="ServerTLSSettings">ServerTLSSettings</h2>
413413
<section>
414+
414415
<table class="message-fields">
415416
<thead>
416417
<tr>
@@ -502,6 +503,27 @@ <h2 id="ServerTLSSettings">ServerTLSSettings</h2>
502503
Only one of server certificates and CA certificate
503504
or credentialName can be specified.</p>
504505

506+
</td>
507+
</tr>
508+
<tr id="ServerTLSSettings-credential_names">
509+
<td><div class="field"><div class="name"><code><a href="#ServerTLSSettings-credential_names">credentialNames</a></code></div>
510+
<div class="type">string[]</div>
511+
</div></td>
512+
<td>
513+
<p>Same as CredentialName but for multiple certificates. Mainly used for specifying
514+
RSA and ECDSA certificates for the same server.</p>
515+
516+
</td>
517+
</tr>
518+
<tr id="ServerTLSSettings-tls_certificates">
519+
<td><div class="field"><div class="name"><code><a href="#ServerTLSSettings-tls_certificates">tlsCertificates</a></code></div>
520+
<div class="type"><a href="#ServerTLSSettings-TLSCertificate">TLSCertificate[]</a></div>
521+
</div></td>
522+
<td>
523+
<p>Only one of <code>server_certificate</code>, <code>private_key</code>, <code>ca_certificates</code> or <code>credential_name</code>
524+
or <code>credential_names</code> or <code>tls_certificates</code> should be specified.
525+
This is mainly used for specifying RSA and ECDSA certificates for the same server.</p>
526+
505527
</td>
506528
</tr>
507529
<tr id="ServerTLSSettings-subject_alt_names">
@@ -511,7 +533,9 @@ <h2 id="ServerTLSSettings">ServerTLSSettings</h2>
511533
<td>
512534
<p>A list of alternate names to verify the subject identity in the
513535
certificate presented by the client.
514-
Requires TLS mode to be set to <code>MUTUAL</code>.</p>
536+
Requires TLS mode to be set to <code>MUTUAL</code>.
537+
When multiple certificates are provided via <code>credential_names</code> or <code>tls_certificates</code>,
538+
the subject alternate names are validated against the selected certificate.</p>
515539

516540
</td>
517541
</tr>
@@ -590,6 +614,52 @@ <h2 id="ServerTLSSettings">ServerTLSSettings</h2>
590614
<li><code>DES-CBC3-SHA</code></li>
591615
</ul>
592616

617+
</td>
618+
</tr>
619+
</tbody>
620+
</table>
621+
</section>
622+
<h3 id="ServerTLSSettings-TLSCertificate">TLSCertificate</h3>
623+
<section>
624+
<p>TLSCertificate describes the server&rsquo;s TLS certificate.</p>
625+
626+
<table class="message-fields">
627+
<thead>
628+
<tr>
629+
<th>Field</th>
630+
<th>Description</th>
631+
</tr>
632+
</thead>
633+
<tbody>
634+
<tr id="ServerTLSSettings-TLSCertificate-server_certificate">
635+
<td><div class="field"><div class="name"><code><a href="#ServerTLSSettings-TLSCertificate-server_certificate">serverCertificate</a></code></div>
636+
<div class="type">string</div>
637+
</div></td>
638+
<td>
639+
<p>REQUIRED if mode is <code>SIMPLE</code> or <code>MUTUAL</code>. The path to the file
640+
holding the server-side TLS certificate to use.</p>
641+
642+
</td>
643+
</tr>
644+
<tr id="ServerTLSSettings-TLSCertificate-private_key">
645+
<td><div class="field"><div class="name"><code><a href="#ServerTLSSettings-TLSCertificate-private_key">privateKey</a></code></div>
646+
<div class="type">string</div>
647+
</div></td>
648+
<td>
649+
<p>REQUIRED if mode is <code>SIMPLE</code> or <code>MUTUAL</code>. The path to the file
650+
holding the server&rsquo;s private key.</p>
651+
652+
</td>
653+
</tr>
654+
<tr id="ServerTLSSettings-TLSCertificate-ca_certificates">
655+
<td><div class="field"><div class="name"><code><a href="#ServerTLSSettings-TLSCertificate-ca_certificates">caCertificates</a></code></div>
656+
<div class="type">string</div>
657+
</div></td>
658+
<td>
659+
<p>REQUIRED if mode is <code>MUTUAL</code> or <code>OPTIONAL_MUTUAL</code>. The path to a file
660+
containing certificate authority certificates to use in verifying a presented
661+
client side certificate.</p>
662+
593663
</td>
594664
</tr>
595665
</tbody>

0 commit comments

Comments
 (0)