Resources / DHCPService
DHCPService
DHCPv4 for one VPC: addresses for members and for other devices, with routers, DNS and a domain.
Overview
| API | network.etorm.com/v1alpha1 |
| Resource | dhcpservices (cluster-scoped inside its cluster) |
| Short names | dhcp |
| Available in | project clusters only |
| Status | written by a controller through /status |
Minimal example
apiVersion: network.etorm.com/v1alpha1
kind: DHCPService
metadata:
name: example
spec:
vpcRef:
name: "<name>"
Spec
| Field | Type | Required | Default | Allowed | Description |
vpcRef | reference to VPC | yes | | | The VPC served. One DHCP service per VPC. |
leaseSeconds | integer | | 3600 | 60 to 604800 | How long a lease lasts, in seconds (60 to 604800). |
routers | list of string | | | up to 4 items | IPv4 default routers handed to clients, for example a member that forwards to the internet. |
dnsServers | list of string | | | up to 4 items | IPv4 DNS servers handed to clients; defaults to the VPC's DNS service. |
domain | string | | | up to 253 characters | Search domain handed to clients; defaults to the DNS zone. |
pool | object | | | | Range of addresses for devices that are not Etorm accounts. |
pool.start | string | yes | | | |
pool.end | string | yes | | | |
reservations | list of object | | | up to 256 items | Fixed leases for devices behind a member. |
reservations[].macAddress | string | yes | | | |
reservations[].ipAddress | string | yes | | | |
reservations[].hostname | string | | | up to 63 characters | |
Status
| Field | Type | Required | Default | Allowed | Description |
phase | string | | | | Pending until the VPC is Ready, then Ready or Failed. |
reservationCount | integer | | | | Number of fixed leases. |
config | object (free-form) | | | | The complete rendered configuration the gateway serves: vni, serverIp, prefix, mtu, lease, routers, DNS servers, domain, pool, reservations. |
conditions | list of object | | | | Detailed state, one entry per aspect; Ready says whether the object is usable. |
conditions[].type | string | | | | |
conditions[].status | string | | | | |
conditions[].reason | string | | | | |
conditions[].message | string | | | | |
Columns in listings
| Column | From |
|---|
| VPC | .spec.vpcRef.name |
| Server | .status.config.serverIp |
| Lease | .spec.leaseSeconds |
| Phase | .status.phase |
Related guides
All resources