xBis7 commented on code in PR #68082: URL: https://github.com/apache/airflow/pull/68082#discussion_r3403770354
########## providers/apache/kafka/docs/configurations-ref.rst: ########## @@ -0,0 +1,91 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +.. _configuration:kafka: + +.. include:: /../../../../devel-common/src/sphinx_exts/includes/providers-configurations-ref.rst +.. include:: /../../../../devel-common/src/sphinx_exts/includes/sections-and-options.rst + + +Highlighted configurations +=========================== + +The ``[kafka_listener]`` section configures the ``KafkaListenerPlugin``, +which publishes Airflow DagRun and TaskInstance state-change events to a +Kafka topic. DagRun and TaskInstance events are separated and enabled by +distinct flags. Both event-type flags default to ``False`` and the plugin +is a no-op if ``bootstrap_servers`` isn't also set. + +.. _configuration_kafka_listener_activation:kafka: + +Activating the listener +----------------------- + +To enable event publishing you need to + + * enable at least one event-type flag + * configure a broker address + * have a pre-existing kafka topic + +.. code-block:: ini + + [kafka_listener] + dag_run_events_enabled = True + task_instance_events_enabled = True + bootstrap_servers = broker1:9092,broker2:9092 Review Comment: I removed `bootstrap_servers` and added `kafka_config_id` instead. Also, added a new config dict key. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
