Skip to content

Commit 948e43a

Browse files
authored
Merge pull request #14078 from mburke5678/logging-team-edits-2
Edits to Logging 4.0 topics per team review 2
2 parents 79ba109 + baaf064 commit 948e43a

40 files changed

+415
-199
lines changed

_topic_map.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -460,6 +460,8 @@ Topics:
460460
File: efk-logging
461461
- Name: Deploying cluster logging
462462
File: efk-logging-deploy
463+
- Name: Changing cluster logging management state
464+
File: efk-logging-management
463465
- Name: Configuring cluster logging
464466
File: efk-logging-configuring
465467
- Name: Configuring Elasticsearch
@@ -472,7 +474,7 @@ Topics:
472474
File: efk-logging-fluentd
473475
- Name: Deploying and Configuring the Event Router
474476
File: efk-logging-eventrouter
475-
- Name: Configuring systemd-journald and rsyslog
477+
- Name: Configuring systemd-journald
476478
File: efk-logging-systemd
477479
- Name: Sending logs to external devices
478480
File: efk-logging-external

logging/efk-logging-configuring.adoc

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,29 +20,45 @@ and includes all the components of the logging stack to collect, store and visua
2020
apiVersion: logging.openshift.io/v1
2121
kind: ClusterLogging
2222
metadata:
23-
name: "instance"
23+
creationTimestamp: '2019-03-20T18:07:02Z'
24+
generation: 1
25+
name: instance
26+
namespace: openshift-logging
2427
spec:
25-
managementState: "Managed"
28+
collection:
29+
logs:
30+
fluentd:
31+
resources: null
32+
rsyslog:
33+
resources: null
34+
type: fluentd
35+
curation:
36+
curator:
37+
resources: null
38+
schedule: 30 3 * * *
39+
type: curator
2640
logStore:
27-
type: "elasticsearch"
2841
elasticsearch:
2942
nodeCount: 3
43+
redundancyPolicy: SingleRedundancy
44+
resources:
45+
limits:
46+
cpu:
47+
memory:
48+
requests:
49+
cpu:
50+
memory:
3051
storage: {}
31-
redundancyPolicy: "SingleRedundancy"
52+
type: elasticsearch
53+
managementState: Managed
3254
visualization:
33-
type: "kibana"
3455
kibana:
56+
proxy:
57+
resources: null
3558
replicas: 1
36-
curation:
37-
type: "curator"
38-
curator:
39-
schedule: "30 3 * * *"
40-
collection:
41-
logs:
42-
type: "fluentd"
43-
fluentd: {}
59+
resources: null
60+
type: kibana
4461
----
45-
4662
You can configure the following for cluster logging:
4763

4864
* You can place cluster logging into an unmanaged state that allows an administrator to assume full control of individual
@@ -68,8 +84,6 @@ The Rsyslog log collector is currently a Technology Preview feature.
6884
// modules required to cover the user story. You can also include other
6985
// assemblies.
7086

71-
include::modules/efk-logging-management-state-changing.adoc[leveloffset=+1]
72-
7387
include::modules/efk-logging-configuring-image-about.adoc[leveloffset=+1]
7488

7589
include::modules/efk-logging-configuring-node-selector.adoc[leveloffset=+1]

logging/efk-logging-curator.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Optionally, you can use the actions file, *_actions.yaml_*, directly. Editing th
106106

107107
[NOTE]
108108
====
109-
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-configuring.html#efk-logging-elasticsearch-management-state-changing-efk-logging-configuring[Changing the cluster logging management state].
109+
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-management.adoc#efk-logging-management[Changing the cluster logging management state].
110110
====
111111

112112
// The following include statements pull in the module files that comprise
@@ -123,4 +123,3 @@ include::modules/efk-logging-curator-delete-index.adoc[leveloffset=+1]
123123
include::modules/efk-logging-curator-actions.adoc[leveloffset=+1]
124124

125125
include::modules/efk-logging-curator-cron.adoc[leveloffset=+1]
126-

logging/efk-logging-deploy.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ include::modules/efk-logging-deploy-storage-considerations.adoc[leveloffset=+1]
2828

2929
== Additional resources
3030

31-
For more information on installing operators,see xref:../applications/operators/olm-adding-operators-to-cluster.html#olm-installing-operators-from-operatorhub-olm-adding-operators-to-a-cluster[Installing Operators from the OperatorHub].
31+
For more information on installing operators, see xref:../applications/operators/olm-adding-operators-to-cluster.html#olm-installing-operators-from-operatorhub-olm-adding-operators-to-a-cluster[Installing Operators from the OperatorHub].
32+
33+
For more information about storage, see xref:../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage].
3234

3335
For information on scaling your Elasticsearch cluster, see xref:../logging/efk-logging-elasticsearch.adoc#efk-logging-elasticsearch-add-remove-efk-logging-elasticsearch[Scaling your Elasticsearch cluster].

logging/efk-logging-elasticsearch-storage.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ metadata:
3939

4040
[NOTE]
4141
====
42-
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-configuring.html#efk-logging-elasticsearch-management-state-changing-efk-logging-configuring[Changing the cluster logging management state].
42+
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-management.adoc#efk-logging-management[Changing the cluster logging management state].
4343
====
4444

4545
// The following include statements pull in the module files that comprise

logging/efk-logging-elasticsearch.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ or higher memory. Each Elasticsearch node can operate with a lower memory settin
1919

2020
[NOTE]
2121
====
22-
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-configuring.html#efk-logging-elasticsearch-management-state-changing-efk-logging-configuring[Changing the cluster logging management state].
22+
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-management.adoc#efk-logging-management[Changing the cluster logging management state].
2323
====
2424

2525
// The following include statements pull in the module files that comprise

logging/efk-logging-external.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ or an external syslog server. You can also configure Fluentd to send logs to an
1010

1111
[NOTE]
1212
====
13-
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-configuring.html#efk-logging-elasticsearch-management-state-changing-efk-logging-configuring[Changing the cluster logging management state].
13+
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-management.adoc#efk-logging-management[Changing the cluster logging management state].
1414
====
1515

1616
// The following include statements pull in the module files that comprise

logging/efk-logging-fluentd.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can configure log rotation, log location, use an external log aggregator, an
1111

1212
[NOTE]
1313
====
14-
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-configuring.html#efk-logging-elasticsearch-management-state-changing-efk-logging-configuring[Changing the cluster logging management state].
14+
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-management.adoc#efk-logging-management[Changing the cluster logging management state].
1515
====
1616

1717
// The following include statements pull in the module files that comprise
@@ -29,10 +29,10 @@ include::modules/efk-logging-fluentd-limits.adoc[leveloffset=+1]
2929

3030
////
3131
4.1
32-
::modules/efk-logging-fluentd-collector.adoc[leveloffset=+1]
32+
modules/efk-logging-fluentd-log-rotation.adoc[leveloffset=+1]
3333
////
3434

35-
include::modules/efk-logging-fluentd-log-rotation.adoc[leveloffset=+1]
35+
include::modules/efk-logging-fluentd-collector.adoc[leveloffset=+1]
3636

3737
include::modules/efk-logging-fluentd-log-location.adoc[leveloffset=+1]
3838

logging/efk-logging-kibana.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can scale Kibana for redundancy and configure the CPU and memory for your Ki
1111

1212
[NOTE]
1313
====
14-
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-configuring.html#efk-logging-elasticsearch-management-state-changing-efk-logging-configuring[Changing the cluster logging management state].
14+
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-management.adoc#efk-logging-management[Changing the cluster logging management state].
1515
====
1616

1717
// The following include statements pull in the module files that comprise

logging/efk-logging-management.adoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
:context: efk-logging-curator
2+
[id='efk-logging-management']
3+
= Changing cluster logging management state
4+
include::modules/common-attributes.adoc[]
5+
6+
toc::[]
7+
8+
9+
The Cluster Logging Operator and Elasticsearch Operator can be in a _Managed_ or _Unmanaged_ state.
10+
11+
By default, the Cluster Logging and Elasticsearch operators are set to Managed. However, in order to modify the components managed by the Cluster Logging Operator,
12+
you need to set cluster logging to the _unmanaged_ state. In order to modify the components managed by the Elasticsearch Operator,
13+
you need to set Elasticsearch to the _unmanaged_ state.
14+
15+
// The following include statements pull in the module files that comprise
16+
// the assembly. Include any combination of concept, procedure, or reference
17+
// modules required to cover the user story. You can also include other
18+
// assemblies.
19+
20+
include::modules/efk-logging-management-state-changing.adoc[leveloffset=+1]
21+
22+
include::modules/efk-logging-management-state-changing-es.adoc[leveloffset=+1]
23+

0 commit comments

Comments
 (0)