From ce75631d308b8da7825c2fc15f5192e5dbd76aa7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Ravier?= Date: Fri, 3 Dec 2021 12:11:35 +0100 Subject: [PATCH] docs: Add shell alias and trafe-offs explaination --- docs/getting-started.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/getting-started.md b/docs/getting-started.md index f590937d8..206e17737 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -29,6 +29,26 @@ sudo podman run --pull=always --privileged --rm \ install /dev/vdb -i config.ign ``` +You may also add the following alias your shell configuration: + +```sh +alias coreos-installer='podman run --pull=always \ + --rm --interactive \ + --security-opt label=disable \ + --volume ${PWD}:/pwd --workdir /pwd \ + quay.io/coreos/coreos-installer:release' +``` + +If you want to be able to cancel `coreos-installer` downloads, you +will have to add the `--tty` option to your podman comand line or shell alias: + +```sh +podmand run ... --rm --interactive --tty ... +``` + +This will however prevent you from using stdin redirection to embed a +configuration file and stdout capture to get the downloaded image file name. + ## Via a Fedora RPM `coreos-installer` is packaged in Fedora: