Update documentation

latest/_sources/commands/cluster.rst.txt

@@ -21,8 +21,8 @@ CLI commands for interacting with the Silverback Platform.
     :nested: full
     :commands: new, list, info, update, remove
 
-.. click:: silverback._cli:registry_auth
-    :prog: silverback cluster registry auth
+.. click:: silverback._cli:registry
+    :prog: silverback cluster registry
     :nested: full
     :commands: new, list, info, update, remove
 

latest/_sources/userguides/deploying.md.txt

@@ -105,7 +105,7 @@ Once you have created all the Variable Group(s) that you need to operate your Bo
 ## Private Container Registries
 
 If you are using a private container registry to store your images, you will need to provide your bot with the necessary credentials to access it.
-First you will need to add your credentials to the cluster with the [`silverback cluster registry auth new`][silverback-cluster-registry-auth-new] command.
+First you will need to add your credentials to the cluster with the [`silverback cluster registry new`][silverback-cluster-registry-new] command.
 
 Then you can provide the name of these credentials when creating your bot with the [`silverback cluster bots new`][silverback-cluster-bots-new] or [`silverback cluster bots update`][silverback-cluster-bots-update] commands.
 
@@ -198,7 +198,7 @@ TODO: Downloading metrics from your Bot
 [silverback-cluster-bots-start]: ../commands/cluster.html#silverback-cluster-bots-start
 [silverback-cluster-bots-stop]: ../commands/cluster.html#silverback-cluster-bots-stop
 [silverback-cluster-bots-update]: ../commands/cluster.html#silverback-cluster-bots-update
-[silverback-cluster-registry-auth-new]: ../commands/cluster.html#silverback-cluster-registry-auth-new
+[silverback-cluster-registry-new]: ../commands/cluster.html#silverback-cluster-registry-new
 [silverback-cluster-vars]: ../commands/cluster.html#silverback-cluster-vars
 [silverback-cluster-vars-info]: ../commands/cluster.html#silverback-cluster-vars-info
 [silverback-cluster-vars-list]: ../commands/cluster.html#silverback-cluster-vars-list

latest/methoddocs/main.html

@@ -145,7 +145,7 @@ <h1>silverback.main<a class="headerlink" href="#silverback-main" title="Link to
 <span class="pre">`</span></code></p>
 <p>Usage example:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="nd">@bot</span><span class="o">.</span><span class="n">on_</span><span class="p">(</span><span class="o">...</span><span class="p">)</span>
-</span><span data-line="2"><span class="k">def</span> <span class="nf">do_something_with_state</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
+</span><span data-line="2"><span class="k">def</span><span class="w"> </span><span class="nf">do_something_with_state</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
 </span><span data-line="3">    <span class="c1"># Read from state using `getattr`</span>
 </span><span data-line="4">    <span class="o">...</span> <span class="o">=</span> <span class="n">bot</span><span class="o">.</span><span class="n">state</span><span class="o">.</span><span class="n">something</span>
 </span><span data-line="5">
@@ -167,7 +167,7 @@ <h1>silverback.main<a class="headerlink" href="#silverback-main" title="Link to
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ManagerAccessMixin</span></code></p>
 <p>The bot singleton. Must be initialized prior to use.</p>
 <p>Usage example:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="kn">from</span> <span class="nn">silverback</span> <span class="kn">import</span> <span class="n">SilverbackBot</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="kn">from</span><span class="w"> </span><span class="nn">silverback</span><span class="w"> </span><span class="kn">import</span> <span class="n">SilverbackBot</span>
 </span><span data-line="2">
 </span><span data-line="3"><span class="n">bot</span> <span class="o">=</span> <span class="n">SilverbackBot</span><span class="p">()</span>
 </span><span data-line="4">
@@ -229,7 +229,7 @@ <h1>silverback.main<a class="headerlink" href="#silverback-main" title="Link to
 Runner has decided to put the bot into the “shutdown” state.</p>
 <p>Usage example:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="nd">@bot</span><span class="o">.</span><span class="n">on_shutdown</span><span class="p">()</span>
-</span><span data-line="2"><span class="k">def</span> <span class="nf">do_something_on_shutdown</span><span class="p">():</span>
+</span><span data-line="2"><span class="k">def</span><span class="w"> </span><span class="nf">do_something_on_shutdown</span><span class="p">():</span>
 </span><span data-line="3">    <span class="o">...</span>  <span class="c1"># Record final state of bot</span>
 </span></pre></div>
 </div>
@@ -242,7 +242,7 @@ <h1>silverback.main<a class="headerlink" href="#silverback-main" title="Link to
 bot is put into the “run” state by the Runner.</p>
 <p>Usage example:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="nd">@bot</span><span class="o">.</span><span class="n">on_startup</span><span class="p">()</span>
-</span><span data-line="2"><span class="k">def</span> <span class="nf">do_something_on_startup</span><span class="p">(</span><span class="n">startup_state</span><span class="p">:</span> <span class="n">StateSnapshot</span><span class="p">):</span>
+</span><span data-line="2"><span class="k">def</span><span class="w"> </span><span class="nf">do_something_on_startup</span><span class="p">(</span><span class="n">startup_state</span><span class="p">:</span> <span class="n">StateSnapshot</span><span class="p">):</span>
 </span><span data-line="3">    <span class="o">...</span>  <span class="c1"># Reprocess missed events or blocks</span>
 </span></pre></div>
 </div>
@@ -258,7 +258,7 @@ <h1>silverback.main<a class="headerlink" href="#silverback-main" title="Link to
 <span class="pre">`</span></code></p>
 <p>Usage example:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="nd">@bot</span><span class="o">.</span><span class="n">on_worker_shutdown</span><span class="p">()</span>
-</span><span data-line="2"><span class="k">def</span> <span class="nf">do_something_on_shutdown</span><span class="p">(</span><span class="n">state</span><span class="p">):</span>
+</span><span data-line="2"><span class="k">def</span><span class="w"> </span><span class="nf">do_something_on_shutdown</span><span class="p">(</span><span class="n">state</span><span class="p">):</span>
 </span><span data-line="3">    <span class="o">...</span>  <span class="c1"># Update some external service, perhaps using information from `state`.</span>
 </span></pre></div>
 </div>
@@ -274,7 +274,7 @@ <h1>silverback.main<a class="headerlink" href="#silverback-main" title="Link to
 <span class="pre">`</span></code></p>
 <p>Usage example:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="nd">@bot</span><span class="o">.</span><span class="n">on_worker_startup</span><span class="p">()</span>
-</span><span data-line="2"><span class="k">def</span> <span class="nf">do_something_on_startup</span><span class="p">(</span><span class="n">state</span><span class="p">):</span>
+</span><span data-line="2"><span class="k">def</span><span class="w"> </span><span class="nf">do_something_on_startup</span><span class="p">(</span><span class="n">state</span><span class="p">):</span>
 </span><span data-line="3">    <span class="o">...</span>  <span class="c1"># Can provision resources, or add things to `state`.</span>
 </span></pre></div>
 </div>

latest/userguides/deploying.html

@@ -208,7 +208,7 @@ <h2>Adding Environment Variables<a class="headerlink" href="#adding-environment-
 <section id="private-container-registries">
 <h2>Private Container Registries<a class="headerlink" href="#private-container-registries" title="Link to this heading"></a></h2>
 <p>If you are using a private container registry to store your images, you will need to provide your bot with the necessary credentials to access it.
-First you will need to add your credentials to the cluster with the <a class="reference external" href="../commands/cluster.html#silverback-cluster-registry-auth-new"><code class="docutils literal notranslate"><span class="pre">silverback</span> <span class="pre">cluster</span> <span class="pre">registry</span> <span class="pre">auth</span> <span class="pre">new</span></code></a> command.</p>
+First you will need to add your credentials to the cluster with the <a class="reference external" href="../commands/cluster.html#silverback-cluster-registry-new"><code class="docutils literal notranslate"><span class="pre">silverback</span> <span class="pre">cluster</span> <span class="pre">registry</span> <span class="pre">new</span></code></a> command.</p>
 <p>Then you can provide the name of these credentials when creating your bot with the <a class="reference external" href="../commands/cluster.html#silverback-cluster-bots-new"><code class="docutils literal notranslate"><span class="pre">silverback</span> <span class="pre">cluster</span> <span class="pre">bots</span> <span class="pre">new</span></code></a> or <a class="reference external" href="../commands/cluster.html#silverback-cluster-bots-update"><code class="docutils literal notranslate"><span class="pre">silverback</span> <span class="pre">cluster</span> <span class="pre">bots</span> <span class="pre">update</span></code></a> commands.</p>
 </section>
 <section id="deploying-your-bot">