这是indexloc提供的服务，不要输入任何密码
Skip to content

Update docs #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 20, 2019
+20 −31
Merged

Update docs #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions docs/print.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -861,15 +861,14 @@ <h2><a class="header" href="#flags-2" id="flags-2">FLAGS</a></h2>
-v, --version Prints version information.
</code></pre>
<h2><a class="header" href="#options-2" id="options-2">OPTIONS</a></h2>
<pre><code>-s, --servers &lt;IP:PORT&gt;... Server addresses in an existing cluster separated by &quot;,&quot;. If not specified, use
default servers. [default: 127.0.0.1:5000]
<pre><code>-s, --server &lt;IP:PORT&gt; Server address in an existing cluster. [default: 127.0.0.1:5000]
</code></pre>
<h2><a class="header" href="#examples-2" id="examples-2">EXAMPLES</a></h2>
<p>To probe a server with default options:</p>
<pre><code class="language-text">$ ./bin/bayard probe
</code></pre>
<p>To probe a server with options:</p>
<pre><code class="language-text">$ ./bin/bayard probe --servers=127.0.0.1:5001
<pre><code class="language-text">$ ./bin/bayard probe --server=127.0.0.1:5001
</code></pre>
<h1><a class="header" href="#bayard-peers" id="bayard-peers">bayard peers</a></h1>
<p>The <code>bayard peers</code> CLI shows the peer addresses of the cluster that the specified server is joining.</p>
Expand All @@ -881,15 +880,14 @@ <h2><a class="header" href="#flags-3" id="flags-3">FLAGS</a></h2>
-v, --version Prints version information.
</code></pre>
<h2><a class="header" href="#options-3" id="options-3">OPTIONS</a></h2>
<pre><code>-s, --servers &lt;IP:PORT&gt;... Server addresses in an existing cluster separated by &quot;,&quot;. If not specified, use
default servers. [default: 127.0.0.1:5000]
<pre><code>-s, --server &lt;IP:PORT&gt; Server address in an existing cluster. [default: 127.0.0.1:5000]
</code></pre>
<h2><a class="header" href="#examples-3" id="examples-3">EXAMPLES</a></h2>
<p>To show peers of the cluster with default options:</p>
<pre><code class="language-text">$ ./bin/bayard peers
</code></pre>
<p>To show peers of the cluster with options:</p>
<pre><code class="language-text">$ ./bin/bayard peers --servers=127.0.0.1:5001
<pre><code class="language-text">$ ./bin/bayard peers --server=127.0.0.1:5001
</code></pre>
<h1><a class="header" href="#bayard-metrics" id="bayard-metrics">bayard metrics</a></h1>
<p>The <code>bayard metrics</code> CLI shows the server metrics of the specified server. The metrics are output in Prometheus exposition format.</p>
Expand All @@ -901,15 +899,13 @@ <h2><a class="header" href="#flags-4" id="flags-4">FLAGS</a></h2>
-v, --version Prints version information.
</code></pre>
<h2><a class="header" href="#options-4" id="options-4">OPTIONS</a></h2>
<pre><code>-s, --servers &lt;IP:PORT&gt;... Server addresses in an existing cluster separated by &quot;,&quot;. If not specified, use
default servers. [default: 127.0.0.1:5000]
</code></pre>
<p>-s, --server <a href="reference/bayard/IP:PORT">IP:PORT</a> Server address in an existing cluster. [default: 127.0.0.1:5000]</p>
<h2><a class="header" href="#examples-4" id="examples-4">EXAMPLES</a></h2>
<p>To show metrics with default options:</p>
<pre><code class="language-text">$ ./bin/bayard metrics
</code></pre>
<p>To show metrics with options:</p>
<pre><code class="language-text">$ ./bin/bayard metrics --servers=127.0.0.1:5001
<pre><code class="language-text">$ ./bin/bayard metrics --server=127.0.0.1:5001
</code></pre>
<h1><a class="header" href="#bayard-leave" id="bayard-leave">bayard leave</a></h1>
<p>The <code>bayard leave</code> CLI removes the server with the specified ID from the cluster that the specified server is joining.</p>
Expand Down
6 changes: 2 additions & 4 deletions docs/reference/bayard/metrics.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,15 +158,13 @@ <h2><a class="header" href="#flags" id="flags">FLAGS</a></h2>
-v, --version Prints version information.
</code></pre>
<h2><a class="header" href="#options" id="options">OPTIONS</a></h2>
<pre><code>-s, --servers &lt;IP:PORT&gt;... Server addresses in an existing cluster separated by &quot;,&quot;. If not specified, use
default servers. [default: 127.0.0.1:5000]
</code></pre>
<p>-s, --server <a href="IP:PORT">IP:PORT</a> Server address in an existing cluster. [default: 127.0.0.1:5000]</p>
<h2><a class="header" href="#examples" id="examples">EXAMPLES</a></h2>
<p>To show metrics with default options:</p>
<pre><code class="language-text">$ ./bin/bayard metrics
</code></pre>
<p>To show metrics with options:</p>
<pre><code class="language-text">$ ./bin/bayard metrics --servers=127.0.0.1:5001
<pre><code class="language-text">$ ./bin/bayard metrics --server=127.0.0.1:5001
</code></pre>

</main>
Expand Down
5 changes: 2 additions & 3 deletions docs/reference/bayard/peers.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,15 +158,14 @@ <h2><a class="header" href="#flags" id="flags">FLAGS</a></h2>
-v, --version Prints version information.
</code></pre>
<h2><a class="header" href="#options" id="options">OPTIONS</a></h2>
<pre><code>-s, --servers &lt;IP:PORT&gt;... Server addresses in an existing cluster separated by &quot;,&quot;. If not specified, use
default servers. [default: 127.0.0.1:5000]
<pre><code>-s, --server &lt;IP:PORT&gt; Server address in an existing cluster. [default: 127.0.0.1:5000]
</code></pre>
<h2><a class="header" href="#examples" id="examples">EXAMPLES</a></h2>
<p>To show peers of the cluster with default options:</p>
<pre><code class="language-text">$ ./bin/bayard peers
</code></pre>
<p>To show peers of the cluster with options:</p>
<pre><code class="language-text">$ ./bin/bayard peers --servers=127.0.0.1:5001
<pre><code class="language-text">$ ./bin/bayard peers --server=127.0.0.1:5001
</code></pre>

</main>
Expand Down
5 changes: 2 additions & 3 deletions docs/reference/bayard/probe.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,15 +158,14 @@ <h2><a class="header" href="#flags" id="flags">FLAGS</a></h2>
-v, --version Prints version information.
</code></pre>
<h2><a class="header" href="#options" id="options">OPTIONS</a></h2>
<pre><code>-s, --servers &lt;IP:PORT&gt;... Server addresses in an existing cluster separated by &quot;,&quot;. If not specified, use
default servers. [default: 127.0.0.1:5000]
<pre><code>-s, --server &lt;IP:PORT&gt; Server address in an existing cluster. [default: 127.0.0.1:5000]
</code></pre>
<h2><a class="header" href="#examples" id="examples">EXAMPLES</a></h2>
<p>To probe a server with default options:</p>
<pre><code class="language-text">$ ./bin/bayard probe
</code></pre>
<p>To probe a server with options:</p>
<pre><code class="language-text">$ ./bin/bayard probe --servers=127.0.0.1:5001
<pre><code class="language-text">$ ./bin/bayard probe --server=127.0.0.1:5001
</code></pre>

</main>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/searchindex.json
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 2 additions & 3 deletions docs_src/reference/bayard/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ The `bayard metrics` CLI shows the server metrics of the specified server. The m

## OPTIONS

-s, --servers <IP:PORT>... Server addresses in an existing cluster separated by ",". If not specified, use
default servers. [default: 127.0.0.1:5000]
-s, --server <IP:PORT> Server address in an existing cluster. [default: 127.0.0.1:5000]

## EXAMPLES

Expand All @@ -27,5 +26,5 @@ $ ./bin/bayard metrics
To show metrics with options:

```text
$ ./bin/bayard metrics --servers=127.0.0.1:5001
$ ./bin/bayard metrics --server=127.0.0.1:5001
```
5 changes: 2 additions & 3 deletions docs_src/reference/bayard/peers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ The `bayard peers` CLI shows the peer addresses of the cluster that the specifie

## OPTIONS

-s, --servers <IP:PORT>... Server addresses in an existing cluster separated by ",". If not specified, use
default servers. [default: 127.0.0.1:5000]
-s, --server <IP:PORT> Server address in an existing cluster. [default: 127.0.0.1:5000]

## EXAMPLES

Expand All @@ -27,5 +26,5 @@ $ ./bin/bayard peers
To show peers of the cluster with options:

```text
$ ./bin/bayard peers --servers=127.0.0.1:5001
$ ./bin/bayard peers --server=127.0.0.1:5001
```
5 changes: 2 additions & 3 deletions docs_src/reference/bayard/probe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ The `bayard probe` CLI probes the server.

## OPTIONS

-s, --servers <IP:PORT>... Server addresses in an existing cluster separated by ",". If not specified, use
default servers. [default: 127.0.0.1:5000]
-s, --server <IP:PORT> Server address in an existing cluster. [default: 127.0.0.1:5000]

## EXAMPLES

Expand All @@ -27,5 +26,5 @@ $ ./bin/bayard probe
To probe a server with options:

```text
$ ./bin/bayard probe --servers=127.0.0.1:5001
$ ./bin/bayard probe --server=127.0.0.1:5001
```