From 241e314be12fd76c865656698da3597e66b8f0b9 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy Date: Mon, 16 Jan 2023 12:43:55 +0100 Subject: [PATCH] Addressed review feedback --- docs/products/flink/concepts/flink-architecture.rst | 5 ++++- docs/products/flink/concepts/flink-features.rst | 4 ++-- .../flink/concepts/managed-service-features.rst | 10 +++++----- docs/products/flink/reference/flink-limitations.rst | 2 +- 4 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/products/flink/concepts/flink-architecture.rst b/docs/products/flink/concepts/flink-architecture.rst index 59bcf3c6a4..19f7f3f20d 100644 --- a/docs/products/flink/concepts/flink-architecture.rst +++ b/docs/products/flink/concepts/flink-architecture.rst @@ -18,7 +18,10 @@ Some of the responsibilities of the JobManager include: In a high-availability setup, there may be multiple JobManagers running in the cluster, with one JobManager designated as the leader and the others as standby JobManagers. -The JobManager in Apache Flink consists of three main components: **ResourceManager**, **Dispatcher**, and **JobMaster**. The ResourceManager is responsible for managing the allocation and deallocation of resources in the Flink cluster. Additionally, ResourceMaanger is responsible for managing **Task slots** - the unit of resource scheduling in a Flink cluster. +The JobManager in Apache Flink consists of three main components: +- **ResourceManager:** The ResourceManager is responsible for managing the allocation and deallocation of resources in the Flink cluster. Additionally, ResourceManger is responsible for managing **Task slots** - the unit of resource scheduling in a Flink cluster. +- **Dispatcher:** The Dispatcher in Apache Flink ensures tasks run smoothly on the cluster by scheduling them on available task slots and ensuring that tasks are executed efficiently. +- **JobMaster: ** The JobMaster in Apache Flink makes sure a specific job runs smoothly on the cluster by coordinating the tasks and executing them correctly and efficiently. TaskManager ----------- diff --git a/docs/products/flink/concepts/flink-features.rst b/docs/products/flink/concepts/flink-features.rst index 9f72e1c299..8700115c22 100644 --- a/docs/products/flink/concepts/flink-features.rst +++ b/docs/products/flink/concepts/flink-features.rst @@ -1,6 +1,6 @@ Aiven for Apache Flink® features ================================ -Aiven for Apache Flink is powered by the open-source framework Apache Flink, a distributed processing engine for stateful computations over data streams. It enables you to easily get started with real-time stream processing using SQL. +Aiven for Apache Flink® is powered by the open-source framework Apache Flink, a distributed processing engine for stateful computations over data streams. It enables you to easily get started with real-time stream processing using SQL. Some of the key features of Aiven for Apache Flink® include: @@ -15,7 +15,7 @@ Applications in the Aiven for Apache Flink service are containers that hold ever Interactive queries ------------------- -The interactive query feature in Aiven for Apache Flink allows you to preview the data of a Flink table or job without outputting the rows to a sink table such as Kafka. This can be useful for testing and debugging purposes, as it allows you to quickly and easily see the data that is being processed by your Flink application. +The interactive query feature in Aiven for Apache Flink allows you to preview the data of a Flink table or job without outputting the rows to a sink table such as Apache Kafka®. This can be useful for testing and debugging purposes, as it allows you to quickly and easily see the data that is being processed by your Flink application. Built-in data flow integration with Aiven for Apache Kafka® ----------------------------------------------------------- diff --git a/docs/products/flink/concepts/managed-service-features.rst b/docs/products/flink/concepts/managed-service-features.rst index 9110eb7e9a..be33b913c7 100644 --- a/docs/products/flink/concepts/managed-service-features.rst +++ b/docs/products/flink/concepts/managed-service-features.rst @@ -5,9 +5,9 @@ As a fully managed distributed data stream processing platform, deployable in th Cluster deployment mode ----------------------- -Aiven for Apache Flink® is configured to use the `HashMap state backend `_. This means that the `state `_ is stored in memory, which can impact the performance of jobs that require keeping a very large state. We recommend you provision your platform accordingly. +Aiven for Apache Flink® is configured to use the `HashMap state backend `_. This means that the `state `_ is stored in memory, which can impact the performance of jobs that require keeping a very large state. We recommend you provision your platform accordingly. -The Flink cluster executes applications in `session mode `_ so you can deploy multiple Flink jobs on the same cluster, thus effectively utilizing the available resources. +The Flink cluster executes applications in `session mode `_ so you can deploy multiple Flink jobs on the same cluster, thus effectively utilizing the available resources. Scaling a Flink cluster ----------------------- @@ -15,17 +15,17 @@ Each node is equipped with a TaskManager and JobManager. We recommend scaling up By default, each TaskManager is configured with a single slot for maximum job isolation. It is highly recommended that you modify this option to match your requirements. -.. note:: Adjusting the task slots per TaskManager requires a cluster restart. +.. warning:: Adjusting the task slots per TaskManager requires a cluster restart. Cluster restart strategy ------------------------ -The cluster's default restart strategy is configured to Failure Rate. This controls Flink's restart behavior in cases of failures during the execution of jobs. Administrators can overwrite this setting in the service's advanced configuration options. +The default restart strategy of the cluster is set to `Failure Rate`. This controls how Apache Flink restarts in case of failures during job execution. Administrators can change this setting in the advanced configuration options of the service. For more information on available options, refer to `Apache Flink's fault tolerance `_ documentation. Disaster recovery ----------------- -Periodic checkpoints have been configured to be persisted externally in object storage. They allow Flink to recover states and positions in the streams by giving the application the same semantics as a failure-free execution. +Periodic checkpoints have been configured to be persisted externally in object storage. They allow Flink to recover states and positions in the streams by giving the application the same semantics as a failure-free execution. For information on checkpoints, see Security considerations ----------------------- diff --git a/docs/products/flink/reference/flink-limitations.rst b/docs/products/flink/reference/flink-limitations.rst index 9d3e607eb2..b162d2a31e 100644 --- a/docs/products/flink/reference/flink-limitations.rst +++ b/docs/products/flink/reference/flink-limitations.rst @@ -6,7 +6,7 @@ There are likely differences between Aiven for Apache Flink and an Apache Flink Some of the differences you might see between Aiven for Apache Flink and a self-managed Flink service include: - **User-defined functions:** Aiven for Apache Flink does not currently support using user-defined functions (UDFs). -- **Apache Flink CLI tool:** The Apache Flink® CLI tool is not currently supported as it requires access to the - JobManager in production, which is not exposed to customers. +- **Apache Flink CLI tool:** The Apache Flink® CLI tool is not currently supported as it requires access to the JobManager in production, which is not exposed to customers. - **Job-level settings:** In Aiven for Apache Flink, each job inherits the cluster-level settings, and job-level settings are not yet supported. You cannot specify separate settings for individual jobs within the same cluster. - **Flame graphs:** Flame graphs are marked as an experimental feature in Apache Flink 1.15 and are not currently enabled in the Aiven for Apache Flink web UI.