Skip to content

Commit f712806

Browse files
committed
OBSDOCS-460: Clean up about page and old references
1 parent 2cdf972 commit f712806

7 files changed

+38
-80
lines changed

logging/cluster-logging.adoc

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,7 @@ toc::[]
99

1010
As a cluster administrator, you can deploy {logging} on an {product-title} cluster, and use it to collect and aggregate node system audit logs, application container logs, and infrastructure logs. You can forward logs to your chosen log outputs, including on-cluster, Red{nbsp}Hat managed log storage. You can also visualize your log data in the {product-title} web console, or xref:../logging/cluster-logging-visualizer.adoc#cluster-logging-visualizer[the Kibana web console], depending on your deployed log storage solution.
1111

12-
[IMPORTANT]
13-
====
14-
The Kibana web console is now deprecated and will be removed in a future logging release.
15-
====
12+
include::snippets/logging-kibana-dep-snip.adoc[]
1613

1714
{product-title} cluster administrators can deploy the {logging} by using Operators. For information, see xref:../logging/cluster-logging-deploying.adoc#cluster-logging-deploying[Installing the {logging-title}].
1815

@@ -39,26 +36,16 @@ include::modules/cluster-logging-collecting-storing-kubernetes-events.adoc[level
3936

4037
For information, see xref:../logging/log_collection_forwarding/cluster-logging-eventrouter.adoc#cluster-logging-eventrouter[About collecting and storing Kubernetes events].
4138

42-
include::modules/cluster-logging-update-logging.adoc[leveloffset=+2]
43-
44-
For information, see xref:../logging/cluster-logging-upgrading.adoc#cluster-logging-upgrading[Updating OpenShift Logging].
45-
4639
include::modules/cluster-logging-view-cluster-dashboards.adoc[leveloffset=+2]
4740

4841
For information, see xref:../logging/cluster-logging-dashboards.adoc#cluster-logging-dashboards[About viewing the cluster dashboard].
4942

5043
include::modules/cluster-logging-troubleshoot-logging.adoc[leveloffset=+2]
5144

52-
include::modules/cluster-logging-Uninstall-logging.adoc[leveloffset=+2]
53-
54-
For information, see xref:../logging/cluster-logging-uninstall.adoc#cluster-logging-uninstall_cluster-logging-uninstall[Uninstalling OpenShift Logging].
55-
5645
include::modules/cluster-logging-export-fields.adoc[leveloffset=+2]
5746

5847
For information, see xref:../logging/cluster-logging-exported-fields.adoc#cluster-logging-exported-fields[About exporting fields].
5948

60-
include::modules/cluster-logging-about-components.adoc[leveloffset=+2]
61-
6249
include::modules/cluster-logging-about-collector.adoc[leveloffset=+2]
6350

6451
For information, see xref:../logging/log_collection_forwarding/cluster-logging-collector.adoc#cluster-logging-collector[Configuring the logging collector].

modules/cluster-logging-Uninstall-logging.adoc

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

modules/cluster-logging-about-components.adoc

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

modules/cluster-logging-feature-reference.adoc

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,10 @@ The following outputs are supported:
1313
1414
* `loki`. Loki, a horizontally scalable, highly available, multitenant log aggregation system.
1515
16-
1716
[id="cluster-logging-vector-enable_{context}"]
1817
== Enabling Vector
19-
Vector is not enabled by default. Use the following steps to enable Vector on your {product-title} cluster.
20-
21-
[IMPORTANT]
22-
====
23-
Vector does not support FIPS Enabled Clusters.
24-
====
25-
26-
.Prerequisites
2718

28-
* {product-title}: {product-version}
29-
* {logging-title-uc}: 5.4
30-
* FIPS disabled
19+
Use the following steps to enable Vector on your {product-title} cluster.
3120

3221
.Procedure
3322

modules/cluster-logging-update-logging.adoc

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

modules/logging-architecture-overview.adoc

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,30 @@
66
[id="logging-architecture-overview_{context}"]
77
= Logging architecture
88

9-
The {logging} consists of these logical components:
10-
11-
* `Collector` - Reads container log data from each node and forwards log data to configured outputs.
12-
13-
* `Store` - Stores log data for analysis; the default output for the forwarder.
14-
15-
* `Visualization` - Graphical interface for searching, querying, and viewing stored logs.
16-
17-
These components are managed by Operators and Custom Resource (CR) YAML files.
9+
The major components of the {logging} are:
10+
11+
Collector:: The collector is a daemonset that deploys pods to each {product-title} node. It collects log data from each node, transforms the data, and forwards it to configured outputs. You can use the Vector collector or the legacy Fluentd collector.
12+
+
13+
--
14+
include::snippets/logging-fluentd-dep-snip.adoc[]
15+
--
16+
17+
Log store:: The log store stores log data for analysis and is the default output for the log forwarder. You can use the default LokiStack log store, the legacy Elasticsearch log store, or forward logs to additional external log stores.
18+
+
19+
--
20+
include::snippets/logging-elastic-dep-snip.adoc[]
21+
--
22+
23+
Visualization:: You can use a UI component to view a visual representation of your log data. The UI provides a graphical interface to search, query, and view stored logs. If you are using LokiStack as the default log storage, the {product-title} web console UI is provided by enabling the {product-title} console plugin. If you are using Elasticsearch as the default log storage, you can use Kibana.
24+
+
25+
--
26+
include::snippets/logging-kibana-dep-snip.adoc[]
27+
--
1828

1929
The {logging-title} collects container logs and node logs. These are categorized into types:
2030

21-
* `application` - Container logs generated by user applications running in the cluster, except infrastructure container applications.
22-
23-
* `infrastructure` - Logs generated by infrastructure components running in the cluster and {product-title} nodes, such as journal logs. Infrastructure components are pods that run in the `openshift*`, `kube*`, or `default` projects.
24-
25-
* `audit` - Logs generated by auditd, the node audit system, which are stored in the */var/log/audit/audit.log* file, and logs from the `auditd`, `kube-apiserver`, `openshift-apiserver` projects, as well as the `ovn` project if enabled.
31+
Application logs:: Container logs generated by user applications running in the cluster, except infrastructure container applications.
2632

27-
The logging collector is a daemonset that deploys pods to each {product-title} node. System and infrastructure logs are generated by journald log messages from the operating system, the container runtime, and {product-title}.
33+
Infrastructure logs:: Container logs generated by infrastructure namespaces: `openshift*`, `kube*`, or `default`, as well as journald messages from nodes.
2834

29-
Container logs are generated by containers running in pods running on the cluster. Each container generates a separate log stream. The collector collects the logs from these sources and forwards them internally or externally as configured in the `ClusterLogForwarder` custom resource.
35+
Audit logs:: Logs generated by auditd, the node audit system, which are stored in the */var/log/audit/audit.log* file, and logs from the `auditd`, `kube-apiserver`, `openshift-apiserver` services, as well as the `ovn` project if enabled.

snippets/logging-kibana-dep-snip.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Text snippet included in the following assemblies:
2+
//
3+
// logging/cluster-logging.adoc
4+
//
5+
// Text snippet included in the following modules:
6+
//
7+
//
8+
9+
:_content-type: SNIPPET
10+
11+
[NOTE]
12+
====
13+
The Kibana web console is now deprecated is planned to be removed in a future logging release.
14+
====

0 commit comments

Comments
 (0)