Skip to content

Commit 1777996

Browse files
authored
Merge pull request #73819 from openshift-cherrypick-robot/cherry-pick-73567-to-enterprise-4.14
[enterprise-4.14] OBSDOCS-890: Updates for http input receiver docs
2 parents 792426d + 46d40ec commit 1777996

File tree

2 files changed

+46
-5
lines changed

2 files changed

+46
-5
lines changed

logging/log_collection_forwarding/cluster-logging-collector.adoc

+11-3
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,18 @@ include::modules/cluster-logging-collector-pod-location.adoc[leveloffset=+1]
2020

2121
include::modules/cluster-logging-collector-limits.adoc[leveloffset=+1]
2222

23-
//include::modules/log-collector-rsyslog-server.adoc[leveloffset=+1]
24-
// uncomment for 5.9 release
23+
[id="cluster-logging-collector-input-receivers"]
24+
== Configuring input receivers
25+
26+
The {clo} deploys a service for each configured input receiver so that clients can write to the collector. This service exposes the port specified for the input receiver.
27+
The service name is generated based on the following:
2528

26-
include::modules/log-collector-http-server.adoc[leveloffset=+1]
29+
* For multi log forwarder `ClusterLogForwarder` CR deployments, the service name is in the format `<ClusterLogForwarder_CR_name>-<input_name>`. For example, `example-http-receiver`.
30+
* For legacy `ClusterLogForwarder` CR deployments, meaning those named `instance` and located in the `openshift-logging` namespace, the service name is in the format `collector-<input_name>`. For example, `collector-http-receiver`.
31+
32+
//include::modules/log-collector-rsyslog-server.adoc[leveloffset=+2]
33+
// uncomment for 5.9 release
34+
include::modules/log-collector-http-server.adoc[leveloffset=+2]
2735

2836
[role="_additional-resources"]
2937
.Additional resources

modules/log-collector-http-server.adoc

+35-2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ You can configure your log collector to listen for HTTP connections and receive
1919

2020
. Modify the `ClusterLogForwarder` CR to add configuration for the `http` receiver input:
2121
+
22+
--
23+
.Example `ClusterLogForwarder` CR if you are using a multi log forwarder deployment
2224
[source,yaml]
2325
----
2426
apiVersion: logging.openshift.io/v1beta1
@@ -42,11 +44,42 @@ spec:
4244
----
4345
<1> Specify a name for your input receiver.
4446
<2> Specify the input receiver type as `http`.
45-
<3> Currently, only the the `kube-apiserver` webhook format is supported for `http` input receivers.
47+
<3> Currently, only the `kube-apiserver` webhook format is supported for `http` input receivers.
4648
<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.
4749
<5> Configure a pipeline for your input receiver.
50+
--
51+
+
52+
--
53+
.Example `ClusterLogForwarder` CR if you are using a legacy deployment
54+
[source,yaml]
55+
----
56+
apiVersion: logging.openshift.io/v1
57+
kind: ClusterLogForwarder
58+
metadata:
59+
name: instance
60+
namespace: openshift-logging
61+
spec:
62+
inputs:
63+
- name: http-receiver # <1>
64+
receiver:
65+
type: http # <2>
66+
http:
67+
format: kubeAPIAudit # <3>
68+
port: 8443 # <4>
69+
pipelines: # <5>
70+
- inputRefs:
71+
- http-receiver
72+
name: http-pipeline
73+
# ...
74+
----
75+
<1> Specify a name for your input receiver.
76+
<2> Specify the input receiver type as `http`.
77+
<3> Currently, only the `kube-apiserver` webhook format is supported for `http` input receivers.
78+
<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.
79+
<5> Configure a pipeline for your input receiver.
80+
--
4881

49-
. Apply the changes to the `ClusterLogForwarder` CR:
82+
. Apply the changes to the `ClusterLogForwarder` CR by running the following command:
5083
+
5184
[source,terminal]
5285
----

0 commit comments

Comments
 (0)