WIP

skupperproject · Oct 29, 2024 · 565ef42 · 565ef42
1 parent 87ff5ee
commit 565ef42
Show file tree

Hide file tree

Showing 10 changed files with 238 additions and 20 deletions.
diff --git a/config/commands.yaml b/config/commands.yaml
@@ -386,17 +386,28 @@ commands:
           applied.  Not having the namespace means the resulting
           output can be used in more contexts.
         include_options: [generate/*, site/*, global/*]
-      # site.start
+  - name: system
+    subcommands:
+      # system.setup
+      - name: setup
+        description: |
+          Install and configure the Skupper components for the current
+          namespace.
+      # system.teardown
+      - name: teardown
+        description: |
+          Remove the Skupper components from the current namespace.
+      # system.start
       - name: start
         platforms: [Docker, Podman, Systemd]
         description: |
           Start running the Skupper components for the current site.
-      # site.stop
+      # system.stop
       - name: stop
         platforms: [Docker, Podman, Systemd]
         description: |
           Shut down the Skupper components for the current site.
-      # site.reload
+      # system.reload
       - name: reload
         platforms: [Docker, Podman, Systemd]
         description: |
@@ -771,15 +782,39 @@ commands:
       Display versions of Skupper components.
     examples: |
       $ skupper version
-      COMPONENT    VERSION   IMAGE                                   // ID?
-      cli          2.0.0     -
-      controller   2.0.0     quay.io/skupper/controller:2.0.0
-      router       3.0.0     quay.io/skupper/router:3.0.0            // Was skupper-router
+      COMPONENT          VERSION
+      cli                2.0.0
+      controller         2.0.0
+      router             3.0.0
+      network-observer   1.0.0
+
+      $ skupper version --output yaml
+      components:
+        cli:
+          version: 2.0.0
+        controller:
+          version: 2.0.0
+          images:
+            - name: quay.io/skupper/controller:2.0.0  // Consider fqin
+        router:
+          version: 3.0.0
+          images:
+            - name: quay.io/skupper/router:3.0.0
+            - name: quay.io/skupper/kube-adaptor:2.0.0
+        network-observer:
+          version: 1.0.0
+            - name: quay.io/skupper/network-observer:1.0.0
     include_options: [context/*, global/*]
+    options:
+      - name: verbose
+        type: boolean
 groups:
   - name: Site configuration
     commands:
       - site
+  - name: Site operation
+    commands:
+      - system
   - name: Site linking
     commands:
       - token

diff --git a/input/commands/index.md b/input/commands/index.md
@@ -22,11 +22,22 @@ links:
 </td></tr>
 <tr><th><a href="{{site_prefix}}/commands/site/generate.html">Site generate</a></th><td><p>Generate a Site resource</p>
 </td></tr>
-<tr><th><a href="{{site_prefix}}/commands/site/start.html">Site start</a></th><td><p>Start running the Skupper components for the current site</p>
+</table>
+
+
+#### Site operation
+
+<table class="objects">
+<tr><th><a href="{{site_prefix}}/commands/system/index.html">System commands</a></th><td>Overview of system commands</td></tr>
+<tr><th><a href="{{site_prefix}}/commands/system/setup.html">System setup</a></th><td><p>Install and configure the Skupper components for the current namespace</p>
+</td></tr>
+<tr><th><a href="{{site_prefix}}/commands/system/teardown.html">System teardown</a></th><td><p>Remove the Skupper components from the current namespace</p>
+</td></tr>
+<tr><th><a href="{{site_prefix}}/commands/system/start.html">System start</a></th><td><p>Start running the Skupper components for the current site</p>
 </td></tr>
-<tr><th><a href="{{site_prefix}}/commands/site/stop.html">Site stop</a></th><td><p>Shut down the Skupper components for the current site</p>
+<tr><th><a href="{{site_prefix}}/commands/system/stop.html">System stop</a></th><td><p>Shut down the Skupper components for the current site</p>
 </td></tr>
-<tr><th><a href="{{site_prefix}}/commands/site/reload.html">Site reload</a></th><td><p>Reload the site configuration</p>
+<tr><th><a href="{{site_prefix}}/commands/system/reload.html">System reload</a></th><td><p>Reload the site configuration</p>
 </td></tr>
 </table>
 

diff --git a/input/commands/site/index.md b/input/commands/site/index.md
@@ -40,12 +40,6 @@ skupper site [command] [options]
 </td></tr>
 <tr><th><a href="generate.html">Site generate</a></th><td><p>Generate a Site resource</p>
 </td></tr>
-<tr><th><a href="start.html">Site start</a></th><td><p>Start running the Skupper components for the current site</p>
-</td></tr>
-<tr><th><a href="stop.html">Site stop</a></th><td><p>Shut down the Skupper components for the current site</p>
-</td></tr>
-<tr><th><a href="reload.html">Site reload</a></th><td><p>Reload the site configuration</p>
-</td></tr>
 </table>
 
 </section>
diff --git a/input/commands/system/index.md b/input/commands/system/index.md
@@ -0,0 +1,40 @@
+---
+body_class: object command
+---
+
+# System commands
+
+<section>
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Systemd</td></table>
+
+</section>
+
+<section>
+
+## Usage
+
+~~~ shell
+skupper system [command] [options]
+~~~
+
+</section>
+
+<section>
+
+## Commands
+
+<table class="objects">
+<tr><th><a href="setup.html">System setup</a></th><td><p>Install and configure the Skupper components for the current namespace</p>
+</td></tr>
+<tr><th><a href="teardown.html">System teardown</a></th><td><p>Remove the Skupper components from the current namespace</p>
+</td></tr>
+<tr><th><a href="start.html">System start</a></th><td><p>Start running the Skupper components for the current site</p>
+</td></tr>
+<tr><th><a href="stop.html">System stop</a></th><td><p>Shut down the Skupper components for the current site</p>
+</td></tr>
+<tr><th><a href="reload.html">System reload</a></th><td><p>Reload the site configuration</p>
+</td></tr>
+</table>
+
+</section>
diff --git a/input/commands/system/reload.md b/input/commands/system/reload.md
@@ -0,0 +1,23 @@
+---
+body_class: object command
+---
+
+# System reload command
+
+<section>
+
+Reload the site configuration.
+
+<table class="fields"><tr><th>Platforms</th><td>Docker, Podman, Systemd</td></table>
+
+</section>
+
+<section>
+
+## Usage
+
+~~~ shell
+skupper system reload [options]
+~~~
+
+</section>
diff --git a/input/commands/system/setup.md b/input/commands/system/setup.md
@@ -0,0 +1,24 @@
+---
+body_class: object command
+---
+
+# System setup command
+
+<section>
+
+Install and configure the Skupper components for the current
+namespace.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Systemd</td></table>
+
+</section>
+
+<section>
+
+## Usage
+
+~~~ shell
+skupper system setup [options]
+~~~
+
+</section>
diff --git a/input/commands/system/start.md b/input/commands/system/start.md
@@ -0,0 +1,23 @@
+---
+body_class: object command
+---
+
+# System start command
+
+<section>
+
+Start running the Skupper components for the current site.
+
+<table class="fields"><tr><th>Platforms</th><td>Docker, Podman, Systemd</td></table>
+
+</section>
+
+<section>
+
+## Usage
+
+~~~ shell
+skupper system start [options]
+~~~
+
+</section>
diff --git a/input/commands/system/stop.md b/input/commands/system/stop.md
@@ -0,0 +1,23 @@
+---
+body_class: object command
+---
+
+# System stop command
+
+<section>
+
+Shut down the Skupper components for the current site.
+
+<table class="fields"><tr><th>Platforms</th><td>Docker, Podman, Systemd</td></table>
+
+</section>
+
+<section>
+
+## Usage
+
+~~~ shell
+skupper system stop [options]
+~~~
+
+</section>
diff --git a/input/commands/system/teardown.md b/input/commands/system/teardown.md
@@ -0,0 +1,23 @@
+---
+body_class: object command
+---
+
+# System teardown command
+
+<section>
+
+Remove the Skupper components from the current namespace.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Systemd</td></table>
+
+</section>
+
+<section>
+
+## Usage
+
+~~~ shell
+skupper system teardown [options]
+~~~
+
+</section>
diff --git a/input/commands/version.md b/input/commands/version.md
@@ -28,10 +28,28 @@ skupper version [options]
 
 ~~~ console
 $ skupper version
-COMPONENT    VERSION   IMAGE                                   // ID?
-cli          2.0.0     -
-controller   2.0.0     quay.io/skupper/controller:2.0.0
-router       3.0.0     quay.io/skupper/router:3.0.0            // Was skupper-router
+COMPONENT          VERSION
+cli                2.0.0
+controller         2.0.0
+router             3.0.0
+network-observer   1.0.0
+
+$ skupper version --output yaml
+components:
+  cli:
+    version: 2.0.0
+  controller:
+    version: 2.0.0
+    images:
+      - name: quay.io/skupper/controller:2.0.0  // Consider fqin
+  router:
+    version: 3.0.0
+    images:
+      - name: quay.io/skupper/router:3.0.0
+      - name: quay.io/skupper/kube-adaptor:2.0.0
+  network-observer:
+    version: 1.0.0
+      - name: quay.io/skupper/network-observer:1.0.0
 ~~~
 
 </section>
@@ -40,6 +58,10 @@ router       3.0.0     quay.io/skupper/router:3.0.0            // Was skupper-ro
 
 ## Options
 
+- <div class="attribute"><h3 id="option-verbose">--verbose</h3><div>boolean</div></div>
+
+  <table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Systemd</td></table>
+
 - <div class="attribute"><h3 id="option-namespace">--namespace</h3><div>(-n) &lt;string&gt;</div></div>
 
   Set the namespace.