Site update command

Change site settings.

Platforms	Kubernetes, Docker, Podman, Linux
Waits for	Ready

Usage

skupper site update [name] [options]

Examples

# Update the current site to accept links
$ skupper site update --enable-link-access
Waiting for status...
Site "west" is ready.

# Update multiple settings
$ skupper site update --enable-link-access --service-account alice

Primary options

[name]

string

optional

The name of the site resource.

If not specified, the name is that of the site associated with the current namespace.

Platforms	Kubernetes, Docker, Podman, Linux

--enable-link-access

boolean

frequently used

Allow access for incoming links from remote sites.

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

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

--timeout

Raise an error if the operation does not complete in the given period of time.

Default	`60s`
Platforms	Kubernetes, Docker, Podman, Linux

--wait

Wait for the given status before exiting.

Default

ready

Choices

`pending`	Pending
`configured`	Configured
`ready`	Ready

Platforms Kubernetes, Docker, Podman, Linux

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

--context

<name>

global

Set the kubeconfig context.

Platforms	Kubernetes
See also	Kubernetes kubeconfigs

--kubeconfig

<file>

global

Set the path to the kubeconfig file.

Platforms	Kubernetes
See also	Kubernetes kubeconfigs

--namespace

(-n) <name>

global

Set the namespace.

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

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

Errors

No site resource exists

There is no existing Skupper site resource to update.