Explicitly document how to register to Red Hat

[myllynen]

The documentation at https://github.com/linux-system-roles/rhc discusses about rhc_server but doesn't give any indication what if any values should be used when connecting to Red Hat instead of a local satellite. While many might guess or test that the variable can be left undefined it'd be better to avoid guessing and mention that explicitly. Thanks.

[ptoscano]

The general RHEL documentation for the role is here:
https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/automating_system_administration_by_using_rhel_system_roles/index#using-the-rhc-system-role-to-register-the-system_automating-system-administration-by-using-rhel-system-roles

For connecting to Red Hat, there are no attributes (e.g. rhc_server) to be changed by default; this is the same as invoking subscription-manager or rhc manually, which register to Red Hat by default OOTB.

While many might guess or test that the variable can be left undefined it'd be better to avoid guessing and mention that explicitly.

I'm not sure I understand the problem here: why would you need to guess? What's the "thought process" here that might lead to confusion?

[myllynen]

I want to use this role to connect a system to Red Hat, not local Satellite. This is the role documentation: https://github.com/linux-system-roles/rhc. It doesn't tell what should values should be used for rhc_server in that case.

[ptoscano]

Just like the RHEL documentation does not mention any changes needed to register to Red Hat, the same applies here to the role.

What I can write is that not changing a/any parameter means that the "default" of the system, which means the underlying tool.

[myllynen]

I think it would be a good idea to document the default, just like the default is documented with other variables as well. Thanks.

[richm]

The role should explicitly state something like "To register to Red Hat, the rhc_server parameter should be omitted (or empty?)"
and we should have an example (if we do not already) of registering a system to Red Hat

- name: Register system to Red Hat
  vars:
    rhc:
      ....
  roles:
    - linux-system-roles.rhc