Skip to content

Commit 7a836fe

Browse files
authored
Merge pull request #68919 from abrennan89/OBSDOCS-650
OBSDOCS-650: Add docs for CLF supporting clusterlogging
2 parents 9f4e3e3 + 6e563f9 commit 7a836fe

File tree

3 files changed

+62
-3
lines changed

3 files changed

+62
-3
lines changed

logging/config/cluster-logging-moving-nodes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
:context: cluster-logging-moving
3-
[id="cluster-logging-moving"]
3+
[id="cluster-logging-moving-nodes"]
44
= Moving {logging} resources with node selectors
55
include::_attributes/common-attributes.adoc[]
66

logging/log_collection_forwarding/cluster-logging-collector.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
88
toc::[]
99

1010
{logging-title-uc} collects operations and application logs from your cluster and enriches the data with Kubernetes pod and project metadata.
11-
12-
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).
11+
All supported modifications to the log collector can be performed though the `spec.collection` stanza in the `ClusterLogging` custom resource (CR).
1312

1413
include::modules/configuring-logging-collector.adoc[leveloffset=+1]
1514

15+
include::modules/log-collector-resources-scheduling.adoc[leveloffset=+1]
16+
1617
include::modules/cluster-logging-collector-pod-location.adoc[leveloffset=+1]
1718

1819
include::modules/cluster-logging-collector-limits.adoc[leveloffset=+1]
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * logging/log_collection_forwarding/log-forwarding.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="log-collector-resources-scheduling_{context}"]
7+
= Configuring resources and scheduling for logging collectors
8+
9+
Administrators can modify the resources or scheduling of the collector by creating a `ClusterLogging` custom resource (CR) that is in the same namespace and has the same name as the `ClusterLogForwarder` CR that it supports.
10+
11+
The applicable stanzas for the `ClusterLogging` CR when using multiple log forwarders in a deployment are `managmentState` and `collection`. All other stanzas are ignored.
12+
13+
.Prerequisites
14+
15+
* You have administrator permissions.
16+
* You have installed the {clo} version 5.8 or newer.
17+
* You have created a `ClusterLogForwarder` CR.
18+
19+
.Procedure
20+
21+
. Create a `ClusterLogging` CR that supports your existing `ClusterLogForwarder` CR:
22+
+
23+
.Example `ClusterLogging` CR YAML
24+
[source,yaml]
25+
----
26+
apiVersion: logging.openshift.io/v1
27+
kind: ClusterLogging
28+
metadata:
29+
name: <name> # <1>
30+
namespace: <namespace> # <2>
31+
spec:
32+
managementState: "Managed"
33+
collection:
34+
type: "vector"
35+
tolerations:
36+
- key: "logging"
37+
operator: "Exists"
38+
effect: "NoExecute"
39+
tolerationSeconds: 6000
40+
resources:
41+
limits:
42+
memory: 1Gi
43+
requests:
44+
cpu: 100m
45+
memory: 1Gi
46+
nodeSelector:
47+
collector: needed
48+
# ...
49+
----
50+
<1> The name must be the same name as the `ClusterLogForwarder` CR.
51+
<2> The namespace must be the same namespace as the `ClusterLogForwarder` CR.
52+
53+
. Apply the `ClusterLogging` CR by running the following command:
54+
+
55+
[source,terminal]
56+
----
57+
$ oc apply -f <filename>.yaml
58+
----

0 commit comments

Comments
 (0)