mirror of
https://github.com/Telecominfraproject/ols-ucentral-schema.git
synced 2025-10-29 09:12:20 +00:00
109 lines
2.8 KiB
YAML
109 lines
2.8 KiB
YAML
description:
|
|
This Object defines the properties of a wireguard-overlay.
|
|
type: object
|
|
properties:
|
|
proto:
|
|
description:
|
|
This field must be set to wireguard-overlay.
|
|
type: string
|
|
const: wireguard-overlay
|
|
private-key:
|
|
description:
|
|
The private key of the device. This key is used to lookup the host entry
|
|
inside the config.
|
|
type: string
|
|
peer-port:
|
|
description:
|
|
The network port that shall be used to establish the wireguard tunnel.
|
|
type: integer
|
|
maximum: 65535
|
|
minimum: 1
|
|
default: 3456
|
|
peer-exchange-port:
|
|
description:
|
|
The network port that shall be used to exchange peer data inside the tunnel.
|
|
type: integer
|
|
maximum: 65535
|
|
minimum: 1
|
|
default: 3458
|
|
root-node:
|
|
description:
|
|
The descritption of the root node of the overlay.
|
|
type: object
|
|
properties:
|
|
key:
|
|
description:
|
|
The public key of the host.
|
|
type: string
|
|
endpoint:
|
|
description:
|
|
The public IP of the host (optional).
|
|
type: string
|
|
format: uc-ip
|
|
ipaddr:
|
|
description:
|
|
The list of private IPs that a host is reachable on inside the overlay.
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uc-ip
|
|
hosts:
|
|
description:
|
|
The list of all known hosts inside the overlay.
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
name:
|
|
description:
|
|
The unique name of the host.
|
|
type: string
|
|
key:
|
|
description:
|
|
The public key of the host.
|
|
type: string
|
|
endpoint:
|
|
description:
|
|
The public IP of the host (optional).
|
|
type: string
|
|
format: uc-ip
|
|
subnet:
|
|
description:
|
|
The list of subnets that shall be routed to this host.
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uc-cidr
|
|
ipaddr:
|
|
description:
|
|
The list of private IPs that a host is reachable on inside the overlay.
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uc-ip
|
|
vxlan:
|
|
description:
|
|
The descritption of the root node of the overlay.
|
|
type: object
|
|
properties:
|
|
port:
|
|
description:
|
|
The network port that shall be used to establish the vxlan overlay.
|
|
type: integer
|
|
maximum: 65535
|
|
minimum: 1
|
|
default: 4789
|
|
mtu:
|
|
description:
|
|
The MTU that shall be used by the vxlan tunnel.
|
|
type: integer
|
|
maximum: 65535
|
|
minimum: 256
|
|
default: 1420
|
|
isolate:
|
|
description:
|
|
If set to true hosts will only be able to talk with the root node and not
|
|
forward L@ traffic between each other.
|
|
type: boolean
|
|
default: true
|