Skip to content

Commit ddea859

Browse files
committed
RHDEVDOCS-2495 Update Logging docs for declarative configs
1 parent 7b46ab4 commit ddea859

6 files changed

+24
-3
lines changed

modules/cluster-logging-collector-legacy-fluentd.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ endif::openshift-origin[]
1818

1919
To send logs using the Fluentd *forward* protocol, create a configuration file called `secure-forward.conf`, that points to an external log aggregator. Then, use that file to create a config map called called `secure-forward` in the `openshift-logging` project, which {product-title} uses when forwarding the logs.
2020

21+
.Prerequisites
22+
23+
* You must have a logging server that is configured to receive the logging data using the specified protocol or format.
24+
2125
.Sample Fluentd configuration file
2226

2327
[source,yaml]

modules/cluster-logging-collector-legacy-syslog.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[id="cluster-logging-collector-legacy-syslog_{context}"]
66
= Forwarding logs using the legacy syslog method
77

8-
You can use the *syslog* RFC3164 protocol to send logs to destinations outside of your {product-title} cluster by creating a configuration file and config map. You are responsible for configuring the external log aggregator, such as a syslog server, to receive log data from {product-title}.
8+
You can use the *syslog* RFC3164 protocol to send logs to destinations outside of your {product-title} cluster by creating a configuration file and config map. You are responsible for configuring the external log aggregator, such as a syslog server, to receive the logs from {product-title}.
99

1010
[IMPORTANT]
1111
====
@@ -19,6 +19,11 @@ There are two versions of the *syslog* protocol:
1919

2020
To send logs using the *syslog* protocol, create a configuration file called `syslog.conf`, with the information needed to forward the logs. Then, use that file to create a config map called `syslog` in the `openshift-logging` project, which {product-title} uses when forwarding the logs.
2121

22+
.Prerequisites
23+
24+
* You must have a logging server that is configured to receive the logging data using the specified protocol or format.
25+
26+
2227
.Sample syslog configuration file
2328
[source,yaml]
2429
----

modules/cluster-logging-collector-log-forward-es.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ To forward logs to both an external and the internal Elasticsearch instance, cre
1616
If you want to forward logs to *only* the internal {product-title} Elasticsearch instance, you do not need to create a `ClusterLogForwarder` CR.
1717
====
1818

19+
.Prerequisites
20+
21+
* You must have a logging server that is configured to receive the logging data using the specified protocol or format.
22+
1923
.Procedure
2024

2125
. Create a `ClusterLogForwarder` CR YAML file similar to the following:

modules/cluster-logging-collector-log-forward-fluentd.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ To configure log forwarding using the *forward* protocol, create a `ClusterLogFo
1414
Alternately, you can use a config map to forward logs using the *forward* protocols. However, this method is deprecated in {product-title} and will be removed in a future release.
1515
====
1616

17+
.Prerequisites
18+
19+
* You must have a logging server that is configured to receive the logging data using the specified protocol or format.
20+
1721
.Procedure
1822

1923
. Create a `ClusterLogForwarder` CR YAML file similar to the following:

modules/cluster-logging-collector-log-forward-project.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To configure forwarding application logs from a project, create a `ClusterLogFor
1111

1212
.Prerequisites
1313

14-
* An external log aggregator that is configured to receive log data from {product-title} using the specified protocol.
14+
* You must have a logging server that is configured to receive the logging data using the specified protocol or format.
1515

1616
.Procedure
1717

modules/cluster-logging-collector-log-forward-syslog.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[id="cluster-logging-collector-log-forward-syslog_{context}"]
66
= Forwarding logs using the syslog protocol
77

8-
You can use the *syslog* link:https://tools.ietf.org/html/rfc3164[RFC3164] or link:https://tools.ietf.org/html/rfc5424[RFC5424] protocol to send a copy of your logs to an external log aggregator configured to accept the protocol instead of, or in addition to, the default Elasticsearch log store. You are responsible for configuring the external log aggregator to receive the logs from {product-title}.
8+
You can use the *syslog* link:https://tools.ietf.org/html/rfc3164[RFC3164] or link:https://tools.ietf.org/html/rfc5424[RFC5424] protocol to send a copy of your logs to an external log aggregator configured to accept the protocol instead of, or in addition to, the default Elasticsearch log store. You are responsible for configuring the external log aggregator, such as a syslog server, to receive the logs from {product-title}.
99

1010
To configure log forwarding using the *syslog* protocol, create a `ClusterLogForwarder` custom resource (CR) with one or more outputs to the syslog servers and pipelines that use those outputs. The syslog output can use a UDP, TCP, or TLS connection.
1111

@@ -14,6 +14,10 @@ To configure log forwarding using the *syslog* protocol, create a `ClusterLogFor
1414
Alternately, you can use a config map to forward logs using the *syslog* RFC3164 protocols. However, this method is deprecated in {product-title} and will be removed in a future release.
1515
====
1616

17+
.Prerequisites
18+
19+
* You must have a logging server that is configured to receive the logging data using the specified protocol or format.
20+
1721
.Procedure
1822

1923
. Create a `ClusterLogForwarder` CR YAML file similar to the following:

0 commit comments

Comments
 (0)