Site resource

A place where components of your application are running. Sites are linked to form application networks.

There can be only one Site resource per namespace.

apiVersion: skupper.io/v2alpha1
kind: Site

Examples

A minimal site:

apiVersion: skupper.io/v2alpha1
kind: Site
metadata:
  name: east
  namespace: hello-world-east

A site configured to accept links:

apiVersion: skupper.io/v2alpha1
kind: Site
metadata:
  name: west
  namespace: hello-world-west
spec:
  linkAccess: default

Metadata properties

name

string

required

The name of the resource.

Platforms	Kubernetes, Docker, Podman, Linux

namespace

string

The namespace of the resource.

Platforms	Kubernetes, Docker, Podman, Linux
See also	Kubernetes namespaces

Spec properties

linkAccess

string

frequently used

Configure external access for links from remote sites.

Sites and links are the basis for creating application networks. In a simple two-site network, at least one of the sites must have link access enabled.

Default

none

Choices

`none`	No linking to this site is permitted.
`default`	Use the default link access for the current platform. On OpenShift, the default is `route`. For other Kubernetes flavors, the default is `loadbalancer`.
`route`	Use an OpenShift route. OpenShift only.
`loadbalancer`	Use a Kubernetes load balancer. Kubernetes only.

Platforms Kubernetes, Docker, Podman, Linux

See also Site linking, Link access concept, Kubernetes load balancer services

ha

boolean

Configure the site for high availability (HA). HA sites have two active routers.

Note that Skupper routers are stateless, and they restart after failure. This already provides a high level of availability. Enabling HA goes further and reduces the window of downtime caused by restarts.

Default	False
Platforms	Kubernetes
Updatable	True
See also	Advanced deployment options

defaultIssuer

string

advanced

The name of a Kubernetes secret containing the signing CA used to generate a certificate from a token. A secret is generated if none is supplied.

This issuer is used by AccessGrant and RouterAccess if a specific issuer is not set.

Default	`skupper-site-ca`
Platforms	Kubernetes

edge

boolean

advanced

Configure the site to operate in edge mode. Edge sites cannot accept links from remote sites.

Edge mode can help you scale your network to large numbers of sites. However, for networks with 16 or fewer sites, there is little benefit.

Currently, edge sites cannot also have HA enabled.

Default	False
Platforms	Kubernetes, Docker, Podman, Linux
See also	Advanced deployment options

serviceAccount

string

advanced

The name of the Kubernetes service account under which to run the Skupper controller.

Default	`skupper-router`
Platforms	Kubernetes
See also	Advanced deployment options, Kubernetes service accounts

settings

object

advanced

A map containing additional settings. Each map entry is a string name and a string value.

routerDataConnections - Set the number of data connections the router uses when linking to other routers.
Default: Computed based on the number of router worker threads. Minimum 2.
routerLogging - Set the router logging level.
Default: info. Choices: debug, info, warning, error.

Platforms	Kubernetes, Docker, Podman, Linux

Status properties

status

string

The current state of the resource.

Pending
Ready

Platforms	Kubernetes, Docker, Podman, Linux

message

string

A human-readable status message.

Platforms	Kubernetes, Docker, Podman, Linux

conditions

array

advanced

A set of named conditions describing the current state of the resource.

Configured
Running
Resolved
Ready

Platforms	Kubernetes
See also	Kubernetes conditions

defaultIssuer

string

advanced

The name of the Kubernetes secret containing the active default signing CA.

Platforms	Kubernetes

endpoints

array

advanced

An array of connection endpoints. Each item has a name, host, port, and group.

Platforms	Kubernetes, Docker, Podman, Linux

network

array

advanced

Platforms	Kubernetes, Docker, Podman, Linux
See also	Network concept

sitesInNetwork

integer

advanced

Platforms	Kubernetes, Docker, Podman, Linux