Skip to content

[2.8] Update deploy prepare launcher docs#4538

Merged
YuanTingHsieh merged 1 commit intoNVIDIA:2.8from
YuanTingHsieh:codex/deploy-prepare-docs
May 8, 2026
Merged

[2.8] Update deploy prepare launcher docs#4538
YuanTingHsieh merged 1 commit intoNVIDIA:2.8from
YuanTingHsieh:codex/deploy-prepare-docs

Conversation

@YuanTingHsieh
Copy link
Copy Markdown
Collaborator

@YuanTingHsieh YuanTingHsieh commented May 6, 2026

Summary

  • Updates Docker and Kubernetes launcher docs to use nvflare deploy prepare instead of provisioning-time runtime builders.
  • Reworks the Helm chart docs/design around the same default generated chart, with chart generation moved to deploy preparation.
  • Updates Brev helper docs and the Docker example to consume prepared runtime kits.
  • Adds nvflare deploy prepare CLI reference docs and links it from the CLI/deployment docs.
  • Removes stale user-facing references to deprecated runtime builder workflows while keeping developer-facing design boundary language where it is useful.

Validation

  • git diff --check
  • bash -n docs/user_guide/admin_guide/deployment/brev_scripts/prepare_brev_startup_kits.sh docs/user_guide/admin_guide/deployment/brev_scripts/launch_brev_nvflare.sh
  • rg -n 'HelmChartBuilder|DockerLauncherBuilder|HelmCharBuilder|K8sLauncherBuilder|docker_k8s_job_launchers|job_launchers' docs examples web
  • rg -n 'Out of Scope|out of scope|outside the scope|not an? [A-Z]|not .* guide|separate guide|should live|if included|Provider-specific|cloud-provider-specific' docs/user_guide docs/examples docs/security_faq.rst docs/programming_guide examples web

@YuanTingHsieh YuanTingHsieh force-pushed the codex/deploy-prepare-docs branch from 9f33f1f to a2a912d Compare May 6, 2026 23:09
@YuanTingHsieh YuanTingHsieh changed the title [codex] Update deploy prepare launcher docs [2.8] Update deploy prepare launcher docs May 6, 2026
@pcnudde
Copy link
Copy Markdown
Collaborator

pcnudde commented May 7, 2026

/build

@YuanTingHsieh YuanTingHsieh force-pushed the codex/deploy-prepare-docs branch from a2a912d to 0bcc9b3 Compare May 7, 2026 18:40
@YuanTingHsieh YuanTingHsieh marked this pull request as ready for review May 7, 2026 20:41
Copilot AI review requested due to automatic review settings May 7, 2026 20:41
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates NVFlare’s user/developer documentation and examples to reflect the current “prepare after provisioning” workflow using nvflare deploy prepare for Docker/Kubernetes runtimes, and documents the launcher_spec job metadata key used by Docker/K8s job launchers.

Changes:

  • Replaces deprecated provisioning-time runtime builder guidance with nvflare deploy prepare usage across Docker, K8s/Helm, and Brev scripted deployment docs.
  • Adds CLI reference documentation for nvflare deploy prepare and links it from CLI/deployment entry points.
  • Documents launcher_spec in job metadata and updates examples/docs to reference it (while noting legacy resource_spec compatibility).

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
examples/docker/README.md Updates the Docker example workflow to use nvflare deploy prepare outputs and refreshes notes on job launcher metadata.
examples/docker/docker.yaml Adds an example Docker runtime config YAML for nvflare deploy prepare.
docs/user_guide/nvflare_cli/nvflare_cli.rst Adds the deploy command group and links the new deploy command docs.
docs/user_guide/nvflare_cli/deploy_command.rst New CLI reference page documenting nvflare deploy prepare usage and runtime config schemas.
docs/user_guide/core_concepts/job.rst Introduces launcher_spec documentation for launcher-specific job execution settings.
docs/user_guide/confidential_computing/on_premises/cc_architecture.rst Refines scope/assumption wording and removes trailing whitespace.
docs/user_guide/admin_guide/deployment/overview.rst Updates deployment overview to point to deploy prepare and removes outdated Docker builder guidance.
docs/user_guide/admin_guide/deployment/containerized_deployment.rst Adds a note clarifying deploy prepare is required for Docker job launcher runtime behavior.
docs/user_guide/admin_guide/deployment/brev_scripts/prepare_brev_startup_kits.sh Updates Brev prep script to generate a K8s deploy prepare config including namespace.
docs/user_guide/admin_guide/deployment/brev_scripts/launch_brev_nvflare.sh Removes provisioning-time patching logic and relies on prepared kits containing correct launcher config/chart.
docs/user_guide/admin_guide/deployment/brev_scripted_deployment.rst Aligns Brev workflow narrative with deploy prepare and prepared kit packaging.
docs/security_faq.rst Rewords IRB guidance to remove “out of scope” phrasing.
docs/programming_guide/provisioning_system.rst Notes Docker/K8s runtime preparation is done via nvflare deploy prepare post-kit creation.
docs/index.rst Adds a top-level docs entry linking to the new deploy prepare CLI page.
docs/examples/tensorboard_streaming.rst Minor wording cleanup to improve readability.
docs/design/site_runtime_packaging_design.md Updates design doc terminology to reflect post-provision runtime preparation.
docs/design/docker_job_launcher_design.md Reworks design doc to reflect deploy prepare ownership and current file/CLI structure.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread examples/docker/README.md
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 7, 2026

Greptile Summary

This PR updates user-facing and developer-facing documentation to replace provisioning-time runtime builder workflows with the nvflare deploy prepare command. It also updates the Docker example meta.json files to use the new launcher_spec / resource_spec split, where container settings live in launcher_spec and GPU/scheduler requirements live in flat resource_spec[site].num_of_gpus.

  • Adds a new deploy_command.rst CLI reference and links it from the index, CLI overview, deployment overview, containerized deployment page, and job concept page.
  • Cleans up all design docs to remove deprecated resource_spec[site][docker] nesting and align examples with the flat resource_spec GPU pattern.
  • Commits examples/docker/docker.yaml as a reusable config and updates the three example meta.json files to move Docker image/kwargs into launcher_spec and num_of_gpus into flat resource_spec.

Confidence Score: 5/5

Documentation-only PR with example meta.json updates; no production logic changed and changes are internally consistent.

All changed files are documentation, design notes, or illustrative example configs. The meta.json rewrites correctly separate launcher_spec from resource_spec and match the runtime behaviour described in the updated design docs. No executable code paths are modified.

No files require special attention.

Important Files Changed

Filename Overview
docs/user_guide/nvflare_cli/deploy_command.rst New CLI reference file for nvflare deploy prepare; covers Docker and K8s config keys, exit codes, and job image examples.
examples/docker/README.md Updated to use nvflare deploy prepare with the committed docker.yaml; all cd paths are now repo-root-relative and correct.
examples/docker/jobs/hello-pt-docker/meta.json Moves Docker image and container settings into launcher_spec and num_of_gpus into flat resource_spec[site].
examples/docker/jobs/pt-ddp-docker/meta.json Same launcher_spec / resource_spec separation; 2-GPU requirement correctly moved to flat resource_spec[site-1].num_of_gpus.
docs/user_guide/admin_guide/deployment/helm_chart.rst Removes num_of_gpus from launcher_spec[site][k8s] examples and adds it to a flat resource_spec[site] block.
docs/design/docker_job_launcher_design.md Design doc updated to reflect resource_spec as the authoritative GPU requirement source; launcher_spec cleaned of num_of_gpus.

Sequence Diagram

sequenceDiagram
    participant Admin as Site Admin
    participant Provision as nvflare provision
    participant Deploy as nvflare deploy prepare
    participant Kit as Startup Kit (runtime-neutral)
    participant PrepKit as Prepared Kit (Docker/K8s)
    participant Helm as Helm / docker run

    Admin->>Provision: nvflare provision -p project.yml
    Provision-->>Kit: server/, site-1/, site-2/ startup kits

    Admin->>Deploy: nvflare deploy prepare site-1 --config docker.yaml
    Deploy-->>Kit: reads startup/ and local/
    Deploy-->>PrepKit: writes start_docker.sh, patched resources.json.default, comm_config.json

    Admin->>Deploy: nvflare deploy prepare site-1 --config k8s.yaml
    Deploy-->>PrepKit: writes helm_chart/, patched resources.json.default, comm_config.json

    Admin->>Helm: helm upgrade --install / bash start_docker.sh
    Helm-->>PrepKit: reads prepared kit and launches parent pod/container
Loading

Reviews (9): Last reviewed commit: "Update deploy prepare launcher docs" | Re-trigger Greptile

Comment thread examples/docker/README.md Outdated
@YuanTingHsieh YuanTingHsieh force-pushed the codex/deploy-prepare-docs branch 9 times, most recently from eedbed3 to 9944dcb Compare May 8, 2026 17:56
IsaacYangSLA
IsaacYangSLA previously approved these changes May 8, 2026
@YuanTingHsieh
Copy link
Copy Markdown
Collaborator Author

/build

@YuanTingHsieh YuanTingHsieh force-pushed the codex/deploy-prepare-docs branch from e17c2ed to c46dc10 Compare May 8, 2026 20:43
@pcnudde
Copy link
Copy Markdown
Collaborator

pcnudde commented May 8, 2026

/build

@IsaacYangSLA IsaacYangSLA enabled auto-merge (squash) May 8, 2026 20:52
@YuanTingHsieh YuanTingHsieh disabled auto-merge May 8, 2026 21:16
@YuanTingHsieh YuanTingHsieh merged commit 08c5f25 into NVIDIA:2.8 May 8, 2026
24 of 25 checks passed
@YuanTingHsieh YuanTingHsieh deleted the codex/deploy-prepare-docs branch May 8, 2026 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants