Connector generate command

skupper connector generate <name> <port> [options]

Generate a Connector resource.

PlatformsKubernetes, Docker, Podman, Linux

Examples

# Generate a Connector resource and print it to the console
$ skupper connector generate backend 8080
apiVersion: skupper.io/v2alpha1
kind: Connector
metadata:
  name: backend
spec:
  routingKey: backend
  port: 8080
  selector: app=backend

# Generate a Connector resource and direct the output to a file
$ skupper connector generate backend 8080 > backend.yaml

Primary options

<name>

string
required

The name of the resource to be generated.

See alsoKubernetes object names

<port>

integer
required

The port on the target server to connect to.

UpdatableTrue

--routing-key

<string>
frequently used

The identifier used to route traffic from listeners to connectors. To expose a local workload to a remote site, the remote listener and the local connector must have matching routing keys.

Default

Value of name

UpdatableTrue

--workload

<resource>
frequently used

A Kubernetes resource name that identifies a workload. It uses <resource-type>/<resource-name> syntax and resolves to an equivalent pod selector.

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

PlatformsKubernetes
See alsoKubernetes workloads

--selector

<string>

A Kubernetes label selector for specifying target server pods. It uses <label-name>=<label-value> syntax.

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

Default

app=[value-of-name]

PlatformsKubernetes
UpdatableTrue
See alsoKubernetes label selectors

--host

<string>

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

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

Default

On Kubernetes: Value of name
On Docker, Podman, and Linux: localhost

UpdatableTrue

--wait

<status>

Wait for the given status before exiting.

Default

configured

Choices
none

Do not wait

configured

Configured

ready

Ready

--output

(-o) <format>

Select the output format.

Default

yaml

Choices
json

Produce JSON output

yaml

Produce YAML output

Global options