GKE TCPXO Networking Prerequisites
For the H100 GKE COS training recipes (h100-gke-cos-training*, on a3-megagpu-8g nodes), GPUDirect TCPXO enables high-speed inter-node GPU communication on GKE. Without it, the NVIDIA Collective Communications Library (NCCL) falls back to TCP (~4 GB/s vs ~340 GB/s with TCPXO).
A100 (a2) exception: the
a100-gke-cos-training*recipes intentionally omit thegke-nccl-tcpxocomponent — GPUDirect TCPXO targets H100a3-megagpu-8gnodes, not the A100a2-highgpu/a2-ultragpumachine family. The prerequisites below do not apply to A100 GKE recipes, and the generated A100 bundle does not install the TCPXO DaemonSets.
Infrastructure Prerequisites
GKE clusters must have multi-NIC networking configured before deploying AICR bundles:
- Multi-NIC networking enabled (8 GPU NICs per a3-megagpu-8g node)
Network+GKENetworkParamSetCRs configured for GPU NICs (cluster-specific, not managed by AICR)nccl-tcpxo-installerDaemonSet on GPU nodes (included in AICR bundle)nri-device-injectorDaemonSet on GPU nodes (included in AICR bundle)
The last two ship in the AICR bundle. The first two are cluster provisioning — AICR detects them but does not create them.
Provisioning multi-NIC networking
These four steps are ordered. Step 2 is the one that cannot be undone later;
steps 3 and 4 must both complete before any TCPXO workload — or aicr validate —
will work.
- Create the VPCs and subnets — one dedicated VPC + subnet per GPU NIC, eight in total, in the cluster’s region.
- Create the cluster with
--enable-multi-networking, plus its two prerequisites--enable-dataplane-v2and--enable-ip-alias. - Create the GPU node pool on an
a3-megagpu-8gmachine type with--enable-gvnic, attaching the eight VPC/subnet pairs as repeated--additional-node-networkentries, one per pair, each in the formnetwork=NETWORK,subnetwork=SUBNET. - Apply the
NetworkandGKENetworkParamSetCRs — one pair per GPU NIC, binding each additional node network into the cluster so pods can reference it by name. EachNetworkname must containgpu-nic— for examplegpu-nic-0throughgpu-nic-7, optionally with a cluster prefix such asaicr-demo2-gpu-nic-0. The pairedGKENetworkParamSetis referenced by theNetworkthroughspec.parametersRef, so its own name is unconstrained.
The
gpu-nicnaming is a requirement, not a convention. AICR discovers these networks by matchinggpu-nicin theNetworkobject’smetadata.name— both thegke-gpu-nic-networksdeployment check and the NCCL benchmark’s own interface mapping. Google’s sample manifests name the Device networksvpc1–vpc8; applied verbatim those are invisible to AICR, and the deployment check reports 0 of 8 on a cluster that is otherwise correctly provisioned. Rename them when following that procedure.Beyond containing
gpu-nic, the exact names are yours to choose — but the workload annotation below must reference the names your cluster actually has. The example there usesgpu-nic0–gpu-nic7; if you provisionedgpu-nic-0–gpu-nic-7, use those instead.
Multi-networking cannot be enabled after cluster creation.
--enable-multi-networkingis a create-time flag; there is nogcloud container clusters updateequivalent, so a cluster created without it must be recreated. Steps 3 and 4, by contrast, can be done on an existing multi-networking cluster — a node pool can be added later, and the CRs can be applied at any point.
AICR installs the TCPXO DaemonSets and detects the CRs; it does not provision any of this networking. These steps are a summary of the prerequisite AICR depends on, not a complete provisioning runbook — for the full procedure, including the per-VPC firewall rules and the supported GKE version floors, follow Google’s GPUDirect and multi-networking guide.
Completing steps 1–3 without step 4 is the failure mode worth knowing: the VMs
come up with all nine NICs attached (the node’s primary interface plus the eight
GPU NICs) and the AICR TCPXO DaemonSets roll out cleanly, but with no Network
objects bound into the cluster no pod can reference a GPU NIC and TCPXO cannot
function.
Verifying
Expect eight GPU NIC entries (plus the default network). Match on the
gpu-nic substring rather than an exact name: the rest of each name is chosen
at provisioning time and may carry a local prefix, such as
aicr-demo2-gpu-nic-0.
Fewer than eight means the prerequisite is incomplete. AICR’s
gke-gpu-nic-networks deployment check asserts this same count, so
aicr validate --phase deployment reports the shortfall by name rather than
letting it surface later as a performance-phase abort with no bandwidth number.
Important: The GPU node pool must be provisioned with only the 8 GPU NIC
networks (gpu-nic-0 through gpu-nic-7). Do not include a gVNIC additional
network — it takes a GPU NIC PCI slot (0000:06:00.0), leaving only 7/8 GPUs
available for TCPXO. This is distinct from the --enable-gvnic node-pool flag,
which selects the gVNIC driver and is required: pass the flag, but do not add
a ninth --additional-node-network entry for it.
The shipped torch-distributed-tcpxo runtime
On the h100-gke-cos-training-kubeflow recipe, AICR ships a pre-wired
ClusterTrainingRuntime named torch-distributed-tcpxo (a sibling of
torch-distributed, which stays as it is). It carries the annotations,
native sidecar, volumes, IPC_LOCK, and the complete versioned NCCL
configuration set — the entire wiring described in the next section — so a
TrainJob references it by name and supplies no fabric configuration at all:
The network names are a required recipe-generation input. The eight names
are cluster-specific and AICR has no cluster access at generation time, so
they are recorded in the recipe (configuration.gke.tcpxoInterfaces),
auditable and provenance-visible. Generation fails closed without them:
or in an AICRConfig:
The mapping is an ordered list of explicit interfaceName → Network pairs —
the interface key, not the list position, binds a network to ethN. Take the
mapping from whoever provisioned the cluster (its GKENetworkParamSet /
provisioning configuration); enumerating Network names shows what exists but
not which one binds each interface. The value is validated as eight unique
interfaces mapped to eight unique networks. It cannot be changed at bundle
time: --set/--set-json/--set-file/--dynamic
paths intersecting kubeflow-trainer:tcpxoInterfaces are rejected, and the
bundle fails if the final resolved value disagrees with what the recipe
records. (This is ownership enforcement, not the profile lock — the lock is
unavailable to this value, see issue #2296.) One gap remains open by design:
editing the generated artifact after AICR produced it is not yet detected
at validation time — that recipe-versus-deployed comparison is #2297’s
work, tracked separately.
Re-bundling a pre-existing recipe: the obligation follows the
declaration. Recipes generated before this runtime existed do not declare
its manifest, so they bundle exactly as before — no runtime, no required
input. Only a recipe whose kubeflow-trainer component attaches the
torch-distributed-tcpxo manifest must record the mapping: generation fails
closed without it, and a hand-edited recipe that adds the manifest without
the configuration is rejected at bundle time. (Recipe loading does not
fail closed on this shape — the metadata store’s coherence check also serves
catalog introspection paths that never deploy, so the enforcement lives at
generation and bundling, where artifacts are produced.)
Residual limitation, stated plainly: the runtime is an opt-in sibling —
workloads that keep referencing torch-distributed get TCP as before, and
nothing points them at the fabric runtime. Discoverability is a doc concern,
not a behavioral one.
Workload Pod Configuration (NRI Profile)
The NRI profile mounts the host’s /sys and /proc/sys into the TCPXO daemon
container, giving it PCI sysfs visibility without hostNetwork. This preserves
pod networking (DNS, network policies, service mesh compatibility).
Key properties:
hostNetwork: false— workloads get proper pod networkingprivileged: false— tcpxo-daemon uses onlyNET_ADMINandNET_BIND_SERVICE/sysmounted as/hostsysfs— provides PCI sysfs visibility for GPU enumeration/proc/sysmounted as/hostprocsysfs— allows kernel network tuning- NRI annotations inject GPU devices and multi-NIC interfaces
- Requires NRI device injector DaemonSet deployed on GPU nodes
Running a Kubeflow TrainJob rather than a bare Pod? A TrainJob cannot add
the tcpxo-daemon sidecar, so the wiring must live in a runtime. On an
AICR-generated bundle for this recipe family you do not author one: reference
the shipped torch-distributed-tcpxo ClusterTrainingRuntime (see above).
To hand-author a TrainingRuntime — a bundle you did not generate, or a
shape the shipped runtime does not cover — see
Attaching a Training Workload to the Cluster Fabric.
See demos/workloads/training/gke-nccl-test-tcpxo.yaml for a complete 2-node NCCL benchmark example. (pinned to the same coupled pair the recipe ships, plugin v1.0.15 with daemon v1.0.21)
NCCL Plugin Version Matching
Google publishes the plugin installer and the tcpxo-daemon sidecar as a
coupled release pair. Running a mismatched pair is unsupported. The pair
AICR currently ships is:
Check what your cluster actually runs:
Then set your workload’s tcpxo-daemon image to the daemon version paired with
it, per Google’s release notes.
Upgrade in order: upgrade the plugin installer first, then the workload’s daemon. Google also advises that workloads should not be running while the installer is upgraded. This is a sequence, not a statement that a mismatched pair is supported to run.
Running the NCCL Benchmark
Automated (recommended): aicr validate
The GKE H100 training recipe (h100-gke-cos-training) already selects the
automated nccl-all-reduce-bw performance check (floor >= 300 GB/s), so the
benchmark is fully driven for you:
That base recipe ships TCPXO but no runtime, so it measures the validator’s
own fixture and labels the result runtimeSource: cluster-capability.
On a recipe that ships the torch-distributed-tcpxo runtime
(h100-gke-cos-training-kubeflow), the performance validator does not measure
a fixture of its own. Before creating anything it verifies recipe → deployed →
cluster: the recipe’s recorded configuration.gke.tcpxoInterfaces must equal
the mapping on the deployed ClusterTrainingRuntime exactly and in order, and
every network that mapping selects must exist on the cluster. It then derives
the benchmark runtime from the deployed one — copying the worker pod template
wholesale (metadata and spec), re-applying only the benchmark’s own worker
image, command, args, resources, and terminationMessagePolicy, and
merging volumes and mounts additively, so the workers run under the shipped
NCCL environment rather than the fixture’s — and labels the result
runtimeSource: delivered-artifact. A mismatch in either comparison fails the
run rather than being recorded; a divergent deployed artifact is a finding,
never something validation repairs.
The validator runs the all-reduce sweep over the validator-fixed 1K–16G
message-size range and asserts the busBW floor. It deploys the
TrainingRuntime (validators/performance/testdata/h100/gke/runtime.yaml)
plus the shared TrainJob (validators/performance/testdata/trainjob.yaml)
that actually launches the worker Pods. The runtime template carries the GKE
multi-NIC and NRI device annotation keys (networking.gke.io/interfaces and
devices.gke.io/container.tcpxo-daemon) as ${...} placeholders, and the
validator discovers and substitutes their concrete values dynamically at
apply time — the interface list from the cluster’s discovered GPU NIC networks
and the NRI device annotation sized to the per-node GPU count. Because those
values are resolved at runtime, the framework manifest cannot be reproduced by a
plain kubectl apply / envsubst of runtime.yaml alone, so running the
framework path by hand is not supported. Use aicr validate for the
framework-equivalent benchmark.
Prerequisites: the automated check needs at least 2 schedulable GPU nodes with allocatable GPUs — the all-reduce measures East-West fabric between nodes. The validator counts discovered schedulable GPU nodes: with fewer than 2 it returns a successful skipped result without measuring bandwidth. The selected nodes also need free GPU capacity (the TrainJob places a full GPU node per worker); if the GPUs are already occupied the workers stay Pending and the check times out — it does not skip. If Kubeflow Trainer is not already installed, the validator downloads and installs it (Trainer v2.2.0 from GitHub, then removes it afterward), so the validator environment needs GitHub egress.
Manual standalone benchmark
To exercise the GPUDirect TCPXO data path directly with raw Pods and a TCPXO
daemon sidecar (independent of the validator framework — useful for debugging),
use the standalone demo manifest. Each pod runs a tcpxo-daemon sidecar
(manages the GPUDirect TCPXO data path) plus the nccl-test container.
NRI profile (recommended, no hostNetwork):
Interpreting results
Troubleshooting
RxDM detects 7/8 GPUs
If RxDM reports Number of GPUs detected 7 is not equal to the actual number of GPUs 8, check the GPU node pool’s additional network configuration:
If a gVNIC network appears in the list, it is taking a GPU NIC PCI slot. Remove the gVNIC from the node pool and reprovision the GPU nodes.
You can also verify the node NIC mapping:
All 8 GPU NIC PCI addresses should be mapped to eth1–eth8. If a gVNIC is present, it typically occupies PCI 0000:06:00.0, displacing the first GPU NIC.
RxDM detects 0/8 GPUs
If RxDM reports Number of GPUs detected in the PCI tree 0, the pod is missing the /sys hostPath mount. Ensure /sys is mounted as /hostsysfs in the tcpxo-daemon container. Without it, the container network namespace hides the host PCI sysfs tree entirely.
Performance Reference
Validated on GKE 1.35 / a3-megagpu-8g (2 nodes, 16 GPUs):