Connector resource
Binds local workloads to listeners in remote sites.
Each site can have multiple connector resources.
apiVersion: skupper.io/v2alpha1
kind: Connector
Examples
A connector in site East for the Hello World backend service:
apiVersion: skupper.io/v2alpha1
kind: Connector
metadata:
name: backend
namespace: hello-world-east
spec:
routingKey: backend
port: 8080
selector: app=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 expose a local workload to a remote site, the remote listener and the local connector must have matching routing keys.
| Platforms | Kubernetes, Docker, Podman, Linux |
|---|---|
| See also | Routing key concept |
port
The port on the target workload to forward traffic to.
| Platforms | Kubernetes, Docker, Podman, Linux |
|---|
selector
A Kubernetes label selector for specifying target server pods.
On Kubernetes, you usually want to use this. As an alternative,
you can use host.
| Platforms | Kubernetes |
|---|
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 router-to-server TLS authentication and encryption.
| Platforms | Kubernetes, Docker, Podman, Linux |
|---|---|
| See also | Site-scoped TLS, Kubernetes TLS secrets |
host
The hostname or IP address of the server. This is an
alternative to selector for specifying the target server.
| Platforms | Kubernetes, Docker, Podman, Linux |
|---|
includeNotReady
If set, include server pods that are not in the ready state.
| Default | False |
|---|---|
| Platforms | Kubernetes |
useClientCert
Send the client certificate when connecting in order to enable mutual TLS.
| Default | False |
|---|---|
| Platforms | Kubernetes, Docker, Podman, Linux |
| See also | Site-scoped TLS |
verifyHostname
If true, require that the hostname of the server connected to matches the hostname in the server's certificate.
| Default | False |
|---|---|
| Platforms | Kubernetes, Docker, Podman, Linux |
settings
A map containing additional settings. Each map entry is a string name and a string value.
| 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 |
|---|
hasMatchingListeners
| Default | False |
|---|---|
| Platforms | Kubernetes, Docker, Podman, Linux |
selectedPods
| Platforms | Kubernetes, Docker, Podman, Linux |
|---|
conditions
A set of named conditions describing the current state of the resource.
| Platforms | Kubernetes |
|---|---|
| See also | Kubernetes conditions |