Debian Codegraph @

ansible_collections/containers/podman/plugins/modules/podman_secret_info.py

raw
1 #!/usr/bin/python
2 # Copyright (c) 2024 Red Hat
3 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
4
5 from __future__ import absolute_import, division, print_function
6
7 __metaclass__ = type
8
9
10 DOCUMENTATION = r"""
11 module: podman_secret_info
12 author:
13 - "Sagi Shnaidman (@sshnaidm)"
14 short_description: Gather info about podman secrets
15 notes: []
16 description:
17 - Gather info about podman secrets with podman inspect command.
18 requirements:
19 - "Podman installed on host"
20 options:
21 name:
22 description:
23 - Name of the secret
24 type: str
25 showsecret:
26 description:
27 - Show secret data value
28 type: bool
29 default: False
30 executable:
31 description:
32 - Path to C(podman) executable if it is not in the C($PATH) on the
33 machine running C(podman)
34 default: 'podman'
35 type: str
36 """
37
38 EXAMPLES = r"""
39 - name: Gather info about all present secrets
40 podman_secret_info:
41
42 - name: Gather info about specific secret
43 podman_secret_info:
44 name: specific_secret
45 """
46
47 RETURN = r"""
48 secrets:
49 description: Facts from all or specified secrets
50 returned: always
51 type: list
52 sample: [
53 {
54 "ID": "06068c676e9a7f1c7dc0da8dd",
55 "CreatedAt": "2024-01-28T20:32:08.31857841+02:00",
56 "UpdatedAt": "2024-01-28T20:32:08.31857841+02:00",
57 "Spec": {
58 "Name": "secret_name",
59 "Driver": {
60 "Name": "file",
61 "Options": {
62 "path": "/home/user/.local/share/containers/storage/secrets/filedriver"
63 }
64 },
65 "Labels": {}
66 }
67 }
68 ]
69 """
70
71 import json
72 from ansible.module_utils.basic import AnsibleModule
73
74
75 def get_secret_info(module, executable, show, name):
76 command = [executable, "secret", "inspect"]
77 if show:
78 command.append("--showsecret")
79 if name:
80 command.append(name)
81 else:
82 all_names = [executable, "secret", "ls", "-q"]
83 rc, out, err = module.run_command(all_names)
84 name = out.split()
85 if not name:
86 return [], out, err
87 command.extend(name)
88 rc, out, err = module.run_command(command)
89 if rc != 0 or "no secret with name or id" in err:
90 module.fail_json(msg="Unable to gather info for %s: %s" % (name or "all secrets", err))
91 if not out or json.loads(out) is None:
92 return [], out, err
93 return json.loads(out), out, err
94
95
96 def main():
97 module = AnsibleModule(
98 argument_spec=dict(
99 executable=dict(type="str", default="podman"),
100 name=dict(type="str"),
101 showsecret=dict(type="bool", default=False),
102 ),
103 supports_check_mode=True,
104 )
105
106 name = module.params["name"]
107 showsecret = module.params["showsecret"]
108 executable = module.get_bin_path(module.params["executable"], required=True)
109
110 inspect_results, out, err = get_secret_info(module, executable, showsecret, name)
111
112 results = {
113 "changed": False,
114 "secrets": inspect_results,
115 "stderr": err,
116 }
117
118 module.exit_json(**results)
119
120
121 if __name__ == "__main__":
122 main()