Update documentation

ApeWorX · Oct 25, 2024 · 4c3fb69 · 4c3fb69
1 parent 22bd5e4
commit 4c3fb69
Show file tree

Hide file tree

Showing 12 changed files with 225 additions and 14 deletions.
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/methoddocs/exceptions.doctree b/latest/.doctrees/methoddocs/exceptions.doctree
diff --git a/latest/.doctrees/methoddocs/main.doctree b/latest/.doctrees/methoddocs/main.doctree
diff --git a/latest/.doctrees/methoddocs/middlewares.doctree b/latest/.doctrees/methoddocs/middlewares.doctree
diff --git a/latest/.doctrees/methoddocs/runner.doctree b/latest/.doctrees/methoddocs/runner.doctree
diff --git a/latest/.doctrees/methoddocs/subscriptions.doctree b/latest/.doctrees/methoddocs/subscriptions.doctree
diff --git a/latest/.doctrees/methoddocs/utils.doctree b/latest/.doctrees/methoddocs/utils.doctree
diff --git a/latest/commands/cluster.html b/latest/commands/cluster.html
@@ -90,7 +90,14 @@
     <div class="sy-scrollbar sy-rside-inner px-6 xl:top-16 xl:sticky xl:pl-0 pt-6 pb-4"><div class="localtoc"><h3>On this page</h3><ul>
 <li><a class="reference internal" href="#silverback-login">silverback login</a></li>
 <li><a class="reference internal" href="#silverback-cluster">silverback cluster</a><ul>
-<li><a class="reference internal" href="#silverback-cluster-workspaces">workspaces</a></li>
+<li><a class="reference internal" href="#silverback-cluster-workspaces">workspaces</a><ul>
+<li><a class="reference internal" href="#silverback-cluster-workspaces-delete">delete</a></li>
+<li><a class="reference internal" href="#silverback-cluster-workspaces-info">info</a></li>
+<li><a class="reference internal" href="#silverback-cluster-workspaces-list">list</a></li>
+<li><a class="reference internal" href="#silverback-cluster-workspaces-new">new</a></li>
+<li><a class="reference internal" href="#silverback-cluster-workspaces-update">update</a></li>
+</ul>
+</li>
 <li><a class="reference internal" href="#silverback-cluster-new">new</a></li>
 <li><a class="reference internal" href="#silverback-cluster-list">list</a></li>
 <li><a class="reference internal" href="#silverback-cluster-info">info</a></li>
@@ -188,17 +195,125 @@ <h2>silverback cluster<a class="headerlink" href="#silverback-cluster" title="Li
 </div>
 <section id="silverback-cluster-workspaces">
 <h3>workspaces<a class="headerlink" href="#silverback-cluster-workspaces" title="Link to this heading"></a></h3>
+<p>View and Manage Workspaces on the Silverback Platform</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">silverback<span class="w"> </span>cluster<span class="w"> </span>workspaces<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
+</span></pre></div>
+</div>
+<section id="silverback-cluster-workspaces-delete">
+<h4>delete<a class="headerlink" href="#silverback-cluster-workspaces-delete" title="Link to this heading"></a></h4>
+<p>Delete an empty Workspace on the Silverback Platform</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">silverback<span class="w"> </span>cluster<span class="w"> </span>workspaces<span class="w"> </span>delete<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>WORKSPACE
+</span></pre></div>
+</div>
+<p class="rubric">Options</p>
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-delete-p">
+<span id="cmdoption-silverback-cluster-workspaces-delete-profile"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--profile</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PROFILE&gt;</span></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-delete-p" title="Link to this definition"></a></dt>
+<dd><p>The authentication profile to use (Advanced)</p>
+</dd></dl>
+
+<p class="rubric">Arguments</p>
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-delete-arg-WORKSPACE">
+<span class="sig-name descname"><span class="pre">WORKSPACE</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-delete-arg-WORKSPACE" title="Link to this definition"></a></dt>
+<dd><p>Required argument</p>
+</dd></dl>
+
+</section>
+<section id="silverback-cluster-workspaces-info">
+<h4>info<a class="headerlink" href="#silverback-cluster-workspaces-info" title="Link to this heading"></a></h4>
+<p>Get Configuration information about a WORKSPACE</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">silverback<span class="w"> </span>cluster<span class="w"> </span>workspaces<span class="w"> </span>info<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>WORKSPACE
+</span></pre></div>
+</div>
+<p class="rubric">Options</p>
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-info-p">
+<span id="cmdoption-silverback-cluster-workspaces-info-profile"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--profile</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PROFILE&gt;</span></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-info-p" title="Link to this definition"></a></dt>
+<dd><p>The authentication profile to use (Advanced)</p>
+</dd></dl>
+
+<p class="rubric">Arguments</p>
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-info-arg-WORKSPACE">
+<span class="sig-name descname"><span class="pre">WORKSPACE</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-info-arg-WORKSPACE" title="Link to this definition"></a></dt>
+<dd><p>Required argument</p>
+</dd></dl>
+
+</section>
+<section id="silverback-cluster-workspaces-list">
+<h4>list<a class="headerlink" href="#silverback-cluster-workspaces-list" title="Link to this heading"></a></h4>
 <p>List available workspaces for your account</p>
-<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">silverback<span class="w"> </span>cluster<span class="w"> </span>workspaces<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">silverback<span class="w"> </span>cluster<span class="w"> </span>workspaces<span class="w"> </span>list<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
+</span></pre></div>
+</div>
+<p class="rubric">Options</p>
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-list-p">
+<span id="cmdoption-silverback-cluster-workspaces-list-profile"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--profile</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PROFILE&gt;</span></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-list-p" title="Link to this definition"></a></dt>
+<dd><p>The authentication profile to use (Advanced)</p>
+</dd></dl>
+
+</section>
+<section id="silverback-cluster-workspaces-new">
+<h4>new<a class="headerlink" href="#silverback-cluster-workspaces-new" title="Link to this heading"></a></h4>
+<p>Create a new workspace</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">silverback<span class="w"> </span>cluster<span class="w"> </span>workspaces<span class="w"> </span>new<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
+</span></pre></div>
+</div>
+<p class="rubric">Options</p>
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-new-n">
+<span id="cmdoption-silverback-cluster-workspaces-new-name"></span><span class="sig-name descname"><span class="pre">-n</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;workspace_name&gt;</span></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-new-n" title="Link to this definition"></a></dt>
+<dd><p><strong>Required</strong> Name for new workspace</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-new-s">
+<span id="cmdoption-silverback-cluster-workspaces-new-slug"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--slug</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;workspace_slug&gt;</span></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-new-s" title="Link to this definition"></a></dt>
+<dd><p><strong>Required</strong> Slug for new workspace</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-new-p">
+<span id="cmdoption-silverback-cluster-workspaces-new-profile"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--profile</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PROFILE&gt;</span></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-new-p" title="Link to this definition"></a></dt>
+<dd><p>The authentication profile to use (Advanced)</p>
+</dd></dl>
+
+</section>
+<section id="silverback-cluster-workspaces-update">
+<h4>update<a class="headerlink" href="#silverback-cluster-workspaces-update" title="Link to this heading"></a></h4>
+<p>Update name and slug for a workspace</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">silverback<span class="w"> </span>cluster<span class="w"> </span>workspaces<span class="w"> </span>update<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>WORKSPACE
 </span></pre></div>
 </div>
 <p class="rubric">Options</p>
 <dl class="std option">
-<dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-p">
-<span id="cmdoption-silverback-cluster-workspaces-profile"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--profile</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PROFILE&gt;</span></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-p" title="Link to this definition"></a></dt>
+<dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-update-n">
+<span id="cmdoption-silverback-cluster-workspaces-update-name"></span><span class="sig-name descname"><span class="pre">-n</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;update_name&gt;</span></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-update-n" title="Link to this definition"></a></dt>
+<dd><p>Update name for workspace</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-update-s">
+<span id="cmdoption-silverback-cluster-workspaces-update-slug"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--slug</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;update_slug&gt;</span></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-update-s" title="Link to this definition"></a></dt>
+<dd><p>Update slug for workspace</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-update-p">
+<span id="cmdoption-silverback-cluster-workspaces-update-profile"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--profile</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PROFILE&gt;</span></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-update-p" title="Link to this definition"></a></dt>
 <dd><p>The authentication profile to use (Advanced)</p>
 </dd></dl>
 
+<p class="rubric">Arguments</p>
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-update-arg-WORKSPACE">
+<span class="sig-name descname"><span class="pre">WORKSPACE</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-update-arg-WORKSPACE" title="Link to this definition"></a></dt>
+<dd><p>Required argument</p>
+</dd></dl>
+
+</section>
 </section>
 <section id="silverback-cluster-new">
 <h3>new<a class="headerlink" href="#silverback-cluster-new" title="Link to this heading"></a></h3>