Automator: update istio.io@ reference docs (#8764)

This commit is contained in:
Istio Automation 2021-01-11 18:10:32 -08:00 committed by GitHub
parent 5a333a7be1
commit 1e75e9ee34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 117 additions and 0 deletions

View File

@ -1487,6 +1487,11 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.9.0/
<td>Config namespace (default ``)</td>
</tr>
<tr>
<td><code>--server &lt;string&gt;</code></td>
<td></td>
<td>The address and port of the Kubernetes API server. (default ``)</td>
</tr>
<tr>
<td><code>--service-account &lt;string&gt;</code></td>
<td></td>
<td>Create a secret with this service account&#39;s credentials. Use &#34;istio-reader-service-account&#34; as default value if --type is &#34;remote&#34;, use &#34;istiod-service-account&#34; as default value if --type is &#34;config&#34;. (default ``)</td>

View File

@ -0,0 +1,112 @@
---
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/api' REPO
source_repo: https://github.com/istio/api
title: Resource Labels
description: Resource labels used by Istio.
location: https://istio.io/docs/reference/config/labels/
weight: 60
---
<p>
This page presents the various resource <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/">labels</a> that
Istio supports to control its behavior.
</p>
<table class="annotations">
<thead>
<tr>
<th>Label Name</th>
<th>Feature Status</th>
<th>Resource Types</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>istio.io/rev</code></td>
<td>Alpha</td>
<td>[Namespace]</td>
<td>Istio control plane revision associated with the resource; e.g. `canary`</td>
</tr>
<tr>
<td><code>service.istio.io/canonical-name</code></td>
<td>Alpha</td>
<td>[Pod]</td>
<td>Istio Canonical Service for a workload instance.</td>
</tr>
<tr>
<td><code>service.istio.io/canonical-revision</code></td>
<td>Alpha</td>
<td>[Pod]</td>
<td>Istio Canonical Service revision for a workload instance.</td>
</tr>
<tr>
<td><code>topology.istio.io/cluster</code></td>
<td>Alpha</td>
<td>[Pod]</td>
<td>A workload label that indicates the name of the cluster that contains the workload. This is typically configured during control plane installation, using either an auto-generated or admin-specified value. Setting this allows workload selection by cluster. For example, a service owner could create a DestinationRule containing a subset per cluster and then use these subsets to control traffic flow to each cluster independently.</td>
</tr>
<tr>
<td><code>topology.istio.io/network</code></td>
<td>Alpha</td>
<td>[Namespace Pod Service]</td>
<td>A label used to identify the network for one or more pods. This is used<br>internally by Istio to group pods resident in the same L3 domain/network.<br>Istio assumes that pods in the same network are directly reachable from<br>one another. When pods are in different networks, an Istio Gateway<br>(e.g. east-west gateway) is typically used to establish connectivity<br>(with AUTO_PASSTHROUGH mode). This label can be applied to the following<br>resources to help automate Istio's multi-network configuration.<br><br>* Istio System Namespace: Applying this label to the system namespace<br> establishes a default network for pods managed by the control plane.<br> This is typically configured during control plane installation using an<br> admin-specified value.<br><br>* Pod: Applying this label to a pod allows overriding the default network<br> on a per-pod basis. This is typically applied to the pod via webhook<br> injection, but can also be manually specified on the pod by the service<br> owner. The Istio installation in each cluster configures webhook injection<br> using an admin-specified value.<br><br>* Gateway Service: Applying this label to the Service for an Istio Gateway,<br> indicates that Istio should use this service as the gateway for the<br> network, when configuring cross-network traffic. Istio will configure<br> pods residing outside of the network to access the Gateway service<br> via `spec.externalIPs`, `status.loadBalancer.ingress[].ip`, or in the case<br> of a NodePort service, the Node's address. The label is configured when<br> installing the gateway (e.g. east-west gateway) and should match either<br> the default network for the control plane (as specified by the Istio System<br> Namespace label) or the network of the targeted pods.</td>
</tr>
<tr>
<td><code>topology.istio.io/subzone</code></td>
<td>Alpha</td>
<td>[Node]</td>
<td>User-provided node label for identifying the locality subzone of a workload. This allows admins to specify a more granular level of locality than what is offered by default with Kubernetes regions and zones.</td>
</tr>
</tbody>
</table>