Link resource
A link is a channel for communication between sites. Links carry application connections and requests. A set of linked sites constitutes a network.
A Link resource specifies remote connection endpoints and TLS credentials for establishing a mutual TLS connection to a remote site. To create an active link, the remote site must first enable link access. Link access provides an external access point for accepting links.
Note: Links are not usually created directly. Instead, you can use an access token to obtain a link.
Metadata properties
name
The name of the resource.
| See also | Kubernetes object names |
|---|
namespace
The namespace of the resource.
| See also | Platform concept, Kubernetes namespaces, System namespaces |
|---|
Spec properties
endpoints
An array of connection endpoints. Each item has a name, host, port, and group.
cost
The configured routing cost of sending traffic over the link.
| Default | 1 |
|---|---|
| See also | Load balancing |
tlsCredentials
The name of a bundle of certificates used for mutual TLS router-to-router communication. The bundle contains the client certificate and key and the trusted server 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 also | Router TLS, Kubernetes TLS secrets, System TLS credentials |
|---|
settings
A map containing additional settings. Each map entry has a string name and a string value.
Note: In general, we recommend not changing settings from their default values.
| See also | Resource settings |
|---|
Status properties
status
The current state of the resource.
Pending: The resource is being processed.Error: There was an error processing the resource. Seemessagefor more information.Ready: The resource is ready to use.
| See also | Resource status |
|---|
message
A human-readable status message. Error messages are reported here.
| See also | Resource status |
|---|
remoteSiteId
The unique ID of the site linked to.
remoteSiteName
The name of the site linked to.
conditions
A set of named conditions describing the current state of the resource.
Configured: The link configuration has been applied to the router.Operational: The link to the remote site is active.Ready: The link is ready to use. All other conditions are true.
| See also | Resource status, Kubernetes conditions |
|---|