Resources / DHCPService

DHCPService

DHCPv4 for one VPC: addresses for members and for other devices, with routers, DNS and a domain.

Overview

APInetwork.etorm.com/v1alpha1
Resourcedhcpservices (cluster-scoped inside its cluster)
Short namesdhcp
Available inproject clusters only
Statuswritten by a controller through /status

Minimal example

apiVersion: network.etorm.com/v1alpha1
kind: DHCPService
metadata:
  name: example
spec:
  vpcRef:
    name: "<name>"

Spec

FieldTypeRequiredDefaultAllowedDescription
vpcRefreference to VPCyesThe VPC served. One DHCP service per VPC.
leaseSecondsinteger360060 to 604800How long a lease lasts, in seconds (60 to 604800).
routerslist of stringup to 4 itemsIPv4 default routers handed to clients, for example a member that forwards to the internet.
dnsServerslist of stringup to 4 itemsIPv4 DNS servers handed to clients; defaults to the VPC's DNS service.
domainstringup to 253 charactersSearch domain handed to clients; defaults to the DNS zone.
poolobjectRange of addresses for devices that are not Etorm accounts.
pool.startstringyes
pool.endstringyes
reservationslist of objectup to 256 itemsFixed leases for devices behind a member.
reservations[].macAddressstringyes
reservations[].ipAddressstringyes
reservations[].hostnamestringup to 63 characters

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending until the VPC is Ready, then Ready or Failed.
reservationCountintegerNumber of fixed leases.
configobject (free-form)The complete rendered configuration the gateway serves: vni, serverIp, prefix, mtu, lease, routers, DNS servers, domain, pool, reservations.
conditionslist of objectDetailed state, one entry per aspect; Ready says whether the object is usable.
conditions[].typestring
conditions[].statusstring
conditions[].reasonstring
conditions[].messagestring

Columns in listings

ColumnFrom
VPC.spec.vpcRef.name
Server.status.config.serverIp
Lease.spec.leaseSeconds
Phase.status.phase

Related guides

All resources