[2.8] Update deploy prepare launcher docs#4538
Conversation
9f33f1f to
a2a912d
Compare
|
/build |
a2a912d to
0bcc9b3
Compare
There was a problem hiding this comment.
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 prepareusage across Docker, K8s/Helm, and Brev scripted deployment docs. - Adds CLI reference documentation for
nvflare deploy prepareand links it from CLI/deployment entry points. - Documents
launcher_specin job metadata and updates examples/docs to reference it (while noting legacyresource_speccompatibility).
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.
Greptile SummaryThis PR updates user-facing and developer-facing documentation to replace provisioning-time runtime builder workflows with the
Confidence Score: 5/5Documentation-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
Sequence DiagramsequenceDiagram
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
Reviews (9): Last reviewed commit: "Update deploy prepare launcher docs" | Re-trigger Greptile |
eedbed3 to
9944dcb
Compare
|
/build |
9588695 to
e17c2ed
Compare
e17c2ed to
c46dc10
Compare
|
/build |
Summary
nvflare deploy prepareinstead of provisioning-time runtime builders.nvflare deploy prepareCLI reference docs and links it from the CLI/deployment docs.Validation
git diff --checkbash -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.shrg -n 'HelmChartBuilder|DockerLauncherBuilder|HelmCharBuilder|K8sLauncherBuilder|docker_k8s_job_launchers|job_launchers' docs examples webrg -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