summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSam Thursfield <sam.thursfield@codethink.co.uk>2015-01-05 12:26:11 +0000
committerSam Thursfield <sam.thursfield@codethink.co.uk>2015-01-05 12:33:36 +0000
commit8ce1e248cdce95ad6118c2a86b73e4199ea5deee (patch)
tree93f5e127b871a775e11e78a40970e3c03f776959
parent2f3b87a4707b16ccfae67b58ce6d590eb5d5e3ce (diff)
downloaddocker-py-8ce1e248cdce95ad6118c2a86b73e4199ea5deee.tar.gz
docs: Add specific import_image() variants
-rw-r--r--docs/api.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md
index 3ce5957..0a17670 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -314,6 +314,48 @@ the name of an existing image to import from.
* tag (str): The tag to apply
* image (str): Use another image like the `FROM` Dockerfile parameter
+## import_image_from_data
+
+Like `.import_image()`, but allows importing in-memory bytes data.
+
+**Params**:
+
+* data (bytes collection): Bytes collection containing valid tar data
+* repository (str): The repository to create
+* tag (str): The tag to apply
+
+## import_image_from_file
+
+Like `.import_image()`, but only supports importing from a tar file on
+disk. If the file doesn't exist it will raise `IOError`.
+
+**Params**:
+
+* filename (str): Full path to a tar file.
+* repository (str): The repository to create
+* tag (str): The tag to apply
+
+## import_image_from_url
+
+Like `.import_image()`, but only supports importing from a URL.
+
+**Params**:
+
+* url (str): A URL pointing to a tar file.
+* repository (str): The repository to create
+* tag (str): The tag to apply
+
+## import_image_from_image
+
+Like `.import_image()`, but only supports importing from another image,
+like the `FROM` Dockerfile parameter.
+
+**Params**:
+
+* image (str): Image name to import from
+* repository (str): The repository to create
+* tag (str): The tag to apply
+
## info
Display system-wide information. Identical to the `docker info` command.