Difference between revisions of "Docker run --help"

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

Latest revision as of 09:56, 18 November 2022

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
      --cgroupns string                Cgroup namespace to use
                                       (host|private)
                                       'host':    Run the container in
                                       the Docker host's cgroup namespace
                                       'private': Run the container in
                                       its own private cgroup namespace
                                       :        Use the cgroup
                                       namespace as configured by the
                                                  default-cgroupns-mode
                                       option on the daemon (default)
      --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)
      --platform string                Set platform if server is
                                       multi-platform capable
      --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
      --pull string                    Pull image before running
                                       ("always"|"missing"|"never")
                                       (default "missing") 
      --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 "SIGTERM")
      --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

Related[edit]

See also[edit]

Retrieved from "https://www.wikieduonline.com/index.php?title=Docker_run_--help&oldid=200885"

Advertising: