Skip to content

Commit ec50e12

Browse files
committed
OBSDOCS-890: Fix bugs in syslog docs
1 parent 6c4afc4 commit ec50e12

File tree

2 files changed

+35
-3
lines changed

2 files changed

+35
-3
lines changed

logging/log_collection_forwarding/cluster-logging-collector.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ The service name is generated based on the following:
2525
* For multi log forwarder `ClusterLogForwarder` CR deployments, the service name is in the format `<ClusterLogForwarder_CR_name>-<input_name>`. For example, `example-http-receiver`.
2626
* 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`.
2727

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

3232
[role="_additional-resources"]
3333
.Additional resources

modules/log-collector-rsyslog-server.adoc

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,15 @@ In {logging} version 5.9 and newer versions, you can configure your log collecto
1919

2020
. Modify the `ClusterLogForwarder` CR to add configuration for the `syslog` receiver input:
2121
+
22+
--
23+
.Example `ClusterLogForwarder` CR if you are using a multi log forwarder deployment
2224
[source,yaml]
2325
----
24-
apiVersion: logging.openshift.io/v1beta1
26+
apiVersion: logging.openshift.io/v1
2527
kind: ClusterLogForwarder
2628
metadata:
27-
# ...
29+
name: example
30+
namespace: <namespace>
2831
spec:
2932
serviceAccountName: <service_account_name>
3033
inputs:
@@ -43,6 +46,35 @@ spec:
4346
<2> Specify the input receiver type as `syslog`.
4447
<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.
4548
<4> Configure a pipeline for your input receiver.
49+
--
50+
+
51+
--
52+
.Example `ClusterLogForwarder` CR if you are using a legacy deployment
53+
[source,yaml]
54+
----
55+
apiVersion: logging.openshift.io/v1
56+
kind: ClusterLogForwarder
57+
metadata:
58+
name: instance
59+
namespace: openshift-logging
60+
spec:
61+
inputs:
62+
- name: syslog-receiver # <1>
63+
receiver:
64+
type: syslog # <2>
65+
syslog:
66+
port: 10514 # <3>
67+
pipelines: # <4>
68+
- inputRefs:
69+
- syslog-receiver
70+
name: syslog-pipeline
71+
# ...
72+
----
73+
<1> Specify a name for your input receiver.
74+
<2> Specify the input receiver type as `syslog`.
75+
<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.
76+
<4> Configure a pipeline for your input receiver.
77+
--
4678

4779
. Apply the changes to the `ClusterLogForwarder` CR by running the following command:
4880
+

0 commit comments

Comments
 (0)