docs: end-to-end installation guide and prerequisite gap fixes by vigviswa · Pull Request #512 · NVIDIA/infra-controller

vigviswa · 2026-03-10T20:58:10Z

Description

Add an end-to-end installation guide and fix documentation gaps that are blocking external customers from deploying Carbide.

Changes:

New: book/src/manuals/installation-guide.md -- 10-step deployment guide following the validated sequence used by SA/engineering teams, linking to existing docs and filling gaps (REST component deploy order, Vault setup, troubleshooting)
Updated: helm/PREREQUISITES.md -- Added Vault PKI configuration (forgeca mount, forge-cluster role, K8s auth, policies), AppRole/token generation steps, PostgreSQL user guidance, and Temporal section
Updated: book/src/manuals/building_bmm_containers.md -- Added container image summary table, registry tagging/push instructions, and REST container build section
Updated: book/src/manuals/site-setup.md -- Replaced nvcr.io/nvidian references with build-from-source instructions
Updated: book/src/SUMMARY.md and README.md -- Added links to the new guide

Type of Change

Add - New feature or capability
Change - Changes in existing functionality
Fix - Bug fixes
Remove - Removed features or deprecated functionality
[ x ] Internal - Internal changes (refactoring, tests, docs, etc.)

Related Issues (Optional)

Fixes #476

Breaking Changes

This PR contains breaking changes

Testing

Unit tests added/updated
Integration tests added/updated
Manual testing performed
[x ] No testing required (docs, internal refactor, etc.)

Additional Notes

Overlaps with #479 on site-setup.md. This PR goes further by adding build-from-source links alongside the registry placeholder format. Based on real customer questions from partner deployments (Vault AppRole/token generation, PostgreSQL user setup, Temporal requirement, nvcr.io access).

copy-pr-bot · 2026-03-10T20:58:13Z

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.

vigviswa · 2026-03-13T04:35:39Z

Pushed a commit to pass DCO check. Kindly review

vigviswa · 2026-03-13T21:46:22Z

Thanks for the approval. The DCO check is passing. The "verified signatures" requirement is blocking me from merging. I've set up GPG signing for future commits, but the existing ones in this PR aren't signed. Could you merge this on your end, or let me know if I should re-push with signed commits?

ajf · 2026-03-13T21:49:30Z

you have to re-push with verified commits, sorry it's a prodsec thing

github-actions · 2026-03-13T22:29:06Z

🔐 TruffleHog Secret Scan

✅ No secrets or credentials found!

Your code has been scanned for 700+ types of secrets and credentials. All clear! 🎉

🔗 View scan details

_{🕐 Last updated: 2026-03-13 22:29:05 UTC | Commit: 208b244}

github-actions · 2026-03-13T22:29:12Z

🛡️ Vulnerability Scan

🚨 Found 72 vulnerability(ies)
📊 vs main: 72 (no change)

Severity Breakdown:

🔴 Critical/High: 72
🟡 Medium: 0
🔵 Low/Info: 0

🔗 View full details in Security tab

_{🕐 Last updated: 2026-03-13 22:29:11 UTC | Commit: 208b244}

github-actions · 2026-04-18T06:26:35Z

This PR has been inactive for 30 days and will be closed soon.
Please push commits or comment to keep it open.

- Add book/src/manuals/installation-guide.md: 10-step deployment guide stitching together existing docs and filling gaps (Vault commands, Temporal setup, admin-cli build, Elektra OTP bootstrap, verification) - Update building_bmm_containers.md: add image summary table, tagging/ pushing section (auth before tag/push), REST image build steps, fix typo "perfrom" and stray backtick in tar command - Update site-setup.md: replace nvcr.io/nvidian internal image refs with <YOUR_REGISTRY> placeholders and build-from-source links (fixes NVIDIA#476) - Update helm/PREREQUISITES.md: add Vault PKI engine/role/auth/policy commands, explicit carbide DB/user requirements, pg extensions, and new Temporal section (optional for core, required for REST) - Update book/src/SUMMARY.md: add installation guide entry, fix broken faqs.md link (file is faq.md) - Update README.md: add installation guide link in Getting Started Signed-off-by: vigneshv <vigneshv@nvidia.com>

Add step-by-step instructions for obtaining VAULT_ROLE_ID, VAULT_SECRET_ID, and VAULT_TOKEN from Vault. These values were previously listed as required but with no explanation of how to generate them -- customers were blocked at this step. Signed-off-by: vigneshv <vigneshv@nvidia.com>

- Update site-setup.md, SUMMARY.md, installation-guide.md, and pushing_containers.md to use NICo naming and correct repo links - Remove work.md from PR Signed-off-by: vigneshv <vigneshv@nvidia.com>

Signed-off-by: vigneshv <vigneshv@nvidia.com>

-e Signed-off-by: Peter Gambrill <pgambrill@nvidia.com>

Copyedits and rebase fixes for end-to-end install changes

ajf · 2026-04-29T15:59:50Z

@vigviswa there's some conflicts here - we also probably want @Coco-Ben to review. But if you don't need this anymore, please close.

vigviswa · 2026-04-30T04:36:00Z

Closing this PR, as due to the docs migration, there have been many changes. Will provide feedback on #1190 & #1227

vigviswa requested a review from a team as a code owner March 10, 2026 20:58

ianderson-nvidia requested changes Mar 11, 2026

View reviewed changes

Comment thread book/src/manuals/building_bmm_containers.md Outdated

Comment thread book/src/manuals/building_bmm_containers.md Outdated

Comment thread book/src/manuals/building_bmm_containers.md Outdated

Comment thread book/src/manuals/building_bmm_containers.md Outdated

vigviswa requested a review from ianderson-nvidia March 12, 2026 18:18

ianderson-nvidia approved these changes Mar 12, 2026

View reviewed changes

vigviswa force-pushed the docs/end-to-end-installation-guide branch from 8cbb911 to c515d06 Compare March 13, 2026 04:33

vigviswa requested a review from ianderson-nvidia March 13, 2026 04:35

ianderson-nvidia approved these changes Mar 13, 2026

View reviewed changes

vigviswa force-pushed the docs/end-to-end-installation-guide branch from b2d2662 to 208b244 Compare March 13, 2026 22:26

vigviswa force-pushed the docs/end-to-end-installation-guide branch 3 times, most recently from dcc17b6 to 3f6d5d8 Compare March 19, 2026 03:15

vigviswa requested a review from ianderson-nvidia March 19, 2026 03:17

github-actions Bot added the lifecycle/stale label Apr 18, 2026

vigviswa added 3 commits April 19, 2026 12:27

docs: fix stale BMM references after NICo rename

97b00ec

- Update site-setup.md, SUMMARY.md, installation-guide.md, and pushing_containers.md to use NICo naming and correct repo links - Remove work.md from PR Signed-off-by: vigneshv <vigneshv@nvidia.com>

vigviswa force-pushed the docs/end-to-end-installation-guide branch from 3f6d5d8 to 97b00ec Compare April 19, 2026 17:29

vigviswa requested a review from a team as a code owner April 19, 2026 17:29

docs: add NGC account prerequisite for container builds

f5672e0

Signed-off-by: vigneshv <vigneshv@nvidia.com>

github-actions Bot removed the lifecycle/stale label Apr 20, 2026

vigviswa added 3 commits April 20, 2026 07:47

docs: add missing REST images and repo link

6088910

Signed-off-by: vigneshv <vigneshv@nvidia.com>

docs: fix PKI role config and add missing REST images

89552b2

Signed-off-by: vigneshv <vigneshv@nvidia.com>

docs: fix REST repo references and installation guide accuracy

6d0d647

Signed-off-by: vigneshv <vigneshv@nvidia.com>

vigviswa and others added 7 commits April 20, 2026 08:14

docs: fix Temporal cert source and Keycloak deployment in install guide

2b163af

Signed-off-by: vigneshv <vigneshv@nvidia.com>

docs: address review findings across PR 512

eb3c5e7

Signed-off-by: vigneshv <vigneshv@nvidia.com>

docs: align step 8 Temporal namespace with step 4.4 pattern

342983b

Signed-off-by: vigneshv <vigneshv@nvidia.com>

docs: fix vault token key, ssh public key, healthz route, KV engine step

82347d1

Signed-off-by: vigneshv <vigneshv@nvidia.com>

docs: clean up REST image descriptions and DB secret key docs

098b027

Signed-off-by: vigneshv <vigneshv@nvidia.com>

Copyedits and rebase fixes for end-to-end install changes

48225a1

-e Signed-off-by: Peter Gambrill <pgambrill@nvidia.com>

Merge pull request #1 from Coco-Ben/upsteam/pull-request/512

ceacc7e

Copyedits and rebase fixes for end-to-end install changes

lachen-nv approved these changes Apr 22, 2026

View reviewed changes

ajf requested a review from Coco-Ben April 29, 2026 15:59

vigviswa closed this Apr 30, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: end-to-end installation guide and prerequisite gap fixes#512

docs: end-to-end installation guide and prerequisite gap fixes#512
vigviswa wants to merge 14 commits into
NVIDIA:mainfrom
vigviswa:docs/end-to-end-installation-guide

vigviswa commented Mar 10, 2026

Uh oh!

copy-pr-bot Bot commented Mar 10, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vigviswa commented Mar 13, 2026

Uh oh!

vigviswa commented Mar 13, 2026

Uh oh!

ajf commented Mar 13, 2026

Uh oh!

github-actions Bot commented Mar 13, 2026

Uh oh!

github-actions Bot commented Mar 13, 2026

Uh oh!

github-actions Bot commented Apr 18, 2026

Uh oh!

ajf commented Apr 29, 2026

Uh oh!

vigviswa commented Apr 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

vigviswa commented Mar 10, 2026

Description

Type of Change

Related Issues (Optional)

Breaking Changes

Testing

Additional Notes

Uh oh!

copy-pr-bot Bot commented Mar 10, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vigviswa commented Mar 13, 2026

Uh oh!

vigviswa commented Mar 13, 2026

Uh oh!

ajf commented Mar 13, 2026

Uh oh!

github-actions Bot commented Mar 13, 2026

🔐 TruffleHog Secret Scan

Uh oh!

github-actions Bot commented Mar 13, 2026

🛡️ Vulnerability Scan

Uh oh!

github-actions Bot commented Apr 18, 2026

Uh oh!

ajf commented Apr 29, 2026

Uh oh!

vigviswa commented Apr 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants