Skip to content

Commit 22249b7

Browse files
mburke5678mburke5678
authored
Merge pull request #12866 from mburke5678/enterprise-4.0
New assembly and modules for About EFK Logging
2 parents f6d2245 + bc94545 commit 22249b7

File tree

70 files changed

+6374
-13
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+6374
-13
lines changed

‎_topic_map.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,34 @@ Topics:
7070
File: osdk-getting-started
7171
- Name: Migrating to Operator SDK v0.1.0
7272
File: migrating-to-osdk-v0-1-0
73+
---
74+
Name: Aggregated EFK Logging
75+
Dir: logging
76+
Distros: openshift-*
77+
Topics:
78+
- Name: About EFK logging
79+
File: efk-logging
80+
- Name: Deploying EFK stack
81+
File: efk-logging-deploy
82+
- Name: Uninstalling the EFK stack
83+
File: efk-logging-uninstall
84+
- Name: Troubleshooting Kubernetes
85+
File: efk-logging-troubleshooting
86+
- Name: Working with Elasticsearch
87+
File: efk-logging-elasticsearch
88+
- Name: Working with Fluentd
89+
File: efk-logging-fluentd
90+
- Name: Working with Kibana
91+
File: efk-logging-kibana
92+
- Name: Working with Curator
93+
File: efk-logging-curator
94+
- Name: Sending logs to external devices
95+
File: efk-logging-external
96+
- Name: Setting the EFK logging driver
97+
File: efk-logging-driver
98+
- Name: Manually rolling out Elasticsearch
99+
File: efk-logging-manual-rollout
100+
- Name: Configuring systemd-journald and rsyslog
101+
File: efk-logging-systemd
102+
- Name: Exported fields
103+
File: efk-logging-exported-fields

‎logging/efk-logging-curator.adoc

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
// For example:
2+
// * file name: assembly_my-assembly-a.adoc
3+
// * ID: [id='assembly_my-assembly-a_{context}']
4+
// * Title: = My assembly A
5+
//
6+
// The ID is used as an anchor for linking to the module.
7+
// Avoid changing it after the module has been published
8+
// to ensure existing links are not broken.
9+
//
10+
// In order for the assembly to be reusable in other assemblies in a guide,
11+
// include {context} in the ID: [id='a-collection-of-modules_{context}'].
12+
//
13+
// If the assembly covers a task, start the title with a verb in the gerund
14+
// form, such as Creating or Configuring.
15+
// The `context` attribute enables module reuse. Every module's ID
16+
// includes {context}, which ensures that the module has a unique ID even if
17+
// it is reused multiple times in a guide.
18+
ifdef::context[:parent-context: {context}]
19+
:context: efk-logging-curator
20+
[id='efk-logging-curator_{context}']
21+
= Working with Elasticsearch Curator in {product-title}
22+
{product-author}
23+
{product-version}
24+
ifdef::openshift-enterprise[]
25+
:latest-tag: v3.11.16
26+
endif::[]
27+
ifdef::openshift-origin[]
28+
:latest-tag: v3.11.16
29+
endif::[]
30+
:data-uri:
31+
:icons:
32+
:experimental:
33+
:toc: macro
34+
:toc-title:
35+
:prewrap!:
36+
37+
toc::[]
38+
39+
As an administrator, you can use the built-in Elasticsearch Curator tool to configure scheduled Elasticsearch maintenance operations
40+
to be performed automatically on a per-project basis.
41+
42+
// The following include statements pull in the module files that comprise
43+
// the assembly. Include any combination of concept, procedure, or reference
44+
// modules required to cover the user story. You can also include other
45+
// assemblies.
46+
47+
include::modules/efk-logging-curator-configure.adoc[leveloffset=+2]
48+
49+
include::modules/efk-logging-curator-actions.adoc[leveloffset=+2]
50+
51+
include::modules/efk-logging-curator-configuration.adoc[leveloffset=+2]
52+
53+
ifdef::parent-context[:context: {parent-context}]
54+
ifndef::parent-context[:!context:]

‎logging/efk-logging-deploy.adoc

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
// For example:
2+
// * file name: assembly_my-assembly-a.adoc
3+
// * ID: [id='assembly_my-assembly-a_{context}']
4+
// * Title: = My assembly A
5+
//
6+
// The ID is used as an anchor for linking to the module.
7+
// Avoid changing it after the module has been published
8+
// to ensure existing links are not broken.
9+
//
10+
// In order for the assembly to be reusable in other assemblies in a guide,
11+
// include {context} in the ID: [id='a-collection-of-modules_{context}'].
12+
//
13+
// If the assembly covers a task, start the title with a verb in the gerund
14+
// form, such as Creating or Configuring.
15+
// The `context` attribute enables module reuse. Every module's ID
16+
// includes {context}, which ensures that the module has a unique ID even if
17+
// it is reused multiple times in a guide.
18+
ifdef::context[:parent-context: {context}]
19+
:context: efk-logging-deploy
20+
[id='efk-logging-deploy_{context}']
21+
= Deploying EFK logging
22+
{product-author}
23+
{product-version}
24+
ifdef::openshift-enterprise[]
25+
:latest-tag: v3.11.16
26+
endif::[]
27+
ifdef::openshift-origin[]
28+
:latest-tag: v3.11.16
29+
endif::[]
30+
:data-uri:
31+
:icons:
32+
:experimental:
33+
:toc: macro
34+
:toc-title:
35+
:prewrap!:
36+
37+
toc::[]
38+
39+
The process for deploying the EFK into {prouct-title} involves:
40+
41+
* Preparing yourself and your environment;
42+
43+
* Editing the Ansible inventory file for your environment;
44+
45+
* Optionally, configure the inventory file to deploy the Ops Cluster;
46+
47+
* Optionally, configure the inventory file to deploy the eventrouter;
48+
49+
* Running the logging installer Ansible playbook.
50+
51+
// The following include statements pull in the module files that comprise
52+
// the assembly. Include any combination of concept, procedure, or reference
53+
// modules required to cover the user story. You can also include other
54+
// assemblies.
55+
56+
include::modules/efk-logging-deploy-pre.adoc[leveloffset=+2]
57+
58+
include::modules/efk-logging-storage-considerations.adoc[leveloffset=+2]
59+
60+
include::modules/efk-logging-deploy-variables.adoc[leveloffset=+2]
61+
62+
include::modules/efk-logging-deploy-ops-cluster.adoc[leveloffset=+2]
63+
64+
include::modules/efk-logging-deploy-eventrouter.adoc[leveloffset=+2]
65+
66+
include::modules/efk-logging-deploy-memory.adoc[leveloffset=+2]
67+
68+
include::modules/efk-logging-deploy-certificates.adoc[leveloffset=+2]
69+
70+
include::modules/efk-logging-deploy-playbook.adoc[leveloffset=+2]
71+
72+
include::modules/efk-logging-deploy-label.adoc[leveloffset=+2]
73+
74+
ifdef::parent-context[:context: {parent-context}]
75+
ifndef::parent-context[:!context:]

‎logging/efk-logging-driver.adoc

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
// For example:
2+
// * file name: assembly_my-assembly-a.adoc
3+
// * ID: [id='assembly_my-assembly-a_{context}']
4+
// * Title: = My assembly A
5+
//
6+
// The ID is used as an anchor for linking to the module.
7+
// Avoid changing it after the module has been published
8+
// to ensure existing links are not broken.
9+
//
10+
// In order for the assembly to be reusable in other assemblies in a guide,
11+
// include {context} in the ID: [id='a-collection-of-modules_{context}'].
12+
//
13+
// If the assembly covers a task, start the title with a verb in the gerund
14+
// form, such as Creating or Configuring.
15+
// The `context` attribute enables module reuse. Every module's ID
16+
// includes {context}, which ensures that the module has a unique ID even if
17+
// it is reused multiple times in a guide.
18+
ifdef::context[:parent-context: {context}]
19+
:context: efk-logging-driver
20+
[id='efk-logging-driver_{context}']
21+
= Setting the EFK logging driver
22+
{product-author}
23+
{product-version}
24+
ifdef::openshift-enterprise[]
25+
:latest-tag: v3.11.16
26+
endif::[]
27+
ifdef::openshift-origin[]
28+
:latest-tag: v3.11.16
29+
endif::[]
30+
:data-uri:
31+
:icons:
32+
:experimental:
33+
:toc: macro
34+
:toc-title:
35+
:prewrap!:
36+
37+
toc::[]
38+
39+
By default, the *json-file* log driver is used by default for Docker in {product-title} as of {product-title} 3.9.
40+
However, if you have upgraded from {product-title} 3.7, your cluster might be configured to use the *journald* log driver configuration.
41+
42+
If you are using EFK logging, you should use the *json-file* log driver.
43+
44+
// The following include statements pull in the module files that comprise
45+
// the assembly. Include any combination of concept, procedure, or reference
46+
// modules required to cover the user story. You can also include other
47+
// assemblies.
48+
49+
include::modules/efk-logging-driver-viewing.adoc[leveloffset=+2]
50+
51+
include::modules/efk-logging-driver-changing.adoc[leveloffset=+2]
52+
53+
ifdef::parent-context[:context: {parent-context}]
54+
ifndef::parent-context[:!context:]

‎logging/efk-logging-elasticsearch.adoc

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// For example:
2+
// * file name: assembly_my-assembly-a.adoc
3+
// * ID: [id='assembly_my-assembly-a_{context}']
4+
// * Title: = My assembly A
5+
//
6+
// The ID is used as an anchor for linking to the module.
7+
// Avoid changing it after the module has been published
8+
// to ensure existing links are not broken.
9+
//
10+
// In order for the assembly to be reusable in other assemblies in a guide,
11+
// include {context} in the ID: [id='a-collection-of-modules_{context}'].
12+
//
13+
// If the assembly covers a task, start the title with a verb in the gerund
14+
// form, such as Creating or Configuring.
15+
// The `context` attribute enables module reuse. Every module's ID
16+
// includes {context}, which ensures that the module has a unique ID even if
17+
// it is reused multiple times in a guide.
18+
ifdef::context[:parent-context: {context}]
19+
:context: efk-logging-elasticseearch
20+
[id='efk-logging-elasticsearch_{context}']
21+
= Working with Elasticsearch in {product-title}
22+
{product-author}
23+
{product-version}
24+
ifdef::openshift-enterprise[]
25+
:latest-tag: v3.11.16
26+
endif::[]
27+
ifdef::openshift-origin[]
28+
:latest-tag: v3.11.16
29+
endif::[]
30+
:data-uri:
31+
:icons:
32+
:experimental:
33+
:toc: macro
34+
:toc-title:
35+
:prewrap!:
36+
37+
toc::[]
38+
39+
{product-title} uses Elasticsearch (ES) to organize the log data from Fleutnd into datastores, or _indices_.
40+
41+
// The following include statements pull in the module files that comprise
42+
// the assembly. Include any combination of concept, procedure, or reference
43+
// modules required to cover the user story. You can also include other
44+
// assemblies.
45+
46+
include::modules/efk-logging-elasticsearch-ha.adoc[leveloffset=+2]
47+
48+
include::modules/efk-logging-elasticsearch-persistent-storage.adoc[leveloffset=+2]
49+
50+
include::modules/efk-logging-elasticsearch-scaling.adoc[leveloffset=+2]
51+
52+
include::modules/efk-logging-elasticsearch-exposing.adoc[leveloffset=+2]
53+
54+
ifdef::parent-context[:context: {parent-context}]
55+
ifndef::parent-context[:!context:]

‎logging/efk-logging-exported-fields.adoc

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
// For example:
2+
// * file name: assembly_my-assembly-a.adoc
3+
// * ID: [id='assembly_my-assembly-a_{context}']
4+
// * Title: = My assembly A
5+
//
6+
// The ID is used as an anchor for linking to the module.
7+
// Avoid changing it after the module has been published
8+
// to ensure existing links are not broken.
9+
//
10+
// In order for the assembly to be reusable in other assemblies in a guide,
11+
// include {context} in the ID: [id='a-collection-of-modules_{context}'].
12+
//
13+
// If the assembly covers a task, start the title with a verb in the gerund
14+
// form, such as Creating or Configuring.
15+
// The `context` attribute enables module reuse. Every module's ID
16+
// includes {context}, which ensures that the module has a unique ID even if
17+
// it is reused multiple times in a guide.
18+
ifdef::context[:parent-context: {context}]
19+
:context: efk-logging-exported-fields
20+
[id='efk-logging-exported-fields_{context}']
21+
= Exported fields
22+
{product-author}
23+
{product-version}
24+
ifdef::openshift-enterprise[]
25+
:latest-tag: v3.11.16
26+
endif::[]
27+
ifdef::openshift-origin[]
28+
:latest-tag: v3.11.16
29+
endif::[]
30+
:data-uri:
31+
:icons:
32+
:experimental:
33+
:toc: macro
34+
:toc-title:
35+
:prewrap!:
36+
37+
toc::[]
38+
39+
40+
41+
These are the fields exported by the logging system and available for searching
42+
from Elasticsearch and Kibana. Use the full, dotted field name when searching.
43+
For example, for an Elasticsearch */_search URL*, to look for a Kubernetes pod name,
44+
use `/_search/q=kubernetes.pod_name:name-of-my-pod`.
45+
46+
The following sections describe fields that may not be present in your logging store.
47+
Not all of these fields are present in every record.
48+
The fields are grouped in the following categories:
49+
50+
* `exported-fields-Default`
51+
* `exported-fields-rsyslog`
52+
* `exported-fields-systemd`
53+
* `exported-fields-kubernetes`
54+
* `exported-fields-docker`
55+
* `exported-fields-pipeline_metadata`
56+
* `exported-fields-ovirt`
57+
* `exported-fields-aushape`
58+
* `exported-fields-tlog`
59+
60+
// The following include statements pull in the module files that comprise
61+
// the assembly. Include any combination of concept, procedure, or reference
62+
// modules required to cover the user story. You can also include other
63+
// assemblies.
64+
65+
include::modules/efk-logging-exported-fields-default.adoc[leveloffset=+2]
66+
67+
include::modules/efk-logging-exported-fields-rsyslog.adoc[leveloffset=+2]
68+
69+
include::modules/efk-logging-exported-fields-systemd.adoc[leveloffset=+2]
70+
71+
include::modules/efk-logging-exported-fields-kubernetes.adoc[leveloffset=+2]
72+
73+
include::modules/efk-logging-exported-fields-docker.adoc[leveloffset=+2]
74+
75+
include::modules/efk-logging-exported-fields-ovirt.adoc[leveloffset=+2]
76+
77+
include::modules/efk-logging-exported-fields-aushape.adoc[leveloffset=+2]
78+
79+
include::modules/efk-logging-exported-fields-tlog.adoc[leveloffset=+2]
80+
81+
ifdef::parent-context[:context: {parent-context}]
82+
ifndef::parent-context[:!context:]

0 commit comments

Comments
 (0)