Add doc for deploying an image from private registry #236
Conversation
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
| - **A container image** to deploy | ||
|
|
||
| ## Deploy an Image | ||
| ## Deploy a Public Image |
Contributor
There was a problem hiding this comment.
To make this consistent?
Suggested change
| ## Deploy a Public Image | |
| ## Deploy from a Public Registry |
| { | ||
| "auths": { | ||
| "https://index.docker.io/v1/": { | ||
| "auth": "eW91ci1kb2NrZXJodWItdXNlcm5hbWU6eW91ci1hY2Nlc3MtdG9rZW4=" |
Contributor
There was a problem hiding this comment.
Suggested change
| "auth": "eW91ci1kb2NrZXJodWItdXNlcm5hbWU6eW91ci1hY2Nlc3MtdG9rZW4=" | |
| "auth": "<your-base64-auth-string>" |
| --- | ||
| title: Deploy a Prebuilt Container Image | ||
| description: Deploy your existing container images to OpenChoreo without using the Build Plane. | ||
| description: Deploy your existing container images to OpenChoreo from public or private registries without using the Build Plane. |
Contributor
There was a problem hiding this comment.
Do we need to mention without using Build Plane?
Contributor
Author
There was a problem hiding this comment.
I included it to clarify the use case. (some users might not immediately understand why they'd deploy a prebuilt image instead of using the standard flow. It helps distinguish BYOI from the build-and-deploy approach.
chalindukodikara
approved these changes
Jan 20, 2026
| name: registry-pull-secret | ||
| namespace: ${metadata.namespace} | ||
| spec: | ||
| refreshInterval: 15s |
Contributor
There was a problem hiding this comment.
[nitpick] Might be a good idea to keep refreshInterval: 1h or similar, to avoid frequent secret syncs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Purpose
Add doc for deploying an image from private registry
Related Issues
Checklist
sidebars.tsif adding a new documentation pagenpm run startto preview the changes locallynpm run buildto ensure the build passes without errors