Listener resource
A connection endpoint for communicating with workloads in remote sites.
Each site can have multiple listener definitions.
apiVersion: skupper.io/v2alpha1
kind: Listener
Examples
A listener in site West for the Hello World backend service in site East:
apiVersion: skupper.io/v2alpha1
kind: Listener
metadata:
name: backend
namespace: hello-world-west
spec:
routingKey: backend
port: 8080
host: backend
Metadata properties
name
The name of the resource.
Platforms | Kubernetes, Docker, Podman, Linux |
---|
namespace
The namespace of the resource.
Platforms | Kubernetes, Docker, Podman, Linux |
---|---|
See also | Kubernetes namespaces |
Spec properties
routingKey
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, Podman, Linux |
---|---|
See also | Routing key concept |
host
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, Podman, Linux |
---|
port
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 |
---|
tlsCredentials
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 |
settings
A map containing additional settings. Each map entry is a string name and a string value.
observer
- Set the protocol observer used to generate traffic metrics.
Default:auto
. Choices:auto
,none
,http1
,http2
.
Platforms | Kubernetes, Docker, Podman, Linux |
---|
Status properties
status
The current state of the resource.
- Pending
- Ready
Platforms | Kubernetes, Docker, Podman, Linux |
---|
message
A human-readable status message.
Platforms | Kubernetes, Docker, Podman, Linux |
---|
hasMatchingConnectors
Default | False |
---|---|
Platforms | Kubernetes, Docker, Podman, Linux |
conditions
A set of named conditions describing the current state of the resource.
Platforms | Kubernetes |
---|---|
See also | Kubernetes conditions |