Docker run

Introduction

The command docker run has very many capabilities. It is not limited to simply starting containers. You can combine the start with internal commands of the software in the container, redirect ports and much more.

Basics

The syntax is as follows

docker run [OPTIONS] IMAGE [COMMAND] [ARG...]

-d: detached mode

-d background mode. Starting a daemon.

Simply put, your console will not be blocked if you apply -d - the container will start as a daemon.

The logs will not be visible either, but they can be viewed with logs .

docker run -d container_name

--name: set a name

--name sets your own name.

docker run --name any_name image_name

If you do not name your container in any way, Docker will do it for you

Port Mapping

-p port forwarding or port mapping

docker run -p <externalPort>:<internalPort> image_name

In other words

docker run -p <hostPort>:<containerPort> image_name

Example

docker run -p 80:80 myimage

where 80 is your host port and 80 is the container port.

Let us consider the simplest example. By default I have the docker101tutorial image downloaded

I do not want to occupy port 80 of my machine, so I will make the container listen on my port 9570 and redirect to its own 80.

docker run -dp 9570:80 docker101tutorial

Now, to open the tutorial in a browser, I need to go to http://localhost:9570/tutorial/

Docker container port forwarding, image from www.eth1.ru

If you now run

docker ps -a

CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES ce4a965e13a2 docker101tutorial "/docker-entrypoint.…" 19 minutes ago Up 19 minutes 0.0.0.0:9570->80/tcp wizardly_hermann

In the PORTS column you can see how the mapping is configured.

It also stands out that the command was run without the --name flag. Docker came up with a great name, wizardly_herman, which does not suit me at all, so I will do the following

docker stop wizardly_hermann
docker rm wizardly_hermann
docker run -dp 9570:80 --name docker-tutorial docker101tutorial
docker ps -a

CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 39297868081b docker101tutorial "/docker-entrypoint.…" 14 seconds ago Up 14 seconds 0.0.0.0:9570->80/tcp docker-tutorial

Now the name better conveys the point.

-v: Volume

When you need to use some directory from the host inside the container, it can be mounted there with -v

docker run -v hostDirectory:containerDirectory

The simplest example can be studied in the article «A container with Nginx»

--rm: clean up after yourself

By default the container's file system is preserved even after exiting the container.

This simplifies debugging, since the final state can be investigated. All data also remains available.

When a large number of short-lived foreground processes are used, this data can take up a lot of space.

Docker can be configured so that it deletes the file systems of closed containers.

To do this the container has to be started with the --rm flag

--rm=false: Automatically remove the container when it exits

If the --rm flag is set, Docker will also remove the anonymous volumes associated with the container when it deletes the container.

This is similar to running docker rm -v my-container. Only volumes that are specified without a name are removed. For example, when running:

docker run --rm -v /foo -v awesome:/bar busybox top

the volume for /foo will be removed, but the volume for /bar will not.

Volumes inherited via --volumes-from will be removed with the same logic: if the original volume was specified with a name it will not be removed.

Commands inside the container

Banner image

All options

The list of all available options can be obtained by running

docker run --help

Usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...] Run a command in a new container Options: --add-host list Add a custom host-to-IP mapping (host:ip) -a, --attach list Attach to STDIN, STDOUT or STDERR --blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) --blkio-weight-device list Block IO weight (relative device weight) (default []) --cap-add list Add Linux capabilities --cap-drop list Drop Linux capabilities --cgroup-parent string Optional parent cgroup for the container --cidfile string Write the container ID to the file --cpu-period int Limit CPU CFS (Completely Fair Scheduler) period --cpu-quota int Limit CPU CFS (Completely Fair Scheduler) quota --cpu-rt-period int Limit CPU real-time period in microseconds --cpu-rt-runtime int Limit CPU real-time runtime in microseconds -c, --cpu-shares int CPU shares (relative weight) --cpus decimal Number of CPUs --cpuset-cpus string CPUs in which to allow execution (0-3, 0,1) --cpuset-mems string MEMs in which to allow execution (0-3, 0,1) -d, --detach Run container in background and print container ID --detach-keys string Override the key sequence for detaching a container --device list Add a host device to the container --device-cgroup-rule list Add a rule to the cgroup allowed devices list --device-read-bps list Limit read rate (bytes per second) from a device (default []) --device-read-iops list Limit read rate (IO per second) from a device (default []) --device-write-bps list Limit write rate (bytes per second) to a device (default []) --device-write-iops list Limit write rate (IO per second) to a device (default []) --disable-content-trust Skip image verification (default true) --dns list Set custom DNS servers --dns-option list Set DNS options --dns-search list Set custom DNS search domains --domainname string Container NIS domain name --entrypoint string Overwrite the default ENTRYPOINT of the image -e, --env list Set environment variables --env-file list Read in a file of environment variables --expose list Expose a port or a range of ports --gpus gpu-request GPU devices to add to the container ('all' to pass all GPUs) --group-add list Add additional groups to join --health-cmd string Command to run to check health --health-interval duration Time between running the check (ms|s|m|h) (default 0s) --health-retries int Consecutive failures needed to report unhealthy --health-start-period duration Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s) --health-timeout duration Maximum time to allow one check to run (ms|s|m|h) (default 0s) --help Print usage -h, --hostname string Container host name --init Run an init inside the container that forwards signals and reaps processes -i, --interactive Keep STDIN open even if not attached --ip string IPv4 address (e.g., 172.30.100.104) --ip6 string IPv6 address (e.g., 2001:db8::33) --ipc string IPC mode to use --isolation string Container isolation technology --kernel-memory bytes Kernel memory limit -l, --label list Set meta data on a container --label-file list Read in a line delimited file of labels --link list Add link to another container --link-local-ip list Container IPv4/IPv6 link-local addresses --log-driver string Logging driver for the container --log-opt list Log driver options --mac-address string Container MAC address (e.g., 92:d0:c6:0a:29:33) -m, --memory bytes Memory limit --memory-reservation bytes Memory soft limit --memory-swap bytes Swap limit equal to memory plus swap: '-1' to enable unlimited swap --memory-swappiness int Tune container memory swappiness (0 to 100) (default -1) --mount mount Attach a filesystem mount to the container --name string Assign a name to the container --network network Connect a container to a network --network-alias list Add network-scoped alias for the container --no-healthcheck Disable any container-specified HEALTHCHECK --oom-kill-disable Disable OOM Killer --oom-score-adj int Tune host's OOM preferences (-1000 to 1000) --pid string PID namespace to use --pids-limit int Tune container pids limit (set -1 for unlimited) --privileged Give extended privileges to this container -p, --publish list Publish a container's port(s) to the host -P, --publish-all Publish all exposed ports to random ports --read-only Mount the container's root filesystem as read only --restart string Restart policy to apply when a container exits (default "no") --rm Automatically remove the container when it exits --runtime string Runtime to use for this container --security-opt list Security Options --shm-size bytes Size of /dev/shm --sig-proxy Proxy received signals to the process (default true) --stop-signal string Signal to stop a container (default "15") --stop-timeout int Timeout (in seconds) to stop a container --storage-opt list Storage driver options for the container --sysctl map Sysctl options (default map[]) --tmpfs list Mount a tmpfs directory -t, --tty Allocate a pseudo-TTY --ulimit ulimit Ulimit options (default []) -u, --user string Username or UID (format: <name|uid>[:<group|gid>]) --userns string User namespace to use --uts string UTS namespace to use -v, --volume list Bind mount a volume --volume-driver string Optional volume driver for the container --volumes-from list Mount volumes from the specified container(s) -w, --workdir string Working directory inside the container

Article author: Andrei Olegovich