-
Notifications
You must be signed in to change notification settings - Fork 248
docs: add recipe for pulling images from local docker registry #474
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
toksdotdev
wants to merge
10
commits into
main
Choose a base branch
from
toks/docs-cookbook
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+236
−21
Open
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
423be42
docs: add cookbook section with local images recipe
toksdotdev 31025d6
docs: move cookbook to top-level tab
toksdotdev 0e91aed
fix: remove trailing comma in docs.json
toksdotdev 100be20
docs: rename Cookbook to Recipes and move to last tab
toksdotdev be65523
docs: move volume mount tip to step 1
toksdotdev b24db5b
Merge branch 'main' into toks/docs-cookbook
toksdotdev 79e7494
Merge branch 'main' into toks/docs-cookbook
appcypher afea192
docs: update registry config, CLI flags, and SDK examples
toksdotdev b942ba9
docs: add --ca-certs to CLI flags table
toksdotdev 32ebd90
Merge branch 'main' into toks/docs-cookbook
toksdotdev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| title: Using Local Docker Images | ||
| description: Use locally built Docker images with microsandbox via a local registry | ||
| icon: "docker" | ||
| --- | ||
|
|
||
| microsandbox pulls images from OCI-compatible registries. If you build an image locally with `docker build`, microsandbox can't access it directly from Docker's local store. The workaround is to run a local registry and push your image there. | ||
|
|
||
| ## Step 1: Start a local registry | ||
|
|
||
| Run a local OCI registry on port 5000: | ||
|
|
||
| ```bash | ||
| docker run -d -p 5000:5000 --name registry registry:2 | ||
| ``` | ||
|
|
||
| <Tip> | ||
| Optionally, add a volume mount so pushed images persist across container restarts: | ||
| ```bash | ||
| docker run -d -p 5000:5000 -v registry-data:/var/lib/registry --name registry registry:2 | ||
| ``` | ||
| </Tip> | ||
|
|
||
| ## Step 2: Build and tag your image | ||
|
|
||
| Build your Docker image and tag it for the local registry: | ||
|
|
||
| ```bash | ||
| docker build -t localhost:5000/my-image:latest . | ||
| ``` | ||
|
|
||
| If you already have an existing image, re-tag it: | ||
|
|
||
| ```bash | ||
| docker tag my-image:latest localhost:5000/my-image:latest | ||
| ``` | ||
|
|
||
| ## Step 3: Push to the local registry | ||
|
|
||
| ```bash | ||
| docker push localhost:5000/my-image:latest | ||
| ``` | ||
|
|
||
| ## Step 4: Use it in microsandbox | ||
|
|
||
| Point microsandbox at your local registry image: | ||
|
|
||
| <CodeGroup> | ||
| ```rust Rust | ||
| let sb = Sandbox::builder("worker") | ||
| .image("localhost:5000/my-image:latest") | ||
| .create() | ||
| .await?; | ||
| ``` | ||
|
|
||
| ```typescript TypeScript | ||
| const sb = await Sandbox.create({ | ||
| name: "worker", | ||
| image: "localhost:5000/my-image:latest", | ||
| }) | ||
| ``` | ||
| </CodeGroup> | ||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.