Skip to content

Commit 79dda5c

Browse files
authored
Merge pull request #14326 from mburke5678/logging-config-subdir
Logging: Moving configuring topics into a subdirectory
2 parents 3ccaff4 + 3cc4b10 commit 79dda5c

20 files changed

+483
-123
lines changed

_topic_map.yml

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -478,26 +478,33 @@ Distros: openshift-*
478478
Topics:
479479
- Name: About cluster logging
480480
File: efk-logging
481+
- Name: About deploying cluster logging
482+
File: efk-logging-deploying-about
481483
- Name: Deploying cluster logging
482-
File: efk-logging-deploy
483-
- Name: Changing cluster logging management state
484-
File: efk-logging-management
485-
- Name: Configuring cluster logging
486-
File: efk-logging-configuring
487-
- Name: Configuring Elasticsearch
488-
File: efk-logging-elasticsearch
489-
- Name: Configuring Kibana
490-
File: efk-logging-kibana
491-
- Name: Configuring Curator
492-
File: efk-logging-curator
493-
- Name: Configuring Fluentd
494-
File: efk-logging-fluentd
484+
File: efk-logging-deploying
495485
- Name: Deploying and Configuring the Event Router
496486
File: efk-logging-eventrouter
497-
- Name: Configuring systemd-journald
498-
File: efk-logging-systemd
499-
- Name: Sending logs to external devices
500-
File: efk-logging-external
487+
- Name: Configuring your cluster logging deployment
488+
Dir: config
489+
Topics:
490+
- Name: About configuring cluster logging
491+
File: efk-logging-configuring-about
492+
- Name: Changing cluster logging management state
493+
File: efk-logging-management
494+
- Name: Configuring cluster logging
495+
File: efk-logging-configuring
496+
- Name: Configuring Elasticsearch
497+
File: efk-logging-elasticsearch
498+
- Name: Configuring Kibana
499+
File: efk-logging-kibana
500+
- Name: Configuring Curator
501+
File: efk-logging-curator
502+
- Name: Configuring Fluentd
503+
File: efk-logging-fluentd
504+
- Name: Configuring systemd-journald
505+
File: efk-logging-systemd
506+
- Name: Sending logs to external devices
507+
File: efk-logging-external
501508
- Name: Manually rolling out Elasticsearch
502509
File: efk-logging-manual-rollout
503510
- Name: Troubleshooting Kibana
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
:context: efk-logging-configuring-about
2+
[id="efk-logging-configuring-about"]
3+
= About configuring cluster logging
4+
include::modules/common-attributes.adoc[]
5+
6+
toc::[]
7+
8+
After installing cluster logging into your cluster, you can make the following configurations.
9+
10+
[NOTE]
11+
====
12+
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see _Changing the cluster logging management state_.
13+
====
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-deploying-about.adoc[leveloffset=+1]
21+
22+

logging/efk-logging-curator.adoc renamed to logging/config/efk-logging-curator.adoc

Lines changed: 1 addition & 1 deletion
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-management.adoc[Changing the cluster logging management state].
109+
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see _Changing the cluster logging management state_.
110110
====
111111

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

logging/efk-logging-elasticsearch.adoc renamed to logging/config/efk-logging-elasticsearch.adoc

Lines changed: 2 additions & 2 deletions
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-management.adoc[Changing the cluster logging management state].
22+
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see _Changing the cluster logging management state_.
2323
====
2424

2525
// The following include statements pull in the module files that comprise
@@ -51,5 +51,5 @@ modules/efk-logging-elasticsearch-persistent-storage-local.adoc[leveloffset=+2]
5151

5252
== Additional Resources
5353

54-
//For information on installing Elasticsearch, see xref:../logging/efk-logging-deploy.adoc[Deploying cluster logging].
54+
//For information on installing Elasticsearch, see xref:../../logging/efk-logging-deploying.adoc[Deploying cluster logging].
5555

logging/efk-logging-external.adoc renamed to logging/config/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-management.adoc[Changing the cluster logging management state].
13+
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see _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 renamed to logging/config/efk-logging-fluentd.adoc

Lines changed: 4 additions & 2 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-management.adoc[Changing the cluster logging management state].
14+
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see _Changing the cluster logging management state_.
1515
====
1616

1717
// The following include statements pull in the module files that comprise
@@ -30,9 +30,11 @@ include::modules/efk-logging-fluentd-limits.adoc[leveloffset=+1]
3030
////
3131
4.1
3232
modules/efk-logging-fluentd-log-rotation.adoc[leveloffset=+1]
33+
34+
4.2
35+
modules/efk-logging-fluentd-collector.adoc[leveloffset=+1]
3336
////
3437

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

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

logging/efk-logging-kibana.adoc renamed to logging/config/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-management.adoc[Changing the cluster logging management state].
14+
Procedures in this topic require your cluster to be in an unmanaged state. For more information, see _Changing the cluster logging management state_.
1515
====
1616

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

0 commit comments

Comments
 (0)