Automating your Red Hat Enterprise Linux pre-upgrade report workflow

Updated

This article describes how to use tools provided by Red Hat to create custom scripts for the Leapp pre-upgrade report during the in-place upgrade from Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8.

Using Red Hat tools with custom scripts

During an in-place upgrade from RHEL 7 to RHEL 8, you must run the Leapp preupgrade command to assess whether your system is ready for the upgrade process. The Leapp utility generates the Leapp pre-upgrade report, which summarizes potential problems and proposes recommended solutions. For more information, see Reviewing the pre-upgrade report.

You can create custom scripts to automate the process of analyzing the pre-upgrade report and to add custom report tools not supported by Red Hat. For example, you can use custom scripts to apply custom filters to the report, merge the results from multiple systems, or compare results from different reports across multiple testing and production environments.

IMPORTANT:
Red Hat does not support custom scripts for pre-upgrade report processing.

You can create custom scripts using the following resources for guidance:

  • Use the Leapp pre-upgrade report ID to apply custom scripts to a specific report. Each Leapp pre-upgrade report ID is stable and unique. The report ID is located in the key field of the /var/log/leapp/leapp-report.json file, which is generated after you have run the Leapp preupgrade command.

  • Use the Leapp pre-upgrade report JSON schema as a reference guide to create and apply custom scripts. The JSON schema updates infrequently, so custom scripts built using the JSON schema as reference are unlikely to break. Major changes to the schema are announced one release in advance. The JSON schema is located in the /usr/share/leapp/report_schema/report-schema.json file, which is installed with the Leapp utility, and in the Content from raw.githubusercontent.com is not included.Leapp GitHub repository.

Additional Information

Article Type