Merge pull request #75710 from laubai/osdocs-8938-cluster-notifications

OSDOCS-8938: Cluster notifications docs for Managed OpenShift

Author: adellape

_topic_maps/_topic_map_osd.yml

@@ -339,6 +339,9 @@ Name: Cluster administration
 Dir: osd_cluster_admin
 Distros: openshift-dedicated
 Topics:
+- Name: Cluster notifications
+  File: osd-cluster-notifications
+  Distros: openshift-dedicated
 - Name: Configuring private connections
   Dir: osd_private_connections
   Distros: openshift-dedicated

_topic_maps/_topic_map_rosa.yml

@@ -554,6 +554,9 @@ Topics:
 #   File: rosa-cluster-auth
 # - Name: Authorization and RBAC
 #   File: rosa-auth-rbac
+- Name: Cluster notifications
+  File: rosa-cluster-notifications
+  Distros: openshift-rosa
 - Name: Configuring private connections
   Dir: cloud_infrastructure_access
   Distros: openshift-rosa

_topic_maps/_topic_map_rosa_hcp.yml

@@ -541,17 +541,20 @@ Topics:
 #    File: ocm-overview
 #  - Name: Using the OpenShift web console
 #    File: rosa-using-openshift-console
-# ---
-# Name: Cluster administration
-# Dir: rosa_cluster_admin
-# Distros: openshift-rosa-hcp
-# Topics:
+---
+Name: Cluster administration
+Dir: rosa_cluster_admin
+Distros: openshift-rosa-hcp
+Topics:
 #  - Name: Cluster configurations
 #    File: rosa-cluster-config
 #  - Name: Cluster authentication
 #    File: rosa-cluster-auth
 #  - Name: Authorization and RBAC
 #    File: rosa-auth-rbac
+  - Name: Cluster notifications
+    File: rosa-cluster-notifications
+    Distros: openshift-rosa-hcp
 # - Name: Configuring private connections
 #   Dir: cloud_infrastructure_access
 #   Distros: openshift-rosa-hcp

modules/managed-cluster-add-notification-contacts.adoc

@@ -0,0 +1,29 @@
+// Module included in the following assemblies:
+//
+// * rosa_cluster_admin/rosa-cluster-notifications.adoc
+// * osd_cluster_admin/osd-cluster-notifications.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="add-notification-contact_{context}"]
+= Adding notification contacts to your cluster
+
+Notification contacts receive emails when cluster notifications are sent to the cluster.
+By default, only the cluster owner receives cluster notification emails. You can configure other cluster users as additional notification contacts in your cluster support settings.
+
+.Prerequisites
+* Your cluster is deployed and registered to the {hybrid-console}.
+* You are logged in to the {hybrid-console-second}.
+* The intended notification recipient has a user account on your cluster.
+
+.Procedure
+. Navigate to the Clusters page of the {hybrid-console-second}.
+. Click the name of your cluster to go to the cluster details page.
+. Click the **Support** tab.
+. On the **Support** tab, find the **Notification contacts** section.
+. Click **Add notification contact**.
+. In the **Red Hat username or email** field, enter the email address or the user name of the new recipient.
+//. In the type field, select the types of cluster notification to send to this recipient.
+. Click **Add contact**.
+
+.Verification steps
+* The "Notification contact added successfully" message displays.

modules/managed-cluster-configure-notification-types-received.adoc

@@ -0,0 +1,31 @@
+// Module included in the following assemblies:
+//
+// * rosa_cluster_admin/rosa-cluster-notifications.adoc
+// * osd_cluster_admin/osd-cluster-notifications.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="config-notification-types-received_{context}"]
+= Configuring notification types received
+
+Notification contacts receive emails when cluster notifications are sent to the cluster.
+
+By default, a notification contact receives an email for every notification sent to the cluster, regardless of notification type. You can configure the type of notification you want to receive in the {hybrid-console} notification settings for OpenShift.
+
+.Prerequisites
+* Your cluster is deployed and registered to the {hybrid-console-second}.
+* You are logged in to the {hybrid-console-second}.
+
+.Procedure
+. Log in to the {hybrid-console-second}.
+. Click **Settings** -> **Notifications** to open the Notifications overview.
+. Click **Notification Preferences**.
+. On the My Notifications page, under OpenShift, click **Cluster Manager**.
+. Specify the notification types that you want to receive by selecting or clearing the relevant checkbox.
+. Click **Save**.
+
+.Verification steps
+* The "Notification preferences successfully saved" message displays.
+
+// .Additional resources
+// * Cluster notification types
+// * Configuring notifications on Hybrid Cloud Console

modules/managed-cluster-notification-policy.adoc

@@ -0,0 +1,30 @@
+// Module included in the following assemblies:
+//
+// * rosa_cluster_admin/rosa-cluster-notifications.adoc
+// * osd_cluster_admin/osd-cluster-notifications.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="managed-cluster-notification-policy_{context}"]
+= Cluster notification policy
+
+Cluster notifications are designed to keep you informed about the health of your cluster and high impact events that affect it.
+
+Most cluster notifications are generated and sent automatically to ensure that you are immediately informed of problems or important changes to the state of your cluster.
+
+In certain situations, Red Hat Site Reliability Engineering (SRE) creates and sends cluster notifications to provide additional context and guidance for a complex issue.
+
+Cluster notifications are not sent for low-impact events, low-risk security updates, routine operations and maintenance, or minor, transient issues that are quickly resolved by SRE.
+
+Red Hat services automatically send notifications when:
+
+* Remote health monitoring or environment verification checks detect an issue in your cluster, for example, when a worker node has low disk space.
+* Significant cluster life cycle events occur, for example, when scheduled maintenance or upgrades begin, or cluster operations are impacted by an event, but do not require customer intervention.
+* Significant cluster management changes occur, for example, when cluster ownership or administrative control is transferred from one user to another.
+* Your cluster subscription is changed or updated, for example, when Red Hat makes updates to subscription terms or features available to your cluster.
+
+SRE creates and sends notifications when:
+
+* An incident results in a degradation or outage that impacts your cluster's availability or performance, for example, your cloud provider has a regional outage. SRE sends subsequent notifications to inform you of incident resolution progress, and when the incident is resolved.
+* A security vulnerability, security breach, or unusual activity is detected on your cluster.
+* Red Hat detects that changes you have made are creating or may result in cluster instability.
+* Red Hat detects that your workloads are causing performance degradation or instability in your cluster.

modules/managed-cluster-notification-severity-levels.adoc

@@ -0,0 +1,18 @@
+// Module included in the following assemblies:
+//
+// * rosa_cluster_admin/rosa-cluster-notifications.adoc
+// * osd_cluster_admin/osd-cluster-notifications.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="managed-cluster-notification-severity_{context}"]
+= Cluster notification severity levels
+
+Each cluster notification has an associated severity level to help you identify notifications with the greatest impact to your business. You can filter cluster notifications according to these severity levels in the {hybrid-console}, in the **Cluster history** tab for your cluster.
+
+Red Hat uses the following severity levels for cluster notifications, from most to least severe:
+
+Critical:: Immediate action is required. One or more key functions of a service or cluster is not working, or will stop working soon. A critical alert is important enough to page on-call staff and interrupt regular workflows.
+Major:: Immediate action is strongly recommended. One or more key functions of the cluster will soon stop working. A major issue may lead to a critical issue if it is not addressed in a timely manner.
+Warning:: Action is required as soon as possible. One or more key functions of the cluster are not working optimally and may degrade further, but do not pose an immediate danger to the functioning of the cluster.
+Info:: No action necessary. This severity does not describe problems that need to be addressed, only important information about meaningful or important life cycle, service, or cluster events.
+Debug:: No action necessary. Debug notifications provide low-level information about less important lifecycle, service, or cluster events to aid in debugging unexpected behavior.

modules/managed-cluster-notification-types.adoc

@@ -0,0 +1,32 @@
+// Module included in the following assemblies:
+//
+// * rosa_cluster_admin/rosa-cluster-notifications.adoc
+// * osd_cluster_admin/osd-cluster-notifications.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="managed-cluster-notification-types_{context}"]
+= Cluster notification types
+
+Each cluster notification has an associated notification type to help you identify notifications that are relevant to your role and responsibilities. You can filter cluster notifications according to these types in the {hybrid-console}, in the **Cluster history** tab for your cluster.
+
+Red Hat uses the following notification types to indicate notification relevance.
+
+Capacity management:: Notifications for events related to updating, creating, or deleting node pools, machine pools, compute replicas or quotas (load balancer, storage, etc.).
+Cluster access:: Notifications for events related to adding or deleting groups, roles or identity providers, for example, when SRE cannot access your cluster because STS credentials have expired, when there is a configuration problem with your AWS roles, or when you add or remove identity providers.
+Cluster add-ons:: Notifications for events related to add-on management or upgrade maintenance for add-ons, for example, when an add-on is installed, upgraded, or removed, or cannot be installed due to unmet requirements.
+Cluster configuration:: Notifications for cluster tuning events, workload monitoring, and inflight checks.
+Cluster lifecycle:: Notifications for cluster or cluster resource creation, deletion, and registration, or change in cluster or resource status (for example, ready or hibernating).
+Cluster networking:: Notifications related to cluster networking, including HTTP/S proxy, router, and ingress state.
+Cluster ownership:: Notifications related to cluster ownership transfer from one user to another.
+Cluster scaling:: Notifications related to updating, creating, or deleting node pools, machine pools, compute replicas or quota.
+Cluster security:: Events related to cluster security, for example, an increased number of failed access attempts, updates to trust bundles, or software updates with security impact.
+Cluster subscription:: Cluster expiration, trial cluster notifications, or switching from free to paid.
+Cluster updates:: Anything relating to upgrades, such as upgrade maintenance or enablement.
+Customer support:: Updates on support case status.
+General notification:: The default notification type. This is only used for notifications that do not have a more specific category.
+// Omitted, as no definition provided as part of OSDOCS-8938
+// cluster-state-updates
+// clustercreate-details
+// clustercreate-high-level
+// clusterremove-details
+// clusterremove-high-level

modules/managed-cluster-notification-view-in-hcc.adoc

@@ -0,0 +1,29 @@
+// Module included in the following assemblies:
+//
+// * rosa_cluster_admin/rosa-cluster-notifications.adoc
+// * osd_cluster_admin/osd-cluster-notifications.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="managed-cluster-notification-view-hcc_{context}"]
+= Viewing cluster notifications using the {hybrid-console}
+
+Cluster notifications provide important information about the health of your cluster. You can view notifications that have been sent to your cluster in the **Cluster history** tab on the {hybrid-console}.
+
+.Prerequisites
+* You are logged in to the {hybrid-console-second}.
+
+.Procedure
+. Navigate to the link:https://console.redhat.com/openshift[Clusters] page of the {hybrid-console-second}.
+. Click the name of your cluster to go to the cluster details page.
+. Click the **Cluster history** tab.
++
+Cluster notifications appear under the Cluster history heading.
+. Optional: Filter for relevant cluster notifications
++
+Use the filter controls to hide cluster notifications that are not relevant to you, so that you can focus on your area of expertise or on resolving a critical issue. You can filter notifications based on text in the notification description, severity level, notification type, when the notification was received, and which system or person triggered the notification.
+
+// .Additional resources
+// * Cluster notification types
+// * Cluster notification severity levels
+// * Cluster notification emails
+// * Troubleshooting: Cluster notifications

modules/managed-cluster-remove-notification-contacts.adoc

@@ -0,0 +1,27 @@
+// Module included in the following assemblies:
+//
+// * rosa_cluster_admin/rosa-cluster-notifications.adoc
+// * osd_cluster_admin/osd-cluster-notifications.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="remove-notification-contact_{context}"]
+= Removing notification contacts from your cluster
+
+Notification contacts receive emails when cluster notifications are sent to the cluster.
+
+You can remove notification contacts in your cluster support settings to prevent them from receiving notification emails.
+
+.Prerequisites
+* Your cluster is deployed and registered to the {hybrid-console}.
+* You are logged in to the {hybrid-console-second}.
+
+.Procedure
+. Navigate to the Clusters page of the {hybrid-console-second}.
+. Click the name of your cluster to go to the cluster details page.
+. Click the **Support** tab.
+. On the **Support** tab, find the **Notification contacts** section.
+. Click the options menu (**⚙**) beside the recipient you want to remove.
+. Click **Delete**.
+
+.Verification steps
+* The "Notification contact deleted successfully" message displays.