Skip to content

[enterprise-4.15] OBSDOCS-890: Updates for http input receiver docs #73820

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions logging/log_collection_forwarding/cluster-logging-collector.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,18 @@ include::modules/cluster-logging-collector-pod-location.adoc[leveloffset=+1]

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

//include::modules/log-collector-rsyslog-server.adoc[leveloffset=+1]
// uncomment for 5.9 release
[id="cluster-logging-collector-input-receivers"]
== Configuring input receivers

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.
The service name is generated based on the following:

include::modules/log-collector-http-server.adoc[leveloffset=+1]
* For multi log forwarder `ClusterLogForwarder` CR deployments, the service name is in the format `<ClusterLogForwarder_CR_name>-<input_name>`. For example, `example-http-receiver`.
* 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`.

//include::modules/log-collector-rsyslog-server.adoc[leveloffset=+2]
// uncomment for 5.9 release
include::modules/log-collector-http-server.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources
Expand Down
37 changes: 35 additions & 2 deletions modules/log-collector-http-server.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ You can configure your log collector to listen for HTTP connections and receive

. Modify the `ClusterLogForwarder` CR to add configuration for the `http` receiver input:
+
--
.Example `ClusterLogForwarder` CR if you are using a multi log forwarder deployment
[source,yaml]
----
apiVersion: logging.openshift.io/v1beta1
Expand All @@ -42,11 +44,42 @@ spec:
----
<1> Specify a name for your input receiver.
<2> Specify the input receiver type as `http`.
<3> Currently, only the the `kube-apiserver` webhook format is supported for `http` input receivers.
<3> Currently, only the `kube-apiserver` webhook format is supported for `http` input receivers.
<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.
<5> Configure a pipeline for your input receiver.
--
+
--
.Example `ClusterLogForwarder` CR if you are using a legacy deployment
[source,yaml]
----
apiVersion: logging.openshift.io/v1
kind: ClusterLogForwarder
metadata:
name: instance
namespace: openshift-logging
spec:
inputs:
- name: http-receiver # <1>
receiver:
type: http # <2>
http:
format: kubeAPIAudit # <3>
port: 8443 # <4>
pipelines: # <5>
- inputRefs:
- http-receiver
name: http-pipeline
# ...
----
<1> Specify a name for your input receiver.
<2> Specify the input receiver type as `http`.
<3> Currently, only the `kube-apiserver` webhook format is supported for `http` input receivers.
<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.
<5> Configure a pipeline for your input receiver.
--

. Apply the changes to the `ClusterLogForwarder` CR:
. Apply the changes to the `ClusterLogForwarder` CR by running the following command:
+
[source,terminal]
----
Expand Down