Skip to content

docs(byoc): add GitOps cluster registration - #1557

Draft
sbaum1994 wants to merge 1 commit into
mainfrom
docs/byoc-gitops-registration
Draft

docs(byoc): add GitOps cluster registration#1557
sbaum1994 wants to merge 1 commit into
mainfrom
docs/byoc-gitops-registration

Conversation

@sbaum1994

Copy link
Copy Markdown
Collaborator

TL;DR

Document an external-organization BYOC registration workflow that uses a SAK
for the one-time NGC API bootstrap and GitOps for the NVCA operator lifecycle.
The guide is needed because the existing managed-cluster pages focus on UI
registration and do not show the no-Vault, no-SSA path.

Additional Details

  • Adds an idempotent ngc cf cluster bootstrap suitable for CI.
  • Defines the boundary between non-secret Helm values and GitOps-managed
    Kubernetes and chart repository credentials.
  • Provides the Helm values required for a SAK-backed, Helm-managed deployment.
  • Calls out that the public NGC CLI cannot currently set the UI management mode
    to read-only.
  • Links the new guide from the Helm-managed page and Fern navigation.

For the Reviewer

Review the commands and chart values in
docs/ngc-managed/cluster-management/gitops-registration.md, especially the
credential handling and management-mode limitation.

For QA

QA is not required for this documentation-only change. The author will test the
workflow against an external organization before the PR is marked ready.

Validation completed:

  • ./tools/ci/check-docs (0 errors; the existing version-sync check remained
    advisory because it starts without imports.yaml)
  • git diff --check
  • Rendered the documented secret-backed values with the current approved NVCA
    operator chart during authoring

Issues

Closes #1556

Checklist

  • I am familiar with the Contributing Guidelines.
  • I have signed off my commits for Developer Certificate of Origin (DCO) compliance.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

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.

Document GitOps registration for managed BYOC clusters

1 participant