Listener generate command

Generate a Listener resource.

Platforms	Kubernetes, Docker, Podman, Linux

Usage

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

Examples

# Generate a Listener resource and print it to the console
$ skupper listener generate backend 8080
apiVersion: skupper.io/v2alpha1
kind: Listener
metadata:
  name: backend
spec:
  routingKey: backend
  port: 8080
  host: backend

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

Primary options

<name>

string

required

The name of the resource to be generated.

Platforms	Kubernetes, Docker, Podman, Linux
See also	Kubernetes object names

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

Platforms	Kubernetes, Docker, Podman, Linux

--routing-key

frequently used

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

Default	Value of name
Platforms	Kubernetes, Docker, Podman, Linux
See also	Routing key concept

--host

frequently used

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.

Default	Value of name
Platforms	Kubernetes, Docker, Podman, Linux

--wait

Wait for the given status before exiting.

Default

configured

Choices

`pending`	Pending
`configured`	Configured
`ready`	Ready

Platforms Kubernetes, Docker, Podman, Linux

--output

(-o) <format>

Select the output format.

Default

yaml

Choices

`json`	Produce JSON output
`yaml`	Produce YAML output

Platforms Kubernetes, Docker, Podman, Linux

--tls-credentials

advanced

A named bundle of TLS certificates and keys used for secure application-to-router communication. The bundle contains the trusted server certificate. It optionally includes a client certificate and key for mutual TLS.

On Kubernetes, the value is the name of a Secret in the current namespace.

This option is used when setting up client-to-router TLS authentication and encryption.

Platforms	Kubernetes, Docker, Podman, Linux
See also	Site-scoped TLS, Kubernetes TLS secrets

Global options

--platform

global

Set the Skupper platform.

Default

kubernetes

Choices

`kubernetes`	Kubernetes
`docker`	Docker
`podman`	Podman
`linux`	Linux

Platforms Kubernetes, Docker, Podman, Linux

--help

(-h) boolean

global

Display help and exit.

Platforms	Kubernetes, Docker, Podman, Linux