feat: Add support to configure parameters form insights-client.conf

README.md

@@ -150,6 +150,25 @@ the system.
 Whether the system is connected to Insights; valid values are `present`
 (the default, to ensure connection), and `absent`.
 
+```yaml
+    rhc_insights_auth:
+      authmethod: BASIC
+      username: null
+      password: null
+```
+
+Configures the authentication method; valid options for `authmethod` are `BASIC`
+(the default), and `CERT`. The variables `username` and `password` configure
+username and password when authmethod is `BASIC`.
+
+```yaml
+    rhc_insights:
+      autoconfig: true
+```
+
+Whether the system attempts to auto configure with Satellite server, values
+are `true` (the default), and `false`.
+
 ```yaml
     rhc_insights:
       autoupdate: true
@@ -173,6 +192,14 @@ Possible values of this variable:
 * `{state: absent}`: the ansible host name is unset in the insights-client config file and Host Based Inventory (HBI) is updated to use the system host name.
 * any other string value: the ansible host name is changed in Host Based Inventory (HBI).
 
+```yaml
+    rhc_inights:
+      baseurl: "cert-api.access.redhat.com:443/r/insights"
+```
+
+Configures the Base URL for the Insights API.
+Defaults to "cert-api.access.redhat.com:443/r/insights".
+
 ```yaml
     rhc_insights:
       display_name: "Example Host"
@@ -188,6 +215,56 @@ Possible values of this variable:
 
 Note: If not set explicitly on registration, the display name is set to the hostname by default. It is not possible to automatically revert it to the hostname, but it can be set so manually.
 
+```yaml
+    rhc_insights:
+      file_redaction:
+        commands: []
+        files: []
+        components: []
+```
+
+Specify lists of commands, files, and components to obmit from output
+
+```yaml
+    rhc_insights:
+      file_redaction:
+        commands: []
+        files: []
+        components: []
+      file_content_redaction:
+        keywords: []
+        patterns: []
+        regex_patterns: []
+```
+
+These are optional.
+Specify lists of commands, files, components, keywords and patterns to obmit from output.
+NOTE: You cannot mix plain string matching and regular expression matching.
+For more informaition on this topic read: [YAML-style denylist configuration for Red Hat Insights Client](https://access.redhat.com/articles/4511681).
+
+```yaml
+    rhc_insights:
+      loglevel: DEFAULT
+```
+
+Configures the log level; valid options are DEBUG (the default), INFO, WARNING, ERROR, CRITICAL.
+
+```yaml
+    rhc_insights:
+      obfuscate: false
+```
+
+Configures IP address obfuscation; valid values are `false` (the default),
+and `false`.
+
+```yaml
+    rhc_insights:
+      obfuscate_hostname: false
+```
+
+Configures hostname obfuscation; valid values are `false` (the default),
+and `false`. Requires `obfuscate: true`.
+
 ```yaml
     rhc_insights:
       remediation: present

defaults/main.yml

@@ -5,11 +5,28 @@ rhc_baseurl: null
 rhc_environments: []
 rhc_insights:
   ansible_host: null
+  autoconfig: true
   autoupdate: true
+  baseurl: "cert-api.access.redhat.com:443/r/insights"
   display_name: null
+  file_redaction:
+    commands: []
+    files: []
+    components: []
+  file_content_redaction:
+    keywords: []
+    patterns: []
+    regex_patterns: []
+  loglevel: DEFAULT
+  obfuscate: false
+  obfuscate_hostname: false
   remediation: present
   state: present
   tags: {}
+rhc_insights_auth:
+  authmethod: BASIC
+  password: null
+  username: null
 rhc_organization: null
 rhc_proxy: {}
 rhc_release: null

tasks/insights-client.yml

@@ -38,6 +38,96 @@
     insertafter: "#auto_update"
     line: auto_update={{ rhc_insights.autoupdate | d(true) | bool }}
 
+- name: Configure authmethod
+  when:
+    - rhc_insights_auth.authmethod is defined
+    - not rhc_insights_auth.authmethod is none
+    - rhc_insights_auth.authmethod != ""
+    - rhc_insights_auth.authmethod != __rhc_state_absent
+    - rhc_insights_auth.authmethod != omit
+  lineinfile:
+    path: "{{ __rhc_insights_conf }}"
+    regexp: "^authmethod="
+    state: present
+    line: authmethod={{ rhc_insights_auth.authmethod }}
+  check_mode: true
+  no_log: true
+
+- name: Configure username for authmethod BASIC
+  when:
+    - rhc_insights_auth.authmethod = "BASIC"
+    - rhc_insights_auth.authmethod != __rhc_state_absent
+    - rhc_insights_auth.username is defined
+    - not rhc_insights_auth.username is none
+    - rhc_insights_auth.username != ""
+    - rhc_insights_auth.username != omit
+  lineinfile:
+    path: "{{ __rhc_insights_conf }}"
+    regexp: "^username="
+    state: present
+    line: username={{ rhc_insights_auth.username }}
+  check_mode: true
+  no_log: true
+
+- name: Configure password for authmethod BASIC
+  when:
+    - rhc_insights_auth.authmethod == "BASIC"
+    - rhc_insights_auth.authmethod != __rhc_state_absent
+    - rhc_insights_auth.password is defined
+    - not rhc_insights_auth.password is none
+    - rhc_insights_auth.password != ""
+    - rhc_insights_auth.password != omit
+  lineinfile:
+    path: "{{ __rhc_insights_conf }}"
+    regexp: "^password="
+    state: present
+    line: password={{ rhc_insights_auth.password }}
+  check_mode: true
+  no_log: true
+
+- name: Configure Base URL for the Insights API
+  when:
+    - rhc_insights.baseurl is defined
+    - not rhc_insights.baseurl is none
+    - rhc_insights.baseurl != ""
+    - rhc_insights.baseurl != __rhc_state_absent
+    - rhc_insights.baseurl != omit
+  lineinfile:
+    path: "{{ __rhc_insights_conf }}"
+    regexp: "^base_url="
+    state: present
+    line: base_url={{ rhc_insights.baseurl }}
+  check_mode: true
+
+- name: Configure IP address obfuscation
+  when:
+    - rhc_insights.obfuscate is defined
+    - not rhc_insights.obfuscate is none
+    - rhc_insights.obfuscate != ""
+    - rhc_insights.obfuscate != __rhc_state_absent
+    - rhc_insights.obfuscate != omit
+  lineinfile:
+    path: "{{ __rhc_insights_conf }}"
+    regexp: "^obfuscate="
+    state: present
+    line: obfuscate={{ rhc_insights.obfuscate }}
+  check_mode: true
+
+- name: Configure hostname obfuscation
+  when:
+    - rhc_insights.obfuscate == "true"
+    - rhc_insights.hostname_obfuscate is defined
+    - not rhc_insights.hostname_obfuscate is none
+    - rhc_insights.hostname_obfuscate != ""
+    - rhc_insights.hostname_obfuscate != __rhc_state_absent
+    - rhc_insights.hostname_obfuscate != omit
+  lineinfile:
+    path: "{{ __rhc_insights_conf }}"
+    regexp: "^hostname_obfuscate="
+    state: present
+    line: hostname_obfuscate={{ rhc_insights.hostname_obfuscate }}
+  check_mode: true
+
 - name: Check ansible host in insights-client config
   when:
     - rhc_insights.ansible_host is defined
@@ -133,6 +223,46 @@
           or "Registered" in __rhc_insights_status.stdout
       changed_when: true
 
+- name: Configure file redaction
+  when: (rhc_insights.file_redaction.commands is defined) or
+        (rhc_insights.file_redaction.files is defined) or
+        (rhc_insights.file_redaction.components is defined)
+  block:
+    - name: Create file-redaction.yaml from template
+      template:
+        src: templates/file-redaction.yaml.j2
+        dest: /etc/insights-client/file-redaction.yaml
+        owner: root
+        group: root
+        mode: 0660
+    - name: Configure path to file-redaction.yaml in insights-client.conf
+      lineinfile:
+        path: "{{ __rhc_insights_conf }}"
+        regexp: "^redaction_file="
+        insertafter: "#redaction_file="
+        line: redaction_file=/etc/insights-client/file-redaction.yaml
+
+- name: Configure file content redaction
+  when: (rhc_insights.file_content_redaction.keywords is defined) or
+        (rhc_insights.file_content_redaction.patterns is defined) or
+        (rhc_insights.file_content_redaction.regex_patterns is defined)
+  block:
+    - name: Create file-content-redaction.yaml from template
+      template:
+        src: templates/file-content-redaction.yaml.j2
+        dest: /etc/insights-client/file-content-redaction.yaml
+        owner: root
+        group: root
+        mode: 0660
+    - name: Configure path to file-redaction.yaml in insights-client.conf
+      lineinfile:
+        path: "{{ __rhc_insights_conf }}"
+        regexp: "^content_redaction_file="
+        insertafter: "#content_redaction_file="
+        line: >-
+          "content_redaction_file=/etc/insights-client/
+          file-content-redaction.yaml"
+
 - name: Register insights-client
   shell: insights-client --register & wait
   when:

templates/file-content-redaction.yaml.j2

@@ -0,0 +1,43 @@
+# file-conrent-redaction.yaml
+# Docs: https://access.redhat.com/articles/4511681
+---
+# Omit lines from files and command output using parameters listed here.
+# Lines matching the parameters specified will be omitted
+#   in the order that the parameters are given, e.g.,
+#
+# patterns:
+#   - "example_string_1"
+#   - "example_string_2"
+#
+# Lines containing "example_string_1" or "example_string_2" will be
+# omitted from output.
+#
+# To use regular expressions, wrap the array with "regex" like the following example:
+#
+# patterns:
+#   regex:
+#     - abc.*
+#     - localhost[[:digit:]]
+#
+# Lines matching these regular expressions will be omitted
+# from output.
+# NOTE: You cannot mix plain string matching and regular expression matching.
+{% if rhc_insights.file_content_redaction.keywords %}
+keywords:
+{% for keyword in rhc_insights.file_content_redaction.keywords %}
+  - {{ keyword }}
+{% endfor %}
+{% endif %}
+{% if rhc_insights.file_content_redaction.patterns %}
+patterns:
+{% for pattern in rhc_insights.file_content_redaction.patterns %}
+  - {{ pattern }}
+{% endfor %}
+{% endif %}
+{% if rhc_insights.file_content_redaction.regex_patterns %}
+patterns:
+  regex:
+{% for regex in rhc_insights.file_content_redaction.regex_patterns %}
+    - {{ regex }}
+{% endfor %}
+{% endif %}

templates/file-redaction.yaml.j2

@@ -0,0 +1,37 @@
+# file-redaction.yaml
+# Docs: https://access.redhat.com/articles/4511681
+---
+# Omit entire output of commands
+# Commands can be specified either by full command or
+#   by the "symbolic_name" listed in /etc/insights-client/.cache.json
+{% if rhc_insights.file_redaction.commands %}
+commands:
+{% for command in rhc_insights.file_redaction.commands %}
+  - {{ command }}
+{% endfor %}
+{% endif %}
+
+# Omit entire output of files
+# Files can be specified either by full filename or
+# by the "symbolic_name" listed in .cache.json
+{% if rhc_insights.file_redaction.files %}
+files:
+{% for file in rhc_insights.file_redaction.files %}
+  - {{ file }}
+{% endfor %}
+{% endif %}
+
+# Omit insights-core components
+# Refer to the Datasource Catalog here for a full list of available insights-core components,
+#   and the commands/files they correspond to.
+#   See items listed under "General Datasources":
+#   https://insights-core.readthedocs.io/en/latest/specs_catalog.html
+#
+# Components specified here must be listed with the fully qualified name, i.e.
+#   must be prefixed with "insights.specs.default.DefaultSpecs."
+{% if rhc_insights.file_redaction.components %}
+components:
+{% for component in rhc_insights.file_redaction.components %}
+  - {{ component }}
+{% endfor %}
+{% endif %}