RouterAccess resource

Configuration for secure access to the site router. The configuration includes TLS credentials and router ports. The RouterAccess resource is used to implement link access for sites.

Metadata properties

name

string
required

The name of the resource.

See alsoKubernetes object names

namespace

string

The namespace of the resource.

See alsoPlatform concept, Kubernetes namespaces

Spec properties

roles

array
required

The named interfaces by which a router can be accessed. These include "inter-router" for links between interior routers and "edge" for links from edge routers to interior routers.

tlsCredentials

string
required

The name of a bundle of TLS certificates used for mutual TLS router-to-router communication. The bundle contains the server certificate and key and the trusted client certificate (usually a CA).

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

On Docker, Podman, and Linux, the value is the name of a directory under input/certs/ in the current namespace.

See alsoKubernetes TLS secrets

generateTlsCredentials

boolean
DefaultFalse

issuer

string

accessType

string
Default

On OpenShift, the default is route. For other Kubernetes flavors, the default is loadbalancer.

Choices
route

Use an OpenShift route. OpenShift only.

loadbalancer

Use a Kubernetes load balancer.

bindHost

string

The hostname or IP address of the network interface to bind to. By default, Skupper binds all the interfaces on the host.

Default

0.0.0.0

subjectAlternativeNames

array

The hostnames and IPs secured by the router TLS certificate.

Default

The current hostname and the IP address of each bound network interface

Status properties

status

string

The current state of the resource.

  • Pending: The resource is being processed.
  • Error: There was an error processing the resource. See message for more information.
  • Ready: The resource is ready to use.

message

string

A human-readable status message. Error messages are reported here.