opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-08-06 19:44:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

remove $-prefix from (most) shell examples

Browse Source 
For the shell examples related to building and installing podman, remove the
shell prompt indicator character '$'.

This makes copying and pasting lines much easier.

Retain the prompt indicator for the post-install shell examples, since they
(often) mix shell commands and shell command output, so it serves a useful
purpose to distinguish them.

Signed-off-by: Jonathan Dowland <jdowland@redhat.com>
This commit is contained in:
Jonathan Dowland
2018-11-09 14:01:41 +00:00
committed by Jonathan Dowland
parent ace93e6a48
commit eb91f82bb2
1 changed files with 51 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
docs/tutorials/podman_tutorial.md
View File

@ -5,10 +5,13 @@ Podman is a utility provided as part of the libpod library. It can be used to c
containers. The following tutorial will teach you how to set up Podman and perform some basic containers. The following tutorial will teach you how to set up Podman and perform some basic
commands with Podman. commands with Podman.
**NOTE**: the code samples are intended to be run as a non-root user, and use `sudo` where
root escalation is required.
## Install Podman on Fedora from RPM Repositories ## Install Podman on Fedora from RPM Repositories
Fedora 27 and later provide Podman via the package manager. Fedora 27 and later provide Podman via the package manager.
```console ```console
$ sudo dnf install -y podman sudo dnf install -y podman
``` ```
## Install Podman on Fedora from Source ## Install Podman on Fedora from Source
@ -18,7 +21,7 @@ acquire the source, and build it.
### Installing build and runtime dependencies ### Installing build and runtime dependencies
```console ```console
$ 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 \ gpgme-devel glib2-devel device-mapper-devel libseccomp-devel \
atomic-registries iptables skopeo-containers containernetworking-cni \ atomic-registries iptables skopeo-containers containernetworking-cni \
conmon conmon
@ -29,12 +32,12 @@ First, configure a `GOPATH` (if you are using go1.8 or later, this defaults to `
and make libpod. and make libpod.
```console ```console
$ export GOPATH=~/go export GOPATH=~/go
$ mkdir -p $GOPATH mkdir -p $GOPATH
$ git clone https://github.com/containers/libpod/ $GOPATH/src/github.com/containers/libpod git clone https://github.com/containers/libpod/ $GOPATH/src/github.com/containers/libpod
$ cd $GOPATH/src/github.com/containers/libpod cd $GOPATH/src/github.com/containers/libpod
$ make 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) You now have a working podman environment. Jump to [Familiarizing yourself with Podman](#familiarizing-yourself-with-podman)
@ -50,8 +53,8 @@ tutorial. For this tutorial, the Ubuntu **artful-server-cloudimg** image was use
#### Installing base packages #### Installing base packages
```console ```console
$ sudo apt-get update sudo apt-get update
$ sudo apt-get install libdevmapper-dev libglib2.0-dev libgpgme11-dev golang libseccomp-dev \ sudo apt-get install libdevmapper-dev libglib2.0-dev libgpgme11-dev golang libseccomp-dev \
go-md2man libprotobuf-dev libprotobuf-c0-dev libseccomp-dev python3-setuptools go-md2man libprotobuf-dev libprotobuf-c0-dev libseccomp-dev python3-setuptools
``` ```
#### Building and installing conmon #### Building and installing conmon
@ -59,42 +62,42 @@ First, configure a `GOPATH` (if you are using go1.8 or later, this defaults to `
and make libpod. and make libpod.
```console ```console
$ export GOPATH=~/go export GOPATH=~/go
$ mkdir -p $GOPATH mkdir -p $GOPATH
$ git clone https://github.com/kubernetes-sigs/cri-o $GOPATH/src/github.com/kubernetes-sigs/cri-o git clone https://github.com/kubernetes-sigs/cri-o $GOPATH/src/github.com/kubernetes-sigs/cri-o
$ cd $GOPATH/src/github.com/kubernetes-sigs/cri-o cd $GOPATH/src/github.com/kubernetes-sigs/cri-o
$ mkdir bin mkdir bin
$ make bin/conmon make bin/conmon
$ sudo install -D -m 755 bin/conmon /usr/libexec/podman/conmon sudo install -D -m 755 bin/conmon /usr/libexec/podman/conmon
``` ```
#### Adding required configuration files #### Adding required configuration files
```console ```console
$ sudo mkdir -p /etc/containers 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/registries/master/registries.fedora -o /etc/containers/registries.conf
$ sudo curl https://raw.githubusercontent.com/containers/skopeo/master/default-policy.json -o /etc/containers/policy.json sudo curl https://raw.githubusercontent.com/containers/skopeo/master/default-policy.json -o /etc/containers/policy.json
``` ```
#### Installing CNI plugins #### Installing CNI plugins
```console ```console
$ git clone https://github.com/containernetworking/plugins.git $GOPATH/src/github.com/containernetworking/plugins git clone https://github.com/containernetworking/plugins.git $GOPATH/src/github.com/containernetworking/plugins
$ cd $GOPATH/src/github.com/containernetworking/plugins cd $GOPATH/src/github.com/containernetworking/plugins
$ ./build_linux.sh ./build_linux.sh
$ sudo mkdir -p /usr/libexec/cni sudo mkdir -p /usr/libexec/cni
$ sudo cp bin/* /usr/libexec/cni sudo cp bin/* /usr/libexec/cni
``` ```
#### Installing runc #### Installing runc
```console ```console
$ git clone https://github.com/opencontainers/runc.git $GOPATH/src/github.com/opencontainers/runc git clone https://github.com/opencontainers/runc.git $GOPATH/src/github.com/opencontainers/runc
$ cd $GOPATH/src/github.com/opencontainers/runc cd $GOPATH/src/github.com/opencontainers/runc
$ make BUILDTAGS="seccomp" make BUILDTAGS="seccomp"
$ sudo cp runc /usr/bin/runc sudo cp runc /usr/bin/runc
``` ```
### Building and installing Podman ### Building and installing Podman
```console ```console
$ git clone https://github.com/containers/libpod/ $GOPATH/src/github.com/containers/libpod git clone https://github.com/containers/libpod/ $GOPATH/src/github.com/containers/libpod
$ cd $GOPATH/src/github.com/containers/libpod cd $GOPATH/src/github.com/containers/libpod
$ make make
$ sudo make install PREFIX=/usr sudo make install PREFIX=/usr
``` ```
## Familiarizing yourself with Podman ## Familiarizing yourself with Podman
@ -103,7 +106,7 @@ $ sudo make install PREFIX=/usr
This sample container will run a very basic httpd server that serves only its index This sample container will run a very basic httpd server that serves only its index
page. page.
```console ```console
$ 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_MAIN_CONF_PATH=/etc/httpd/conf \
-e HTTPD_CONTAINER_SCRIPTS_PATH=/usr/share/container-scripts/httpd/ \ -e HTTPD_CONTAINER_SCRIPTS_PATH=/usr/share/container-scripts/httpd/ \
registry.fedoraproject.org/f27/httpd /usr/bin/run-httpd registry.fedoraproject.org/f27/httpd /usr/bin/run-httpd
@ -114,7 +117,7 @@ will print the container ID after it has run.
### Listing running containers ### Listing running containers
The Podman *ps* command is used to list creating and running containers. The Podman *ps* command is used to list creating and running containers.
```console ```console
$ sudo podman ps sudo podman ps
``` ```
Note: If you add *-a* to the *ps* command, Podman will show all containers. Note: If you add *-a* to the *ps* command, Podman will show all containers.
@ -134,7 +137,7 @@ Now that we have the IP address of the container, we can test the network commun
operating system and the container using curl. The following command should display the index page of our operating system and the container using curl. The following command should display the index page of our
containerized httpd server. containerized httpd server.
```console ```console
# curl http://<IP_address>:8080 curl http://<IP_address>:8080
``` ```
### Viewing the container's logs ### Viewing the container's logs
@ -163,7 +166,7 @@ With this a container can later be restored and continue running at exactly the
checkpoint. This capability requires CRIU 3.11 or later installed on the system. checkpoint. This capability requires CRIU 3.11 or later installed on the system.
To checkpoint the container use: To checkpoint the container use:
```console ```console
$ sudo podman container checkpoint <container_id> sudo podman container checkpoint <container_id>
``` ```
### Restoring the container ### Restoring the container
@ -171,29 +174,29 @@ Restoring a container is only possible for a previously checkpointed container.
continue to run at exactly the same point in time it was checkpointed. continue to run at exactly the same point in time it was checkpointed.
To restore the container use: To restore the container use:
```console ```console
$ sudo podman container restore <container_id> sudo podman container restore <container_id>
``` ```
After being restored, the container will answer requests again as it did before checkpointing. After being restored, the container will answer requests again as it did before checkpointing.
```console ```console
# curl http://<IP_address>:8080 curl http://<IP_address>:8080
``` ```
### Stopping the container ### Stopping the container
To stop the httpd container: To stop the httpd container:
```console ```console
$ 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 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. use the *-a* argument to list all containers.
```console ```console
$ sudo podman ps -a sudo podman ps -a
``` ```
### Removing the container ### Removing the container
To remove the httpd container: To remove the httpd container:
```console ```console
$ sudo podman rm --latest sudo podman rm --latest
``` ```
You can verify the deletion of the container by running *podman ps -a*. You can verify the deletion of the container by running *podman ps -a*.