feat: guides for nixl benchmarking

[biswapanda]

Overview:

This guide describes how to build and deploy the NIXL benchmark using the provided scripts on a Kubernetes (K8s) cluster.

• closes DEP-460

Summary by CodeRabbit

• New Features

  • Added a pre-deployment check script that validates kubectl access, default StorageClass, GPU availability, and GPU operator status with a clear pass/fail summary.
  • Introduced an interactive NIXL build-and-deploy script (x86_64/aarch64) with registry prompts, step selection, and Kubernetes deployment.
  • Updated NIXL deployment manifest: new image format, ETCD endpoint via env var, improved command, and explicit CPU/memory/GPU resources.

• Documentation

  • Added guides for pre-deployment checks and NIXL benchmark build/deploy workflow, including quick start and troubleshooting.
  • Removed outdated NIXL benchmark README.

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[coderabbitai]

Caution

Review failed

Failed to post review comments

Walkthrough

Adds Kubernetes pre-deployment checks and NIXL benchmark build/deploy tooling. Introduces two new Bash scripts, updates NIXL deployment YAML, replaces/relocates NIXL documentation, and removes an old benchmark README. No application code or APIs changed.

Changes

Cohort / File(s)	Summary
Pre-deployment checks deploy/cloud/pre-deployment/pre-deployment-check.sh, deploy/cloud/pre-deployment/README.md	New script and guide to validate kubectl access, default StorageClass, GPU resources, and GPU operator; prints a PASS/FAIL summary and exit code.
NIXL docs restructure benchmarks/nixl/README.md, deploy/cloud/pre-deployment/nixl/README.md	Removes old benchmark README; adds a comprehensive NIXL build/deploy guide under pre-deployment/nixl.
NIXL build and deploy tooling deploy/cloud/pre-deployment/nixl/build_and_deploy.sh, deploy/cloud/pre-deployment/nixl/nixlbench-deployment.yaml	Adds interactive script to build images (x86_64/aarch64), update deployment YAML, and deploy via kubectl; updates deployment manifest (image, env var, resources, command) and removes imagePullSecrets.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor U as User
  participant S as pre-deployment-check.sh
  participant K as kubectl
  participant API as Kubernetes API

  U->>S: Run script
  S->>K: kubectl version / cluster-info
  K->>API: Connect
  API-->>K: Response
  K-->>S: Status
  S->>K: Get default StorageClass
  K-->>S: SC list/labels
  S->>K: Get GPU nodes (labels/resources)
  K-->>S: Node counts
  S->>K: Check GPU operator pods
  K-->>S: Pod states
  S-->>U: Per-check results and overall summary (PASS/FAIL), exit code

Loading

sequenceDiagram
  autonumber
  actor U as User
  participant B as build_and_deploy.sh
  participant FS as Filesystem
  participant D as Docker/Build
  participant R as Registry
  participant K as kubectl
  participant API as Kubernetes API

  U->>B: Start script (select arch, steps)
  alt Build image
    B->>FS: Fetch NIXL source
    B->>D: docker build -t REG/nixlbench:VERSION-ARCH
    D->>R: Push (if configured)
    R-->>B: Image available
  end
  alt Update YAML
    B->>FS: Copy base YAML -> arch-specific file
    B->>FS: Update image ref via sed
  end
  alt Deploy
    B->>K: kubectl apply -f arch-specific YAML
    K->>API: Create/Update resources
    API-->>K: Status
    K-->>B: Apply result
  end
  B-->>U: Summary and follow-up commands

Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Poem

I thump my paws, deploy with cheer,
New scripts check clouds both far and near.
NIXL builds hum, YAMLs align,
GPUs ready—everything’s fine.
Hop, push, apply—logs scroll bright,
Carrots for green checks, all paws light! 🥕✨

Pre-merge checks

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The pull request description only provides the Overview section and a closes statement but omits the required Details and Where should the reviewer start sections from the repository’s template, leaving out specific change descriptions and file callouts.	Please complete the template by adding a Details section that describes the specific files and changes made in this PR and a Where should the reviewer start section listing the key files reviewers should focus on.
Docstring Coverage	⚠️ Warning	Docstring coverage is 77.78% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title clearly and concisely describes the addition of guides for NIXL benchmarking and aligns with the main purpose of the changeset without extraneous details.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[atchernych]

some nice to haves, i think quotes are important

[biswapanda]

some nice to haves, i think quotes are important

makes sense @atchernych.
I've addressed the comments