o-nikolas commented on code in PR #73507: URL: https://github.com/apache/airflow/pull/73507#discussion_r4128040214
########## providers/amazon/docs/msk.rst: ########## @@ -0,0 +1,44 @@ + .. 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. + +Amazon Managed Streaming for Apache Kafka Review Comment: A top level doc for MSK does not make sense, we don't do this for any other individual service. Can you please move this to `message-queues/index.rst`, thanks! ########## providers/amazon/docs/msk.rst: ########## @@ -0,0 +1,44 @@ + .. 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. + +Amazon Managed Streaming for Apache Kafka +========================================= + +`Amazon MSK <https://aws.amazon.com/msk/>`_ is a managed Apache Kafka service. The Amazon +provider's :class:`~airflow.providers.amazon.aws.hooks.msk.MskHook` provides a boto3 client for +managing MSK clusters and can generate IAM authentication tokens for Kafka clients. The +Apache Kafka provider handles producing and consuming topic messages. + +Trigger a Dag from an MSK topic +------------------------------- + +Use :class:`~airflow.providers.apache.kafka.triggers.msg_queue.KafkaMessageQueueTrigger` with +``AssetWatcher`` to trigger a Dag when a message arrives. Set the trigger's ``kafka_config_id`` +to a Kafka connection configured for the MSK brokers. There is no separate Amazon MSK message +queue trigger; the standard Kafka trigger works with MSK because MSK uses the Kafka protocol. +See the `Kafka message queue trigger guide +<https://airflow.apache.org/docs/apache-airflow-providers-apache-kafka/stable/message-queues/index.html>`_ Review Comment: You can use `:doc:` references to make these links, that has checks for dead links and when pages move, it's preferable. Here and throughout the rest of the PR. -- 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]
