Skip to content

Commit babb96a

Browse files
committed
OBSDOCS-144: Updating ClusterLogging docs
1 parent 27983c1 commit babb96a

18 files changed

+202
-154
lines changed

_attributes/attributes-openshift-dedicated.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,17 @@
2020
:rhq-short: Red Hat Quay
2121
:SMProductName: Red Hat OpenShift Service Mesh
2222
:pipelines-title: Red Hat OpenShift Pipelines
23+
//logging
24+
:logging-title: logging subsystem for Red Hat OpenShift
25+
:logging-title-uc: Logging subsystem for Red Hat OpenShift
26+
:logging: logging subsystem
27+
:logging-uc: Logging subsystem
28+
:clo: Red Hat OpenShift Logging Operator
29+
:loki-op: Loki Operator
30+
:es-op: Elasticsearch Operator
2331
:logging-sd: Red Hat OpenShift Logging
2432
:log-plug: logging subsystem Console Plugin
33+
//
2534
:ServerlessProductName: OpenShift Serverless
2635
:rh-openstack-first: Red Hat OpenStack Platform (RHOSP)
2736
:rh-openstack: RHOSP

_topic_maps/_topic_map.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2544,8 +2544,6 @@ Topics:
25442544
Dir: config
25452545
Distros: openshift-enterprise,openshift-origin
25462546
Topics:
2547-
- Name: About the Cluster Logging custom resource
2548-
File: cluster-logging-configuring-cr
25492547
- Name: Configuring the log store
25502548
File: cluster-logging-log-store
25512549
- Name: Configuring CPU and memory limits for Logging components

_topic_maps/_topic_map_osd.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1055,8 +1055,6 @@ Topics:
10551055
- Name: Configuring your Logging deployment
10561056
Dir: config
10571057
Topics:
1058-
- Name: About the Cluster Logging custom resource
1059-
File: cluster-logging-configuring-cr
10601058
- Name: Configuring the log store
10611059
File: cluster-logging-log-store
10621060
- Name: Configuring CPU and memory limits for Logging components

_topic_maps/_topic_map_rosa.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Topics:
8888
# File: rosa-mobb-prerequisites-tutorial
8989
- Name: Verifying Permissions for a ROSA STS Deployment
9090
File: rosa-mobb-verify-permissions-sts-deployment
91-
- Name: Configuring the Cluster Log Forwarder for CloudWatch logs and STS
91+
- Name: Configuring log forwarding for CloudWatch logs and STS
9292
File: cloud-experts-rosa-cloudwatch-sts
9393
- Name: Using AWS WAF and Amazon CloudFront to protect ROSA workloads
9494
File: cloud-experts-using-cloudfront-and-waf
@@ -351,7 +351,7 @@ Topics:
351351
Topics:
352352
- Name: Installing the web terminal
353353
File: installing-web-terminal
354-
# Do not have sufficient permissions to read any cluster configuration.
354+
# Do not have sufficient permissions to read any cluster configuration.
355355
# - Name: Configuring the web terminal
356356
# File: configuring-web-terminal
357357
- Name: Using the web terminal
@@ -1239,8 +1239,6 @@ Topics:
12391239
- Name: Configuring your Logging deployment
12401240
Dir: config
12411241
Topics:
1242-
- Name: About the Cluster Logging custom resource
1243-
File: cluster-logging-configuring-cr
12441242
- Name: Configuring the log store
12451243
File: cluster-logging-log-store
12461244
- Name: Configuring CPU and memory limits for Logging components

cloud_experts_tutorials/cloud-experts-rosa-cloudwatch-sts.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="cloud-experts-rosa-cloudwatch-sts"]
3-
= Tutorial: Configuring the Cluster Log Forwarder for CloudWatch logs and STS
3+
= Configuring log forwarding for CloudWatch logs and STS
44
include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: cloud-experts-rosa-cloudwatch-sts
66

@@ -18,7 +18,7 @@ toc::[]
1818
// - Connor Wooley
1919
// ---
2020

21-
Use this tutorial to deploy the Cluster Log Forwarder Operator and configure it to use Security Token Services (STS) authentication to forward logs to CloudWatch.
21+
Use this tutorial to deploy the {clo} and configure it to use Security Token Services (STS) authentication to forward logs to CloudWatch.
2222

2323
[id="cloud-experts-rosa-cloudwatch-sts-prerequisites"]
2424
.Prerequisites
@@ -58,7 +58,7 @@ $ echo "Cluster: ${ROSA_CLUSTER_NAME}, Region: ${REGION}, OIDC Endpoint: ${OIDC_
5858
[id="cloud-experts-rosa-cloudwatch-sts-prep-aws"]
5959
== Preparing your AWS account
6060

61-
. Create an Identity Access Management (IAM) policy for OpenShift Log Forwarding:
61+
. Create an Identity Access Management (IAM) policy for the {logging}:
6262
+
6363
[source,terminal]
6464
----
@@ -127,7 +127,7 @@ $ aws iam attach-role-policy --role-name "${ROSA_CLUSTER_NAME}-RosaCloudWatch" \
127127
[id="cloud-experts-rosa-cloudwatch-sts-deploy-Os"]
128128
== Deploying Operators
129129

130-
. Deploy the Cluster Logging Operator:
130+
. Deploy the {clo}:
131131
+
132132
[source,terminal]
133133
----
@@ -166,7 +166,7 @@ EOF
166166
[id="cloud-experts-rosa-cloudwatch-sts-configure-cluster-logging"]
167167
== Configuring cluster logging
168168

169-
. Create a cluster-log forwarding resource:
169+
. Create a `ClusterLogForwarder` custom resource (CR):
170170
+
171171
[source,terminal]
172172
----
@@ -197,7 +197,7 @@ $ cat << EOF | oc apply -f -
197197
EOF
198198
----
199199

200-
. Create a cluster logging resource:
200+
. Create a `ClusterLogging` CR:
201201
+
202202
[source,terminal]
203203
----
@@ -258,14 +258,14 @@ If this is a new cluster, you might not see a log group for `application` logs a
258258
[id="cloud-experts-rosa-cloudwatch-sts-clean-up"]
259259
== Cleaning up your resources
260260

261-
. Delete the cluster-log forwarding resource:
261+
. Delete the `ClusterLogForwarder` CR:
262262
+
263263
[source,terminal]
264264
----
265265
$ oc delete -n openshift-logging clusterlogforwarder instance
266266
----
267267

268-
. Delete the cluster logging resource:
268+
. Delete the `ClusterLogging` CR:
269269
+
270270
[source,terminal]
271271
----
@@ -305,4 +305,4 @@ $ aws iam delete-policy --policy-arn "${POLICY_ARN}"
305305
----
306306
$ aws logs delete-log-group --log-group-name "rosa-${ROSA_CLUSTER_NAME}.audit"
307307
$ aws logs delete-log-group --log-group-name "rosa-${ROSA_CLUSTER_NAME}.infrastructure"
308-
----
308+
----

logging/cluster-logging-deploying.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,12 @@ include::modules/logging-install-es-operator.adoc[leveloffset=+2]
4343
[id="cluster-logging-deploying-postinstallation"]
4444
== Postinstallation tasks
4545

46-
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].
46+
After you have installed the {clo}, you can configure your deployment by creating and modifying a `ClusterLogging` custom resource (CR).
4747

48+
include::modules/cluster-logging-about-crd.adoc[leveloffset=+2]
49+
include::modules/configuring-log-storage-cr.adoc[leveloffset=+2]
50+
include::modules/configuring-logging-collector.adoc[leveloffset=+2]
51+
include::modules/configuring-log-visualizer.adoc[leveloffset=+2]
4852
include::modules/cluster-logging-deploy-multitenant.adoc[leveloffset=+2]
4953

5054
[role="_additional-resources"]

logging/cluster-logging-loki.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ include::modules/logging-loki-cli-install.adoc[leveloffset=+1]
2626

2727
include::modules/logging-clo-cli-install.adoc[leveloffset=+1]
2828

29+
include::modules/configuring-log-storage-cr.adoc[leveloffset=+1]
30+
2931
include::modules/logging-loki-storage.adoc[leveloffset=+1]
3032

3133
include::modules/logging-loki-storage-aws.adoc[leveloffset=+2]
@@ -79,10 +81,7 @@ xref:../authentication/using-rbac.adoc[Using RBAC to define and apply permission
7981
endif::[]
8082

8183
include::modules/logging-loki-retention.adoc[leveloffset=+1]
82-
83-
include::modules/cluster-logging-forwarding-lokistack.adoc[leveloffset=+1]
84-
85-
include::modules/loki-rate-limit-errors.adoc[leveloffset=+2]
84+
include::modules/loki-rate-limit-errors.adoc[leveloffset=+1]
8685

8786
[role="_additional-resources"]
8887
[id="additional-resources_cluster-logging-loki"]

logging/config/cluster-logging-configuring-cr.adoc

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

logging/log_collection_forwarding/cluster-logging-collector.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ toc::[]
1111

1212
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).
1313

14+
include::modules/configuring-logging-collector.adoc[leveloffset=+1]
15+
1416
include::modules/cluster-logging-collector-pod-location.adoc[leveloffset=+1]
1517

1618
include::modules/cluster-logging-collector-limits.adoc[leveloffset=+1]

logging/log_visualization/log-visualization.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ You can visualize your log data in the {product-title} web console, or the Kiban
1111

1212
include::snippets/logging-kibana-dep-snip.adoc[]
1313

14+
include::modules/configuring-log-visualizer.adoc[leveloffset=+1]
15+
1416
[id="log-visualization-resource-logs"]
1517
== Viewing logs for a resource
1618

0 commit comments

Comments
 (0)