From 5fb4c1d2357baa4c339d757e34e1346a53f49113 Mon Sep 17 00:00:00 2001 From: Justin Ross Date: Tue, 7 Jan 2025 17:29:52 -0500 Subject: [PATCH] WIP --- config/commands/system.yaml | 110 ++++++++++++---- input/commands/connector/create.md | 14 +- input/commands/connector/delete.md | 8 +- input/commands/connector/generate.md | 16 +-- input/commands/connector/status.md | 10 +- input/commands/connector/update.md | 14 +- input/commands/debug/check.md | 6 +- input/commands/debug/dump.md | 8 +- input/commands/index.md | 12 +- input/commands/link/delete.md | 8 +- input/commands/link/generate.md | 12 +- input/commands/link/status.md | 10 +- input/commands/link/update.md | 10 +- input/commands/listener/create.md | 14 +- input/commands/listener/delete.md | 8 +- input/commands/listener/generate.md | 16 +-- input/commands/listener/status.md | 10 +- input/commands/listener/update.md | 14 +- input/commands/site/create.md | 10 +- input/commands/site/delete.md | 10 +- input/commands/site/generate.md | 10 +- input/commands/site/status.md | 10 +- input/commands/site/update.md | 10 +- input/commands/system/apply.md | 50 +++----- input/commands/system/delete.md | 88 +++++++++++++ input/commands/system/generate-bundle.md | 121 ++++++++++++++++++ input/commands/system/index.md | 14 +- input/commands/system/install.md | 36 ++---- input/commands/system/reload.md | 9 +- input/commands/system/start.md | 18 +-- input/commands/system/stop.md | 13 +- input/commands/system/uninstall.md | 26 ++-- input/commands/token/issue.md | 4 +- input/commands/token/redeem.md | 12 +- input/commands/version.md | 8 +- input/resources/access-grant.md | 30 ++--- input/resources/access-token.md | 22 ++-- input/resources/attached-connector-binding.md | 18 +-- input/resources/attached-connector.md | 22 ++-- input/resources/connector.md | 34 ++--- input/resources/link.md | 22 ++-- input/resources/listener.md | 24 ++-- input/resources/router-access.md | 28 ++-- input/resources/site.md | 30 ++--- python/common.py | 4 +- 45 files changed, 616 insertions(+), 367 deletions(-) create mode 100644 input/commands/system/delete.md create mode 100644 input/commands/system/generate-bundle.md diff --git a/config/commands/system.yaml b/config/commands/system.yaml index 6b1d310..adb757e 100644 --- a/config/commands/system.yaml +++ b/config/commands/system.yaml @@ -1,53 +1,109 @@ name: system -platforms: [Docker, Podman, Linux] +platforms: [Kubernetes, Docker, Podman, Linux] related_concepts: [platform] subcommands: - name: install related_commands: [system/uninstall] description: | - Install the Skupper components. + Install local system infrastructure and configure the environment. - This creates the router configuration, TLS certificates, and - systemd unit file for the current namespace. On Docker or - Podman, it also creates containers for Skupper components. - include_options: [context/namespace, global/*] + It does the following: + + - Checks the local environment for required resources and + configuration. + - In some instances, configures the local environment. On + Podman, it starts the Podman API service if it is not already + available. + + **Note:** With a long-lived controller, this operation would + also start the controller as a user-scoped systemd service. + include_options: [global/*] - name: uninstall related_commands: [system/install] description: | - Remove the Skupper components. + Remove local system infrastructure. - This removes the router configuration, TLS certificates, and - systemd unit file for the current namespace. On Docker or - Podman, it also removes the containers for Skupper components. - include_options: [context/namespace, global/*] + This operation fails if sites are present. Use the + `--force` option to override. + include_options: [global/*] + options: + - name: force + type: boolean - name: start related_commands: [system/stop] description: | - Start up the Skupper components for the current site. + Start the Skupper router for the current site. This starts the + systemd service for the current namespace. - This starts the systemd service for the current namespace. - - + **Note:** In the absence of a long-lived controller, this + operation first reads the input resources and updates the router + configuration. With a long-lived controller, that config update + would have already taken place. include_options: [context/namespace, global/*] - name: stop related_commands: [system/start] description: | - Shut down the Skupper components for the current site. - - This stops the systemd service for the current namespace. + Stop the Skupper router for the current site. This stops the + systemd service for the current namespace. include_options: [context/namespace, global/*] - name: reload description: | - Reload the site configuration. + Reload the site configuration. This restarts the systemd + service for the current namespace. - This restarts the systemd service for the current namespace. - # - name: apply - # description: | - # Apply resource configuration from files or standard input. + **Note:** This is currently equivalent to start then stop. With + a router adaptor service, we could avoid a router restart for some + config changes. + - name: apply + description: | + Create or update resources using files or standard input. - # - # include_options: [context/namespace, global/*] - - name: status + + + include_options: [context/namespace, global/*] + options: + - name: filename + type: string + short_option: f + - name: delete + description: | + Delete resources using files or standard input. + + + + include_options: [context/namespace, global/*] + options: + - name: filename + type: string + short_option: f + - name: generate-bundle description: | - Display the status of the system. + Generate a self-contained site bundle for use on another + machine. include_options: [context/namespace, global/*] + options: + - name: bundle-file + type: string + positional: true + required: true + description: | + The name of the bundle file to generate. + + The command exits with an error if the file already exists. + - name: input + type: string + default: $HOME/.local/share/skupper/namespaces//input/resources + description: | + The location of the Skupper resources defining the site. + - name: type + type: string + default: tarball + choices: + - name: tarball + description: A gzipped tar file + - name: shell-script + description: A self-extracting shell script + # - name: status + # description: | + # Display the status of the system. + # include_options: [context/namespace, global/*] diff --git a/input/commands/connector/create.md b/input/commands/connector/create.md index 74d443e..00d1c64 100644 --- a/input/commands/connector/create.md +++ b/input/commands/connector/create.md @@ -57,7 +57,7 @@ option is not specified. On Kubernetes, the name defines the default pod selector if the `--selector` and `--workload` options are not specified. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -72,7 +72,7 @@ the default pod selector if the `--selector` and The port on the target server to connect to. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+
UpdatableTrue
@@ -91,7 +91,7 @@ remote listener and the local connector must have matching routing keys.
Default

Value of name

-
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+UpdatableTrue @@ -149,7 +149,7 @@ This is an alternative to setting the `--selector` or `--workload` options.
Default

Value of name

-
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+UpdatableTrue @@ -230,7 +230,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -252,7 +252,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -267,7 +267,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/connector/delete.md b/input/commands/connector/delete.md index bafe0e3..24b79bd 100644 --- a/input/commands/connector/delete.md +++ b/input/commands/connector/delete.md @@ -45,7 +45,7 @@ Connector "database" is deleted. The name of the resource to be deleted. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -122,7 +122,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -144,7 +144,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -159,7 +159,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/connector/generate.md b/input/commands/connector/generate.md index bbead0f..272a869 100644 --- a/input/commands/connector/generate.md +++ b/input/commands/connector/generate.md @@ -54,7 +54,7 @@ $ skupper connector generate backend 8080 > backend.yaml The name of the resource to be generated. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -69,7 +69,7 @@ The name of the resource to be generated. The port on the target server to connect to. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+
UpdatableTrue
@@ -88,7 +88,7 @@ remote listener and the local connector must have matching routing keys.
Default

Value of name

-
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+UpdatableTrue @@ -146,7 +146,7 @@ This is an alternative to setting the `--selector` or `--workload` options.
Default

Value of name

-
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+UpdatableTrue @@ -164,7 +164,7 @@ Wait for the given status before exiting. Choices
none

Do not wait

configured

Configured

ready

Ready

-
PlatformsKubernetes, Docker, Podman, Linux + @@ -181,7 +181,7 @@ Select the output format.
Default

yaml

Choices
json

Produce JSON output

yaml

Produce YAML output

-
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -205,7 +205,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -220,7 +220,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/connector/status.md b/input/commands/connector/status.md index d971c94..c98a772 100644 --- a/input/commands/connector/status.md +++ b/input/commands/connector/status.md @@ -58,7 +58,7 @@ Has matching listeners: 1 An optional resource name. If set, the status command reports status for the named resource only. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -90,7 +90,7 @@ Print status to the console in a structured output format.
Choices
json

Produce JSON output

yaml

Produce YAML output

-
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -137,7 +137,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -159,7 +159,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -174,7 +174,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/connector/update.md b/input/commands/connector/update.md index e96eafd..e87a308 100644 --- a/input/commands/connector/update.md +++ b/input/commands/connector/update.md @@ -48,7 +48,7 @@ $ skupper connector update backend --routing-key be2 The name of the resource to be updated. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -63,7 +63,7 @@ The name of the resource to be updated. The port on the target server to connect to. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+
UpdatableTrue
@@ -82,7 +82,7 @@ remote listener and the local connector must have matching routing keys.
Default

Value of name

-
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+UpdatableTrue @@ -140,7 +140,7 @@ This is an alternative to setting the `--selector` or `--workload` options.
Default

Value of name

-
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+UpdatableTrue @@ -221,7 +221,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -243,7 +243,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -258,7 +258,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/debug/check.md b/input/commands/debug/check.md index 0f263e6..d1a64d6 100644 --- a/input/commands/debug/check.md +++ b/input/commands/debug/check.md @@ -58,7 +58,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -80,7 +80,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -95,7 +95,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/debug/dump.md b/input/commands/debug/dump.md index ecd858f..ad3f3e2 100644 --- a/input/commands/debug/dump.md +++ b/input/commands/debug/dump.md @@ -44,7 +44,7 @@ The name of the file to generate. The command exits with an error if the file already exists.
Default

skupper-dump-<site-name>-<date>.tar.gz

-
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -91,7 +91,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -113,7 +113,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -128,7 +128,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/index.md b/input/commands/index.md index 54d1cc9..a4921be 100644 --- a/input/commands/index.md +++ b/input/commands/index.md @@ -64,12 +64,14 @@ refdog_links: - - - - + + + + - + + +
SystemOverview of system commands
System installInstall the Skupper components
System uninstallRemove the Skupper components
System startStart up the Skupper components for the current site
System stopShut down the Skupper components for the current site
System installInstall local system infrastructure and configure the environment
System uninstallRemove local system infrastructure
System startStart the Skupper router for the current site
System stopStop the Skupper router for the current site
System reloadReload the site configuration
System statusDisplay the status of the system
System applyCreate or update resources using files or standard input
System deleteDelete resources using files or standard input
System generate-bundleGenerate a self-contained site bundle for use on another machine
diff --git a/input/commands/link/delete.md b/input/commands/link/delete.md index 6a2eb80..5df6a4c 100644 --- a/input/commands/link/delete.md +++ b/input/commands/link/delete.md @@ -43,7 +43,7 @@ Link "west-6bfn6" is deleted. The name of the resource to be deleted. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -120,7 +120,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -142,7 +142,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -157,7 +157,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/link/generate.md b/input/commands/link/generate.md index 02a99b0..d9939c6 100644 --- a/input/commands/link/generate.md +++ b/input/commands/link/generate.md @@ -74,7 +74,7 @@ $ skupper link generate > link.yaml The name of the resource to be generated. A name is generated if none is provided. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -89,7 +89,7 @@ generated if none is provided. The configured routing cost of sending traffic over the link. -
Default1
PlatformsKubernetes, Docker, Podman, Linux
See alsoLoad balancing
+
Default1
See alsoLoad balancing
@@ -106,7 +106,7 @@ Select the output format.
Default

yaml

Choices
json

Produce JSON output

yaml

Produce YAML output

-
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -153,7 +153,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -175,7 +175,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -190,7 +190,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/link/status.md b/input/commands/link/status.md index b841786..8226434 100644 --- a/input/commands/link/status.md +++ b/input/commands/link/status.md @@ -56,7 +56,7 @@ Cost: 1 An optional resource name. If set, the status command reports status for the named resource only. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -88,7 +88,7 @@ Print status to the console in a structured output format.
Choices
json

Produce JSON output

yaml

Produce YAML output

-
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -135,7 +135,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -157,7 +157,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -172,7 +172,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/link/update.md b/input/commands/link/update.md index 60fe6d0..69ab6ab 100644 --- a/input/commands/link/update.md +++ b/input/commands/link/update.md @@ -43,7 +43,7 @@ Link "west-6bfn6" is ready. The name of the resource to be updated. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -58,7 +58,7 @@ The name of the resource to be updated. The configured routing cost of sending traffic over the link. -
Default1
PlatformsKubernetes, Docker, Podman, Linux
See alsoLoad balancing
+
Default1
See alsoLoad balancing
@@ -139,7 +139,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -161,7 +161,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -176,7 +176,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/listener/create.md b/input/commands/listener/create.md index a82611b..fcee023 100644 --- a/input/commands/listener/create.md +++ b/input/commands/listener/create.md @@ -52,7 +52,7 @@ The name of the resource to be created. The name is the default routing key and host if the `--routing-key` and `--host` options are not specified. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -69,7 +69,7 @@ The port of the local listener. Clients at this site use the listener host and port to establish connections to the remote service. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+
UpdatableTrue
@@ -88,7 +88,7 @@ remote site, the local listener and the remote connector must have matching routing keys.
Default

Value of name

-
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+UpdatableTrue @@ -106,7 +106,7 @@ at this site use the listener host and port to establish connections to the remote service.
Default

Value of name

-
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+UpdatableTrue @@ -187,7 +187,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -209,7 +209,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -224,7 +224,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/listener/delete.md b/input/commands/listener/delete.md index ebcbace..0e1bdc1 100644 --- a/input/commands/listener/delete.md +++ b/input/commands/listener/delete.md @@ -45,7 +45,7 @@ Listener "database" is deleted. The name of the resource to be deleted. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -122,7 +122,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -144,7 +144,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -159,7 +159,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/listener/generate.md b/input/commands/listener/generate.md index 8216960..a32640f 100644 --- a/input/commands/listener/generate.md +++ b/input/commands/listener/generate.md @@ -54,7 +54,7 @@ $ skupper listener generate backend 8080 > backend.yaml The name of the resource to be generated. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -71,7 +71,7 @@ The port of the local listener. Clients at this site use the listener host and port to establish connections to the remote service. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+
UpdatableTrue
@@ -90,7 +90,7 @@ remote site, the local listener and the remote connector must have matching routing keys.
Default

Value of name

-
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+UpdatableTrue @@ -108,7 +108,7 @@ at this site use the listener host and port to establish connections to the remote service.
Default

Value of name

-
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+UpdatableTrue @@ -126,7 +126,7 @@ Wait for the given status before exiting. Choices
none

Do not wait

configured

Configured

ready

Ready

-
PlatformsKubernetes, Docker, Podman, Linux + @@ -143,7 +143,7 @@ Select the output format.
Default

yaml

Choices
json

Produce JSON output

yaml

Produce YAML output

-
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -167,7 +167,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -182,7 +182,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/listener/status.md b/input/commands/listener/status.md index 3ce7ae9..8e24492 100644 --- a/input/commands/listener/status.md +++ b/input/commands/listener/status.md @@ -57,7 +57,7 @@ Has matching connectors: true An optional resource name. If set, the status command reports status for the named resource only. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -89,7 +89,7 @@ Print status to the console in a structured output format.
Choices
json

Produce JSON output

yaml

Produce YAML output

-
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -136,7 +136,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -158,7 +158,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -173,7 +173,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/listener/update.md b/input/commands/listener/update.md index 0b5d5ea..d777199 100644 --- a/input/commands/listener/update.md +++ b/input/commands/listener/update.md @@ -48,7 +48,7 @@ $ skupper listener update backend --routing-key be2 The name of the resource to be updated. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -66,7 +66,7 @@ at this site use the listener host and port to establish connections to the remote service.
Default

Value of name

-
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+UpdatableTrue @@ -83,7 +83,7 @@ The port of the local listener. Clients at this site use the listener host and port to establish connections to the remote service. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+
UpdatableTrue
@@ -102,7 +102,7 @@ remote site, the local listener and the remote connector must have matching routing keys.
Default

Value of name

-
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+UpdatableTrue @@ -183,7 +183,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -205,7 +205,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -220,7 +220,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/site/create.md b/input/commands/site/create.md index a47bda2..f0cc2d8 100644 --- a/input/commands/site/create.md +++ b/input/commands/site/create.md @@ -45,7 +45,7 @@ $ skupper site create west --enable-link-access A name of your choice for the Skupper site. This name is displayed in the console and CLI output. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -64,7 +64,7 @@ Sites and links are the basis for creating application networks. In a simple two-site network, at least one of the sites must have link access enabled. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoLink concept, Site linking
+
See alsoLink concept, Site linking
@@ -187,7 +187,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -209,7 +209,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -224,7 +224,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/site/delete.md b/input/commands/site/delete.md index 43c52c0..fc6dd23 100644 --- a/input/commands/site/delete.md +++ b/input/commands/site/delete.md @@ -47,7 +47,7 @@ The name of the site resource. If not specified, the name is that of the site associated with the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -64,7 +64,7 @@ In addition the site resource, delete all of the Skupper resources associated with the site in the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -141,7 +141,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -163,7 +163,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -178,7 +178,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/site/generate.md b/input/commands/site/generate.md index b8b8deb..9af6cb4 100644 --- a/input/commands/site/generate.md +++ b/input/commands/site/generate.md @@ -48,7 +48,7 @@ $ skupper site generate east > east.yaml The name of the resource to be generated. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -67,7 +67,7 @@ Sites and links are the basis for creating application networks. In a simple two-site network, at least one of the sites must have link access enabled. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoLink concept, Site linking
+
See alsoLink concept, Site linking
@@ -84,7 +84,7 @@ Select the output format.
Default

yaml

Choices
json

Produce JSON output

yaml

Produce YAML output

-
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -150,7 +150,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -165,7 +165,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/site/status.md b/input/commands/site/status.md index d8a6b11..74b4aae 100644 --- a/input/commands/site/status.md +++ b/input/commands/site/status.md @@ -45,7 +45,7 @@ The name of the site resource. If not specified, the name is that of the site associated with the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -77,7 +77,7 @@ Print status to the console in a structured output format.
Choices
json

Produce JSON output

yaml

Produce YAML output

-
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -124,7 +124,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -146,7 +146,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -161,7 +161,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/site/update.md b/input/commands/site/update.md index 892a040..5373ff3 100644 --- a/input/commands/site/update.md +++ b/input/commands/site/update.md @@ -47,7 +47,7 @@ The name of the site resource. If not specified, the name is that of the site associated with the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -66,7 +66,7 @@ Sites and links are the basis for creating application networks. In a simple two-site network, at least one of the sites must have link access enabled. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoLink concept, Site linking
+
See alsoLink concept, Site linking
@@ -189,7 +189,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -211,7 +211,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -226,7 +226,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/system/apply.md b/input/commands/system/apply.md index 03bf6f0..de9b79f 100644 --- a/input/commands/system/apply.md +++ b/input/commands/system/apply.md @@ -4,46 +4,34 @@ refdog_links: - title: Platform concept url: /concepts/platform.html refdog_object_has_attributes: true -refdog_toc: -- id: '' - title: Overview -- id: usage - title: Usage -- id: primary-options - title: Primary options -- id: global-options - title: Global options --- # System apply command -
- -Apply resource configuration from files or standard input. - - - -
PlatformsDocker, Podman, Linux
- -
- -
- -## Usage - ~~~ shell skupper system apply [options] ~~~ -
+Create or update resources using files or standard input. -
+ + + +
PlatformsKubernetes, Docker, Podman, Linux
## Primary options -
+
+
+

--filename

+
(-f) <string>
+
+
+ + -
+
+
## Global options @@ -57,7 +45,7 @@ skupper system apply [options] Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -79,7 +67,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -94,9 +82,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ - - diff --git a/input/commands/system/delete.md b/input/commands/system/delete.md new file mode 100644 index 0000000..5f14953 --- /dev/null +++ b/input/commands/system/delete.md @@ -0,0 +1,88 @@ +--- +body_class: object command +refdog_links: +- title: Platform concept + url: /concepts/platform.html +refdog_object_has_attributes: true +--- + +# System delete command + +~~~ shell +skupper system delete [options] +~~~ + +Delete resources using files or standard input. + + + + +
PlatformsKubernetes, Docker, Podman, Linux
+ +## Primary options + +
+
+

--filename

+
(-f) <string>
+
+
+ + + +
+
+ +## Global options + + + + + + diff --git a/input/commands/system/generate-bundle.md b/input/commands/system/generate-bundle.md new file mode 100644 index 0000000..e68cf11 --- /dev/null +++ b/input/commands/system/generate-bundle.md @@ -0,0 +1,121 @@ +--- +body_class: object command +refdog_links: +- title: Platform concept + url: /concepts/platform.html +refdog_object_has_attributes: true +--- + +# System generate-bundle command + +~~~ shell +skupper system generate-bundle [options] +~~~ + +Generate a self-contained site bundle for use on another +machine. + +
PlatformsKubernetes, Docker, Podman, Linux
+ +## Primary options + +
+
+

<bundle-file>

+
string
+
required
+
+
+ +The name of the bundle file to generate. + +The command exits with an error if the file already exists. + + + +
+
+ +
+
+

--input

+
<string>
+
+
+ +The location of the Skupper resources defining the site. + +
Default

$HOME/.local/share/skupper/namespaces/<namespace>/input/resources

+
+ +
+
+ +
+
+

--type

+
<string>
+
+
+ +
Default

tarball

+
Choices
tarball

A gzipped tar file

+
shell-script

A self-extracting shell script

+
+ +
+
+ +## Global options + + + + + + diff --git a/input/commands/system/index.md b/input/commands/system/index.md index 162969d..8a761b4 100644 --- a/input/commands/system/index.md +++ b/input/commands/system/index.md @@ -12,15 +12,17 @@ refdog_object_has_attributes: true skupper system [subcommand] [options] ~~~ -
PlatformsDocker, Podman, Linux
+
PlatformsKubernetes, Docker, Podman, Linux
## Subcommands - - - - + + + + - + + +
System installInstall the Skupper components
System uninstallRemove the Skupper components
System startStart up the Skupper components for the current site
System stopShut down the Skupper components for the current site
System installInstall local system infrastructure and configure the environment
System uninstallRemove local system infrastructure
System startStart the Skupper router for the current site
System stopStop the Skupper router for the current site
System reloadReload the site configuration
System statusDisplay the status of the system
System applyCreate or update resources using files or standard input
System deleteDelete resources using files or standard input
System generate-bundleGenerate a self-contained site bundle for use on another machine
diff --git a/input/commands/system/install.md b/input/commands/system/install.md index 1e3b129..7378e53 100644 --- a/input/commands/system/install.md +++ b/input/commands/system/install.md @@ -14,32 +14,24 @@ refdog_object_has_attributes: true skupper system install [options] ~~~ -Install the Skupper components. +Install local system infrastructure and configure the environment. -This creates the router configuration, TLS certificates, and -systemd unit file for the current namespace. On Docker or -Podman, it also creates containers for Skupper components. +It does the following: -
PlatformsDocker, Podman, Linux
+- Checks the local environment for required resources and + configuration. +- In some instances, configures the local environment. On + Podman, it starts the Podman API service if it is not already + available. -## Primary options - -## Global options - - +## Global options @@ -73,7 +65,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/system/reload.md b/input/commands/system/reload.md index 3340900..ef60622 100644 --- a/input/commands/system/reload.md +++ b/input/commands/system/reload.md @@ -12,8 +12,11 @@ refdog_object_has_attributes: true skupper system reload [options] ~~~ -Reload the site configuration. +Reload the site configuration. This restarts the systemd +service for the current namespace. -This restarts the systemd service for the current namespace. +**Note:** This is currently equivalent to start then stop. With +a router adaptor service, we could avoid a router restart for some +config changes. -
PlatformsDocker, Podman, Linux
+
PlatformsKubernetes, Docker, Podman, Linux
diff --git a/input/commands/system/start.md b/input/commands/system/start.md index b7087cf..51abfce 100644 --- a/input/commands/system/start.md +++ b/input/commands/system/start.md @@ -14,13 +14,15 @@ refdog_object_has_attributes: true skupper system start [options] ~~~ -Start up the Skupper components for the current site. +Start the Skupper router for the current site. This starts the +systemd service for the current namespace. -This starts the systemd service for the current namespace. +**Note:** In the absence of a long-lived controller, this +operation first reads the input resources and updates the router +configuration. With a long-lived controller, that config update +would have already taken place. - - -
PlatformsDocker, Podman, Linux
+
PlatformsKubernetes, Docker, Podman, Linux
## Primary options @@ -36,7 +38,7 @@ This starts the systemd service for the current namespace. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -58,7 +60,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -73,7 +75,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/system/stop.md b/input/commands/system/stop.md index 13ed78c..ce5b794 100644 --- a/input/commands/system/stop.md +++ b/input/commands/system/stop.md @@ -14,11 +14,10 @@ refdog_object_has_attributes: true skupper system stop [options] ~~~ -Shut down the Skupper components for the current site. +Stop the Skupper router for the current site. This stops the +systemd service for the current namespace. -This stops the systemd service for the current namespace. - -
PlatformsDocker, Podman, Linux
+
PlatformsKubernetes, Docker, Podman, Linux
## Primary options @@ -34,7 +33,7 @@ This stops the systemd service for the current namespace. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -56,7 +55,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -71,7 +70,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/system/uninstall.md b/input/commands/system/uninstall.md index 870d5fe..ee262f5 100644 --- a/input/commands/system/uninstall.md +++ b/input/commands/system/uninstall.md @@ -14,33 +14,29 @@ refdog_object_has_attributes: true skupper system uninstall [options] ~~~ -Remove the Skupper components. +Remove local system infrastructure. -This removes the router configuration, TLS certificates, and -systemd unit file for the current namespace. On Docker or -Podman, it also removes the containers for Skupper components. +This operation fails if sites are present. Use the +`--force` option to override. -
PlatformsDocker, Podman, Linux
+
PlatformsKubernetes, Docker, Podman, Linux
## Primary options -## Global options - - diff --git a/input/commands/token/issue.md b/input/commands/token/issue.md index 09f69b4..bcfa041 100644 --- a/input/commands/token/issue.md +++ b/input/commands/token/issue.md @@ -147,7 +147,7 @@ one. Set the kubeconfig context. -
PlatformsKubernetes
See alsoKubernetes kubeconfigs
+
See alsoKubernetes kubeconfigs
@@ -162,7 +162,7 @@ Set the kubeconfig context. Set the path to the kubeconfig file. -
PlatformsKubernetes
See alsoKubernetes kubeconfigs
+
See alsoKubernetes kubeconfigs
diff --git a/input/commands/token/redeem.md b/input/commands/token/redeem.md index 68cfb9a..afa661d 100644 --- a/input/commands/token/redeem.md +++ b/input/commands/token/redeem.md @@ -47,7 +47,7 @@ You can now safely delete /home/fritz/token.yaml. The name of the token file to use. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -63,7 +63,7 @@ Raise an error if the operation does not complete in the given period of time.
Default

60s

-
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -77,7 +77,7 @@ period of time. The link cost to use when creating the link. -
Default1
PlatformsKubernetes, Docker, Podman, Linux
See alsoLoad balancing
+
Default1
See alsoLoad balancing
@@ -124,7 +124,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -146,7 +146,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -161,7 +161,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/commands/version.md b/input/commands/version.md index 62eae96..f159685 100644 --- a/input/commands/version.md +++ b/input/commands/version.md @@ -59,7 +59,7 @@ Produce verbose structured output.
Choices
json

Produce JSON output

yaml

Produce YAML output

-
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -106,7 +106,7 @@ Set the path to the kubeconfig file. Set the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes namespaces, System namespaces
+
See alsoKubernetes namespaces, System namespaces
@@ -128,7 +128,7 @@ Set the Skupper platform. docker

Docker

podman

Podman

linux

Linux

-PlatformsKubernetes, Docker, Podman, LinuxSee alsoPlatform concept +See alsoPlatform concept @@ -143,7 +143,7 @@ Set the Skupper platform. Display help and exit. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/resources/access-grant.md b/input/resources/access-grant.md index fee733e..6a4dad8 100644 --- a/input/resources/access-grant.md +++ b/input/resources/access-grant.md @@ -35,7 +35,7 @@ status are used to generate access tokens from the grant. The name of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -49,7 +49,7 @@ The name of the resource. The namespace of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoPlatform concept, Kubernetes namespaces, System namespaces
+
See alsoPlatform concept, Kubernetes namespaces, System namespaces
@@ -66,7 +66,7 @@ The namespace of the resource. The number of times an access token for this grant can be redeemed. -
Default1
PlatformsKubernetes, Docker, Podman, Linux
+
Default1
@@ -82,7 +82,7 @@ The period of time in which an access token for this grant can be redeemed.
Default

15m

-
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -101,7 +101,7 @@ for redemption. If not set, a value is generated and placed in the `code` status property. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -119,7 +119,7 @@ certificate when redeeming a token for this grant. If not set, `defaultIssuer` on the Site rsource is used. -
PlatformsKubernetes
See alsoRouter TLS, Kubernetes TLS secrets
+
See alsoRouter TLS, Kubernetes TLS secrets
@@ -138,7 +138,7 @@ string name and a string value. **Note:** In general, we recommend not changing settings from their default values. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource settings
+
See alsoResource settings
@@ -159,7 +159,7 @@ The current state of the resource. `message` for more information. - `Ready`: The resource is ready to use. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -174,7 +174,7 @@ The current state of the resource. A human-readable status message. Error messages are reported here. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -189,7 +189,7 @@ here. The number of times a token for this grant has been redeemed. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -203,7 +203,7 @@ redeemed. The point in time when the grant expires. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -217,7 +217,7 @@ The point in time when the grant expires. The URL of the token-redemption service for this grant. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -232,7 +232,7 @@ The URL of the token-redemption service for this grant. The trusted server certificate of the token-redemption service for this grant. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -248,7 +248,7 @@ The secret code used to authenticate access tokens submitted for redemption.
Default

Generated

-
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -271,7 +271,7 @@ resource. - `Ready`: The grant is ready to use. All other conditions are true. -
PlatformsKubernetes
See alsoResource status, Kubernetes conditions
+
See alsoResource status, Kubernetes conditions
diff --git a/input/resources/access-token.md b/input/resources/access-token.md index 0f959fb..5c5cfb4 100644 --- a/input/resources/access-token.md +++ b/input/resources/access-token.md @@ -39,7 +39,7 @@ contains the URL and secret code of a corresponding access grant. The name of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -53,7 +53,7 @@ The name of the resource. The namespace of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoPlatform concept, Kubernetes namespaces, System namespaces
+
See alsoPlatform concept, Kubernetes namespaces, System namespaces
@@ -70,7 +70,7 @@ The namespace of the resource. The URL of the grant service at the remote site. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -86,7 +86,7 @@ The URL of the grant service at the remote site. The secret code used to authenticate the token when submitted for redemption. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -101,7 +101,7 @@ submitted for redemption. The trusted server certificate of the grant service at the remote site. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -115,7 +115,7 @@ remote site. The link cost to use when creating the link. -
Default1
PlatformsKubernetes, Docker, Podman, Linux
See alsoLoad balancing
+
Default1
See alsoLoad balancing
@@ -134,7 +134,7 @@ string name and a string value. **Note:** In general, we recommend not changing settings from their default values. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource settings
+
See alsoResource settings
@@ -151,7 +151,7 @@ their default values. True if the token has been redeemed. Once a token is redeemed, it cannot be used again. -
DefaultFalse
PlatformsKubernetes, Docker, Podman, Linux
+
DefaultFalse
@@ -170,7 +170,7 @@ The current state of the resource. `message` for more information. - `Ready`: The resource is ready to use. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -185,7 +185,7 @@ The current state of the resource. A human-readable status message. Error messages are reported here. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -204,7 +204,7 @@ resource. - `Redeemed`: The token has been exchanged for a link. -
PlatformsKubernetes
See alsoResource status, Kubernetes conditions
+
See alsoResource status, Kubernetes conditions
diff --git a/input/resources/attached-connector-binding.md b/input/resources/attached-connector-binding.md index 75a53de..a86d812 100644 --- a/input/resources/attached-connector-binding.md +++ b/input/resources/attached-connector-binding.md @@ -28,7 +28,7 @@ The name of the resource. The name must be the same as that of the associated AttachedConnector resource in the connector namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -42,7 +42,7 @@ AttachedConnector resource in the connector namespace. The namespace of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoPlatform concept, Kubernetes namespaces, System namespaces
+
See alsoPlatform concept, Kubernetes namespaces, System namespaces
@@ -60,7 +60,7 @@ The namespace of the resource. The name of the namespace where the associated AttachedConnector is located. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -78,7 +78,7 @@ connectors. To expose a local workload to a remote site, the remote listener and the local connector must have matching routing keys. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
See alsoRouting key concept
+
UpdatableTrue
See alsoRouting key concept
@@ -93,7 +93,7 @@ routing keys. If true, expose each pod as an individual service. -
DefaultFalse
PlatformsKubernetes
See alsoIndividual pod services
+
DefaultFalse
See alsoIndividual pod services
@@ -112,7 +112,7 @@ string name and a string value. **Note:** In general, we recommend not changing settings from their default values. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource settings
+
See alsoResource settings
@@ -133,7 +133,7 @@ The current state of the resource. `message` for more information. - `Ready`: The resource is ready to use. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -148,7 +148,7 @@ The current state of the resource. True if there is at least one listener with a matching routing key (usually in a remote site). -
DefaultFalse
PlatformsKubernetes, Docker, Podman, Linux
See alsoRouting key concept
+
DefaultFalse
See alsoRouting key concept
@@ -164,7 +164,7 @@ key (usually in a remote site). A set of named conditions describing the current state of the resource. -
PlatformsKubernetes
See alsoResource status, Kubernetes conditions
+
See alsoResource status, Kubernetes conditions
diff --git a/input/resources/attached-connector.md b/input/resources/attached-connector.md index 8eaec04..bd3ff0a 100644 --- a/input/resources/attached-connector.md +++ b/input/resources/attached-connector.md @@ -28,7 +28,7 @@ The name of the resource. The name must be the same as that of the associated AttachedConnectorBinding resource in the site namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -42,7 +42,7 @@ AttachedConnectorBinding resource in the site namespace. The namespace of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoPlatform concept, Kubernetes namespaces, System namespaces
+
See alsoPlatform concept, Kubernetes namespaces, System namespaces
@@ -60,7 +60,7 @@ The namespace of the resource. The name of the namespace in which the site this connector should be attached to is defined. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -75,7 +75,7 @@ should be attached to is defined. The port on the target server to connect to. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+
UpdatableTrue
@@ -93,7 +93,7 @@ uses `=` syntax. On Kubernetes, either `selector` or `host` is required. -
PlatformsKubernetes
UpdatableTrue
See alsoKubernetes label selectors
+
UpdatableTrue
See alsoKubernetes label selectors
@@ -108,7 +108,7 @@ On Kubernetes, either `selector` or `host` is required. If true, include server pods in the `NotReady` state. -
DefaultFalse
PlatformsKubernetes
+
DefaultFalse
@@ -130,7 +130,7 @@ On Kubernetes, the value is the name of a Secret in the current namespace. On Docker, Podman, and Linux, the value is the name of a directory under `input/certs/` in the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoApplication TLS, Kubernetes TLS secrets, System TLS credentials
+
See alsoApplication TLS, Kubernetes TLS secrets, System TLS credentials
@@ -149,7 +149,7 @@ string name and a string value. **Note:** In general, we recommend not changing settings from their default values. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource settings
+
See alsoResource settings
@@ -170,7 +170,7 @@ The current state of the resource. `message` for more information. - `Ready`: The resource is ready to use. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -186,7 +186,7 @@ The current state of the resource. A set of named conditions describing the current state of the resource. -
PlatformsKubernetes
See alsoResource status, Kubernetes conditions
+
See alsoResource status, Kubernetes conditions
@@ -199,7 +199,7 @@ resource.
-
PlatformsKubernetes, Docker, Podman, Linux
+
diff --git a/input/resources/connector.md b/input/resources/connector.md index 422cd5c..d478dca 100644 --- a/input/resources/connector.md +++ b/input/resources/connector.md @@ -53,7 +53,7 @@ spec: The name of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -67,7 +67,7 @@ The name of the resource. The namespace of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoPlatform concept, Kubernetes namespaces, System namespaces
+
See alsoPlatform concept, Kubernetes namespaces, System namespaces
@@ -87,7 +87,7 @@ connectors. To expose a local workload to a remote site, the remote listener and the local connector must have matching routing keys. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
See alsoRouting key concept
+
UpdatableTrue
See alsoRouting key concept
@@ -102,7 +102,7 @@ routing keys. The port on the target server to connect to. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+
UpdatableTrue
@@ -120,7 +120,7 @@ uses `=` syntax. On Kubernetes, either `selector` or `host` is required. -
PlatformsKubernetes
UpdatableTrue
See alsoKubernetes label selectors
+
UpdatableTrue
See alsoKubernetes label selectors
@@ -140,7 +140,7 @@ On Kubernetes, either `selector` or `host` is required. On Docker, Podman, or Linux, `host` is required. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+
UpdatableTrue
@@ -155,7 +155,7 @@ On Docker, Podman, or Linux, `host` is required. If true, include server pods in the `NotReady` state. -
DefaultFalse
PlatformsKubernetes
+
DefaultFalse
@@ -170,7 +170,7 @@ If true, include server pods in the `NotReady` state. If true, expose each pod as an individual service. -
DefaultFalse
PlatformsKubernetes
See alsoIndividual pod services
+
DefaultFalse
See alsoIndividual pod services
@@ -192,7 +192,7 @@ On Kubernetes, the value is the name of a Secret in the current namespace. On Docker, Podman, and Linux, the value is the name of a directory under `input/certs/` in the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoApplication TLS, Kubernetes TLS secrets, System TLS credentials
+
See alsoApplication TLS, Kubernetes TLS secrets, System TLS credentials
@@ -208,7 +208,7 @@ a directory under `input/certs/` in the current namespace. Send the client certificate when connecting in order to enable mutual TLS. -
DefaultFalse
PlatformsKubernetes, Docker, Podman, Linux
See alsoApplication TLS
+
DefaultFalse
See alsoApplication TLS
@@ -224,7 +224,7 @@ mutual TLS. If true, require that the hostname of the server connected to matches the hostname in the server's certificate. -
DefaultFalse
PlatformsKubernetes, Docker, Podman, Linux
See alsoApplication TLS
+
DefaultFalse
See alsoApplication TLS
@@ -243,7 +243,7 @@ string name and a string value. **Note:** In general, we recommend not changing settings from their default values. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource settings
+
See alsoResource settings
@@ -264,7 +264,7 @@ The current state of the resource. `message` for more information. - `Ready`: The resource is ready to use. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -279,7 +279,7 @@ The current state of the resource. A human-readable status message. Error messages are reported here. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -294,7 +294,7 @@ here. True if there is at least one listener with a matching routing key (usually in a remote site). -
DefaultFalse
PlatformsKubernetes, Docker, Podman, Linux
See alsoRouting key concept
+
DefaultFalse
See alsoRouting key concept
@@ -317,7 +317,7 @@ resource. - `Ready`: The connector is ready to use. All other conditions are true. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -330,7 +330,7 @@ resource.
-
PlatformsKubernetes, Docker, Podman, Linux
+
diff --git a/input/resources/link.md b/input/resources/link.md index 8ff7ab6..64b2eea 100644 --- a/input/resources/link.md +++ b/input/resources/link.md @@ -41,7 +41,7 @@ use an [access token][token] to obtain a link. The name of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -55,7 +55,7 @@ The name of the resource. The namespace of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoPlatform concept, Kubernetes namespaces, System namespaces
+
See alsoPlatform concept, Kubernetes namespaces, System namespaces
@@ -73,7 +73,7 @@ The namespace of the resource. An array of connection endpoints. Each item has a name, host, port, and group. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -88,7 +88,7 @@ port, and group. The configured routing cost of sending traffic over the link. -
Default1
PlatformsKubernetes, Docker, Podman, Linux
See alsoLoad balancing
+
Default1
See alsoLoad balancing
@@ -111,7 +111,7 @@ current namespace. On Docker, Podman, and Linux, the value is the name of a directory under `input/certs/` in the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoRouter TLS, Kubernetes TLS secrets, System TLS credentials
+
See alsoRouter TLS, Kubernetes TLS secrets, System TLS credentials
@@ -130,7 +130,7 @@ string name and a string value. **Note:** In general, we recommend not changing settings from their default values. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource settings
+
See alsoResource settings
@@ -151,7 +151,7 @@ The current state of the resource. `message` for more information. - `Ready`: The resource is ready to use. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -166,7 +166,7 @@ The current state of the resource. A human-readable status message. Error messages are reported here. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -180,7 +180,7 @@ here. The unique ID of the site linked to. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -194,7 +194,7 @@ The unique ID of the site linked to. The name of the site linked to. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -217,7 +217,7 @@ resource. - `Ready`: The link is ready to use. All other conditions are true. -
PlatformsKubernetes
See alsoResource status, Kubernetes conditions
+
See alsoResource status, Kubernetes conditions
diff --git a/input/resources/listener.md b/input/resources/listener.md index 65446ff..8baf8d6 100644 --- a/input/resources/listener.md +++ b/input/resources/listener.md @@ -51,7 +51,7 @@ spec: The name of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -65,7 +65,7 @@ The name of the resource. The namespace of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoPlatform concept, Kubernetes namespaces, System namespaces
+
See alsoPlatform concept, Kubernetes namespaces, System namespaces
@@ -85,7 +85,7 @@ connectors. To enable connecting to a service at a remote site, the local listener and the remote connector must have matching routing keys. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
See alsoRouting key concept
+
UpdatableTrue
See alsoRouting key concept
@@ -102,7 +102,7 @@ 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. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+
UpdatableTrue
@@ -119,7 +119,7 @@ The port of the local listener. Clients at this site use the listener host and port to establish connections to the remote service. -
PlatformsKubernetes, Docker, Podman, Linux
UpdatableTrue
+
UpdatableTrue
@@ -134,7 +134,7 @@ the remote service. If true, expose each pod as an individual service. -
DefaultFalse
PlatformsKubernetes
See alsoIndividual pod services
+
DefaultFalse
See alsoIndividual pod services
@@ -157,7 +157,7 @@ current namespace. On Docker, Podman, and Linux, the value is the name of a directory under `input/certs/` in the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoApplication TLS, Kubernetes TLS secrets, System TLS credentials
+
See alsoApplication TLS, Kubernetes TLS secrets, System TLS credentials
@@ -181,7 +181,7 @@ their default values. traffic metrics.
Default: `auto`. Choices: `auto`, `none`, `http1`, `http2`. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource settings
+
See alsoResource settings
@@ -202,7 +202,7 @@ The current state of the resource. `message` for more information. - `Ready`: The resource is ready to use. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -217,7 +217,7 @@ The current state of the resource. A human-readable status message. Error messages are reported here. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -232,7 +232,7 @@ here. True if there is at least one connector with a matching routing key (usually in a remote site). -
DefaultFalse
PlatformsKubernetes, Docker, Podman, Linux
See alsoRouting key concept
+
DefaultFalse
See alsoRouting key concept
@@ -256,7 +256,7 @@ resource. - `Ready`: The listener is ready to use. All other conditions are true. -
PlatformsKubernetes
See alsoResource status, Kubernetes conditions
+
See alsoResource status, Kubernetes conditions
diff --git a/input/resources/router-access.md b/input/resources/router-access.md index b0935d0..c1f4d74 100644 --- a/input/resources/router-access.md +++ b/input/resources/router-access.md @@ -28,7 +28,7 @@ RouterAccess resource is used to implement link access for sites. The name of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -42,7 +42,7 @@ The name of the resource. The namespace of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoPlatform concept, Kubernetes namespaces, System namespaces
+
See alsoPlatform concept, Kubernetes namespaces, System namespaces
@@ -61,7 +61,7 @@ The named interfaces by which a router can be accessed. These include "inter-router" for links between interior routers and "edge" for links from edge routers to interior routers. -
PlatformsKubernetes, Docker, Podman, Linux
+ @@ -85,7 +85,7 @@ current namespace. On Docker, Podman, and Linux, the value is the name of a directory under `input/certs/` in the current namespace. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoRouter TLS, Kubernetes TLS secrets, System TLS credentials
+
See alsoRouter TLS, Kubernetes TLS secrets, System TLS credentials
@@ -97,7 +97,7 @@ directory under `input/certs/` in the current namespace.
-
DefaultFalse
PlatformsKubernetes, Docker, Podman, Linux
+
DefaultFalse
@@ -109,7 +109,7 @@ directory under `input/certs/` in the current namespace.
-
PlatformsKubernetes, Docker, Podman, Linux
+
@@ -125,7 +125,7 @@ directory under `input/certs/` in the current namespace. Kubernetes flavors, the default is loadbalancer.

Choices
route

Use an OpenShift route. OpenShift only.

loadbalancer

Use a Kubernetes load balancer.

-
PlatformsKubernetes + @@ -141,7 +141,7 @@ The hostname or IP address of the network interface to bind to. By default, Skupper binds all the interfaces on the host.
Default

0.0.0.0

-
PlatformsDocker, Podman, Linux
+ @@ -157,7 +157,7 @@ The hostnames and IPs secured by the router TLS certificate.
Default

The current hostname and the IP address of each bound network interface

-
PlatformsDocker, Podman, Linux
+ @@ -176,7 +176,7 @@ string name and a string value. **Note:** In general, we recommend not changing settings from their default values. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource settings
+
See alsoResource settings
@@ -197,7 +197,7 @@ The current state of the resource. `message` for more information. - `Ready`: The resource is ready to use. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -212,7 +212,7 @@ The current state of the resource. A human-readable status message. Error messages are reported here. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -235,7 +235,7 @@ resource. - `Ready`: The router access is ready to use. All other conditions are true. -
PlatformsKubernetes
See alsoResource status, Kubernetes conditions
+
See alsoResource status, Kubernetes conditions
@@ -251,7 +251,7 @@ resource. An array of connection endpoints. Each item has a name, host, port, and group. -
PlatformsKubernetes, Docker, Podman, Linux
+ diff --git a/input/resources/site.md b/input/resources/site.md index 9585f36..9688faa 100644 --- a/input/resources/site.md +++ b/input/resources/site.md @@ -57,7 +57,7 @@ spec: The name of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoKubernetes object names
+
See alsoKubernetes object names
@@ -71,7 +71,7 @@ The name of the resource. The namespace of the resource. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoPlatform concept, Kubernetes namespaces, System namespaces
+
See alsoPlatform concept, Kubernetes namespaces, System namespaces
@@ -97,7 +97,7 @@ the sites must have link access enabled. default

Use the default link access for the current platform. On OpenShift, the default is route. For other Kubernetes flavors, the default is loadbalancer.

route

Use an OpenShift route. OpenShift only.

loadbalancer

Use a Kubernetes load balancer.

-PlatformsKubernetes, Docker, Podman, LinuxUpdatableTrueSee alsoLink concept, Site linking +UpdatableTrueSee alsoLink concept, Site linking @@ -117,7 +117,7 @@ after failure. This already provides a high level of availability. Enabling HA goes further and reduces the window of downtime caused by restarts. -
DefaultFalse
PlatformsKubernetes
UpdatableTrue
See alsoHigh availability
+
DefaultFalse
UpdatableTrue
See alsoHigh availability
@@ -138,7 +138,7 @@ This issuer is used by AccessGrant and RouterAccess if a specific issuer is not set.
Default

skupper-site-ca

-
PlatformsKubernetes
UpdatableTrue
See alsoRouter TLS, Kubernetes TLS secrets
+UpdatableTrueSee alsoRouter TLS, Kubernetes TLS secrets @@ -164,7 +164,7 @@ Currently, edge sites cannot also have HA enabled. "VAN ID" that enables multiple VANs to operate on shared router infrastructure. --> -
DefaultFalse
PlatformsKubernetes, Docker, Podman, Linux
See alsoLarge networks
+
DefaultFalse
See alsoLarge networks
@@ -182,7 +182,7 @@ the Skupper router. A service account is generated if none is specified.
Default

Generated

-
PlatformsKubernetes
See alsoKubernetes service accounts
+See alsoKubernetes service accounts @@ -210,7 +210,7 @@ their default values. - `routerLogging`: Set the router logging level.
Default: `info`. Choices: `info`, `warning`, `error`. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource settings
+
See alsoResource settings
@@ -231,7 +231,7 @@ The current state of the resource. `message` for more information. - `Ready`: The resource is ready to use. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -246,7 +246,7 @@ The current state of the resource. A human-readable status message. Error messages are reported here. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoResource status
+
See alsoResource status
@@ -271,7 +271,7 @@ resource. - `Ready`: The site is ready for use. All other conditions are true. -
PlatformsKubernetes
See alsoResource status, Kubernetes conditions
+
See alsoResource status, Kubernetes conditions
@@ -287,7 +287,7 @@ resource. The name of the Kubernetes secret containing the active default signing CA. -
PlatformsKubernetes
See alsoRouter TLS, Kubernetes TLS secrets
+
See alsoRouter TLS, Kubernetes TLS secrets
@@ -305,7 +305,7 @@ port, and group. These include connection endpoints for link access. -
PlatformsKubernetes, Docker, Podman, Linux
See alsoLink concept, Site linking
+
See alsoLink concept, Site linking
@@ -318,7 +318,7 @@ These include connection endpoints for link access.
-
PlatformsKubernetes, Docker, Podman, Linux
+
@@ -331,7 +331,7 @@ These include connection endpoints for link access.
-
PlatformsKubernetes, Docker, Podman, Linux
See alsoNetwork concept
+
See alsoNetwork concept
diff --git a/python/common.py b/python/common.py index 9d969ee..54361a8 100644 --- a/python/common.py +++ b/python/common.py @@ -79,7 +79,9 @@ def generate_attribute_fields(attr): if attr.choices: rows.append(f"Choices{generate_attribute_choices(attr)}") - if attr.platforms: + from commands import Option + + if attr.platforms and isinstance(attr, Option) and attr.platforms != attr.object.platforms: rows.append(f"Platforms{', '.join(attr.platforms)}") if attr.updatable: