Bug 1990119 - Documentation bug for the compute_resource module
Summary: Documentation bug for the compute_resource module
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Ansible Collection
Version: 6.9.0
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: 6.12.0
Assignee: Evgeni Golov
QA Contact: Griffin Sullivan
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-08-04 19:26 UTC by Luc de Louw
Modified: 2022-11-16 13:33 UTC (History)
3 users (show)

Fixed In Version: ansible-collection-redhat-satellite-3.4.0
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
: 2131788 (view as bug list)
Environment:
Last Closed: 2022-11-16 13:32:46 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github theforeman foreman-ansible-modules pull 1404 0 None open update libvirt doc examples 2022-05-12 09:12:10 UTC
Red Hat Issue Tracker SAT-12649 0 None None None 2022-09-01 10:54:17 UTC
Red Hat Product Errata RHSA-2022:8506 0 None None None 2022-11-16 13:33:34 UTC

Description Luc de Louw 2021-08-04 19:26:17 UTC
Description of problem:

When following the documentation at https://console.redhat.com/ansible/automation-hub/repo/published/redhat/satellite/content/module/compute_resource the URL of the provider is wrong, at least for the libvirt provider.


Version-Release number of selected component (if applicable):
2.1.2 (Sat 6.9 -> 2.0.1)

How reproducible:
Always

Steps to Reproduce:
1. Using the following Ansible playbook snippet:
provider_params:
      url: libvirt.example.com
      display_type: vnc
2. Run the playbook


Actual results:

fatal: [localhost]: FAILED! => {"changed": false, "error": {"errors": {"url": ["is invalid"]}, "full_messages": ["URL is invalid"], "id": null}, "msg": "Error while performing create on compute_resources: 422 Client Error: Unprocessable Entity"}                                             


Expected results:

TASK [compute-resources : Create livirt compute resource] *********************************************
changed: [localhost]



Additional info:

Correct would be:

- name: Create livirt compute resource
  redhat.satellite.compute_resource:
    name: libvirt-hypervisor
    locations: "BER"
    organizations: "{{ organization }}"
    provider: libvirt
    provider_params:
      url: qemu+ssh://root.com/system
      display_type: spice
      set_console_password: no
    server_url: "{{ sat_url }}"
    username: "{{ sat_user }}"
    password: "{{ sat_passwd }}"
    state: present

BTW: display_type is also undocumented and vnc is not really state of the art compared to spice.

Thanks,

Luc

Comment 1 Griffin Sullivan 2022-09-09 15:58:25 UTC
Verified in 6.12 snap 10

compute_resource docs are updated with a proper libvirt url and new display_type.

Steps to Reproduce:

1) #  ansible-doc -M /usr/share/ansible/collections/ansible_collections/redhat/satellite/plugins/modules compute_resource

Results:

- name: Create livirt compute resource
  redhat.satellite.compute_resource:
    name: example_compute_resource
    locations:
      - Munich
    organizations:
      - ACME
    provider: libvirt
    provider_params:
      url: qemu+ssh://root.com/system
      display_type: spice
    server_url: "https://satellite.example.com"
    username: "admin"
    password: "changeme"
    state: present


Notes:

Original link is also updated properly.

Comment 5 errata-xmlrpc 2022-11-16 13:32:46 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Important: Satellite 6.12 Release), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2022:8506


Note You need to log in before you can comment on or make changes to this bug.