Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
ssorj committed Jun 9, 2024
1 parent 95c8d77 commit ae86aee
Show file tree
Hide file tree
Showing 33 changed files with 225 additions and 209 deletions.
6 changes: 5 additions & 1 deletion config/resources.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,11 @@ groups:
The port on the target workload to forward traffic to.
- name: selector
description: |
A Kubernetes label selector for specifying target pods.
A Kubernetes label selector for specifying target server
pods.
On Kubernetes, you usually want to use this. As an
alternative, you can use `host`.
links:
- name: Kubernetes label selectors
url: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
Expand Down
34 changes: 19 additions & 15 deletions input/commands/connector-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ skupper connector create backend 8080 --output yaml

## Options

- <h4 id="name">name <span class="argument-info">string, required</span></h3>
- <h4 id="name">name <span class="argument-info">string, required</span></h4>

The name of the connector resource.

- <h4 id="port">port <span class="argument-info">integer, required</span></h3>
- <h4 id="port">port <span class="argument-info">integer, required</span></h4>

The port on the target workload to forward traffic to.

- <h4 id="routing-key">--routing-key <span class="argument-info">string</span></h3>
- <h4 id="routing-key">--routing-key <span class="argument-info">string</span></h4>

The identifier used to route traffic from listeners to
connectors. To expose a local workload to a remote
Expand All @@ -69,15 +69,19 @@ skupper connector create backend 8080 --output yaml

_See also:_ [Routing key concept]({{site_prefix}}/concepts/routing-key.html)

- <h4 id="selector">--selector <span class="argument-info">string</span></h3>
- <h4 id="selector">--selector <span class="argument-info">string</span></h4>

A Kubernetes label selector for specifying target pods.
A Kubernetes label selector for specifying target server
pods.

On Kubernetes, you usually want to use this. As an
alternative, you can use `host`.

_Default:_ `app=<value-of-name>`

_See also:_ [Kubernetes label selectors]({{site_prefix}}https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors), [Kubernetes pods]({{site_prefix}}https://kubernetes.io/docs/concepts/workloads/pods/)

- <h4 id="workload">--workload <span class="argument-info">string (resource name)</span></h3>
- <h4 id="workload">--workload <span class="argument-info">string (resource name)</span></h4>

A Kubernetes resource name that identifies a workload.
It resolves to an equivalent pod selector.
Expand All @@ -87,14 +91,14 @@ skupper connector create backend 8080 --output yaml

_See also:_ [Kubernetes workloads]({{site_prefix}}https://kubernetes.io/docs/concepts/workloads/)

- <h4 id="host">--host <span class="argument-info">string</span></h3>
- <h4 id="host">--host <span class="argument-info">string</span></h4>

The hostname or IP address of the server.

This is an alternative to setting the `--selector` or
`--workload` options.

- <h4 id="tls-secret">--tls-secret <span class="argument-info">string</span></h3>
- <h4 id="tls-secret">--tls-secret <span class="argument-info">string</span></h4>

The name of a Kubernetes secret containing the trusted
server certificate (typically a CA).
Expand All @@ -107,20 +111,20 @@ skupper connector create backend 8080 --output yaml

_See also:_ [TLS re-encrypt]({{site_prefix}})

- <h4 id="type">--type <span class="argument-info">string</span></h3>
- <h4 id="type">--type <span class="argument-info">string</span></h4>

The connector type.

_Default:_ `tcp`

- <h4 id="include-not-ready">--include-not-ready <span class="argument-info">boolean</span></h3>
- <h4 id="include-not-ready">--include-not-ready <span class="argument-info">boolean</span></h4>

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

### Output options

- <h4 id="output">--output <span class="argument-info">string</span></h3>
- <h4 id="output">--output <span class="argument-info">string</span></h4>

Print resources to the console instead of submitting
them to the Skupper controller.
Expand All @@ -132,21 +136,21 @@ skupper connector create backend 8080 --output yaml

### Context options

- <h4 id="namespace">--namespace <span class="argument-info">string</span></h3>
- <h4 id="namespace">--namespace <span class="argument-info">string</span></h4>

Select the current namespace.

- <h4 id="context">--context <span class="argument-info">string</span></h3>
- <h4 id="context">--context <span class="argument-info">string</span></h4>

Select the current kubeconfig context.

- <h4 id="platform">--platform <span class="argument-info">string</span></h3>
- <h4 id="platform">--platform <span class="argument-info">string</span></h4>

Select the current Skupper platform.

### Global options

- <h4 id="help">--help <span class="argument-info">None</span></h3>
- <h4 id="help">--help <span class="argument-info">None</span></h4>

Display help and exit.

Expand Down
10 changes: 5 additions & 5 deletions input/commands/connector-delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,27 +33,27 @@ Connector "<name>" is deleted.

## Options

- <h4 id="name">name <span class="argument-info">string, required</span></h3>
- <h4 id="name">name <span class="argument-info">string, required</span></h4>

The name of the connector resource.

### Context options

- <h4 id="namespace">--namespace <span class="argument-info">string</span></h3>
- <h4 id="namespace">--namespace <span class="argument-info">string</span></h4>

Select the current namespace.

- <h4 id="context">--context <span class="argument-info">string</span></h3>
- <h4 id="context">--context <span class="argument-info">string</span></h4>

Select the current kubeconfig context.

- <h4 id="platform">--platform <span class="argument-info">string</span></h3>
- <h4 id="platform">--platform <span class="argument-info">string</span></h4>

Select the current Skupper platform.

### Global options

- <h4 id="help">--help <span class="argument-info">None</span></h3>
- <h4 id="help">--help <span class="argument-info">None</span></h4>

Display help and exit.

Expand Down
34 changes: 19 additions & 15 deletions input/commands/connector-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ skupper connector update frontend --port 9090 --output yaml

## Options

- <h4 id="name">name <span class="argument-info">string, required</span></h3>
- <h4 id="name">name <span class="argument-info">string, required</span></h4>

The name of the connector resource.

- <h4 id="port">--port <span class="argument-info">integer</span></h3>
- <h4 id="port">--port <span class="argument-info">integer</span></h4>

The port on the target workload to forward traffic to.

- <h4 id="routing-key">--routing-key <span class="argument-info">string</span></h3>
- <h4 id="routing-key">--routing-key <span class="argument-info">string</span></h4>

The identifier used to route traffic from listeners to
connectors. To expose a local workload to a remote
Expand All @@ -69,15 +69,19 @@ skupper connector update frontend --port 9090 --output yaml

_See also:_ [Routing key concept]({{site_prefix}}/concepts/routing-key.html)

- <h4 id="selector">--selector <span class="argument-info">string</span></h3>
- <h4 id="selector">--selector <span class="argument-info">string</span></h4>

A Kubernetes label selector for specifying target pods.
A Kubernetes label selector for specifying target server
pods.

On Kubernetes, you usually want to use this. As an
alternative, you can use `host`.

_Default:_ `app=<value-of-name>`

_See also:_ [Kubernetes label selectors]({{site_prefix}}https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors), [Kubernetes pods]({{site_prefix}}https://kubernetes.io/docs/concepts/workloads/pods/)

- <h4 id="workload">--workload <span class="argument-info">string (resource name)</span></h3>
- <h4 id="workload">--workload <span class="argument-info">string (resource name)</span></h4>

A Kubernetes resource name that identifies a workload.
It resolves to an equivalent pod selector.
Expand All @@ -87,14 +91,14 @@ skupper connector update frontend --port 9090 --output yaml

_See also:_ [Kubernetes workloads]({{site_prefix}}https://kubernetes.io/docs/concepts/workloads/)

- <h4 id="host">--host <span class="argument-info">string</span></h3>
- <h4 id="host">--host <span class="argument-info">string</span></h4>

The hostname or IP address of the server.

This is an alternative to setting the `--selector` or
`--workload` options.

- <h4 id="tls-secret">--tls-secret <span class="argument-info">string</span></h3>
- <h4 id="tls-secret">--tls-secret <span class="argument-info">string</span></h4>

The name of a Kubernetes secret containing the trusted
server certificate (typically a CA).
Expand All @@ -107,20 +111,20 @@ skupper connector update frontend --port 9090 --output yaml

_See also:_ [TLS re-encrypt]({{site_prefix}})

- <h4 id="type">--type <span class="argument-info">string</span></h3>
- <h4 id="type">--type <span class="argument-info">string</span></h4>

The connector type.

_Default:_ `tcp`

- <h4 id="include-not-ready">--include-not-ready <span class="argument-info">boolean</span></h3>
- <h4 id="include-not-ready">--include-not-ready <span class="argument-info">boolean</span></h4>

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

### Output options

- <h4 id="output">--output <span class="argument-info">string</span></h3>
- <h4 id="output">--output <span class="argument-info">string</span></h4>

Print resources to the console instead of submitting
them to the Skupper controller.
Expand All @@ -132,21 +136,21 @@ skupper connector update frontend --port 9090 --output yaml

### Context options

- <h4 id="namespace">--namespace <span class="argument-info">string</span></h3>
- <h4 id="namespace">--namespace <span class="argument-info">string</span></h4>

Select the current namespace.

- <h4 id="context">--context <span class="argument-info">string</span></h3>
- <h4 id="context">--context <span class="argument-info">string</span></h4>

Select the current kubeconfig context.

- <h4 id="platform">--platform <span class="argument-info">string</span></h3>
- <h4 id="platform">--platform <span class="argument-info">string</span></h4>

Select the current Skupper platform.

### Global options

- <h4 id="help">--help <span class="argument-info">None</span></h3>
- <h4 id="help">--help <span class="argument-info">None</span></h4>

Display help and exit.

Expand Down
2 changes: 1 addition & 1 deletion input/commands/connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Display help for connector commands and exit.

### Global options

- <h4 id="help">--help <span class="argument-info">None</span></h3>
- <h4 id="help">--help <span class="argument-info">None</span></h4>

Display help and exit.

Expand Down
8 changes: 4 additions & 4 deletions input/commands/grant-delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,21 @@ links:

### Context options

- <h4 id="namespace">--namespace <span class="argument-info">string</span></h3>
- <h4 id="namespace">--namespace <span class="argument-info">string</span></h4>

Select the current namespace.

- <h4 id="context">--context <span class="argument-info">string</span></h3>
- <h4 id="context">--context <span class="argument-info">string</span></h4>

Select the current kubeconfig context.

- <h4 id="platform">--platform <span class="argument-info">string</span></h3>
- <h4 id="platform">--platform <span class="argument-info">string</span></h4>

Select the current Skupper platform.

### Global options

- <h4 id="help">--help <span class="argument-info">None</span></h3>
- <h4 id="help">--help <span class="argument-info">None</span></h4>

Display help and exit.

Expand Down
10 changes: 5 additions & 5 deletions input/commands/grant-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ links:

### Output options

- <h4 id="output">--output <span class="argument-info">string</span></h3>
- <h4 id="output">--output <span class="argument-info">string</span></h4>

Print resources to the console instead of submitting
them to the Skupper controller.
Expand All @@ -31,21 +31,21 @@ links:

### Context options

- <h4 id="namespace">--namespace <span class="argument-info">string</span></h3>
- <h4 id="namespace">--namespace <span class="argument-info">string</span></h4>

Select the current namespace.

- <h4 id="context">--context <span class="argument-info">string</span></h3>
- <h4 id="context">--context <span class="argument-info">string</span></h4>

Select the current kubeconfig context.

- <h4 id="platform">--platform <span class="argument-info">string</span></h3>
- <h4 id="platform">--platform <span class="argument-info">string</span></h4>

Select the current Skupper platform.

### Global options

- <h4 id="help">--help <span class="argument-info">None</span></h3>
- <h4 id="help">--help <span class="argument-info">None</span></h4>

Display help and exit.

Expand Down
2 changes: 1 addition & 1 deletion input/commands/grant.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ links:

### Global options

- <h4 id="help">--help <span class="argument-info">None</span></h3>
- <h4 id="help">--help <span class="argument-info">None</span></h4>

Display help and exit.

Expand Down
8 changes: 4 additions & 4 deletions input/commands/link-delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,21 @@ $ skupper link delete <name>

### Context options

- <h4 id="namespace">--namespace <span class="argument-info">string</span></h3>
- <h4 id="namespace">--namespace <span class="argument-info">string</span></h4>

Select the current namespace.

- <h4 id="context">--context <span class="argument-info">string</span></h3>
- <h4 id="context">--context <span class="argument-info">string</span></h4>

Select the current kubeconfig context.

- <h4 id="platform">--platform <span class="argument-info">string</span></h3>
- <h4 id="platform">--platform <span class="argument-info">string</span></h4>

Select the current Skupper platform.

### Global options

- <h4 id="help">--help <span class="argument-info">None</span></h3>
- <h4 id="help">--help <span class="argument-info">None</span></h4>

Display help and exit.

Expand Down
Loading

0 comments on commit ae86aee

Please sign in to comment.