Client Configuration Guide for Red Hat Insights with FedRAMP

Procedure

1. Use an editor to create the /etc/insights-client/file-redaction.yaml file.

2. Enter the strings, files: and commands:, on separate lines in the YAML file.

   Copy to Clipboard Toggle word wrap

   files:
   
   
   commands:

3. Specify the files and commands you want to redact:

   1. On the line following files:, enter the files that you want to redact. Use the information in the Datasources catalog to identify which files and commands to specify. For example, if you want to redact the auditd.conf file, this is how it would look:

      Copy to Clipboard Toggle word wrap

      files:
        - /etc/audit/auditd.conf

   2. On the line following commands:, enter the commands that you want to redact. Use the information in the Datasources catalog to identify which commands to specify. For example, if you want to redact the ethtool -i command, this is how it would look:

      Copy to Clipboard Toggle word wrap

      commands:
        - ethtool_i

4. Save the YAML file in /etc/insights-client/.

5. Verify that the file-redaction.yaml file permissions are root owner only by running ll file-redaction.yaml as root, on the command line.

   Copy to Clipboard Toggle word wrap

   [root@insights]# ll file-redaction.yaml
   -rw-------. 1 root root 145 Sep 25 17:39 file-redaction.yaml

1. On the command line, enter the insights-client command with the --no-upload option, and press Return.

   Copy to Clipboard Toggle word wrap

   [root@insights]# insights-client --no-upload

2. The command runs and displays informational messages. The following example shows the redaction of the dmesg command and the cluster.conf file.

   Copy to Clipboard Toggle word wrap

   WARNING: Excluding data from files
   Starting to collect Insights data for I-HOST
   WARNING: Skipping command /bin/dmesg
   WARNING: Skipping file /etc/cluster/cluster.conf
   Archive saved at /var/tmp/qsINM9/insights-ITC-4-20190925180232.tar.gz

Procedure

1. Use an editor to create the /etc/insights-client/file-content-redaction.yaml file.

   Example

   Copy to Clipboard Toggle word wrap

   # file-content-redaction.yaml
   ---
   # Pattern redaction per matching line
   #  Lines that match a pattern are excluded from files and command output.
   #  Patterns are processed in the order that they are listed.
   # Example
   
   patterns:
    - "a_string_1"
    - "a_string_2"
   
   # Regular expression pattern redaction per line
   #  Use "regex:" to wrap patterns with regular expressions"
   # Example
   
   patterns:
    regex:
    - "abc.*def"
    - "localhost[[:digit:]]"
   
   
   # Keyword replacement redaction
   #  Replace keywords in files and command output with generic identifiers
   #  Keyword does not support regex
   # Example
   
   keywords:
   - "1.1.1.1"
   - "My Name"
   - "a_name"

2. Make sure the file-content-redaction.yaml file permissions are set for root owner only.

   Copy to Clipboard Toggle word wrap

   [root@insights]# ll file-content-redaction.yaml
   -rw-------. 1 root root 145 Sep 25 17:39 file-content-redaction.yaml

Procedure

1. Enter the insights-client command with the --no-upload option.

   Copy to Clipboard Toggle word wrap

   [root@insights]# insights-client --no-upload

   The command displays informational messages when redaction or obfuscation is applied.

   Copy to Clipboard Toggle word wrap

   WARNING: Excluding data from files
   Starting to collect Insights data for ITC-4
   WARNING: Skipping patterns found in remove.conf
   WARNING: Skipping command /bin/dmesg
   WARNING: Skipping command /bin/hostname
   WARNING: Skipping file /etc/cluster/cluster.conf
   WARNING: Skipping file /etc/hosts
   Archive saved at /var/tmp/qsINM9/insights-ITC-4-20190925180232.tar.gz

2. Navigate to the temporary storage directory as shown in the Archive saved at message.

   Copy to Clipboard Toggle word wrap

   [root@insights]# cd /var/tmp/qsINM9/

3. Unpack the compressed tar.gz file.

   Copy to Clipboard Toggle word wrap

   [root@insights]# tar -xzf insights-ITC-4-20190925180232.tar.gz

   The script creates a new directory that contains the files.

Procedure

1. Enter the insights-client command with the --keep-archive option.

   Copy to Clipboard Toggle word wrap

   [root@insights]# insights-client --keep-archive

   The command displays informational messages.

   Copy to Clipboard Toggle word wrap

   Starting to collect Insights data for ITC-4
   Uploading Insights data.
   Successfully uploaded report from ITC-4 to account 6229994.
   Insights archive retained in /var/tmp/ozM8bY/insights-ITC-4-20190925181622.tar.gz

2. Navigate to the temporary storage directory displayed in the Insights archive retained in message.

   Copy to Clipboard Toggle word wrap

   [root@insights]# cd /var/tmp/ozM8bY/

3. Unpack the compressed tar.gz file.

   Copy to Clipboard Toggle word wrap

   [root@insights]# tar -xzf insights-ITC-4-20190925181622.tar.gz

   The script creates a new directory that contains the files.

Procedure

1. Run the following command as root, adding your custom group name in place of <name-you-choose>:

   Copy to Clipboard Toggle word wrap

   [root@server ~]# insights-client --group=<name-you-choose>

2. Optional. To add additional tags, edit the /etc/insights-client/tags.yaml file.
3. Navigate to Inventory > Systems and log in if necessary.
4. Click the Filter by tags drop-down menu. You can also use the search box to enter all or part of the tag’s name to automatically show systems with that text in the tags.
5. Scroll up or down the list to locate the tag.
6. Click the tag to filter by it.

7. Verify that your system is among the results on the advisor systems list.

   1. Navigate to Inventory > Systems and log in if necessary.
   2. Activate the Name filter and begin typing the system name until you see your system, then select it.
   3. The tag symbol is a darker color, and the number beside it shows the correct number of tags applied.

Procedure

1. Open the tag configuration file, tags.yaml, in an editor.

   Copy to Clipboard Toggle word wrap

   [root@server ~]# vim /etc/insights-client/tags.yaml

2. Edit the file contents or add additional key=value pairs. Add additional key=value pairs if needed. Use a mix of capitalization, letters, numbers, symbols, and whitespace. The following example shows how to organize tags.yaml when adding more than one tag to a system.

   Copy to Clipboard Toggle word wrap

   # tags
   ---
   group: _group-name-value_
   location: _location-name-value_
   description:
   - RHEL8
   - SAP
   key 4: value

3. Save your changes and close the editor.

4. Generate an upload to Insights for Red Hat Enterprise Linux.

   Copy to Clipboard Toggle word wrap

   [root@server ~]# insights-client

5. Navigate to Inventory > Systems and log in if necessary.

6. In the Filter Results box, click the down arrow and select one of the filters or enter the name of the filter and select it.

   Note

   You can search by the tag key or by its value.

7. Find your system among the results.
8. Verify that the filter icon is darkened and shows a number representing the number of filters applied to the system.

Procedure

1. Using the command line, and your preferred editor, open /etc/insights-client/tags.yaml. (The following example uses Vim.)

   Copy to Clipboard Toggle word wrap

   [root@server ~]# vi /etc/insights-client/tags.yaml

2. Edit the /etc/insights-client/tags.yaml file to add the predefined key=value pair for the tags. This example shows how to add security: strict and network_performance: latency tags.

   Copy to Clipboard Toggle word wrap

   # cat /etc/insights-client/tags.yaml
   group: redhat
   location: Brisbane/Australia
   description:
   - RHEL8
   - SAP
   security: strict
   network_performance: latency

3. Save your changes.
4. Close the editor.

5. Optional: Run the insights-client command to generate an upload to Red Hat Insights for Red Hat Enterprise Linux, or wait until the next scheduled Red Hat Insights upload.

   Copy to Clipboard Toggle word wrap

   [root@server ~]# insights-client

Procedure

1. Enter the insights-client command with the --version option to verify the client version.

   Copy to Clipboard Toggle word wrap

   [root@insights]# insights-client --version
   Client: 3.0.6-0
   Core: 3.0.121-1

2. Enter the insights-client command with the --disable-schedule option to disable the client schedule.

   Copy to Clipboard Toggle word wrap

   [root@insights]# insights-client --disable-schedule

Procedure

1. To verify the client version, enter the insights-client command with the --version option.

   Copy to Clipboard Toggle word wrap

   [root@insights]# insights-client --version
   Client: 3.0.6-0
   Core: 3.0.121-1

2. Enter the insights-client command with the --enable-schedule option to enable the client schedule.

   Copy to Clipboard Toggle word wrap

   [root@insights]# insights-client --enable-schedule

Procedure

1. To edit the settings in the insights-client.timer file, enter the systemctl edit command and the file name.

   Copy to Clipboard Toggle word wrap

   [root@insights]# systemctl edit insights-client.timer

   This action opens an empty file with the default system editor.

2. Enter different settings to modify the schedule. The values in this example are the default settings for systemd.

   Copy to Clipboard Toggle word wrap

   [Timer]
   OnCalendar=daily
   RandomizedDelaySec=14400

3. Enable the insights-client schedule.

   Copy to Clipboard Toggle word wrap

   [root@insights]# insights-client --enable-schedule