Update documentation

ApeWorX · Oct 4, 2024 · 62e38be · 62e38be
1 parent b33fd3a
commit 62e38be
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 2 deletions.
diff --git a/index.html b/index.html
@@ -2,4 +2,4 @@
 <!DOCTYPE html>
 <meta charset="utf-8">
 <title>Redirecting...</title>
-<meta http-equiv="refresh" content="0; URL=./stable/">
+<meta http-equiv="refresh" content="0; URL=./latest/">
diff --git a/latest/.doctrees/commands/cluster.doctree b/latest/.doctrees/commands/cluster.doctree
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
diff --git a/latest/.doctrees/userguides/platform.doctree b/latest/.doctrees/userguides/platform.doctree
diff --git a/latest/_sources/commands/cluster.rst.txt b/latest/_sources/commands/cluster.rst.txt
@@ -15,6 +15,11 @@ Cloud Platform
     :nested: full
     :commands: new, list, info, update, remove
 
+.. click:: silverback._cli:docker_auth
+    :prog: silverback cluster docker auth
+    :nested: full
+    :commands: new, list, info, update, remove
+
 .. click:: silverback._cli:bots
     :prog: silverback cluster bots
     :nested: full

diff --git a/latest/_sources/userguides/platform.md.txt b/latest/_sources/userguides/platform.md.txt
@@ -79,6 +79,13 @@ You can only remove a Variable Group if it is not referenced by any existing Bot
 
 Once you have created all the Variable Group(s) that you need to operate your Bot, you can reference these groups by name when adding your Bot to the cluster.
 
+## 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.
+
+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.
+
 ## Deploying your Bot
 
 You are finally ready to deploy your bot on the Cluster and get it running!
@@ -171,6 +178,7 @@ TODO: Downloading metrics from your Bot
 [silverback-cluster-health]: ../commands/cluster.html#silverback-cluster-health
 [silverback-cluster-info]: ../commands/cluster.html#silverback-cluster-info
 [silverback-cluster-new]: ../commands/cluster.html#silverback-cluster-new
+[silverback-cluster-registry-auth-new]: ../commands/cluster.html#silverback-cluster-registry-auth-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

diff --git a/latest/searchindex.js b/latest/searchindex.js
diff --git a/latest/userguides/platform.html b/latest/userguides/platform.html
@@ -91,6 +91,7 @@
 <li><a class="reference internal" href="#connecting-to-your-cluster">Connecting to your Cluster</a></li>
 <li><a class="reference internal" href="#building-your-bot">Building your Bot</a></li>
 <li><a class="reference internal" href="#adding-environment-variables">Adding Environment Variables</a></li>
+<li><a class="reference internal" href="#private-container-registries">Private Container Registries</a></li>
 <li><a class="reference internal" href="#deploying-your-bot">Deploying your Bot</a></li>
 <li><a class="reference internal" href="#monitoring-your-bot">Monitoring your Bot</a></li>
 <li><a class="reference internal" href="#controlling-your-bot">Controlling your Bot</a></li>
@@ -193,6 +194,12 @@ <h2>Adding Environment Variables<a class="headerlink" href="#adding-environment-
 </div>
 <p>Once you have created all the Variable Group(s) that you need to operate your Bot, you can reference these groups by name when adding your Bot to the cluster.</p>
 </section>
+<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>
+<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">
 <h2>Deploying your Bot<a class="headerlink" href="#deploying-your-bot" title="Link to this heading"></a></h2>
 <p>You are finally ready to deploy your bot on the Cluster and get it running!</p>