An ansible role which connects RHEL systems to Red Hat.
The role requires subscription-manager, which is available from the standard
RHEL repositories, and usually installed by default on RHEL. On other
distributions it will be installed if not already.
The role requires also insights-client, which is available from the standard
RHEL repositories, in case the Insights support is enabled (and it is by
default).
In addition, the role requires rhc, which is available from the standard RHEL
repositories, in case the Insights remediation is enabled (and it is by
default).
The role requires modules from community.general
. If you are using
ansible-core
, you must install the community.general
collection. Use the
file meta/collection-requirements.yml
to install it:
ansible-galaxy collection install -vv -r meta/collection-requirements.yml
If you are using Ansible Engine 2.9, or are using an Ansible bundle which
includes these collections/modules, you should have to do nothing.
rhc_state: present
Whether the system is connected to Red Hat; valid values are present
(the default, to ensure connection), absent
, and reconnect
.
When using reconnect
, the system will be first disconnected in case
it was already connected; because of this, the role will always report a
“changed” status.
rhc_organization: "your-organization"
The organization of the user. This must be specified when connecting if
either:
rhc_auth
below) rhc_auth: {}
The authentication method used to connect a system. This must be specified
in case a system may need to connect (e.g. in case it was not before).
There are few possible authentication methods; only one can be specified at
a time.
NB: the variables used for authentication are considered secrets, and thus
they ought to be secured. We recommend the usage of Ansible Vault as source
for them. The references below only describe which keys exists and what they
are for.
For authenticating using username & password, specify the login
dictionary
using the following mandatory keys:
rhc_auth:
login:
username: "your-username"
password: "your-password"
using rhc_organization
if needed.
For authenticating using activation keys, specify the activation_keys
dictionary using the following mandatory keys, together with rhc_organization
:
rhc_auth:
activation_keys:
keys: ["key-1", ...]
rhc_organization: "your-organization"
rhc_server: {}
The details of the registration server to connect to; it can contain the
following optional keys:
rhc_server:
hostname: "hostname"
port: 443
prefix: "server-prefix"
insecure: false
hostname
is the hostname of the serverport
is the port to which connect to on the serverprefix
is the prefix (starting with /
) for the API calls to the serverinsecure
specifies whether to disable the validation of the SSL certificate rhc_baseurl: ""
The base URL for receiving content from the subscription server.
rhc_repositories: []
A list of repositories to enable or disable in the system. Each item is a
dictionary containing two keys:
name
is the name of a repository; this keys is mandatorystate
is the state of that repository in the system, and it can be enabled
disabled
; this key is optional, and enabled
if not specifiedrhc_repositories:
- {name: "repository-1", state: enabled}
- {name: "repository-2", state: disabled}
rhc_release: "release"
A release to set for the system. Typically used for locking a RHEL system to
a certain minor version of RHEL.
Use {"state":"absent"}
(and not ""
) to actually unset the release set for
the system.
rhc_insights:
state: present
Whether the system is connected to Insights; valid values are present
(the default, to ensure connection), and absent
.
rhc_insights:
autoupdate: true
Whether the system automatically updates the dynamic configuration. It is
enabled by default.
rhc_insights:
remediation: present
Whether the system is configured to run the Insights remediation; valid values
are present
(the default, to ensure remediation), and absent
.
rhc_insights:
tags: {}
A dictionary of tags that is added to the system record in Host Based Inventory
(HBI); typically used for the grouping and tagging of systems, and to search
for systems in the inventory.
Possible values of this variable:
null
or an empty value (e.g.: {}
): the tags file content is not changed{state: absent}
: all the tags are removed (by removing the tags file)Since the tags are arbitrary values for the tagging of systems, there is no
fixed format. In the specified dictionary, the keys are strings, and the type
of the values can be any data type (strings, numbers, lists, dictionaries,
etc).
Example of the tags configured in the insights-client
documentation:
rhc_insights:
tags:
group: _group-name-value_
location: _location-name-value_
description:
- RHEL8
- SAP
key 4: value
rhc_proxy: {}
The details of the proxy server to use for connecting:
rhc_proxy:
hostname: "proxy-hostname"
port: 4321
username: "proxy-hostname"
password: "proxy-password"
hostname
is the hostname of the proxy serverport
is the port to which connect to on the proxy serverusername
is the username to use for authenticating on the proxy server;password
is the password to use for authenticating on the proxy server;Use {"state":"absent"}
to reset all the proxy configurations to empty
(effectively disabling the proxy server).
NB: the variables used for the authentication on the proxy server are
considered secrets, and thus they ought to be secured. We recommend the usage
of Ansible Vault as source for them.
rhc_environments: []
The list of environments to which register to when connecting the system.
NB:
Ensure the connection to Red Hat including Insights, authenticating using
username & password:
- name: Register systems
hosts: all
vars:
rhc_auth:
login:
username: "your-username"
password: !vault |
$ANSIBLE_VAULT;1.2;AES256;dev
....
roles:
- redhat.rhel_system_roles.rhc
Ensure that certain RHEL 9 repositories are enabled, and another one is not:
- name: Ensure RHEL 9 repositories are enabled
hosts: all
vars:
rhc_repositories:
- {name: "rhel-9-for-x86_64-baseos-rpms", state: enabled}
- {name: "rhel-9-for-x86_64-appstream-rpms", state: enabled}
- {name: "codeready-builder-for-rhel-9-x86_64-rpms", state: disabled}
roles:
- redhat.rhel_system_roles.rhc
Ensure that a RHEL 8 system is locked on RHEL 8.6:
- name: Ensure systems are locked at RHEL 8.6
hosts: all
vars:
rhc_release: 8.6
roles:
- redhat.rhel_system_roles.rhc
Ensure that a system is connected to Insights, without optional features such
as automatic updates and remediation:
- name: Ensure systems are connected to Insights
hosts: all
vars:
rhc_insights:
autoupdate: false
remediation: absent
roles:
- redhat.rhel_system_roles.rhc
MIT