Skip to content

Commit 1537c80

Browse files
committed
OBSDOCS-280: Update internal log store refs
1 parent 48c1798 commit 1537c80

File tree

4 files changed

+16
-20
lines changed

4 files changed

+16
-20
lines changed

logging/log_collection_forwarding/configuring-log-forwarding.adoc

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
77

88
toc::[]
99

10-
By default, the {logging} sends container and infrastructure logs to the default internal log store defined in the `ClusterLogging` custom resource. However, it does not send audit logs to the internal store because it does not provide secure storage. If this default configuration meets your needs, you do not need to configure the Cluster Log Forwarder.
11-
12-
[NOTE]
13-
====
14-
To send audit logs to the internal Elasticsearch log store, use the Cluster Log Forwarder as described in xref:../../logging/log_storage/logging-config-es-store.adoc#cluster-logging-elasticsearch-audit_logging-config-es-store[Forwarding audit logs to the log store].
15-
====
10+
include::snippets/audit-logs-default.adoc[]
1611

1712
include::modules/cluster-logging-collector-log-forwarding-about.adoc[leveloffset=+1]
1813

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

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
To send logs to specific endpoints inside and outside your {product-title} cluster, you specify a combination of _outputs_ and _pipelines_ in a `ClusterLogForwarder` custom resource (CR). You can also use _inputs_ to forward the application logs associated with a specific project to an endpoint. Authentication is provided by a Kubernetes _Secret_ object.
66

7+
include::snippets/audit-logs-default.adoc[]
8+
79
_pipeline_:: Defines simple routing from one log type to one or more outputs, or which logs you want to send. The log types are one of the following:
810
+
911
--
@@ -27,16 +29,10 @@ _Secret_:: A `key:value map` that contains confidential data such as user creden
2729

2830
Note the following:
2931

30-
* If a `ClusterLogForwarder` CR object exists, logs are not forwarded to the default Elasticsearch instance, unless there is a pipeline with the `default` output.
31-
32-
* By default, the {logging} sends container and infrastructure logs to the default internal Elasticsearch log store defined in the `ClusterLogging` custom resource. However, it does not send audit logs to the internal store because it does not provide secure storage. If this default configuration meets your needs, do not configure the Log Forwarding API.
33-
3432
* If you do not define a pipeline for a log type, the logs of the undefined types are dropped. For example, if you specify a pipeline for the `application` and `audit` types, but do not specify a pipeline for the `infrastructure` type, `infrastructure` logs are dropped.
3533
3634
* You can use multiple types of outputs in the `ClusterLogForwarder` custom resource (CR) to send logs to servers that support different protocols.
3735
38-
* The internal {product-title} Elasticsearch instance does not provide secure storage for audit logs. We recommend you ensure that the system to which you forward audit logs is compliant with your organizational and governmental regulations and is properly secured. The {logging} does not comply with those regulations.
39-
4036
The following example forwards the audit logs to a secure external Elasticsearch instance, the infrastructure logs to an insecure external Elasticsearch instance, the application logs to a Kafka broker, and the application logs from the `my-apps-logs` project to the internal Elasticsearch instance.
4137

4238
.Sample log forwarding outputs and pipelines

modules/cluster-logging-elasticsearch-audit.adoc

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,7 @@
66
[id="cluster-logging-elasticsearch-audit_{context}"]
77
= Forwarding audit logs to the log store
88

9-
By default, OpenShift Logging does not store audit logs in the internal {product-title} Elasticsearch log store. You can send audit logs to this log store so, for example, you can view them in Kibana.
10-
11-
To send the audit logs to the default internal Elasticsearch log store, for example to view the audit logs in Kibana, you must use the Log Forwarding API.
12-
13-
[IMPORTANT]
14-
====
15-
The internal {product-title} Elasticsearch log store does not provide secure storage for audit logs. Verify that the system to which you forward audit logs complies with your organizational and governmental regulations and is properly secured. {logging-uc} does not comply with those regulations.
16-
====
9+
include::snippets/audit-logs-default.adoc[]
1710

1811
.Procedure
1912

snippets/audit-logs-default.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Module included in the following assemblies and modules:
2+
//
3+
// * logging/log_collection_forwarding/configuring-log-forwarding.adoc
4+
//
5+
// * modules/cluster-logging-collector-log-forwarding-about.adoc
6+
// * modules/cluster-logging-elasticsearch-audit.adoc
7+
8+
In a {logging} deployment, container and infrastructure logs are forwarded to the internal log store defined in the `ClusterLogging` custom resource (CR) by default.
9+
10+
Audit logs are not forwarded to the internal log store by default because this does not provide secure storage. Ensure that the system to which you forward audit logs is compliant with your organizational and governmental regulations and is properly secured.
11+
12+
If this default configuration meets your needs, you do not need to configure a `ClusterLogForwarder` CR. If a `ClusterLogForwarder` CR exists, logs are not forwarded to the internal log store unless a pipeline is defined that contains the `default` output.

0 commit comments

Comments
 (0)