Skip to content

Commit 9873681

Browse files
committed
CNV-17386: Consolidate support files
Signed-off-by: Avital Pinnick <[email protected]>
1 parent 8b82bd6 commit 9873681

File tree

46 files changed

+388
-546
lines changed

Some content is hidden

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

46 files changed

+388
-546
lines changed

_topic_maps/_topic_map.yml

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3561,8 +3561,6 @@ Topics:
35613561
File: virt-configuring-vgpu-passthrough
35623562
- Name: Configuring mediated devices
35633563
File: virt-configuring-mediated-devices
3564-
- Name: Configuring a watchdog device
3565-
File: virt-configuring-a-watchdog
35663564
- Name: Automatic importing and updating of pre-defined boot sources
35673565
File: virt-automatic-bootsource-updates
35683566
- Name: Enabling descheduler evictions on virtual machines
@@ -3702,35 +3700,32 @@ Topics:
37023700
- Name: Preventing node reconciliation
37033701
File: virt-preventing-node-reconciliation
37043702
# Removed the Node Networking content from the topic map because this section is now part of the OCP docs
3705-
# Logging, events, and monitoring
3703+
# Support, was Logging, events, and monitoring
37063704
- Name: Support
37073705
Dir: support
37083706
Topics:
3709-
- Name: Viewing OpenShift Virtualization logs
3710-
File: virt-logs
3711-
- Name: Viewing events
3712-
File: virt-events
3713-
- Name: Monitoring live migration
3714-
File: virt-monitor-vmi-migration
3715-
- Name: Diagnosing data volumes using events and conditions
3716-
File: virt-diagnosing-datavolumes-using-events-and-conditions
3717-
- Name: Monitoring virtual machine health with health probes
3718-
File: virt-monitoring-vm-health
3719-
- Name: Viewing cluster information
3720-
File: virt-using-dashboard-to-get-cluster-info
3721-
- Name: OpenShift cluster monitoring, logging, and Telemetry
3722-
File: virt-openshift-cluster-monitoring
3723-
- Name: Running OpenShift cluster checkups
3724-
File: virt-running-cluster-checkups
3725-
- Name: Prometheus queries for virtual resources
3726-
File: virt-prometheus-queries
3727-
- Name: Exposing custom metrics for virtual machines
3728-
File: virt-exposing-custom-metrics-for-vms
3729-
- Name: OpenShift Virtualization runbooks
3730-
File: virt-runbooks
3707+
- Name: Support overview
3708+
File: virt-support-overview
37313709
- Name: Collecting data for Red Hat Support
37323710
File: virt-collecting-virt-data
37333711
Distros: openshift-enterprise
3712+
- Name: Monitoring
3713+
Dir: monitoring
3714+
Topics:
3715+
- Name: Monitoring overview
3716+
File: virt-monitoring-overview
3717+
- Name: OpenShift cluster checkup framework
3718+
File: virt-running-cluster-checkups
3719+
- Name: Prometheus queries for virtual resources
3720+
File: virt-prometheus-queries
3721+
- Name: Virtual machine custom metrics
3722+
File: virt-exposing-custom-metrics-for-vms
3723+
- Name: Virtual machine health checks
3724+
File: virt-monitoring-vm-health
3725+
- Name: Troubleshooting
3726+
File: virt-troubleshooting
3727+
- Name: Runbooks
3728+
File: virt-runbooks
37343729
- Name: Backup and restore
37353730
Dir: backup_restore
37363731
Topics:
Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
// Module included in the following assemblies:
22
//
33
// * logging/cluster-logging.adoc
4-
// * virt/support/virt-openshift-cluster-monitoring.adoc
5-
6-
7-
ifeval::["{context}" == "virt-openshift-cluster-monitoring"]
8-
:virt-logging:
9-
endif::[]
104

115
:_content-type: CONCEPT
126
[id="cluster-logging-about-components_{context}"]
@@ -21,10 +15,3 @@ The major components of the {logging} are:
2115
* log store - This is where the logs are stored. The default implementation is Elasticsearch. You can use the default Elasticsearch log store or forward logs to external log stores. The default log store is optimized and tested for short-term storage.
2216
* visualization - This is the UI component you can use to view logs, graphs, charts, and so forth. The current implementation is Kibana.
2317
24-
ifndef::virt-logging[]
25-
This document might refer to log store or Elasticsearch, visualization or Kibana, collection or Fluentd, interchangeably, except where noted.
26-
endif::virt-logging[]
27-
28-
ifeval::["{context}" == "virt-openshift-cluster-monitoring"]
29-
:!virt-logging:
30-
endif::[]

modules/monitoring-about-cluster-monitoring.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/support/virt-openshift-cluster-monitoring.adoc
43
// * monitoring/monitoring-overview.adoc
54

65
// This module uses a conditionalized title so that the module

modules/telemetry-about-telemetry.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/support/virt-openshift-cluster-monitoring.adoc
43
// * support/remote_health_monitoring/about-remote-health-monitoring.adoc
54

65
:_content-type: CONCEPT
76
[id="telemetry-about-telemetry_{context}"]
87
= About Telemetry
98

10-
Telemetry sends a carefully chosen subset of the cluster monitoring metrics to Red Hat. The Telemeter Client fetches the metrics values every four minutes and thirty seconds and uploads the data to Red Hat. These metrics are described in this document.
9+
Telemetry sends a carefully chosen subset of the cluster monitoring metrics to Red Hat. The Telemeter Client fetches the metrics values every four minutes and thirty seconds and uploads the data to Red Hat. These metrics are described in this document.
1110

1211
This stream of data is used by Red Hat to monitor the clusters in real-time and to react as necessary to problems that impact our customers. It also allows Red Hat to roll out {product-title} upgrades to customers to minimize service impact and continuously improve the upgrade experience.
1312

modules/telemetry-what-information-is-collected.adoc

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/support/virt-openshift-cluster-monitoring.adoc
43
// * support/remote_health_monitoring/about-remote-health-monitoring.adoc
54

6-
ifeval::["{context}" == "virt-openshift-cluster-monitoring"]
7-
:virt-cluster:
8-
endif::[]
9-
5+
:_content-type: REFERENCE
106
[id="what-information-is-collected_{context}"]
117
= Information collected by Telemetry
128

@@ -35,6 +31,3 @@ endif::openshift-dedicated[]
3531
3632
Telemetry does not collect identifying information such as user names or passwords. Red Hat does not intend to collect personal information. If Red Hat discovers that personal information has been inadvertently received, Red Hat will delete such information. To the extent that any telemetry data constitutes personal data, please refer to the link:https://www.redhat.com/en/about/privacy-policy[Red Hat Privacy Statement] for more information about Red Hat's privacy practices.
3733

38-
ifeval::["{context}" == "virt-openshift-cluster-monitoring"]
39-
:!virt-cluster:
40-
endif::[]

modules/virt-about-conditions-and-events.adoc renamed to modules/virt-about-dv-conditions-and-events.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/support/virt-diagnosing-datavolumes-using-events-and-conditions.adoc
3+
// * virt/support/virt-troubleshooting.adoc
44

55
:_content-type: CONCEPT
6-
[id="virt-about-conditions-and-events.adoc_{context}"]
7-
= About conditions and events
6+
[id="virt-about-dv-conditions-and-events.adoc_{context}"]
7+
= About data volume conditions and events
88

9-
Diagnose data volume issues by examining the output of the `Conditions` and `Events` sections
9+
You can diagnose data volume issues by examining the output of the `Conditions` and `Events` sections
1010
generated by the command:
1111

1212
[source,terminal]
1313
----
1414
$ oc describe dv <DataVolume>
1515
----
1616

17-
There are three `Types` in the `Conditions` section that display:
17+
The `Conditions` section displays the following `Types`:
1818

1919
* `Bound`
2020
* `Running`
@@ -29,7 +29,7 @@ The `Events` section provides the following additional information:
2929
3030
The output from `oc describe` does not always contains `Events`.
3131

32-
An event is generated when either `Status`, `Reason`, or `Message` changes.
32+
An event is generated when the `Status`, `Reason`, or `Message` changes.
3333
Both conditions and events react to changes in the state of the data volume.
3434

3535
For example, if you misspell the URL during an import operation, the import

modules/virt-about-the-overview-dashboard.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/support/virt-using-dashboard-to-get-cluster-info.adoc
43
// * web_console/using-dashboard-to-get-cluster-information.adoc
54

65
ifeval::["{context}" == "virt-using-dashboard-to-get-cluster-info"]

modules/virt-about-vm-events.adoc

Lines changed: 0 additions & 14 deletions
This file was deleted.
Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/support/virt-analyzing-datavolumes-using-events-and-conditions.adoc
3+
// * virt/support/virt-troubleshooting.adoc
44

55
[id="virt-analyzing-datavolume-conditions-and-events_{context}"]
6-
= Analyzing data volumes using conditions and events
6+
= Analyzing data volume conditions and events
77

88
By inspecting the `Conditions` and `Events` sections generated by the `describe`
99
command, you determine the state of the data volume
@@ -16,7 +16,7 @@ There are many different combinations of conditions. Each must be evaluated in i
1616

1717
Examples of various combinations follow.
1818

19-
* `Bound` A successfully bound PVC displays in this example.
19+
* `Bound` - A successfully bound PVC displays in this example.
2020
+
2121
Note that the `Type` is `Bound`, so the `Status` is `True`.
2222
If the PVC is not bound, the `Status` is `False`.
@@ -33,21 +33,21 @@ in this case `datavolume-controller`:
3333
[source,terminal]
3434
----
3535
Status:
36-
Conditions:
37-
Last Heart Beat Time: 2020-07-15T03:58:24Z
38-
Last Transition Time: 2020-07-15T03:58:24Z
39-
Message: PVC win10-rootdisk Bound
40-
Reason: Bound
41-
Status: True
42-
Type: Bound
43-
44-
Events:
45-
Type Reason Age From Message
46-
---- ------ ---- ---- -------
47-
Normal Bound 24s datavolume-controller PVC example-dv Bound
36+
Conditions:
37+
Last Heart Beat Time: 2020-07-15T03:58:24Z
38+
Last Transition Time: 2020-07-15T03:58:24Z
39+
Message: PVC win10-rootdisk Bound
40+
Reason: Bound
41+
Status: True
42+
Type: Bound
43+
...
44+
Events:
45+
Type Reason Age From Message
46+
---- ------ ---- ---- -------
47+
Normal Bound 24s datavolume-controller PVC example-dv Bound
4848
----
4949

50-
* `Running` In this case, note that `Type` is `Running` and `Status` is `False`,
50+
* `Running` - In this case, note that `Type` is `Running` and `Status` is `False`,
5151
indicating that an event has occurred that caused an attempted
5252
operation to fail, changing the Status from `True` to `False`.
5353
+
@@ -67,19 +67,19 @@ attempting to access the data volume:
6767
[source,terminal]
6868
----
6969
Status:
70-
Conditions:
71-
Last Heart Beat Time: 2020-07-15T04:31:39Z
72-
Last Transition Time: 2020-07-15T04:31:39Z
73-
Message: Import Complete
74-
Reason: Completed
75-
Status: False
76-
Type: Running
77-
78-
Events:
79-
Type Reason Age From Message
80-
---- ------ ---- ---- -------
81-
Warning Error 12s (x2 over 14s) datavolume-controller Unable to connect
82-
to http data source: expected status code 200, got 404. Status: 404 Not Found
70+
Conditions:
71+
Last Heart Beat Time: 2020-07-15T04:31:39Z
72+
Last Transition Time: 2020-07-15T04:31:39Z
73+
Message: Import Complete
74+
Reason: Completed
75+
Status: False
76+
Type: Running
77+
...
78+
Events:
79+
Type Reason Age From Message
80+
---- ------ ---- ---- -------
81+
Warning Error 12s (x2 over 14s) datavolume-controller Unable to connect
82+
to http data source: expected status code 200, got 404. Status: 404 Not Found
8383
----
8484

8585
* `Ready` – If `Type` is `Ready` and `Status` is `True`, then the data volume is ready
@@ -90,9 +90,9 @@ used, the `Status` is `False`:
9090
[source,terminal]
9191
----
9292
Status:
93-
Conditions:
94-
Last Heart Beat Time: 2020-07-15T04:31:39Z
95-
Last Transition Time: 2020-07-15T04:31:39Z
96-
Status: True
97-
Type: Ready
93+
Conditions:
94+
Last Heart Beat Time: 2020-07-15T04:31:39Z
95+
Last Transition Time: 2020-07-15T04:31:39Z
96+
Status: True
97+
Type: Ready
9898
----

modules/virt-collecting-data-about-vms.adoc

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

0 commit comments

Comments
 (0)