diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml index 435246f77e..ab29a0849b 100644 --- a/_topic_maps/_topic_map_osd.yml +++ b/_topic_maps/_topic_map_osd.yml @@ -93,8 +93,6 @@ Topics: File: creating-a-gcp-cluster - Name: Configuring your identity providers File: config-identity-providers -- Name: Notifications for OpenShift Dedicated clusters - File: notifications --- Name: Cluster administration Dir: osd_cluster_admin @@ -120,6 +118,12 @@ Topics: File: osd-managing-worker-nodes - Name: About autoscaling nodes on a cluster File: osd-nodes-about-autoscaling-nodes +- Name: Logging + Dir: osd_logging + Distros: openshift-dedicated + Topics: + - Name: Accessing the service logs + File: osd-accessing-the-service-logs - Name: Monitoring user-defined projects Dir: osd_monitoring Distros: openshift-dedicated diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index 85edaed535..900f887dbc 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -207,9 +207,11 @@ Topics: Dir: rosa_logging Distros: openshift-rosa Topics: + - Name: Accessing the service logs + File: rosa-accessing-the-service-logs - Name: Installing the CloudWatch logging service File: rosa-install-logging - - Name: Viewing cluster logs + - Name: Viewing cluster logs in the AWS Console File: rosa-viewing-logs - Name: Monitoring user-defined projects Dir: rosa_monitoring diff --git a/modules/adding-cluster-notification-contacts.adoc b/modules/adding-cluster-notification-contacts.adoc new file mode 100644 index 0000000000..976c641a5a --- /dev/null +++ b/modules/adding-cluster-notification-contacts.adoc @@ -0,0 +1,36 @@ +// Module included in the following assemblies: +// +// * osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.adoc +// * rosa_cluster_admin/rosa_logging/rosa-accessing-the-service-logs.adoc + +:_content-type: PROCEDURE +[id="adding-cluster-notification-contacts_{context}"] += Adding cluster notification contacts + +You can add notification contacts for your +ifdef::openshift-dedicated[] +{product-title} +endif::openshift-dedicated[] +ifdef::openshift-rosa[] +{product-title} (ROSA) +endif::openshift-rosa[] +cluster. When an event occurs that triggers a cluster notification email, subscribed users are notified. + +.Procedure + +. Navigate to {cluster-manager-url} and select your cluster. + +. On the *Support* tab, under the *Notification contacts* heading, click *Add notification contact*. + +. Enter the Red Hat username or email of the contact you want to add. ++ +[NOTE] +==== +The username or email address must relate to a user account in the Red Hat organization where the cluster is deployed. +==== + +. Click *Add contact*. + +.Verification + +* You see a confirmation message when you have successfully added the contact. The user appears under the *Notification contacts* heading on the *Support* tab. diff --git a/modules/notification-subscribe.adoc b/modules/notification-subscribe.adoc deleted file mode 100644 index dc590aed3f..0000000000 --- a/modules/notification-subscribe.adoc +++ /dev/null @@ -1,23 +0,0 @@ - -// Module included in the following assemblies: -// -// * assemblies/notifications.adoc - -:_content-type: PROCEDURE -[id="notification-subscribe{context}"] -= Subscribing to notifications - - -You can add notification contacts for your {product-title} cluster. When an event occurs that triggers a cluster notification email, subscribed users are notified. - -.Procedure - -. From {cluster-manager-url}, navigate to the *Clusters* page and select your cluster. - -. On the *Support* tab, under the *Notification contacts* heading, click *Add notification contact*. - -. Enter the Red Hat username or email of the contact you want to add. - -. Click *Add contact*. - -A confirmation message appears when the contact was added successfully, and the user is then listed under the *Notification contacts* heading on the *Support* tab. diff --git a/modules/rosa-planning-considerations.adoc b/modules/rosa-planning-considerations.adoc index de7e4937ff..59d1c839f3 100644 --- a/modules/rosa-planning-considerations.adoc +++ b/modules/rosa-planning-considerations.adoc @@ -71,7 +71,7 @@ The maximum number of compute nodes on ROSA is 180. The SRE team might scale the control plane and infrastructure nodes for additional reasons, for example to manage an increase in resource consumption on the nodes. -When scaling is applied, the customer is notified through a service log entry. +When scaling is applied, the customer is notified through a service log entry. For more information about the service log, see _Accessing the service logs for ROSA clusters_. [id="sizing-considerations-for-larger-clusters_{context}"] == Sizing considerations for larger clusters diff --git a/modules/viewing-notifications.adoc b/modules/viewing-notifications.adoc deleted file mode 100644 index 115cf2b666..0000000000 --- a/modules/viewing-notifications.adoc +++ /dev/null @@ -1,28 +0,0 @@ - -// Module included in the following assemblies: -// -// * assemblies/notifications.adoc - -:_content-type: PROCEDURE -[id="viewing-notifications{context}"] -= Viewing {product-title} cluster notifications - - -Service logs are recorded under the *Cluster history* heading on the *Overview* tab from {cluster-manager-first} and are also available through {cluster-manager} CLI. - -.Procedure - -. From {cluster-manager-url}, navigate to the *Clusters* page and select your cluster. - -. On the *Overview* tab, under *Cluster history*, you can view all cluster events from the service log. - -. Optional: Filter the cluster service logs by *Description* or *Severity* from the drop-down menu. You can filter further by entering a specific item in the search bar. - -. Optional: Click *Download history* to download the cluster history service logs. Select *JSON* or *CSV* for the output file type and then click *Download*. - -. To view service logs from {cluster-manager} CLI, enter the following command: -+ -[source,terminal] ----- -$ ocm get /api/service_logs/v1/cluster_logs --parameter search="cluster_uuid is ''" ----- diff --git a/modules/viewing-the-service-logs-cli.adoc b/modules/viewing-the-service-logs-cli.adoc new file mode 100644 index 0000000000..74286d070e --- /dev/null +++ b/modules/viewing-the-service-logs-cli.adoc @@ -0,0 +1,143 @@ +// Module included in the following assemblies: +// +// * osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.adoc +// * rosa_cluster_admin/rosa_logging/rosa-accessing-the-service-logs.adoc + +:_content-type: PROCEDURE +[id="viewing-the-service-logs-cli_{context}"] += Viewing the service logs by using the CLI + +You can view the service logs for +ifdef::openshift-dedicated[] +{product-title} +endif::openshift-dedicated[] +ifdef::openshift-rosa[] +{product-title} (ROSA) +endif::openshift-rosa[] +clusters by using the {cluster-manager} CLI (`ocm`). + +You can view the logs for a specific cluster or for all available clusters in your Red Hat organization. You can also filter the service logs, for example by severity or by log ID. + +.Prerequisites + +* You have installed an {product-title} cluster. +* You are the cluster owner or you have the cluster editor role. +* You have installed and configured the latest {cluster-manager} CLI (`ocm`) on your installation host. ++ +[NOTE] +==== +You can download the latest version of the {cluster-manager} CLI (`ocm`) on the link:https://console.redhat.com/openshift/downloads[{cluster-manager} downloads] page. +==== + +.Procedure + +. View the service logs for a cluster: +.. List the clusters in your Red Hat organization: ++ +[source,terminal] +---- +$ ocm list clusters +---- ++ +.Example output +[source,terminal] +---- +ID NAME API URL OPENSHIFT_VERSION PRODUCT ID CLOUD_PROVIDER REGION ID STATE +ifdef::openshift-dedicated[] +1t1398ndq653vjf317a32cfjvee771dc mycluster https://api.mycluster.cdrj.p1.openshiftapps.com:6443 4.10.18 osd aws us-east-1 ready +endif::openshift-dedicated[] +ifdef::openshift-rosa[] +1t1398ndq653vjf317a32cfjvee771dc mycluster https://api.mycluster.cdrj.p1.openshiftapps.com:6443 4.10.18 rosa aws us-east-1 ready +endif::openshift-rosa[] +---- ++ +.. Obtain the external cluster ID for your cluster: ++ +[source,terminal] +---- +$ ocm describe cluster <1> +---- +<1> Replace `` with the name of your cluster. ++ +.Example output +[source,terminal] +---- +ID: 1t1298nhq824vjf347q12cpjvee771hc +External ID: f3f1a6c1-2b2b-4a55-854c-fd65e26b737b +... +---- ++ +.. View the service logs for your cluster: ++ +[source,terminal] +---- +$ ocm get /api/service_logs/v1/cluster_logs --parameter search="cluster_uuid = ''" <1> +---- +<1> Replace `` with the external cluster ID that you obtained in the preceding step. ++ +.Example output +[source,terminal] +---- +{ + "kind": "ClusterLogList", + "page": 1, + "size": 1, + "total": 1, + "items": [ + { + "id": "1AyuZCfRwUEwkUEbyKJqjUsdRdj", + "kind": "ClusterLog", + "href": "/api/service_logs/v1/cluster_logs/1AyuZCfRwUEwkUEbyKJqjUsdRdj", + "timestamp": "2022-06-23T14:23:19.078551Z", + "severity": "Info", + "service_name": "AccountManager", + "cluster_uuid": "f3f1a6c1-2b2b-4a55-854c-fd65e26b737b", + "summary": "Cluster registered successfully", + "description": "Cluster installation completed and the cluster registered successfully.", + "event_stream_id": "3ByuXECLcWsfFvVMIOhiH8YCxEk", + "created_by": "service-account-ocm-ams-service", + "created_at": "2022-06-23T14:23:19.10425Z", + "username": "service-account-telemeter-service" + } + ] +} +---- + +. View the service logs for all available clusters in your Red Hat organization: ++ +.Example output +[source,terminal] +---- +$ ocm get /api/service_logs/v1/cluster_logs +---- + +. View the service logs for all available clusters in your Red Hat organization and sort the results by cluster ID: ++ +.Example output +[source,terminal] +---- +$ ocm get /api/service_logs/v1/cluster_logs --parameter orderBy="cluster_uuid" +---- + +. Filter the service logs by severity: ++ +.Example output +[source,terminal] +---- +$ ocm get /api/service_logs/v1/cluster_logs --parameter search="severity = ''" <1> +---- +<1> Replace `` with the severity type. The available values are `Debug`, `Info`, `Warning`, `Error`, and `Fatal`. ++ +[NOTE] +==== +You can include multiple search filters in your parameter specification. For example, you can filter the service logs for a specific cluster by severity by using `--parameter search="cluster_uuid = '' and severity = ''"`. +==== + +. View a specific service log entry by specifying the log ID: ++ +.Example output +[source,terminal] +---- +$ ocm get /api/service_logs/v1/cluster_logs/ <1> +---- +<1> Replace `` with the ID of the log entry. diff --git a/modules/viewing-the-service-logs-ocm.adoc b/modules/viewing-the-service-logs-ocm.adoc new file mode 100644 index 0000000000..d5348e4e8c --- /dev/null +++ b/modules/viewing-the-service-logs-ocm.adoc @@ -0,0 +1,38 @@ +// Module included in the following assemblies: +// +// * osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.adoc +// * rosa_cluster_admin/rosa_logging/rosa-accessing-the-service-logs.adoc + +:_content-type: PROCEDURE +[id="viewing-the-service-logs-ocm_{context}"] += Viewing the service logs by using {cluster-manager} + +You can view the service logs for +ifdef::openshift-dedicated[] +an {product-title} +endif::openshift-dedicated[] +ifdef::openshift-rosa[] +a {product-title} (ROSA) +endif::openshift-rosa[] +cluster by using {cluster-manager-first}. + +.Prerequisites + +* You have installed +ifdef::openshift-dedicated[] +an {product-title} +endif::openshift-dedicated[] +ifdef::openshift-rosa[] +a ROSA +endif::openshift-rosa[] +cluster. + +.Procedure + +. Navigate to {cluster-manager-url} and select your cluster. + +. In the *Overview* page for your cluster, view the service logs in the *Cluster history* section. + +. Optional: Filter the cluster service logs by *Description* or *Severity* from the drop-down menu. You can filter further by entering a specific item in the search bar. + +. Optional: Click *Download history* to download the service logs for your cluster in JSON or CSV format. diff --git a/modules/viewing-the-service-logs.adoc b/modules/viewing-the-service-logs.adoc new file mode 100644 index 0000000000..66e5fda30c --- /dev/null +++ b/modules/viewing-the-service-logs.adoc @@ -0,0 +1,10 @@ +// Module included in the following assemblies: +// +// * osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.adoc +// * rosa_cluster_admin/rosa_logging/rosa-accessing-the-service-logs.adoc + +:_content-type: PROCEDURE +[id="viewing-the-service-logs_{context}"] += Viewing the service logs + +You can view the service logs for your clusters by using {cluster-manager-first} or the {cluster-manager} CLI (`ocm`). diff --git a/osd_cluster_admin/osd_logging/_attributes b/osd_cluster_admin/osd_logging/_attributes new file mode 120000 index 0000000000..5b32de1e01 --- /dev/null +++ b/osd_cluster_admin/osd_logging/_attributes @@ -0,0 +1 @@ +../../_attributes \ No newline at end of file diff --git a/osd_cluster_admin/osd_logging/images b/osd_cluster_admin/osd_logging/images new file mode 120000 index 0000000000..5fa6987088 --- /dev/null +++ b/osd_cluster_admin/osd_logging/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/osd_cluster_admin/osd_logging/modules b/osd_cluster_admin/osd_logging/modules new file mode 120000 index 0000000000..8b0e854007 --- /dev/null +++ b/osd_cluster_admin/osd_logging/modules @@ -0,0 +1 @@ +../../modules \ No newline at end of file diff --git a/osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.adoc b/osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.adoc new file mode 100644 index 0000000000..e8909a8de3 --- /dev/null +++ b/osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.adoc @@ -0,0 +1,22 @@ +:_content-type: ASSEMBLY +[id="osd-accessing-the-service-logs"] += Accessing the service logs for OpenShift Dedicated clusters +include::_attributes/attributes-openshift-dedicated.adoc[] +:context: osd-accessing-the-service-logs + +toc::[] + +[role="_abstract"] +You can view the service logs for your {product-title} clusters by using {cluster-manager-first}. The service logs detail cluster events such as load balancer quota updates and scheduled maintenance upgrades. The logs also show cluster resource changes such as the addition or deletion of users, groups, and identity providers. + +// Commented out while the OpenShift Cluster Manager CLI is in Developer Preview: +//You can view the service logs for your {product-title} clusters by using {cluster-manager-first} or the {cluster-manager} CLI (`ocm`). The service logs detail cluster events such as load balancer quota updates and scheduled maintenance upgrades. The logs also show cluster resource changes such as the addition or deletion of users, groups, and identity providers. + +Additionally, you can add notification contacts for an {product-title} cluster. Subscribed users receive emails about cluster events that require customer action, known cluster incidents, upgrade maintenance, and other topics. + +// Commented out while the OpenShift Cluster Manager CLI is in Developer Preview: +//include::modules/viewing-the-service-logs.adoc[leveloffset=+1] +//include::modules/viewing-the-service-logs-ocm.adoc[leveloffset=+2] +//include::modules/viewing-the-service-logs-cli.adoc[leveloffset=+2] +include::modules/viewing-the-service-logs-ocm.adoc[leveloffset=+1] +include::modules/adding-cluster-notification-contacts.adoc[leveloffset=+1] diff --git a/osd_cluster_admin/osd_logging/snippets b/osd_cluster_admin/osd_logging/snippets new file mode 120000 index 0000000000..7bf6da9a51 --- /dev/null +++ b/osd_cluster_admin/osd_logging/snippets @@ -0,0 +1 @@ +../../snippets \ No newline at end of file diff --git a/osd_install_access_delete_cluster/notifications.adoc b/osd_install_access_delete_cluster/notifications.adoc deleted file mode 100644 index 42a58df218..0000000000 --- a/osd_install_access_delete_cluster/notifications.adoc +++ /dev/null @@ -1,16 +0,0 @@ -:_content-type: ASSEMBLY -[id="notifications"] -= Notifications for {product-title} clusters -:context: notifications -include::_attributes/attributes-openshift-dedicated.adoc[] - -toc::[] - -[role="_abstract"] -Cluster service logs can be viewed through {cluster-manager-first} and {cluster-manager} CLI. The cluster history details cluster events such as adding groups, adding users, adding identity providers, load balancer quota updates, and scheduled maintenance upgrades. - -In addition to the cluster history on {cluster-manager}, users subscribed to cluster notifications also receive emails for cluster upgrade maintenance, known cluster incidents, or customer action required cluster events. - -include::modules/viewing-notifications.adoc[leveloffset=+1] - -include::modules/notification-subscribe.adoc[leveloffset=+1] diff --git a/rosa_cluster_admin/rosa_logging/rosa-accessing-the-service-logs.adoc b/rosa_cluster_admin/rosa_logging/rosa-accessing-the-service-logs.adoc new file mode 100644 index 0000000000..2e847e5411 --- /dev/null +++ b/rosa_cluster_admin/rosa_logging/rosa-accessing-the-service-logs.adoc @@ -0,0 +1,22 @@ +:_content-type: ASSEMBLY +[id="rosa-accessing-the-service-logs"] += Accessing the service logs for ROSA clusters +include::_attributes/attributes-openshift-dedicated.adoc[] +:context: rosa-accessing-the-service-logs + +toc::[] + +[role="_abstract"] +You can view the service logs for your {product-title} (ROSA) clusters by using {cluster-manager-first}. The service logs detail cluster events such as load balancer quota updates and scheduled maintenance upgrades. The logs also show cluster resource changes such as the addition or deletion of users, groups, and identity providers. + +// Commented out while the OpenShift Cluster Manager CLI is in Developer Preview: +//You can view the service logs for your {product-title} (ROSA) clusters by using {cluster-manager-first} or the {cluster-manager} CLI (`ocm`). The service logs detail cluster events such as load balancer quota updates and scheduled maintenance upgrades. The logs also show cluster resource changes such as the addition or deletion of users, groups, and identity providers. + +Additionally, you can add notification contacts for a ROSA cluster. Subscribed users receive emails about cluster events that require customer action, known cluster incidents, upgrade maintenance, and other topics. + +// Commented out while the OpenShift Cluster Manager CLI is in Developer Preview: +//include::modules/viewing-the-service-logs.adoc[leveloffset=+1] +//include::modules/viewing-the-service-logs-ocm.adoc[leveloffset=+2] +//include::modules/viewing-the-service-logs-cli.adoc[leveloffset=+2] +include::modules/viewing-the-service-logs-ocm.adoc[leveloffset=+1] +include::modules/adding-cluster-notification-contacts.adoc[leveloffset=+1] diff --git a/rosa_cluster_admin/rosa_logging/rosa-viewing-logs.adoc b/rosa_cluster_admin/rosa_logging/rosa-viewing-logs.adoc index 4603c79ebf..da1a5040d7 100644 --- a/rosa_cluster_admin/rosa_logging/rosa-viewing-logs.adoc +++ b/rosa_cluster_admin/rosa_logging/rosa-viewing-logs.adoc @@ -1,7 +1,7 @@ :_content-type: ASSEMBLY include::_attributes/attributes-openshift-dedicated.adoc[] [id="rosa-viewing-logs"] -= Viewing cluster logs += Viewing cluster logs in the AWS Console :context: rosa-viewing-logs toc::[] diff --git a/rosa_planning/rosa-limits-scalability.adoc b/rosa_planning/rosa-limits-scalability.adoc index c5da9bd799..fcb734654e 100644 --- a/rosa_planning/rosa-limits-scalability.adoc +++ b/rosa_planning/rosa-limits-scalability.adoc @@ -17,3 +17,9 @@ include::modules/rosa-planning-considerations.adoc[leveloffset=+1] == Next steps * xref:../rosa_planning/rosa-planning-environment.adoc#rosa-planning-environment[Planning your environment] + +[role="_additional-resources"] +[id="additional-resources_rosa-limits-scalability"] +== Additional resources + +* xref:../rosa_cluster_admin/rosa_logging/rosa-accessing-the-service-logs.adoc#rosa-accessing-the-service-logs[Accessing the service logs for ROSA clusters] diff --git a/upgrading/osd-upgrades.adoc b/upgrading/osd-upgrades.adoc index d9a43dd07a..7641c111b0 100644 --- a/upgrading/osd-upgrades.adoc +++ b/upgrading/osd-upgrades.adoc @@ -11,6 +11,10 @@ You can schedule automatic or manual upgrade policies to update the version of y include::modules/upgrade.adoc[leveloffset=+1] -include::modules/upgrade-auto.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* For more information about the service log and adding cluster notification contacts, see xref:../osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.adoc#osd-accessing-the-service-logs[Accessing the service logs for {product-title} clusters]. + +include::modules/upgrade-auto.adoc[leveloffset=+1] include::modules/upgrade-manual.adoc[leveloffset=+1]