ExternalBigIPRegistry

Overview

Function

Defines DNS replica sets of TMOS DNS instances that an External BIG-IP Controller pushes wide-IP configuration to.

Names

Singular name	Plural name	Short name
externalbigipregistry	externalbigipregistries	–

API group and version

k8s.f5.com/v1

Scope

Namespace

Specification

spec

Field	Required	Default	Description
dnsReplicaSets array	No	—	List of TMOS DNS replica sets. At most one entry is supported.
poolMonitor object	No	—	Configuration for TCP pool monitors on GTM pools managed by this cluster.
dataServerMonitor object	No	—	Configuration for ICMP monitors on the GSLB data-center server object for this cluster.
fallbackLoadBalancingMode string	No	return-to-dns	Fallback load balancing mode for GTM pools managed by this cluster. EBC configures all GTM pools with the specified fallback mode. If not configured, GTM pools use the F5 DNS default fallback mode return-to-dns. Accepted values: return-to-dns, fallback-ip.
availabilityZones array	No	—	Optional list of availability zones to disable. Zones not listed are implicitly enabled. When a zone is disabled, EBC removes all pool members and data servers whose availability zone matches the zone name on all TMOS DNS endpoints in the replica set. Duplicate zone names are rejected at the Kubernetes API level.

spec.dnsReplicaSets[]

Field	Required	Default	Description
name string	Yes	—	Unique, immutable identifier for this replica set. Immutable once set.
dnsSuffix string	No	—	GTM delegation zone suffix appended to the WideIP domain name on BIG-IP. When set, domain names are normalized and joined with this suffix. Applies to all WideIPs managed by this replica set.
bigipEndpoints array	Yes	—	List of BIG-IP TMOS DNS VE endpoints in this replica set. Each endpoint receives identical WideIP configuration. Maximum three endpoints.

spec.dnsReplicaSets[].bigipEndpoints[]

Field	Required	Default	Description
bigipMgmtURL string	Yes	—	BIG-IP management URL. Must start with http:// or https:// followed by an IPv4 address (for example, https://10.1.1.1:443), a valid IPv6 address in brackets (for example, https://[2001:db8::1]:443), or a hostname (for example, https://bigip-dns.example.com). Port must be in range 1–65535; an optional path may follow. Scheme is required — bare IPs or hostnames without a scheme are rejected. Hostnames must follow RFC 1123. IPv6 addresses must follow RFC 4291 format. Immutable — change requires removing and re-adding the endpoint.
bigipLoginSecret string	Yes	—	Name of the Kubernetes Secret holding BIG-IP credentials (username and password keys). Must be in the same namespace as the ExternalBIGIPConnector resource. Mutable.
certSecret string	No	—	Optional Kubernetes Secret name holding the TLS CA certificate used to verify the BIG-IP management endpoint. Must be in the same namespace as the ExternalBIGIPConnector resource. Mutable.

spec.poolMonitor

Field	Required	Default	Description
enabled boolean	No	true	When true, EBC attaches a TCP pool monitor on GTM pools managed by this cluster. Set to false to disable TCP pool monitoring for all GTM pools.

spec.dataServerMonitor

Field	Required	Default	Description
enabled boolean	No	false	When true, EBC attaches an ICMP monitor on the GSLB data-center server object for this cluster. Set to false to disable ICMP server monitoring.

spec.availabilityZones[]

Field	Required	Default	Description
name string	Yes	—	Availability zone identifier. Must match the availability_zone value in gRPC pool member messages from the CNE Controller.
disabled boolean	Yes	—	When true, removes all pool members and data servers in this zone from TMOS DNS. Set to false or remove the entry to re-enable.
reason string	No	—	Optional human-readable explanation for the zone disablement (for example, “maintenance” or “routing failure”).