Bug 1455737 - Add a section describing host status types
Summary: Add a section describing host status types
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Docs Host Configuration Guide
Version: 6.2.9
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: Unspecified
Assignee: Sergei Petrosian
QA Contact: Russell Dickenson
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-05-26 00:51 UTC by Andrew Dahms
Modified: 2019-09-26 16:14 UTC (History)
0 users

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-06-12 09:51:10 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
Host status type icons (22.41 KB, image/png)
2017-05-26 00:51 UTC, Andrew Dahms
no flags Details
Host status type icons (22.59 KB, image/png)
2017-05-26 01:08 UTC, Andrew Dahms
no flags Details

Description Andrew Dahms 2017-05-26 00:51:44 UTC
Created attachment 1282444 [details]
Host status type icons

A new section must be added to the 'Configuring Hosts' chapter after the 'Browsing Hosts' section that outlines the different host status types and what they mean.

Comment 1 Andrew Dahms 2017-05-26 00:56:50 UTC
There are three main status types -

* Error
  An error has been detected on the host. Click the host to see a more granular
  report of issues. For example, when a host is in error status, the 
  'Configuration', 'Compliance', and 'Subscription' fields appear, and show
  the status of each element.

* Warning
  The host has been configured, but no reports have been collected for that
  host during the last reporting interval.

* Ok
  There are no pending actions on the host, no pending changes, and no errors
  over the last reporting interval.

See the following section of the OSP documentation for some more details of the 'Error' and 'OK' status types, and a basic introduction -

https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux_OpenStack_Platform/5/html-single/Installer_and_Foreman_Guide/index.html#Host_Status_Types

Comment 2 Andrew Dahms 2017-05-26 00:57:17 UTC
Code snippet reference -

      if error?
        # error
        return HostStatus::Global::ERROR
      elsif out_of_sync?
        # out of sync
        return HostStatus::Global::WARN
      elsif no_reports? && (host.configuration? || Setting[:always_show_configuration_status])
        # no reports and configuration is set
        return HostStatus::Global::WARN
      else
        # active, pending, no changes, no reports (or host not setup for configuration)
        return HostStatus::Global::OK
      end

Comment 3 Andrew Dahms 2017-05-26 00:59:16 UTC
Assigning to Sergei for review.

Sergei - another piece in the puzzle for hosts. :)

We can take most of the details from the above, and it would be good to have a table with the icon in the first column, the status type in the second column, and a description of the status type in the third column.

Comment 4 Andrew Dahms 2017-05-26 01:08:11 UTC
Created attachment 1282445 [details]
Host status type icons

Comment 7 Sergei Petrosian 2017-05-29 10:27:36 UTC
These changes are now live on the Custom Portal.
Thank you

Comment 11 Sergei Petrosian 2017-06-12 09:51:10 UTC
Hello,

these changes are now live on the Custom Portal.

Thank you


Note You need to log in before you can comment on or make changes to this bug.