docs: end-to-end installation guide and prerequisite gap fixes#512
Open
vigviswa wants to merge 3 commits intoNVIDIA:mainfrom
Open
docs: end-to-end installation guide and prerequisite gap fixes#512vigviswa wants to merge 3 commits intoNVIDIA:mainfrom
vigviswa wants to merge 3 commits intoNVIDIA:mainfrom
Conversation
- 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 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.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. Made-with: Cursor
Made-with: Cursor
ianderson-nvidia
requested changes
Mar 11, 2026
|
|
||
| **NOTE**: The `CONTAINER_RUNTIME_AARCH64=alpine:latest` build argument must be included. The aarch64 binaries are bundled into an x86 container. | ||
|
|
||
| ## Tagging and Pushing to a Private Registry |
Contributor
There was a problem hiding this comment.
Let's move the tagging and pushing of containers to a registry into its own document, independent of container building.
Comment on lines
+207
to
+210
| ### Prerequisites | ||
|
|
||
| * Go 1.25.4 or later | ||
| * Docker 20.10+ with BuildKit enabled |
Contributor
There was a problem hiding this comment.
Can this be moved up to the top of the doc so its appears with the other PreReqs - https://github.com/NVIDIA/bare-metal-manager-core/blob/main/book/src/manuals/building_bmm_containers.md?plain=1#L14
Comment on lines
+212
to
+216
| ### Build all REST images | ||
|
|
||
| ```sh | ||
| cd bare-metal-manager-rest | ||
| make docker-build IMAGE_REGISTRY=$REGISTRY IMAGE_TAG=$TAG |
Contributor
There was a problem hiding this comment.
Comment on lines
+201
to
+205
| ## Building BMM REST Containers | ||
|
|
||
| The BMM REST components (cloud-api, cloud-workflow, site-manager, site-agent, | ||
| db migrations, cert-manager) are built from the | ||
| [bare-metal-manager-rest](https://github.com/NVIDIA/bare-metal-manager-rest) repository. |
Contributor
There was a problem hiding this comment.
Can you move this up in the doc after - https://github.com/NVIDIA/bare-metal-manager-core/blob/main/book/src/manuals/building_bmm_containers.md?plain=1#L146
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add an end-to-end installation guide and fix documentation gaps that are blocking external customers from deploying Carbide.
Changes:
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)helm/PREREQUISITES.md-- Added Vault PKI configuration (forgeca mount, forge-cluster role, K8s auth, policies), AppRole/token generation steps, PostgreSQL user guidance, and Temporal sectionbook/src/manuals/building_bmm_containers.md-- Added container image summary table, registry tagging/push instructions, and REST container build sectionbook/src/manuals/site-setup.md-- Replaced nvcr.io/nvidian references with build-from-source instructionsbook/src/SUMMARY.mdandREADME.md-- Added links to the new guideType of Change
Related Issues (Optional)
Fixes #476
Breaking Changes
Testing
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).