diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/podman-build.1.md | 3 | ||||
| -rw-r--r-- | docs/podman-inspect.1.md | 10 | ||||
| -rw-r--r-- | docs/podman-login.1.md | 3 | ||||
| -rw-r--r-- | docs/podman-pull.1.md | 7 | ||||
| -rw-r--r-- | docs/podman-push.1.md | 7 | ||||
| -rw-r--r-- | docs/podman-search.1.md | 115 | ||||
| -rw-r--r-- | docs/podman-stop.1.md | 4 | ||||
| -rw-r--r-- | docs/tutorials/podman_tutorial.md | 42 |
8 files changed, 163 insertions, 28 deletions
diff --git a/docs/podman-build.1.md b/docs/podman-build.1.md index 61c8d8aaa..d4e9af175 100644 --- a/docs/podman-build.1.md +++ b/docs/podman-build.1.md @@ -38,7 +38,8 @@ resulting image's configuration. **--cert-dir** *path* -Use certificates at *path* (*.crt, *.cert, *.key) to connect to the registry +Use certificates at *path* (*.crt, *.cert, *.key) to connect to the registry. +Default certificates directory is _/etc/containers/certs.d_. **--creds** *creds* diff --git a/docs/podman-inspect.1.md b/docs/podman-inspect.1.md index 5b8a344d7..e40dfa29f 100644 --- a/docs/podman-inspect.1.md +++ b/docs/podman-inspect.1.md @@ -79,6 +79,16 @@ Display the total file size if the type is a container } ``` +``` +# podman inspect a04 --format "{{.ImageName}}" +fedora +``` + +``` +$ sudo podman inspect a04 --format "{{.GraphDriver.Name}}" +overlay +``` + ## SEE ALSO podman(1) diff --git a/docs/podman-login.1.md b/docs/podman-login.1.md index fcf32870a..b22a02553 100644 --- a/docs/podman-login.1.md +++ b/docs/podman-login.1.md @@ -38,7 +38,8 @@ Username for registry Path of the authentication file. Default is ${XDG_\RUNTIME\_DIR}/containers/auth.json **--cert-dir** -Pathname of a directory containing TLS certificates and keys used to connect to the registry +Pathname of a directory containing TLS certificates and keys used to connect to the registry. +Default certificates directory is _/etc/containers/certs.d_. **--tls-verify** Require HTTPS and verify certificates when contacting registries (default: true) diff --git a/docs/podman-pull.1.md b/docs/podman-pull.1.md index b1212ee6b..1a1611fd0 100644 --- a/docs/podman-pull.1.md +++ b/docs/podman-pull.1.md @@ -61,11 +61,14 @@ If the authorization state is not found there, $HOME/.docker/config.json is chec **--cert-dir** -Pathname of a directory containing TLS certificates and keys +Pathname of a directory containing TLS certificates and keys. +Default certificates directory is _/etc/containers/certs.d_. **--creds** -Credentials (USERNAME:PASSWORD) to use for authenticating to a registry +The [username[:password]] to use to authenticate with the registry if required. +If one or both values are not supplied, a command line prompt will appear and the +value can be entered. The password is entered without echo. **--quiet, -q** diff --git a/docs/podman-push.1.md b/docs/podman-push.1.md index 63c75ea36..964758da6 100644 --- a/docs/podman-push.1.md +++ b/docs/podman-push.1.md @@ -53,11 +53,14 @@ If the authorization state is not found there, $HOME/.docker/config.json is chec **--creds="CREDENTIALS"** -Credentials (USERNAME:PASSWORD) to use for authenticating to a registry +The [username[:password]] to use to authenticate with the registry if required. +If one or both values are not supplied, a command line prompt will appear and the +value can be entered. The password is entered without echo. **cert-dir="PATHNAME"** -Pathname of a directory containing TLS certificates and keys +Pathname of a directory containing TLS certificates and keys. +Default certificates directory is _/etc/containers/certs.d_. **--compress** diff --git a/docs/podman-search.1.md b/docs/podman-search.1.md new file mode 100644 index 000000000..668748d3f --- /dev/null +++ b/docs/podman-search.1.md @@ -0,0 +1,115 @@ +% podman(1) podman-search - Tool to search registries for an image +% Urvashi Mohnani +# podman-search "1" "January 2018" "podman" + +## NAME +podman search - Search a registry for an image + +## SYNOPSIS +**podman search** +**TERM** +[**--filter**|**-f**] +[**--format**] +[**--limit**] +[**--no-trunc**] +[**--registry**] +[**--help**|**-h**] + +## DESCRIPTION +**podman search** searches a registry or a list of registries for a matching image. +The user can specify which registry to search by setting the **--registry** flag, default +is the default registries set in the config file - **/etc/containers/registries.conf**. +The number of results can be limited using the **--limit** flag. If more than one registry +is being searched, the limit will be applied to each registry. The output can be filtered +using the **--filter** flag. + +**podman [GLOBAL OPTIONS]** + +**podman search [GLOBAL OPTIONS]** + +**podman search [OPTIONS] TERM** + +## OPTIONS + +**--filter, -f** +Filter output based on conditions provided (default []) + +Supported filters are: +- stars (int - number of stars the image has) +- is-automated (boolean - true | false) - is the image automated or not +- is-official (boolean - true | false) - is the image official or not + +**--format** +Change the output format to a Go template + +Valid placeholders for the Go template are listed below: + +| **Placeholder** | **Description** | +| --------------- | ---------------------------- | +| .Index | Registry | +| .Name | Image name | +| .Descriptions | Image description | +| .Stars | Star count of image | +| .Official | "[OK]" if image is official | +| .Automated | "[OK]" if image is automated | + +**--limit** +Limit the number of results +Note: The results from each registry will be limited to this value. +Example if limit is 10 and two registries are being searched, the total +number of results will be 20, 10 from each (if there are at least 10 matches in each). +The order of the search results is the order in which the API endpoint returns the results. + +**--no-trunc** +Do not truncate the output + +**--registry** +Specific registry to search (only the given registry will be searched, not the default registries) + +## EXAMPLES + +``` +# podman search --limit 3 rhel +INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED +docker.io docker.io/richxsl/rhel7 RHEL 7 image with minimal installation 9 +docker.io docker.io/bluedata/rhel7 RHEL-7.x base container images 1 +docker.io docker.io/gidikern/rhel-oracle-jre RHEL7 with jre8u60 5 [OK] +redhat.com redhat.com/rhel This platform image provides a minimal runti... 0 +redhat.com redhat.com/rhel6 This platform image provides a minimal runti... 0 +redhat.com redhat.com/rhel6.5 This platform image provides a minimal runti... 0 +``` + +``` +# podman search alpine +INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED +docker.io docker.io/library/alpine A minimal Docker image based on Alpine Linux... 3009 [OK] +docker.io docker.io/mhart/alpine-node Minimal Node.js built on Alpine Linux 332 +docker.io docker.io/anapsix/alpine-java Oracle Java 8 (and 7) with GLIBC 2.23 over A... 272 [OK] +docker.io docker.io/tenstartups/alpine Alpine linux base docker image with useful p... 5 [OK] +``` + +``` +# podman search --registry registry.fedoraproject.org fedora +INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED +fedoraproject.org fedoraproject.org/fedora 0 +fedoraproject.org fedoraproject.org/fedora-minimal 0 +``` + +``` +# podman search --filter=is-official alpine +INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED +docker.io docker.io/library/alpine A minimal Docker image based on Alpine Linux... 3009 [OK] +``` + +``` +# podman search --registry registry.fedoraproject.org --format "table {{.Index}} {{.Name}}" fedora +INDEX NAME +fedoraproject.org fedoraproject.org/fedora +fedoraproject.org fedoraproject.org/fedora-minimal +``` + +## SEE ALSO +podman(1), crio(8), crio.conf(5) + +## HISTORY +January 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> diff --git a/docs/podman-stop.1.md b/docs/podman-stop.1.md index f4372be5f..58cb2c39c 100644 --- a/docs/podman-stop.1.md +++ b/docs/podman-stop.1.md @@ -11,7 +11,9 @@ podman stop - Stop one or more containers ## DESCRIPTION Stops one or more containers. You may use container IDs or names as input. The **--timeout** switch allows you to specify the number of seconds to wait before forcibly stopping the container after the stop command -is issued to the container. The default is 10 seconds. +is issued to the container. The default is 10 seconds. By default, containers are stopped with SIGTERM +and then SIGKILL after the timeout. The SIGTERM default can be overridden by the image used to create the +container and also via command line when creating the container. ## OPTIONS diff --git a/docs/tutorials/podman_tutorial.md b/docs/tutorials/podman_tutorial.md index 8402dd74b..5e174ac6b 100644 --- a/docs/tutorials/podman_tutorial.md +++ b/docs/tutorials/podman_tutorial.md @@ -12,7 +12,7 @@ for Podman until an RPM becomes available. ### Installing build and runtime dependencies ``` -# sudo dnf install -y git runc libassuan-devel golang golang-github-cpuguy83-go-md2man glibc-static \ +$ sudo dnf install -y git runc libassuan-devel golang golang-github-cpuguy83-go-md2man glibc-static \ gpgme-devel glib2-devel device-mapper-devel libseccomp-devel \ atomic-registries iptables skopeo-containers containernetworking-cni \ conmon @@ -22,7 +22,7 @@ for Podman until an RPM becomes available. # git clone https://github.com/projectatomic/libpod/ ~/src/github.com/projectatomic/libpod # cd !$ # make -# sudo make install PREFIX=/usr +$ sudo make install PREFIX=/usr ``` You now have a working podman environment. Jump to [Familiarizing yourself with Podman](Familiarizing yourself with Podman) @@ -38,8 +38,8 @@ tutorial. For this tutorial, the Ubuntu **artful-server-cloudimg** image was use #### Installing base packages ``` -# sudo apt-get update -# sudo apt-get install libdevmapper-dev libglib2.0-dev libgpgme11-dev golang libseccomp-dev \ +$ sudo apt-get update +$ sudo apt-get install libdevmapper-dev libglib2.0-dev libgpgme11-dev golang libseccomp-dev \ go-md2man libprotobuf-dev libprotobuf-c0-dev libseccomp-dev ``` #### Building and installing conmon @@ -48,28 +48,28 @@ tutorial. For this tutorial, the Ubuntu **artful-server-cloudimg** image was use # cd ~/src/github.com/kubernetes-incubator/cri-o # mkdir bin # make conmon -# sudo install -D -m 755 bin/conmon /usr/libexec/crio/conmon +$ sudo install -D -m 755 bin/conmon /usr/libexec/crio/conmon ``` #### Adding required configuration files ``` -# sudo mkdir -p /etc/containers -# sudo curl https://raw.githubusercontent.com/projectatomic/registries/master/registries.fedora -o /etc/containers/registries.conf -# sudo curl https://raw.githubusercontent.com/projectatomic/skopeo/master/default-policy.json -o /etc/containers/policy.json +$ sudo mkdir -p /etc/containers +$ sudo curl https://raw.githubusercontent.com/projectatomic/registries/master/registries.fedora -o /etc/containers/registries.conf +$ sudo curl https://raw.githubusercontent.com/projectatomic/skopeo/master/default-policy.json -o /etc/containers/policy.json ``` #### Installing CNI plugins ``` # git clone https://github.com/containernetworking/plugins.git ~/src/github.com/containernetworking/plugins # cd ~/src/github.com/containernetworking/plugins # ./build.sh -# sudo mkdir -p /usr/libexec/cni -# sudo cp bin/* /usr/libexec/cni +$ sudo mkdir -p /usr/libexec/cni +$ sudo cp bin/* /usr/libexec/cni ``` #### Installing runc ``` # git clone https://github.com/opencontainers/runc.git ~/src/github.com/opencontainers/runc # cd ~/src/github.com/opencontainers/runc # GOPATH=~/ make static BUILDTAGS="seccomp selinux" -# sudo cp runc /usr/bin/runc +$ sudo cp runc /usr/bin/runc ``` ### Building and installing Podman @@ -77,7 +77,7 @@ tutorial. For this tutorial, the Ubuntu **artful-server-cloudimg** image was use # git clone https://github.com/projectatomic/libpod/ ~/src/github.com/projectatomic/libpod # cd ~/src/github.com/projectatomic/libpod # make -# sudo make install PREFIX=/usr +$ sudo make install PREFIX=/usr ``` ## Familiarizing yourself with Podman @@ -86,7 +86,7 @@ tutorial. For this tutorial, the Ubuntu **artful-server-cloudimg** image was use This sample container will run a very basic httpd server that serves only its index page. ``` -# sudo podman run -dt -e HTTPD_VAR_RUN=/var/run/httpd -e HTTPD_MAIN_CONF_D_PATH=/etc/httpd/conf.d \ +$ sudo podman run -dt -e HTTPD_VAR_RUN=/var/run/httpd -e HTTPD_MAIN_CONF_D_PATH=/etc/httpd/conf.d \ -e HTTPD_MAIN_CONF_PATH=/etc/httpd/conf \ -e HTTPD_CONTAINER_SCRIPTS_PATH=/usr/share/container-scripts/httpd/ \ registry.fedoraproject.org/f26/httpd /usr/bin/run-httpd @@ -97,7 +97,7 @@ will print the container ID after it has run. ### Listing running containers The Podman *ps* command is used to list creating and running containers. ``` -# sudo podman ps +$ sudo podman ps ``` Note: If you add *-a* to the *ps* command, Podman will show all containers. @@ -109,8 +109,8 @@ install *iproute* in the container. Notice here that we use the switch **--late created container. You could also use the container's ID listed during *podman ps* in the previous step or when you ran the container. ``` -# sudo podman exec --latest -t dnf -y install iproute -# sudo podman exec --latest -t ip a +$ sudo podman exec --latest -t dnf -y install iproute +$ sudo podman exec --latest -t ip a ``` Note the IP address of the *ethernet* device. @@ -126,30 +126,30 @@ containerized httpd server. ### Viewing the container's logs You can view the container's logs with Podman as well: ``` -# sudo podman logs --latest +$ sudo podman logs --latest ``` <!-- ( ### Viewing the container's pids And you can observe the httpd pid in the container with *top*. ``` -# sudo podman top <container_id> +$ sudo podman top <container_id> ``` ) --> ### Stopping the container To stop the httpd container: ``` -# sudo podman stop --latest +$ sudo podman stop --latest ``` You can also check the status of one or more containers using the *ps* subcommand. In this case, we should use the *-a* argument to list all containers. ``` -# sudo podman ps -a +$ sudo podman ps -a ``` ### Removing the container To remove the httpd container: ``` -# sudo podman rm --latest +$ sudo podman rm --latest ``` You can verify the deletion of the container by running *podman ps -a*. ## More information |