From b97e03c23392c1fbd0151887cdbf93024f7d9ebc Mon Sep 17 00:00:00 2001 From: Justin Ross Date: Sat, 8 Jun 2024 10:25:58 -0400 Subject: [PATCH] WIP --- config/commands.yaml | 35 ++++++++++++------------ input/commands/connector-create.md | 42 +++++++++++++++++++++------- input/commands/connector-delete.md | 22 ++++++++++++++- input/commands/connector-update.md | 42 +++++++++++++++++++++------- input/commands/connector.md | 6 ++++ input/commands/grant-delete.md | 20 ++++++++++++++ input/commands/grant-status.md | 32 ++++++++++++++++++++++ input/commands/grant.md | 6 ++++ input/commands/link-delete.md | 20 ++++++++++++++ input/commands/link-status.md | 32 ++++++++++++++++++++++ input/commands/link.md | 6 ++++ input/commands/listener-create.md | 44 ++++++++++++++++++++++++++---- input/commands/listener-delete.md | 22 ++++++++++++++- input/commands/listener-status.md | 32 ++++++++++++++++++++++ input/commands/listener-update.md | 44 ++++++++++++++++++++++++++---- input/commands/site-create.md | 36 ++++++++---------------- input/commands/site-delete.md | 22 +++++---------- input/commands/site-status.md | 20 ++++---------- input/commands/site-update.md | 36 ++++++++---------------- input/commands/token-issue.md | 26 ++++++++++++++++-- input/commands/token-redeem.md | 22 ++++++++++++++- input/commands/token.md | 6 ++++ input/main.css | 6 +++- input/resources/certificate.md | 16 +++++------ input/resources/claim.md | 10 +++---- input/resources/connector.md | 18 ++++++------ input/resources/grant.md | 18 ++++++------ input/resources/link.md | 20 +++++++------- input/resources/linkaccess.md | 20 +++++++------- input/resources/listener.md | 14 +++++----- input/resources/securedaccess.md | 20 +++++++------- input/resources/site.md | 18 ++++++------ python/commands.py | 23 ++++++---------- python/resources.py | 2 +- 34 files changed, 532 insertions(+), 226 deletions(-) diff --git a/config/commands.yaml b/config/commands.yaml index d479b09..7ea0751 100644 --- 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 + 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 "" is active. You can now safely delete . + 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 "" 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 "" 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 "" is deleted. + inherit_standard_arguments: [context, global] arguments: - name: name type: string @@ -393,6 +396,7 @@ groups: output: | Waiting for status... Listener "" is ready. + inherit_standard_arguments: [output, context, global] arguments: - name: name type: string @@ -432,6 +436,7 @@ groups: Waiting for update to complete... Listener "" 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 "" 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 index db58000..c91f8d1 100644 --- a/input/commands/connector-create.md +++ b/input/commands/connector-create.md @@ -50,15 +50,15 @@ skupper connector create backend 8080 --output yaml ## Options --

name string, required

+-

name string, required

The name of the connector resource. --

port integer, required

+-

port integer, required

The port on the target workload to forward traffic to. --

--routing-key string

+-

--routing-key string

The identifier used to route traffic from listeners to connectors. To expose a local workload to a remote @@ -69,7 +69,7 @@ skupper connector create backend 8080 --output yaml _See also:_ [Routing key concept]({{site_prefix}}/concepts/routing-key.html) --

--selector string

+-

--selector string

A Kubernetes label selector for specifying target pods. @@ -77,7 +77,7 @@ skupper connector create backend 8080 --output yaml _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/) --

--workload string (resource name)

+-

--workload string (resource name)

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/) --

--host string

+-

--host string

The hostname or IP address of the server. This is an alternative to setting the `--selector` or `--workload` options. --

--tls-secret string

+-

--tls-secret string

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}}) --

--type string

+-

--type string

The connector type. _Default:_ `tcp` --

--include-not-ready boolean

+-

--include-not-ready boolean

If set, include server pods that are not in the ready state. --

--output string

+### Output options + +-

--output string

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 + +-

--namespace string

+ + Select the current namespace. + +-

--context string

+ + Select the current kubeconfig context. + +-

--platform string

+ + Select the current Skupper platform. + +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/connector-delete.md b/input/commands/connector-delete.md index 120e99d..897fdbe 100644 --- a/input/commands/connector-delete.md +++ b/input/commands/connector-delete.md @@ -33,10 +33,30 @@ Connector "" is deleted. ## Options --

name string, required

+-

name string, required

The name of the connector resource. +### Context options + +-

--namespace string

+ + Select the current namespace. + +-

--context string

+ + Select the current kubeconfig context. + +-

--platform string

+ + Select the current Skupper platform. + +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/connector-update.md b/input/commands/connector-update.md index a569119..ecba02c 100644 --- 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 --

name string, required

+-

name string, required

The name of the connector resource. --

--port integer

+-

--port integer

The port on the target workload to forward traffic to. --

--routing-key string

+-

--routing-key string

The identifier used to route traffic from listeners to connectors. To expose a local workload to a remote @@ -69,7 +69,7 @@ skupper connector update frontend --port 9090 --output yaml _See also:_ [Routing key concept]({{site_prefix}}/concepts/routing-key.html) --

--selector string

+-

--selector string

A Kubernetes label selector for specifying target pods. @@ -77,7 +77,7 @@ skupper connector update frontend --port 9090 --output yaml _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/) --

--workload string (resource name)

+-

--workload string (resource name)

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/) --

--host string

+-

--host string

The hostname or IP address of the server. This is an alternative to setting the `--selector` or `--workload` options. --

--tls-secret string

+-

--tls-secret string

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}}) --

--type string

+-

--type string

The connector type. _Default:_ `tcp` --

--include-not-ready boolean

+-

--include-not-ready boolean

If set, include server pods that are not in the ready state. --

--output string

+### Output options + +-

--output string

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 + +-

--namespace string

+ + Select the current namespace. + +-

--context string

+ + Select the current kubeconfig context. + +-

--platform string

+ + Select the current Skupper platform. + +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/connector.md b/input/commands/connector.md index 186568f..6002268 100644 --- a/input/commands/connector.md +++ b/input/commands/connector.md @@ -14,6 +14,12 @@ Display help for connector commands and exit. ## Options +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/grant-delete.md b/input/commands/grant-delete.md index fb163b6..8a3b023 100644 --- a/input/commands/grant-delete.md +++ b/input/commands/grant-delete.md @@ -17,6 +17,26 @@ links: ## Options +### Context options + +-

--namespace string

+ + Select the current namespace. + +-

--context string

+ + Select the current kubeconfig context. + +-

--platform string

+ + Select the current Skupper platform. + +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/grant-status.md b/input/commands/grant-status.md index 714b48e..37d8c94 100644 --- a/input/commands/grant-status.md +++ b/input/commands/grant-status.md @@ -17,6 +17,38 @@ links: ## Options +### Output options + +-

--output string

+ + Print resources to the console instead of submitting + them to the Skupper controller. + + _Choices:_ + + - `json` - Produce JSON output + - `yaml` - Produce YAML output + +### Context options + +-

--namespace string

+ + Select the current namespace. + +-

--context string

+ + Select the current kubeconfig context. + +-

--platform string

+ + Select the current Skupper platform. + +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/grant.md b/input/commands/grant.md index 67229d9..4d91809 100644 --- a/input/commands/grant.md +++ b/input/commands/grant.md @@ -17,6 +17,12 @@ links: ## Options +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/link-delete.md b/input/commands/link-delete.md index 795d746..b5222aa 100644 --- a/input/commands/link-delete.md +++ b/input/commands/link-delete.md @@ -29,6 +29,26 @@ $ skupper link delete ## Options +### Context options + +-

--namespace string

+ + Select the current namespace. + +-

--context string

+ + Select the current kubeconfig context. + +-

--platform string

+ + Select the current Skupper platform. + +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/link-status.md b/input/commands/link-status.md index 463a5cc..17089fb 100644 --- a/input/commands/link-status.md +++ b/input/commands/link-status.md @@ -14,6 +14,38 @@ Show the current status of links for the site. ## Options +### Output options + +-

--output string

+ + Print resources to the console instead of submitting + them to the Skupper controller. + + _Choices:_ + + - `json` - Produce JSON output + - `yaml` - Produce YAML output + +### Context options + +-

--namespace string

+ + Select the current namespace. + +-

--context string

+ + Select the current kubeconfig context. + +-

--platform string

+ + Select the current Skupper platform. + +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/link.md b/input/commands/link.md index 340aad4..eb284b3 100644 --- a/input/commands/link.md +++ b/input/commands/link.md @@ -26,6 +26,12 @@ grant and token to obtain a link. ## Options +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/listener-create.md b/input/commands/listener-create.md index b579f3f..5947dc9 100644 --- a/input/commands/listener-create.md +++ b/input/commands/listener-create.md @@ -50,17 +50,17 @@ skupper listener create frontend 8080 --output yaml ## Options --

name string, required

+-

name string, required

The name of the listener resource. --

port integer, required

+-

port integer, required

The port of the local listener. Clients at this site use the listener host and port to establish connections to the remote service. --

--routing-key string

+-

--routing-key string

The identifier used to route traffic from listeners to connectors. To enable connecting to a service at a @@ -71,7 +71,7 @@ skupper listener create frontend 8080 --output yaml _See also:_ [Routing key concept]({{site_prefix}}/concepts/routing-key.html) --

--host string

+-

--host string

The hostname or IP address of the local listener. Clients at this site use the listener host and port to @@ -79,7 +79,7 @@ skupper listener create frontend 8080 --output yaml _Default:_ _Value of name_ --

--tls-secret string

+-

--tls-secret string

The name of a Kubernetes secret containing TLS credentials. The secret contains the trusted server @@ -93,12 +93,44 @@ skupper listener create frontend 8080 --output yaml _See also:_ [TLS re-encrypt]({{site_prefix}}) --

--type string

+-

--type string

The listener type. _Default:_ `tcp` +### Output options + +-

--output string

+ + Print resources to the console instead of submitting + them to the Skupper controller. + + _Choices:_ + + - `json` - Produce JSON output + - `yaml` - Produce YAML output + +### Context options + +-

--namespace string

+ + Select the current namespace. + +-

--context string

+ + Select the current kubeconfig context. + +-

--platform string

+ + Select the current Skupper platform. + +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/listener-delete.md b/input/commands/listener-delete.md index ead81b6..2946d3d 100644 --- a/input/commands/listener-delete.md +++ b/input/commands/listener-delete.md @@ -33,10 +33,30 @@ Listener "" is deleted. ## Options --

name string, required

+-

name string, required

The name of the listener resource. +### Context options + +-

--namespace string

+ + Select the current namespace. + +-

--context string

+ + Select the current kubeconfig context. + +-

--platform string

+ + Select the current Skupper platform. + +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/listener-status.md b/input/commands/listener-status.md index 05b2e08..68b8316 100644 --- a/input/commands/listener-status.md +++ b/input/commands/listener-status.md @@ -27,6 +27,38 @@ database database database 5432 1 ## Options +### Output options + +-

--output string

+ + Print resources to the console instead of submitting + them to the Skupper controller. + + _Choices:_ + + - `json` - Produce JSON output + - `yaml` - Produce YAML output + +### Context options + +-

--namespace string

+ + Select the current namespace. + +-

--context string

+ + Select the current kubeconfig context. + +-

--platform string

+ + Select the current Skupper platform. + +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/listener-update.md b/input/commands/listener-update.md index e1e0bf5..5ef8ce7 100644 --- a/input/commands/listener-update.md +++ b/input/commands/listener-update.md @@ -50,17 +50,17 @@ skupper listener update frontend --port 9090 --output yaml ## Options --

name string, required

+-

name string, required

The name of the listener resource. --

--port integer

+-

--port integer

The port of the local listener. Clients at this site use the listener host and port to establish connections to the remote service. --

--routing-key string

+-

--routing-key string

The identifier used to route traffic from listeners to connectors. To enable connecting to a service at a @@ -71,7 +71,7 @@ skupper listener update frontend --port 9090 --output yaml _See also:_ [Routing key concept]({{site_prefix}}/concepts/routing-key.html) --

--host string

+-

--host string

The hostname or IP address of the local listener. Clients at this site use the listener host and port to @@ -79,7 +79,7 @@ skupper listener update frontend --port 9090 --output yaml _Default:_ _Value of name_ --

--tls-secret string

+-

--tls-secret string

The name of a Kubernetes secret containing TLS credentials. The secret contains the trusted server @@ -93,12 +93,44 @@ skupper listener update frontend --port 9090 --output yaml _See also:_ [TLS re-encrypt]({{site_prefix}}) --

--type string

+-

--type string

The listener type. _Default:_ `tcp` +### Output options + +-

--output string

+ + Print resources to the console instead of submitting + them to the Skupper controller. + + _Choices:_ + + - `json` - Produce JSON output + - `yaml` - Produce YAML output + +### Context options + +-

--namespace string

+ + Select the current namespace. + +-

--context string

+ + Select the current kubeconfig context. + +-

--platform string

+ + Select the current Skupper platform. + +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/site-create.md b/input/commands/site-create.md index ff96fe9..2bc7757 100644 --- a/input/commands/site-create.md +++ b/input/commands/site-create.md @@ -47,16 +47,16 @@ skupper site create west --enable-link-access ## Options --

name string, required

+-

name string, required

A name of your choice for the Skupper site. This name is displayed in the console and CLI output. -- +- Allow access for incoming links from remote sites. -- +- Configure external access for links from remote sites. @@ -71,7 +71,7 @@ skupper site create west --enable-link-access - `route` - Use an OpenShift route. - `loadbalancer` - Use a Kubernetes load balancer. --

--service-account string

+-

--service-account string

The Kubernetes service account under which to run the Skupper controller. @@ -80,13 +80,9 @@ skupper site create west --enable-link-access _See also:_ [Kubernetes service accounts]({{site_prefix}}https://kubernetes.io/docs/concepts/security/service-accounts/) -
- -
+### Output options -## Output options - --

--output string

+-

--output string

Print resources to the console instead of submitting them to the Skupper controller. @@ -96,31 +92,23 @@ skupper site create west --enable-link-access - `json` - Produce JSON output - `yaml` - Produce YAML output -
- -
- -## Context options +### Context options --

--namespace string

+-

--namespace string

Select the current namespace. --

--context string

+-

--context string

Select the current kubeconfig context. --

--platform string

+-

--platform string

Select the current Skupper platform. -
- -
- -## Global options +### Global options --

--help None

+-

--help None

Display help and exit. diff --git a/input/commands/site-delete.md b/input/commands/site-delete.md index 6cb570e..5da20ce 100644 --- a/input/commands/site-delete.md +++ b/input/commands/site-delete.md @@ -31,38 +31,30 @@ Site "" is deleted. ## Options --

name string, optional

+-

name string, optional

The name of the site resource. If not specified, the name is that of the site associated with the current namespace. -
- -
- -## Context options +### Context options --

--namespace string

+-

--namespace string

Select the current namespace. --

--context string

+-

--context string

Select the current kubeconfig context. --

--platform string

+-

--platform string

Select the current Skupper platform. -
- -
- -## Global options +### Global options --

--help None

+-

--help None

Display help and exit. diff --git a/input/commands/site-status.md b/input/commands/site-status.md index f86596b..e6896a0 100644 --- a/input/commands/site-status.md +++ b/input/commands/site-status.md @@ -31,31 +31,23 @@ west Ready 1 0 ## Options -
- -
- -## Context options +### Context options --

--namespace string

+-

--namespace string

Select the current namespace. --

--context string

+-

--context string

Select the current kubeconfig context. --

--platform string

+-

--platform string

Select the current Skupper platform. -
- -
- -## Global options +### Global options --

--help None

+-

--help None

Display help and exit. diff --git a/input/commands/site-update.md b/input/commands/site-update.md index 193ab72..dd73d5b 100644 --- a/input/commands/site-update.md +++ b/input/commands/site-update.md @@ -47,18 +47,18 @@ skupper site update --enable-link-access --service-account app1:alice ## Options --

name string, optional

+-

name string, optional

The name of the site resource. If not specified, the name is that of the site associated with the current namespace. -- +- Allow access for incoming links from remote sites. -- +- Configure external access for links from remote sites. @@ -73,7 +73,7 @@ skupper site update --enable-link-access --service-account app1:alice - `route` - Use an OpenShift route. - `loadbalancer` - Use a Kubernetes load balancer. --

--service-account string

+-

--service-account string

The Kubernetes service account under which to run the Skupper controller. @@ -82,13 +82,9 @@ skupper site update --enable-link-access --service-account app1:alice _See also:_ [Kubernetes service accounts]({{site_prefix}}https://kubernetes.io/docs/concepts/security/service-accounts/) -
- -
+### Output options -## Output options - --

--output string

+-

--output string

Print resources to the console instead of submitting them to the Skupper controller. @@ -98,31 +94,23 @@ skupper site update --enable-link-access --service-account app1:alice - `json` - Produce JSON output - `yaml` - Produce YAML output -
- -
- -## Context options +### Context options --

--namespace string

+-

--namespace string

Select the current namespace. --

--context string

+-

--context string

Select the current kubeconfig context. --

--platform string

+-

--platform string

Select the current Skupper platform. -
- -
- -## Global options +### Global options --

--help None

+-

--help None

Display help and exit. diff --git a/input/commands/token-issue.md b/input/commands/token-issue.md index 9a7242e..c89c945 100644 --- a/input/commands/token-issue.md +++ b/input/commands/token-issue.md @@ -57,24 +57,44 @@ skupper token issue ~/token.yaml --expiration-period 24h --redemptions-allowed 3 ## Options --

file string, required

+-

file string, required

The name of the token file. --

--expiration-period string (duration)

+-

--expiration-period string (duration)

The period of time in which a token for this grant can be redeemed. _Default:_ `15m` --

--redemptions-allowed integer

+-

--redemptions-allowed integer

The number of times a token for this grant can be redeemed. _Default:_ 1 +### Context options + +-

--namespace string

+ + Select the current namespace. + +-

--context string

+ + Select the current kubeconfig context. + +-

--platform string

+ + Select the current Skupper platform. + +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/token-redeem.md b/input/commands/token-redeem.md index fe82dea..335335b 100644 --- a/input/commands/token-redeem.md +++ b/input/commands/token-redeem.md @@ -34,10 +34,30 @@ You can now safely delete . ## Options --

file string, required

+-

file string, required

The name of the token file. +### Context options + +-

--namespace string

+ + Select the current namespace. + +-

--context string

+ + Select the current kubeconfig context. + +-

--platform string

+ + Select the current Skupper platform. + +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/commands/token.md b/input/commands/token.md index 5692333..7df45bc 100644 --- a/input/commands/token.md +++ b/input/commands/token.md @@ -19,6 +19,12 @@ Display help for token commands and exit. ## Options +### Global options + +-

--help None

+ + Display help and exit. +
diff --git a/input/main.css b/input/main.css index d593379..67b2700 100644 --- a/input/main.css +++ b/input/main.css @@ -277,7 +277,7 @@ aside > div { } aside h4 { - font-size: 0.9em; + font-size: 0.9em !important; font-weight: 500; text-transform: uppercase; } @@ -291,6 +291,10 @@ body.resource h2, body.command h2 { } body.resource h3, body.command h3 { + font-size: 1.1em; +} + +body.resource h4, body.command h4 { font-family: var(--body-font-family); font-size: 1em; } diff --git a/input/resources/certificate.md b/input/resources/certificate.md index 8568bbb..857f7ea 100644 --- a/input/resources/certificate.md +++ b/input/resources/certificate.md @@ -12,17 +12,17 @@ body_class: resource ## Spec properties --

ca string, required

+-

ca string, required

--

subject string, required

+-

subject string, required

--

hosts array

+-

hosts array

--

client boolean

+-

client boolean

--

server boolean

+-

server boolean

--

signing boolean

+-

signing boolean

@@ -30,8 +30,8 @@ body_class: resource ## Status properties --

status string

+-

status string

--

expiration string (date-time)

+-

expiration string (date-time)

diff --git a/input/resources/claim.md b/input/resources/claim.md index 7be459d..e2ea491 100644 --- a/input/resources/claim.md +++ b/input/resources/claim.md @@ -23,17 +23,17 @@ corresponding grant. ## Spec properties --

redemptionSecret string, required

+-

redemptionSecret string, required

The secret used to authenticate the token when submitted for redemption. --

redemptionURL string, required

+-

redemptionURL string, required

The URL of the token redemption service at the target site. --

redemptionCA string, required

+-

redemptionCA string, required

The trusted server certificate of the token redemption service at the target site. @@ -44,11 +44,11 @@ corresponding grant. ## Status properties --

status string

+-

status string

The current state of the resource. --

redeemed boolean

+-

redeemed boolean

True if the token has been redeemed. diff --git a/input/resources/connector.md b/input/resources/connector.md index 64f7130..208eb8f 100644 --- a/input/resources/connector.md +++ b/input/resources/connector.md @@ -44,7 +44,7 @@ spec: ## Spec properties --

routingKey string, required

+-

routingKey string, required

The identifier used to route traffic from listeners to connectors. To expose a local workload to a remote @@ -53,23 +53,23 @@ spec: _See also:_ [Routing key concept]({{site_prefix}}/concepts/routing-key.html) --

port integer, required

+-

port integer, required

The port on the target workload to forward traffic to. --

selector string

+-

selector string

A Kubernetes label selector for specifying target pods. _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/) --

host string

+-

host string

The hostname or IP address of the server. This is an alternative to `selector` for specifying the target server. --

tlsSecret string

+-

tlsSecret string

The name of a Kubernetes secret containing the trusted server certificate (typically a CA). @@ -82,12 +82,12 @@ spec: _See also:_ [TLS re-encrypt]({{site_prefix}}) --

includeNotReady boolean

+-

includeNotReady boolean

If set, include server pods that are not in the ready state. --

type string

+-

type string

The connector type. @@ -99,10 +99,10 @@ spec: ## Status properties --

status string

+-

status string

The current state of the resource. --

active boolean

+-

active boolean

diff --git a/input/resources/grant.md b/input/resources/grant.md index 0329af9..b3f7dfb 100644 --- a/input/resources/grant.md +++ b/input/resources/grant.md @@ -25,21 +25,21 @@ period and for a limited number of redemptions. ## Spec properties --

redemptionsAllowed integer

+-

redemptionsAllowed integer

The number of times a token for this grant can be redeemed. _Default:_ 1 --

expirationPeriod string (duration)

+-

expirationPeriod string (duration)

The period of time in which a token for this grant can be redeemed. _Default:_ `15m` --

secret string

+-

secret string

What is this secret as compared to the one in the status? The description above says "containing the @@ -54,29 +54,29 @@ period and for a limited number of redemptions. ## Status properties --

status string

+-

status string

The current state of the resource. --

redemptions integer

+-

redemptions integer

The number of times a token for this grant has been redeemed. --

expiration string (date-time)

+-

expiration string (date-time)

The point in time when the grant expires. --

redemptionSecret string

+-

redemptionSecret string

The secret used to authenticate tokens submitted for redemption. --

redemptionURL string

+-

redemptionURL string

The URL of the token redemption service for this grant. --

redemptionCA string

+-

redemptionCA string

The trusted server certificate of the token redemption service for this grant. diff --git a/input/resources/link.md b/input/resources/link.md index 073a9f0..645cd74 100644 --- a/input/resources/link.md +++ b/input/resources/link.md @@ -28,7 +28,7 @@ grant and token to obtain a link. ## Spec properties --

tlsSecret string

+-

tlsSecret string

The name of a Kubernetes secret containing TLS credentials. The secret contains the trusted server @@ -37,13 +37,13 @@ grant and token to obtain a link. It can optionally include a client certificate and key for mutual TLS. --

cost integer

+-

cost integer

--

interRouter object, required

+-

interRouter object, required

--

edge object, required

+-

edge object, required

--

noClientAuth boolean

+-

noClientAuth boolean

@@ -51,16 +51,16 @@ grant and token to obtain a link. ## Status properties --

status string

+-

status string

The current state of the resource. --

configured boolean

+-

configured boolean

--

active boolean

+-

active boolean

--

url string

+-

url string

--

site string

+-

site string

diff --git a/input/resources/linkaccess.md b/input/resources/linkaccess.md index b7e815a..24d0a04 100644 --- a/input/resources/linkaccess.md +++ b/input/resources/linkaccess.md @@ -17,9 +17,9 @@ access. ## Spec properties --

roles array, required

+-

roles array, required

--

tlsSecret string, required

+-

tlsSecret string, required

The name of a Kubernetes secret containing the trusted server certificate (typically a CA). @@ -27,7 +27,7 @@ access. It can optionally include a client certificate and key for mutual TLS. --

ca string

+-

ca string

The name of a Kubernetes secret containing a CA for generating TLS credentials. If the `tlsCredentials` @@ -36,13 +36,13 @@ access. Consider tlsCA. And "ca" often means "this is what I trust". This thing has a different meaning. --

bindHost string

+-

bindHost string

--

subjectAlternativeNames array

+-

subjectAlternativeNames array

--

options object

+-

options object

--

accessType string

+-

accessType string

@@ -50,10 +50,10 @@ access. ## Status properties --

active boolean

+-

active boolean

--

status string

+-

status string

--

urls array

+-

urls array

diff --git a/input/resources/listener.md b/input/resources/listener.md index 63870c7..feb52b6 100644 --- a/input/resources/listener.md +++ b/input/resources/listener.md @@ -45,7 +45,7 @@ spec: ## Spec properties --

routingKey string, required

+-

routingKey string, required

The identifier used to route traffic from listeners to connectors. To enable connecting to a service at a @@ -54,19 +54,19 @@ spec: _See also:_ [Routing key concept]({{site_prefix}}/concepts/routing-key.html) --

host string, required

+-

host string, required

The hostname or IP address of the local listener. Clients at this site use the listener host and port to establish connections to the remote service. --

port integer, required

+-

port integer, required

The port of the local listener. Clients at this site use the listener host and port to establish connections to the remote service. --

tlsSecret string

+-

tlsSecret string

The name of a Kubernetes secret containing TLS credentials. The secret contains the trusted server @@ -80,7 +80,7 @@ spec: _See also:_ [TLS re-encrypt]({{site_prefix}}) --

type string

+-

type string

The listener type. @@ -92,10 +92,10 @@ spec: ## Status properties --

status string

+-

status string

The current state of the resource. --

active boolean

+-

active boolean

diff --git a/input/resources/securedaccess.md b/input/resources/securedaccess.md index 88099e0..f066207 100644 --- a/input/resources/securedaccess.md +++ b/input/resources/securedaccess.md @@ -12,17 +12,17 @@ body_class: resource ## Spec properties --

ports array, required

+-

ports array, required

--

selector object, required

+-

selector object, required

--

ca string

+-

ca string

--

certificate string

+-

certificate string

--

accessType string

+-

accessType string

--

options object

+-

options object

@@ -30,12 +30,12 @@ body_class: resource ## Status properties --

active boolean

+-

active boolean

--

status string

+-

status string

--

urls array

+-

urls array

--

ca string

+-

ca string

diff --git a/input/resources/site.md b/input/resources/site.md index 62fc320..220d6fd 100644 --- a/input/resources/site.md +++ b/input/resources/site.md @@ -52,7 +52,7 @@ spec: ## Spec properties --

linkAccess string

+-

linkAccess string

Configure external access for links from remote sites. @@ -67,7 +67,7 @@ spec: - `route` - Use an OpenShift route. - `loadbalancer` - Use a Kubernetes load balancer. --

serviceAccount string

+-

serviceAccount string

The Kubernetes service account under which to run the Skupper controller. @@ -76,7 +76,7 @@ spec: _See also:_ [Kubernetes service accounts]({{site_prefix}}https://kubernetes.io/docs/concepts/security/service-accounts/) --

options array

+-

options array

@@ -84,20 +84,20 @@ spec: ## Status properties --

status string

+-

status string

The current state of the resource. --

active boolean

+-

active boolean

"This thing is working." --

endpoints array

+-

endpoints array

--

sitesInNetwork integer

+-

sitesInNetwork integer

--

servicesInNetwork integer

+-

servicesInNetwork integer

--

network array

+-

network array

diff --git a/python/commands.py b/python/commands.py index 13d7909..08d2998 100644 --- a/python/commands.py +++ b/python/commands.py @@ -102,21 +102,16 @@ def append(line=""): for argument in command.arguments: generate_argument(argument, append) - append("") - append() - - if command.standard_arguments: - for name, arguments in command.standard_arguments: - append("
") - append() - append(f"## {name}") - append() + if command.standard_arguments: + for name, arguments in command.standard_arguments: + append(f"### {name}") + append() - for argument in arguments: - generate_argument(argument, append) + for argument in arguments: + generate_argument(argument, append) - append("
") - append() + append("") + append() if command.errors: append("
") @@ -166,7 +161,7 @@ def generate_argument(argument, append): if not argument.required and argument.positional: argument_info += ", optional" - append(f"-

{prefix}{name} {argument_info}

") + append(f"-

{prefix}{name} {argument_info}

") append() if argument.description: diff --git a/python/resources.py b/python/resources.py index 8d6d24c..ca16b3c 100644 --- a/python/resources.py +++ b/python/resources.py @@ -133,7 +133,7 @@ def generate_property(prop, append): if prop.required and prop.default is None: prop_info += ", required" - append(f"-

{name} {prop_info}

") + append(f"-

{name} {prop_info}

") append() if prop.description: