Skip to content

docs: update for current console (Secrets, Dynamo frontends, Storage, retire LLM Serving) - #86

Merged
atokayev merged 11 commits into
mainfrom
atokayev/Review-docs-for-possible-missing-areas
Nov 17, 2026
Merged

atokayev merged 11 commits into
mainfrom
atokayev/Review-docs-for-possible-missing-areas

Conversation

@atokayev

@atokayev atokayev commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Brings the CCluster docs in line with the current platform console (v4.37 era). Targets main. Includes the two commits from the closed #84 (docs/post-launch-cleanup), which were never merged.

Wording and fields

  • Private Endpoint, Advanced step, optional Max Concurrency, SSH agent forwarding supported (X11 not)
  • Vault is now Secrets ("Managing Secrets"): visibility and lifecycle, image pull secrets across inference, compute, jobs, NIM, custom image
  • Compute is revision-aware; jobs can be paused and resumed (resume restarts the job, with a warning)
  • Dynamo: model_revision / weight_transfer API fields, reserved env prefixes
  • Existing-certificate flow documented (replaces the "under construction" section)

Retired

  • LLM Serving page removed (CServe creation is gone); /apps/llm redirects to Dynamo; json-and-tool.mdx now targets Dynamo

New pages

  • Managing Storage (resources/storage.mdx), Monitoring Usage (resources/usage.mdx), a console Clusters section in Hardware Instances
  • Open Source CCluster (home/open-source.mdx): intro to github.com/NVIDIA/ccluster (noting its early stage), a GitHub link in the navbar, and a card on the Introduction page

Screenshots: 21 images replaced in place (same filenames), 2x and cropped; before/after below. Retired llm-stage1/2.png removed; new storage-*.png and clusters.png added.

Carried over from closed #84 (docs/post-launch-cleanup, 2 commits)

  • README: link the live site docs.nvidia.com/ccluster; replace the outdated note about the Developer Experience review and Jira ticket
  • docs/apps/dynamo.mdx: fix the 404 Dynamo KServe gRPC frontend link
  • Remove endpoints/openapi.json (4.5k lines; unused by Fern, still listed retired RAG, payments and credits endpoints). This accounts for nearly all of the deletions in this PR's diff.

Known gaps

  • No screenshots yet for Usage, Add hardware, Dynamo detail or Jobs detail (need real Dev data)
  • The note that ccluster ls does not list Dynamo deployments is based on the CLI source; no Dynamo deployments were available to test it

Test plan

  • fern check, fern docs md check, tools/check-docs-mdx, tools/check-docs-paths
  • Review the preview deployment

Before / after

File Before After
apps/images/inf-1.png
apps/images/inf-2.png
apps/images/inf-3.png
apps/images/inf-4.png
apps/images/comp-1.png
apps/images/dynamo-endpoint-configuration.png
apps/images/dynamo-advanced-configuration.png
apps/images/dynamo-hardware-scaling.png
home/images/homepage.png
resources/images/vault.png
resources/images/vault-bearer-tokens.png
resources/images/add-bearer-token.png
resources/images/added-bearer-token.png
resources/images/add-certificates.png
resources/images/gen-cert.png
resources/images/added-certificate.png
resources/images/add-env.png
resources/images/env-vault.png
resources/images/grpc-vllm-config.png
resources/images/grpc-vllm-entry-script.png
resources/images/grpc-vllm-hardware.png

🤖 Generated with Claude Code

atokayev and others added 8 commits November 16, 2026 14:05
…step, concurrency, SSH agent forwarding)

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…s, Dynamo frontends, LLM Serving links

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…eld placement

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
… to Dynamo

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…age links

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

🌿 Preview your docs: https://nvidia-preview-pr-86.docs.buildwithfern.com/ccluster

@atokayev
atokayev marked this pull request as ready for review November 17, 2026 18:35
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@atokayev
atokayev changed the base branch from docs/post-launch-cleanup to main November 17, 2026 18:48
@atokayev
atokayev marked this pull request as draft November 17, 2026 18:48
@atokayev
atokayev marked this pull request as ready for review November 17, 2026 18:54
@atokayev
atokayev requested a review from a team November 17, 2026 18:54
@michaelshin

Copy link
Copy Markdown
Contributor

Production-release scope review at 6721348, against v4.37.1, the latest published platform release:

[P2] Remove unreleased Dynamo Frontend replica configuration before merging.

dynamo.mdx:37 documents a default of three Frontends, configurable replicas, and node-failure resilience. This feature merged in platform PR #4844 after v4.37.1. The released chart runs one Frontend, and its API has no frontend configuration field. Publishing these instructions would describe controls and availability guarantees that the production release does not provide.

To keep this PR limited to the production release:

  • Remove Frontend Replicas and the frontend API instructions at line 161.
  • Restore the single-Frontend description and readiness examples at lines 17, 209, and 214.
  • Replace docs/apps/images/dynamo-endpoint-configuration.png; it visibly includes the unreleased Frontend Replicas control.

The existing Current scope paragraph correctly says Frontend high availability is unavailable.

The other major additions checked—Secrets, Storage, Usage, Compute revisions, model_revision, and weight_transfer—are present in v4.37.1 source.

Validation: local MDX and path checks passed. Fern CLI checks were not run because Fern is not installed.

@michaelshin

Copy link
Copy Markdown
Contributor

Additional content review at 6721348, checked against v4.37.1 source:

  1. [P2] Explain that resuming a job restarts its work — jobs.mdx:52

    Pause deletes the job's application; resume recreates it. Completed indices and in-memory progress aren't preserved. Add a warning that work can run again and that checkpointing requires application logic and persistent storage. Update the same claim in Managing Deployments. The released implementation routes pause through _delete_deployment_application and resume through _submit_deployment in deployments/utils.py.

  2. [P2] Correct the certificate setup instructions — private.mdx:51

    Selecting Private Endpoint doesn't automatically generate a downloadable certificate upon deployment. Users must choose Certificate, then select an existing secret or create one. The PEM downloads when a new certificate is generated. This section retains the old workflow despite updating the field name. See the released PrivateEndpoint component and certificate creation modal.

  3. [P2] Replace the retired serving paths in authentication examples — private.mdx:23

    The security guide still uses /openai/v1 throughout, while the Dynamo examples correctly use /v1. Following the security guide against Dynamo produces incorrect request paths. Update the curl and Python examples; the Secrets page also retains an old endpoint example. These are inherited issues left behind by the CServe retirement changes.

  4. [P3] Remove the inaccurate latency-filter claim — usage.mdx:28

    The new page says 404, 500, 304, and 499 responses are excluded. The released query uses an exact-string exclusion, status!="404|500|304|499", which excludes none of those individual codes. Remove that sentence to describe production accurately.

The previously reported unreleased Frontend replica configuration also remains unchanged at this commit.

Validation limit: this was a source-based review against v4.37.1; production console workflows and endpoints were not exercised.

atokayev and others added 2 commits November 17, 2026 16:02
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…rn jobs resume restarts, fix mTLS steps and /v1 paths, drop latency-filter claim

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@atokayev

Copy link
Copy Markdown
Contributor Author

Re: Frontend Replicas review — @michaelshin

Confirmed and fixed in 1f09d0f. The Frontend Replicas content (platform #4844) was written from main and isn't in v4.37.1. I removed the Frontend Replicas field and the frontend API paragraph, restored the single-Frontend wording and the Frontend (1 / 1 …) readiness examples, and re-captured dynamo-endpoint-configuration.png using the v4.37.1 version of the Dynamo form, so it no longer shows the field.

@atokayev

Copy link
Copy Markdown
Contributor Author

Re: additional content review — @michaelshin

All four items are fixed in 1f09d0f, checked against v4.37.1:

  1. Job resume: jobs.mdx and Managing Deployments now warn that pausing deletes the job's pods and resuming restarts it from the beginning, and that keeping progress needs checkpointing in the application plus persistent storage.
  2. Certificate steps: private.mdx now says to choose Certificate under Private Endpoint, then select an existing certificate or + Add a new certificate. The .pem downloads when a new certificate is generated.
  3. Paths: the private.mdx examples and the Secrets example use /v1, with a note that the path depends on the server in the container. I also fixed the mTLS curl example, where a comment after a \ continuation broke the command.
  4. Latency filter: the sentence about excluded status codes is removed from usage.mdx.

Validation: fern check, fern docs md check, fern docs broken-links --strict, check-docs-mdx, and check-docs-paths pass. I haven't exercised the production console.

@atokayev
atokayev merged commit aadd7dd into main Nov 17, 2026
6 checks passed
@atokayev
atokayev deleted the atokayev/Review-docs-for-possible-missing-areas branch November 17, 2026 21:53
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.

2 participants