"Fossies" - the Fresh Open Source Software Archive

Member "istio-1.6.5/mixer/adapter/kubernetesenv/config/adapter.kubernetesenv.config.pb.html" (8 Jul 2020, 3301 Bytes) of package /linux/misc/istio-1.6.5.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 ---
    2 title: Kubernetes Env
    3 description: Adapter that extracts information from a Kubernetes environment.
    4 location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/kubernetesenv.html
    5 layout: protoc-gen-docs
    6 generator: protoc-gen-docs
    7 supported_templates: kubernetes
    8 aliases:
    9   - /docs/reference/config/adapters/kubernetesenv.html
   10 number_of_entries: 1
   11 ---
   12 <p>The <code>kubernetesenv</code> adapter extracts information from a Kubernetes environment
   13 and produces attributes that can be used in downstream adapters.</p>
   14 
   15 <p>This adapter supports the <a href="https://istio.io/docs/reference/config/policy-and-telemetry/templates/kubernetes/">kubernetes template</a>.</p>
   16 
   17 <h2 id="Params">Params</h2>
   18 <section>
   19 <p>Configuration parameters for the kubernetes adapter. These params
   20 control the manner in which the kubernetes adapter discovers and
   21 generates values related to pod information.</p>
   22 
   23 <p>The adapter works by looking up pod information by UIDs (of the
   24 form: &ldquo;kubernetes://pod.namespace&rdquo;). It expects that the UIDs will be
   25 supplied in an input map for three distinct traffic classes (source,
   26 destination, and origin).</p>
   27 
   28 <p>For all valid UIDs supplied, this adapter generates output
   29 values containing information about the related pods.</p>
   30 
   31 <table class="message-fields">
   32 <thead>
   33 <tr>
   34 <th>Field</th>
   35 <th>Type</th>
   36 <th>Description</th>
   37 <th>Required</th>
   38 </tr>
   39 </thead>
   40 <tbody>
   41 <tr id="Params-kubeconfig_path">
   42 <td><code>kubeconfigPath</code></td>
   43 <td><code>string</code></td>
   44 <td>
   45 <p>File path to discover <code>kubeconfig</code>. For in-cluster configuration,
   46 this should be left unset. For local configuration, this should
   47 be set to the path of a <code>kubeconfig</code> file that can be used to
   48 reach a kubernetes API server.</p>
   49 
   50 <p>NOTE: The <code>kubernetesenv</code> adapter will use the value of the <code>KUBECONFIG</code> environment variable
   51 in the case where it is set (overriding any value configured
   52 through this proto).</p>
   53 
   54 <p>Default: &ldquo;&rdquo; (unset)</p>
   55 
   56 </td>
   57 <td>
   58 No
   59 </td>
   60 </tr>
   61 <tr id="Params-cache_refresh_duration">
   62 <td><code>cacheRefreshDuration</code></td>
   63 <td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
   64 <td>
   65 <p>Controls the resync period of the Kubernetes cluster info cache.
   66 The cache will watch for events and every so often completely resync.
   67 This controls how frequently the complete resync occurs.</p>
   68 
   69 <p>Default: 5 minutes</p>
   70 
   71 </td>
   72 <td>
   73 No
   74 </td>
   75 </tr>
   76 <tr id="Params-cluster_registries_namespace">
   77 <td><code>clusterRegistriesNamespace</code></td>
   78 <td><code>string</code></td>
   79 <td>
   80 <p>Namespace of the secret created for multicluster support.</p>
   81 
   82 <p>Details on multicluster and the Kubernetes secret required to
   83 access the remote cluster&rsquo;s credentials can be found in
   84 <a href="https://istio.io/docs/setup/install/multicluster/">multicluster install</a>.</p>
   85 
   86 <p>NOTE: If <code>cluster_registries_namespace</code> is not set then the environment
   87 variable <code>POD_NAMESPACE</code> is checked/used. If <code>POD_NAMESPACE</code> is not
   88 set then <code>cluster_registries_namespace</code> defaults to &ldquo;istio-system&rdquo;.</p>
   89 
   90 <p>Default: &ldquo;istio-system&rdquo;</p>
   91 
   92 </td>
   93 <td>
   94 No
   95 </td>
   96 </tr>
   97 </tbody>
   98 </table>
   99 </section>