OBSDOCS-152: Restructuring log visualization docs

_topic_maps/_topic_map.yml

@@ -2533,6 +2533,13 @@ Topics:
 - Name: Updating Logging
   File: cluster-logging-upgrading
   Distros: openshift-enterprise,openshift-origin
+- Name: Visualizing logs
+  Dir: log_visualization
+  Topics:
+  - Name: About log visualization
+    File: log-visualization
+  - Name: Log visualization with Kibana
+    File: logging-kibana
 - Name: Configuring your Logging deployment
   Dir: config
   Distros: openshift-enterprise,openshift-origin
@@ -2541,8 +2548,6 @@ Topics:
     File: cluster-logging-configuring-cr
   - Name: Configuring the log store
     File: cluster-logging-log-store
-  - Name: Configuring the log visualizer
-    File: cluster-logging-visualizer
   - Name: Configuring Logging storage
     File: cluster-logging-storage-considerations
   - Name: Configuring CPU and memory limits for Logging components
@@ -2555,11 +2560,6 @@ Topics:
     File: cluster-logging-systemd
 - Name: Logging using LokiStack
   File: cluster-logging-loki
-- Name: Viewing logs for a specific resource
-  File: viewing-resource-logs
-- Name: Viewing cluster logs in Kibana
-  File: cluster-logging-visualizer
-  Distros: openshift-enterprise,openshift-origin
 - Name: Log collection and forwarding
   Dir: log_collection_forwarding
   Topics:

_topic_maps/_topic_map_osd.yml

@@ -740,7 +740,7 @@ Topics:
 # cannot use oc adm cordon; cannot patch resource "machinesets"; cannot patch resource "nodes"
 #  - Name: Working with nodes
 #    File: nodes-nodes-working
-# cannot create resource "kubeletconfigs", "schedulers", "machineconfigs", "kubeletconfigs" 
+# cannot create resource "kubeletconfigs", "schedulers", "machineconfigs", "kubeletconfigs"
 #  - Name: Managing nodes
 #    File: nodes-nodes-managing
 # cannot create resource "kubeletconfigs"
@@ -773,7 +773,7 @@ Topics:
 #    File: nodes-nodes-problem-detector
   - Name: Machine Config Daemon metrics
     File: nodes-nodes-machine-config-daemon-metrics
-# cannot patch resource "nodes" 
+# cannot patch resource "nodes"
 #  - Name: Creating infrastructure nodes
 #    File: nodes-nodes-creating-infrastructure-nodes
 - Name: Working with containers
@@ -860,6 +860,13 @@ Topics:
   File: cluster-logging-deploying
 - Name: Updating Logging
   File: cluster-logging-upgrading
+- Name: Visualizing logs
+  Dir: log_visualization
+  Topics:
+  - Name: About log visualization
+    File: log-visualization
+  - Name: Log visualization with Kibana
+    File: logging-kibana
 - Name: Accessing the service logs
   File: sd-accessing-the-service-logs
 - Name: Configuring your Logging deployment
@@ -869,8 +876,6 @@ Topics:
     File: cluster-logging-configuring-cr
   - Name: Configuring the log store
     File: cluster-logging-log-store
-  - Name: Configuring the log visualizer
-    File: cluster-logging-visualizer
   - Name: Configuring Logging storage
     File: cluster-logging-storage-considerations
   - Name: Configuring CPU and memory limits for Logging components
@@ -883,11 +888,6 @@ Topics:
   #  File: cluster-logging-systemd
 - Name: Logging using LokiStack
   File: cluster-logging-loki
-- Name: Viewing logs for a specific resource
-  File: viewing-resource-logs
-- Name: Viewing cluster logs in Kibana
-  File: cluster-logging-visualizer
-  Distros: openshift-dedicated
 - Name: Log collection and forwarding
   Dir: log_collection_forwarding
   Topics:

_topic_maps/_topic_map_rosa.yml

@@ -910,10 +910,10 @@ Topics:
 # cannot use oc adm cordon; cannot patch resource "machinesets"; cannot patch resource "nodes"
 #  - Name: Working with nodes
 #    File: nodes-nodes-working
-# cannot create resource "kubeletconfigs", "schedulers", "machineconfigs", "kubeletconfigs" 
+# cannot create resource "kubeletconfigs", "schedulers", "machineconfigs", "kubeletconfigs"
 #  - Name: Managing nodes
 #    File: nodes-nodes-managing
-# cannot create resource "kubeletconfigs" 
+# cannot create resource "kubeletconfigs"
 #  - Name: Managing graceful node shutdown
 #    File: nodes-nodes-graceful-shutdown
 # cannot create resource "kubeletconfigs"
@@ -943,7 +943,7 @@ Topics:
 #    File: nodes-nodes-problem-detector
   - Name: Machine Config Daemon metrics
     File: nodes-nodes-machine-config-daemon-metrics
-# cannot patch resource "nodes" 
+# cannot patch resource "nodes"
 #  - Name: Creating infrastructure nodes
 #    File: nodes-nodes-creating-infrastructure-nodes
 - Name: Working with containers
@@ -1031,6 +1031,13 @@ Topics:
   File: cluster-logging-deploying
 - Name: Updating Logging
   File: cluster-logging-upgrading
+- Name: Visualizing logs
+  Dir: log_visualization
+  Topics:
+  - Name: About log visualization
+    File: log-visualization
+  - Name: Log visualization with Kibana
+    File: logging-kibana
 - Name: Accessing the service logs
   File: sd-accessing-the-service-logs
 - Name: Viewing cluster logs in the AWS Console
@@ -1042,8 +1049,6 @@ Topics:
     File: cluster-logging-configuring-cr
   - Name: Configuring the log store
     File: cluster-logging-log-store
-  - Name: Configuring the log visualizer
-    File: cluster-logging-visualizer
   - Name: Configuring Logging storage
     File: cluster-logging-storage-considerations
   - Name: Configuring CPU and memory limits for Logging components
@@ -1056,10 +1061,6 @@ Topics:
   #  File: cluster-logging-systemd
 - Name: Logging using LokiStack
   File: cluster-logging-loki
-- Name: Viewing logs for a specific resource
-  File: viewing-resource-logs
-- Name: Viewing cluster logs in Kibana
-  File: cluster-logging-visualizer
 - Name: Log collection and forwarding
   Dir: log_collection_forwarding
   Topics:

logging/cluster-logging-deploying.adoc

@@ -43,21 +43,14 @@ endif::[]
 
 == Postinstallation tasks
 
-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 network plugin 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]
 
 == Postinstallation tasks
 
-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 network plugin 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]
-
 include::modules/cluster-logging-deploy-multitenant.adoc[leveloffset=+2]
 
 [role="_additional-resources"]

logging/cluster-logging.adoc

@@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
 
 toc::[]
 
-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.
+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 the Kibana web console, depending on your deployed log storage solution.
 
 include::snippets/logging-kibana-dep-snip.adoc[]
 
@@ -36,10 +36,6 @@ include::modules/cluster-logging-collecting-storing-kubernetes-events.adoc[level
 
 For information, see xref:../logging/log_collection_forwarding/cluster-logging-eventrouter.adoc#cluster-logging-eventrouter[About collecting and storing Kubernetes events].
 
-include::modules/cluster-logging-view-cluster-dashboards.adoc[leveloffset=+2]
-
-For information, see xref:../logging/cluster-logging-dashboards.adoc#cluster-logging-dashboards[About viewing the cluster dashboard].
-
 include::modules/cluster-logging-troubleshoot-logging.adoc[leveloffset=+2]
 
 include::modules/cluster-logging-export-fields.adoc[leveloffset=+2]
@@ -50,10 +46,6 @@ include::modules/cluster-logging-about-logstore.adoc[leveloffset=+2]
 
 For information, see xref:../logging/config/cluster-logging-log-store.adoc#cluster-logging-log-store[Configuring the log store].
 
-include::modules/cluster-logging-about-visualizer.adoc[leveloffset=+2]
-
-For information, see xref:../logging/config/cluster-logging-visualizer.adoc#cluster-logging-visualizer[Configuring the log visualizer].
-
 include::modules/cluster-logging-eventrouter-about.adoc[leveloffset=+2]
 
 For information, see xref:../logging/log_collection_forwarding/cluster-logging-eventrouter.adoc#cluster-logging-eventrouter[Collecting and storing Kubernetes events].

logging/log_visualization/_attributes

@@ -0,0 +1 @@
+../../_attributes/

logging/log_visualization/images

@@ -0,0 +1 @@
+../../images/

logging/log_visualization/log-visualization.adoc

@@ -0,0 +1,57 @@
+:_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+include::_attributes/attributes-openshift-dedicated.adoc[]
+[id="log-visualization"]
+= About log visualization
+:context: log-visualization
+
+toc::[]
+
+You can visualize your log data in the {product-title} web console, or the Kibana web console, depending on your deployed log storage solution.
+
+include::snippets/logging-kibana-dep-snip.adoc[]
+
+[id="log-visualization-kibana"]
+== About the Kibana console
+
+You can use the Kibana console to visualize logs if you are using the ElasticSearch log store on your cluster.
+
+You can configure using the Kibana console by modifying the `ClusterLogging` custom resource (CR):
+
+.Example ClusterLogging resource
+[source,yaml]
+----
+apiVersion: logging.openshift.io/v1
+kind: ClusterLogging
+metadata:
+  name: instance
+  namespace: openshift-logging
+spec:
+# ...
+  visualization: <1>
+    type: kibana
+    kibana:
+      resources:
+        limits:
+          memory: 736Mi
+        requests:
+          cpu: 100m
+          memory: 736Mi
+      replicas: 1
+# ...
+----
+<1> Settings for the visualizer, including the resource requests and limits, and the number of pod replicas.
+
+[TIP]
+====
+If you are not using the ElasticSearch log store and as a result are not using the Kibana console, you can remove the `visualization` stanza from the `ClusterLogging` CR to save resources.
+====
+
+[id="log-visualization-resource-logs"]
+== Viewing logs for a resource
+
+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 the {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 Kibana interface. Resource logs do not access the {logging} log store.
+
+You can view the logs for various resources, such as builds, deployments, and pods by using the {oc-first} and the web console.
+
+include::modules/viewing-resource-logs-cli-console.adoc[leveloffset=+2]

logging/log_visualization/logging-kibana.adoc

@@ -0,0 +1,35 @@
+:_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+include::_attributes/attributes-openshift-dedicated.adoc[]
+[id="logging-kibana"]
+= Log visualization with Kibana
+:context: logging-kibana
+
+toc::[]
+
+You can use the Kibana console to visualize collected log data.
+
+Using Kibana, you can do the following with your data:
+
+* Search and browse the data using the *Discover* tab.
+* Chart and map the data using the *Visualize* tab.
+* 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].
+
+[NOTE]
+====
+The audit logs are not stored in the internal {product-title} Elasticsearch instance by default. To view the audit logs in Kibana, you must use the xref:../../logging/config/cluster-logging-log-store.adoc#cluster-logging-elasticsearch-audit_cluster-logging-log-store[Log Forwarding API] to configure a pipeline that uses the `default` output for audit logs.
+====
+
+include::modules/cluster-logging-visualizer-indices.adoc[leveloffset=+1]
+include::modules/cluster-logging-visualizer-kibana.adoc[leveloffset=+1]
+
+[id="logging-kibana-configuring"]
+== Configuring Kibana
+
+You can scale Kibana for redundancy and configure the CPU and memory for your Kibana nodes.
+
+include::modules/cluster-logging-cpu-memory.adoc[leveloffset=+2]
+include::modules/cluster-logging-kibana-scaling.adoc[leveloffset=+2]

logging/log_visualization/modules

@@ -0,0 +1 @@
+../../modules/

logging/log_visualization/snippets

@@ -0,0 +1 @@
+../../snippets/

modules/cluster-logging-visualizer-indices.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * logging/cluster-logging-visualizer.adoc
+// * logging/log_visualizer/logging-kibana.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="cluster-logging-visualizer-indices_{context}"]