Skip to content

Commit d9c1444

Browse files
authored
Merge pull request #55445 from bmcelvee/OSDOCS-3949-new
OSDOCS-3949: Describe data sent off-cluster in ROSA/OSD docs
2 parents 34d2409 + 9815275 commit d9c1444

File tree

44 files changed

+149
-402
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+149
-402
lines changed

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -238,9 +238,7 @@ AddType text/vtt vtt
238238

239239
# RewriteRule rosa/logging/?(.*)$ rosa/rosa_cluster_admin/rosa_logging/$1 [NE,R=301]
240240

241-
RewriteRule rosa/monitoring/osd?(.*)$ rosa/rosa_cluster_admin/rosa_monitoring/rosa$1 [NE,R=301]
242-
243-
RewriteRule rosa/cloud_infrastructure_access/?(.*)$ rosa/rosa_cluster_admin/cloud_infrastructure_access/$1 [NE,R=301]
241+
RewriteRule rosa/cloud_infrastructure_access/?(.*)$ rosa/rosa_cluster_admin/cloud_infrastructure_access/$1 [NE,R=301]
244242

245243
RewriteRule rosa/nodes/nodes-machinepools-about.html rosa/rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about.html [NE,R=301]
246244
RewriteRule rosa/nodes/rosa-managing-worker-nodes.html rosa/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.html [NE,R=301]
@@ -589,8 +587,6 @@ AddType text/vtt vtt
589587

590588
RewriteRule ^dedicated/osd_notifications/notifications.html /dedicated/osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.html [NE,R=301]
591589

592-
RewriteRule ^dedicated/monitoring/?(.*)$ /dedicated/osd_cluster_admin/osd_monitoring/$1 [NE,R=301]
593-
594590
RewriteRule ^dedicated/osd_policy/?(.*)$ /dedicated/osd_architecture/osd_policy/$1 [NE,R=301]
595591

596592
RewriteRule ^dedicated/support/getting-support.html /dedicated/osd_architecture/osd-support.html [NE,R=301]

_topic_maps/_topic_map_osd.yml

Lines changed: 29 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -130,28 +130,15 @@ Topics:
130130
Topics:
131131
- Name: Accessing the service logs
132132
File: osd-accessing-the-service-logs
133-
- Name: Monitoring user-defined projects
134-
Dir: osd_monitoring
135-
Distros: openshift-dedicated
136-
Topics:
137-
- Name: Understanding the monitoring stack
138-
File: osd-understanding-the-monitoring-stack
139-
- Name: Accessing monitoring for user-defined projects
140-
File: osd-accessing-monitoring-for-user-defined-projects
141-
- Name: Configuring the monitoring stack
142-
File: osd-configuring-the-monitoring-stack
143-
- Name: Enabling alert routing for user-defined projects
144-
File: osd-enabling-alert-routing-for-user-defined-projects
145-
- Name: Managing metrics
146-
File: osd-managing-metrics
147-
- Name: Managing alerts
148-
File: osd-managing-alerts
149-
- Name: Reviewing monitoring dashboards
150-
File: osd-reviewing-monitoring-dashboards
151-
- Name: Troubleshooting monitoring issues
152-
File: osd-troubleshooting-monitoring-issues
153133
---
154-
Name: Cluster security
134+
Name: Security and compliance
135+
Dir: security
136+
Distros: openshift-dedicated
137+
Topics:
138+
- Name: Viewing audit logs
139+
File: audit-log-view
140+
---
141+
Name: Authentication and authorization
155142
Dir: authentication
156143
Distros: openshift-dedicated
157144
Topics:
@@ -346,6 +333,27 @@ Topics:
346333
- Name: Exported fields
347334
File: cluster-logging-exported-fields
348335
---
336+
Name: Monitoring user-defined projects
337+
Dir: monitoring
338+
Distros: openshift-dedicated
339+
Topics:
340+
- Name: Understanding the monitoring stack
341+
File: osd-understanding-the-monitoring-stack
342+
- Name: Accessing monitoring for user-defined projects
343+
File: osd-accessing-monitoring-for-user-defined-projects
344+
- Name: Configuring the monitoring stack
345+
File: osd-configuring-the-monitoring-stack
346+
- Name: Enabling alert routing for user-defined projects
347+
File: osd-enabling-alert-routing-for-user-defined-projects
348+
- Name: Managing metrics
349+
File: osd-managing-metrics
350+
- Name: Managing alerts
351+
File: managing-alerts
352+
- Name: Reviewing monitoring dashboards
353+
File: osd-reviewing-monitoring-dashboards
354+
- Name: Troubleshooting monitoring issues
355+
File: osd-troubleshooting-monitoring-issues
356+
---
349357
Name: Serverless
350358
Dir: serverless
351359
Distros: openshift-dedicated

_topic_maps/_topic_map_rosa.yml

Lines changed: 37 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -212,26 +212,17 @@ Topics:
212212
Distros: openshift-rosa
213213
- Name: About autoscaling nodes on a cluster
214214
File: rosa-nodes-about-autoscaling-nodes
215-
- Name: Monitoring user-defined projects
216-
Dir: rosa_monitoring
217-
Distros: openshift-rosa
218-
Topics:
219-
- Name: Understanding the monitoring stack
220-
File: rosa-understanding-the-monitoring-stack
221-
- Name: Accessing monitoring for user-defined projects
222-
File: rosa-accessing-monitoring-for-user-defined-projects
223-
- Name: Configuring the monitoring stack
224-
File: rosa-configuring-the-monitoring-stack
225-
- Name: Enabling alert routing for user-defined projects
226-
File: rosa-enabling-alert-routing-for-user-defined-projects
227-
- Name: Managing metrics
228-
File: rosa-managing-metrics
229-
- Name: Managing alerts
230-
File: rosa-managing-alerts
231-
- Name: Reviewing monitoring dashboards
232-
File: rosa-reviewing-monitoring-dashboards
233-
- Name: Troubleshooting monitoring issues
234-
File: rosa-troubleshooting-monitoring-issues
215+
---
216+
Name: Security and compliance
217+
Dir: security
218+
Distros: openshift-rosa
219+
Topics:
220+
- Name: Viewing audit logs
221+
File: audit-log-view
222+
# - Name: Security
223+
# File: rosa-security
224+
# - Name: Application and cluster compliance
225+
# File: rosa-app-security-compliance
235226
---
236227
Name: Authentication and authorization
237228
Dir: authentication
@@ -241,10 +232,6 @@ Topics:
241232
File: assuming-an-aws-iam-role-for-a-service-account
242233
- Name: Managing security context constraints
243234
File: managing-security-context-constraints
244-
# - Name: Security
245-
# File: rosa-security
246-
# - Name: Application and cluster compliance
247-
# File: rosa-app-security-compliance
248235
---
249236
Name: Upgrading
250237
Dir: upgrading
@@ -447,6 +434,27 @@ Topics:
447434
- Name: Exported fields
448435
File: cluster-logging-exported-fields
449436
---
437+
Name: Monitoring user-defined projects
438+
Dir: monitoring
439+
Distros: openshift-rosa
440+
Topics:
441+
- Name: Understanding the monitoring stack
442+
File: rosa-understanding-the-monitoring-stack
443+
- Name: Accessing monitoring for user-defined projects
444+
File: rosa-accessing-monitoring-for-user-defined-projects
445+
- Name: Configuring the monitoring stack
446+
File: rosa-configuring-the-monitoring-stack
447+
- Name: Enabling alert routing for user-defined projects
448+
File: rosa-enabling-alert-routing-for-user-defined-projects
449+
- Name: Managing metrics
450+
File: rosa-managing-metrics
451+
- Name: Managing alerts
452+
File: managing-alerts
453+
- Name: Reviewing monitoring dashboards
454+
File: rosa-reviewing-monitoring-dashboards
455+
- Name: Troubleshooting monitoring issues
456+
File: rosa-troubleshooting-monitoring-issues
457+
---
450458
Name: Service Mesh
451459
Dir: service_mesh
452460
Distros: openshift-rosa
@@ -932,6 +940,11 @@ Name: Troubleshooting
932940
Dir: rosa_support
933941
Distros: openshift-rosa
934942
Topics:
943+
- Name: Remote health monitoring with connected clusters
944+
Dir: remote_health_monitoring
945+
Topics:
946+
- Name: Showing data collected by remote health monitoring
947+
File: showing-data-collected-by-remote-health-monitoring
935948
- Name: Troubleshooting expired offline access tokens
936949
File: rosa-troubleshooting-expired-tokens
937950
- Name: Troubleshooting installations

modules/monitoring-applying-a-custom-configuration-to-alertmanager-for-user-defined-alert-routing.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
// Module included in the following assemblies:
22
//
33
// * monitoring/managing-alerts.adoc
4-
// * monitoring/osd-managing-alerts.adoc
5-
// * osd_cluster_admin/osd_monitoring/osd-managing-alerts.adoc
6-
// * rosa_cluster_admin/rosa_monitoring/rosa-managing-alerts.adoc
74

85
:_content-type: PROCEDURE
96
[id="applying-a-custom-configuration-to-alertmanager-for-user-defined-alert-routing_{context}"]

modules/monitoring-enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
//
33
// * monitoring/enabling-alert-routing-for-user-defined-projects.adoc
44
// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
5-
// * osd_cluster_admin/osd_monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
6-
// * rosa_cluster_admin/rosa_monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
5+
// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
6+
// * monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
77

88
:_content-type: PROCEDURE
99
[id="enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing_{context}"]

modules/monitoring-granting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
//
33
// * monitoring/enabling-alert-routing-for-user-defined-projects.adoc
44
// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
5-
// * osd_cluster_admin/osd_monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
6-
// * rosa_cluster_admin/rosa_monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
5+
// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
6+
// * monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
77

88
:_content-type: PROCEDURE
99
[id="granting-users-permission-to-configure-alert-routing-for-user-defined-projects_{context}"]

modules/monitoring-listing-alerting-rules-for-all-projects-in-a-single-view.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
// Module included in the following assemblies:
22
//
33
// * monitoring/managing-alerts.adoc
4-
// * monitoring/osd-managing-alerts.adoc
5-
// * osd_cluster_admin/osd_monitoring/osd-managing-alerts.adoc
6-
// * rosa_cluster_admin/rosa_monitoring/rosa-managing-alerts.adoc
74

85
:_content-type: PROCEDURE
96
[id="listing-alerting-rules-for-all-projects-in-a-single-view_{context}"]

modules/monitoring-managing-alerting-rules-for-user-defined-projects.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In {product-title} {product-version}, you can create, view, edit, and remove ale
1414
ifdef::openshift-rosa,openshift-dedicated[]
1515
[IMPORTANT]
1616
====
17-
Managing alerting rules for user-defined projects is only available in {product-title} version 4.11 and up.
17+
Managing alerting rules for user-defined projects is only available in {product-title} version 4.11 and later.
1818
====
1919
endif::[]
2020

modules/osd-monitoring-understanding-alert-routing-for-user-defined-projects.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
// Module included in the following assemblies:
22
//
33
// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
4-
// * osd_cluster_admin/osd_monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
5-
// * rosa_cluster_admin/rosa_monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
4+
// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
5+
// * monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
66

77
:_content-type: CONCEPT
88
[id="osd-understanding-alert-routing-for-user-defined-projects_{context}"]

modules/telemetry-showing-data-collected-from-the-cluster.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,14 @@ You can view the cluster and components time series data captured by Telemetry.
1010

1111
.Prerequisites
1212

13-
* You have installed the {product-title} CLI (`oc`).
13+
* You have installed the
14+
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
15+
{product-title}
16+
endif::openshift-enterprise,openshift-webscale,openshift-origin[]
17+
ifndef::openshift-enterprise,openshift-webscale,openshift-origin[]
18+
OpenShift Container Platform
19+
endif::openshift-enterprise,openshift-webscale,openshift-origin[]
20+
CLI (`oc`).
1421
* You have access to the cluster as a user with the `cluster-admin` role or the `cluster-monitoring-view` role.
1522
1623
.Procedure

0 commit comments

Comments
 (0)