From d34e11fb8f8a481b601a67ed1b3316a162925217 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy Date: Mon, 15 Jan 2024 15:43:30 +0100 Subject: [PATCH 1/5] Updated few more topics with the new service settings page --- .../integrations/access-jmx-metrics-jolokia.rst | 12 ++++++++---- docs/platform/howto/prepare-for-high-load.rst | 12 ++++++++++-- docs/products/flink/howto/flink-confluent-avro.rst | 3 ++- .../kafka/kafka-connect/howto/enable-connect.rst | 4 +++- .../howto/enable-oauth-oidc-kafka-rest-proxy.rst | 7 ++++--- 5 files changed, 27 insertions(+), 11 deletions(-) diff --git a/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst b/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst index 51baddaad8..168f596de7 100644 --- a/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst +++ b/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst @@ -27,12 +27,16 @@ To enable Jolokia integration for Aiven services, follow these steps to create a Enabling Jolokia integration ------------------------------ + +Enabling Jolokia Integration +---------------------------- + To enable Jolokia integration for a specific service, follow these steps: -1. In the `Aiven Console `_, open the service for which you want to enable Jolokia integration. -2. On the **Overview** page of your service, navigate to the **Service integrations** section, and select **Manage integrations**. -3. On the **Integrations** page, select **Jolokia** from the list. -4. Select the Jolokia endpoint you created and select **Enable**. The system will configure the Jolokia endpoint on all service nodes, providing access to the metrics. +#. Access the `Aiven Console `_ and click on the service for which you want to enable Jolokia integration. +#. On the **Overview** page of your service, click **Integrations** in the sidebar. +#. On the **Integrations** page, find **Jolokia** under **External Integrations** and click on it. +#. Choose the Jolokia endpoint you created and click **Enable**. The system will then configure the Jolokia endpoint on all service nodes, providing access to the metrics. The Aiven Jolokia integration enables HTTP POST requests to retrieve values from service-specific metrics. It also supports bulk requests for batch collection of metrics. For more detailed information on the Jolokia protocol, refer to `Jolokia documentation `__ . diff --git a/docs/platform/howto/prepare-for-high-load.rst b/docs/platform/howto/prepare-for-high-load.rst index 133e6dbcc1..4c3217f4a1 100644 --- a/docs/platform/howto/prepare-for-high-load.rst +++ b/docs/platform/howto/prepare-for-high-load.rst @@ -46,9 +46,17 @@ If you forecast a load that can't be handled by the current service plan, you ca Define the backups schedule --------------------------- -During the backup process, you may experience a temporary higher load. It is therefore recommended to perform them outside of your peak traffic hours to lower the impact. +To minimize the impact of the higher load during the backup process, it is recommended to schedule backups outside of peak traffic hours. -For Aiven for PostgreSQL® and Aiven for MySQL® services, you can configure the time in the day when the daily backups are taken by setting the ``backup_hour`` and ``backup_minute`` variables in `Aiven Console `_ > your service's **Overview** page > the **Advanced configuration** section. +To configure the daily backup time in **Aiven for PostgreSQL®** and **Aiven for MySQL®** services: + +#. Access the `Aiven Console `, select your project and then choose your service. +#. In the service page, select **Service settings** from the sidebar, and scroll down to the **Advanced configuration** section. +#. Click **Configure**. +#. In the **Advanced configuration** dialog, configure the values for these variables: + + * ``backup_hour``: The hour of the day when the backup starts. + * ``backup_minute``: The minute of the hour to begin the backup. .. Tip:: diff --git a/docs/products/flink/howto/flink-confluent-avro.rst b/docs/products/flink/howto/flink-confluent-avro.rst index b190132267..5a7a1c9703 100644 --- a/docs/products/flink/howto/flink-confluent-avro.rst +++ b/docs/products/flink/howto/flink-confluent-avro.rst @@ -13,7 +13,8 @@ Prerequisites * :doc:`Aiven for Apache Flink service ` with Aiven for Apache Kafka® integration. See :doc:`/docs/products/flink/howto/create-integration` for more information. * Aiven for Apache Kafka® service with Karapace Schema registry enabled. See :doc:`/docs/products/kafka/karapace/get-started` for more information. -* By default, Flink cannot create Apache Kafka topics while pushing the first record automatically. To change this behavior, enable in the Aiven for Apache Kafka target service the ``kafka.auto_create_topics_enable`` option in **Advanced configuration** section. +* By default, Flink cannot automatically create Apache Kafka topics when pushing the first record. To change this behavior, enable the ``kafka.auto_create_topics_enable`` option in the **Advanced configuration** section of the Aiven for Apache Kafka target service. To access the **Advanced Configuration**, go to your target service's overview page, select **Service Settings** from the sidebar, scroll down to the **Advanced Configuration** section. + Create an Apache Flink® table with Confluent Avro -------------------------------------------------- diff --git a/docs/products/kafka/kafka-connect/howto/enable-connect.rst b/docs/products/kafka/kafka-connect/howto/enable-connect.rst index 9252866d13..03e7948e17 100644 --- a/docs/products/kafka/kafka-connect/howto/enable-connect.rst +++ b/docs/products/kafka/kafka-connect/howto/enable-connect.rst @@ -11,6 +11,8 @@ To enable Apache Kafka Connect on Aiven for Apache Kafka nodes 1. Log into `Aiven Console `_ and select the Aiven for Apache Kafka service where to enable Apache Kafka Connect -2. Scroll down the **Service overview** page to the **Apache Kafka Connect** section and turn it on. +2. Select **Connectors** from the sidebar. +3. On the **Connectors** page, click **Enable connector on this service**. + The Apache Kafka Connect connection information are now available at the top of the **Service overview** page in the Kafka Connect tab. diff --git a/docs/products/kafka/karapace/howto/enable-oauth-oidc-kafka-rest-proxy.rst b/docs/products/kafka/karapace/howto/enable-oauth-oidc-kafka-rest-proxy.rst index 376d2b3685..ee064a1bcc 100644 --- a/docs/products/kafka/karapace/howto/enable-oauth-oidc-kafka-rest-proxy.rst +++ b/docs/products/kafka/karapace/howto/enable-oauth-oidc-kafka-rest-proxy.rst @@ -43,9 +43,10 @@ Prerequisites Configuration via Aiven Console ``````````````````````````````````` 1. In `Aiven Console `_, select your project and then choose your Aiven for Apache Kafka® service. -2. On the **Overview** page, scroll down to **Advanced configuration** and select **Configure**. -3. In the **Advanced configuration** screen, select **Add configuration options**. -4. Look for ``kafka_rest_authorization`` parameter and set it to ``True``. +2. In the service page, select **Service settings** from the sidebar. +3. On the **Service settings** page, scroll down to the **Advanced configuration** section, and click **Configure**. +4. In the **Advanced configuration** dialog, select **Add configuration options**. +5. Look for ``kafka_rest_authorization`` parameter and set it to ``True``. Configuration via Aiven CLI ````````````````````````````` From 776a8f95eaa0f33e18848a700e8e317f1a81badc Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy Date: Thu, 25 Jan 2024 09:17:48 +0100 Subject: [PATCH 2/5] updated content for Apache Kafka Connect --- docs/products/kafka/kafka-connect/get-started.rst | 10 ++++++++++ .../kafka/kafka-connect/howto/enable-connect.rst | 3 ++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/products/kafka/kafka-connect/get-started.rst b/docs/products/kafka/kafka-connect/get-started.rst index 87c43334a9..b4f29d1272 100644 --- a/docs/products/kafka/kafka-connect/get-started.rst +++ b/docs/products/kafka/kafka-connect/get-started.rst @@ -4,6 +4,16 @@ Getting started Before creating an Aiven for Apache Kafka® Connect service, ensure that you have existing Aiven for Apache Kafka® services set up in your project. If your project does not have any Aiven for Apache Kafka services, you must create one by following the instructions in the :doc:`create new service guide `. +Key benefits of Apache Kafka® Connect with Aiven for Apache Kafka services: + +- You can integrate multiple dedicated Kafka Connect services with the same Aiven for Apache Kafka cluster without any conflicts, even if they run on the same cluster nodes. +- Each service has its own data management (config, offsets, status) in separate internal topics, identified by integration IDs. This ensures smooth operation and avoids data interference. +- You don't have to delete your existing connectors when you set up a standalone Apache Kafka Connect service. They can keep running in their current deployment. +- If you want to migrate a connector from one Kafka Connect service to another, make sure to migrate the offsets as well. + + + + .. _apache_kafka_connect_dedicated_cluster: Create a dedicated Aiven for Apache Kafka® Connect service diff --git a/docs/products/kafka/kafka-connect/howto/enable-connect.rst b/docs/products/kafka/kafka-connect/howto/enable-connect.rst index 03e7948e17..135cb5580d 100644 --- a/docs/products/kafka/kafka-connect/howto/enable-connect.rst +++ b/docs/products/kafka/kafka-connect/howto/enable-connect.rst @@ -1,7 +1,8 @@ Enable Apache Kafka® Connect on Aiven for Apache Kafka® ======================================================= -To enable Apache Kafka® Connect on Aiven for Apache Kafka® services, those should be running on business or premium plans. +Leveraging Aiven for Apache Kafka services with Apache Kafka Connect can enhance data streaming capabilities between sources and sinks. To use Apache Kafka® Connect with Aiven for Apache Kafka® services, you need to have a business or premium plan. + .. Warning:: From 648bc66f0641f8820a8ab5764af50e0492dc411d Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Thu, 25 Jan 2024 09:28:33 +0100 Subject: [PATCH 3/5] Update docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst Co-authored-by: Arthur --- docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst b/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst index 168f596de7..f0ac344eee 100644 --- a/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst +++ b/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst @@ -33,7 +33,7 @@ Enabling Jolokia Integration To enable Jolokia integration for a specific service, follow these steps: -#. Access the `Aiven Console `_ and click on the service for which you want to enable Jolokia integration. +#. Access the `Aiven Console `_ and click the service for which you want to enable Jolokia integration. #. On the **Overview** page of your service, click **Integrations** in the sidebar. #. On the **Integrations** page, find **Jolokia** under **External Integrations** and click on it. #. Choose the Jolokia endpoint you created and click **Enable**. The system will then configure the Jolokia endpoint on all service nodes, providing access to the metrics. From 2715ef27f3ae2e886244ead12128eb930039a641 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Thu, 25 Jan 2024 09:28:43 +0100 Subject: [PATCH 4/5] Update docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst Co-authored-by: Arthur --- docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst b/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst index f0ac344eee..9f154144bd 100644 --- a/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst +++ b/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst @@ -36,7 +36,7 @@ To enable Jolokia integration for a specific service, follow these steps: #. Access the `Aiven Console `_ and click the service for which you want to enable Jolokia integration. #. On the **Overview** page of your service, click **Integrations** in the sidebar. #. On the **Integrations** page, find **Jolokia** under **External Integrations** and click on it. -#. Choose the Jolokia endpoint you created and click **Enable**. The system will then configure the Jolokia endpoint on all service nodes, providing access to the metrics. +#. Choose the Jolokia endpoint you created and click **Enable**. The system configures the Jolokia endpoint on all service nodes, providing access to the metrics. The Aiven Jolokia integration enables HTTP POST requests to retrieve values from service-specific metrics. It also supports bulk requests for batch collection of metrics. For more detailed information on the Jolokia protocol, refer to `Jolokia documentation `__ . From 9d9bedc632d88005386a4e4f9551f5a7e18977bd Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Thu, 25 Jan 2024 09:28:48 +0100 Subject: [PATCH 5/5] Update docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst Co-authored-by: Arthur --- docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst b/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst index 9f154144bd..f9dee5debe 100644 --- a/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst +++ b/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst @@ -35,7 +35,7 @@ To enable Jolokia integration for a specific service, follow these steps: #. Access the `Aiven Console `_ and click the service for which you want to enable Jolokia integration. #. On the **Overview** page of your service, click **Integrations** in the sidebar. -#. On the **Integrations** page, find **Jolokia** under **External Integrations** and click on it. +#. On the **Integrations** page, in **External Integrations**, click **Jolokia**. #. Choose the Jolokia endpoint you created and click **Enable**. The system configures the Jolokia endpoint on all service nodes, providing access to the metrics. The Aiven Jolokia integration enables HTTP POST requests to retrieve values from service-specific metrics. It also supports bulk requests for batch collection of metrics. For more detailed information on the Jolokia protocol, refer to `Jolokia