diff options
| author | Sam Thursfield <sam.thursfield@codethink.co.uk> | 2015-01-05 12:19:32 +0000 |
|---|---|---|
| committer | Sam Thursfield <sam.thursfield@codethink.co.uk> | 2015-01-05 12:26:29 +0000 |
| commit | 47af951ac8bcba23c21802764233f1667f517ba1 (patch) | |
| tree | f59dbdffb1cd7782f75fbb93a454be8979c1504f /docs | |
| parent | 42b91885a29885daee8ef46b8e6364d68c09a4f3 (diff) | |
| download | docker-py-47af951ac8bcba23c21802764233f1667f517ba1.tar.gz | |
docs: Clarify import_image() docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.md | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/docs/api.md b/docs/api.md index a4e7dd1..3ce5957 100644 --- a/docs/api.md +++ b/docs/api.md @@ -296,16 +296,20 @@ layers) ## import_image -Identical to the `docker import` command. If `src` is a string or unicode -string, it will be treated as a URL to fetch the image from. To import an image -from the local machine, `src` needs to be a file-like object or bytes -collection. To import from a tarball use your absolute path to your tarball. -To load arbitrary data as tarball use whatever you want as src and your -tarball content in data. +Similar to the `docker import` command. + +If `src` is a string or unicode string, it will first be treated as a path to +a tarball on the local system. If there is an error reading from that file, +src will be treated as a URL instead to fetch the image from. You can also pass +an open file handle as 'src', in which case the data will be read from that +file. + +If `src` is unset but `image` is set, the `image` paramater will be taken as +the name of an existing image to import from. **Params**: -* src (str or file): Path to tarfile or URL +* src (str or file): Path to tarfile, URL, or file-like object * repository (str): The repository to create * tag (str): The tag to apply * image (str): Use another image like the `FROM` Dockerfile parameter |
