diff options
author | chouseknecht <chouseknecht@ansible.com> | 2016-03-01 13:42:39 -0500 |
---|---|---|
committer | chouseknecht <chouseknecht@ansible.com> | 2016-03-02 02:49:19 -0500 |
commit | e0f41c7726355c9282b840327a3848f677b384ca (patch) | |
tree | d540e374077958735e3370ab1fca57fba32c367b | |
parent | d6716a2f9054f3426d558576d9e3ebf7937aa888 (diff) | |
download | ansible-e0f41c7726355c9282b840327a3848f677b384ca.tar.gz |
Updated docker_image_facts module proposal.
-rw-r--r-- | docs/proposals/docker/docker_image_facts_module.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/proposals/docker/docker_image_facts_module.md b/docs/proposals/docker/docker_image_facts_module.md new file mode 100644 index 0000000000..a399e682b0 --- /dev/null +++ b/docs/proposals/docker/docker_image_facts_module.md @@ -0,0 +1,47 @@ + +# Docker_Image_Facts Module Proposal + +## Purpose and Scope + +The purpose of docker_image_facts is to inspect docker images. + +Docker_image_facts will use docker-py to communicate with either a local or remote API. It will +support API versions >= 1.14. API connection details will be handled externally in a shared utility module similar +to how other cloud modules operate. + +## Parameters + +Docker_image_facts will support the parameters listed below. API connection parameters will be part of a shared +utility module as mentioned above. + +``` +name: + description: + - An image name or list of image names. The image name can include a tag using the format C(name:tag). + default: null +``` + +## Examples + +``` +- name: Inspect all images + docker_image_facts + register: image_facts + +- name: Inspect a single image + docker_image_facts: + name: myimage:v1 + register: myimage_v1_facts +``` + +## Returns + +``` +{ + changed: False + failed: False + rc: 0 + result: [ < inspection output > ] +} +``` + |