From 4d0237c0813dfd273dfe2b8820c91143b9a6cdaf Mon Sep 17 00:00:00 2001 From: libander Date: Tue, 26 Apr 2022 18:40:42 -0500 Subject: [PATCH] Deprecated files restored to fix build. --- logging/cluster-logging-deploying.adoc | 15 ++++++--------- logging/cluster-logging-eventrouter.adoc | 4 ++-- logging/cluster-logging-exported-fields.adoc | 4 +++- logging/cluster-logging-external.adoc | 4 ++-- logging/cluster-logging-release-notes.adoc | 6 +++--- logging/cluster-logging-uninstall.adoc | 2 +- logging/cluster-logging-upgrading.adoc | 12 ++++-------- logging/cluster-logging-visualizer.adoc | 6 ++---- logging/cluster-logging.adoc | 8 ++++---- logging/config/cluster-logging-collector.adoc | 2 +- .../config/cluster-logging-configuring-cr.adoc | 7 +------ logging/config/cluster-logging-configuring.adoc | 13 ++++++------- logging/config/cluster-logging-log-store.adoc | 2 +- .../cluster-logging-maintenance-support.adoc | 3 --- logging/config/cluster-logging-memory.adoc | 5 ++--- .../config/cluster-logging-moving-nodes.adoc | 2 +- .../cluster-logging-storage-considerations.adoc | 8 +++----- logging/config/cluster-logging-tolerations.adoc | 4 ++-- logging/config/cluster-logging-visualizer.adoc | 3 +-- logging/dedicated-cluster-logging.adoc | 8 +++----- .../troubleshooting/cluster-logging-alerts.adoc | 2 +- .../cluster-logging-cluster-status.adoc | 4 +--- .../cluster-logging-must-gather.adoc | 4 ++-- logging/viewing-resource-logs.adoc | 5 ++--- modules/cluster-logging-about-collector.adoc | 2 +- modules/cluster-logging-about-components.adoc | 9 ++++----- modules/cluster-logging-about-crd.adoc | 4 ++-- modules/cluster-logging-about-logstore.adoc | 7 +++---- modules/cluster-logging-about.adoc | 17 ++++++++--------- modules/cluster-logging-clo-status-comp.adoc | 12 ++++++------ modules/cluster-logging-clo-status.adoc | 2 +- ...luster-logging-collector-alerts-viewing.adoc | 2 +- ...ogging-collector-log-forward-cloudwatch.adoc | 2 +- ...er-logging-collector-log-forward-syslog.adoc | 1 + ...-logging-collector-log-forwarding-about.adoc | 4 ++-- .../cluster-logging-collector-tolerations.adoc | 2 +- modules/cluster-logging-collector-tuning.adoc | 2 +- ...cluster-logging-configuring-image-about.adoc | 5 ++--- modules/cluster-logging-cpu-memory.adoc | 2 +- modules/cluster-logging-deploy-cli.adoc | 6 +++--- modules/cluster-logging-deploy-console.adoc | 6 +++--- modules/cluster-logging-deploy-label.adoc | 2 +- modules/cluster-logging-deploy-multitenant.adoc | 2 +- ...r-logging-deploy-storage-considerations.adoc | 2 +- modules/cluster-logging-deploying-about.adoc | 13 ++++++------- .../cluster-logging-elasticsearch-audit.adoc | 2 +- .../cluster-logging-elasticsearch-exposing.adoc | 9 +++------ modules/cluster-logging-elasticsearch-ha.adoc | 2 +- ...-elasticsearch-persistent-storage-empty.adoc | 8 +++----- ...cluster-logging-elasticsearch-retention.adoc | 4 ++-- .../cluster-logging-elasticsearch-storage.adoc | 4 ++-- ...uster-logging-elasticsearch-tolerations.adoc | 2 +- modules/cluster-logging-eventrouter-about.adoc | 4 ++-- modules/cluster-logging-eventrouter-deploy.adoc | 2 +- modules/cluster-logging-forwarding-about.adoc | 3 +-- modules/cluster-logging-kibana-tolerations.adoc | 2 +- ...luster-logging-log-store-status-viewing.adoc | 2 +- modules/cluster-logging-logstore-limits.adoc | 2 +- ...uster-logging-maintenance-support-about.adoc | 4 ++-- .../cluster-logging-manual-rollout-rolling.adoc | 2 +- modules/cluster-logging-must-gather-about.adoc | 2 +- .../cluster-logging-must-gather-collecting.adoc | 6 +++--- modules/cluster-logging-uninstall.adoc | 6 +++--- modules/cluster-logging-visualizer-kibana.adoc | 2 +- modules/infrastructure-moving-logging.adoc | 4 ++-- 65 files changed, 137 insertions(+), 172 deletions(-) diff --git a/logging/cluster-logging-deploying.adoc b/logging/cluster-logging-deploying.adoc index f39a16f26261..66d5b19f22cc 100644 --- a/logging/cluster-logging-deploying.adoc +++ b/logging/cluster-logging-deploying.adoc @@ -1,20 +1,17 @@ :_content-type: ASSEMBLY :context: cluster-logging-deploying [id="cluster-logging-deploying"] -= Installing OpenShift Logging += Installing the {logging-title} include::_attributes/common-attributes.adoc[] toc::[] -You can install OpenShift Logging by deploying -the OpenShift Elasticsearch and Red Hat OpenShift Logging Operators. The OpenShift Elasticsearch Operator -creates and manages the Elasticsearch cluster used by OpenShift Logging. -The Red Hat OpenShift Logging Operator creates and manages the components of the logging stack. +You can install the {logging-title} by deploying the OpenShift Elasticsearch and Red Hat OpenShift Logging Operators. The OpenShift Elasticsearch Operator creates and manages the Elasticsearch cluster used by OpenShift Logging. The {logging} Operator creates and manages the components of the logging stack. -The process for deploying OpenShift Logging to {product-title} involves: +The process for deploying the {logging} to {product-title} involves: -* Reviewing the xref:../logging/config/cluster-logging-storage-considerations#cluster-logging-storage[OpenShift Logging storage considerations]. +* Reviewing the xref:../logging/config/cluster-logging-storage-considerations#cluster-logging-storage[{logging-uc} storage considerations]. * Installing the OpenShift Elasticsearch Operator and Red Hat OpenShift Logging Operator using the {product-title} xref:../logging/cluster-logging-deploying.adoc#cluster-logging-deploy-console_cluster-logging-deploying[web console] or xref:../logging/cluster-logging-deploying.adoc#cluster-logging-deploy-cli_cluster-logging-deploying[CLI]. @@ -34,7 +31,7 @@ include::modules/cluster-logging-deploy-console.adoc[leveloffset=+1] If you plan to use Kibana, you must xref:#cluster-logging-visualizer-indices_cluster-logging-deploying[manually create your Kibana index patterns and visualizations] to explore and visualize data in Kibana. -If your cluster network provider enforces network isolation, xref:#cluster-logging-deploy-multitenant_cluster-logging-deploying[allow network traffic between the projects that contain the OpenShift Logging operators]. +If your cluster network provider enforces network isolation, xref:#cluster-logging-deploy-multitenant_cluster-logging-deploying[allow network traffic between the projects that contain the {logging} Operators]. include::modules/cluster-logging-deploy-cli.adoc[leveloffset=+1] @@ -43,7 +40,7 @@ include::modules/cluster-logging-deploy-cli.adoc[leveloffset=+1] If you plan to use Kibana, you must xref:#cluster-logging-visualizer-indices_cluster-logging-deploying[manually create your Kibana index patterns and visualizations] to explore and visualize data in Kibana. -If your cluster network provider enforces network isolation, xref:#cluster-logging-deploy-multitenant_cluster-logging-deploying[allow network traffic between the projects that contain the OpenShift Logging operators]. +If your cluster network provider enforces network isolation, xref:#cluster-logging-deploy-multitenant_cluster-logging-deploying[allow network traffic between the projects that contain the {logging} Operators]. include::modules/cluster-logging-visualizer-indices.adoc[leveloffset=+2] diff --git a/logging/cluster-logging-eventrouter.adoc b/logging/cluster-logging-eventrouter.adoc index b05516a3c85d..c0397eee4000 100644 --- a/logging/cluster-logging-eventrouter.adoc +++ b/logging/cluster-logging-eventrouter.adoc @@ -6,9 +6,9 @@ include::_attributes/common-attributes.adoc[] toc::[] -The {product-title} Event Router is a pod that watches Kubernetes events and logs them for collection by OpenShift Logging. You must manually deploy the Event Router. +The {product-title} Event Router is a pod that watches Kubernetes events and logs them for collection by the {logging}. You must manually deploy the Event Router. -The Event Router collects events from all projects and writes them to `STDOUT`. Fluentd collects those events and forwards them into the {product-title} Elasticsearch instance. Elasticsearch indexes the events to the `infra` index. +The Event Router collects events from all projects and writes them to `STDOUT`. The collector then forwards those events to the store defined in the `ClusterLogForwarder` custom resource (CR). [IMPORTANT] ==== diff --git a/logging/cluster-logging-exported-fields.adoc b/logging/cluster-logging-exported-fields.adoc index e8b4922bfe7c..9d7cf2487ca2 100644 --- a/logging/cluster-logging-exported-fields.adoc +++ b/logging/cluster-logging-exported-fields.adoc @@ -6,12 +6,14 @@ include::_attributes/common-attributes.adoc[] toc::[] -The following fields can be present in log records exported by OpenShift Logging. Although log records are typically formatted as JSON objects, the same data model can be applied to other encodings. +The following fields can be present in log records exported by the {logging}. Although log records are typically formatted as JSON objects, the same data model can be applied to other encodings. To search these fields from Elasticsearch and Kibana, use the full dotted field name when searching. For example, with an Elasticsearch */_search URL*, to look for a Kubernetes pod name, use `/_search/q=kubernetes.pod_name:name-of-my-pod`. // The logging system can parse JSON-formatted log entries to external systems. These log entries are formatted as a fluentd message with extra fields such as `kubernetes`. The fields exported by the logging system and available for searching from Elasticsearch and Kibana are documented at the end of this document. include::modules/cluster-logging-exported-fields-top-level-fields.adoc[leveloffset=0] + include::modules/cluster-logging-exported-fields-kubernetes.adoc[leveloffset=0] + // add modules/cluster-logging-exported-fields-openshift when available diff --git a/logging/cluster-logging-external.adoc b/logging/cluster-logging-external.adoc index 1cdbda55f2fa..5b3c46ed0e6b 100644 --- a/logging/cluster-logging-external.adoc +++ b/logging/cluster-logging-external.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -By default, OpenShift Logging sends container and infrastructure logs to the default internal Elasticsearch log store defined in the `ClusterLogging` custom resource. However, it does not send audit logs to the internal store because it does not provide secure storage. If this default configuration meets your needs, you do not need to configure the Cluster Log Forwarder. +By default, the {logging} sends container and infrastructure logs to the default internal Elasticsearch log store defined in the `ClusterLogging` custom resource. However, it does not send audit logs to the internal store because it does not provide secure storage. If this default configuration meets your needs, you do not need to configure the Cluster Log Forwarder. To send logs to other log aggregators, you use the {product-title} Cluster Log Forwarder. This API enables you to send container, infrastructure, and audit logs to specific endpoints within or outside your cluster. In addition, you can send different types of logs to various systems so that various individuals can access each type. You can also enable Transport Layer Security (TLS) support to send logs securely, as required by your organization. @@ -15,7 +15,7 @@ To send logs to other log aggregators, you use the {product-title} Cluster Log F To send audit logs to the default internal Elasticsearch log store, use the Cluster Log Forwarder as described in xref:../logging/config/cluster-logging-log-store.adoc#cluster-logging-elasticsearch-audit_cluster-logging-store[Forward audit logs to the log store]. ==== -When you forward logs externally, the Red Hat OpenShift Logging Operator creates or modifies a Fluentd config map to send logs using your desired protocols. You are responsible for configuring the protocol on the external log aggregator. +When you forward logs externally, the {logging} creates or modifies a Fluentd config map to send logs using your desired protocols. You are responsible for configuring the protocol on the external log aggregator. [IMPORTANT] ==== diff --git a/logging/cluster-logging-release-notes.adoc b/logging/cluster-logging-release-notes.adoc index b7c16521ca97..9975ed2e7e6f 100644 --- a/logging/cluster-logging-release-notes.adoc +++ b/logging/cluster-logging-release-notes.adoc @@ -8,9 +8,9 @@ toc::[] include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] -[id="cluster-logging-supported-versions"] -== Supported Versions -include::modules/cluster-logging-supported-versions.adoc[leveloffset=+1] +[id="cluster-logging-ocp-compatibility"] += {product-title} compatibility +The {logging-title} is provided as an installable component, with a distinct release cycle from the core {product-title}. The link:https://access.redhat.com/support/policy/updates/openshift#logging[Red Hat OpenShift Container Platform Life Cycle Policy] outlines release compatibility. // Release Notes by version [id="cluster-logging-release-notes-5-3-0"] diff --git a/logging/cluster-logging-uninstall.adoc b/logging/cluster-logging-uninstall.adoc index 69b2e742504a..1b1aeaded2c3 100644 --- a/logging/cluster-logging-uninstall.adoc +++ b/logging/cluster-logging-uninstall.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -You can remove OpenShift Logging from your {product-title} cluster. +You can remove the {logging} from your {product-title} cluster. // The following include statements pull in the module files that comprise // the assembly. Include any combination of concept, procedure, or reference diff --git a/logging/cluster-logging-upgrading.adoc b/logging/cluster-logging-upgrading.adoc index 3b068369b8dc..d571c4f3cf24 100644 --- a/logging/cluster-logging-upgrading.adoc +++ b/logging/cluster-logging-upgrading.adoc @@ -6,14 +6,9 @@ include::_attributes/common-attributes.adoc[] toc::[] -.{product-title} version support for Red Hat OpenShift Logging (RHOL) -[options="header"] -|==== -| |4.7 |4.8 |4.9 -|RHOL 5.0|X |X | -|RHOL 5.1|X |X | -|RHOL 5.2|X |X |X -|==== +[id="cluster-logging-supported-versions"] +== Supported Versions +For version compatibility and support information, see link:https://access.redhat.com/support/policy/updates/openshift#logging[Red Hat OpenShift Container Platform Life Cycle Policy] To upgrade from cluster logging in {product-title} version 4.6 and earlier to OpenShift Logging 5.x, you update the {product-title} cluster to version 4.7 or 4.8. Then, you update the following operators: @@ -23,4 +18,5 @@ To upgrade from cluster logging in {product-title} version 4.6 and earlier to Op To upgrade from a previous version of OpenShift Logging to the current version, you update OpenShift Elasticsearch Operator and Red Hat OpenShift Logging Operator to their current versions. include::modules/cluster-logging-updating-logging-to-5-0.adoc[leveloffset=+1] + include::modules/cluster-logging-updating-logging-to-5-1.adoc[leveloffset=+1] diff --git a/logging/cluster-logging-visualizer.adoc b/logging/cluster-logging-visualizer.adoc index 2f643db68f6b..6ded5d71ff00 100644 --- a/logging/cluster-logging-visualizer.adoc +++ b/logging/cluster-logging-visualizer.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -OpenShift Logging includes a web console for visualizing collected log data. Currently, {product-title} deploys the Kibana console for visualization. +The {logging} includes a web console for visualizing collected log data. Currently, {product-title} deploys the Kibana console for visualization. Using the log visualizer, you can do the following with your data: @@ -15,7 +15,7 @@ Using the log visualizer, you can do the following with your data: * create and view custom dashboards using the *Dashboard* tab. Use and configuration of the Kibana interface is beyond the scope of this documentation. For more information, -on using the interface, see the link:https://www.elastic.co/guide/en/kibana/6.8/connect-to-elasticsearch.html[Kibana documentation]. +on using the interface, see the link:https://www.elastic.co/guide/en/kibana/6.8/connect-to-elasticsearch.html[Kibana documentation]. [NOTE] ==== @@ -29,5 +29,3 @@ The audit logs are not stored in the internal {product-title} Elasticsearch inst include::modules/cluster-logging-visualizer-indices.adoc[leveloffset=+1] include::modules/cluster-logging-visualizer-kibana.adoc[leveloffset=+1] - - diff --git a/logging/cluster-logging.adoc b/logging/cluster-logging.adoc index 216624089b34..9356f80167cf 100644 --- a/logging/cluster-logging.adoc +++ b/logging/cluster-logging.adoc @@ -1,7 +1,7 @@ :_content-type: ASSEMBLY :context: cluster-logging [id="cluster-logging"] -= Understanding Red Hat OpenShift Logging += Understanding the {logging-title} include::_attributes/common-attributes.adoc[] toc::[] @@ -9,11 +9,11 @@ toc::[] ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] -As a cluster administrator, you can deploy OpenShift Logging to +As a cluster administrator, you can deploy the {logging} to aggregate all the logs from your {product-title} cluster, such as node system audit logs, application container logs, and infrastructure logs. -OpenShift Logging aggregates these logs from throughout your cluster and stores them in a default log store. You can xref:../logging/cluster-logging-visualizer.adoc#cluster-logging-visualizer[use the Kibana web console to visualize log data]. +The {logging} aggregates these logs from throughout your cluster and stores them in a default log store. You can xref:../logging/cluster-logging-visualizer.adoc#cluster-logging-visualizer[use the Kibana web console to visualize log data]. -OpenShift Logging aggregates the following types of logs: +The {logging} aggregates the following types of logs: * `application` - Container logs generated by user applications running in the cluster, except infrastructure container applications. * `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. diff --git a/logging/config/cluster-logging-collector.adoc b/logging/config/cluster-logging-collector.adoc index 53f661f583a2..237b8f38351b 100644 --- a/logging/config/cluster-logging-collector.adoc +++ b/logging/config/cluster-logging-collector.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -{product-title} uses Fluentd to collect operations and application logs from your cluster and enriches the data with Kubernetes pod and project metadata. +{logging-title-uc} collects operations and application logs from your cluster and enriches the data with Kubernetes pod and project metadata. You can configure the CPU and memory limits for the log collector and xref:../../logging/config/cluster-logging-moving-nodes.adoc#cluster-logging-moving[move the log collector pods to specific nodes]. All supported modifications to the log collector can be performed though the `spec.collection.log.fluentd` stanza in the `ClusterLogging` custom resource (CR). diff --git a/logging/config/cluster-logging-configuring-cr.adoc b/logging/config/cluster-logging-configuring-cr.adoc index dd2855623d46..4cb8c3f1d142 100644 --- a/logging/config/cluster-logging-configuring-cr.adoc +++ b/logging/config/cluster-logging-configuring-cr.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -To configure OpenShift Logging, you customize the `ClusterLogging` custom resource (CR). +To configure {logging-title} you customize the `ClusterLogging` custom resource (CR). // The following include statements pull in the module files that comprise // the assembly. Include any combination of concept, procedure, or reference @@ -14,8 +14,3 @@ To configure OpenShift Logging, you customize the `ClusterLogging` custom resour // assemblies. include::modules/cluster-logging-about-crd.adoc[leveloffset=+1] - - - - - diff --git a/logging/config/cluster-logging-configuring.adoc b/logging/config/cluster-logging-configuring.adoc index fe4f1ed15aa7..251f7e03d361 100644 --- a/logging/config/cluster-logging-configuring.adoc +++ b/logging/config/cluster-logging-configuring.adoc @@ -6,14 +6,13 @@ include::_attributes/common-attributes.adoc[] toc::[] -OpenShift Logging is configurable using a `ClusterLogging` custom resource (CR) deployed +{logging-title-uc} is configurable using a `ClusterLogging` custom resource (CR) deployed in the `openshift-logging` project. -The Red Hat OpenShift Logging Operator watches for changes to `ClusterLogging` CR, +The {logging} operator watches for changes to `ClusterLogging` CR, creates any missing logging components, and adjusts the logging environment accordingly. -The `ClusterLogging` CR is based on the `ClusterLogging` custom resource definition (CRD), which defines a complete OpenShift Logging environment -and includes all the components of the logging stack to collect, store and visualize logs. +The `ClusterLogging` CR is based on the `ClusterLogging` custom resource definition (CRD), which defines a complete {logging} environment and includes all the components of the logging stack to collect, store and visualize logs. .Sample `ClusterLogging` custom resource (CR) [source,yaml] @@ -53,9 +52,9 @@ spec: resources: null type: kibana ---- -You can configure the following for OpenShift Logging: +You can configure the following for the {logging}: -* You can overwrite the image for each OpenShift Logging component by modifying the appropriate +* You can overwrite the image for each {logging} component by modifying the appropriate environment variable in the `cluster-logging-operator` Deployment. * You can specify specific nodes for the logging components using node selectors. @@ -78,5 +77,5 @@ The Rsyslog log collector is currently a Technology Preview feature. [IMPORTANT] ==== -The logging routes are managed by the Red Hat OpenShift Logging Operator and cannot be modified by the user. +The logging routes are managed by the {logging-title} Operator and cannot be modified by the user. ==== diff --git a/logging/config/cluster-logging-log-store.adoc b/logging/config/cluster-logging-log-store.adoc index f9cef0ea667c..a0ef02ff54d2 100644 --- a/logging/config/cluster-logging-log-store.adoc +++ b/logging/config/cluster-logging-log-store.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -{product-title} uses Elasticsearch 6 (ES) to store and organize the log data. +{logging-title-uc} uses Elasticsearch 6 (ES) to store and organize the log data. You can make modifications to your log store, including: diff --git a/logging/config/cluster-logging-maintenance-support.adoc b/logging/config/cluster-logging-maintenance-support.adoc index ceda0ec50b4e..fba711d9d4be 100644 --- a/logging/config/cluster-logging-maintenance-support.adoc +++ b/logging/config/cluster-logging-maintenance-support.adoc @@ -11,6 +11,3 @@ include::modules/cluster-logging-maintenance-support-about.adoc[leveloffset=+1] include::modules/cluster-logging-maintenance-support-list.adoc[leveloffset=+1] include::modules/unmanaged-operators.adoc[leveloffset=+1] - - - diff --git a/logging/config/cluster-logging-memory.adoc b/logging/config/cluster-logging-memory.adoc index 24fac411749b..154fd68985c4 100644 --- a/logging/config/cluster-logging-memory.adoc +++ b/logging/config/cluster-logging-memory.adoc @@ -1,13 +1,13 @@ :_content-type: ASSEMBLY :context: cluster-logging-memory [id="cluster-logging-memory"] -= Configuring CPU and memory limits for OpenShift Logging components += Configuring CPU and memory limits for {logging} components include::_attributes/common-attributes.adoc[] toc::[] -You can configure both the CPU and memory limits for each of the OpenShift Logging components as needed. +You can configure both the CPU and memory limits for each of the {logging} components as needed. // The following include statements pull in the module files that comprise @@ -17,4 +17,3 @@ You can configure both the CPU and memory limits for each of the OpenShift Loggi include::modules/cluster-logging-cpu-memory.adoc[leveloffset=+1] - diff --git a/logging/config/cluster-logging-moving-nodes.adoc b/logging/config/cluster-logging-moving-nodes.adoc index e6493fdc3fc0..89ca4a5032be 100644 --- a/logging/config/cluster-logging-moving-nodes.adoc +++ b/logging/config/cluster-logging-moving-nodes.adoc @@ -1,7 +1,7 @@ :_content-type: ASSEMBLY :context: cluster-logging-moving [id="cluster-logging-moving"] -= Moving OpenShift Logging resources with node selectors += Moving {logging} resources with node selectors include::_attributes/common-attributes.adoc[] toc::[] diff --git a/logging/config/cluster-logging-storage-considerations.adoc b/logging/config/cluster-logging-storage-considerations.adoc index 88c1fe9f11d7..83d432692e54 100644 --- a/logging/config/cluster-logging-storage-considerations.adoc +++ b/logging/config/cluster-logging-storage-considerations.adoc @@ -1,16 +1,14 @@ :_content-type: ASSEMBLY :context: cluster-logging-storage [id="cluster-logging-storage"] -= Configuring OpenShift Logging storage += Configuring {logging} storage include::_attributes/common-attributes.adoc[] toc::[] -Elasticsearch is a memory-intensive application. The default OpenShift Logging installation deploys 16G of memory for both memory requests and memory limits. -The initial set of {product-title} nodes might not be large enough to support the Elasticsearch cluster. You must add additional nodes to the -{product-title} cluster to run with the recommended or higher memory. Each Elasticsearch node can operate with a lower -memory setting, though this is not recommended for production environments. +Elasticsearch is a memory-intensive application. The default {logging} installation deploys 16G of memory for both memory requests and memory limits. +The initial set of {product-title} nodes might not be large enough to support the Elasticsearch cluster. You must add additional nodes to the {product-title} cluster to run with the recommended or higher memory. Each Elasticsearch node can operate with a lower memory setting, though this is not recommended for production environments. // The following include statements pull in the module files that comprise // the assembly. Include any combination of concept, procedure, or reference diff --git a/logging/config/cluster-logging-tolerations.adoc b/logging/config/cluster-logging-tolerations.adoc index 42dbcf06fa3b..96fa378927cd 100644 --- a/logging/config/cluster-logging-tolerations.adoc +++ b/logging/config/cluster-logging-tolerations.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -You can use taints and tolerations to ensure that OpenShift Logging pods run +You can use taints and tolerations to ensure that {logging} pods run on specific nodes and that no other workload can run on those nodes. Taints and tolerations are simple `key:value` pair. A taint on a node @@ -15,7 +15,7 @@ instructs the node to repel all pods that do not tolerate the taint. The `key` is any string, up to 253 characters and the `value` is any string up to 63 characters. The string must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores. -.Sample OpenShift Logging CR with tolerations +.Sample {logging} CR with tolerations [source,yaml] ---- apiVersion: "logging.openshift.io/v1" diff --git a/logging/config/cluster-logging-visualizer.adoc b/logging/config/cluster-logging-visualizer.adoc index c5921ecf68a7..f1d0670fe26f 100644 --- a/logging/config/cluster-logging-visualizer.adoc +++ b/logging/config/cluster-logging-visualizer.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -{product-title} uses Kibana to display the log data collected by OpenShift Logging. +{product-title} uses Kibana to display the log data collected by the {logging}. You can scale Kibana for redundancy and configure the CPU and memory for your Kibana nodes. @@ -18,4 +18,3 @@ You can scale Kibana for redundancy and configure the CPU and memory for your Ki include::modules/cluster-logging-cpu-memory.adoc[leveloffset=+1] include::modules/cluster-logging-kibana-scaling.adoc[leveloffset=+1] - diff --git a/logging/dedicated-cluster-logging.adoc b/logging/dedicated-cluster-logging.adoc index f2fffe83cba6..9da78a1e6091 100644 --- a/logging/dedicated-cluster-logging.adoc +++ b/logging/dedicated-cluster-logging.adoc @@ -1,18 +1,16 @@ :_content-type: ASSEMBLY :context: dedicated-cluster-logging [id="dedicated-cluster-logging"] -= Configuring OpenShift Logging in {product-title} += Configuring the {logging-title} include::_attributes/common-attributes.adoc[] toc::[] -As a cluster administrator, you can deploy OpenShift Logging -to aggregate logs for a range of services. +As a cluster administrator, you can deploy the {logging} to aggregate logs for a range of services. {product-title} clusters can perform logging tasks using the OpenShift Elasticsearch Operator. - -OpenShift Logging is configurable using a `ClusterLogging` custom resource (CR) +The {logging} is configurable using a `ClusterLogging` custom resource (CR) deployed in the `openshift-logging` project namespace. The Red Hat OpenShift Logging Operator watches for changes to `ClusterLogging` CR, creates diff --git a/logging/troubleshooting/cluster-logging-alerts.adoc b/logging/troubleshooting/cluster-logging-alerts.adoc index ad48a4ef4214..83055bbc563c 100644 --- a/logging/troubleshooting/cluster-logging-alerts.adoc +++ b/logging/troubleshooting/cluster-logging-alerts.adoc @@ -1,7 +1,7 @@ :_content-type: ASSEMBLY :context: cluster-logging-alerts [id="cluster-logging-alerts"] -= Understanding OpenShift Logging alerts += Understanding {logging} alerts include::_attributes/common-attributes.adoc[] toc::[] diff --git a/logging/troubleshooting/cluster-logging-cluster-status.adoc b/logging/troubleshooting/cluster-logging-cluster-status.adoc index 2d06ead546a1..22b4c854a6a3 100644 --- a/logging/troubleshooting/cluster-logging-cluster-status.adoc +++ b/logging/troubleshooting/cluster-logging-cluster-status.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -You can view the status of the Red Hat OpenShift Logging Operator and for a number of OpenShift Logging components. +You can view the status of the Red Hat OpenShift Logging Operator and for a number of {logging} components. // The following include statements pull in the module files that comprise // the assembly. Include any combination of concept, procedure, or reference @@ -17,5 +17,3 @@ You can view the status of the Red Hat OpenShift Logging Operator and for a numb include::modules/cluster-logging-clo-status.adoc[leveloffset=+1] include::modules/cluster-logging-clo-status-comp.adoc[leveloffset=+1] - - diff --git a/logging/troubleshooting/cluster-logging-must-gather.adoc b/logging/troubleshooting/cluster-logging-must-gather.adoc index 08455ea3caa1..e344ef126c1a 100644 --- a/logging/troubleshooting/cluster-logging-must-gather.adoc +++ b/logging/troubleshooting/cluster-logging-must-gather.adoc @@ -8,7 +8,7 @@ toc::[] When opening a support case, it is helpful to provide debugging information about your cluster to Red Hat Support. -The xref:../../support/gathering-cluster-data.adoc#gathering-cluster-data[`must-gather` tool] enables you to collect diagnostic information for project-level resources, cluster-level resources, and each of the OpenShift Logging components. +The xref:../../support/gathering-cluster-data.adoc#gathering-cluster-data[`must-gather` tool] enables you to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components. For prompt support, supply diagnostic information for both {product-title} and OpenShift Logging. @@ -22,6 +22,6 @@ include::modules/cluster-logging-must-gather-about.adoc[leveloffset=+1] [id="cluster-logging-must-gather-prereqs"] == Prerequisites -* OpenShift Logging and Elasticsearch must be installed. +* The {logging} and Elasticsearch must be installed. include::modules/cluster-logging-must-gather-collecting.adoc[leveloffset=+1] diff --git a/logging/viewing-resource-logs.adoc b/logging/viewing-resource-logs.adoc index 099ebf8bd310..d0d19b48b600 100644 --- a/logging/viewing-resource-logs.adoc +++ b/logging/viewing-resource-logs.adoc @@ -6,12 +6,11 @@ include::_attributes/common-attributes.adoc[] toc::[] -You can view the logs for various resources, such as builds, deployments, and pods by using the OpenShift CLI (oc) and the web console. +You can view the logs for various resources, such as builds, deployments, and pods by using the OpenShift CLI (oc) and the web console. [NOTE] ==== -Resource logs are a default feature that provides limited log viewing capability. To enhance your log retrieving and viewing experience, it is recommended that you install xref:../logging/cluster-logging.adoc#cluster-logging[OpenShift Logging]. OpenShift Logging aggregates all the logs from your {product-title} cluster, such as node system audit logs, application container logs, and infrastructure logs, into a dedicated log store. You can then query, discover, and visualize your log data through the xref:../logging/cluster-logging-visualizer.adoc#cluster-logging-visualizer-using[Kibana interface]. Resource logs do not access the OpenShift Logging log store. +Resource logs are a default feature that provides limited log viewing capability. To enhance your log retrieving and viewing experience, it is recommended that you install xref:../logging/cluster-logging.adoc#cluster-logging[OpenShift Logging]. The {logging} aggregates all the logs from your {product-title} cluster, such as node system audit logs, application container logs, and infrastructure logs, into a dedicated log store. You can then query, discover, and visualize your log data through the xref:../logging/cluster-logging-visualizer.adoc#cluster-logging-visualizer-using[Kibana interface]. Resource logs do not access the {logging} log store. ==== include::modules/viewing-resource-logs-cli-console.adoc[leveloffset=+1] - diff --git a/modules/cluster-logging-about-collector.adoc b/modules/cluster-logging-about-collector.adoc index 8ab29c0d9edd..4b6251b5841d 100644 --- a/modules/cluster-logging-about-collector.adoc +++ b/modules/cluster-logging-about-collector.adoc @@ -6,7 +6,7 @@ [id="cluster-logging-about-collector_{context}"] = About the logging collector -{product-title} uses Fluentd to collect container and node logs. +The {logging-title} collects container and node logs. By default, the log collector uses the following sources: diff --git a/modules/cluster-logging-about-components.adoc b/modules/cluster-logging-about-components.adoc index 960b74b81721..280541ef4eef 100644 --- a/modules/cluster-logging-about-components.adoc +++ b/modules/cluster-logging-about-components.adoc @@ -10,13 +10,12 @@ endif::[] :_content-type: CONCEPT [id="cluster-logging-about-components_{context}"] -= About OpenShift Logging components += About {logging} components -The OpenShift Logging components include a collector deployed to each node in the {product-title} cluster -that collects all node and container logs and writes them to a log store. You can use a centralized web UI -to create rich visualizations and dashboards with the aggregated data. +The {logging} components include a collector deployed to each node in the {product-title} cluster +that collects all node and container logs and writes them to a log store. You can use a centralized web UI to create rich visualizations and dashboards with the aggregated data. -The major components of OpenShift Logging are: +The major components of the {logging} are: * collection - This is the component that collects logs from the cluster, formats them, and forwards them to the log store. The current implementation is Fluentd. * 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. diff --git a/modules/cluster-logging-about-crd.adoc b/modules/cluster-logging-about-crd.adoc index b3b7df5803fd..12c8ee10b102 100644 --- a/modules/cluster-logging-about-crd.adoc +++ b/modules/cluster-logging-about-crd.adoc @@ -6,11 +6,11 @@ [id="cluster-logging-configuring-crd_{context}"] = About the ClusterLogging custom resource -To make changes to your OpenShift Logging environment, create and modify the `ClusterLogging` custom resource (CR). +To make changes to your {logging} environment, create and modify the `ClusterLogging` custom resource (CR). Instructions for creating or modifying a CR are provided in this documentation as appropriate. -The following example shows a typical custom resource for OpenShift Logging. +The following example shows a typical custom resource for the {logging}. [id="efk-logging-configuring-about-sample_{context}"] .Sample `ClusterLogging` custom resource (CR) diff --git a/modules/cluster-logging-about-logstore.adoc b/modules/cluster-logging-about-logstore.adoc index c90ae77c0acd..d51ab1623e43 100644 --- a/modules/cluster-logging-about-logstore.adoc +++ b/modules/cluster-logging-about-logstore.adoc @@ -6,9 +6,9 @@ [id="cluster-logging-about-logstore_{context}"] = About the log store -By default, {product-title} uses link:https://www.elastic.co/products/elasticsearch[Elasticsearch (ES)] to store log data. Optionally, you can use the log forwarding features to forward logs to external log stores using Fluentd protocols, syslog protocols, or the {product-title} Log Forwarding API. +By default, {product-title} uses link:https://www.elastic.co/products/elasticsearch[Elasticsearch (ES)] to store log data. Optionally you can use the Log Forwarder API to forward logs to an external store. Several types of store are supported, including fluentd, rsyslog, kafka and others. -The OpenShift Logging Elasticsearch instance is optimized and tested for short term storage, approximately seven days. If you want to retain your logs over a longer term, it is recommended you move the data to a third-party storage system. +The {logging} Elasticsearch instance is optimized and tested for short term storage, approximately seven days. If you want to retain your logs over a longer term, it is recommended you move the data to a third-party storage system. Elasticsearch organizes the log data from Fluentd into datastores, or _indices_, then subdivides each index into multiple pieces called _shards_, which it spreads across a set of Elasticsearch nodes in an Elasticsearch cluster. You can configure Elasticsearch to make copies of the shards, called _replicas_, which Elasticsearch also spreads across the Elasticsearch nodes. The `ClusterLogging` custom resource (CR) allows you to specify how the shards are replicated to provide data redundancy and resilience to failure. You can also specify how long the different types of logs are retained using a retention policy in the `ClusterLogging` CR. @@ -23,8 +23,7 @@ See the link:https://www.elastic.co/guide/en/elasticsearch/guide/current/hardwar [NOTE] ==== -A highly-available Elasticsearch environment requires at least three Elasticsearch nodes, -each on a different host. +A highly-available Elasticsearch environment requires at least three Elasticsearch nodes, each on a different host. ==== Role-based access control (RBAC) applied on the Elasticsearch indices enables the controlled access of the logs to the developers. Administrators can access all logs and developers can access only the logs in their projects. diff --git a/modules/cluster-logging-about.adoc b/modules/cluster-logging-about.adoc index a18b89a0d8a6..33839af95a00 100644 --- a/modules/cluster-logging-about.adoc +++ b/modules/cluster-logging-about.adoc @@ -9,19 +9,18 @@ :_content-type: CONCEPT [id="cluster-logging-about_{context}"] -= About deploying OpenShift Logging += About deploying the {logging-title} ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] -{product-title} cluster administrators can deploy OpenShift Logging using -the {product-title} web console or CLI to install the OpenShift Elasticsearch +{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 OpenShift Logging pods and -other resources necessary to support OpenShift Logging. The operators are -responsible for deploying, upgrading, and maintaining OpenShift Logging. +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}. endif::openshift-enterprise,openshift-webscale,openshift-origin[] -The `ClusterLogging` CR defines a complete OpenShift 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 OpenShift Logging -CR and adjusts the logging deployment accordingly. +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. Administrators and application developers can view the logs of the projects for which they have view access. diff --git a/modules/cluster-logging-clo-status-comp.adoc b/modules/cluster-logging-clo-status-comp.adoc index 88f2b0a53017..c31d3b5355fe 100644 --- a/modules/cluster-logging-clo-status-comp.adoc +++ b/modules/cluster-logging-clo-status-comp.adoc @@ -4,13 +4,13 @@ :_content-type: PROCEDURE [id="cluster-logging-clo-status-example_{context}"] -= Viewing the status of OpenShift Logging components += Viewing the status of {logging} components -You can view the status for a number of OpenShift Logging components. +You can view the status for a number of {logging} components. .Prerequisites -* OpenShift Logging and Elasticsearch must be installed. +* The {logging-title} and Elasticsearch must be installed. .Procedure @@ -21,7 +21,7 @@ You can view the status for a number of OpenShift Logging components. $ oc project openshift-logging ---- -. View the status of the OpenShift Logging environment: +. View the status of the {logging-title} environment: + [source,terminal] ---- @@ -41,7 +41,7 @@ Conditions: Available True MinimumReplicasAvailable Progressing True NewReplicaSetAvailable -.... +.... Events: Type Reason Age From Message @@ -49,7 +49,7 @@ Events: Normal ScalingReplicaSet 62m deployment-controller Scaled up replica set cluster-logging-operator-574b8987df to 1---- ---- -. View the status of the OpenShift Logging replica set: +. View the status of the {logging} replica set: .. Get the name of a replica set: + diff --git a/modules/cluster-logging-clo-status.adoc b/modules/cluster-logging-clo-status.adoc index d1553dda267e..e2bbee792fa0 100644 --- a/modules/cluster-logging-clo-status.adoc +++ b/modules/cluster-logging-clo-status.adoc @@ -10,7 +10,7 @@ You can view the status of your Red Hat OpenShift Logging Operator. .Prerequisites -* OpenShift Logging and Elasticsearch must be installed. +* The {logging-title} and Elasticsearch must be installed. .Procedure diff --git a/modules/cluster-logging-collector-alerts-viewing.adoc b/modules/cluster-logging-collector-alerts-viewing.adoc index 7282f4323e66..49dea5b1b13a 100644 --- a/modules/cluster-logging-collector-alerts-viewing.adoc +++ b/modules/cluster-logging-collector-alerts-viewing.adoc @@ -14,7 +14,7 @@ Alerts are shown in the {product-title} web console, on the *Alerts* tab of the .Procedure -To view OpenShift Logging and other {product-title} alerts: +To view the {logging} and other {product-title} alerts: . In the {product-title} console, click *Observe* → *Alerting*. diff --git a/modules/cluster-logging-collector-log-forward-cloudwatch.adoc b/modules/cluster-logging-collector-log-forward-cloudwatch.adoc index 6082d3b742cf..6f13227f8b4b 100644 --- a/modules/cluster-logging-collector-log-forward-cloudwatch.adoc +++ b/modules/cluster-logging-collector-log-forward-cloudwatch.adoc @@ -2,7 +2,7 @@ [id="cluster-logging-collector-log-forward-cloudwatch_{context}"] = Forwarding logs to Amazon CloudWatch -You can forward logs to Amazon CloudWatch, a monitoring and log storage service hosted by Amazon Web Services (AWS). You can forward logs to CloudWatch in addition to, or instead of, the default OpenShift Logging-managed Elasticsearch log store. +You can forward logs to Amazon CloudWatch, a monitoring and log storage service hosted by Amazon Web Services (AWS). You can forward logs to CloudWatch in addition to, or instead of, the default {logging} managed Elasticsearch log store. To configure log forwarding to CloudWatch, you must create a `ClusterLogForwarder` custom resource (CR) with an output for CloudWatch, and a pipeline that uses the output. diff --git a/modules/cluster-logging-collector-log-forward-syslog.adoc b/modules/cluster-logging-collector-log-forward-syslog.adoc index c28fb94c9ad0..831a0f4e7e3c 100644 --- a/modules/cluster-logging-collector-log-forward-syslog.adoc +++ b/modules/cluster-logging-collector-log-forward-syslog.adoc @@ -6,6 +6,7 @@ You can use the *syslog* link:https://tools.ietf.org/html/rfc3164[RFC3164] or li To configure log forwarding using the *syslog* protocol, you must create a `ClusterLogForwarder` custom resource (CR) with one or more outputs to the syslog servers, and pipelines that use those outputs. The syslog output can use a UDP, TCP, or TLS connection. +//SME-Feedback-Req: Is the below note accurate? [NOTE] ==== Alternately, you can use a config map to forward logs using the *syslog* RFC3164 protocols. However, this method is deprecated in {product-title} and will be removed in a future release. diff --git a/modules/cluster-logging-collector-log-forwarding-about.adoc b/modules/cluster-logging-collector-log-forwarding-about.adoc index cb788f87df2b..53d447248d00 100644 --- a/modules/cluster-logging-collector-log-forwarding-about.adoc +++ b/modules/cluster-logging-collector-log-forwarding-about.adoc @@ -47,13 +47,13 @@ Note the following: * If a `ClusterLogForwarder` CR object exists, logs are not forwarded to the default Elasticsearch instance, unless there is a pipeline with the `default` output. -* By default, OpenShift Logging sends container and infrastructure logs to the default internal Elasticsearch log store defined in the `ClusterLogging` custom resource. However, it does not send audit logs to the internal store because it does not provide secure storage. If this default configuration meets your needs, do not configure the Log Forwarding API. +* By default, the {logging} sends container and infrastructure logs to the default internal Elasticsearch log store defined in the `ClusterLogging` custom resource. However, it does not send audit logs to the internal store because it does not provide secure storage. If this default configuration meets your needs, do not configure the Log Forwarding API. * If you do not define a pipeline for a log type, the logs of the undefined types are dropped. For example, if you specify a pipeline for the `application` and `audit` types, but do not specify a pipeline for the `infrastructure` type, `infrastructure` logs are dropped. * You can use multiple types of outputs in the `ClusterLogForwarder` custom resource (CR) to send logs to servers that support different protocols. -* The internal {product-title} Elasticsearch instance does not provide secure storage for audit logs. We recommend you ensure that the system to which you forward audit logs is compliant with your organizational and governmental regulations and is properly secured. OpenShift Logging does not comply with those regulations. +* The internal {product-title} Elasticsearch instance does not provide secure storage for audit logs. We recommend you ensure that the system to which you forward audit logs is compliant with your organizational and governmental regulations and is properly secured. The {logging} does not comply with those regulations. The following example forwards the audit logs to a secure external Elasticsearch instance, the infrastructure logs to an insecure external Elasticsearch instance, the application logs to a Kafka broker, and the application logs from the `my-apps-logs` project to the internal Elasticsearch instance. diff --git a/modules/cluster-logging-collector-tolerations.adoc b/modules/cluster-logging-collector-tolerations.adoc index 57088f58202a..e9fca7e0e5f4 100644 --- a/modules/cluster-logging-collector-tolerations.adoc +++ b/modules/cluster-logging-collector-tolerations.adoc @@ -25,7 +25,7 @@ tolerations: .Prerequisites -* OpenShift Logging and Elasticsearch must be installed. +* The {logging-title} and Elasticsearch must be installed. .Procedure diff --git a/modules/cluster-logging-collector-tuning.adoc b/modules/cluster-logging-collector-tuning.adoc index 6f33e7e8c843..ecc256f63b0a 100644 --- a/modules/cluster-logging-collector-tuning.adoc +++ b/modules/cluster-logging-collector-tuning.adoc @@ -6,7 +6,7 @@ [id="cluster-logging-collector-tuning_{context}"] = Advanced configuration for the log forwarder -OpenShift Logging includes multiple Fluentd parameters that you can use for tuning the performance of the Fluentd log forwarder. With these parameters, you can change the following Fluentd behaviors: +The {logging-title} includes multiple Fluentd parameters that you can use for tuning the performance of the Fluentd log forwarder. With these parameters, you can change the following Fluentd behaviors: * Chunk and chunk buffer sizes * Chunk flushing behavior diff --git a/modules/cluster-logging-configuring-image-about.adoc b/modules/cluster-logging-configuring-image-about.adoc index fe62d4cb1999..f0b6522dba2c 100644 --- a/modules/cluster-logging-configuring-image-about.adoc +++ b/modules/cluster-logging-configuring-image-about.adoc @@ -3,10 +3,9 @@ // * logging/cluster-logging-configuring.adoc [id="cluster-logging-configuring-image-about_{context}"] -= Understanding OpenShift Logging component images += Understanding {logging} component images -There are several components in OpenShift Logging, each one implemented with one -or more images. Each image is specified by an environment variable +There are several components in the {logging-title}, each one implemented with one or more images. Each image is specified by an environment variable defined in the *cluster-logging-operator* deployment in the *openshift-logging* project and should not be changed. You can view the images by running the following command: diff --git a/modules/cluster-logging-cpu-memory.adoc b/modules/cluster-logging-cpu-memory.adoc index 743ceba5d6ff..0971d084f6af 100644 --- a/modules/cluster-logging-cpu-memory.adoc +++ b/modules/cluster-logging-cpu-memory.adoc @@ -6,7 +6,7 @@ [id="cluster-logging-memory-limits_{context}"] = Configuring CPU and memory limits -The OpenShift Logging components allow for adjustments to both the CPU and memory limits. +The {logging} components allow for adjustments to both the CPU and memory limits. .Procedure diff --git a/modules/cluster-logging-deploy-cli.adoc b/modules/cluster-logging-deploy-cli.adoc index 10293f60d1b3..984952b5dd72 100644 --- a/modules/cluster-logging-deploy-cli.adoc +++ b/modules/cluster-logging-deploy-cli.adoc @@ -4,7 +4,7 @@ :_content-type: PROCEDURE [id="cluster-logging-deploy-cli_{context}"] -= Installing OpenShift Logging using the CLI += Installing the {logging-title} using the CLI You can use the {product-title} CLI to install the OpenShift Elasticsearch and Red Hat OpenShift Logging Operators. @@ -282,7 +282,7 @@ openshift-logging clusterlogging.5.1.0-202 [NOTE] ==== This default OpenShift Logging configuration should support a wide array of environments. Review the topics on tuning and -configuring OpenShift Logging components for information on modifications you can make to your OpenShift Logging cluster. +configuring {logging} components for information on modifications you can make to your OpenShift Logging cluster. ==== + ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] @@ -381,7 +381,7 @@ For example: $ oc create -f olo-instance.yaml ---- + -This creates the OpenShift Logging components, the `Elasticsearch` custom resource and components, and the Kibana interface. +This creates the {logging} components, the `Elasticsearch` custom resource and components, and the Kibana interface. . Verify the installation by listing the pods in the *openshift-logging* project. + diff --git a/modules/cluster-logging-deploy-console.adoc b/modules/cluster-logging-deploy-console.adoc index 268c90857d74..9c530502e919 100644 --- a/modules/cluster-logging-deploy-console.adoc +++ b/modules/cluster-logging-deploy-console.adoc @@ -4,7 +4,7 @@ :_content-type: PROCEDURE [id="cluster-logging-deploy-console_{context}"] -= Installing OpenShift Logging using the web console += Installing the {logging-title} using the web console You can use the {product-title} web console to install the OpenShift Elasticsearch and Red Hat OpenShift Logging Operators. @@ -124,7 +124,7 @@ You might have to refresh the page to load the data. [NOTE] ==== This default OpenShift Logging configuration should support a wide array of environments. Review the topics on tuning and -configuring OpenShift Logging components for information on modifications you can make to your OpenShift Logging cluster. +configuring {logging} components for information on modifications you can make to your OpenShift Logging cluster. ==== + ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] @@ -209,7 +209,7 @@ elasticsearch-cdm-x6kdekli-3 0/1 1 0 6m44s The number of primary shards for the index templates is equal to the number of Elasticsearch data nodes. ==== -.. Click *Create*. This creates the OpenShift Logging components, the `Elasticsearch` custom resource and components, and the Kibana interface. +.. Click *Create*. This creates the {logging} components, the `Elasticsearch` custom resource and components, and the Kibana interface. . Verify the install: diff --git a/modules/cluster-logging-deploy-label.adoc b/modules/cluster-logging-deploy-label.adoc index 3884178e265e..38a3aa28704e 100644 --- a/modules/cluster-logging-deploy-label.adoc +++ b/modules/cluster-logging-deploy-label.adoc @@ -21,7 +21,7 @@ The following also works: $ oc label nodes 10.10.0.{100..119} elasticsearch-fluentd=true ---- -Labeling nodes in groups paces the daemon sets used by OpenShift logging, helping to avoid contention on shared resources such as the image registry. +Labeling nodes in groups paces the daemon sets used by the {logging}, helping to avoid contention on shared resources such as the image registry. [NOTE] ==== diff --git a/modules/cluster-logging-deploy-multitenant.adoc b/modules/cluster-logging-deploy-multitenant.adoc index 45c35aa7498c..e5da687de69c 100644 --- a/modules/cluster-logging-deploy-multitenant.adoc +++ b/modules/cluster-logging-deploy-multitenant.adoc @@ -8,7 +8,7 @@ Your cluster network provider might enforce network isolation. If so, you must allow network traffic between the projects that contain the operators deployed by OpenShift Logging. -Network isolation blocks network traffic between pods or services that are in different projects. OpenShift Logging installs the _OpenShift Elasticsearch Operator_ in the `openshift-operators-redhat` project and the _Red Hat OpenShift Logging Operator_ in the `openshift-logging` project. Therefore, you must allow traffic between these two projects. +Network isolation blocks network traffic between pods or services that are in different projects. The {logging} installs the _OpenShift Elasticsearch Operator_ in the `openshift-operators-redhat` project and the _Red Hat OpenShift Logging Operator_ in the `openshift-logging` project. Therefore, you must allow traffic between these two projects. {product-title} offers two supported choices for the default Container Network Interface (CNI) network provider, OpenShift SDN and OVN-Kubernetes. These two providers implement various network isolation policies. diff --git a/modules/cluster-logging-deploy-storage-considerations.adoc b/modules/cluster-logging-deploy-storage-considerations.adoc index f4fd1a672ba2..23a0b01b007b 100644 --- a/modules/cluster-logging-deploy-storage-considerations.adoc +++ b/modules/cluster-logging-deploy-storage-considerations.adoc @@ -3,7 +3,7 @@ // * logging/config/cluster-logging-storage-considerations.adoc [id="cluster-logging-deploy-storage-considerations_{context}"] -= Storage considerations for OpenShift Logging and {product-title} += Storage considerations for the {logging-title} //// An Elasticsearch index is a collection of primary shards and their corresponding replica shards. This is how Elasticsearch implements high availability internally, so there is little requirement to use hardware based mirroring RAID variants. RAID 0 can still be used to increase overall disk performance. diff --git a/modules/cluster-logging-deploying-about.adoc b/modules/cluster-logging-deploying-about.adoc index 633447828c62..bdee59a2f473 100644 --- a/modules/cluster-logging-deploying-about.adoc +++ b/modules/cluster-logging-deploying-about.adoc @@ -5,21 +5,20 @@ :_content-type: CONCEPT [id="cluster-logging-deploying-about_{context}"] -= About deploying and configuring OpenShift Logging += About deploying and configuring the {logging-title} -OpenShift Logging is designed to be used with the default configuration, which is tuned for small to medium sized {product-title} clusters. +The {logging} is designed to be used with the default configuration, which is tuned for small to medium sized {product-title} clusters. -The installation instructions that follow include a sample `ClusterLogging` custom resource (CR), which you can use to create an OpenShift Logging instance -and configure your OpenShift Logging environment. +The installation instructions that follow include a sample `ClusterLogging` custom resource (CR), which you can use to create a {logging} instance and configure your {logging} environment. -If you want to use the default OpenShift Logging install, you can use the sample CR directly. +If you want to use the default {logging} install, you can use the sample CR directly. If you want to customize your deployment, make changes to the sample CR as needed. The following describes the configurations you can make when installing your OpenShift Logging instance or modify after installation. See the Configuring sections for more information on working with each component, including modifications you can make outside of the `ClusterLogging` custom resource. [id="cluster-logging-deploy-about-config_{context}"] -== Configuring and Tuning OpenShift Logging +== Configuring and Tuning the {logging} -You can configure your OpenShift Logging environment by modifying the `ClusterLogging` custom resource deployed +You can configure your {logging} by modifying the `ClusterLogging` custom resource deployed in the `openshift-logging` project. You can modify any of the following components upon install or after install: diff --git a/modules/cluster-logging-elasticsearch-audit.adoc b/modules/cluster-logging-elasticsearch-audit.adoc index b07242852db8..ea00f8c6e4c3 100644 --- a/modules/cluster-logging-elasticsearch-audit.adoc +++ b/modules/cluster-logging-elasticsearch-audit.adoc @@ -12,7 +12,7 @@ To send the audit logs to the default internal Elasticsearch log store, for exam [IMPORTANT] ==== -The internal {product-title} Elasticsearch log store does not provide secure storage for audit logs. Verify that the system to which you forward audit logs complies with your organizational and governmental regulations and is properly secured. OpenShift Logging does not comply with those regulations. +The internal {product-title} Elasticsearch log store does not provide secure storage for audit logs. Verify that the system to which you forward audit logs complies with your organizational and governmental regulations and is properly secured. The {logging-title} does not comply with those regulations. ==== .Procedure diff --git a/modules/cluster-logging-elasticsearch-exposing.adoc b/modules/cluster-logging-elasticsearch-exposing.adoc index cb0a0541fbe8..dd10d90f7b13 100644 --- a/modules/cluster-logging-elasticsearch-exposing.adoc +++ b/modules/cluster-logging-elasticsearch-exposing.adoc @@ -6,12 +6,9 @@ [id="cluster-logging-elasticsearch-exposing_{context}"] = Exposing the log store service as a route -By default, the log store that is deployed with OpenShift Logging is not -accessible from outside the logging cluster. You can enable a route with re-encryption termination -for external access to the log store service for those tools that access its data. +By default, the log store that is deployed with the {logging-title} is not accessible from outside the logging cluster. You can enable a route with re-encryption termination for external access to the log store service for those tools that access its data. -Externally, you can access the log store by creating a reencrypt route, your {product-title} token and the installed -log store CA certificate. Then, access a node that hosts the log store service with a cURL request that contains: +Externally, you can access the log store by creating a reencrypt route, your {product-title} token and the installed log store CA certificate. Then, access a node that hosts the log store service with a cURL request that contains: * The `Authorization: Bearer ${token}` * The Elasticsearch reencrypt route and an link:https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html[Elasticsearch API request]. @@ -59,7 +56,7 @@ $ oc exec elasticsearch-cdm-oplnhinv-1-5746475887-fj2f8 -n openshift-logging -- .Prerequisites -* OpenShift Logging and Elasticsearch must be installed. +* The {logging-title} and Elasticsearch must be installed. * You must have access to the project to be able to access to the logs. diff --git a/modules/cluster-logging-elasticsearch-ha.adoc b/modules/cluster-logging-elasticsearch-ha.adoc index fb8e6c19a727..912bdfa488f5 100644 --- a/modules/cluster-logging-elasticsearch-ha.adoc +++ b/modules/cluster-logging-elasticsearch-ha.adoc @@ -10,7 +10,7 @@ You can define how Elasticsearch shards are replicated across data nodes in the .Prerequisites -* OpenShift Logging and Elasticsearch must be installed. +* The {logging-title} and Elasticsearch must be installed. .Procedure diff --git a/modules/cluster-logging-elasticsearch-persistent-storage-empty.adoc b/modules/cluster-logging-elasticsearch-persistent-storage-empty.adoc index 39635eaaa415..af78950d38e2 100644 --- a/modules/cluster-logging-elasticsearch-persistent-storage-empty.adoc +++ b/modules/cluster-logging-elasticsearch-persistent-storage-empty.adoc @@ -15,8 +15,8 @@ When using emptyDir, if log storage is restarted or redeployed, you will lose da ==== .Prerequisites - -* OpenShift Logging and Elasticsearch must be installed. +//Find & replace the below according to SME feedback. +* The {logging-title} and Elasticsearch must be installed. .Procedure @@ -28,8 +28,6 @@ When using emptyDir, if log storage is restarted or redeployed, you will lose da logStore: type: "elasticsearch" elasticsearch: - nodeCount: 3 + nodeCount: 3 storage: {} ---- - - diff --git a/modules/cluster-logging-elasticsearch-retention.adoc b/modules/cluster-logging-elasticsearch-retention.adoc index 14ea1a65ee5e..2673a9bfe041 100644 --- a/modules/cluster-logging-elasticsearch-retention.adoc +++ b/modules/cluster-logging-elasticsearch-retention.adoc @@ -19,8 +19,8 @@ Elasticsearch rolls over an index, moving the current index and creating a new i Elasticsearch deletes the rolled-over indices based on the retention policy you configure. If you do not create a retention policy for any log sources, logs are deleted after seven days by default. .Prerequisites - -* OpenShift Logging and the OpenShift Elasticsearch Operator must be installed. +//SME Feedback Req: There are a few instances of these for prereqs. Should OpenShift Logging here be the Red Hat OpenShift Logging Operator or the logging product name? +* The {logging-title} and the OpenShift Elasticsearch Operator must be installed. .Procedure diff --git a/modules/cluster-logging-elasticsearch-storage.adoc b/modules/cluster-logging-elasticsearch-storage.adoc index 1053f88b9c89..e0a7cc1242e4 100644 --- a/modules/cluster-logging-elasticsearch-storage.adoc +++ b/modules/cluster-logging-elasticsearch-storage.adoc @@ -17,8 +17,8 @@ occur. ==== .Prerequisites - -* OpenShift Logging and Elasticsearch must be installed. + +* The {logging-title} and Elasticsearch must be installed. .Procedure diff --git a/modules/cluster-logging-elasticsearch-tolerations.adoc b/modules/cluster-logging-elasticsearch-tolerations.adoc index 6926e7c9d82f..acaad1605c63 100644 --- a/modules/cluster-logging-elasticsearch-tolerations.adoc +++ b/modules/cluster-logging-elasticsearch-tolerations.adoc @@ -26,7 +26,7 @@ tolerations: .Prerequisites -* OpenShift Logging and Elasticsearch must be installed. +* The {logging-title} and Elasticsearch must be installed. .Procedure diff --git a/modules/cluster-logging-eventrouter-about.adoc b/modules/cluster-logging-eventrouter-about.adoc index cbb23609c756..690662b9f531 100644 --- a/modules/cluster-logging-eventrouter-about.adoc +++ b/modules/cluster-logging-eventrouter-about.adoc @@ -6,7 +6,7 @@ [id="cluster-logging-eventrouter-about_{context}"] = About event routing -The Event Router is a pod that watches {product-title} events so they can be collected by OpenShift Logging. -The Event Router collects events from all projects and writes them to `STDOUT`. Fluentd collects those events and forwards them into the {product-title} Elasticsearch instance. Elasticsearch indexes the events to the `infra` index. +The Event Router is a pod that watches {product-title} events so they can be collected by the {logging-title}. +The Event Router collects events from all projects and writes them to `STDOUT`. Fluentd collects those events and forwards them into the {product-title} Elasticsearch instance. Elasticsearch indexes the events to the `infra` index. You must manually deploy the Event Router. diff --git a/modules/cluster-logging-eventrouter-deploy.adoc b/modules/cluster-logging-eventrouter-deploy.adoc index 0971dc46e3df..29eb1c21a8b8 100644 --- a/modules/cluster-logging-eventrouter-deploy.adoc +++ b/modules/cluster-logging-eventrouter-deploy.adoc @@ -14,7 +14,7 @@ The following Template object creates the service account, cluster role, and clu * You need proper permissions to create service accounts and update cluster role bindings. For example, you can run the following template with a user that has the *cluster-admin* role. -* OpenShift Logging must be installed. +* The {logging-title} must be installed. .Procedure diff --git a/modules/cluster-logging-forwarding-about.adoc b/modules/cluster-logging-forwarding-about.adoc index e29a55044ded..efe67f586b8f 100644 --- a/modules/cluster-logging-forwarding-about.adoc +++ b/modules/cluster-logging-forwarding-about.adoc @@ -6,5 +6,4 @@ [id="cluster-logging-forwarding-about_{context}"] = About log forwarding -By default, OpenShift Logging sends logs to the default internal Elasticsearch log store, defined in the `ClusterLogging` custom resource (CR). If you want to forward logs to other log aggregators, you can use the log forwarding features to send logs to specific endpoints within or outside your cluster. - +By default, the {logging-title} sends logs to the default internal Elasticsearch log store, defined in the `ClusterLogging` custom resource (CR). If you want to forward logs to other log aggregators, you can use the log forwarding features to send logs to specific endpoints within or outside your cluster. diff --git a/modules/cluster-logging-kibana-tolerations.adoc b/modules/cluster-logging-kibana-tolerations.adoc index a281c09a06c1..f081f4e51af0 100644 --- a/modules/cluster-logging-kibana-tolerations.adoc +++ b/modules/cluster-logging-kibana-tolerations.adoc @@ -16,7 +16,7 @@ that is not on other pods ensures only the Kibana pod can run on that node. .Prerequisites -* OpenShift Logging and Elasticsearch must be installed. +* The {logging-title} and Elasticsearch must be installed. .Procedure diff --git a/modules/cluster-logging-log-store-status-viewing.adoc b/modules/cluster-logging-log-store-status-viewing.adoc index 02e5b83e0649..7f47ba5cacd6 100644 --- a/modules/cluster-logging-log-store-status-viewing.adoc +++ b/modules/cluster-logging-log-store-status-viewing.adoc @@ -10,7 +10,7 @@ You can view the status of your log store. .Prerequisites -* OpenShift Logging and Elasticsearch must be installed. +* The {logging-title} and Elasticsearch must be installed. .Procedure diff --git a/modules/cluster-logging-logstore-limits.adoc b/modules/cluster-logging-logstore-limits.adoc index b5c929cfbf36..d2573f82af0a 100644 --- a/modules/cluster-logging-logstore-limits.adoc +++ b/modules/cluster-logging-logstore-limits.adoc @@ -20,7 +20,7 @@ For production use, you should have no less than the default 16Gi allocated to e .Prerequisites -* OpenShift Logging and Elasticsearch must be installed. +* The {logging-title} and Elasticsearch must be installed. .Procedure diff --git a/modules/cluster-logging-maintenance-support-about.adoc b/modules/cluster-logging-maintenance-support-about.adoc index a0b9203d5255..f71a4c5c6520 100644 --- a/modules/cluster-logging-maintenance-support-about.adoc +++ b/modules/cluster-logging-maintenance-support-about.adoc @@ -4,9 +4,9 @@ :_content-type: CONCEPT [id="cluster-logging-maintenance-support-about_{context}"] -= About unsupported configurations += About unsupported configurations -The supported way of configuring OpenShift Logging is by configuring it using the options described in this documentation. Do not use other configurations, as they are unsupported. Configuration paradigms might change across {product-title} releases, and such cases can only be handled gracefully if all configuration possibilities are controlled. If you use configurations other than those described in this documentation, your changes will disappear because the OpenShift Elasticsearch Operator and Red Hat OpenShift Logging Operator reconcile any differences. The Operators reverse everything to the defined state by default and by design. +The supported way of configuring the {logging-title} is by configuring it using the options described in this documentation. Do not use other configurations, as they are unsupported. Configuration paradigms might change across {product-title} releases, and such cases can only be handled gracefully if all configuration possibilities are controlled. If you use configurations other than those described in this documentation, your changes will disappear because the OpenShift Elasticsearch Operator and Red Hat OpenShift Logging Operator reconcile any differences. The Operators reverse everything to the defined state by default and by design. [NOTE] ==== diff --git a/modules/cluster-logging-manual-rollout-rolling.adoc b/modules/cluster-logging-manual-rollout-rolling.adoc index 97683cdb5aaf..f3f2e336ee5c 100644 --- a/modules/cluster-logging-manual-rollout-rolling.adoc +++ b/modules/cluster-logging-manual-rollout-rolling.adoc @@ -12,7 +12,7 @@ Also, a rolling restart is recommended if the nodes on which an Elasticsearch po .Prerequisites -* OpenShift Logging and Elasticsearch must be installed. +* The {logging-title} and Elasticsearch must be installed. .Procedure diff --git a/modules/cluster-logging-must-gather-about.adoc b/modules/cluster-logging-must-gather-about.adoc index cce8f926c31d..e8abfa298832 100644 --- a/modules/cluster-logging-must-gather-about.adoc +++ b/modules/cluster-logging-must-gather-about.adoc @@ -8,7 +8,7 @@ The `oc adm must-gather` CLI command collects the information from your cluster that is most likely needed for debugging issues. -For your OpenShift Logging environment, `must-gather` collects the following information: +For your {logging}, `must-gather` collects the following information: * Project-level resources, including pods, configuration maps, service accounts, roles, role bindings, and events at the project level * Cluster-level resources, including nodes, roles, and role bindings at the cluster level diff --git a/modules/cluster-logging-must-gather-collecting.adoc b/modules/cluster-logging-must-gather-collecting.adoc index 32254b9a968c..1747f51ffa6b 100644 --- a/modules/cluster-logging-must-gather-collecting.adoc +++ b/modules/cluster-logging-must-gather-collecting.adoc @@ -6,15 +6,15 @@ [id="cluster-logging-must-gather-collecting_{context}"] = Collecting OpenShift Logging data -You can use the `oc adm must-gather` CLI command to collect information about your OpenShift Logging environment. +You can use the `oc adm must-gather` CLI command to collect information about your {logging}. .Procedure -To collect OpenShift Logging information with `must-gather`: +To collect {logging} information with `must-gather`: . Navigate to the directory where you want to store the `must-gather` information. -. Run the `oc adm must-gather` command against the OpenShift Logging image: +. Run the `oc adm must-gather` command against the OpenShift Logging image: + ifndef::openshift-origin[] [source,terminal] diff --git a/modules/cluster-logging-uninstall.adoc b/modules/cluster-logging-uninstall.adoc index f6afaef6cb9f..860d6db70e7e 100644 --- a/modules/cluster-logging-uninstall.adoc +++ b/modules/cluster-logging-uninstall.adoc @@ -4,16 +4,16 @@ :_content-type: PROCEDURE [id="cluster-logging-uninstall_{context}"] -= Uninstalling OpenShift Logging from {product-title} += Uninstalling the {logging-title} -You can stop log aggregation by deleting the `ClusterLogging` custom resource (CR). After deleting the CR, there are other OpenShift Logging components that remain, which you can optionally remove. +You can stop log aggregation by deleting the `ClusterLogging` custom resource (CR). After deleting the CR, there are other {logging} components that remain, which you can optionally remove. Deleting the `ClusterLogging` CR does not remove the persistent volume claims (PVCs). To preserve or delete the remaining PVCs, persistent volumes (PVs), and associated data, you must take further action. .Prerequisites -* OpenShift Logging and Elasticsearch must be installed. +* The {logging-title} and Elasticsearch must be installed. .Procedure diff --git a/modules/cluster-logging-visualizer-kibana.adoc b/modules/cluster-logging-visualizer-kibana.adoc index 0b7fdd5eabcb..03e0d513b7fd 100644 --- a/modules/cluster-logging-visualizer-kibana.adoc +++ b/modules/cluster-logging-visualizer-kibana.adoc @@ -10,7 +10,7 @@ You view cluster logs in the Kibana web console. The methods for viewing and vis .Prerequisites -* OpenShift Logging and Elasticsearch must be installed. +* The {logging-title} and Elasticsearch must be installed. * Kibana index patterns must exist. diff --git a/modules/infrastructure-moving-logging.adoc b/modules/infrastructure-moving-logging.adoc index a5236a11ef14..b6adfc20026d 100644 --- a/modules/infrastructure-moving-logging.adoc +++ b/modules/infrastructure-moving-logging.adoc @@ -7,13 +7,13 @@ [id="infrastructure-moving-logging_{context}"] = Moving OpenShift Logging resources -You can configure the Cluster Logging Operator to deploy the pods for OpenShift Logging components, such as Elasticsearch and Kibana, to different nodes. You cannot move the Cluster Logging Operator pod from its installed location. +You can configure the Cluster Logging Operator to deploy the pods for {logging} components, such as Elasticsearch and Kibana, to different nodes. You cannot move the Cluster Logging Operator pod from its installed location. For example, you can move the Elasticsearch pods to a separate node because of high CPU, memory, and disk requirements. .Prerequisites -* OpenShift Logging and Elasticsearch must be installed. These features are not installed by default. +* The {logging-title} and Elasticsearch must be installed. These features are not installed by default. .Procedure