Skip to content

Commit b0e3029

Browse files
jcantrillopenshift-merge-bot[bot]
authored andcommitted
Update README.adoc
Update readme for 6.2
1 parent 6dbe128 commit b0e3029

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

README.adoc

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,41 @@
11
= Cluster Logging Operator
22

3-
An operator to support OKD aggregated cluster logging. Cluster logging configuration information
4-
is found in the link:./docs/administration/configuration.md[configuration] documentation.
3+
An operator to support log collection and forwarding on OpenShift clusters. Cluster logging configuration information
4+
is found in the link:./docs/administration/configuration.md[configuration] documentation. This
5+
operator is solely responsible for configuring log collection and forwarding. It works in conjunction
6+
with the deployment of a LokiStack via the https://github.com/openshift/loki-operator[loki-operator]. The loki-operator is responsible for log storage.
57

68
== Overview
79

8-
The CLO (Cluster Logging Operator) provides a set of APIs to control collection and forwarding of logs from
10+
The Cluster Logging Operator (CLO) provides a set of APIs to control collection and forwarding of logs from
911
all pods and nodes in a cluster. This includes _application_ logs (from regular
1012
pods), _infrastructure_ logs (from system pods and node logs), and _audit_ logs
1113
(special node logs with legal/security implications)
1214

13-
The CLO does not collect or forward logs itself: it starts, configures, monitors
14-
and manages the components that do the work.
15+
The CLO deploys:
1516

16-
CLO currently uses:
17+
* A log collector/forwarder (current implimentation is https://vector.dev/[Vector])
1718

18-
* Vector as collector/forwarder
19-
* Loki as store
20-
* Openshift console for visualization.
19+
and relies upon:
2120

22-
(Still supports fluentd, elasticsearch and kibana for compatibility)
21+
* Loki as a log storage engine
22+
* The https://github.com/rhobs/observability-operator[cluster-obervability-operator] (COO) to provide a visualization plugin to the Openshift console.
2323

24-
The goal is to _encapsulate_ those technologies behind APIs so that:
24+
The goal is to _abstract_ away the deployment and configuration of these technologies behind APIs so that:
2525

26-
. The user has less to learn, and has a simpler experience to control logging.
27-
. These technologies can be replaced in the future without affecting the user experience.
26+
* A user has a simplified logging experience
27+
* A user has less to learn
28+
* Technologies can be replaced in the future without affecting the user experience.
2829

2930
The CLO can also _forward_ logs over multiple protocols, to multiple types of log stores, on- or off-cluster
3031

3132
The CLO _owns_ the following APIs:
3233

33-
* ClusterLogging: Top level control of cluster-wide logging resources
3434
* ClusterLogForwarder: Configure forwarding of logs to external sources
35+
* LogFileMetricsExporter: Configure deployment of a component to monitor the volume of logs generated by container workloads
3536

36-
To install a released version of cluster logging see the https://docs.openshift.com/[Openshift Documentation], (e.g., https://docs.openshift.com/container-platform/4.5/logging/cluster-logging-deploying.html[OCP v4.5])
37-
38-
To experiment or contribute to the development of cluster logging, see the link:docs/contributing/README.adoc[hacking] and link:docs/contributing/REVIEW.adoc[review] documentation
39-
40-
To debug the cluster logging stack, see link:./must-gather/README.md[README.md]
41-
42-
To find currently known Cluster Logging Operator issues with work-arounds, see the link:docs/administration/troubleshooting.md[Troubleshooting] guide.
37+
== Getting Started ==
38+
* To install a released version of cluster logging see the https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/logging/index[Openshift Logging Documentation]
39+
* To experiment or contribute to the development of cluster logging, see the link:docs/contributing/README.adoc[hacking] and link:docs/contributing/REVIEW.adoc[review] documentation
40+
* To debug the cluster logging stack, see link:./must-gather/README.md[README.md]
41+
* To find currently known Cluster Logging Operator issues with work-arounds, see the link:docs/administration/troubleshooting.md[Troubleshooting] guide.

0 commit comments

Comments
 (0)