values.yaml Reference
The xRouter chart is configured entirely through Helm values. This page maps the top-level sections
of values.yaml; run helm show values expeto/xrouter for the complete file with its inline
comments. Values are checked against the chart's schema at install time. The values file for a
deployment is agreed with Expeto Support during design; use this page to read it, and route changes
through Expeto Support.
Required values
| Value |
Purpose |
imageCredentials.username, .password, .email |
Registry credentials, written into the expeto pull Secret. Pass them with --set. |
agent.connections.customerId, .siteId, .systemId |
The xControl Customer, Site and System this installation belongs to. |
agent.connections.serverUri, .brokerUri |
The xControl installation the Agent connects to. |
agent.connections.apiToken |
The Site's API token. Pass it with --set. |
global.plmn.mcc, .mnc |
The home PLMN. |
global.ueConfig.defaultIpRanges.ipv4Cidr |
Default UE address range. |
Global settings
| Section |
Purpose |
global.productName, global.imageRegistry |
Labels and the registry every image is pulled from; point the registry at a mirror for air-gapped clusters. |
global.k8sPlatform |
Force a platform profile (openshift, eks, aks, microk8s, tanzu) when rendering without a cluster. |
global.manualNodeConfig |
true renders no node configuration at all: neither the netcfg operator nor the nodeNetworkConfig resource. The platform team then prepares kernel modules, sysctls and NIC queues itself. |
global.metallb.namespace, global.frrk8s.namespace |
Namespaces of an existing MetalLB and FRR-K8s. MetalLB resources default to metallb-system; FRR configurations default to openshift-frr-k8s on OpenShift and to the MetalLB namespace elsewhere. Not used with the bundled MetalLB, whose resources stay in the release namespace. |
global.tls |
Enable TLS between the functions with certificates from cert-manager. |
global.plmn, global.ambr, global.ueConfig |
Home PLMN, default bit-rate limits, default UE address ranges, DNS servers and APN. |
global.frr |
BGP routers and neighbours: typically a north router towards the IPX and a south router (in its own VRF) towards the xCores, each with the prefixes to advertise and accept. |
global.networks |
Network attachments and MetalLB address pools shared by the functions. |
global.database, global.store |
MariaDB Galera and Redis settings shared by the functions. |
global.eks |
Karpenter and ENI settings for EKS. |
Network functions
| Section |
Purpose |
agent |
The Expeto Agent: connection to xControl, the gateways it reports (the SMF and UPF roles of this installation), the HSS functions it drives (provisioning, integrity check, metrics). |
hss |
The HSS: Diameter (hss.diameter), MAP over M3UA (hss.map), SMS centre and SMPP (hss.smsc), SIP interworking (hss.sip), its database (hss.galeracluster), exposed ports and Java heap. See HSS configuration. |
smf |
SGW-C and PGW-C. |
upf |
The user plane: dataplane StatefulSet, controller, replicas and autoscaling. |
nfcm |
Configuration management, monitoring and statistics; nfcm.dataNetwork.numSessions sizes the session table. |
nrf, udsf, faultmanager |
Service discovery, session state and fault handling. Enabled by default. |
pcef |
Policy and charging enforcement towards a PCRF over Gx. Disabled by default. |
Each function accepts enabled, replicaSet, autoscaling, resources, nodeSelector,
tolerations and affinity, and per-workload overrides under deployments.<name> or
statefulsets.<name>.
Networking
| Section |
Purpose |
createNetworks |
Render the NetworkAttachmentDefinition and MetalLB objects declared under global.networks. |
metallb |
Bundle MetalLB with FRR-K8s. |
multus-cni, whereabouts, cni-route-override |
Bundle Multus and its companions where the platform has none. |
netcfg |
The bundled netcfg node-configuration operator, a cluster singleton. Set netcfg.enabled=false when another Expeto release on the cluster already runs it. |
nodeNetworkConfig |
xRouter's node requirements, rendered as a NodeNetworkConfig resource the netcfg operator applies to every node: kernel modules, sysctls and, per named interface, transmit queue lengths, addresses, routes and iptables rules. |
securityContextConstraints |
OpenShift security context constraints for the privileged user plane. |
tls |
Certificate issuer for the internal certificates. |
Infrastructure and monitoring
| Section |
Purpose |
galeracluster, redis |
The shared MariaDB Galera cluster and Redis. |
couchbase |
Optional document store for NFCM. |
kubemonitoring |
Namespace-scoped Prometheus scraping the functions; the Agent relays the metrics to xControl for xView. |
teleport-kube-agent |
Optional Teleport agent for Expeto Support access. |
karpenter |
Node autoscaling on EKS. |
serviceAccount, role |
The service account and RBAC the functions run with. |