WIP

skupperproject · Jun 8, 2024 · b97e03c · b97e03c
1 parent 1d4e3f9
commit b97e03c
Show file tree

Hide file tree

Showing 34 changed files with 532 additions and 226 deletions.
diff --git a/config/commands.yaml b/config/commands.yaml
@@ -159,12 +159,14 @@ groups:
           Display help for link commands and exit.
 
           @resource_description@
+        inherit_standard_arguments: [global]
       - name: link delete
         concept: link
         resource: Link
         description: |
           Delete a link.
         usage: skupper link delete <name>
+        inherit_standard_arguments: [context, global]
       - name: link status
         description: |
           Show the current status of links for the site.
@@ -176,20 +178,25 @@ groups:
           Links from remote sites:
 
           None
+        inherit_standard_arguments: [output, context, global]
       - name: grant
         concept: grant
         resource: Grant
+        inherit_standard_arguments: [global]
       - name: grant delete
         concept: grant
         resource: Grant
+        inherit_standard_arguments: [context, global]
       - name: grant status
         concept: grant
         resource: Grant
+        inherit_standard_arguments: [output, context, global]
       - name: token
         concept: claim
         resource: Claim
         description: |
           Display help for token commands and exit.
+        inherit_standard_arguments: [global]
       - name: token issue
         concept: grant
         resource: Grant
@@ -216,6 +223,7 @@ groups:
 
           # Issue a token with non-default limits
           skupper token issue ~/token.yaml --expiration-period 24h --redemptions-allowed 3
+        inherit_standard_arguments: [context, global]
         arguments:
           - name: file
             type: string
@@ -243,6 +251,7 @@ groups:
           Waiting for status...
           Link "<name>" is active.
           You can now safely delete <file>.
+        inherit_standard_arguments: [context, global]
         arguments:
           - name: file
             type: string
@@ -254,6 +263,7 @@ groups:
       - name: connector
         description: |
           Display help for connector commands and exit.
+        inherit_standard_arguments: [global]
       - name: connector create
         concept: connector
         resource: Connector
@@ -273,6 +283,7 @@ groups:
         output: |
           Waiting for status...
           Connector "<name>" is ready.
+        inherit_standard_arguments: [output, context, global]
         arguments:
           - name: name
             type: string
@@ -313,16 +324,6 @@ groups:
             property: type
           - name: include-not-ready
             property: includeNotReady
-          - name: output
-            type: string
-            description: |
-              Print resources to the console instead of submitting
-              them to the Skupper controller.
-            choices:
-              - name: json
-                description: Produce JSON output
-              - name: yaml
-                description: Produce YAML output
       - name: connector update
         concept: connector
         resource: Connector
@@ -343,6 +344,7 @@ groups:
           Waiting for update to complete...
           Connector "<name>" is updated.
         inherit_command_arguments: connector create
+        inherit_standard_arguments: [output, context, global]
         arguments:
           - name: port
             property: port
@@ -357,6 +359,7 @@ groups:
         output: |
           Waiting for deletion to complete...
           Connector "<name>" is deleted.
+        inherit_standard_arguments: [context, global]
         arguments:
           - name: name
             type: string
@@ -393,6 +396,7 @@ groups:
         output: |
           Waiting for status...
           Listener "<name>" is ready.
+        inherit_standard_arguments: [output, context, global]
         arguments:
           - name: name
             type: string
@@ -432,6 +436,7 @@ groups:
           Waiting for update to complete...
           Listener "<name>" is updated.
         inherit_command_arguments: listener create
+        inherit_standard_arguments: [output, context, global]
         arguments:
           - name: port
             property: port
@@ -446,6 +451,7 @@ groups:
         output: |
           Waiting for deletion to complete...
           Listener "<name>" is deleted.
+        inherit_standard_arguments: [context, global]
         arguments:
           - name: name
             type: string
@@ -460,14 +466,7 @@ groups:
           NAME       ROUTING-KEY   HOST       PORT   MATCHING-CONNECTORS
           backend    backend       backend    8080   1
           database   database      database   5432   1
-  # - name: Platform operations
-  #   commands:
-  #     - name: platform
-  #       description: |
-  #         Display help for platform commands and exit.
-  #     - name: platform install
-  #     - name: platform uninstall
-  #     - name: platform switch
+        inherit_standard_arguments: [output, context, global]
   - name: Debug operations
     commands:
       - name: debug

diff --git a/input/commands/connector-create.md b/input/commands/connector-create.md
@@ -50,15 +50,15 @@ skupper connector create backend 8080 --output yaml
 
 ## Options
 
-- <h3 id="name">name <span class="argument-info">string, required</span></h3>
+- <h4 id="name">name <span class="argument-info">string, required</span></h3>
 
   The name of the connector resource.
 
-- <h3 id="port">port <span class="argument-info">integer, required</span></h3>
+- <h4 id="port">port <span class="argument-info">integer, required</span></h3>
 
   The port on the target workload to forward traffic to.
 
-- <h3 id="routing-key">--routing-key <span class="argument-info">string</span></h3>
+- <h4 id="routing-key">--routing-key <span class="argument-info">string</span></h3>
 
   The identifier used to route traffic from listeners to
   connectors.  To expose a local workload to a remote
@@ -69,15 +69,15 @@ skupper connector create backend 8080 --output yaml
 
   _See also:_ [Routing key concept]({{site_prefix}}/concepts/routing-key.html)
 
-- <h3 id="selector">--selector <span class="argument-info">string</span></h3>
+- <h4 id="selector">--selector <span class="argument-info">string</span></h3>
 
   A Kubernetes label selector for specifying target pods.
 
   _Default:_ `app=<value-of-name>`
 
   _See also:_ [Kubernetes label selectors]({{site_prefix}}https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors), [Kubernetes pods]({{site_prefix}}https://kubernetes.io/docs/concepts/workloads/pods/)
 
-- <h3 id="workload">--workload <span class="argument-info">string (resource name)</span></h3>
+- <h4 id="workload">--workload <span class="argument-info">string (resource name)</span></h3>
 
   A Kubernetes resource name that identifies a workload.
   It resolves to an equivalent pod selector.
@@ -87,14 +87,14 @@ skupper connector create backend 8080 --output yaml
 
   _See also:_ [Kubernetes workloads]({{site_prefix}}https://kubernetes.io/docs/concepts/workloads/)
 
-- <h3 id="host">--host <span class="argument-info">string</span></h3>
+- <h4 id="host">--host <span class="argument-info">string</span></h3>
 
   The hostname or IP address of the server.
 
   This is an alternative to setting the `--selector` or
   `--workload` options.
 
-- <h3 id="tls-secret">--tls-secret <span class="argument-info">string</span></h3>
+- <h4 id="tls-secret">--tls-secret <span class="argument-info">string</span></h3>
 
   The name of a Kubernetes secret containing the trusted
   server certificate (typically a CA).
@@ -107,18 +107,20 @@ skupper connector create backend 8080 --output yaml
 
   _See also:_ [TLS re-encrypt]({{site_prefix}})
 
-- <h3 id="type">--type <span class="argument-info">string</span></h3>
+- <h4 id="type">--type <span class="argument-info">string</span></h3>
 
   The connector type.
 
   _Default:_ `tcp`
 
-- <h3 id="include-not-ready">--include-not-ready <span class="argument-info">boolean</span></h3>
+- <h4 id="include-not-ready">--include-not-ready <span class="argument-info">boolean</span></h3>
 
   If set, include server pods that are not in the ready
   state.
 
-- <h3 id="output">--output <span class="argument-info">string</span></h3>
+### Output options
+
+- <h4 id="output">--output <span class="argument-info">string</span></h3>
 
   Print resources to the console instead of submitting
   them to the Skupper controller.
@@ -128,6 +130,26 @@ skupper connector create backend 8080 --output yaml
    - `json` - Produce JSON output
    - `yaml` - Produce YAML output
 
+### Context options
+
+- <h4 id="namespace">--namespace <span class="argument-info">string</span></h3>
+
+  Select the current namespace.
+
+- <h4 id="context">--context <span class="argument-info">string</span></h3>
+
+  Select the current kubeconfig context.
+
+- <h4 id="platform">--platform <span class="argument-info">string</span></h3>
+
+  Select the current Skupper platform.
+
+### Global options
+
+- <h4 id="help">--help <span class="argument-info">None</span></h3>
+
+  Display help and exit.
+
 </section>
 
 <section>

diff --git a/input/commands/connector-delete.md b/input/commands/connector-delete.md
@@ -33,10 +33,30 @@ Connector "<name>" is deleted.
 
 ## Options
 
-- <h3 id="name">name <span class="argument-info">string, required</span></h3>
+- <h4 id="name">name <span class="argument-info">string, required</span></h3>
 
   The name of the connector resource.
 
+### Context options
+
+- <h4 id="namespace">--namespace <span class="argument-info">string</span></h3>
+
+  Select the current namespace.
+
+- <h4 id="context">--context <span class="argument-info">string</span></h3>
+
+  Select the current kubeconfig context.
+
+- <h4 id="platform">--platform <span class="argument-info">string</span></h3>
+
+  Select the current Skupper platform.
+
+### Global options
+
+- <h4 id="help">--help <span class="argument-info">None</span></h3>
+
+  Display help and exit.
+
 </section>
 
 <section>

diff --git a/input/commands/connector-update.md b/input/commands/connector-update.md
@@ -50,15 +50,15 @@ skupper connector update frontend --port 9090 --output yaml
 
 ## Options
 
-- <h3 id="name">name <span class="argument-info">string, required</span></h3>
+- <h4 id="name">name <span class="argument-info">string, required</span></h3>
 
   The name of the connector resource.
 
-- <h3 id="port">--port <span class="argument-info">integer</span></h3>
+- <h4 id="port">--port <span class="argument-info">integer</span></h3>
 
   The port on the target workload to forward traffic to.
 
-- <h3 id="routing-key">--routing-key <span class="argument-info">string</span></h3>
+- <h4 id="routing-key">--routing-key <span class="argument-info">string</span></h3>
 
   The identifier used to route traffic from listeners to
   connectors.  To expose a local workload to a remote
@@ -69,15 +69,15 @@ skupper connector update frontend --port 9090 --output yaml
 
   _See also:_ [Routing key concept]({{site_prefix}}/concepts/routing-key.html)
 
-- <h3 id="selector">--selector <span class="argument-info">string</span></h3>
+- <h4 id="selector">--selector <span class="argument-info">string</span></h3>
 
   A Kubernetes label selector for specifying target pods.
 
   _Default:_ `app=<value-of-name>`
 
   _See also:_ [Kubernetes label selectors]({{site_prefix}}https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors), [Kubernetes pods]({{site_prefix}}https://kubernetes.io/docs/concepts/workloads/pods/)
 
-- <h3 id="workload">--workload <span class="argument-info">string (resource name)</span></h3>
+- <h4 id="workload">--workload <span class="argument-info">string (resource name)</span></h3>
 
   A Kubernetes resource name that identifies a workload.
   It resolves to an equivalent pod selector.
@@ -87,14 +87,14 @@ skupper connector update frontend --port 9090 --output yaml
 
   _See also:_ [Kubernetes workloads]({{site_prefix}}https://kubernetes.io/docs/concepts/workloads/)
 
-- <h3 id="host">--host <span class="argument-info">string</span></h3>
+- <h4 id="host">--host <span class="argument-info">string</span></h3>
 
   The hostname or IP address of the server.
 
   This is an alternative to setting the `--selector` or
   `--workload` options.
 
-- <h3 id="tls-secret">--tls-secret <span class="argument-info">string</span></h3>
+- <h4 id="tls-secret">--tls-secret <span class="argument-info">string</span></h3>
 
   The name of a Kubernetes secret containing the trusted
   server certificate (typically a CA).
@@ -107,18 +107,20 @@ skupper connector update frontend --port 9090 --output yaml
 
   _See also:_ [TLS re-encrypt]({{site_prefix}})
 
-- <h3 id="type">--type <span class="argument-info">string</span></h3>
+- <h4 id="type">--type <span class="argument-info">string</span></h3>
 
   The connector type.
 
   _Default:_ `tcp`
 
-- <h3 id="include-not-ready">--include-not-ready <span class="argument-info">boolean</span></h3>
+- <h4 id="include-not-ready">--include-not-ready <span class="argument-info">boolean</span></h3>
 
   If set, include server pods that are not in the ready
   state.
 
-- <h3 id="output">--output <span class="argument-info">string</span></h3>
+### Output options
+
+- <h4 id="output">--output <span class="argument-info">string</span></h3>
 
   Print resources to the console instead of submitting
   them to the Skupper controller.
@@ -128,6 +130,26 @@ skupper connector update frontend --port 9090 --output yaml
    - `json` - Produce JSON output
    - `yaml` - Produce YAML output
 
+### Context options
+
+- <h4 id="namespace">--namespace <span class="argument-info">string</span></h3>
+
+  Select the current namespace.
+
+- <h4 id="context">--context <span class="argument-info">string</span></h3>
+
+  Select the current kubeconfig context.
+
+- <h4 id="platform">--platform <span class="argument-info">string</span></h3>
+
+  Select the current Skupper platform.
+
+### Global options
+
+- <h4 id="help">--help <span class="argument-info">None</span></h3>
+
+  Display help and exit.
+
 </section>
 
 <section>