From 288d17f07e6e9ffafc48220fcbe7406bc4e045bc Mon Sep 17 00:00:00 2001 From: Harshal Sheth Date: Tue, 6 Jul 2021 15:33:52 -0700 Subject: [PATCH] docs(ingest): update links to Kafka docs (#2834) --- metadata-ingestion/README.md | 6 ++++-- .../{secured_kafka_to_console.yml => secured_kafka.yml} | 0 metadata-ingestion/src/datahub/configuration/kafka.py | 6 +++--- 3 files changed, 7 insertions(+), 5 deletions(-) rename metadata-ingestion/examples/recipes/{secured_kafka_to_console.yml => secured_kafka.yml} (100%) diff --git a/metadata-ingestion/README.md b/metadata-ingestion/README.md index cb1c346d1e..8210533c85 100644 --- a/metadata-ingestion/README.md +++ b/metadata-ingestion/README.md @@ -157,7 +157,7 @@ source: schema_registry_config: {} # passed to https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#confluent_kafka.schema_registry.SchemaRegistryClient ``` -For a full example with a number of security options, see this [example recipe](./examples/recipes/secured_kafka_to_console.yml). +For a full example with a number of security options, see this [example recipe](./examples/recipes/secured_kafka.yml). ### MySQL Metadata `mysql` @@ -895,11 +895,13 @@ sink: config: connection: bootstrap: "localhost:9092" - producer_config: {} # passed to https://docs.confluent.io/platform/current/clients/confluent-kafka-python/index.html#serializingproducer + producer_config: {} # passed to https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#serializingproducer schema_registry_url: "http://localhost:8081" schema_registry_config: {} # passed to https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#confluent_kafka.schema_registry.SchemaRegistryClient ``` +For a full example with a number of security options, see this [example recipe](./examples/recipes/secured_kafka.yml). + ### Console `console` Simply prints each metadata event to stdout. Useful for experimentation and debugging purposes. diff --git a/metadata-ingestion/examples/recipes/secured_kafka_to_console.yml b/metadata-ingestion/examples/recipes/secured_kafka.yml similarity index 100% rename from metadata-ingestion/examples/recipes/secured_kafka_to_console.yml rename to metadata-ingestion/examples/recipes/secured_kafka.yml diff --git a/metadata-ingestion/src/datahub/configuration/kafka.py b/metadata-ingestion/src/datahub/configuration/kafka.py index fc3ff910ed..876db21086 100644 --- a/metadata-ingestion/src/datahub/configuration/kafka.py +++ b/metadata-ingestion/src/datahub/configuration/kafka.py @@ -14,7 +14,7 @@ class _KafkaConnectionConfig(ConfigModel): # Extra schema registry config. # These options will be passed into Kafka's SchemaRegistryClient. - # See https://docs.confluent.io/platform/current/clients/confluent-kafka-python/index.html?highlight=schema%20registry#schemaregistryclient. + # See https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html?#schemaregistryclient schema_registry_config: dict = Field(default_factory=dict) @validator("bootstrap") @@ -43,7 +43,7 @@ class KafkaConsumerConnectionConfig(_KafkaConnectionConfig): # Extra consumer config. # These options will be passed into Kafka's DeserializingConsumer. - # See https://docs.confluent.io/platform/current/clients/confluent-kafka-python/index.html#deserializingconsumer + # See https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#deserializingconsumer # and https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md. consumer_config: dict = Field(default_factory=dict) @@ -53,6 +53,6 @@ class KafkaProducerConnectionConfig(_KafkaConnectionConfig): # Extra producer config. # These options will be passed into Kafka's SerializingProducer. - # See https://docs.confluent.io/platform/current/clients/confluent-kafka-python/index.html#serializingproducer + # See https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#serializingproducer # and https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md. producer_config: dict = Field(default_factory=dict)