Troubleshooting Red Hat Discovery

Subscription Central 1-latest

Troubleshooting Red Hat Discovery

Red Hat Customer Content Services

Abstract

When troubleshooting Red Hat Discovery, you can determine the version of your installation, uninstall the server, get help with command-line interface commands, configure SSH credentials, locate log files, back up and restore the server encryption key, and restart the server after a system reboot.

Preface

Use this guide to diagnose and resolve common issues with Red Hat Discovery.

Chapter 1. Track your product data with Red Hat Discovery

Red Hat Discovery is designed to help users collect data about their usage of specific Red Hat software. By using Discovery, users can reduce the amount of time and effort that is required to calculate and report usage of those Red Hat products.

1.1. What is Red Hat Discovery

Red Hat Discovery is an agentless inspection and reporting tool that identifies physical and virtual systems on a network, their operating systems, configuration data, and installed Red Hat products. Use these findings to understand and manage your subscription usage and IT inventory.

The ability to inspect the software and systems that are running on your network improves your ability to understand and report on your subscription usage. Ultimately, this inspection and reporting process is part of the larger system administration task of managing your inventories.

Red Hat Discovery requires the configuration of two basic structures to access IT resources and run the inspection process. A credential contains user access data, such as the username and password or Secure Shell (SSH) key. It provides sufficient authority to run the inspection process on a particular source. A source contains data about a single asset or multiple assets that are to be inspected.

These assets can be physical machines, virtual machines, or containers, identified as hostnames, IP addresses, IP ranges, or subnets. These assets can also be a systems management solution such as vCenter Server or Red Hat Satellite Server, or can be clusters deployed on Red Hat OpenShift Container Platform.

Note

Currently, the only virtualized deployment that Discovery can scan with a specialized source for virtualization infrastructure is VMware vCenter. No other virtualization infrastructure that is supported by Red Hat can be scanned with a specialized scan. General scans of your network might still find these assets, without the precise metadata returned by a specialized scan.

You can save multiple credentials and sources to use with Discovery in various combinations as you run inspection processes, or scans. When you have completed a scan, you can access these facts in the output as a collection of formatted data, or report, to review the results.

By default, the credentials and sources that are created during the use of Red Hat Discovery are encrypted in a database. The values are encrypted with AES-256 encryption. They are decrypted when the Red Hat Discovery server runs a scan with the use of a vault password to access the encrypted values that are stored in the database.

Red Hat Discovery is an agentless inspection tool, so there is no need to install the tool on every source that is to be inspected. However, the system that Discovery is installed on must have access to the systems to be discovered and inspected.

1.2. Products that Red Hat Discovery finds

Red Hat Discovery detects specific Red Hat products. For each version or release, the earliest supported version is listed, with later releases indicated as applicable.

If a product has changed names recently so that you might be more familiar with the current name for that product, that name is provided as additional information. No later version is implied by the inclusion of a newer product name unless specific versions of that product are also listed.

Red Hat Enterprise Linux

Red Hat Enterprise Linux version 6 and later
Red Hat Enterprise Linux version 7 and later
Red Hat Enterprise Linux version 8 and later
Red Hat Enterprise Linux version 9 and later
Red Hat Enterprise Linux version 10 and later

Red Hat Application Services products (formerly Red Hat Middleware)

JBoss Enterprise Web Server version 1 and later; Red Hat JBoss Web Server 3.0.1 and later
Red Hat JBoss Enterprise Application Platform version 4.2 and later, version 4.3 and later, version 5 and later, version 6 and later, version 7 and later
Red Hat Fuse version 6.0 and later

Red Hat Ansible Automation Platform

Ansible Automation Platform version 2 and later

Red Hat OpenShift Container Platform

Red Hat OpenShift Container Platform version 4 and later

Red Hat Advanced Cluster Security for Kubernetes

Red Hat Advanced Cluster Security for Kubernetes version 4 and later

Red Hat Advanced Cluster Management for Kubernetes

Red Hat Advanced Cluster Management for Kubernetes version 2 and later

1.3. Red Hat Discovery suitability and support

Red Hat Discovery helps you discover your Red Hat product inventory across complex networks. Work with a Red Hat Solution Architect (SA) or Technical Account Manager (TAM) to interpret the generated reports.

You can also work with the Subscription Education and Awareness Program (SEAP) for analysis and assistance.

Although you can install and use Discovery independently and then generate and view report data, the Discovery documentation does not provide any information to help you interpret report results. Red Hat Support can provide some basic assistance related to installation and usage of Discovery. However, the support team does not provide any assistance to help you understand the reports.

The Discovery tool does not automatically share data directly with Red Hat. Instead, you choose whether to prepare and send report data to Red Hat for ingestion by Red Hat tools and services. You can use the Discovery tool locally to scan your network for the Red Hat products that Discovery currently supports and then use the generated reports for your own internal purposes.

Chapter 2. Analyze Red Hat Discovery system behavior and diagnose errors

Determine your Red Hat Discovery version, uninstall the server, get help with command-line interface commands, and configure Secure Shell (SSH) credentials. You can also locate log files, back up and restore encryption keys, and restart the server after a reboot.

2.1. Determine the version of the Red Hat Discovery server

Determine the version of the Red Hat Discovery server by using the command line interface to help with troubleshooting and support requests.

Prerequisites

You are logged in to the command line interface as the Discovery server administrator.

Procedure

To determine the version of the Discovery server, use the following steps:
- Enter the dsc server status command. The expected output provides the version of the server that you are using:
```
"server_address": "127.0.0.1:9443", "server_id":
"45a8ea20-2ec4-4113-b459-234fed505b0d", "server_version": "1.0.0.3e15fa8786a974c9eafe6376ff31ae0211972c36"
```
  If you cannot get the server status command to run, or you cannot log in to the server, use the following Podman images command:
```
podman images --filter 'reference=registry.redhat.io/discovery/discovery-server-rhel9' --format '{{.Labels.url}}'
```

2.2. Uninstall Red Hat Discovery

If you no longer need Discovery, you can uninstall the server and its associated packages from your system.

Prerequisites

You are logged in to the system that is running Red Hat Discovery.
You have sudo access to perform certain functions in dnf.

Procedure

To uninstall Red Hat Discovery server, use the following steps:
Run the uninstall command.
```
discoveryctl uninstall
```
Uninstall the discoveryctl package.
```
sudo dnf remove discoveryctl
```
Optional: Uninstall the command line interface, if installed.
```
sudo dnf remove discovery-cli
```

2.3. Get help with the command line interface

Access Discovery help through the man page and subcommand options to find usage details for the command line interface.

Prerequisites

You are logged in to the command line interface as the Discovery server administrator.

Procedure

For help on general topics, see the man page information.
For help on a specific subcommand, use the -h option. For example:
```
dsc cred -h
dsc source -h
dsc scan -h
```

2.4. Secure Shell (SSH) credential configuration

If you receive an error message that includes text similar to not a valid file on the filesystem, that message might indicate an issue with the mount point. The mount point on the file system enables access to the SSH keyfiles.

2.5. Log file locations

Log files for the Discovery server are stored in specific directories that vary by component, helping you diagnose server and scanning issues.

Table 2.1. Log file locations

Location	Description
`"${HOME}"/.local/share/discovery/log`	Log files on the local file system.
`podman logs discovery-server`	Log data copied to `stdout`, accessible through Podman logs.
`podman logs discovery-celery-worker`	Log data for the Celery worker process.

To follow the log output, include the -f option:

podman logs -f discovery-server
podman logs -f discovery-celery-worker

2.6. Back up or restore the server encryption key

Passwords are not stored as plain text. They are encrypted and decrypted by using the content of the secret.txt file as a secret key. If you need to back up and restore the secret.txt file, use these steps.

Prerequisites

You are logged in to the system that is running Red Hat Discovery.
You have sudo access to perform certain functions in dnf.

Procedure

To back up the encrypted SSH credentials, navigate to "${HOME}"/.local/share/discovery/data directory and copy the secret.txt file.
To restore the secret.txt file, enter the following command, where path_to_backup is the path where the secret.txt file is backed up:
```
cp -p __path_to_backup__/secret.txt "${HOME}"/.local/share/discovery/data/
```

2.7. Restart the Red Hat Discovery server after a reboot

If Discovery does not automatically restart after a system reboot, manually restart it by using the systemctl command.

Prerequisites

You are logged in to the system that is running Red Hat Discovery.
You have sudo access to perform certain functions in dnf.

Procedure

To restart the Discovery application after a reboot, use the following command:
```
systemctl --user restart discovery-app
```

Legal Notice

Except as otherwise noted below, the text of and illustrations in this documentation are licensed by Red Hat under the Creative Commons Attribution–Share Alike 3.0 Unported license . If you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, the Red Hat logo, JBoss, Hibernate, and RHCE are trademarks or registered trademarks of Red Hat, LLC. or its subsidiaries in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

XFS is a trademark or registered trademark of Hewlett Packard Enterprise Development LP or its subsidiaries in the United States and other countries.

The OpenStack® Word Mark and OpenStack logo are trademarks or registered trademarks of the Linux Foundation, used under license.

All other trademarks are the property of their respective owners.