Skip to content

Commit 46e063f

Browse files
authored
Merge pull request #71780 from abrennan89/OBSDOCS-212
OBSDOCS-212: Add docs for http server receiver input
2 parents ce844ca + 30b6043 commit 46e063f

File tree

3 files changed

+61
-1
lines changed

3 files changed

+61
-1
lines changed

logging/log_collection_forwarding/cluster-logging-collector.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,10 @@ include::modules/cluster-logging-collector-limits.adoc[leveloffset=+1]
2323
//include::modules/log-collector-rsyslog-server.adoc[leveloffset=+1]
2424
// uncomment for 5.9 release
2525

26+
include::modules/log-collector-http-server.adoc[leveloffset=+1]
27+
28+
[role="_additional-resources"]
29+
.Additional resources
30+
* xref:../../logging/log_collection_forwarding/configuring-log-forwarding.adoc#logging-audit-filtering_configuring-log-forwarding[Overview of API audit filter]
31+
2632
include::modules/cluster-logging-collector-tuning.adoc[leveloffset=+1]
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * logging/log_collection_forwarding/cluster-logging-collector.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="log-collector-http-server_{context}"]
7+
= Configuring the collector to receive audit logs as an HTTP server
8+
9+
You can configure your log collector to listen for HTTP connections and receive audit logs as an HTTP server by specifying `http` as a receiver input in the `ClusterLogForwarder` custom resource (CR). This enables you to use a common log store for audit logs that are collected from both inside and outside of your {product-title} cluster.
10+
11+
.Prerequisites
12+
13+
* You have administrator permissions.
14+
* You have installed the {oc-first}.
15+
* You have installed the {clo}.
16+
* You have created a `ClusterLogForwarder` CR.
17+
18+
.Procedure
19+
20+
. Modify the `ClusterLogForwarder` CR to add configuration for the `http` receiver input:
21+
+
22+
[source,yaml]
23+
----
24+
apiVersion: logging.openshift.io/v1beta1
25+
kind: ClusterLogForwarder
26+
metadata:
27+
# ...
28+
spec:
29+
serviceAccountName: <service_account_name>
30+
inputs:
31+
- name: http-receiver # <1>
32+
receiver:
33+
type: http # <2>
34+
http:
35+
format: kubeAPIAudit # <3>
36+
port: 8443 # <4>
37+
pipelines: # <5>
38+
- name: http-pipeline
39+
inputRefs:
40+
- http-receiver
41+
# ...
42+
----
43+
<1> Specify a name for your input receiver.
44+
<2> Specify the input receiver type as `http`.
45+
<3> Currently, only the the `kube-apiserver` webhook format is supported for `http` input receivers.
46+
<4> Optional: Specify the port that the input receiver listens on. This must be a value between `1024` and `65535`. The default value is `8443` if this is not specified.
47+
<5> Configure a pipeline for your input receiver.
48+
49+
. Apply the changes to the `ClusterLogForwarder` CR:
50+
+
51+
[source,terminal]
52+
----
53+
$ oc apply -f <filename>.yaml
54+
----

modules/logging-audit-log-filtering.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//logging/log_collection_forwarding/configuring-log-forwarding.adoc
33
//
44
:_mod-docs-content-type: CONCEPT
5-
[id="logging_audit_filtering_{context}"]
5+
[id="logging-audit-filtering_{context}"]
66
= Overview of API audit filter
77
OpenShift API servers generate audit events for each API call, detailing the request, response, and the identity of the requester, leading to large volumes of data. The API Audit filter uses rules to enable the exclusion of non-essential events and the reduction of event size, facilitating a more manageable audit trail. Rules are checked in order, checking stops at the first match. How much data is included in an event is determined by the value of the `level` field:
88

0 commit comments

Comments
 (0)