Site generate command

Generate a Site resource.

Platforms	Kubernetes, Docker, Podman, Linux

Usage

skupper site generate <name> [options]

Examples

# Generate a Site resource and print it to the console
$ skupper site generate west --enable-link-access
apiVersion: skupper.io/v2alpha1
kind: Site
metadata:
  name: west
spec:
  linkAccess: default

# Generate a Site resource and direct the output to a file
$ skupper site generate east > east.yaml

Primary options

<name>

string

required

The name of the resource to be generated.

Platforms	Kubernetes, Docker, Podman, Linux
See also	Kubernetes object names

--enable-link-access

boolean

frequently used

Allow access for incoming links from remote sites.

Platforms	Kubernetes, Docker, Podman, Linux
See also	Link access concept

--output

(-o) <format>

Select the output format.

Default

yaml

Choices

`json`	Produce JSON output
`yaml`	Produce YAML output

Platforms Kubernetes, Docker, Podman, Linux

--link-access-type

<type>

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

default

Choices

`default`	Use the default link access. 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

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

--enable-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, Docker, Podman, Linux
See also	Advanced deployment options

--default-issuer

<name>

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, Docker, Podman, Linux

--enable-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

--service-account

<name>

advanced

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

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

Global options

--platform

global

Set the Skupper platform.

Default

kubernetes

Choices

`kubernetes`	Kubernetes
`docker`	Docker
`podman`	Podman
`linux`	Linux

Platforms Kubernetes, Docker, Podman, Linux

--help

(-h) boolean

global

Display help and exit.

Platforms	Kubernetes, Docker, Podman, Linux