github.com/blixtra/rkt@v0.8.1-0.20160204105720-ab0d1add1a43/Documentation/subcommands/prepare.md (about)

     1  # rkt prepare
     2  
     3  rkt can prepare images to run in a pod.
     4  This means it will fetch (if necessary) the images, extract them in its internal tree store, and allocate a pod UUID.
     5  If overlay fs is not supported or disabled, it will also copy the tree in the pod rootfs.
     6  
     7  In this way, the pod is ready to be launched immediately by the [run-prepared](run-prepared.md) command.
     8  
     9  Running `rkt prepare` + `rkt run-prepared` is semantically equivalent to running [rkt run](run.md).
    10  Therefore, the supported arguments are mostly the same as in `run` except runtime arguments like `--interactive` or `--mds-register`.
    11  
    12  ## Example
    13  
    14  ```
    15  # rkt prepare coreos.com/etcd:v2.0.10
    16  rkt prepare coreos.com/etcd:v2.0.10
    17  rkt: using image from local store for image name coreos.com/rkt/stage1-coreos:0.16.0
    18  rkt: searching for app image coreos.com/etcd:v2.0.10
    19  rkt: remote fetching from url https://github.com/coreos/etcd/releases/download/v2.0.10/etcd-v2.0.10-linux-amd64.aci
    20  prefix: "coreos.com/etcd"
    21  key: "https://coreos.com/dist/pubkeys/aci-pubkeys.gpg"
    22  gpg key fingerprint is: 8B86 DE38 890D DB72 9186  7B02 5210 BD88 8818 2190
    23  	CoreOS ACI Builder <release@coreos.com>
    24  Key "https://coreos.com/dist/pubkeys/aci-pubkeys.gpg" already in the keystore
    25  Downloading signature from https://github.com/coreos/etcd/releases/download/v2.0.10/etcd-v2.0.10-linux-amd64.aci.asc
    26  Downloading signature: [=======================================] 819 B/819 B
    27  Downloading ACI: [=============================================] 3.79 MB/3.79 MB
    28  rkt: signature verified:
    29    CoreOS ACI Builder <release@coreos.com>
    30  c9fad0e6-8236-4fc2-ad17-55d0a4c7d742
    31  ```
    32  
    33  ## Options
    34  
    35  | Flag | Default | Options | Description |
    36  | --- | --- | --- | --- |
    37  | `--exec` |  `` | A path | Override the exec command for the preceding image |
    38  | `--inherit-env` |  `false` | `true` or `false` | Inherit all environment variables not set by apps |
    39  | `--mount` |  `` | Mount syntax (`volume=NAME,target=PATH`). See [Mounting Volumes without Mount Points](run.md#mounting-volumes-without-mount-points) | Mount point binding a volume to a path within an app |
    40  | `--no-overlay` |  `false` | `true` or `false` | Disable overlay filesystem |
    41  | `--no-store` |  `false` | `true` or `false` | Fetch images, ignoring the local store. See [image fetching behavior](../image-fetching-behavior.md) |
    42  | `--pod-manifest` |  `` | A path | The path to the pod manifest. If it's non-empty, then only `--net`, `--no-overlay` and `--interactive` will have effect |
    43  | `--port` |  `` | A port number | Ports to expose on the host (requires [contained network](https://github.com/coreos/rkt/blob/master/Documentation/networking.md#contained-mode)). Syntax: --port=NAME:HOSTPORT |
    44  | `--private-users` |  `false` | `true` or `false` | Run within user namespaces (experimental) |
    45  | `--quiet` |  `false` | `true` or `false` | Supress superfluous output on stdout, print only the UUID on success |
    46  | `--set-env` |  `` | An environment variable. Syntax `NAME=VALUE` | An environment variable to set for apps |
    47  | `--stage1-url` |  `` | A URL to a stage1 image. HTTP/HTTPS/File/Docker URLs are supported | Image to use as stage1 |
    48  | `--stage1-path` |  `` | A path to a stage1 image. Absolute and relative paths are supported | Image to use as stage1 |
    49  | `--stage1-name` |  `` | A name of a stage1 image. Will perform a discovery if the image is not in the store | Image to use as stage1 |
    50  | `--stage1-hash` |  `` | A hash of a stage1 image. The image must exist in the store | Image to use as stage1 |
    51  | `--stage1-from-dir` |  `` | A stage1 image file inside the default stage1 images directory | Image to use as stage1 |
    52  | `--store-only` |  `false` | `true` or `false` | Use only available images in the store (do not discover or download from remote URLs). See [image fetching behavior](../image-fetching-behavior.md) |
    53  | `--volume` |  `` | Volume syntax (`NAME,kind=KIND,source=PATH,readOnly=BOOL`). See [Mount Volumes into a Pod](run.md#mount-volumes-into-a-pod) | Volumes to make available in the pod |
    54  
    55  ## Global options
    56  
    57  | Flag | Default | Options | Description |
    58  | --- | --- | --- | --- |
    59  | `--debug` |  `false` | `true` or `false` | Prints out more debug information to `stderr` |
    60  | `--dir` | `/var/lib/rkt` | A directory path | Path to the `rkt` data directory |
    61  | `--insecure-options` |  none | <ul><li>**none**: All security features are enabled</li><li>**http**: Allow HTTP connections. Be warned that this will send any credentials as clear text.</li><li>**image**: Disables verifying image signatures</li><li>**tls**: Accept any certificate from the server and any host name in that certificate</li><li>**ondisk**: Disables verifying the integrity of the on-disk, rendered image before running. This significantly speeds up start time.</li><li>**all**: Disables all security checks</li></ul>  | Comma-separated list of security features to disable |
    62  | `--local-config` |  `/etc/rkt` | A directory path | Path to the local configuration directory |
    63  | `--system-config` |  `/usr/lib/rkt` | A directory path | Path to the system configuration directory |
    64  | `--trust-keys-from-https` |  `false` | `true` or `false` | Automatically trust gpg keys fetched from https |
    65  | `--user-config` |  `` | A directory path | Path to the user configuration directory |