Skip to content

Commit dd6b27e

Browse files
gabriel-rhgabriel-rh
authored
Merge pull request #94054 from gabriel-rh/migrate-old-content-config
OBSDOCS-1972 migrate old content - add in config folder
2 parents 5255efc + 9a67942 commit dd6b27e

File tree

8 files changed

+135
-0
lines changed

8 files changed

+135
-0
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,15 @@ Distros: openshift-logging
3838
Topics:
3939
- Name: Upgrading to Logging 6.0
4040
File: upgrading-to-logging-60
41+
42+
---
43+
Name: Configuring your Logging deployment
44+
Dir: config
45+
Distros: openshift-logging
46+
Topics:
47+
- Name: Configuring OpenShift Logging
48+
File: cluster-logging-configuring
49+
- Name: Configuring CPU and memory limits for Logging components
50+
File: cluster-logging-memory
51+
- Name: Configuring systemd-journald for Logging
52+
File: cluster-logging-systemd

‎config/_attributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_attributes/

‎config/cluster-logging-configuring.adoc

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: cluster-logging-configuring
3+
[id="cluster-logging-configuring"]
4+
= Configuring OpenShift Logging
5+
include::_attributes/common-attributes.adoc[]
6+
7+
toc::[]
8+
9+
{logging-title-uc} is configurable using a `ClusterLogging` custom resource (CR) deployed
10+
in the `openshift-logging` project.
11+
12+
The {clo} watches for changes to `ClusterLogging` CR,
13+
creates any missing logging components, and adjusts the logging environment accordingly.
14+
15+
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.
16+
17+
.Sample `ClusterLogging` custom resource (CR)
18+
[source,yaml]
19+
----
20+
apiVersion: logging.openshift.io/v1
21+
kind: ClusterLogging
22+
metadata:
23+
creationTimestamp: '2019-03-20T18:07:02Z'
24+
generation: 1
25+
name: instance
26+
namespace: openshift-logging
27+
spec:
28+
collection:
29+
logs:
30+
fluentd:
31+
resources: null
32+
type: fluentd
33+
logStore:
34+
elasticsearch:
35+
nodeCount: 3
36+
redundancyPolicy: SingleRedundancy
37+
resources:
38+
limits:
39+
cpu:
40+
memory:
41+
requests:
42+
cpu:
43+
memory:
44+
storage: {}
45+
type: elasticsearch
46+
managementState: Managed
47+
visualization:
48+
kibana:
49+
proxy:
50+
resources: null
51+
replicas: 1
52+
resources: null
53+
type: kibana
54+
----
55+
You can configure the following for {logging}:
56+
57+
* You can overwrite the image for each {logging} component by modifying the appropriate
58+
environment variable in the `cluster-logging-operator` Deployment.
59+
60+
* You can specify specific nodes for the logging components using node selectors.
61+
62+
////
63+
* You can specify the Log collectors to deploy to each node in a cluster, either Fluentd or Rsyslog.
64+
65+
[IMPORTANT]
66+
====
67+
The Rsyslog log collector is currently a Technology Preview feature.
68+
====
69+
////
70+
71+
// The following include statements pull in the module files that comprise
72+
// the assembly. Include any combination of concept, procedure, or reference
73+
// modules required to cover the user story. You can also include other
74+
// assemblies.
75+
76+
// modules/cluster-logging-configuring-image-about.adoc[leveloffset=+1]
77+
78+
[IMPORTANT]
79+
====
80+
The logging routes are managed by the {clo} and cannot be modified by the user.
81+
====

‎config/cluster-logging-memory.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: cluster-logging-memory
3+
[id="cluster-logging-memory"]
4+
= Configuring CPU and memory limits for {logging} components
5+
include::_attributes/common-attributes.adoc[]
6+
7+
toc::[]
8+
9+
10+
You can configure both the CPU and memory limits for each of the {logging} components as needed.
11+
12+
13+
// The following include statements pull in the module files that comprise
14+
// the assembly. Include any combination of concept, procedure, or reference
15+
// modules required to cover the user story. You can also include other
16+
// assemblies.
17+
18+
19+
include::modules/cluster-logging-cpu-memory.adoc[leveloffset=+1]

‎config/cluster-logging-systemd.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: cluster-logging-systemd
3+
[id="cluster-logging-systemd"]
4+
= Configuring systemd-journald and Fluentd
5+
include::_attributes/common-attributes.adoc[]
6+
7+
toc::[]
8+
9+
Because Fluentd reads from the journal, and the journal default settings are very low, journal entries can be lost because the journal cannot keep up with the logging rate from system services.
10+
11+
We recommend setting `RateLimitIntervalSec=30s` and `RateLimitBurst=10000` (or even higher if necessary) to prevent the journal from losing entries.
12+
13+
// The following include statements pull in the module files that comprise
14+
// the assembly. Include any combination of concept, procedure, or reference
15+
// modules required to cover the user story. You can also include other
16+
// assemblies.
17+
18+
19+
include::modules/cluster-logging-systemd-scaling.adoc[leveloffset=+1]

‎config/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../images/

‎config/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../modules/

‎config/snippets

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../snippets/

0 commit comments

Comments
 (0)