From 477c5dd5bc82d21e2f16b093d70768cb2e8336dc Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy Date: Thu, 11 Jan 2024 15:30:50 +0100 Subject: [PATCH 1/3] Added content for Apache Kafka glossary based on the blog page --- _toc.yml | 1 + .../kafka/concepts/apache-kafka-glossary.rst | 83 +++++++++++++++++++ 2 files changed, 84 insertions(+) create mode 100644 docs/products/kafka/concepts/apache-kafka-glossary.rst diff --git a/_toc.yml b/_toc.yml index b2fba7fea1..a8ed2bd5ea 100644 --- a/_toc.yml +++ b/_toc.yml @@ -319,6 +319,7 @@ entries: title: Sample data generator - file: docs/products/kafka/concepts entries: + - file: docs/products/kafka/concepts/apache-kafka-glossary - file: docs/products/kafka/concepts/upgrade-procedure title: Upgrade procedure - file: docs/products/kafka/concepts/horizontal-vertical-scaling diff --git a/docs/products/kafka/concepts/apache-kafka-glossary.rst b/docs/products/kafka/concepts/apache-kafka-glossary.rst new file mode 100644 index 0000000000..aabacd4d5e --- /dev/null +++ b/docs/products/kafka/concepts/apache-kafka-glossary.rst @@ -0,0 +1,83 @@ +Apache Kafka® glossary +====================== + +An in-depth guide to understanding the terminology of Apache Kafka® + +.. _Broker: + +Broker +------ + +A server that operates Apache Kafka, responsible for message storage, processing, and delivery. Typically part of a cluster for enhanced scalability and reliability, each broker functions independently but is integral to Kafka's overall operations, separate from tools like Apache Kafka Connect. + +Consumer +-------- + +An application that reads data from Apache Kafka, often processing or acting upon it. Various tools used with Apache Kafka ultimately function as either a producer or a consumer when communicating with Apache Kafka. + +Consumer groups +--------------- + +Groups of consumers in Apache Kafka are used to scale beyond a single application instance. Multiple instances of an application coordinate to handle messages, with each group allocated to different partitions for even workload distribution. + +Event-driven architecture +------------------------- + +Application architecture centered around responding to and processing events. + +.. _Event: + +Event +----- + +A single discrete data unit in Apache Kafka, consisting of a ``value`` (the message body) and often a ``key`` (for quick identification) and ``headers`` (metadata about the message). + +Kafka node +---------- + +See :ref:`Broker` + +Kafka server +------------ + +See :ref:`Broker` + +Message +------- + +See :ref:`Event` + +Partitioning +------------ + +A method used by Apache Kafka to distribute a topic across multiple servers. Each server acts as the ``leader`` for a partition, ensuring data sharding and message order within each partition. + +Producer +-------- + +An application that writes data into Apache Kafka without concern for the data's consumers. The data can range from well-structured to simple text, often accompanied by metadata. + +Pub/sub +------- + +A publish-subscribe messaging architecture where messages are broadcasted by publishers and received by any listening subscribers, unlike point-to-point systems. + +Queueing +-------- + +A messaging system where messages are sent and received in the order they are produced. Apache Kafka maintains a watermark for each consumer to track the most recent message read. + +Record +------ + +See :ref:`Event` + +Replication +----------- + +Apache Kafka's feature for data replication across multiple servers, ensuring data preservation even if a server fails. This is configurable per topic. + +Topic +----- + +Logical channels in Apache Kafka through which messages are organized. Topics are named in a human-readable manner, like ``sensor-readings`` or ``kubernetes-logs``. From f576a4f9bd3a48b5d00bf3bf0432da70a4585910 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy Date: Thu, 11 Jan 2024 15:53:06 +0100 Subject: [PATCH 2/3] Updated intro text --- docs/products/kafka/concepts/apache-kafka-glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/products/kafka/concepts/apache-kafka-glossary.rst b/docs/products/kafka/concepts/apache-kafka-glossary.rst index aabacd4d5e..8f79f78b13 100644 --- a/docs/products/kafka/concepts/apache-kafka-glossary.rst +++ b/docs/products/kafka/concepts/apache-kafka-glossary.rst @@ -1,7 +1,7 @@ Apache Kafka® glossary ====================== -An in-depth guide to understanding the terminology of Apache Kafka® +A comprehensive glossary of essential Apache Kafka® terms and their meanings. .. _Broker: From a46436dbe291b640fc50c83bb0c5723273fdc90f Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy Date: Mon, 15 Jan 2024 16:27:25 +0100 Subject: [PATCH 3/3] update Concepts topic with the list of glossary --- _toc.yml | 2 +- docs/products/kafka/concepts.rst | 85 ++++++++++++++++++- .../kafka/concepts/apache-kafka-glossary.rst | 83 ------------------ 3 files changed, 82 insertions(+), 88 deletions(-) delete mode 100644 docs/products/kafka/concepts/apache-kafka-glossary.rst diff --git a/_toc.yml b/_toc.yml index ce82556c69..1294b85321 100644 --- a/_toc.yml +++ b/_toc.yml @@ -318,8 +318,8 @@ entries: - file: docs/products/kafka/howto/fake-sample-data title: Sample data generator - file: docs/products/kafka/concepts + title: Concepts entries: - - file: docs/products/kafka/concepts/apache-kafka-glossary - file: docs/products/kafka/concepts/upgrade-procedure title: Upgrade procedure - file: docs/products/kafka/concepts/horizontal-vertical-scaling diff --git a/docs/products/kafka/concepts.rst b/docs/products/kafka/concepts.rst index 3ba38b4492..5e26432225 100644 --- a/docs/products/kafka/concepts.rst +++ b/docs/products/kafka/concepts.rst @@ -1,6 +1,83 @@ -Concepts -======== +Apache Kafka® concepts +====================== -Explanations and supporting concepts to help you succeed with Aiven for Apache Kafka®. +A comprehensive glossary of essential Apache Kafka® terms and their meanings. -.. tableofcontents:: +.. _Broker: + +Broker +------ + +A server that operates Apache Kafka, responsible for message storage, processing, and delivery. Typically part of a cluster for enhanced scalability and reliability, each broker functions independently but is integral to Kafka's overall operations, separate from tools like Apache Kafka Connect. + +Consumer +-------- + +An application that reads data from Apache Kafka, often processing or acting upon it. Various tools used with Apache Kafka ultimately function as either a producer or a consumer when communicating with Apache Kafka. + +Consumer groups +--------------- + +Groups of consumers in Apache Kafka are used to scale beyond a single application instance. Multiple instances of an application coordinate to handle messages, with each group allocated to different partitions for even workload distribution. + +Event-driven architecture +------------------------- + +Application architecture centered around responding to and processing events. + +.. _Event: + +Event +----- + +A single discrete data unit in Apache Kafka, consisting of a ``value`` (the message body) and often a ``key`` (for quick identification) and ``headers`` (metadata about the message). + +Kafka node +---------- + +See :ref:`Broker` + +Kafka server +------------ + +See :ref:`Broker` + +Message +------- + +See :ref:`Event` + +Partitioning +------------ + +A method used by Apache Kafka to distribute a topic across multiple servers. Each server acts as the ``leader`` for a partition, ensuring data sharding and message order within each partition. + +Producer +-------- + +An application that writes data into Apache Kafka without concern for the data's consumers. The data can range from well-structured to simple text, often accompanied by metadata. + +Pub/sub +------- + +A publish-subscribe messaging architecture where messages are broadcasted by publishers and received by any listening subscribers, unlike point-to-point systems. + +Queueing +-------- + +A messaging system where messages are sent and received in the order they are produced. Apache Kafka maintains a watermark for each consumer to track the most recent message read. + +Record +------ + +See :ref:`Event` + +Replication +----------- + +Apache Kafka's feature for data replication across multiple servers, ensuring data preservation even if a server fails. This is configurable per topic. + +Topic +----- + +Logical channels in Apache Kafka through which messages are organized. Topics are named in a human-readable manner, like ``sensor-readings`` or ``kubernetes-logs``. diff --git a/docs/products/kafka/concepts/apache-kafka-glossary.rst b/docs/products/kafka/concepts/apache-kafka-glossary.rst deleted file mode 100644 index 8f79f78b13..0000000000 --- a/docs/products/kafka/concepts/apache-kafka-glossary.rst +++ /dev/null @@ -1,83 +0,0 @@ -Apache Kafka® glossary -====================== - -A comprehensive glossary of essential Apache Kafka® terms and their meanings. - -.. _Broker: - -Broker ------- - -A server that operates Apache Kafka, responsible for message storage, processing, and delivery. Typically part of a cluster for enhanced scalability and reliability, each broker functions independently but is integral to Kafka's overall operations, separate from tools like Apache Kafka Connect. - -Consumer --------- - -An application that reads data from Apache Kafka, often processing or acting upon it. Various tools used with Apache Kafka ultimately function as either a producer or a consumer when communicating with Apache Kafka. - -Consumer groups ---------------- - -Groups of consumers in Apache Kafka are used to scale beyond a single application instance. Multiple instances of an application coordinate to handle messages, with each group allocated to different partitions for even workload distribution. - -Event-driven architecture -------------------------- - -Application architecture centered around responding to and processing events. - -.. _Event: - -Event ------ - -A single discrete data unit in Apache Kafka, consisting of a ``value`` (the message body) and often a ``key`` (for quick identification) and ``headers`` (metadata about the message). - -Kafka node ----------- - -See :ref:`Broker` - -Kafka server ------------- - -See :ref:`Broker` - -Message -------- - -See :ref:`Event` - -Partitioning ------------- - -A method used by Apache Kafka to distribute a topic across multiple servers. Each server acts as the ``leader`` for a partition, ensuring data sharding and message order within each partition. - -Producer --------- - -An application that writes data into Apache Kafka without concern for the data's consumers. The data can range from well-structured to simple text, often accompanied by metadata. - -Pub/sub -------- - -A publish-subscribe messaging architecture where messages are broadcasted by publishers and received by any listening subscribers, unlike point-to-point systems. - -Queueing --------- - -A messaging system where messages are sent and received in the order they are produced. Apache Kafka maintains a watermark for each consumer to track the most recent message read. - -Record ------- - -See :ref:`Event` - -Replication ------------ - -Apache Kafka's feature for data replication across multiple servers, ensuring data preservation even if a server fails. This is configurable per topic. - -Topic ------ - -Logical channels in Apache Kafka through which messages are organized. Topics are named in a human-readable manner, like ``sensor-readings`` or ``kubernetes-logs``.