Skip to content
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.

Sign up for GitHub

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

Docs - Getting Started: Fix examples of using container images #574

Merged
merged 2 commits into from
Jan 10, 2025
Merged

Docs - Getting Started: Fix examples of using container images #574

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5501f4
docs/getting-started: Update container image example
hrismarin Jan 1, 2025
4c6588a
Reduce the 'podman' command verbosity
hrismarin Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,17 @@ Using the official container images is the recommended option.
This example uses `podman`, but `docker` can also be used.

```bash
# Pull the latest release
# Pull the container image release
podman pull quay.io/coreos/butane:release

# Run butane using standard in and standard out
podman run -i --rm quay.io/coreos/butane:release --pretty --strict < your_config.bu > transpiled_config.ign
# Run Butane using standard input and standard output
podman run --interactive --rm quay.io/coreos/butane:release \
--pretty --strict < your_config.bu > transpiled_config.ign

# Run butane using files.
podman run --rm -v /path/to/your_config.bu:/config.bu:z quay.io/coreos/butane:release --pretty --strict /config.bu > transpiled_config.ign
# Run Butane using a file as input and standard output
podman run --interactive --rm --security-opt label=disable \
--volume ${PWD}:/pwd --workdir /pwd quay.io/coreos/butane:release \
--pretty --strict your_config.bu > transpiled_config.ign
```

You may also add the following alias in your shell configuration:
Expand Down
Loading