Add podman system info module #922

johnsonlien · 2025-04-08T05:35:17Z

This adds the podman_system_info module. There are niche use cases in offline environments to set up machines running Podman.

Closes #921

johnsonlien

Have come into (rare) situations where I needed to configure cgroups to use v2 or network backend. This can help my playbook to decide whether or not to do those extra steps.

sshnaidm · 2025-04-14T15:12:35Z

Awesome! Thanks for this addition.
Please integrate CI tests as done in its example so tests can run inside the job: #531

johnsonlien

added workflow

sshnaidm · 2025-04-15T19:07:16Z

You need to add all from that PR, this file as well: https://github.com/containers/ansible-podman-collections/pull/531/files#diff-a01ddc89899bc0839a7c238e1a66c67a6087d5d8954f4729b22e64cff76cd21a
Need to fix linter and ansible-test:

ERROR: Found 3 yamllint issue(s) which need to be resolved:
ERROR: plugins/modules/podman_system_info.py:26:1: error: EXAMPLES: syntax error: found unexpected end of stream (syntax)
ERROR: plugins/modules/podman_system_info.py:26:1: unparsable-with-libyaml: EXAMPLES: while scanning a quoted scalar found unexpected end of stream
ERROR: plugins/modules/podman_system_info.py:50:1: error: RETURN: syntax error: found character '\t' that cannot start any token (syntax)

ERROR: plugins/modules/podman_system_info.py:0:0: undocumented-parameter: Argument 'executable' is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/podman_system_info.py:26:1: invalid-examples: EXAMPLES is not valid YAML
RROR: plugins/modules/podman_system_info.py:0:0: doc-default-does-not-match-spec: Argument 'executable' in argument_spec defines default as ('podman') but documentation defines default as (None)
ERROR: plugins/modules/podman_system_info.py:0:0: parameter-type-not-in-doc: Argument 'executable' in argument_spec defines type as 'str' but documentation doesn't define type

And RETURN statement should be YAML, take a look at example here: https://github.com/containers/ansible-podman-collections/blob/main/plugins/modules/podman_container_info.py#L51

Signed-off-by: johnsonlien <[email protected]>

return json object and add example for printing value Signed-off-by: johnsonlien <[email protected]>

Signed-off-by: johnsonlien <[email protected]>

sshnaidm · 2025-04-16T09:34:35Z

plugins/modules/podman_system_info.py

+  register: podman_info
+- name: Printing Podman System info
+  debug:
+    msg: "{{ podman_info['podman_system_info'] }}


no ending double quote

Suggested change

msg: "{{ podman_info['podman_system_info'] }}

msg: "{{ podman_info['podman_system_info'] }}"

sshnaidm · 2025-04-16T09:35:09Z

plugins/modules/podman_system_info.py

+  GoVersion: go1.16.6
+  OsArch: linux/amd64
+  Version: 4.0.0
+}


remove this

Suggested change

}

sshnaidm · 2025-04-16T09:36:20Z

plugins/modules/podman_system_info.py

+author:
+  - Johnson Lien (@johnsonlien)
+short_description: Get podman system information from host machine
+description: Runs "podman system info --format json" on host machine


you should document arguments here, like executable

sshnaidm · 2025-04-16T09:36:47Z

plugins/modules/podman_system_info.py

+def main():
+    module = AnsibleModule(
+        argument_spec=dict(
+            executable=dict(type='str', default='podman'),


please add it in doc above.

Signed-off-by: johnsonlien <[email protected]>

For quadlets you can set sdnotify (which maps to Notify=) to healthy to use a healthcheck to determine when the container is up. Signed-off-by: Ewoud Kohl van Wijngaarden <[email protected]> Signed-off-by: johnsonlien <[email protected]>

Signed-off-by: johnsonlien <[email protected]>

return json object and add example for printing value Signed-off-by: johnsonlien <[email protected]>

Signed-off-by: johnsonlien <[email protected]>

…ners#920) Fixes: containers#807 Signed-off-by: Evgeni Golov <[email protected]> Signed-off-by: johnsonlien <[email protected]>

Fix containers#917 Signed-off-by: Sagi Shnaidman <[email protected]> Signed-off-by: johnsonlien <[email protected]>

Signed-off-by: Sagi Shnaidman <[email protected]> Signed-off-by: johnsonlien <[email protected]>

Signed-off-by: johnsonlien <[email protected]>

sshnaidm

Please fix remaining issues and should be fine

sshnaidm · 2025-04-29T07:08:07Z

plugins/modules/podman_system_info.py

+import json
+
+from ansible.module_utils.basic import AnsibleModule
+


Suggested change

sshnaidm · 2025-04-29T07:08:21Z

plugins/modules/podman_system_info.py

+
+    module.log(msg="Unable to get podman system info: %s" % err)
+    return json.dumps([])
+


Suggested change

sshnaidm · 2025-04-29T07:08:35Z

plugins/modules/podman_system_info.py

+    )
+
+    module.exit_json(**results)
+


Suggested change

sshnaidm · 2025-04-29T07:14:36Z

plugins/modules/podman_system_info.py

+  conmon:
+    package: conmon-2.0.29-2.fc34.x86_64
+    path: /usr/bin/conmon
+    version: 'conmon version 2.0.29, commit: '


Suggested change

version: 'conmon version 2.0.29, commit: '

version: 'conmon version 2.0.29, commit '

this breaks yaml

sshnaidm · 2025-04-29T07:14:46Z

plugins/modules/podman_system_info.py

+    package: conmon-2.0.29-2.fc34.x86_64
+    path: /usr/bin/conmon
+    version: 'conmon version 2.0.29, commit: '
+ cpu_utilization:


Suggested change

cpu_utilization:

cpu_utilization:

this breaks yaml, wrong indent

sshnaidm · 2025-04-29T07:16:08Z

pep8 errors, included in suggestions:

ERROR: Found 3 pep8 issue(s) which need to be resolved:
ERROR: plugins/modules/podman_system_info.py:187:1: E302: expected 2 blank lines, found 1
ERROR: plugins/modules/podman_system_info.py:197:1: E302: expected 2 blank lines, found 1
ERROR: plugins/modules/podman_system_info.py:216:1: E305: expected 2 blank lines after class or function definition, found 1

sshnaidm · 2025-05-12T09:51:47Z

@johnsonlien would you like to fix these last linter errors?

Signed-off-by: Sagi Shnaidman <[email protected]>

johnsonlien force-pushed the add-podman_system_info-module branch from e40c22c to 22d8381 Compare April 8, 2025 05:38

johnsonlien commented Apr 8, 2025

View reviewed changes

johnsonlien commented Apr 15, 2025

View reviewed changes

johnsonlien force-pushed the add-podman_system_info-module branch from 3296a37 to 47f94ea Compare April 15, 2025 06:26

johnsonlien added 8 commits April 15, 2025 22:59

add incomplete module

704b236

Signed-off-by: johnsonlien <[email protected]>

add RETURN value and a test

3142ba4

Signed-off-by: johnsonlien <[email protected]>

add another example

7f2c399

Signed-off-by: johnsonlien <[email protected]>

add log if system info fails

3ee0c54

Signed-off-by: johnsonlien <[email protected]>

Update podman_system_info.py

e9b1c5d

return json object and add example for printing value Signed-off-by: johnsonlien <[email protected]>

add workflow for podman_system_info module

162ee42

Signed-off-by: johnsonlien <[email protected]>

add ansible python interpreter to var for podman_system_info

ddb0d51

Signed-off-by: johnsonlien <[email protected]>

have RETURN be yaml format

1c857fe

Signed-off-by: johnsonlien <[email protected]>

johnsonlien force-pushed the add-podman_system_info-module branch from 1636a59 to 1c857fe Compare April 16, 2025 05:59

add integration test to workflow

b576ca5

Signed-off-by: johnsonlien <[email protected]>

johnsonlien force-pushed the add-podman_system_info-module branch from be7f23e to b576ca5 Compare April 16, 2025 06:28

sshnaidm requested changes Apr 16, 2025

View reviewed changes

johnsonlien added 12 commits April 28, 2025 21:22

remove extra closing brace

eec08a8

remove '--format json' from description

d69625e

add missing double quotes

9d10714

add requirements and options section to DOCUMENTATION

c1da79a

split long sentence to newline

79438c1

Merge branch 'containers:main' into add-podman_system_info-module

dcd654f

add integration test to workflow

342857f

Signed-off-by: johnsonlien <[email protected]>

remove extra closing brace

a3f28d5

Signed-off-by: johnsonlien <[email protected]>

remove '--format json' from description

eda19cf

Signed-off-by: johnsonlien <[email protected]>

add missing double quotes

e377ac5

Signed-off-by: johnsonlien <[email protected]>

add requirements and options section to DOCUMENTATION

5104c0d

Signed-off-by: johnsonlien <[email protected]>

split long sentence to newline

8045bf5

Signed-off-by: johnsonlien <[email protected]>

ekohl and others added 19 commits April 28, 2025 22:21

add incomplete module

285f1fc

Signed-off-by: johnsonlien <[email protected]>

add RETURN value and a test

6c1f17e

Signed-off-by: johnsonlien <[email protected]>

add another example

7f2b410

Signed-off-by: johnsonlien <[email protected]>

add log if system info fails

a55474c

Signed-off-by: johnsonlien <[email protected]>

Update podman_system_info.py

fac2e1d

return json object and add example for printing value Signed-off-by: johnsonlien <[email protected]>

add workflow for podman_system_info module

d98cc56

Signed-off-by: johnsonlien <[email protected]>

add ansible python interpreter to var for podman_system_info

fa4bb59

Signed-off-by: johnsonlien <[email protected]>

have RETURN be yaml format

498c6a7

Signed-off-by: johnsonlien <[email protected]>

add integration test to workflow

5e6bf4d

Signed-off-by: johnsonlien <[email protected]>

remove extra closing brace

a5f4608

Signed-off-by: johnsonlien <[email protected]>

remove '--format json' from description

6a7eefb

Signed-off-by: johnsonlien <[email protected]>

add missing double quotes

429be95

Signed-off-by: johnsonlien <[email protected]>

add requirements and options section to DOCUMENTATION

ce5e456

Signed-off-by: johnsonlien <[email protected]>

split long sentence to newline

7e21a7e

Signed-off-by: johnsonlien <[email protected]>

correctly quote labels and environment variables for quadlets (contai…

d4aa649

…ners#920) Fixes: containers#807 Signed-off-by: Evgeni Golov <[email protected]> Signed-off-by: johnsonlien <[email protected]>

Fix setuptools (containers#925)

388a628

Fix containers#917 Signed-off-by: Sagi Shnaidman <[email protected]> Signed-off-by: johnsonlien <[email protected]>

Fix conditions in CI jobs (containers#928)

230f14a

Signed-off-by: Sagi Shnaidman <[email protected]> Signed-off-by: johnsonlien <[email protected]>

add missing curly brace in ci/playbooks/containers/podman_system_info

179f219

Signed-off-by: johnsonlien <[email protected]>

sshnaidm requested changes Apr 29, 2025

View reviewed changes

sshnaidm force-pushed the add-podman_system_info-module branch 4 times, most recently from 2dd7cfe to 93fa2d1 Compare June 22, 2025 10:06

Add systeminfo module

9aa5d9c

Signed-off-by: Sagi Shnaidman <[email protected]>

sshnaidm force-pushed the add-podman_system_info-module branch from 93fa2d1 to 9aa5d9c Compare June 22, 2025 10:09

sshnaidm approved these changes Jun 22, 2025

View reviewed changes

sshnaidm merged commit aa20ede into containers:main Jun 22, 2025
8 checks passed

	msg: "{{ podman_info['podman_system_info'] }}
	msg: "{{ podman_info['podman_system_info'] }}"

		import json

		from ansible.module_utils.basic import AnsibleModule


		module.log(msg="Unable to get podman system info: %s" % err)
		return json.dumps([])

	version: 'conmon version 2.0.29, commit: '
	version: 'conmon version 2.0.29, commit '

Uh oh!

Add podman system info module #922

Add podman system info module #922

Uh oh!

Conversation

johnsonlien commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johnsonlien left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sshnaidm commented Apr 14, 2025

Uh oh!

johnsonlien left a comment

Choose a reason for hiding this comment

Uh oh!

sshnaidm commented Apr 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sshnaidm left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sshnaidm commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sshnaidm commented May 12, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

johnsonlien commented Apr 8, 2025 •

edited

Loading

johnsonlien left a comment •

edited

Loading

sshnaidm commented Apr 29, 2025 •

edited

Loading