Skip to content

Commit 345d0dd

Browse files
committed
OBSDOCS-120: Update formatting and install instructions
1 parent 4c5bb87 commit 345d0dd

19 files changed

+150
-398
lines changed

_topic_maps/_topic_map.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2543,8 +2543,6 @@ Topics:
25432543
File: cluster-logging-log-store
25442544
- Name: Configuring the log visualizer
25452545
File: cluster-logging-visualizer
2546-
- Name: Configuring Logging storage
2547-
File: cluster-logging-storage-considerations
25482546
- Name: Configuring CPU and memory limits for Logging components
25492547
File: cluster-logging-memory
25502548
- Name: Using tolerations to control Logging pod placement

_topic_maps/_topic_map_osd.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -740,7 +740,7 @@ Topics:
740740
# cannot use oc adm cordon; cannot patch resource "machinesets"; cannot patch resource "nodes"
741741
# - Name: Working with nodes
742742
# File: nodes-nodes-working
743-
# cannot create resource "kubeletconfigs", "schedulers", "machineconfigs", "kubeletconfigs"
743+
# cannot create resource "kubeletconfigs", "schedulers", "machineconfigs", "kubeletconfigs"
744744
# - Name: Managing nodes
745745
# File: nodes-nodes-managing
746746
# cannot create resource "kubeletconfigs"
@@ -773,7 +773,7 @@ Topics:
773773
# File: nodes-nodes-problem-detector
774774
- Name: Machine Config Daemon metrics
775775
File: nodes-nodes-machine-config-daemon-metrics
776-
# cannot patch resource "nodes"
776+
# cannot patch resource "nodes"
777777
# - Name: Creating infrastructure nodes
778778
# File: nodes-nodes-creating-infrastructure-nodes
779779
- Name: Working with containers
@@ -871,8 +871,6 @@ Topics:
871871
File: cluster-logging-log-store
872872
- Name: Configuring the log visualizer
873873
File: cluster-logging-visualizer
874-
- Name: Configuring Logging storage
875-
File: cluster-logging-storage-considerations
876874
- Name: Configuring CPU and memory limits for Logging components
877875
File: cluster-logging-memory
878876
- Name: Using tolerations to control Logging pod placement

_topic_maps/_topic_map_rosa.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -910,10 +910,10 @@ Topics:
910910
# cannot use oc adm cordon; cannot patch resource "machinesets"; cannot patch resource "nodes"
911911
# - Name: Working with nodes
912912
# File: nodes-nodes-working
913-
# cannot create resource "kubeletconfigs", "schedulers", "machineconfigs", "kubeletconfigs"
913+
# cannot create resource "kubeletconfigs", "schedulers", "machineconfigs", "kubeletconfigs"
914914
# - Name: Managing nodes
915915
# File: nodes-nodes-managing
916-
# cannot create resource "kubeletconfigs"
916+
# cannot create resource "kubeletconfigs"
917917
# - Name: Managing graceful node shutdown
918918
# File: nodes-nodes-graceful-shutdown
919919
# cannot create resource "kubeletconfigs"
@@ -943,7 +943,7 @@ Topics:
943943
# File: nodes-nodes-problem-detector
944944
- Name: Machine Config Daemon metrics
945945
File: nodes-nodes-machine-config-daemon-metrics
946-
# cannot patch resource "nodes"
946+
# cannot patch resource "nodes"
947947
# - Name: Creating infrastructure nodes
948948
# File: nodes-nodes-creating-infrastructure-nodes
949949
- Name: Working with containers
@@ -1044,8 +1044,6 @@ Topics:
10441044
File: cluster-logging-log-store
10451045
- Name: Configuring the log visualizer
10461046
File: cluster-logging-visualizer
1047-
- Name: Configuring Logging storage
1048-
File: cluster-logging-storage-considerations
10491047
- Name: Configuring CPU and memory limits for Logging components
10501048
File: cluster-logging-memory
10511049
- Name: Using tolerations to control Logging pod placement
Lines changed: 17 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,42 @@
11
:_mod-docs-content-type: ASSEMBLY
22
:context: cluster-logging-deploying
33
[id="cluster-logging-deploying"]
4-
= Installing the {logging-title}
4+
= Installing Logging
55
include::_attributes/common-attributes.adoc[]
66
include::_attributes/attributes-openshift-dedicated.adoc[]
77

88
toc::[]
99

10-
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.
11-
12-
The process for deploying the {logging} to {product-title}
13-
ifdef::openshift-rosa[]
14-
(ROSA)
15-
endif::[]
16-
involves:
17-
18-
* Reviewing the xref:../logging/config/cluster-logging-storage-considerations#cluster-logging-storage[{logging-uc} storage considerations].
19-
20-
* Installing the logging subsystem for {product-title} using xref:../logging/cluster-logging-deploying.adoc#cluster-logging-deploy-console_cluster-logging-deploying[the web console] or xref:../logging/cluster-logging-deploying.adoc#cluster-logging-deploy-cli_cluster-logging-deploying[the CLI].
10+
You can install the {logging-title} by deploying the Red Hat OpenShift Logging Operator. The {logging} Operator creates and manages the components of the logging stack.
2111

2212
[IMPORTANT]
2313
====
2414
For new installations, Vector and LokiStack are recommended. Documentation for logging is in the process of being updated to reflect these underlying component changes.
2515
====
2616

27-
include::snippets/logging-elastic-dep-snip.adoc[]
17+
ifdef::openshift-origin[]
18+
[id="prerequisites_cluster-logging-deploying"]
19+
== Prerequisites
20+
* Ensure that you have downloaded the {cluster-manager-url-pull} as shown in _Obtaining the installation program_ in the installation documentation for your platform.
21+
+
22+
If you have the pull secret, add the `redhat-operators` catalog to the OperatorHub custom resource (CR) as shown in _Configuring {product-title} to use Red Hat Operators_.
23+
endif::[]
24+
2825
include::snippets/logging-fluentd-dep-snip.adoc[]
2926

3027
include::modules/cluster-logging-deploy-console.adoc[leveloffset=+1]
3128

29+
[id="cluster-logging-deploying-es-operator"]
30+
== Installing the Elasticsearch Operator
31+
32+
include::snippets/logging-elastic-dep-snip.adoc[]
33+
include::modules/logging-es-storage-considerations.adoc[leveloffset=+2]
34+
include::modules/logging-install-es-operator.adoc[leveloffset=+2]
35+
3236
[role="_additional-resources"]
3337
.Additional resources
34-
35-
ifdef::openshift-enterprise,openshift-origin[]
3638
* xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Installing Operators from the OperatorHub]
3739
* xref:../logging/config/cluster-logging-log-store.adoc#cluster-logging-removing-unused-components-if-no-elasticsearch_cluster-logging-log-store[Removing unused components if you do not use the default Elasticsearch log store]
38-
endif::[]
39-
ifdef::openshift-rosa,openshift-dedicated[]
40-
* link:https://docs.openshift.com/container-platform/latest/operators/admin/olm-adding-operators-to-cluster.html[Installing Operators from OperatorHub]
41-
* link:https://docs.openshift.com/container-platform/latest/logging/config/cluster-logging-log-store.html#cluster-logging-removing-unused-components-if-no-elasticsearch_cluster-logging-log-store[Removing unused components if you do not use the default Elasticsearch log store]
42-
endif::[]
4340

4441
== Postinstallation tasks
4542

@@ -73,9 +70,3 @@ ifdef::openshift-rosa,openshift-dedicated[]
7370
* link:https://docs.openshift.com/container-platform/latest/networking/openshift_sdn/about-openshift-sdn.html[About the OpenShift SDN default CNI network provider]
7471
* link:https://docs.openshift.com/container-platform/latest/networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.html[About the OVN-Kubernetes default Container Network Interface (CNI) network provider]
7572
endif::[]
76-
77-
// include::modules/cluster-logging-deploy-memory.adoc[leveloffset=+1]
78-
79-
// include::modules/cluster-logging-deploy-certificates.adoc[leveloffset=+1]
80-
81-
// include::modules/cluster-logging-deploy-label.adoc[leveloffset=+1]

logging/config/cluster-logging-log-store.adoc

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,6 @@ You can make modifications to your log store, including:
1515
* shard replication across data nodes in the cluster, from full replication to no replication
1616
* external access to Elasticsearch data
1717
18-
//Following paragraph also in modules/cluster-logging-deploy-storage-considerations.adoc
19-
20-
Elasticsearch is a memory-intensive application. Each Elasticsearch node needs at least 16G of memory for both memory requests and limits, unless you specify otherwise in the `ClusterLogging` custom resource. 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
21-
or higher memory, up to a maximum of 64G for each Elasticsearch node.
22-
23-
Each Elasticsearch node can operate with a lower memory setting, though this is not recommended for production environments.
24-
2518
include::modules/cluster-logging-elasticsearch-audit.adoc[leveloffset=+1]
2619

2720
[role="_additional-resources"]

logging/config/cluster-logging-storage-considerations.adoc

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

logging/v5_5/logging-5-5-administration.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
//Installing the Red Hat OpenShift Logging Operator via webconsole
10-
include::modules/logging-deploy-RHOL-console.adoc[leveloffset=+1]
11-
129
//Installing the Loki Operator via webconsole
1310
include::modules/logging-deploy-loki-console.adoc[leveloffset=+1]
1411

logging/v5_6/logging-5-6-administration.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
//Installing the Red Hat OpenShift Logging Operator via webconsole
10-
include::modules/logging-deploy-RHOL-console.adoc[leveloffset=+1]
11-
129
//Installing the Loki Operator via webconsole
1310
include::modules/logging-deploy-loki-console.adoc[leveloffset=+1]
1411

logging/v5_7/logging-5-7-administration.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
//Installing the Red Hat OpenShift Logging Operator via webconsole
10-
include::modules/logging-deploy-RHOL-console.adoc[leveloffset=+1]
11-
129
//Installing the Loki Operator via webconsole
1310
include::modules/logging-deploy-loki-console.adoc[leveloffset=+1]
1411

modules/cluster-logging-deploy-certificates.adoc

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

0 commit comments

Comments
 (0)