github.com/khulnasoft/cli@v0.0.0-20240402070845-01bcad7beefa/docs/reference/commandline/create.md (about)

     1  # docker create
     2  
     3  <!---MARKER_GEN_START-->
     4  Create a new container
     5  
     6  ### Aliases
     7  
     8  `docker container create`, `docker create`
     9  
    10  ### Options
    11  
    12  | Name                      | Type          | Default   | Description                                                                                                                                                                                                                                                                                                      |
    13  |:--------------------------|:--------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
    14  | `--add-host`              | `list`        |           | Add a custom host-to-IP mapping (host:ip)                                                                                                                                                                                                                                                                        |
    15  | `--annotation`            | `map`         | `map[]`   | Add an annotation to the container (passed through to the OCI runtime)                                                                                                                                                                                                                                           |
    16  | `-a`, `--attach`          | `list`        |           | Attach to STDIN, STDOUT or STDERR                                                                                                                                                                                                                                                                                |
    17  | `--blkio-weight`          | `uint16`      | `0`       | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)                                                                                                                                                                                                                                     |
    18  | `--blkio-weight-device`   | `list`        |           | Block IO weight (relative device weight)                                                                                                                                                                                                                                                                         |
    19  | `--cap-add`               | `list`        |           | Add Linux capabilities                                                                                                                                                                                                                                                                                           |
    20  | `--cap-drop`              | `list`        |           | Drop Linux capabilities                                                                                                                                                                                                                                                                                          |
    21  | `--cgroup-parent`         | `string`      |           | Optional parent cgroup for the container                                                                                                                                                                                                                                                                         |
    22  | `--cgroupns`              | `string`      |           | Cgroup namespace to use (host\|private)<br>'host':    Run the container in the Docker host's cgroup namespace<br>'private': Run the container in its own private cgroup namespace<br>'':        Use the cgroup namespace as configured by the<br>           default-cgroupns-mode option on the daemon (default) |
    23  | `--cidfile`               | `string`      |           | Write the container ID to the file                                                                                                                                                                                                                                                                               |
    24  | `--cpu-count`             | `int64`       | `0`       | CPU count (Windows only)                                                                                                                                                                                                                                                                                         |
    25  | `--cpu-percent`           | `int64`       | `0`       | CPU percent (Windows only)                                                                                                                                                                                                                                                                                       |
    26  | `--cpu-period`            | `int64`       | `0`       | Limit CPU CFS (Completely Fair Scheduler) period                                                                                                                                                                                                                                                                 |
    27  | `--cpu-quota`             | `int64`       | `0`       | Limit CPU CFS (Completely Fair Scheduler) quota                                                                                                                                                                                                                                                                  |
    28  | `--cpu-rt-period`         | `int64`       | `0`       | Limit CPU real-time period in microseconds                                                                                                                                                                                                                                                                       |
    29  | `--cpu-rt-runtime`        | `int64`       | `0`       | Limit CPU real-time runtime in microseconds                                                                                                                                                                                                                                                                      |
    30  | `-c`, `--cpu-shares`      | `int64`       | `0`       | CPU shares (relative weight)                                                                                                                                                                                                                                                                                     |
    31  | `--cpus`                  | `decimal`     |           | Number of CPUs                                                                                                                                                                                                                                                                                                   |
    32  | `--cpuset-cpus`           | `string`      |           | CPUs in which to allow execution (0-3, 0,1)                                                                                                                                                                                                                                                                      |
    33  | `--cpuset-mems`           | `string`      |           | MEMs in which to allow execution (0-3, 0,1)                                                                                                                                                                                                                                                                      |
    34  | `--device`                | `list`        |           | Add a host device to the container                                                                                                                                                                                                                                                                               |
    35  | `--device-cgroup-rule`    | `list`        |           | Add a rule to the cgroup allowed devices list                                                                                                                                                                                                                                                                    |
    36  | `--device-read-bps`       | `list`        |           | Limit read rate (bytes per second) from a device                                                                                                                                                                                                                                                                 |
    37  | `--device-read-iops`      | `list`        |           | Limit read rate (IO per second) from a device                                                                                                                                                                                                                                                                    |
    38  | `--device-write-bps`      | `list`        |           | Limit write rate (bytes per second) to a device                                                                                                                                                                                                                                                                  |
    39  | `--device-write-iops`     | `list`        |           | Limit write rate (IO per second) to a device                                                                                                                                                                                                                                                                     |
    40  | `--disable-content-trust` | `bool`        | `true`    | Skip image verification                                                                                                                                                                                                                                                                                          |
    41  | `--dns`                   | `list`        |           | Set custom DNS servers                                                                                                                                                                                                                                                                                           |
    42  | `--dns-option`            | `list`        |           | Set DNS options                                                                                                                                                                                                                                                                                                  |
    43  | `--dns-search`            | `list`        |           | Set custom DNS search domains                                                                                                                                                                                                                                                                                    |
    44  | `--domainname`            | `string`      |           | Container NIS domain name                                                                                                                                                                                                                                                                                        |
    45  | `--entrypoint`            | `string`      |           | Overwrite the default ENTRYPOINT of the image                                                                                                                                                                                                                                                                    |
    46  | `-e`, `--env`             | `list`        |           | Set environment variables                                                                                                                                                                                                                                                                                        |
    47  | `--env-file`              | `list`        |           | Read in a file of environment variables                                                                                                                                                                                                                                                                          |
    48  | `--expose`                | `list`        |           | Expose a port or a range of ports                                                                                                                                                                                                                                                                                |
    49  | `--gpus`                  | `gpu-request` |           | GPU devices to add to the container ('all' to pass all GPUs)                                                                                                                                                                                                                                                     |
    50  | `--group-add`             | `list`        |           | Add additional groups to join                                                                                                                                                                                                                                                                                    |
    51  | `--health-cmd`            | `string`      |           | Command to run to check health                                                                                                                                                                                                                                                                                   |
    52  | `--health-interval`       | `duration`    | `0s`      | Time between running the check (ms\|s\|m\|h) (default 0s)                                                                                                                                                                                                                                                        |
    53  | `--health-retries`        | `int`         | `0`       | Consecutive failures needed to report unhealthy                                                                                                                                                                                                                                                                  |
    54  | `--health-start-interval` | `duration`    | `0s`      | Time between running the check during the start period (ms\|s\|m\|h) (default 0s)                                                                                                                                                                                                                                |
    55  | `--health-start-period`   | `duration`    | `0s`      | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s)                                                                                                                                                                                                 |
    56  | `--health-timeout`        | `duration`    | `0s`      | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s)                                                                                                                                                                                                                                                |
    57  | `--help`                  |               |           | Print usage                                                                                                                                                                                                                                                                                                      |
    58  | `-h`, `--hostname`        | `string`      |           | Container host name                                                                                                                                                                                                                                                                                              |
    59  | `--init`                  |               |           | Run an init inside the container that forwards signals and reaps processes                                                                                                                                                                                                                                       |
    60  | `-i`, `--interactive`     |               |           | Keep STDIN open even if not attached                                                                                                                                                                                                                                                                             |
    61  | `--io-maxbandwidth`       | `bytes`       | `0`       | Maximum IO bandwidth limit for the system drive (Windows only)                                                                                                                                                                                                                                                   |
    62  | `--io-maxiops`            | `uint64`      | `0`       | Maximum IOps limit for the system drive (Windows only)                                                                                                                                                                                                                                                           |
    63  | `--ip`                    | `string`      |           | IPv4 address (e.g., 172.30.100.104)                                                                                                                                                                                                                                                                              |
    64  | `--ip6`                   | `string`      |           | IPv6 address (e.g., 2001:db8::33)                                                                                                                                                                                                                                                                                |
    65  | `--ipc`                   | `string`      |           | IPC mode to use                                                                                                                                                                                                                                                                                                  |
    66  | `--isolation`             | `string`      |           | Container isolation technology                                                                                                                                                                                                                                                                                   |
    67  | `--kernel-memory`         | `bytes`       | `0`       | Kernel memory limit                                                                                                                                                                                                                                                                                              |
    68  | `-l`, `--label`           | `list`        |           | Set meta data on a container                                                                                                                                                                                                                                                                                     |
    69  | `--label-file`            | `list`        |           | Read in a line delimited file of labels                                                                                                                                                                                                                                                                          |
    70  | `--link`                  | `list`        |           | Add link to another container                                                                                                                                                                                                                                                                                    |
    71  | `--link-local-ip`         | `list`        |           | Container IPv4/IPv6 link-local addresses                                                                                                                                                                                                                                                                         |
    72  | `--log-driver`            | `string`      |           | Logging driver for the container                                                                                                                                                                                                                                                                                 |
    73  | `--log-opt`               | `list`        |           | Log driver options                                                                                                                                                                                                                                                                                               |
    74  | `--mac-address`           | `string`      |           | Container MAC address (e.g., 92:d0:c6:0a:29:33)                                                                                                                                                                                                                                                                  |
    75  | `-m`, `--memory`          | `bytes`       | `0`       | Memory limit                                                                                                                                                                                                                                                                                                     |
    76  | `--memory-reservation`    | `bytes`       | `0`       | Memory soft limit                                                                                                                                                                                                                                                                                                |
    77  | `--memory-swap`           | `bytes`       | `0`       | Swap limit equal to memory plus swap: '-1' to enable unlimited swap                                                                                                                                                                                                                                              |
    78  | `--memory-swappiness`     | `int64`       | `-1`      | Tune container memory swappiness (0 to 100)                                                                                                                                                                                                                                                                      |
    79  | `--mount`                 | `mount`       |           | Attach a filesystem mount to the container                                                                                                                                                                                                                                                                       |
    80  | `--name`                  | `string`      |           | Assign a name to the container                                                                                                                                                                                                                                                                                   |
    81  | `--network`               | `network`     |           | Connect a container to a network                                                                                                                                                                                                                                                                                 |
    82  | `--network-alias`         | `list`        |           | Add network-scoped alias for the container                                                                                                                                                                                                                                                                       |
    83  | `--no-healthcheck`        |               |           | Disable any container-specified HEALTHCHECK                                                                                                                                                                                                                                                                      |
    84  | `--oom-kill-disable`      |               |           | Disable OOM Killer                                                                                                                                                                                                                                                                                               |
    85  | `--oom-score-adj`         | `int`         | `0`       | Tune host's OOM preferences (-1000 to 1000)                                                                                                                                                                                                                                                                      |
    86  | `--pid`                   | `string`      |           | PID namespace to use                                                                                                                                                                                                                                                                                             |
    87  | `--pids-limit`            | `int64`       | `0`       | Tune container pids limit (set -1 for unlimited)                                                                                                                                                                                                                                                                 |
    88  | `--platform`              | `string`      |           | Set platform if server is multi-platform capable                                                                                                                                                                                                                                                                 |
    89  | `--privileged`            |               |           | Give extended privileges to this container                                                                                                                                                                                                                                                                       |
    90  | `-p`, `--publish`         | `list`        |           | Publish a container's port(s) to the host                                                                                                                                                                                                                                                                        |
    91  | `-P`, `--publish-all`     |               |           | Publish all exposed ports to random ports                                                                                                                                                                                                                                                                        |
    92  | `--pull`                  | `string`      | `missing` | Pull image before creating (`always`, `\|missing`, `never`)                                                                                                                                                                                                                                                      |
    93  | `-q`, `--quiet`           |               |           | Suppress the pull output                                                                                                                                                                                                                                                                                         |
    94  | `--read-only`             |               |           | Mount the container's root filesystem as read only                                                                                                                                                                                                                                                               |
    95  | `--restart`               | `string`      | `no`      | Restart policy to apply when a container exits                                                                                                                                                                                                                                                                   |
    96  | `--rm`                    |               |           | Automatically remove the container when it exits                                                                                                                                                                                                                                                                 |
    97  | `--runtime`               | `string`      |           | Runtime to use for this container                                                                                                                                                                                                                                                                                |
    98  | `--security-opt`          | `list`        |           | Security Options                                                                                                                                                                                                                                                                                                 |
    99  | `--shm-size`              | `bytes`       | `0`       | Size of /dev/shm                                                                                                                                                                                                                                                                                                 |
   100  | `--stop-signal`           | `string`      |           | Signal to stop the container                                                                                                                                                                                                                                                                                     |
   101  | `--stop-timeout`          | `int`         | `0`       | Timeout (in seconds) to stop a container                                                                                                                                                                                                                                                                         |
   102  | `--storage-opt`           | `list`        |           | Storage driver options for the container                                                                                                                                                                                                                                                                         |
   103  | `--sysctl`                | `map`         | `map[]`   | Sysctl options                                                                                                                                                                                                                                                                                                   |
   104  | `--tmpfs`                 | `list`        |           | Mount a tmpfs directory                                                                                                                                                                                                                                                                                          |
   105  | `-t`, `--tty`             |               |           | Allocate a pseudo-TTY                                                                                                                                                                                                                                                                                            |
   106  | `--ulimit`                | `ulimit`      |           | Ulimit options                                                                                                                                                                                                                                                                                                   |
   107  | `-u`, `--user`            | `string`      |           | Username or UID (format: <name\|uid>[:<group\|gid>])                                                                                                                                                                                                                                                             |
   108  | `--userns`                | `string`      |           | User namespace to use                                                                                                                                                                                                                                                                                            |
   109  | `--uts`                   | `string`      |           | UTS namespace to use                                                                                                                                                                                                                                                                                             |
   110  | `-v`, `--volume`          | `list`        |           | Bind mount a volume                                                                                                                                                                                                                                                                                              |
   111  | `--volume-driver`         | `string`      |           | Optional volume driver for the container                                                                                                                                                                                                                                                                         |
   112  | `--volumes-from`          | `list`        |           | Mount volumes from the specified container(s)                                                                                                                                                                                                                                                                    |
   113  | `-w`, `--workdir`         | `string`      |           | Working directory inside the container                                                                                                                                                                                                                                                                           |
   114  
   115  
   116  <!---MARKER_GEN_END-->
   117