Bug 1904372 - [DOCS] Not including secret in Kafka example Forwarding logs to a Kafka broker
Summary: [DOCS] Not including secret in Kafka example Forwarding logs to a Kafka broker
Keywords:
Status: CLOSED DEFERRED
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.6
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: landerso
QA Contact: Anping Li
Claire Bremble
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-12-04 09:02 UTC by Oscar Casal Sanchez
Modified: 2024-06-13 23:38 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-02-10 19:49:23 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHDEVDOCS-3432 0 None None None 2021-10-27 15:17:28 UTC

Description Oscar Casal Sanchez 2020-12-04 09:02:17 UTC
[Document URL]
https://docs.openshift.com/container-platform/4.6/logging/cluster-logging-external.html#cluster-logging-collector-log-forward-kafka_cluster-logging-external

[Section Number and Name]
Forwarding logs to a Kafka broker

[Describe the issue]
In the example for sending to Kafka, it's possible to read:
~~~
...
   - name: infra-logs
     type: kafka
     url: tls://kafka.devlab2.example.com:9093/infra-topic
   - name: audit-logs
...
~~~

In the infra-logs endpoint is defined to send using tls, but not secret defined

[Suggestions for improvement] 
Include in the example the secret to send via tls or use tcp to be insecure. Then, if the example is using TLS, it could be something like:

~~~
...
   - name: infra-logs
     type: kafka
     url: tls://kafka.devlab2.example.com:9093/infra-topic
     secret:
       name: kafka-secret-devlab2
   - name: audit-logs
...
~~~

Or in the case that we want to show an example for using kafka with tcp:

~~~
...
   - name: infra-logs
     type: kafka
     url: http://kafka.devlab2.example.com:9093/infra-topic
   - name: audit-logs
...
~~~

Additional information:

Comment 2 Claire Bremble 2023-02-10 19:49:08 UTC
Closing as deferred so a duplicate Jira is not created. This work can be followed at https://issues.redhat.com/browse/RHDEVDOCS-3432


Note You need to log in before you can comment on or make changes to this bug.