|
11 | 11 | [id="cluster-logging-about_{context}"] |
12 | 12 | = About deploying the {logging-title} |
13 | 13 |
|
14 | | -ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] |
15 | | -{product-title} cluster administrators can deploy the {logging} using the {product-title} web console or CLI to install the OpenShift Elasticsearch Operator and Red Hat OpenShift Logging Operator. When the Operators are installed, you create a `ClusterLogging` custom resource (CR) to schedule {logging} pods and other resources necessary to support the {logging}. The Operators are responsible for deploying, upgrading, and maintaining the {logging}. |
16 | | -endif::openshift-enterprise,openshift-webscale,openshift-origin[] |
17 | | - |
18 | | -The `ClusterLogging` CR defines a complete {logging} environment that includes all the components of the logging stack to collect, store and visualize logs. The Red Hat OpenShift Logging Operator watches the {logging} CR and adjusts the logging deployment accordingly. |
| 14 | +Administrators can deploy the {logging} by using the {product-title} web console or the {oc-first} to install the {logging} Operators. The Operators are responsible for deploying, upgrading, and maintaining the {logging}. |
19 | 15 |
|
20 | 16 | Administrators and application developers can view the logs of the projects for which they have view access. |
| 17 | + |
| 18 | +[id="cluster-logging-about-custom-resources_{context}"] |
| 19 | +== Logging custom resources |
| 20 | + |
| 21 | +You can configure your {logging} deployment with custom resource (CR) YAML files implemented by each Operator. |
| 22 | + |
| 23 | +*Red Hat Openshift Logging Operator*: |
| 24 | + |
| 25 | +* `ClusterLogging` (CL) - After the Operators are installed, you create a `ClusterLogging` custom resource (CR) to schedule {logging} pods and other resources necessary to support the {logging}. The `ClusterLogging` CR deploys the collector and forwarder, which currently are both implemented by a daemonset running on each node. The Red Hat OpenShift Logging Operator watches the `ClusterLogging` CR and adjusts the logging deployment accordingly. |
| 26 | + |
| 27 | +* `ClusterLogForwarder` (CLF) - Generates collector configuration to forward logs per user configuration. |
| 28 | + |
| 29 | +*Loki Operator*: |
| 30 | + |
| 31 | +* `LokiStack` - Controls the Loki cluster as log store and the web proxy with OpenShift Container Platform authentication integration to enforce multi-tenancy. |
| 32 | + |
| 33 | +*OpenShift Elasticsearch Operator*: |
| 34 | + |
| 35 | +[NOTE] |
| 36 | +==== |
| 37 | +These CRs are generated and managed by the Red Hat OpenShift Elasticsearch Operator. Manual changes cannot be made without being overwritten by the Operator. |
| 38 | +==== |
| 39 | + |
| 40 | +* `ElasticSearch` - Configure and deploy an Elasticsearch instance as the default log store. |
| 41 | + |
| 42 | +* `Kibana` - Configure and deploy Kibana instance to search, query and view logs. |
0 commit comments