docs: document containerRegistryAuthId for private Flash images - #816
Draft
justinwlin wants to merge 1 commit into
Draft
docs: document containerRegistryAuthId for private Flash images#816justinwlin wants to merge 1 commit into
justinwlin wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
1 participant
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.
The Flash custom Docker images page told readers to
configure Docker registry authentication in Runpod consolefor private images but never explained how a Flash endpoint references the saved credential — without the field, private image pulls fail with no actionable hint. This adds the missing mechanism: pass the credential ID viaPodTemplate(containerRegistryAuthId=...), with instructions for obtaining the ID (runpodctl registry listor the Container Registry Authentication section of console settings).Fixes #800
Internal: CON-1233
What changed
flash/custom-docker-images.mdx: new "Private images" section showingPodTemplate(containerDiskInGb, containerRegistryAuthId), a warning about missing credentials, and how to obtain the ID (runpodctl registry list,runpodctl registry create, console settings → Container Registry Authentication, GHCRread:packagesnote). Troubleshooting "Authentication errors" bullet now points to the new section.flash/configuration/parameters.mdx: addedcontainerRegistryAuthIdto the PodTemplate reference table and example, with a pointer to the new section.How verified
runpod_flash/core/resources/template.py(containerRegistryAuthId: Optional[str], serialized into the build manifest incli/commands/build_utils/manifest.py).node scripts/validate-tooltips.jspasses;mintlify broken-linksreports only pre-existing CLAUDE.md links./runpodctl/reference/runpodctl-registryand anchor#private-images(from the## Private imagesheading) checked.