Skip to content

Commit 71fb651

Browse files
authored
Merge pull request #23485 from mburke5678/logging-fix-topic-forwarding
Log forwarding assembly called wrong module
2 parents f9d8be9 + 6e44b53 commit 71fb651

File tree

3 files changed

+8
-110
lines changed

3 files changed

+8
-110
lines changed

logging/config/cluster-logging-external.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The methods for forwarding logs using a ConfigMap are deprecated and will be rep
2828
include::modules/cluster-logging-collector-fluentd.adoc[leveloffset=+1]
2929
include::modules/cluster-logging-collector-syslog.adoc[leveloffset=+1]
3030
include::modules/cluster-logging-collector-log-forward.adoc[leveloffset=+1]
31-
include::modules/cluster-logging-collector-log-forward-about.adoc[leveloffset=+2]
31+
include::modules/cluster-logging-log-forwarding-about.adoc[leveloffset=+2]
3232
include::modules/cluster-logging-collector-log-forward-enable.adoc[leveloffset=+2]
3333
include::modules/cluster-logging-collector-log-forward-configure.adoc[leveloffset=+2]
3434
include::modules/cluster-logging-collector-log-forwarding-disable.adoc[leveloffset=+2]

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

Lines changed: 0 additions & 102 deletions
This file was deleted.

modules/cluster-logging-log-forwarding-about.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
// * logging/cluster-logging-external.adoc
44

55
[id="cluster-logging-log-forwarding-about_{context}"]
6-
= Understanding cluster log forwarding
6+
= Understanding the Log Forwarding API
77

8-
The {product-title} cluster log forwarding feature uses a combination of _outputs_ and _pipelines_ defined in the Log Forwarding Custom Resource to send logs to specific endpoints inside and outside of your {product-title} cluster.
8+
Forwarding cluster logs using the Log Forwarding API requires a combination of _outputs_ and _pipelines_ to send logs to specific endpoints inside and outside of your {product-title} cluster.
99

1010
[NOTE]
1111
====
@@ -19,7 +19,7 @@ An _output_ is the destination for log data and a _pipeline_ defines simple rout
1919
An output can be either:
2020

2121
* `elasticsearch` to forward logs to an external Elasticsearch v5.x cluster and/or the internal {product-title} Elasticsearch instance.
22-
* `forward` to forward logs to an external log aggregation solution. This option uses the Fluentd *forward* plug-ins.
22+
* `forward` to forward logs to an external log aggregation solution. This option uses the Fluentd *forward* protocols.
2323

2424
[NOTE]
2525
====
@@ -29,7 +29,7 @@ The endpoint must be a server name or FQDN, not an IP Address, if the cluster-wi
2929
A _pipeline_ associates the source of the data to an output. The source of the data is one of the following:
3030

3131
* `logs.app` - Container logs generated by user applications running in the cluster, except infrastructure container applications.
32-
* `logs.infra` - Logs generated by both infrastructure components running in the cluster and {product-title} nodes, such as journal logs. Infrastructure components are pods that run in the `openshift*`, `kube*`, or `default` projects.
32+
* `logs.infra` - Logs generated by infrastructure components running in the cluster and {product-title} nodes, such as journal logs. Infrastructure components are pods that run in the `openshift*`, `kube*`, or `default` projects.
3333
* `logs.audit` - Logs generated by the node audit system (auditd), which are stored in the */var/log/audit/audit.log* file, and the audit logs from the Kubernetes apiserver and the OpenShift apiserver.
3434

3535
Note the following:
@@ -44,13 +44,13 @@ The following example creates three outputs:
4444

4545
* the internal {product-title} Elasticsearch instance,
4646
* an unsecured externally-managed Elasticsearch instance,
47-
* a secured external log aggregator using the *forward* plug-in.
47+
* a secured external log aggregator using the *forward* protocols.
4848

4949
Three pipelines send:
5050

5151
* the application logs to the internal {product-title} Elasticsearch,
5252
* the infrastructure logs to an external Elasticsearch instance,
53-
* the audit logs to the secured device over the *forward* plug-in.
53+
* the audit logs to the secured device over the *forward* protocols.
5454

5555
.Sample log forwarding outputs and pipelines
5656
[source,yaml]
@@ -97,7 +97,7 @@ spec:
9797
<3> Configuration for the outputs.
9898
<4> A name to describe the output.
9999
<5> The type of output, either `elasticsearch` or `forward`.
100-
* Enter the endpoint, either the server name, FQDN, or IP address. If the cluster-wide proxy using the CIDR annotation is enabled, the endpoint must be a server name or FQDN, not an IP Address. For the internal {product-title} Elasticsearch instance, specify `elasticsearch.openshift-logging.svc:9200`.
100+
<6> Enter the endpoint, either the server name, FQDN, or IP address. If the cluster-wide proxy using the CIDR annotation is enabled, the endpoint must be a server name or FQDN, not an IP Address. For the internal {product-title} Elasticsearch instance, specify `elasticsearch.openshift-logging.svc:9200`.
101101
<7> Optional name of the secret required by the endpoint for TLS communication. The secret must exist in the `openshift-logging` project.
102102
<8> Optional setting if the endpoint does not use a secret, resulting in insecure communication.
103103
<9> Configuration for the pipelines.

0 commit comments

Comments
 (0)