diff options
author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2022-02-02 10:06:45 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-02-02 10:06:45 -0500 |
commit | dc0dc6a557dc9da9f89bd93baae3732e02b9ba20 (patch) | |
tree | a18b92550eae8c45e1dff97c35094d98b2de975b /contrib/helloimage/README.md | |
parent | 72c505a18104a183ad92e3b419f11d31fd37edaa (diff) | |
parent | 012e24b791ec8e41335686608acf4f28baf851b7 (diff) | |
download | podman-dc0dc6a557dc9da9f89bd93baae3732e02b9ba20.tar.gz podman-dc0dc6a557dc9da9f89bd93baae3732e02b9ba20.tar.bz2 podman-dc0dc6a557dc9da9f89bd93baae3732e02b9ba20.zip |
Merge pull request #13079 from TomSweeneyRedHat/dev/tsweeney/hellow
[CI:DOCS] Add a hello world image to quay.io
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 +``` |