Skip to content

Commit

Permalink
Merge pull request #574 from hrismarin/docs-getting-started
Browse files Browse the repository at this point in the history
Docs - Getting Started: Fix examples of using container images
  • Loading branch information
travier authored Jan 10, 2025
2 parents 255ce1a + 4c6588a commit 7f32eb5
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 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
# 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

0 comments on commit 7f32eb5

Please sign in to comment.