Menu Close
Settings Close

Language and Page Formatting Options

Chapter 1. Client Configuration Guide for Red Hat Insights

The Insights for RHEL client runs on your RHEL system and gathers management data that is uploaded to Red Hat Insights for Red Hat Enterprise Linux and the suite of management applications available on Red Hat Hybrid Cloud Console. You control each instance of the Insights for RHEL client through configuration commands and settings.

1.1. Insights client configuration overview

With the insights-client command and associated configuration files, you can control how your system interacts with Red Hat Insights for Red Hat Enterprise Linux.

  • General information and overviews of the Insights client features are covered in the first few chapters.
  • How-to information on using the Insights client commands and configuration files to accomplish specific tasks follows the overview information.
  • Command reference and configuration file reference information is at the end of this guide.

Navigation links help you quickly find what you are looking for.

1.2. Client configuration overview

The Insights client collects information about your system and sends it to Red Hat Insights for Red Hat Enterprise Linux, which is a cloud application. Command options for the CLI and configuration file options modify the information that is collected and shared with Red Hat Insights for Red Hat Enterprise Linux. These options control the following:

  • Data obfuscation

    • IP address obfuscation

      Note

      IP address obfuscation is supported only for IPv4 addresses.

    • Host name obfuscation
  • Data redaction

    • Specific files
    • Output of specific commands
    • Pattern-match deletions
    • Keyword replacement
  • Insights client scheduling
  • Insights for RHEL rule updates
  • Insights client authentication method

    • Certificate-based
    • SSO-based, or Basic
  • System tagging

The information collected by the Insights client is saved in a tar file, that file is referred to as an archive file.

Note

The Red Hat Insights for Red Hat Enterprise Linux compliance service uses OpenSCAP tools to generate compliance reports based on information from the host system. The collaboration with OpenSCAP prevents the compliance service’s ability to completely obfuscate or redact host name and IP address data. Also, host information is sent to Insights for RHEL when a compliance data collection job launches on the host system. Red Hat Insights for Red Hat Enterprise Linux is working to improve obfuscation options for host information.

For information about how Red Hat Insights for Red Hat Enterprise Linux handles data collection, see Red Hat Insights Data & Application Security.

1.3. Insights client CLI and configuration file interactions

The Insights client runs according to its scheduler, which by default is every 24 hours. The client also runs when you enter the insights-client command.

When the client runs, its behavior is controlled, in order, by the following:

  1. The values, if any, provided when you enter the insights-client command. Values entered in the CLI override configuration file settings and system environment settings for that execution of the Insights client.
  2. The settings in the configuration files (/etc/insights-client/insights-client.conf and /etc/insights-client/remove.conf) override system environment settings.
  3. The values of any system environment variables (printenv) not affected by the CLI or the client configuration files are used.

Any options you provide in the insights-client command are used only for that execution. Those values can temporarily override values set in the configuration file or the environment variables.

Note

Using the insights-client command to set the display name takes effect immediately but does not run the Insights client.

Note

If you are using RHEL 6.9 or earlier, the client command is redhat-access-insights.

1.4. Red Hat Insights client distribution

Insights client is available on Red Hat Enterprise Linux (RHEL) as shown in the following table.

RHEL releaseComments

RHEL 8

Distributed with Insights client pre-installed, unless RHEL 8 was installed as a minimal installation.

RHEL 7

Distributed with the Insights client RPM package loaded but not installed.

RHEL 6.10 and later

You must download the Insights client RPM package and install it.

Note

Insights client installation on older versions

RHEL versions 6 and 7 do not come with the Insights client pre-installed. If you have one of these versions, run the following commands in your terminal:

[root@server ~]# yum install insights-client

Then, register the system to Red Hat Insights for Red Hat Enterprise Linux:

[root@server ~]# insights-client --register
Note

Minimal Installation Configuration

The Insights client is not automatically installed on systems running the minimal installation of RHEL 8.

To create a minimal installation with the Insights client, select Minimal Installation from the RHEL Software Selection options in the Anaconda installer. Make sure to select the Standard checkbox in the Additional Software for Selected Environment section. The Standard option includes the insights-client package in the RHEL installation.

If you do not select the Standard checkbox, RHEL installs without the insights-client package. If that happens, you can use dnf install to install the Insights client at a later time.

For more information about minimal installations, see Configuring software selection in Performing a standard RHEL installation.