WIP

skupperproject · May 14, 2024 · cf3b95f · cf3b95f
1 parent ed2b71c
commit cf3b95f
Show file tree

Hide file tree

Showing 8 changed files with 316 additions and 321 deletions.
diff --git a/config/commands.yaml b/config/commands.yaml
@@ -38,8 +38,10 @@ groups:
           Site "<name>" is ready
         arguments:
           - name: name
+            variable: string
             description: |
-              The name of the site resource.
+              A name of your choice for the Skupper site.  This name is
+              displayed in the console and CLI output.
           - property: enableLinkAccess
           - property: linkAccessType
           - property: linkAccessHost
@@ -64,6 +66,7 @@ groups:
           Site "<name>" is updated
         arguments:
           - name: name
+            variable: string
             description: |
               The name of the site resource.
           - property: enableLinkAccess
@@ -83,6 +86,7 @@ groups:
           Site "<name>" is deleted
         arguments:
           - name: name
+            variable: string
             description: |
               The name of the site resource.
         errors:
@@ -117,6 +121,7 @@ groups:
           The token expires after 1 use or after 15 minutes
         arguments:
           - name: file
+            variable: string
             description: |
               The name of the token file.
           - property: validFor
@@ -133,6 +138,8 @@ groups:
         title: skupper link create
         description: |
           Create a link.
+
+          @resource_description@
         usage: skupper link create <file> [options]
         output: |
           Waiting for status...
@@ -163,6 +170,8 @@ groups:
         title: skupper connector create
         description: |
           Create a connector.
+
+          @resource_description@
         usage: skupper connector create <name> [options]
         examples: |
           # Create a connector for a database
@@ -172,10 +181,11 @@ groups:
           Connector "<name>" is ready
         arguments:
           - name: name
+            variable: string
             description: |
               The name of the connector resource.
           - property: routingKey
-            default: _value of name_
+            default: _Value of name_
           - name: --workload
             variable: string
           - property: port
@@ -193,6 +203,7 @@ groups:
           Connector "<name>" is deleted
         arguments:
           - name: name
+            variable: string
             description: |
               The name of the connector resource.
       - title: skupper connector status
@@ -221,10 +232,11 @@ groups:
           Listener "<name>" is ready
         arguments:
           - name: name
+            variable: string
             description: |
               The name of the listener resource.
           - property: routingKey
-            default: _value of name_
+            default: _Value of name_
           - property: host
           - property: port
           - property: tlsCredentials
@@ -238,6 +250,7 @@ groups:
           Listener "<name>" is deleted
         arguments:
           - name: name
+            variable: string
             description: |
               The name of the listener resource.
       - title: skupper listener status
@@ -264,7 +277,7 @@ groups:
       - title: skupper debug dump
         description: |
           Generate a debug dump file.
-        usage: skupper debug dump [FILE]
+        usage: skupper debug dump [file]
         output: |
           Debug dump file generated at <file>
   - title: Other operations

diff --git a/config/resources.yaml b/config/resources.yaml
@@ -37,8 +37,8 @@ resources:
 
       There can be only one site definition per namespace.
 
-      [site]: concepts.md#site
-      [network]: concepts.md#network
+      [site]: concepts.html#site
+      [network]: concepts.html#network
     examples:
       - description: A minimal site definition
         yaml: |
@@ -48,10 +48,6 @@ resources:
             name: east
             namespace: hello-world-east
     properties:
-      name:
-        description: |
-          A name of your choice for the Skupper site.  This name is
-          displayed in the console and CLI output.
       enableLinkAccess:
         type: boolean
         description: |
@@ -60,28 +56,21 @@ resources:
         type: string
         description: |
           Select the means of opening external access.
-
-          The default is `route` on OpenShift and `loadbalancer`
-          otherwise.
         default: |
           `route` if the environment is OpenShift, otherwise
           `loadbalancer`
         choices: [route, loadbalancer, nodeport, ingress]
       linkAccessHost:
         type: string
         description: |
-          The host or IP used to expose link access.
+          The host or IP address at which to expose link access.
   Link:
     group: site-linking
     description: |
       A [link][link] is a site-to-site communication channel. Links
       serve as a transport for application connections and requests.
 
-      XXX
-
-      The Link would has the details from its associated LinkAccess.
-
-      [link]: concepts.md#link
+      [link]: concepts.html#link
     examples:
       - description: A typical link definition
         yaml: |
@@ -204,7 +193,7 @@ resources:
 
       Each namespace can contain multiple connector definitions.
 
-      [connector]: concepts.md#connector
+      [connector]: concepts.html#connector
     examples:
       - description: |
           A connector in site East for the Hello World backend service
@@ -255,7 +244,7 @@ resources:
 
       Each namespace can contain multiple listener definitions.
 
-      [listener]: concepts.md#listener
+      [listener]: concepts.html#listener
     examples:
       - description: |
           A listener in site West for the Hello World backend service

diff --git a/input/commands.md b/input/commands.md
@@ -70,8 +70,8 @@ running.  Sites are linked to form application
 
 There can be only one site definition per namespace.
 
-[site]: concepts.md#site
-[network]: concepts.md#network
+[site]: concepts.html#site
+[network]: concepts.html#network
 
 
 
@@ -95,13 +95,16 @@ skupper site create west --enable-link-access
 
 #### Arguments
 
-- **name**
+- **name** _string_
 
-  The name of the site resource.
+  A name of your choice for the Skupper site.  This name is
+  displayed in the console and CLI output.
 
 
 - **--enable-link-access** _boolean_
 
+  _Default:_ false
+
   Enable external access for links from remote sites.
 
 
@@ -113,13 +116,10 @@ skupper site create west --enable-link-access
 
   Select the means of opening external access.
 
-  The default is `route` on OpenShift and `loadbalancer`
-  otherwise.
-
 
 - **--link-access-host** _string_
 
-  The host or IP used to expose link access.
+  The host or IP address at which to expose link access.
 
 
 - **--service-account** _string_
@@ -156,13 +156,15 @@ skupper site update west --enable-link-access --link-access-type loadbalancer
 
 #### Arguments
 
-- **name**
+- **name** _string_
 
   The name of the site resource.
 
 
 - **--enable-link-access** _boolean_
 
+  _Default:_ false
+
   Enable external access for links from remote sites.
 
 
@@ -174,13 +176,10 @@ skupper site update west --enable-link-access --link-access-type loadbalancer
 
   Select the means of opening external access.
 
-  The default is `route` on OpenShift and `loadbalancer`
-  otherwise.
-
 
 - **--link-access-host** _string_
 
-  The host or IP used to expose link access.
+  The host or IP address at which to expose link access.
 
 
 - **--service-account** _string_
@@ -207,7 +206,7 @@ Site "<name>" is deleted
 
 #### Arguments
 
-- **name**
+- **name** _string_
 
   The name of the site resource.
 
@@ -262,7 +261,7 @@ The token expires after 1 use or after 15 minutes
 
 #### Arguments
 
-- **file**
+- **file** _string_
 
   The name of the token file.
 
@@ -284,6 +283,12 @@ Display help for link commands and exit.
 
 Create a link.
 
+A [link][link] is a site-to-site communication channel. Links
+serve as a transport for application connections and requests.
+
+[link]: concepts.html#link
+
+
 
 #### Usage
 
@@ -326,6 +331,14 @@ Display help for connector commands and exit.
 
 Create a connector.
 
+A [connector][connector] binds local servers to listeners in
+remote sites.
+
+Each namespace can contain multiple connector definitions.
+
+[connector]: concepts.html#connector
+
+
 
 #### Usage
 
@@ -344,14 +357,14 @@ skupper connector create database --workload deployment/postgresql --port 5432
 
 #### Arguments
 
-- **name**
+- **name** _string_
 
   The name of the connector resource.
 
 
 - **--routing-key** _string_
 
-  _Default:_ _value of name_
+  _Default:_ _Value of name_
 
   The identifier used to route traffic from listeners to
   connectors.  To connect to a service at a remote site, the
@@ -396,6 +409,8 @@ skupper connector create database --workload deployment/postgresql --port 5432
 
 - **--include-not-ready** _boolean_
 
+  _Default:_ false
+
 ### skupper connector delete
 
 Delete a connector.
@@ -411,7 +426,7 @@ Connector "<name>" is deleted
 
 #### Arguments
 
-- **name**
+- **name** _string_
 
   The name of the connector resource.
 
@@ -444,7 +459,7 @@ servers in remote sites.
 
 Each namespace can contain multiple listener definitions.
 
-[listener]: concepts.md#listener
+[listener]: concepts.html#listener
 
 
 
@@ -465,14 +480,14 @@ skupper listener create database --host database --port 5432
 
 #### Arguments
 
-- **name**
+- **name** _string_
 
   The name of the listener resource.
 
 
 - **--routing-key** _string_
 
-  _Default:_ _value of name_
+  _Default:_ _Value of name_
 
   The identifier used to route traffic from listeners to
   connectors.  To connect to a service at a remote site, the
@@ -522,7 +537,7 @@ Listener "<name>" is deleted
 
 #### Arguments
 
-- **name**
+- **name** _string_
 
   The name of the listener resource.
 
@@ -556,7 +571,7 @@ Generate a debug dump file.
 #### Usage
 
 ~~~ shell
-$ skupper debug dump [FILE]
+$ skupper debug dump [file]
 Debug dump file generated at <file>
 ~~~