Search

Assessing and remediating system issues using Red Hat Insights Tasks with FedRAMP

download PDF
Red Hat Insights 1-latest

Use predefined Insights Tasks playbooks to resolve issues on your systems

Red Hat Customer Content Services

Abstract

Red Hat Insights Tasks helps you assess and remediate system issues by using predefined playbooks called Tasks with FedRAMP®.
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright's message.

Chapter 1. Overview of Insights for Red Hat Enterprise Linux tasks

Tasks is part of the Automation Toolkit for Insights for Red Hat Enterprise Linux. Tasks offer predefined playbooks that help you maintain the health of your infrastructure by simplifying and solving complex problems using automated tasks. Tasks solve specific problems and are typically executed one time on your systems to accomplish things such as, detecting a high-profile vulnerability on your systems or preparing systems for a major upgrade. You can find tasks in Red Hat Hybrid Cloud Console > Red Hat Insights > RHEL > Automation Toolkit > Tasks.

Insights for Red Hat Enterprise Linux anticipates your need to solve problems and get things done in your infrastructure, and continuously adds specific tasks to the Automation Toolkit. Tasks include the following:

  • RHEL pre-upgrade analysis utility task
  • Pre-conversion analysis utility task
  • Convert to RHEL from CentOS Linux 7

Some important information you will need to get started with executing a task are:

Note

System requirements to execute different tasks might vary.

1.1. User Access settings in the Red Hat Hybrid Cloud Console

User Access is the Red Hat implementation of role-based access control (RBAC). Your Organization Administrator uses User Access to configure what users can see and do on the Red Hat Hybrid Cloud Console (the console):

  • Control user access by organizing roles instead of assigning permissions individually to users.
  • Create groups that include roles and their corresponding permissions.
  • Assign users to these groups, allowing them to inherit the permissions associated with their group’s roles.

All users on your account have access to most of the data in Insights for Red Hat Enterprise Linux.

1.1.1. Predefined User Access groups and roles

To make groups and roles easier to manage, Red Hat provides two predefined groups and a set of predefined roles.

1.1.1.1. Predefined groups

The Default access group contains all users in your organization. Many predefined roles are assigned to this group. It is automatically updated by Red Hat.

Note

If the Organization Administrator makes changes to the Default access group its name changes to Custom default access group and it is no longer updated by Red Hat.

The Default admin access group contains only users who have Organization Administrator permissions. This group is automatically maintained and users and roles in this group cannot be changed.

On the Hybrid Cloud Console navigate to Red Hat Hybrid Cloud Console > the Settings icon (⚙) > Identity & Access Management > User Access > Groups to see the current groups in your account. This view is limited to the Organization Administrator.

1.1.1.2. Predefined roles assigned to groups

The Default access group contains many of the predefined roles. Because all users in your organization are members of the Default access group, they inherit all permissions assigned to that group.

The Default admin access group includes many (but not all) predefined roles that provide update and delete permissions. The roles in this group usually include administrator in their name.

On the Hybrid Cloud Console navigate to Red Hat Hybrid Cloud Console > the Settings icon (⚙) > Identity & Access Management > User Access > Roles to see the current roles in your account. You can see how many groups each role is assigned to. This view is limited to the Organization Administrator.

See User Access Configuration Guide for Role-based Access Control (RBAC) for additional information.

1.1.2. Access permissions

The Prerequisites for each procedure list which predefined role provides the permissions you must have. As a user, you can navigate to Red Hat Hybrid Cloud Console > the Settings icon (⚙) > My User Access to view the roles and application permissions currently inherited by you.

If you try to access Insights for Red Hat Enterprise Linux features and see a message that you do not have permission to perform this action, you must obtain additional permissions. The Organization Administrator or the User Access administrator for your organization configures those permissions.

Use the Red Hat Hybrid Cloud Console Virtual Assistant to ask "Contact my Organization Administrator". The assistant sends an email to the Organization Administrator on your behalf.

1.1.3. User Access roles for Insights Tasks users

The following role enables enhanced access to remediations features in Insights for Red Hat Enterprise Linux:

  • Tasks administrator. The Tasks administrator role permits access to all Tasks capabilities to remotely execute Tasks on Insights-connected systems.
Note

All members of the Default Admin Access group can also execute Tasks.

A Tasks viewer role does not exist.

Chapter 2. Registering and connecting systems to Red Hat Insights to execute tasks

To work with Red Hat Insights, you need to register systems to Insights, and enable system communication with Insights. In addition to communicating with Insights, you need to enable and install dependencies on Satellite 6.11+, Remote Host Configuration (rhc), rhc-worker-playbook and ansible, so that you can use task services, and other services in the Automation Toolkit.

For more information about enabling system communication with Insights, and addressing dependencies, see:

Chapter 3. Executing tasks using Red Hat Insights

You can execute tasks on remote systems in the Red Hat Hybrid Cloud Console directly from Red Hat Insights Tasks.

Tasks you can execute are:

  • RHEL pre-upgrade analysis utility tasks.
  • Pre-conversion analysis utility tasks.
  • Convert to RHEL from CentOS Linux 7.
Note

Prerequisites and actions required to execute specific Insights tasks will vary.

Here are general instructions to execute a task.

Prerequisites

Procedure

  1. Navigate to Automation Toolkit > Tasks.
  2. Select a task to execute and click Run Task.
  3. Optional: Edit the default task name to customize it for your needs.

    Note

    After you execute the task, you will not be able to change the task name again.

  4. Make note of any task-specific prerequisites shown in the brief description of the task.
  5. Select the systems on which to execute the task. You can use filters to search and filter systems by:

    • Name
    • Operating System
    • Tag

      list of systems to select for the task

  6. Click Execute task. The task executes on the selected systems. You might see a pop-up that shows that your task is running.

    pop-up alert that show the task is running and includes a link to View Progress

  7. Click View Progress to view the task details page which shows how the task is executing on each of your selected systems.

    display of details about the systems on which the tasks are executing

  8. Review Status and Message details.
  9. If shown, click the Show more icon beside the system name to find more information about messages.
  10. Click Tasks to go to the task detail view to see more information about how the task executed on the selected systems.
  11. Click the Activity tab to see the status of all the task you have executed. Tasks are in chronological order, by the most recent date and time.

    Note

    A Completed status indicates that the task executed, but does not indicate that the task accomplished its goal.

    view status updates and messages about task results for individual systems

  12. Optional: Click the task you executed to return to the task detail view to see more information about how the task executed on the selected systems.

Next Steps

You might need to resolve errors, such as an error that occurs because you need to install a software package on your systems before a task can successfully execute. After you resolve those errors, you can execute the task again on the same systems.

Optional: To execute a task again, click Run Task again. The previously selected systems are still selected, and you can also add additional systems, if needed.

Chapter 4. Using Insights tasks to help you convert from CentOS Linux 7 to RHEL 7

You can use Red Hat Insights to help you convert from CentOS Linux 7 to RHEL 7.

For more information about using Insights tasks to help convert your systems, see Converting using Insights in the Converting from an RPM-based Linux distribution to RHEL documentation.

Troubleshooting conversion-related Insights tasks

Tasks help you update, manage, or secure your Red Hat Enterprise Linux infrastructure using Insights. Each task is a predefined playbook that executes a task from start to finish. If you have trouble completing some Insights conversion-related tasks, see:

Chapter 5. Assessing system-upgrade readiness with the pre-upgrade analysis task

This task is a component of the in-place upgrade capability for Red Hat Enterprise Linux using the Leapp tool. For more information about the Leapp tool and using it to check upgrade readiness manually, see Upgrading from RHEL 8 to RHEL 9, Instructions for an in-place upgrade from Red Hat Enterprise Linux 8 to Red Hat Enterprise Linux 9.

The pre-upgrade analysis task checks the readiness of systems to upgrade from Red Hat Enterprise Linux (RHEL) 8 to RHEL 9. If Insights detects upgrade-blocking issues, you can see more information about the issues, including steps to resolve them, in Insights for Red Hat Enterprise Linux on the Red Hat Hybrid Cloud Console (Console).

The pre-upgrade analysis task can run on any RHEL 8 system that is connected to Red Hat Insights using the remote host configuration (rhc) solution. You can verify that your system is connected to Insights by locating it in the Insights system inventory on the Console. If the system is not in the inventory, see Remote Host Configuration and Management documentation for information about connecting systems to Insights.

You can also run the Leapp utility manually on systems. When an Insights-connected system has a Leapp report in its archive, whether the utility was run manually or as an Insights task, you can see results from the report in Insights.

5.1. Requirements and prerequisites

The following requirements and prerequisites apply to the pre-upgrade analysis task:

  • This guide assumes that you have read and understood the in-place upgrade documentation before attempting to perform any upgrade-related action using Red Hat Insights.
  • Your systems must be eligible for in-place upgrade. See in-place upgrade documentation for system requirements and limitations.
  • Your RHEL system must be connected to Red Hat Insights using the remote host configuration solution in order to execute Insights tasks and other remediation playbooks from the Insights for Red Hat Enterprise Linux UI.

  • You are logged into the console.redhat.com with Tasks administrator privileges granted in User Access.

    Note

    All members of the Default admin access group have Tasks administrator access. If you are not a member of a User Access group with this role, you will not see any tasks on the Tasks page. For more information about User Access, including how to request greater access to Insights features, see User Access Configuration Guide for Role-based Access Control (RBAC).

5.2. Running the pre-upgrade analysis task

Use the following procedure to analyze the readiness of RHEL systems for upgrading from RHEL 8 to RHEL 9.

Prerequisites

  • Prerequisites are listed in the Requirements and prerequisites section of this chapter.

Procedure

  1. Go to the Red Hat Hybrid Cloud Console > Red Hat Insights > RHEL > Automation Toolkit > Tasks.
  2. Locate the Pre-upgrade analysis for in-place upgrade from RHEL 8 task.

    Note

    If you can not see any tasks on the page, you might not have adequate User Access. See User Access Configuration Guide for Role-based Access Control (RBAC) for more information.

  3. Optional: You can view details of the pre-upgrade analysis utility by clicking Download preview of playbook.
  4. Click Run task.
  5. On the Pre-upgrade analysis for in-place upgrade from RHEL 8 popup, select systems on which to run the pre-upgrade analysis by checking the box next to each system.

    Note

    By default, the list of systems is filtered to only display systems that are eligible to run the task. You can change or add filters to expand the parameters of included systems from your inventory.

  6. Click Execute task to run the task on the selected systems.

Verification

Use the following procedure to verify that a task has been executed successfully.

  1. Go to the Red Hat Hybrid Cloud Console > Red Hat Insights > RHEL > Automation Toolkit > Tasks page and click the Activity tab. The status of tasks, whether they are in progress or have been completed, can be viewed here.
  2. Locate your task based on the run date and time. You can see whether the task completed or failed.

    View the status of tasks

5.3. Reviewing the pre-upgrade analysis task report

After executing the pre-upgrade analysis task on systems, you can review specific details and upgrade-inhibiting recommendations for each system.

Prerequisites

  • Prerequisites are listed in the Requirements and prerequisites section of this chapter.

Procedure

  1. Go to the Red Hat Hybrid Cloud Console > Red Hat Insights > RHEL > Automation Toolkit > Tasks and click the Activity tab.
  2. Click on the task name to view the results of a task. Note the run date and time so that you select the correct report.
  3. Click on the carat next to the system name to view a list of alerts for that system.

    Upgrade-inhibiting issues shown in the task report

  4. View information about upgrade-inhibiting alerts by clicking on the carat next to an alert with a white exclamation mark inside of a red dot, accompanying red alert text.

    Note

    In addition to the inhibitor alerts, you might also see lower severity and informative alerts that do not require remediation in order for the upgrade to proceed.

  5. Review the report thoroughly. While some recommendations may be informational, it is crucial to take action if you encounter any errors or warnings. In the event of such issues, address them on your systems and re-run the pre-upgrade task to assess the impact of your remediation efforts.

    Note

    Certain errors are classified as official inhibitors, and proceeding with the upgrade is not possible until these are remediated.

5.4. Viewing upgrade-inhibiting recommendations

After running the pre-upgrade analysis task, or manually running the Leapp tool on individual systems, you can view a list of recommendations for upgrade-inhibiting issues in your infrastructure.

Using the list of pre-upgrade recommendations, you can view the following information about each recommendation:

  • Recommendation details
  • Affected-system information
  • Total risk and impact insights
  • Risk to system availability during resolution actions

Prerequisites

  • Any user with default access (the default for every user) can view the list of in-place upgrade recommendations.

Procedure

  1. Go to Red Hat Insights > Operations > Advisor > Topics > In-place upgrade to view recommendations affecting the success of in-place upgrades.

    Note

    Currently, the in-place upgrade recommendations list only shows recommendations that Insights has identified as upgrade inhibitors. All in-place upgrade recommendations, including non-inhibitors, can be seen in the detailed view of each executed task.

5.5. Remediating upgrade-inhibiting recommendations

You can use the in-place upgrade recommendations list as a basis for remediating upgrade-inhibiting issues on systems in your infrastructure.

Some recommendations have a playbook available for automating the execution of remediations directly from the Insights for Red Hat Enterprise Linux UI. However, some recommendations require manual resolutions, the steps of which are customized for the system and recommendation pair, and are provided with the recommendation. You can tell which recommendations have playbooks available by viewing the Remediation column in the list of recommendations.

For more information about Insights remediations, see the Red Hat Insights Remediations Guide.

5.5.1. Using Insights remediation playbooks to resolve RHEL upgrade-inhibiting recommendations

You can automate the remediation of upgrade-inhibiting recommendations using Ansible Playbooks that you create in Insights. Use the following procedure to locate your inhibitor issues and select recommendations and systems to remediate.

Prerequisites

  • Prerequisites are listed in the Requirements and prerequisites section of this chapter.

Procedure

  1. Go to Red Hat Insights > Operations > Advisor > Topics > In-place upgrade to view recommendations affecting the success of in-place upgrades.
  2. Choose a recommendation with the word "Playbook" in the Remediation tab, which indicates issues that have a playbook available.

    Recommendations list for in-place upgrades

  3. For each recommendation with an available playbook, take the following actions:

    1. Click on the recommendation to see more information about the issue, including the systems that are affected.
    2. Check the box next to each system you want to add to the playbook and click Remediate.

      Select systems then click Remediate.

    3. In the popup, select Create a new playbook and enter a name for the playbook, then click Next.
    4. Optional: Alternatively, you can add the resolution for the selected systems to an existing playbook.
    5. Review the included systems and click Next.
    6. Review the included recommendation. You can click the carat next to the recommendation name to see included systems.

      Important

      Some resolutions require the system to reboot. Auto reboot is not enabled by default but you can enable it by clicking Turn on autoreboot above the list of recommendations.

    7. Click Submit. The final popup view confirms that the playbook was created successfully. You can select to return to the application or open the playbook.
  4. Find the playbook in Automation Toolkit > Remediations and click on it to open it.
  5. The playbook includes a list of actions. Select the actions to execute by checking the box next to each one.
  6. Click Execute playbook to run the playbook on the specified systems.
  7. On the popup, click on the Execute playbook on systems button. The playbook runs on those systems.

5.5.2. Remediating RHEL upgrade-inhibiting recommendations manually

You can remediate upgrade-inhibiting recommendations by manually applying resolution steps on affected systems. The following procedure shows how to find the resolution steps for a system and recommendation pairing.

Prerequisites

  • Prerequisites are listed in the Requirements and prerequisites section of this chapter.

Procedure

  1. Go to Red Hat Insights > Operations > Advisor > Topics > In-place upgrade to view recommendations affecting the success of in-place upgrades.
  2. Choose a recommendation with the word "Manual" in the *Remediation tab, which indicates that the issue requires manual remediation.

    Recommendations for in-place upgrades

  3. For each recommendation requiring a manual remediation, take the following actions:

    1. Click on the recommendation to open the recommendation-details page, which shows affected systems.

      An upgrade inhibiting recommendation with affected systems

    2. Click on a system name.
    3. Pick a recommendation to resolve manually and click on the carat to view the Steps to resolve the recommendation on the system.
    4. Perform the resolution steps on the system.
    5. Repeat steps b, c, and d for each affected system.

Chapter 6. Using Insights Tasks to update image-mode RHEL systems

While building systems using image mode for RHEL, you can connect your systems to Red Hat Insights. Once connected, use the Red Hat Insights task, Initiate an update of your image mode RHEL host, to update your Insights-connected systems to the latest versions of RHEL. Red Hat Enterprise Linux Version 9.4 and later includes image mode for RHEL.

Note

Image mode for RHEL uses the terms update and upgrade interchangeably.

6.1. Running the Initiate Update for image mode RHEL for RHEL host task

You can initiate an upgrade for image-mode RHEL systems using Insights tasks. You might run the Initiate Update for image mode for RHEL host task if you have a large number of image-mode RHEL systems to update. Or, you might run the task if you want to avoid updating systems using the automatic upgrades option.

Running the task does the following:

  • Checks the container repository for a new container image.
  • Downloads the image and extracts content for use on next boot.
  • If updated content is available, reboots the host to pull in new image content.
  • Provides results about whether the image was updated.
Note

The image mode for RHEL update is sometimes referred to as a bootc update.

Important

Image mode for RHEL is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.

For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.

Prerequisites

Procedure

  1. Go to Automation Toolkit > Tasks, and log in to the Red Hat Hybrid Cloud Console, if needed. The Available tab (the default view) shows you a list of tasks available for you to run. Click the Activity tab to show the history of all the tasks run on your account.
  2. Find the Initiate Update for image mode for RHEL host task.

    Initiate Update for image mode for RHEL task and details about the task. Option to download a preview of the playbook. Select Systems button.

  3. Click Select systems.
  4. Select the systems on which to run the task. You can use filters to search and filter systems by Name, Operating System, Group, Tags, and Task Eligibility (the default filter shows systems registered via RHC).
Note

The filter does not filter for image mode for RHEL (or bootc) systems. You can filter systems running 9.4 or later to create a better list of systems on which to run the task. If needed, click the system name to find out if there is a system fact with bootc information.

In this example, one system is selected.

Eligible RHEL 9.4 system selected

Important

Completing the next step results in a reboot of your selected systems. In addition, if you need to roll back your systems to the previous state, see Chapter 5. Managing RHEL bootable images Red Hat Enterprise Linux 9 in Using image mode for RHEL to build, deploy, and manage operating systems.

  1. Click Run Task. A pop-up alerts you that the task is running.

    List of all eligible systems with one eligible system selected. The Run Task button is highlighted.

  2. Review the information in the Status and Message fields on the Activity page. For this example, the message is Bootc upgrade complete. Expand for details.

    Message about the completed task that says the Bootc upgrade completed. Instructions to use the dropdown to get additional information. More details about when the task started and completed running.

  3. Click the drop-down arrow next to the system name to get more details about the task. You will see more details about the task results, such as the image hash.

    Partially highlighted image hash that the user can use to confirm the update. Running the task might result in no updates because the system is already up to date.

    Example of results when the bootc upgrade does not make any changes. Message that no changes were made because no update was available.

Troubleshooting

To resolve issues with the task, you can find the answers to some common issues within documentation for other tasks. Red Hat Insights tasks use a common framework of tools, language, and resources within the service, If you have trouble completing this task,

Providing feedback on Red Hat documentation

We appreciate and prioritize your feedback regarding our documentation. Provide as much detail as possible, so that your request can be quickly addressed.

Prerequisites

  • You are logged in to the Red Hat Customer Portal.

Procedure

To provide feedback, perform the following steps:

  1. Click the following link: Create Issue
  2. Describe the issue or enhancement in the Summary text box.
  3. Provide details about the issue or requested enhancement in the Description text box.
  4. Type your name in the Reporter text box.
  5. Click the Create button.

This action creates a documentation ticket and routes it to the appropriate documentation team. Thank you for taking the time to provide feedback.

Legal Notice

Copyright © 2024 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, 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, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.