Listener resource

Binds target workloads in the local site to listeners in remote sites.

Each site can have multiple listener definitions.

apiVersion: skupper.io/v1alpha1
kind: Listener
metadata:  # Metadata properties
spec:      # Spec properties
status:    # Status properties

Examples

A listener in site West for the Hello World backend service in site East:

apiVersion: skupper.io/v1alpha1
kind: Listener
metadata:
  name: backend
  namespace: hello-world-west
spec:
  routingKey: backend
  port: 8080
  host: backend

Metadata properties

• name string, required

  The name of the resource.

  Platforms	Kubernetes, Docker
  See also	Kubernetes object names

• namespace string

  The namespace of the resource.

  Platforms	Kubernetes, Docker
  See also	Namespace concept, Kubernetes namespaces

Spec properties

• routingKey string, required

  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.

  Platforms	Kubernetes, Docker
  See also	Routing key concept

• host string, required

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

  Platforms	Kubernetes, Docker

• 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

• tlsSecret string

  The name of a Kubernetes secret containing TLS credentials. The secret contains the trusted server certificate (typically a CA).

  It can optionally include a client certificate and key for mutual TLS.

  This option is used when setting up router-to-server TLS encryption.

  Platforms	Kubernetes, Docker
  See also	Site-scoped TLS

• type string

  The listener type.

  Default	tcp
  Platforms	Kubernetes, Docker

• options object

  Additional settings.

  Platforms	Kubernetes, Docker

Status properties

• status string

  The current state of the resource.

  Platforms	Kubernetes, Docker

• active boolean

  This thing is working.

  Default	False
  Platforms	Kubernetes, Docker