Skip to content

[enterprise-4.15] OBSDOCS-890: Fix bugs in syslog docs #74145

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.

Sign up for GitHub

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
merged 1 commit into from
Apr 3, 2024
Merged

[enterprise-4.15] OBSDOCS-890: Fix bugs in syslog docs #74145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion logging/log_collection_forwarding/cluster-logging-collector.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ The service name is generated based on the following:
* 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-http-server.adoc[leveloffset=+2]
//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
36 changes: 34 additions & 2 deletions modules/log-collector-rsyslog-server.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,15 @@ In {logging} version 5.9 and newer versions, you can configure your log collecto

. Modify the `ClusterLogForwarder` CR to add configuration for the `syslog` receiver input:
+
--
.Example `ClusterLogForwarder` CR if you are using a multi log forwarder deployment
[source,yaml]
----
apiVersion: logging.openshift.io/v1beta1
apiVersion: logging.openshift.io/v1
kind: ClusterLogForwarder
metadata:
# ...
name: example
namespace: <namespace>
spec:
serviceAccountName: <service_account_name>
inputs:
Expand All @@ -43,6 +46,35 @@ spec:
<2> Specify the input receiver type as `syslog`.
<3> Optional: Specify the port that the input receiver listens on. This must be a value between `1024` and `65535`. The default value is `10514` if this is not specified.
<4> 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: syslog-receiver # <1>
receiver:
type: syslog # <2>
syslog:
port: 10514 # <3>
pipelines: # <4>
- inputRefs:
- syslog-receiver
name: syslog-pipeline
# ...
----
<1> Specify a name for your input receiver.
<2> Specify the input receiver type as `syslog`.
<3> Optional: Specify the port that the input receiver listens on. This must be a value between `1024` and `65535`. The default value is `10514` if this is not specified.
<4> Configure a pipeline for your input receiver.
--

. Apply the changes to the `ClusterLogForwarder` CR by running the following command:
+
Expand Down