Documentation
¶
Overview ¶
Package gkenet discovers the GKE multi-NIC networking objects that GPUDirect TCPXO depends on. It is shared by the deployment-phase prerequisite check and the performance-phase NCCL benchmark so both gate on the same definition of "the cluster has GPU NIC networks".
Index ¶
Constants ¶
const GPUNICNameSubstring = "gpu-nic"
GPUNICNameSubstring identifies a GPU NIC network by name.
Network names are chosen by whoever provisions the cluster, not assigned by GKE — Google's own sample manifests name them "vpc1".."vpc8". Matching a substring rather than exact names is what lets a cluster carry a local prefix (e.g. "aicr-demo2-gpu-nic-0") while still being discoverable. Because the names are operator-chosen, containing this substring is a documented provisioning REQUIREMENT, not an observation about GKE's behavior; see docs/integrator/gke-tcpxo-networking.md.
const RequiredGPUNICNetworks = 8
RequiredGPUNICNetworks is the number of GPU NIC networks GPUDirect TCPXO needs on an a3-megagpu-8g node — one per GPU, bound to eth1..eth8. Both the deployment-phase prerequisite check and the performance-phase NCCL benchmark gate on this value so a cluster that clears the deployment gate cannot fail the benchmark's own discovery for the same reason.
The floor is fixed to the a3-megagpu-8g shape rather than derived from the node's GPU count: only the H100 GKE training recipe declares gke-nccl-tcpxo, and that recipe targets a3-megagpu-8g. Making it SKU-aware is tracked separately.
Variables ¶
var NetworkGVR = schema.GroupVersionResource{
Group: "networking.gke.io", Version: "v1", Resource: "networks",
}
NetworkGVR is the cluster-scoped GKE Network CR that multi-networking binds into the cluster. Its absence is what this package detects.
Functions ¶
func DiscoverGPUNICNetworks ¶
DiscoverGPUNICNetworks lists networks.networking.gke.io and returns the GPU NIC network names, sorted alphabetically.
The returned error is the RAW Kubernetes API error, deliberately not wrapped in a pkg/errors code, because callers classify it by shape and would lose that ability behind a wrap. The deployment check relies on exactly this: it routes an apierrors.IsNotFound error (the cluster does not serve this GVR at all, i.e. it was created without --enable-multi-networking) through validators.Capability.Require, which is declaration-gated, and every other error through RequireList, which always blocks. Do not wrap or normalize these errors without updating that caller.
A cluster that serves the API but has no matching networks returns an empty slice and a nil error — "none found" is a verdict for the caller, distinct from both a failure to read and an absent API.
Types ¶
This section is empty.
Source Files