Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Update more topics to reflect the new Aiven Console Service settings page #2428

Merged
merged 6 commits into from
Jan 25, 2024
Next Next commit
Updated few more topics with the new service settings page
harshini-rangaswamy committed Jan 15, 2024

Verified

This commit was signed with the committer’s verified signature.
harshini-rangaswamy Harshini Rangaswamy
commit d34e11fb8f8a481b601a67ed1b3316a162925217
12 changes: 8 additions & 4 deletions docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst
Original file line number Diff line number Diff line change
@@ -27,12 +27,16 @@

Enabling Jolokia integration
------------------------------

Enabling Jolokia Integration

Check failure on line 31 in docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst

GitHub Actions / vale

[vale] docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst#L31

[Aiven.capitalization_headings] 'Enabling Jolokia Integration' should be in sentence case
Raw output
{"message": "[Aiven.capitalization_headings] 'Enabling Jolokia Integration' should be in sentence case", "location": {"path": "docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst", "range": {"start": {"line": 31, "column": 1}}}, "severity": "ERROR"}
----------------------------

To enable Jolokia integration for a specific service, follow these steps:

1. In the `Aiven Console <https://console.aiven.io/>`_, 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 <https://console.aiven.io/>`_ and click on the service for which you want to enable Jolokia integration.
harshini-rangaswamy marked this conversation as resolved.
Show resolved Hide resolved
#. 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.
harshini-rangaswamy marked this conversation as resolved.
Show resolved Hide resolved
#. 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.
harshini-rangaswamy marked this conversation as resolved.
Show resolved Hide resolved

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 <https://jolokia.org/reference/html/manual/jolokia_protocol.html>`__ .
12 changes: 10 additions & 2 deletions docs/platform/howto/prepare-for-high-load.rst
Original file line number Diff line number Diff line change
@@ -46,9 +46,17 @@
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 <https://console.aiven.io/>`_ > 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 <https://console.aiven.io/>`, select your project and then choose your service.

Check failure on line 53 in docs/platform/howto/prepare-for-high-load.rst

GitHub Actions / vale

[vale] docs/platform/howto/prepare-for-high-load.rst#L53

[Aiven.common_replacements] Use 'Aiven' instead of 'aiven'.
Raw output
{"message": "[Aiven.common_replacements] Use 'Aiven' instead of 'aiven'.", "location": {"path": "docs/platform/howto/prepare-for-high-load.rst", "range": {"start": {"line": 53, "column": 47}}}, "severity": "ERROR"}
#. 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::

3 changes: 2 additions & 1 deletion docs/products/flink/howto/flink-confluent-avro.rst
Original file line number Diff line number Diff line change
@@ -13,7 +13,8 @@ Prerequisites

* :doc:`Aiven for Apache Flink service </docs/platform/howto/create_new_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
--------------------------------------------------
4 changes: 3 additions & 1 deletion docs/products/kafka/kafka-connect/howto/enable-connect.rst
Original file line number Diff line number Diff line change
@@ -11,6 +11,8 @@ To enable Apache Kafka Connect on Aiven for Apache Kafka nodes

1. Log into `Aiven Console <https://console.aiven.io>`_ 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.
Original file line number Diff line number Diff line change
@@ -43,9 +43,10 @@ Prerequisites
Configuration via Aiven Console
```````````````````````````````````
1. In `Aiven Console <https://console.aiven.io/>`_, 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
`````````````````````````````