Skip to content

Commit

Permalink
docs/getting-started: Update container image example
Browse files Browse the repository at this point in the history
Fixes: #573
  • Loading branch information
hrismarin authored and Hristo Marinov committed Jan 5, 2025
1 parent fff2279 commit d5501f4
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions docs/getting-started.md
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
podman pull quay.io/coreos/butane:release
# Pull the container image release
podman image 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 container 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 container 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

0 comments on commit d5501f4

Please sign in to comment.