Skip to content

Commit f7e7ae6

Browse files
pneedle-rhpneedle-rh
authored
Merge pull request #47033 from pneedle-rh/osdocs-3718-obtaining-the-service-logs
OSDOCS-3718 - Adding OSD and ROSA service log content
2 parents 07ad72a + 5ffc456 commit f7e7ae6

20 files changed

+301
-75
lines changed

‎.s2i/httpd-cfg/01-commercial.conf

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -550,8 +550,10 @@ AddType text/vtt vtt
550550
RewriteRule ^dedicated/architecture/additional_concepts/f5_big_ip\.html(.*) /dedicated/welcome/index.html$1 [NE,L,R=301]
551551
RewriteRule ^dedicated/architecture/additional_concepts/flannel\.html(.*) /dedicated/welcome/index.html$1 [NE,L,R=301]
552552

553-
# Redirects for the Dedicated restructure applied in https://github.com/openshift/openshift-docs/pull/41923 and https://github.com/openshift/openshift-docs/pull/43807
553+
# Redirects for Dedicated service log content move, applied in https://github.com/openshift/openshift-docs/pull/47033
554+
RewriteRule ^dedicated/osd_install_access_delete_cluster/notifications.html /dedicated/osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.html [NE,R=302]
554555

556+
# Redirects for the Dedicated restructure applied in https://github.com/openshift/openshift-docs/pull/41923 and https://github.com/openshift/openshift-docs/pull/43807
555557
RewriteRule ^dedicated/osd_quickstart/osd-quickstart.html /dedicated/osd_getting_started/osd-getting-started.html [NE,R=302]
556558

557559
RewriteRule ^dedicated/osd_cluster_create/osd-understanding-your-cloud-deployment-options.html /dedicated/osd_getting_started/osd-understanding-your-cloud-deployment-options.html [NE,R=302]
@@ -567,7 +569,7 @@ AddType text/vtt vtt
567569
RewriteRule ^dedicated/nodes/rosa-managing-worker-nodes.html /dedicated/osd_cluster_admin/osd_nodes/osd-managing-worker-nodes.html [NE,R=302]
568570
RewriteRule ^dedicated/nodes/?(.*)$ /dedicated/osd_cluster_admin/osd_nodes/osd-$1 [NE,R=302]
569571

570-
RewriteRule ^dedicated/osd_notifications/notifications.html /dedicated/osd_install_access_delete_cluster/notifications.html [NE,R=302]
572+
RewriteRule ^dedicated/osd_notifications/notifications.html /dedicated/osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.html [NE,R=302]
571573

572574
RewriteRule ^dedicated/monitoring/?(.*)$ /dedicated/osd_cluster_admin/osd_monitoring/$1 [NE,R=302]
573575

‎_topic_maps/_topic_map_osd.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,6 @@ Topics:
9393
File: creating-a-gcp-cluster
9494
- Name: Configuring your identity providers
9595
File: config-identity-providers
96-
- Name: Notifications for OpenShift Dedicated clusters
97-
File: notifications
9896
---
9997
Name: Cluster administration
10098
Dir: osd_cluster_admin
@@ -120,6 +118,12 @@ Topics:
120118
File: osd-managing-worker-nodes
121119
- Name: About autoscaling nodes on a cluster
122120
File: osd-nodes-about-autoscaling-nodes
121+
- Name: Logging
122+
Dir: osd_logging
123+
Distros: openshift-dedicated
124+
Topics:
125+
- Name: Accessing the service logs
126+
File: osd-accessing-the-service-logs
123127
- Name: Monitoring user-defined projects
124128
Dir: osd_monitoring
125129
Distros: openshift-dedicated

‎_topic_maps/_topic_map_rosa.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,9 +207,11 @@ Topics:
207207
Dir: rosa_logging
208208
Distros: openshift-rosa
209209
Topics:
210+
- Name: Accessing the service logs
211+
File: rosa-accessing-the-service-logs
210212
- Name: Installing the CloudWatch logging service
211213
File: rosa-install-logging
212-
- Name: Viewing cluster logs
214+
- Name: Viewing cluster logs in the AWS Console
213215
File: rosa-viewing-logs
214216
- Name: Monitoring user-defined projects
215217
Dir: rosa_monitoring

‎modules/adding-cluster-notification-contacts.adoc

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.adoc
4+
// * rosa_cluster_admin/rosa_logging/rosa-accessing-the-service-logs.adoc
5+
6+
:_content-type: PROCEDURE
7+
[id="adding-cluster-notification-contacts_{context}"]
8+
= Adding cluster notification contacts
9+
10+
You can add notification contacts for your
11+
ifdef::openshift-dedicated[]
12+
{product-title}
13+
endif::openshift-dedicated[]
14+
ifdef::openshift-rosa[]
15+
{product-title} (ROSA)
16+
endif::openshift-rosa[]
17+
cluster. When an event occurs that triggers a cluster notification email, subscribed users are notified.
18+
19+
.Procedure
20+
21+
. Navigate to {cluster-manager-url} and select your cluster.
22+
23+
. On the *Support* tab, under the *Notification contacts* heading, click *Add notification contact*.
24+
25+
. Enter the Red Hat username or email of the contact you want to add.
26+
+
27+
[NOTE]
28+
====
29+
The username or email address must relate to a user account in the Red Hat organization where the cluster is deployed.
30+
====
31+
32+
. Click *Add contact*.
33+
34+
.Verification
35+
36+
* You see a confirmation message when you have successfully added the contact. The user appears under the *Notification contacts* heading on the *Support* tab.

‎modules/notification-subscribe.adoc

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎modules/rosa-planning-considerations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The maximum number of compute nodes on ROSA is 180.
7171

7272
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.
7373

74-
When scaling is applied, the customer is notified through a service log entry.
74+
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_.
7575

7676
[id="sizing-considerations-for-larger-clusters_{context}"]
7777
== Sizing considerations for larger clusters

‎modules/viewing-notifications.adoc

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎modules/viewing-the-service-logs-cli.adoc

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.adoc
4+
// * rosa_cluster_admin/rosa_logging/rosa-accessing-the-service-logs.adoc
5+
6+
:_content-type: PROCEDURE
7+
[id="viewing-the-service-logs-cli_{context}"]
8+
= Viewing the service logs by using the CLI
9+
10+
You can view the service logs for
11+
ifdef::openshift-dedicated[]
12+
{product-title}
13+
endif::openshift-dedicated[]
14+
ifdef::openshift-rosa[]
15+
{product-title} (ROSA)
16+
endif::openshift-rosa[]
17+
clusters by using the {cluster-manager} CLI (`ocm`).
18+
19+
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.
20+
21+
.Prerequisites
22+
23+
* You have installed an {product-title} cluster.
24+
* You are the cluster owner or you have the cluster editor role.
25+
* You have installed and configured the latest {cluster-manager} CLI (`ocm`) on your installation host.
26+
+
27+
[NOTE]
28+
====
29+
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.
30+
====
31+
32+
.Procedure
33+
34+
. View the service logs for a cluster:
35+
.. List the clusters in your Red Hat organization:
36+
+
37+
[source,terminal]
38+
----
39+
$ ocm list clusters
40+
----
41+
+
42+
.Example output
43+
[source,terminal]
44+
----
45+
ID NAME API URL OPENSHIFT_VERSION PRODUCT ID CLOUD_PROVIDER REGION ID STATE
46+
ifdef::openshift-dedicated[]
47+
1t1398ndq653vjf317a32cfjvee771dc mycluster https://api.mycluster.cdrj.p1.openshiftapps.com:6443 4.10.18 osd aws us-east-1 ready
48+
endif::openshift-dedicated[]
49+
ifdef::openshift-rosa[]
50+
1t1398ndq653vjf317a32cfjvee771dc mycluster https://api.mycluster.cdrj.p1.openshiftapps.com:6443 4.10.18 rosa aws us-east-1 ready
51+
endif::openshift-rosa[]
52+
----
53+
+
54+
.. Obtain the external cluster ID for your cluster:
55+
+
56+
[source,terminal]
57+
----
58+
$ ocm describe cluster <cluster_name> <1>
59+
----
60+
<1> Replace `<cluster_name>` with the name of your cluster.
61+
+
62+
.Example output
63+
[source,terminal]
64+
----
65+
ID: 1t1298nhq824vjf347q12cpjvee771hc
66+
External ID: f3f1a6c1-2b2b-4a55-854c-fd65e26b737b
67+
...
68+
----
69+
+
70+
.. View the service logs for your cluster:
71+
+
72+
[source,terminal]
73+
----
74+
$ ocm get /api/service_logs/v1/cluster_logs --parameter search="cluster_uuid = '<external_cluster_id>'" <1>
75+
----
76+
<1> Replace `<external_cluster_id>` with the external cluster ID that you obtained in the preceding step.
77+
+
78+
.Example output
79+
[source,terminal]
80+
----
81+
{
82+
"kind": "ClusterLogList",
83+
"page": 1,
84+
"size": 1,
85+
"total": 1,
86+
"items": [
87+
{
88+
"id": "1AyuZCfRwUEwkUEbyKJqjUsdRdj",
89+
"kind": "ClusterLog",
90+
"href": "/api/service_logs/v1/cluster_logs/1AyuZCfRwUEwkUEbyKJqjUsdRdj",
91+
"timestamp": "2022-06-23T14:23:19.078551Z",
92+
"severity": "Info",
93+
"service_name": "AccountManager",
94+
"cluster_uuid": "f3f1a6c1-2b2b-4a55-854c-fd65e26b737b",
95+
"summary": "Cluster registered successfully",
96+
"description": "Cluster installation completed and the cluster registered successfully.",
97+
"event_stream_id": "3ByuXECLcWsfFvVMIOhiH8YCxEk",
98+
"created_by": "service-account-ocm-ams-service",
99+
"created_at": "2022-06-23T14:23:19.10425Z",
100+
"username": "service-account-telemeter-service"
101+
}
102+
]
103+
}
104+
----
105+
106+
. View the service logs for all available clusters in your Red Hat organization:
107+
+
108+
.Example output
109+
[source,terminal]
110+
----
111+
$ ocm get /api/service_logs/v1/cluster_logs
112+
----
113+
114+
. View the service logs for all available clusters in your Red Hat organization and sort the results by cluster ID:
115+
+
116+
.Example output
117+
[source,terminal]
118+
----
119+
$ ocm get /api/service_logs/v1/cluster_logs --parameter orderBy="cluster_uuid"
120+
----
121+
122+
. Filter the service logs by severity:
123+
+
124+
.Example output
125+
[source,terminal]
126+
----
127+
$ ocm get /api/service_logs/v1/cluster_logs --parameter search="severity = '<severity>'" <1>
128+
----
129+
<1> Replace `<severity>` with the severity type. The available values are `Debug`, `Info`, `Warning`, `Error`, and `Fatal`.
130+
+
131+
[NOTE]
132+
====
133+
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 = '<external_cluster_id>' and severity = '<severity>'"`.
134+
====
135+
136+
. View a specific service log entry by specifying the log ID:
137+
+
138+
.Example output
139+
[source,terminal]
140+
----
141+
$ ocm get /api/service_logs/v1/cluster_logs/<log_id> <1>
142+
----
143+
<1> Replace `<log_id>` with the ID of the log entry.

‎modules/viewing-the-service-logs-ocm.adoc

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.adoc
4+
// * rosa_cluster_admin/rosa_logging/rosa-accessing-the-service-logs.adoc
5+
6+
:_content-type: PROCEDURE
7+
[id="viewing-the-service-logs-ocm_{context}"]
8+
= Viewing the service logs by using {cluster-manager}
9+
10+
You can view the service logs for
11+
ifdef::openshift-dedicated[]
12+
an {product-title}
13+
endif::openshift-dedicated[]
14+
ifdef::openshift-rosa[]
15+
a {product-title} (ROSA)
16+
endif::openshift-rosa[]
17+
cluster by using {cluster-manager-first}.
18+
19+
.Prerequisites
20+
21+
* You have installed
22+
ifdef::openshift-dedicated[]
23+
an {product-title}
24+
endif::openshift-dedicated[]
25+
ifdef::openshift-rosa[]
26+
a ROSA
27+
endif::openshift-rosa[]
28+
cluster.
29+
30+
.Procedure
31+
32+
. Navigate to {cluster-manager-url} and select your cluster.
33+
34+
. In the *Overview* page for your cluster, view the service logs in the *Cluster history* section.
35+
36+
. 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.
37+
38+
. Optional: Click *Download history* to download the service logs for your cluster in JSON or CSV format.

‎modules/viewing-the-service-logs.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.adoc
4+
// * rosa_cluster_admin/rosa_logging/rosa-accessing-the-service-logs.adoc
5+
6+
:_content-type: PROCEDURE
7+
[id="viewing-the-service-logs_{context}"]
8+
= Viewing the service logs
9+
10+
You can view the service logs for your clusters by using {cluster-manager-first} or the {cluster-manager} CLI (`ocm`).

0 commit comments

Comments
 (0)