Skip to content

Commit

Permalink
Update reference docs. (#937)
Browse files Browse the repository at this point in the history
  • Loading branch information
geeknoid authored Feb 6, 2018
1 parent ff84954 commit 428af2c
Show file tree
Hide file tree
Showing 58 changed files with 4,529 additions and 2,039 deletions.
257 changes: 181 additions & 76 deletions _docs/reference/api/istio.mixer.v1.html

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions _docs/reference/commands/istio_ca.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: istio_ca
overview: Istio Certificate Authority (CA)
layout: pkg-collateral-docs
number_of_entries: 3
---
<p>Istio Certificate Authority (CA)</p>
<pre class="language-bash"><code>istio_ca [flags]
Expand Down Expand Up @@ -49,6 +50,16 @@
<td>Specifies path to kubeconfig file. This must be specified when not running inside a Kubernetes pod. (default ``)</td>
</tr>
<tr>
<td><code>--livenessProbeInterval &lt;duration&gt;</code></td>
<td></td>
<td>Interval of updating file for the liveness probe. (default `0s`)</td>
</tr>
<tr>
<td><code>--livenessProbePath &lt;string&gt;</code></td>
<td></td>
<td>Path to the file for the liveness probe. (default ``)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
<td></td>
<td>Whether to format output as JSON or in plain console-friendly format </td>
Expand Down
23 changes: 12 additions & 11 deletions _docs/reference/commands/istioctl.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: istioctl
overview: Istio control interface
layout: pkg-collateral-docs
number_of_entries: 13
---
<p>
Istio configuration command line utility.</p>
Expand All @@ -27,7 +28,7 @@
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default `/Users/mtail/.kube/config`)</td>
<td>Kubernetes configuration file (default `$KUBECONFIG else $HOME/.kube/config`)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
Expand Down Expand Up @@ -130,7 +131,7 @@ <h2 id="istioctl context-create">istioctl context-create</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default `/Users/mtail/.kube/config`)</td>
<td>Kubernetes configuration file (default `$KUBECONFIG else $HOME/.kube/config`)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
Expand Down Expand Up @@ -233,7 +234,7 @@ <h2 id="istioctl create">istioctl create</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default `/Users/mtail/.kube/config`)</td>
<td>Kubernetes configuration file (default `$KUBECONFIG else $HOME/.kube/config`)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
Expand Down Expand Up @@ -334,7 +335,7 @@ <h2 id="istioctl delete">istioctl delete</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default `/Users/mtail/.kube/config`)</td>
<td>Kubernetes configuration file (default `$KUBECONFIG else $HOME/.kube/config`)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
Expand Down Expand Up @@ -435,7 +436,7 @@ <h2 id="istioctl deregister">istioctl deregister</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default `/Users/mtail/.kube/config`)</td>
<td>Kubernetes configuration file (default `$KUBECONFIG else $HOME/.kube/config`)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
Expand Down Expand Up @@ -558,7 +559,7 @@ <h2 id="istioctl gen-deploy">istioctl gen-deploy</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default `/Users/mtail/.kube/config`)</td>
<td>Kubernetes configuration file (default `$KUBECONFIG else $HOME/.kube/config`)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
Expand Down Expand Up @@ -664,7 +665,7 @@ <h2 id="istioctl get">istioctl get</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default `/Users/mtail/.kube/config`)</td>
<td>Kubernetes configuration file (default `$KUBECONFIG else $HOME/.kube/config`)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
Expand Down Expand Up @@ -826,7 +827,7 @@ <h2 id="istioctl kube-inject">istioctl kube-inject</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default `/Users/mtail/.kube/config`)</td>
<td>Kubernetes configuration file (default `$KUBECONFIG else $HOME/.kube/config`)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
Expand Down Expand Up @@ -972,7 +973,7 @@ <h2 id="istioctl register">istioctl register</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default `/Users/mtail/.kube/config`)</td>
<td>Kubernetes configuration file (default `$KUBECONFIG else $HOME/.kube/config`)</td>
</tr>
<tr>
<td><code>--labels &lt;stringSlice&gt;</code></td>
Expand Down Expand Up @@ -1080,7 +1081,7 @@ <h2 id="istioctl replace">istioctl replace</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default `/Users/mtail/.kube/config`)</td>
<td>Kubernetes configuration file (default `$KUBECONFIG else $HOME/.kube/config`)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
Expand Down Expand Up @@ -1176,7 +1177,7 @@ <h2 id="istioctl version">istioctl version</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default `/Users/mtail/.kube/config`)</td>
<td>Kubernetes configuration file (default `$KUBECONFIG else $HOME/.kube/config`)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
Expand Down
1 change: 1 addition & 0 deletions _docs/reference/commands/mixc.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: mixc
overview: Utility to trigger direct calls to Mixer&#39;s API.
layout: pkg-collateral-docs
number_of_entries: 5
---
<p>This command lets you interact with a running instance of
Mixer. Note that you need a pretty good understanding of Mixer&#39;s
Expand Down
1 change: 1 addition & 0 deletions _docs/reference/commands/mixs.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: mixs
overview: Mixer is Istio&#39;s abstraction on top of infrastructure backends.
layout: pkg-collateral-docs
number_of_entries: 10
---
<p>Mixer is Istio&#39;s point of integration with infrastructure backends and is the
nexus for policy evaluation and telemetry reporting.</p>
Expand Down
1 change: 1 addition & 0 deletions _docs/reference/commands/node_agent.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: node_agent
overview: Istio security per-node agent
layout: pkg-collateral-docs
number_of_entries: 3
---
<p>Istio security per-node agent</p>
<pre class="language-bash"><code>node_agent [flags]
Expand Down
6 changes: 6 additions & 0 deletions _docs/reference/commands/pilot-agent.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: pilot-agent
overview: Istio Pilot agent
layout: pkg-collateral-docs
number_of_entries: 4
---
<p>Istio Pilot provides management plane functionality to the Istio service mesh and Istio Mixer.</p>
<table class="command-flags">
Expand Down Expand Up @@ -95,6 +96,11 @@ <h2 id="pilot-agent proxy">pilot-agent proxy</h2>
<td>Path to the proxy binary (default `/usr/local/bin/envoy`)</td>
</tr>
<tr>
<td><code>--bootstrapv2</code></td>
<td></td>
<td>Use bootstrap v2 </td>
</tr>
<tr>
<td><code>--configPath &lt;string&gt;</code></td>
<td></td>
<td>Path to the generated configuration file directory (default `/etc/istio/proxy`)</td>
Expand Down
1 change: 1 addition & 0 deletions _docs/reference/commands/pilot-discovery.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: pilot-discovery
overview: Istio Pilot
layout: pkg-collateral-docs
number_of_entries: 4
---
<p>Istio Pilot provides fleet-wide traffic management capabilities in the Istio Service Mesh.</p>
<table class="command-flags">
Expand Down
1 change: 1 addition & 0 deletions _docs/reference/commands/sidecar-injector.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: sidecar-injector
overview: Kubernetes webhook for automatic Istio sidecar injection
layout: pkg-collateral-docs
number_of_entries: 3
---
<p>Kubernetes webhook for automatic Istio sidecar injection</p>
<pre class="language-bash"><code>sidecar-injector [flags]
Expand Down
113 changes: 113 additions & 0 deletions _docs/reference/config/adapters/circonus.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
---
title: Circonus
overview: Adapter for circonus.com's monitoring solution.
location: https://istio.io/docs/reference/config/adapters/circonus.html
layout: protoc-gen-docs
number_of_entries: 3
---
{% raw %}
<p>The <code>circonus</code> adapter enables Istio to deliver metric data to the
<a href="https://www.circonus.com">Circonus</a> monitoring backend.</p>

<h2 id="Params">Params</h2>
<section>
<p>Cnofiguration format for the Circonus adapter.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="Params.submission_url">
<td><code>submissionUrl</code></td>
<td><code>string</code></td>
<td>
<p>Circonus SubmissionURL to HTTPTrap check</p>

</td>
</tr>
<tr id="Params.submission_interval">
<td><code>submissionInterval</code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">google.protobuf.Duration</a></code></td>
<td>
</td>
</tr>
<tr id="Params.metrics">
<td><code>metrics</code></td>
<td><code><a href="#Params.MetricInfo">Params.MetricInfo[]</a></code></td>
<td>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Params.MetricInfo">Params.MetricInfo</h2>
<section>
<p>Describes how to represent a metric</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="Params.MetricInfo.name">
<td><code>name</code></td>
<td><code>string</code></td>
<td>
<p>name</p>

</td>
</tr>
<tr id="Params.MetricInfo.type">
<td><code>type</code></td>
<td><code><a href="#Params.MetricInfo.Type">Params.MetricInfo.Type</a></code></td>
<td>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Params.MetricInfo.Type">Params.MetricInfo.Type</h2>
<section>
<p>The type of metric.</p>

<table class="enum-values">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="Params.MetricInfo.Type.UNKNOWN">
<td><code>UNKNOWN</code></td>
<td>
</td>
</tr>
<tr id="Params.MetricInfo.Type.COUNTER">
<td><code>COUNTER</code></td>
<td>
</td>
</tr>
<tr id="Params.MetricInfo.Type.GAUGE">
<td><code>GAUGE</code></td>
<td>
</td>
</tr>
<tr id="Params.MetricInfo.Type.DISTRIBUTION">
<td><code>DISTRIBUTION</code></td>
<td>
</td>
</tr>
</tbody>
</table>
</section>
{% endraw %}
Loading

0 comments on commit 428af2c

Please sign in to comment.