Add podman_container_info module (#64361)
Co-Authored-By: Felix Fontein <felix@fontein.de>
This commit is contained in:
Sergey
Sam Doran
parent
63bb08fea8
commit
e444e68bf0
4 changed files with 507 additions and 0 deletions
410
lib/ansible/modules/cloud/podman/podman_container_info.py
Normal file
410
lib/ansible/modules/cloud/podman/podman_container_info.py
Normal file
|
|
@ -0,0 +1,410 @@
|
||||||
|
#!/usr/bin/python
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# Copyright (c) 2019 Ansible Project
|
||||||
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
|
||||||
|
from __future__ import absolute_import, division, print_function
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
ANSIBLE_METADATA = {
|
||||||
|
'metadata_version': '1.1',
|
||||||
|
'status': ['preview'],
|
||||||
|
'supported_by': 'community'
|
||||||
|
}
|
||||||
|
|
||||||
|
DOCUMENTATION = """
|
||||||
|
module: podman_container_info
|
||||||
|
author:
|
||||||
|
- Sagi Shnaidman (@sshnaidm)
|
||||||
|
- Emilien Macchi (@EmilienM)
|
||||||
|
version_added: '2.10'
|
||||||
|
short_description: Gather facts about containers using podman
|
||||||
|
notes:
|
||||||
|
- Podman may require elevated privileges in order to run properly.
|
||||||
|
description:
|
||||||
|
- Gather facts about containers using C(podman)
|
||||||
|
requirements:
|
||||||
|
- "Podman installed on host"
|
||||||
|
options:
|
||||||
|
name:
|
||||||
|
description:
|
||||||
|
- List of container names to gather facts about. If no name is given
|
||||||
|
return facts about all containers.
|
||||||
|
type: list
|
||||||
|
elements: str
|
||||||
|
executable:
|
||||||
|
description:
|
||||||
|
- Path to C(podman) executable if it is not in the C($PATH) on the
|
||||||
|
machine running C(podman)
|
||||||
|
default: 'podman'
|
||||||
|
type: str
|
||||||
|
"""
|
||||||
|
EXAMPLES = """
|
||||||
|
- name: Gather facts for all containers
|
||||||
|
podman_container_info:
|
||||||
|
|
||||||
|
- name: Gather facts on a specific container
|
||||||
|
podman_container_info:
|
||||||
|
name: web1
|
||||||
|
|
||||||
|
- name: Gather facts on several containers
|
||||||
|
podman_container_info:
|
||||||
|
name:
|
||||||
|
- redis
|
||||||
|
- web1
|
||||||
|
"""
|
||||||
|
RETURN = """
|
||||||
|
containers:
|
||||||
|
description: Facts from all or specificed containers
|
||||||
|
returned: always
|
||||||
|
type: list
|
||||||
|
elements: dict
|
||||||
|
sample: [
|
||||||
|
{
|
||||||
|
"Id": "c5c39f9b80a6ea2ad665aa9946435934e478a0c5322da835f3883872f",
|
||||||
|
"Created": "2019-10-01T12:51:00.233106443Z",
|
||||||
|
"Path": "dumb-init",
|
||||||
|
"Args": [
|
||||||
|
"--single-child",
|
||||||
|
"--",
|
||||||
|
"kolla_start"
|
||||||
|
],
|
||||||
|
"State": {
|
||||||
|
"OciVersion": "1.0.1-dev",
|
||||||
|
"Status": "configured",
|
||||||
|
"Running": false,
|
||||||
|
"Paused": false,
|
||||||
|
"Restarting": false,
|
||||||
|
"OOMKilled": false,
|
||||||
|
"Dead": false,
|
||||||
|
"Pid": 0,
|
||||||
|
"ExitCode": 0,
|
||||||
|
"Error": "",
|
||||||
|
"StartedAt": "0001-01-01T00:00:00Z",
|
||||||
|
"FinishedAt": "0001-01-01T00:00:00Z",
|
||||||
|
"Healthcheck": {
|
||||||
|
"Status": "",
|
||||||
|
"FailingStreak": 0,
|
||||||
|
"Log": null
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"Image": "0e267acda67d0ebd643e900d820a91b961d859743039e620191ca1",
|
||||||
|
"ImageName": "docker.io/tripleomaster/centos-haproxy:latest",
|
||||||
|
"Rootfs": "",
|
||||||
|
"Pod": "",
|
||||||
|
"ResolvConfPath": "",
|
||||||
|
"HostnamePath": "",
|
||||||
|
"HostsPath": "",
|
||||||
|
"OCIRuntime": "runc",
|
||||||
|
"Name": "haproxy",
|
||||||
|
"RestartCount": 0,
|
||||||
|
"Driver": "overlay",
|
||||||
|
"MountLabel": "system_u:object_r:svirt_sandbox_file_t:s0:c78,c866",
|
||||||
|
"ProcessLabel": "system_u:system_r:svirt_lxc_net_t:s0:c785,c866",
|
||||||
|
"AppArmorProfile": "",
|
||||||
|
"EffectiveCaps": [
|
||||||
|
"CAP_CHOWN",
|
||||||
|
"CAP_DAC_OVERRIDE",
|
||||||
|
"CAP_FSETID",
|
||||||
|
"CAP_FOWNER",
|
||||||
|
"CAP_MKNOD",
|
||||||
|
"CAP_NET_RAW",
|
||||||
|
"CAP_SETGID",
|
||||||
|
"CAP_SETUID",
|
||||||
|
"CAP_SETFCAP",
|
||||||
|
"CAP_SETPCAP",
|
||||||
|
"CAP_NET_BIND_SERVICE",
|
||||||
|
"CAP_SYS_CHROOT",
|
||||||
|
"CAP_KILL",
|
||||||
|
"CAP_AUDIT_WRITE"
|
||||||
|
],
|
||||||
|
"BoundingCaps": [
|
||||||
|
"CAP_CHOWN",
|
||||||
|
"CAP_DAC_OVERRIDE",
|
||||||
|
"CAP_FSETID",
|
||||||
|
"CAP_FOWNER",
|
||||||
|
"CAP_MKNOD",
|
||||||
|
"CAP_NET_RAW",
|
||||||
|
"CAP_SETGID",
|
||||||
|
"CAP_SETUID",
|
||||||
|
"CAP_SETFCAP",
|
||||||
|
"CAP_SETPCAP",
|
||||||
|
"CAP_NET_BIND_SERVICE",
|
||||||
|
"CAP_SYS_CHROOT",
|
||||||
|
"CAP_KILL",
|
||||||
|
"CAP_AUDIT_WRITE"
|
||||||
|
],
|
||||||
|
"ExecIDs": [],
|
||||||
|
"GraphDriver": {
|
||||||
|
"Name": "overlay"
|
||||||
|
},
|
||||||
|
"Mounts": [],
|
||||||
|
"Dependencies": [],
|
||||||
|
"NetworkSettings": {
|
||||||
|
"Bridge": "",
|
||||||
|
"SandboxID": "",
|
||||||
|
"HairpinMode": false,
|
||||||
|
"LinkLocalIPv6Address": "",
|
||||||
|
"LinkLocalIPv6PrefixLen": 0,
|
||||||
|
"Ports": [],
|
||||||
|
"SandboxKey": "",
|
||||||
|
"SecondaryIPAddresses": null,
|
||||||
|
"SecondaryIPv6Addresses": null,
|
||||||
|
"EndpointID": "",
|
||||||
|
"Gateway": "",
|
||||||
|
"GlobalIPv6Address": "",
|
||||||
|
"GlobalIPv6PrefixLen": 0,
|
||||||
|
"IPAddress": "",
|
||||||
|
"IPPrefixLen": 0,
|
||||||
|
"IPv6Gateway": "",
|
||||||
|
"MacAddress": ""
|
||||||
|
},
|
||||||
|
"ExitCommand": [
|
||||||
|
"/usr/bin/podman",
|
||||||
|
"--root",
|
||||||
|
"/var/lib/containers/storage",
|
||||||
|
"--runroot",
|
||||||
|
"/var/run/containers/storage",
|
||||||
|
"--log-level",
|
||||||
|
"error",
|
||||||
|
"--cgroup-manager",
|
||||||
|
"systemd",
|
||||||
|
"--tmpdir",
|
||||||
|
"/var/run/libpod",
|
||||||
|
"--runtime",
|
||||||
|
"runc",
|
||||||
|
"--storage-driver",
|
||||||
|
"overlay",
|
||||||
|
"--events-backend",
|
||||||
|
"journald",
|
||||||
|
"container",
|
||||||
|
"cleanup",
|
||||||
|
"c9e813703f9b80a6ea2ad665aa9946435934e478a0c5322da835f3883872f"
|
||||||
|
],
|
||||||
|
"Namespace": "",
|
||||||
|
"IsInfra": false,
|
||||||
|
"Config": {
|
||||||
|
"Hostname": "c5c39e813703",
|
||||||
|
"Domainname": "",
|
||||||
|
"User": "",
|
||||||
|
"AttachStdin": false,
|
||||||
|
"AttachStdout": false,
|
||||||
|
"AttachStderr": false,
|
||||||
|
"Tty": false,
|
||||||
|
"OpenStdin": false,
|
||||||
|
"StdinOnce": false,
|
||||||
|
"Env": [
|
||||||
|
"PATH=/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
|
||||||
|
"TERM=xterm",
|
||||||
|
"HOSTNAME=",
|
||||||
|
"container=oci",
|
||||||
|
"KOLLA_INSTALL_METATYPE=rdo",
|
||||||
|
"KOLLA_BASE_DISTRO=centos",
|
||||||
|
"KOLLA_INSTALL_TYPE=binary",
|
||||||
|
"KOLLA_DISTRO_PYTHON_VERSION=2.7",
|
||||||
|
"KOLLA_BASE_ARCH=x86_64"
|
||||||
|
],
|
||||||
|
"Cmd": [
|
||||||
|
"kolla_start"
|
||||||
|
],
|
||||||
|
"Image": "docker.io/tripleomaster/centos-haproxy:latest",
|
||||||
|
"Volumes": null,
|
||||||
|
"WorkingDir": "/",
|
||||||
|
"Entrypoint": "dumb-init --single-child --",
|
||||||
|
"OnBuild": null,
|
||||||
|
"Labels": {
|
||||||
|
"build-date": "20190919",
|
||||||
|
"kolla_version": "8.1.0",
|
||||||
|
"name": "haproxy",
|
||||||
|
"org.label-schema.build-date": "20190801",
|
||||||
|
"org.label-schema.license": "GPLv2",
|
||||||
|
"org.label-schema.name": "CentOS Base Image",
|
||||||
|
"org.label-schema.schema-version": "1.0",
|
||||||
|
"org.label-schema.vendor": "CentOS"
|
||||||
|
},
|
||||||
|
"Annotations": {
|
||||||
|
"io.kubernetes.cri-o.ContainerType": "sandbox",
|
||||||
|
"io.kubernetes.cri-o.TTY": "false",
|
||||||
|
"io.podman.annotations.autoremove": "FALSE",
|
||||||
|
"io.podman.annotations.init": "FALSE",
|
||||||
|
"io.podman.annotations.privileged": "FALSE",
|
||||||
|
"io.podman.annotations.publish-all": "FALSE"
|
||||||
|
},
|
||||||
|
"StopSignal": 15
|
||||||
|
},
|
||||||
|
"HostConfig": {
|
||||||
|
"Binds": [],
|
||||||
|
"ContainerIDFile": "",
|
||||||
|
"LogConfig": {
|
||||||
|
"Type": "k8s-file",
|
||||||
|
"Config": null
|
||||||
|
},
|
||||||
|
"NetworkMode": "default",
|
||||||
|
"PortBindings": {},
|
||||||
|
"RestartPolicy": {
|
||||||
|
"Name": "",
|
||||||
|
"MaximumRetryCount": 0
|
||||||
|
},
|
||||||
|
"AutoRemove": false,
|
||||||
|
"VolumeDriver": "",
|
||||||
|
"VolumesFrom": null,
|
||||||
|
"CapAdd": [],
|
||||||
|
"CapDrop": [],
|
||||||
|
"Dns": [],
|
||||||
|
"DnsOptions": [],
|
||||||
|
"DnsSearch": [],
|
||||||
|
"ExtraHosts": [],
|
||||||
|
"GroupAdd": [],
|
||||||
|
"IpcMode": "",
|
||||||
|
"Cgroup": "",
|
||||||
|
"Links": null,
|
||||||
|
"OomScoreAdj": 0,
|
||||||
|
"PidMode": "",
|
||||||
|
"Privileged": false,
|
||||||
|
"PublishAllPorts": false,
|
||||||
|
"ReadonlyRootfs": false,
|
||||||
|
"SecurityOpt": [],
|
||||||
|
"Tmpfs": {},
|
||||||
|
"UTSMode": "",
|
||||||
|
"UsernsMode": "",
|
||||||
|
"ShmSize": 65536000,
|
||||||
|
"Runtime": "oci",
|
||||||
|
"ConsoleSize": [
|
||||||
|
0,
|
||||||
|
0
|
||||||
|
],
|
||||||
|
"Isolation": "",
|
||||||
|
"CpuShares": 0,
|
||||||
|
"Memory": 0,
|
||||||
|
"NanoCpus": 0,
|
||||||
|
"CgroupParent": "",
|
||||||
|
"BlkioWeight": 0,
|
||||||
|
"BlkioWeightDevice": null,
|
||||||
|
"BlkioDeviceReadBps": null,
|
||||||
|
"BlkioDeviceWriteBps": null,
|
||||||
|
"BlkioDeviceReadIOps": null,
|
||||||
|
"BlkioDeviceWriteIOps": null,
|
||||||
|
"CpuPeriod": 0,
|
||||||
|
"CpuQuota": 0,
|
||||||
|
"CpuRealtimePeriod": 0,
|
||||||
|
"CpuRealtimeRuntime": 0,
|
||||||
|
"CpusetCpus": "",
|
||||||
|
"CpusetMems": "",
|
||||||
|
"Devices": [],
|
||||||
|
"DiskQuota": 0,
|
||||||
|
"KernelMemory": 0,
|
||||||
|
"MemoryReservation": 0,
|
||||||
|
"MemorySwap": 0,
|
||||||
|
"MemorySwappiness": -1,
|
||||||
|
"OomKillDisable": false,
|
||||||
|
"PidsLimit": 0,
|
||||||
|
"Ulimits": [
|
||||||
|
{
|
||||||
|
"Name": "RLIMIT_NOFILE",
|
||||||
|
"Soft": 1048576,
|
||||||
|
"Hard": 1048576
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Name": "RLIMIT_NPROC",
|
||||||
|
"Soft": 1048576,
|
||||||
|
"Hard": 1048576
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"CpuCount": 0,
|
||||||
|
"CpuPercent": 0,
|
||||||
|
"IOMaximumIOps": 0,
|
||||||
|
"IOMaximumBandwidth": 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
"""
|
||||||
|
|
||||||
|
import json
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
|
||||||
|
|
||||||
|
def get_containers_facts(module, executable, name):
|
||||||
|
"""Collect containers facts for all containers or for specified in 'name'.
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
module {AnsibleModule} -- instance of AnsibleModule
|
||||||
|
executable {string} -- binary to execute when inspecting containers
|
||||||
|
name {list} -- list of names or None in case of all containers
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list of containers info, stdout, stderr
|
||||||
|
"""
|
||||||
|
if not name:
|
||||||
|
all_names = [executable, 'container', 'ls', '-q', '-a']
|
||||||
|
rc, out, err = module.run_command(all_names)
|
||||||
|
if rc != 0:
|
||||||
|
module.fail_json(msg="Unable to get list of containers: %s" % err)
|
||||||
|
name = out.split()
|
||||||
|
if not name:
|
||||||
|
return [], out, err
|
||||||
|
command = [executable, 'container', 'inspect']
|
||||||
|
command.extend(name)
|
||||||
|
rc, out, err = module.run_command(command)
|
||||||
|
if rc == 0:
|
||||||
|
json_out = json.loads(out) if out else None
|
||||||
|
if json_out is None:
|
||||||
|
return [], out, err
|
||||||
|
return json_out, out, err
|
||||||
|
if rc != 0 and 'no such ' in err:
|
||||||
|
if len(name) < 2:
|
||||||
|
return [], out, err
|
||||||
|
return cycle_over(module, executable, name)
|
||||||
|
module.fail_json(msg="Unable to gather info for %s: %s" % (",".join(name), err))
|
||||||
|
|
||||||
|
|
||||||
|
def cycle_over(module, executable, name):
|
||||||
|
"""Inspect each container in a cycle in case some of them don't exist.
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
module {AnsibleModule} -- instance of AnsibleModule
|
||||||
|
executable {string} -- binary to execute when inspecting containers
|
||||||
|
name {list} -- list of containers names to inspect
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list of containers info, stdout as empty, stderr
|
||||||
|
"""
|
||||||
|
inspection = []
|
||||||
|
stderrs = []
|
||||||
|
for container in name:
|
||||||
|
command = [executable, 'container', 'inspect', container]
|
||||||
|
rc, out, err = module.run_command(command)
|
||||||
|
if rc != 0 and 'no such ' not in err:
|
||||||
|
module.fail_json(msg="Unable to gather info for %s: %s" % (container, err))
|
||||||
|
if rc == 0 and out:
|
||||||
|
json_out = json.loads(out)
|
||||||
|
if json_out:
|
||||||
|
inspection += json_out
|
||||||
|
stderrs.append(err)
|
||||||
|
return inspection, "", "\n".join(stderrs)
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec={
|
||||||
|
'executable': {'type': 'str', 'default': 'podman'},
|
||||||
|
'name': {'type': 'list', 'elements': 'str'},
|
||||||
|
},
|
||||||
|
supports_check_mode=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
name = module.params['name']
|
||||||
|
executable = module.get_bin_path(module.params['executable'], required=True)
|
||||||
|
|
||||||
|
inspect_results, out, err = get_containers_facts(module, executable, name)
|
||||||
|
|
||||||
|
results = {
|
||||||
|
"changed": False,
|
||||||
|
"containers": inspect_results,
|
||||||
|
"stderr": err
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exit_json(**results)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
4
test/integration/targets/podman_container_info/aliases
Normal file
4
test/integration/targets/podman_container_info/aliases
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
shippable/posix/group2
|
||||||
|
skip/osx
|
||||||
|
skip/freebsd
|
||||||
|
destructive
|
||||||
|
|
@ -0,0 +1,2 @@
|
||||||
|
dependencies:
|
||||||
|
- setup_podman
|
||||||
|
|
@ -0,0 +1,91 @@
|
||||||
|
- name: Test podman_container_info
|
||||||
|
when:
|
||||||
|
- ansible_facts.virtualization_type != 'docker'
|
||||||
|
- ansible_facts.distribution == 'RedHat'
|
||||||
|
block:
|
||||||
|
|
||||||
|
- name: Generate random value for container name
|
||||||
|
set_fact:
|
||||||
|
container_name: "{{ 'ansible-test-podman-%0x' % ((2**32) | random) }}"
|
||||||
|
|
||||||
|
- name: Make sure container doesn't exist
|
||||||
|
command: podman container rm -f {{ container_name }}
|
||||||
|
ignore_errors: true
|
||||||
|
|
||||||
|
- name: Get missing container info
|
||||||
|
podman_container_info:
|
||||||
|
name: "{{ container_name }}"
|
||||||
|
register: nonexist
|
||||||
|
|
||||||
|
- name: Check results of missing container info
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- "'containers' in nonexist"
|
||||||
|
- nonexist is succeeded
|
||||||
|
- nonexist.containers == []
|
||||||
|
|
||||||
|
- name: Get missing multiple container info
|
||||||
|
podman_container_info:
|
||||||
|
name:
|
||||||
|
- "{{ container_name }}"
|
||||||
|
- neverexist
|
||||||
|
- whatever
|
||||||
|
register: nonexist2
|
||||||
|
ignore_errors: true
|
||||||
|
|
||||||
|
- name: Check results of missing multiple container info
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- "'containers' in nonexist2"
|
||||||
|
- nonexist2 is succeeded
|
||||||
|
- nonexist2.containers == []
|
||||||
|
|
||||||
|
- name: Make sure container exists
|
||||||
|
command: podman container run -d --name {{ container_name }} alpine sleep 15m
|
||||||
|
|
||||||
|
- name: Get existing container info
|
||||||
|
podman_container_info:
|
||||||
|
name: "{{ container_name }}"
|
||||||
|
register: existing_container
|
||||||
|
|
||||||
|
- name: Get mixed existing and non-existing container info
|
||||||
|
podman_container_info:
|
||||||
|
name:
|
||||||
|
- "{{ container_name }}"
|
||||||
|
- whatever
|
||||||
|
register: mixed_existing_container
|
||||||
|
|
||||||
|
- name: Get all containers info
|
||||||
|
podman_container_info:
|
||||||
|
register: all_containers
|
||||||
|
|
||||||
|
- name: Dump podman container inspect result
|
||||||
|
debug: var=existing_container
|
||||||
|
|
||||||
|
- name: Comparison with 'podman container inspect'
|
||||||
|
command: podman container inspect "{{ container_name }}"
|
||||||
|
register: podman_inspect
|
||||||
|
|
||||||
|
- name: Convert podman inspect output to JSON
|
||||||
|
set_fact:
|
||||||
|
podman_inspect_result: "{{ podman_inspect.stdout | from_json }}"
|
||||||
|
|
||||||
|
- name: Cleanup
|
||||||
|
command: podman container rm -f {{ container_name }}
|
||||||
|
|
||||||
|
- name: Make checks
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- "'containers' in existing_container"
|
||||||
|
- existing_container.containers
|
||||||
|
- "existing_container.containers == podman_inspect_result"
|
||||||
|
- all_containers.containers == existing_container.containers
|
||||||
|
- "'containers' in mixed_existing_container"
|
||||||
|
- mixed_existing_container.containers
|
||||||
|
- existing_container.containers == mixed_existing_container.containers
|
||||||
|
|
||||||
|
always:
|
||||||
|
|
||||||
|
- name: Cleanup
|
||||||
|
command: podman container rm -f {{ container_name }}
|
||||||
|
ignore_errors: true
|
||||||
Loading…
Reference in a new issue