diff options
author | tomsweeneyredhat <tsweeney@redhat.com> | 2022-01-29 17:56:02 -0500 |
---|---|---|
committer | tomsweeneyredhat <tsweeney@redhat.com> | 2022-02-01 16:35:33 -0500 |
commit | 012e24b791ec8e41335686608acf4f28baf851b7 (patch) | |
tree | 7c7870253a0a62418d151dd2fbad31bc3ea907a3 /contrib/helloimage/README.md | |
parent | 6f491e21aa291ac0e9cbda5f41e7dc8b87fe160c (diff) | |
download | podman-012e24b791ec8e41335686608acf4f28baf851b7.tar.gz podman-012e24b791ec8e41335686608acf4f28baf851b7.tar.bz2 podman-012e24b791ec8e41335686608acf4f28baf851b7.zip |
[CI:DOCS] Add a hello world image to quay.io
[NO NEW TESTS NEEDED]
This commit describes how to run the quay.io/podman/hello
image. It also contains the files necessary to build that
image localy, and a README.md explaining the image and how
to build it.
Signed-off-by: tomsweeneyredhat <tsweeney@redhat.com>
Diffstat (limited to 'contrib/helloimage/README.md')
-rw-r--r-- | contrib/helloimage/README.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/contrib/helloimage/README.md b/contrib/helloimage/README.md new file mode 100644 index 000000000..93edcc527 --- /dev/null +++ b/contrib/helloimage/README.md @@ -0,0 +1,55 @@ +![PODMAN logo](../../logo/podman-logo-source.svg) + +# Podman Hello World image + +## Overview + +This directory contains the Containerfile and bash script necessary to create the +"hello" podman image housed on quay.io under the Podman account in a public +repository. The image is public and can be pulled without credentials. + +Using this image is helpful to: + + * Prove that basic Podman operations are working on the host. + * Shows that the image was pulled from the quay.io container registry. + * Container creation was successfuly accomplished. (`podman ps -a`) + * The created container was able to stream output to your terminal. + +## Directory Contents + +The contents of this directory contain: + * ./Containerfile + * ./podman_hello_world.bash + +## Sample Usage + +To simply run the image: + +``` +podman run quay.io/podman/hello + +! ... Hello Podman World ...! + + .--"--. + / - - \ + / (O) (O) \ + ~~~| -=(,Y,)=- | + .---. /` \ |~~ + ~/ o o \~~~~.----. ~~ + | =(X)= |~ / (O (O) \ + ~~~~~~~ ~| =(Y_)=- | + ~~~~ ~~~| U |~~ + +Project: https://github.com/containers/podman +Website: https://podman.io +Documents: https://docs.podman.io +Twitter: @Podman_io +``` +To build the image yourself, copy the files from this directory into +a local directory and issue these commands: + +``` +chmod 755 ./podman_hello_world.bash +podman build -t myhello . +podman run myhello +``` |