Add option to proxmox dynamic inventory to exclude nodes

[IamLunchbox]

SUMMARY

This pull request enables users of the proxmox inventory source to exclude the proxmox-nodes from the ansible-host list at will. The default of the new setting exclude_nodes is to include nodes, so it it should stay compatible to the current usage. If exclude_node is true, nodes will not be added at all to the inventory. This option is implicitly mutually exclusive with composite-vars for nodes, since, well if you exclude nodes, you don't need composite vars for them.

TODO: I could only test this implementation on my single-node proxmox cluster, I'd be glad if someone else could verify this implementation on a multi-node-cluster.

This PR fixes #6714 .

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

!component =plugins/inventory/proxmox.py

ADDITIONAL INFORMATION

before:

ubuntu@adm: ansible-inventory -i test.proxmox.yaml --graph
@all:
  |--@ungrouped:
  |--@proxmox_all_lxc:
  |--@proxmox_all_qemu:
  |  |--mail
  |  |--git
  |  |--web
  |--@proxmox_all_running:
  |  |--mail
  |  |--git
  |  |--web
  |--@proxmox_all_stopped:
  |--@proxmox_all_prelaunch:
  |--@proxmox_all_paused:
  |--@proxmox_nodes:
  |  |--hypervisor
  |--@proxmox_hypervisor_lxc:
  |--@proxmox_hypervisor_qemu:
  |  |--git
  |  |--mail
  |  |--web

after:

ubuntu@adm: ansible-inventory -i test.proxmox.yaml --graph
 @all:
  |--@ungrouped:
  |--@proxmox_all_lxc:
  |--@proxmox_all_qemu:
  |  |--web
  |  |--git
  |  |--mail
  |--@proxmox_all_running:
  |  |--web
  |  |--git
  |  |--mail
  |--@proxmox_all_stopped:
  |--@proxmox_all_prelaunch:
  |--@proxmox_all_paused:
  |--@proxmox_hypervisor_lxc:
  |--@proxmox_hypervisor_qemu:
  |  |--web
  |  |--git
  |  |--mail

[ansibullbot]

cc @Ajpantuso @Thulium-Drake @ilijamt @joshainglis @karmab
click here for bot help

[felixfontein]

Thanks for your contribution!

Please note that the unit tests currently fail and need to be fixed before merging.

[IamLunchbox]

Yes, I saw that the pipeline failed due to the error AttributeError: 'InventoryModule' object has no attribute 'exclude_nodes' - but I don't know where this is coming from or why this happens.

[felixfontein]

The tests set all attributes that should be present manually, see for example https://github.com/ansible-collections/community.general/blob/main/tests/unit/plugins/inventory/test_proxmox.py#L648. Since you added a new attribute, you also have to set that one.

[IamLunchbox]

The CI-Pipeline is fixed.

[felixfontein]

If there are no objections, I'll merge this in a week.

[patchback]

Backport to stable-8: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-8/d05932fb2cf0bcb81041e8df3b8819ee201424c0/pr-7461

Backported as #7606

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

[felixfontein]

@IamLunchbox thanks four your contribution!
@Thulium-Drake thanks for reviewing!