Skip to content

Commit 2bc120a

Browse files
committed
Logging: Moving configuring topics into a subdirectory
1 parent e5c33f9 commit 2bc120a

18 files changed

+470
-116
lines changed

_topic_map.yml

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -480,26 +480,33 @@ Distros: openshift-*
480480
Topics:
481481
- Name: About cluster logging
482482
File: efk-logging
483+
- Name: About deploying cluster logging
484+
File: efk-logging-deploying-about
483485
- Name: Deploying cluster logging
484-
File: efk-logging-deploy
485-
- Name: Changing cluster logging management state
486-
File: efk-logging-management
487-
- Name: Configuring cluster logging
488-
File: efk-logging-configuring
489-
- Name: Configuring Elasticsearch
490-
File: efk-logging-elasticsearch
491-
- Name: Configuring Kibana
492-
File: efk-logging-kibana
493-
- Name: Configuring Curator
494-
File: efk-logging-curator
495-
- Name: Configuring Fluentd
496-
File: efk-logging-fluentd
486+
File: efk-logging-deploying
497487
- Name: Deploying and Configuring the Event Router
498488
File: efk-logging-eventrouter
499-
- Name: Configuring systemd-journald
500-
File: efk-logging-systemd
501-
- Name: Sending logs to external devices
502-
File: efk-logging-external
489+
- Name: Configuring your cluster logging deployment
490+
Dir: config
491+
Topics:
492+
- Name: About configuring cluster logging
493+
File: efk-logging-configuring-about
494+
- Name: Changing cluster logging management state
495+
File: efk-logging-management
496+
- Name: Configuring cluster logging
497+
File: efk-logging-configuring
498+
- Name: Configuring Elasticsearch
499+
File: efk-logging-elasticsearch
500+
- Name: Configuring Kibana
501+
File: efk-logging-kibana
502+
- Name: Configuring Curator
503+
File: efk-logging-curator
504+
- Name: Configuring Fluentd
505+
File: efk-logging-fluentd
506+
- Name: Configuring systemd-journald
507+
File: efk-logging-systemd
508+
- Name: Sending logs to external devices
509+
File: efk-logging-external
503510
- Name: Manually rolling out Elasticsearch
504511
File: efk-logging-manual-rollout
505512
- 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 xref:../../logging/config/efk-logging-management.adoc#efk-logging-management[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 xref:../../logging/config/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

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 xref:../../logging/config/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
@@ -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 xref:../../logging/config/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 renamed to logging/config/efk-logging-fluentd.adoc

Lines changed: 1 addition & 1 deletion
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 xref:../../logging/config/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-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 xref:../../logging/config/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

0 commit comments

Comments
 (0)