Skip to content

Commit 5bb0ced

Browse files
authored
Merge pull request #95616 from EricPonvelle/OSDOCS-14125_Logging-Review
OSDOCS-14125: Updated Logging to remove <6.0 content
2 parents 08e6008 + 6800a62 commit 5bb0ced

File tree

6 files changed

+121
-209
lines changed

6 files changed

+121
-209
lines changed

_topic_maps/_topic_map_rosa.yml

Lines changed: 47 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1554,116 +1554,59 @@ Topics:
15541554
Dir: logging
15551555
Distros: openshift-rosa
15561556
Topics:
1557-
- Name: Release notes
1558-
Dir: logging_release_notes
1559-
Topics:
1560-
- Name: Logging 5.9
1561-
File: logging-5-9-release-notes
1562-
- Name: Logging 5.8
1563-
File: logging-5-8-release-notes
1564-
- Name: Logging 5.7
1565-
File: logging-5-7-release-notes
1566-
- Name: Support
1567-
File: cluster-logging-support
1568-
- Name: Troubleshooting logging
1569-
Dir: troubleshooting
1570-
Topics:
1571-
- Name: Viewing Logging status
1572-
File: cluster-logging-cluster-status
1573-
- Name: Troubleshooting log forwarding
1574-
File: log-forwarding-troubleshooting
1575-
- Name: Troubleshooting logging alerts
1576-
File: troubleshooting-logging-alerts
1577-
- Name: Viewing the status of the Elasticsearch log store
1578-
File: cluster-logging-log-store-status
15791557
- Name: About Logging
1580-
File: cluster-logging
1581-
- Name: Installing Logging
1582-
File: cluster-logging-deploying
1583-
- Name: Updating Logging
1584-
File: cluster-logging-upgrading
1585-
- Name: Visualizing logs
1586-
Dir: log_visualization
1587-
Topics:
1588-
- Name: About log visualization
1589-
File: log-visualization
1590-
- Name: Log visualization with the web console
1591-
File: log-visualization-ocp-console
1592-
- Name: Viewing cluster dashboards
1593-
File: cluster-logging-dashboards
1594-
- Name: Log visualization with Kibana
1595-
File: logging-kibana
1596-
- Name: Configuring your Logging deployment
1597-
Dir: config
1598-
Topics:
1599-
- Name: Configuring CPU and memory limits for Logging components
1600-
File: cluster-logging-memory
1601-
#- Name: Configuring systemd-journald and Fluentd
1602-
# File: cluster-logging-systemd
1603-
- Name: Log collection and forwarding
1604-
Dir: log_collection_forwarding
1558+
File: about-logging
1559+
- Name: Logging 6.2
1560+
Dir: logging-6.2
16051561
Topics:
1606-
- Name: About log collection and forwarding
1607-
File: log-forwarding
1608-
- Name: Log output types
1609-
File: logging-output-types
1610-
- Name: Enabling JSON log forwarding
1611-
File: cluster-logging-enabling-json-logging
1562+
- Name: Support
1563+
File: log62-cluster-logging-support
1564+
- Name: Release notes
1565+
File: log6x-release-notes-6.2
1566+
- Name: About logging 6.2
1567+
File: log6x-about-6.2
16121568
- Name: Configuring log forwarding
1613-
File: configuring-log-forwarding
1569+
File: log6x-clf-6.2
16141570
- Name: Configuring the logging collector
1615-
File: cluster-logging-collector
1616-
- Name: Collecting and storing Kubernetes events
1617-
File: cluster-logging-eventrouter
1618-
- Name: Log storage
1619-
Dir: log_storage
1571+
File: 6x-cluster-logging-collector-6.2
1572+
- Name: Configuring LokiStack storage
1573+
File: log6x-loki-6.2
1574+
- Name: Configuring LokiStack for OTLP
1575+
File: log6x-configuring-lokistack-otlp-6.2
1576+
- Name: Visualization for logging
1577+
File: log6x-visual-6.2
1578+
- Name: Logging 6.1
1579+
Dir: logging-6.1
16201580
Topics:
1621-
- Name: About log storage
1622-
File: about-log-storage
1623-
- Name: Installing log storage
1624-
File: installing-log-storage
1625-
- Name: Configuring the LokiStack log store
1626-
File: cluster-logging-loki
1627-
- Name: Configuring the Elasticsearch log store
1628-
File: logging-config-es-store
1629-
- Name: Logging alerts
1630-
Dir: logging_alerts
1631-
Topics:
1632-
- Name: Default logging alerts
1633-
File: default-logging-alerts
1634-
- Name: Custom logging alerts
1635-
File: custom-logging-alerts
1636-
- Name: Performance and reliability tuning
1637-
Dir: performance_reliability
1638-
Topics:
1639-
- Name: Flow control mechanisms
1640-
File: logging-flow-control-mechanisms
1641-
- Name: Filtering logs by content
1642-
File: logging-content-filtering
1643-
- Name: Filtering logs by metadata
1644-
File: logging-input-spec-filtering
1645-
- Name: Scheduling resources
1646-
Dir: scheduling_resources
1647-
Topics:
1648-
- Name: Using node selectors to move logging resources
1649-
File: logging-node-selectors
1650-
- Name: Using tolerations to control logging pod placement
1651-
File: logging-taints-tolerations
1652-
- Name: Uninstalling Logging
1653-
File: cluster-logging-uninstall
1654-
- Name: Exported fields
1655-
File: cluster-logging-exported-fields
1656-
- Name: API reference
1657-
Dir: api_reference
1581+
- Name: Release notes
1582+
File: log6x-release-notes-6.1
1583+
- Name: About logging 6.1
1584+
File: log6x-about-6.1
1585+
- Name: Configuring log forwarding
1586+
File: log6x-clf-6.1
1587+
- Name: Configuring LokiStack storage
1588+
File: log6x-loki-6.1
1589+
- Name: Configuring LokiStack for OTLP
1590+
File: log6x-configuring-lokistack-otlp-6.1
1591+
- Name: OpenTelemetry data model
1592+
File: log6x-opentelemetry-data-model-6.1
1593+
- Name: Visualization for logging
1594+
File: log6x-visual-6.1
1595+
- Name: Logging 6.0
1596+
Dir: logging-6.0
16581597
Topics:
1659-
# - Name: 5.8 Logging API reference
1660-
# File: logging-5-8-reference
1661-
# - Name: 5.7 Logging API reference
1662-
# File: logging-5-7-reference
1663-
- Name: 5.6 Logging API reference
1664-
File: logging-5-6-reference
1665-
- Name: Glossary
1666-
File: logging-common-terms
1598+
- Name: Release notes
1599+
File: log6x-release-notes
1600+
- Name: About logging 6.0
1601+
File: log6x-about
1602+
- Name: Upgrading to Logging 6.0
1603+
File: log6x-upgrading-to-6
1604+
- Name: Configuring log forwarding
1605+
File: log6x-clf
1606+
- Name: Configuring LokiStack storage
1607+
File: log6x-loki
1608+
- Name: Visualization for logging
1609+
File: log6x-visual
16671610
---
16681611
Name: Service Mesh
16691612
Dir: service_mesh

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 47 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1217,116 +1217,59 @@ Topics:
12171217
Dir: logging
12181218
Distros: openshift-rosa-hcp
12191219
Topics:
1220-
- Name: Release notes
1221-
Dir: logging_release_notes
1222-
Topics:
1223-
- Name: Logging 5.9
1224-
File: logging-5-9-release-notes
1225-
- Name: Logging 5.8
1226-
File: logging-5-8-release-notes
1227-
- Name: Logging 5.7
1228-
File: logging-5-7-release-notes
1229-
- Name: Support
1230-
File: cluster-logging-support
1231-
- Name: Troubleshooting logging
1232-
Dir: troubleshooting
1233-
Topics:
1234-
- Name: Viewing Logging status
1235-
File: cluster-logging-cluster-status
1236-
- Name: Troubleshooting log forwarding
1237-
File: log-forwarding-troubleshooting
1238-
- Name: Troubleshooting logging alerts
1239-
File: troubleshooting-logging-alerts
1240-
- Name: Viewing the status of the Elasticsearch log store
1241-
File: cluster-logging-log-store-status
12421220
- Name: About Logging
1243-
File: cluster-logging
1244-
- Name: Installing Logging
1245-
File: cluster-logging-deploying
1246-
- Name: Updating Logging
1247-
File: cluster-logging-upgrading
1248-
- Name: Visualizing logs
1249-
Dir: log_visualization
1250-
Topics:
1251-
- Name: About log visualization
1252-
File: log-visualization
1253-
- Name: Log visualization with the web console
1254-
File: log-visualization-ocp-console
1255-
- Name: Viewing cluster dashboards
1256-
File: cluster-logging-dashboards
1257-
- Name: Log visualization with Kibana
1258-
File: logging-kibana
1259-
- Name: Configuring your Logging deployment
1260-
Dir: config
1261-
Topics:
1262-
- Name: Configuring CPU and memory limits for Logging components
1263-
File: cluster-logging-memory
1264-
#- Name: Configuring systemd-journald and Fluentd
1265-
# File: cluster-logging-systemd
1266-
- Name: Log collection and forwarding
1267-
Dir: log_collection_forwarding
1221+
File: about-logging
1222+
- Name: Logging 6.2
1223+
Dir: logging-6.2
12681224
Topics:
1269-
- Name: About log collection and forwarding
1270-
File: log-forwarding
1271-
- Name: Log output types
1272-
File: logging-output-types
1273-
- Name: Enabling JSON log forwarding
1274-
File: cluster-logging-enabling-json-logging
1225+
- Name: Support
1226+
File: log62-cluster-logging-support
1227+
- Name: Release notes
1228+
File: log6x-release-notes-6.2
1229+
- Name: About logging 6.2
1230+
File: log6x-about-6.2
12751231
- Name: Configuring log forwarding
1276-
File: configuring-log-forwarding
1232+
File: log6x-clf-6.2
12771233
- Name: Configuring the logging collector
1278-
File: cluster-logging-collector
1279-
- Name: Collecting and storing Kubernetes events
1280-
File: cluster-logging-eventrouter
1281-
- Name: Log storage
1282-
Dir: log_storage
1234+
File: 6x-cluster-logging-collector-6.2
1235+
- Name: Configuring LokiStack storage
1236+
File: log6x-loki-6.2
1237+
- Name: Configuring LokiStack for OTLP
1238+
File: log6x-configuring-lokistack-otlp-6.2
1239+
- Name: Visualization for logging
1240+
File: log6x-visual-6.2
1241+
- Name: Logging 6.1
1242+
Dir: logging-6.1
12831243
Topics:
1284-
- Name: About log storage
1285-
File: about-log-storage
1286-
- Name: Installing log storage
1287-
File: installing-log-storage
1288-
- Name: Configuring the LokiStack log store
1289-
File: cluster-logging-loki
1290-
- Name: Configuring the Elasticsearch log store
1291-
File: logging-config-es-store
1292-
- Name: Logging alerts
1293-
Dir: logging_alerts
1294-
Topics:
1295-
- Name: Default logging alerts
1296-
File: default-logging-alerts
1297-
- Name: Custom logging alerts
1298-
File: custom-logging-alerts
1299-
- Name: Performance and reliability tuning
1300-
Dir: performance_reliability
1301-
Topics:
1302-
- Name: Flow control mechanisms
1303-
File: logging-flow-control-mechanisms
1304-
- Name: Filtering logs by content
1305-
File: logging-content-filtering
1306-
- Name: Filtering logs by metadata
1307-
File: logging-input-spec-filtering
1308-
- Name: Scheduling resources
1309-
Dir: scheduling_resources
1310-
Topics:
1311-
- Name: Using node selectors to move logging resources
1312-
File: logging-node-selectors
1313-
- Name: Using tolerations to control logging pod placement
1314-
File: logging-taints-tolerations
1315-
- Name: Uninstalling Logging
1316-
File: cluster-logging-uninstall
1317-
- Name: Exported fields
1318-
File: cluster-logging-exported-fields
1319-
- Name: API reference
1320-
Dir: api_reference
1244+
- Name: Release notes
1245+
File: log6x-release-notes-6.1
1246+
- Name: About logging 6.1
1247+
File: log6x-about-6.1
1248+
- Name: Configuring log forwarding
1249+
File: log6x-clf-6.1
1250+
- Name: Configuring LokiStack storage
1251+
File: log6x-loki-6.1
1252+
- Name: Configuring LokiStack for OTLP
1253+
File: log6x-configuring-lokistack-otlp-6.1
1254+
- Name: OpenTelemetry data model
1255+
File: log6x-opentelemetry-data-model-6.1
1256+
- Name: Visualization for logging
1257+
File: log6x-visual-6.1
1258+
- Name: Logging 6.0
1259+
Dir: logging-6.0
13211260
Topics:
1322-
# - Name: 5.8 Logging API reference
1323-
# File: logging-5-8-reference
1324-
# - Name: 5.7 Logging API reference
1325-
# File: logging-5-7-reference
1326-
- Name: 5.6 Logging API reference
1327-
File: logging-5-6-reference
1328-
- Name: Glossary
1329-
File: logging-common-terms
1261+
- Name: Release notes
1262+
File: log6x-release-notes
1263+
- Name: About logging 6.0
1264+
File: log6x-about
1265+
- Name: Upgrading to Logging 6.0
1266+
File: log6x-upgrading-to-6
1267+
- Name: Configuring log forwarding
1268+
File: log6x-clf
1269+
- Name: Configuring LokiStack storage
1270+
File: log6x-loki
1271+
- Name: Visualization for logging
1272+
File: log6x-visual
13301273
---
13311274
Name: Service Mesh
13321275
Dir: service_mesh

observability/logging/logging-6.0/log6x-visual.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@
22
[id="log6x-visual"]
33
= Visualization for logging
44
include::_attributes/common-attributes.adoc[]
5+
include::_attributes/attributes-openshift-dedicated.adoc[]
56
:context: logging-6x
67

78
toc::[]
89

10+
ifndef::openshift-rosa,openshift-rosa-hcp[]
911
Visualization for logging is provided by deploying the xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[Logging UI Plugin] of the xref:../../../observability/cluster_observability_operator/cluster-observability-operator-overview.adoc#cluster-observability-operator-overview[Cluster Observability Operator], which requires Operator installation.
12+
endif::openshift-rosa,openshift-rosa-hcp[]
13+
ifdef::openshift-rosa,openshift-rosa-hcp[]
14+
Visualization for logging is provided by deploying the Logging UI Plugin of the Cluster Observability Operator, which requires Operator installation.
15+
endif::openshift-rosa,openshift-rosa-hcp[]
1016

1117
include::snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc[]

observability/logging/logging-6.1/log6x-visual-6.1.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,17 @@
22
[id="log6x-visual-6-1"]
33
= Visualization for logging
44
include::_attributes/common-attributes.adoc[]
5+
include::_attributes/attributes-openshift-dedicated.adoc[]
56
:context: logging-6x-6.1
67

78
toc::[]
89

10+
ifndef::openshift-rosa,openshift-rosa-hcp[]
911
Visualization for logging is provided by deploying the xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[Logging UI Plugin] of the xref:../../../observability/cluster_observability_operator/cluster-observability-operator-overview.adoc#cluster-observability-operator-overview[Cluster Observability Operator], which requires Operator installation.
12+
endif::openshift-rosa,openshift-rosa-hcp[]
13+
ifdef::openshift-rosa,openshift-rosa-hcp[]
14+
Visualization for logging is provided by deploying the Logging UI Plugin of the Cluster Observability Operator, which requires Operator installation.
15+
endif::openshift-rosa,openshift-rosa-hcp[]
16+
1017

1118
include::snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc[]

observability/logging/logging-6.2/log6x-visual-6.2.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@
22
[id="log6x-visual-6-2"]
33
= Visualization for logging
44
include::_attributes/common-attributes.adoc[]
5+
include::_attributes/attributes-openshift-dedicated.adoc[]
56
:context: logging-6x-6.2
67

78
toc::[]
89

10+
ifndef::openshift-rosa,openshift-rosa-hcp[]
911
Visualization for logging is provided by deploying the xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[Logging UI Plugin] of the xref:../../../observability/cluster_observability_operator/cluster-observability-operator-overview.adoc#cluster-observability-operator-overview[Cluster Observability Operator], which requires Operator installation.
12+
endif::openshift-rosa,openshift-rosa-hcp[]
13+
ifdef::openshift-rosa,openshift-rosa-hcp[]
14+
Visualization for logging is provided by deploying the Logging UI Plugin of the Cluster Observability Operator, which requires Operator installation.
15+
endif::openshift-rosa,openshift-rosa-hcp[]
1016

1117
include::snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc[]

snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,12 @@
66

77
[IMPORTANT]
88
====
9-
Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[Logging UI Plugin] on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA.
9+
Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its
10+
ifndef::openshift-rosa,openshift-rosa-hcp[]
11+
xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[Logging UI Plugin]
12+
endif::openshift-rosa,openshift-rosa-hcp[]
13+
ifdef::openshift-rosa,openshift-rosa-hcp[]
14+
Logging UI Plugin
15+
endif::openshift-rosa,openshift-rosa-hcp[]
16+
on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA.
1017
====

0 commit comments

Comments
 (0)