Bug 1904410 - [DOCS] Add example for sending to several Kafka brokers using only one output entry
Summary: [DOCS] Add example for sending to several Kafka brokers using only one output...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.6
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Latha S
QA Contact: Anping Li
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-12-04 11:36 UTC by Oscar Casal Sanchez
Modified: 2024-06-13 23:38 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-03-17 22:36:25 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker OBSDOCS-327 0 None None None 2023-06-16 16:01:40 UTC
Red Hat Issue Tracker RHDEVDOCS-2605 0 None None None 2023-06-16 16:01:14 UTC
Red Hat Knowledge Base (Solution) 5676101 0 None None None 2020-12-31 15:49:34 UTC

Description Oscar Casal Sanchez 2020-12-04 11:36:06 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 documentation, we have an example about how to define an output to send to one broker like this:
~~~
  outputs:
   - name: app-logs 
     type: kafka 
     url: tls://kafka.example.devlab.com:9093/app-topic 
     secret:
       name: kafka-secret
~~~

But in the CRD [1] it's indicated that it's possible to define one output to send to several brokers and using the same secret.

[Suggestions for improvement]
Include one example where it's defined one output to send to several brokers using the same topic, like this:

~~~
  - name: app-logs 
    type: kafka
    secret:
      name: kafka-secret-dev
    kafka:
      brokers:
        - tls://kafka-broker1.example.com:9093/
        - tls://kafka-broker2.example.com:9093/
        - ...
      topic: app-topic
~~~


[1] https://github.com/openshift/cluster-logging-operator/blob/332dec5d433570f7e315b1629159c81abfe936d4/manifests/4.6/logging.openshift.io_clusterlogforwarders_crd.yaml#L75

Comment 1 Rolfe Dlugy-Hegwer 2021-02-10 21:04:23 UTC
Moved to ON_QA with https://issues.redhat.com/browse/RHDEVDOCS-2605

Comment 2 Rolfe Dlugy-Hegwer 2021-03-17 22:36:25 UTC
Resolved with https://github.com/openshift/openshift-docs/pull/29399


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