summaryrefslogtreecommitdiff
path: root/contrib/helloimage
diff options
context:
space:
mode:
authortomsweeneyredhat <tsweeney@redhat.com>2022-01-29 17:56:02 -0500
committertomsweeneyredhat <tsweeney@redhat.com>2022-02-01 16:35:33 -0500
commit012e24b791ec8e41335686608acf4f28baf851b7 (patch)
tree7c7870253a0a62418d151dd2fbad31bc3ea907a3 /contrib/helloimage
parent6f491e21aa291ac0e9cbda5f41e7dc8b87fe160c (diff)
downloadpodman-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')
-rw-r--r--contrib/helloimage/Containerfile8
-rw-r--r--contrib/helloimage/README.md55
-rwxr-xr-xcontrib/helloimage/podman_hello_world.bash23
3 files changed, 86 insertions, 0 deletions
diff --git a/contrib/helloimage/Containerfile b/contrib/helloimage/Containerfile
new file mode 100644
index 000000000..bea71cae0
--- /dev/null
+++ b/contrib/helloimage/Containerfile
@@ -0,0 +1,8 @@
+FROM registry.access.redhat.com/ubi8-micro:latest
+
+LABEL maintainer="Podman Maintainers"
+LABEL artist="Máirín Ní Ḋuḃṫaiġ, Twitter:@mairin"
+WORKDIR /tmp
+
+COPY podman_hello_world.bash .
+ENTRYPOINT ./podman_hello_world.bash
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
+```
diff --git a/contrib/helloimage/podman_hello_world.bash b/contrib/helloimage/podman_hello_world.bash
new file mode 100755
index 000000000..c28141174
--- /dev/null
+++ b/contrib/helloimage/podman_hello_world.bash
@@ -0,0 +1,23 @@
+#!/bin/sh
+###
+# ASCII art by the incomparable Máirín Duffy,
+# duffy@redhat.com, Twitter: @mairin
+# January 2022
+###
+echo " "
+echo "! ... Hello Podman World ...!"
+echo " "
+echo " .--\"--. "
+echo " / - - \\ "
+echo " / (O) (O) \\ "
+echo " ~~~| -=(,Y,)=- | "
+echo " .---. /\` \\ |~~ "
+echo " ~/ o o \\~~~~.----. ~~ "
+echo " | =(X)= |~ / (O (O) \\ "
+echo " ~~~~~~~ ~| =(Y_)=- | "
+echo " ~~~~ ~~~| U |~~ "
+echo ""
+echo "Project: https://github.com/containers/podman"
+echo "Website: https://podman.io"
+echo "Documents: https://docs.podman.io"
+echo "Twitter: @Podman_io"