Connector resource

Binds a connection endpoint in the local site to target workloads in remote sites.

Each site can have multiple connector resources.

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

Examples

A connector in site East for the Hello World backend service:

apiVersion: skupper.io/v1alpha1
kind: Connector
metadata:
  name: backend
  namespace: hello-world-east
spec:
  routingKey: backend
  port: 8080
  selector: app=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 expose a local workload to a remote site, the remote listener and the local connector must have matching routing keys.

  Platforms	Kubernetes, Docker
  See also	Routing key concept

• port integer, required

  The port on the target workload to forward traffic to.

  Platforms	Kubernetes, Docker

• selector string

  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
  See also	Kubernetes label selectors, Kubernetes pods

• host string

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

  Platforms	Kubernetes, Docker

• tlsSecret string

  The name of a Kubernetes secret containing 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 client-to-router TLS encryption.

  Platforms	Kubernetes, Docker
  See also	Site-scoped TLS

• includeNotReady boolean

  If set, include server pods that are not in the ready state.

  Default	False
  Platforms	Kubernetes
  See also	Kubernetes pod lifecycle

• type string

  The connector 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