├── CODE-OF-CONDUCT.md ├── LICENSE ├── README.md ├── SECURITY.md ├── examples ├── pull_image.yml └── remove_image.yml ├── modules ├── __init__.py └── podman_image_v2.py └── tests └── run-tests-playbook.yml /CODE-OF-CONDUCT.md: -------------------------------------------------------------------------------- 1 | ## The Podman Ansible Project Community Code of Conduct 2 | 3 | The Podman Ansible project follows the [Containers Community Code of Conduct](https://github.com/containers/common/blob/master/CODE-OF-CONDUCT.md). 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | Ansible Module for Podman 3 | ========================= 4 | This module allows Ansible to use Podman to manage container images. 5 | 6 | Requirements 7 | ============ 8 | * Python 3.6+ 9 | * Ansible 2.8 10 | 11 | Installation 12 | ============ 13 | 1. Install [Podman](https://github.com/containers/libpod/blob/master/install.md) 14 | 2. Install [Python-podman library](https://github.com/containers/python-podman) on the host you will be 15 | running ansible playbooks. 16 | ``` 17 | git clone git@github.com:containers/python-podman.git 18 | cd ~/python-podman 19 | python3 setup.py clean -a && python3 setup.py sdist bdist 20 | python3 setup.py install --user 21 | ``` 22 | 3. Copy `podman_images_v2.py` to your directory library 23 | ``` 24 | ../podman_test/ 25 | ├── library 26 | │   └── podman_image_v2.py 27 | └── pull_image.yml 28 | ``` 29 | 30 | Usage Examples 31 | ============== 32 | This module will pull the fedora latest image from docker hub. 33 | 34 | ``` 35 | hosts: localhost 36 | tasks: 37 | - name: Pull an image 38 | podman_image_v2: 39 | name: fedora 40 | register: result 41 | 42 | - debug: var=result 43 | ``` 44 | 45 | Parameters 46 | ========== 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 |
parameterrequireddefaultchoicescomments
nameyes
    		Set image name
    tagnolatest
      		Set the tag of the image
      pullnotrue
        		Set the pull option
        forcenofalse
          		Set to pull an image forcefully
          statenopresent
          • present
          • build
          • absent
          		Set the state of the image
          92 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | ## Security and Disclosure Information Policy for the Ansible Module for Podman Project 2 | 3 | The Ansible Module for Podman Project follows the [Security and Disclosure Information Policy](https://github.com/containers/common/blob/master/SECURITY.md) for the Containers Projects. 4 | 5 | -------------------------------------------------------------------------------- /examples/pull_image.yml: -------------------------------------------------------------------------------- 1 | --- 2 | #This ansible playbook will pull an image 3 | 4 | - hosts: localhost 5 | tasks: 6 | - name: Test 7 | podman_image_v2: 8 | name: alpine 9 | register: result 10 | 11 | - debug: var=result 12 | -------------------------------------------------------------------------------- /examples/remove_image.yml: -------------------------------------------------------------------------------- 1 | --- 2 | #This ansible playbook will remove an image 3 | 4 | - hosts: localhost 5 | tasks: 6 | - name: Remove image 7 | podman_image_v2: 8 | name: alpine 9 | state: absent 10 | register: result 11 | 12 | - debug: var=result 13 | -------------------------------------------------------------------------------- /modules/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/containers/ansible-podman/b73aadf81e4ddbd8376e62995a6a5f7cf2d843d3/modules/__init__.py -------------------------------------------------------------------------------- /modules/podman_image_v2.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | 4 | from __future__ import absolute_import, division, print_function 5 | __metaclass__ = type 6 | 7 | ANSIBLE_METADATA = {'metadata_version': '1.1', 8 | 'status': ['preview'], 9 | 'supported_by': 'community'} 10 | 11 | DOCUMENTATION = """ 12 | module: podman_image_v2 13 | author: 14 | - Dhanisha Phadate (@Phadated) 15 | - Renu Hadke (@renuHadke) 16 | - Neha Jain (@nehajain1809) 17 | - Krish Jain (@krishjain4894) 18 | - Chinmay Keskar (@ckeskar) 19 | short_description: Pull and remove images for use by podman 20 | notes: [] 21 | description: 22 | - pull, remove images using Podman. 23 | options: 24 | name: 25 | description: 26 | - Name of the image to pull or delete. It may contain a tag using the format C(image:tag). 27 | required: True 28 | tag: 29 | description: 30 | - Tag of the image to pull or delete. 31 | default: "latest" 32 | pull: 33 | description: Whether or not to pull the image. 34 | default: True 35 | force: 36 | description: 37 | - Whether or not to force pull an image. force the pull even if the image already exists. 38 | state: 39 | description: 40 | - Whether an image should be present or absent. 41 | default: "present" 42 | choices: 43 | - present 44 | - absent 45 | """ 46 | 47 | EXAMPLES = """ 48 | - name: Pull an image 49 | podman_image_v2: 50 | name: fedora 51 | register: result 52 | 53 | - debug: var=result 54 | 55 | - name: Remove an image 56 | podman_image_v2: 57 | name: alpine 58 | state: absent 59 | register: result 60 | 61 | - debug: var=result 62 | 63 | - name: Pull an image with specific tag 64 | podman_image_v2: 65 | name: alpine 66 | tag: "3.10.1" 67 | """ 68 | 69 | RETURN = """ 70 | 71 | "image": { 72 | "annotations": {}, 73 | "architecture": "amd64", 74 | "author": "", 75 | "comment": "", 76 | "config": { 77 | "cmd": [ 78 | "/bin/sh" 79 | ], 80 | "env": [ 81 | "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" 82 | ] 83 | }, 84 | "created": "2019-07-11T22:20:52.375286404Z", 85 | "digest": "sha256:57334c50959f26ce1ee025d08f136c2292c128f84e7b229d1b0da5dac89e9866", 86 | "graphdriver": { 87 | "data": { 88 | "mergeddir": "/var/lib/containers/storage/overlay/1bfeebd65323b8ddf5bd6a51cc7097b72788bc982e9ab3280d53d3c613adffa7/merged", 89 | "upperdir": "/var/lib/containers/storage/overlay/1bfeebd65323b8ddf5bd6a51cc7097b72788bc982e9ab3280d53d3c613adffa7/diff", 90 | "workdir": "/var/lib/containers/storage/overlay/1bfeebd65323b8ddf5bd6a51cc7097b72788bc982e9ab3280d53d3c613adffa7/work" 91 | }, 92 | "name": "overlay" 93 | }, 94 | "history": [ 95 | { 96 | "created": "2019-07-11T22:20:52.139709355Z", 97 | "created_by": "/bin/sh -c #(nop) ADD file:0eb5ea35741d23fe39cbac245b3a5d84856ed6384f4ff07d496369ee6d960bad in / " 98 | }, 99 | { 100 | "created": "2019-07-11T22:20:52.375286404Z", 101 | "created_by": "/bin/sh -c #(nop) CMD [\"/bin/sh\"]", 102 | "empty_layer": true 103 | } 104 | ], 105 | "id": "b7b28af77ffec6054d13378df4fdf02725830086c7444d9c278af25312aa39b9", 106 | "labels": null, 107 | "manifesttype": "application/vnd.docker.distribution.manifest.v2+json", 108 | "os": "linux", 109 | "parent": "", 110 | "repodigests": [ 111 | "docker.io/library/alpine@sha256:57334c50959f26ce1ee025d08f136c2292c128f84e7b229d1b0da5dac89e9866" 112 | ], 113 | "repotags": [ 114 | "docker.io/library/alpine:latest" 115 | ], 116 | "rootfs": { 117 | "layers": [ 118 | "sha256:1bfeebd65323b8ddf5bd6a51cc7097b72788bc982e9ab3280d53d3c613adffa7" 119 | ], 120 | "type": "layers" 121 | }, 122 | "size": 5846536, 123 | "user": "", 124 | "version": "18.06.1-ce", 125 | "virtualsize": 5846536 126 | } 127 | 128 | """ 129 | 130 | import os 131 | import json 132 | import re 133 | import podman 134 | from ansible.module_utils.basic import * 135 | 136 | class PodmanImageManager(object): 137 | 138 | def __init__(self, module, results): 139 | super(PodmanImageManager, self).__init__() 140 | self.module = module 141 | self.results = results 142 | self.name = self.module.params.get('name') 143 | self.tag = self.module.params.get('tag') 144 | self.pull = self.module.params.get('pull') 145 | self.force = self.module.params.get('force') 146 | self.state = self.module.params.get('state') 147 | self._client= podman.Client() 148 | 149 | repo, repo_tag = parse_repository_tag(self.name) 150 | if repo_tag: 151 | self.name = repo 152 | self.tag = repo_tag 153 | 154 | self.image_name = '{name}:{tag}'.format(name=self.name, tag=self.tag) 155 | 156 | if self.state in ['present', 'build']: 157 | self.present() 158 | 159 | if self.state in ['absent']: 160 | self.absent() 161 | 162 | def present(self): 163 | if not self.force: 164 | # Pull the image 165 | self.results['actions'].append('Pulled image {image_name}'.format(image_name=self.image_name)) 166 | self.results['changed'] = True 167 | if not self.module.check_mode: 168 | self.results['image'] = self.pull_image() 169 | 170 | def find_image(self, image_name=None): 171 | pass 172 | 173 | def pull_image(self, image_name=None): 174 | if image_name is None: 175 | image_name = self.image_name 176 | id=self._client.images.pull(image_name) 177 | img=self._client.images.get(id) 178 | res=img.inspect() 179 | return res._asdict() 180 | 181 | def absent(self): 182 | image = self.image_name 183 | 184 | #TODO find_image function to check if the image is present before removal 185 | if image: 186 | if not self.module.check_mode and self.remove_image() == 'Deleted': 187 | self.results['actions'].append('Removed image {name}'.format(name=self.name)) 188 | self.results['changed'] = True 189 | self.results['image']['state'] = 'Deleted' 190 | else: 191 | self.results['image']['state'] = 'ImageNotFound' 192 | 193 | 194 | def remove_image(self, image_name=None): 195 | if image_name is None: 196 | image_name = self.image_name 197 | try: 198 | img = self._client.images.get(image_name) 199 | if self.force: 200 | _id=img.remove(self.force) 201 | else: 202 | _id=img.remove() 203 | 204 | if _id: 205 | out= "Deleted" 206 | 207 | except: 208 | out= "ImageNotFound" 209 | 210 | return out 211 | 212 | def parse_repository_tag(repo_name): 213 | parts = repo_name.rsplit('@', 1) 214 | if len(parts) == 2: 215 | return tuple(parts) 216 | parts = repo_name.rsplit(':', 1) 217 | if len(parts) == 2 and '/' not in parts[1]: 218 | return tuple(parts) 219 | return repo_name, None 220 | 221 | 222 | def main(): 223 | module = AnsibleModule( 224 | argument_spec=dict( 225 | name=dict(type='str', required=True), 226 | tag=dict(type='str', default='latest'), 227 | pull=dict(type='bool', default=True), 228 | force=dict(type='bool', default=False), 229 | state=dict(type='str', default='present', choices=['absent', 'present', 'build']), 230 | ), 231 | ) 232 | 233 | results = dict( 234 | changed=False, 235 | actions=[], 236 | image={}, 237 | ) 238 | 239 | PodmanImageManager(module, results) 240 | module.exit_json(**results) 241 | 242 | 243 | if __name__ == '__main__': 244 | main() 245 | -------------------------------------------------------------------------------- /tests/run-tests-playbook.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: test podman ansible 3 | hosts: localhost 4 | user: root 5 | gather_facts: no 6 | tasks: 7 | - name: Test 8 | podman_image_v2: 9 | name: fedora 10 | register: result 11 | 12 | - debug: var=result 13 | --------------------------------------------------------------------------------