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

Commit

Permalink
Merge pull request #2290 from aiven/dorota-update-pg-docs-for-the-new…
Browse files Browse the repository at this point in the history
…-settings-page

[DON'T MERGE] platform: docs updates for the new service settings UX
  • Loading branch information
wojcik-dorota authored Dec 8, 2023
2 parents bc7c0ae + 36b83ac commit ea8cff3
Show file tree
Hide file tree
Showing 26 changed files with 112 additions and 101 deletions.
2 changes: 1 addition & 1 deletion docs/platform/reference/eol-for-major-versions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ own schedule. After the EOL date:
1. If the service is powered on, it's auto-upgraded to the latest version.
2. If the service is powered off, it's deleted.

Aiven platform offers database forking as an efficient tool to verify
Aiven platform offers :doc:`database forking </docs/platform/howto/console-fork-service>` as an efficient tool to verify
the version upgrade so that customers can safely test compatibility
without committing their production services to a one-way upgrade.

Expand Down
20 changes: 13 additions & 7 deletions docs/products/cassandra/howto/manage-cross-cluster-replication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,19 @@ Change the service plan

.. note::

It's recommended to use the `Aiven console <https://console.aiven.io/>`_ for changing the plan for a CCR-enabled service.
It's recommended to use `Aiven Console <https://console.aiven.io/>`_ for changing the plan for a CCR-enabled service.

1. Log in to `Aiven Console <https://console.aiven.io/>`_.
2. From the **Services** page, select a CCR-enabled Aiven for Apache Cassandra service that you want to update.
3. In the **Overview** page of your service, navigate to **Service plan** and select **Change plan**.
4. In the **Change service plan** view, select a new plan you want to use for your service.
3. On the **Overview** page of your service, select **Service settings** from the sidebar.
4. On the **Service settings** page of your service, navigate to the **Service plan** section, and select **Change plan** from the **Actions** (**...**) menu.
5. In the **Change service plan** window, select a new plan you want to use for your service.

.. tip::

You can also add extra disk space for your service by using the slider in the **Additional disk storage** section.

5. Select **Change**.
6. Select **Change**.

.. topic:: Result

Expand All @@ -62,14 +63,19 @@ Add an extra disk space

1. Log in to `Aiven Console <https://console.aiven.io/>`_.
2. From the **Services** page, select a CCR-enabled Aiven for Apache Cassandra service that you want to update.
3. In the **Overview** page of your service, navigate to the **Service plan** section and select **Add storage**.
4. In the **Upgrade service storage** view, use the slider to add extra disk space for your service.
3. On the **Overview** page of your service, select **Service settings** from the sidebar.
4. On the **Service settings** page of your service, navigate to the **Service plan** section, and select **Add additional storage** from the **Actions** (**...**) menu.
5. In the **Upgrade service storage** window, use the slider to add extra disk space for your service.

.. tip::

You can also change your service plan by selecting **Change plan** in the **Your current plan** section.

You've added extra disk storage space for your CCR-enabled service and its CCR-replica service.
6. Select **Save changes**.

.. topic:: Result

You've added extra disk storage space for your CCR-enabled service and its CCR-replica service.

.. _set-up-replication-factor:

Expand Down
2 changes: 1 addition & 1 deletion docs/products/cassandra/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ It is a truly distributed database where the individual nodes can communicate wi
Get started with Aiven for Apache Cassandra
-------------------------------------------

Take your first steps with Aiven for Apache Cassandra® by following :doc:`Get started with Aiven for Apache Cassandra </docs/products/cassandra/get-started>`.
Take your first steps with Aiven for Apache Cassandra® by following :doc:`Get started with Aiven for Apache Cassandra </docs/products/cassandra/get-started>`.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To use the ClickHouse® client across different operating systems, we recommend
Connection properties
---------------------

You will need to know the following properties to establish a secure connection with your Aiven for ClickHouse service: **Host**, **Port**, **User** and **Password**. You will find these in the *Connection information* section in the *Overview* page of your service in the `Aiven web console <https://console.aiven.io/>`_.
You will need to know the following properties to establish a secure connection with your Aiven for ClickHouse service: **Host**, **Port**, **User** and **Password**. You will find these in the **Connection information** section on the **Overview** page of your service in the `Aiven web console <https://console.aiven.io/>`_.

Command template
----------------
Expand Down
2 changes: 1 addition & 1 deletion docs/products/clickhouse/howto/enable-tiered-storage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Prerequisites

* You have an Aiven organization and at least one project.
* You have a command line tool (:doc:`ClickHouse client </docs/products/clickhouse/howto/connect-with-clickhouse-cli>`) installed.
* All maintenance updates are applied on your service (check on the **Overview** page of your service in Aiven Console).
* All maintenance updates are applied on your service (check in Aiven Console: your service's page > **Service settings** > **Service management** > **Maintenance updates**).

Enable tiered storage on a project
----------------------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/products/clickhouse/howto/secure-service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ Aiven services can be protected against accidental deletion or powering off by e
Enable the termination protection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. Log in to the `Aiven web console <https://console.aiven.io/>`_, and select your ClickHouse® service from the **Services** view.

2. In the **Overview** page of your service, scroll down to the **Termination protection** section and enable this feature using the toggle switch.
1. Log in to `Aiven Console <https://console.aiven.io/>`_, and select your ClickHouse® service from the **Services** view.
2. On the **Overview** page of your service, select **Service settings** from the sidebar.
3. On the **Service settings** page, navigate to the **Service status** section, and select **Enable termination protection** from the **Actions** (**...**) menu.

.. topic:: Result

Expand Down
2 changes: 1 addition & 1 deletion docs/products/grafana/howto/dashboard-previews.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ Limitations
* Before downgrading your service plan to Hobbyist or Startup-1, where dashboard previews are unavailable, you need first to disable it on the current service.

.. seealso::
For more information on Dashboard previews, see `Grafana documentation <https://grafana.com/docs/grafana/latest/dashboards/>`_.
For more information on Dashboard previews, see `Grafana documentation <https://grafana.com/docs/grafana/latest/dashboards/>`_.
10 changes: 6 additions & 4 deletions docs/products/kafka/howto/enabled-consumer-lag-predictor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,13 @@ Enable 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**.
2. Click **Service settings** on the sidebar.

3. In the **Advanced configuration** screen, select **Add configuration options**.
3. Scroll to the **Advanced configuration** section, and select **Configure**.

4. In the add configuration options:
4. In the **Advanced configuration** screen, select **Add configuration options**.

5. In the add configuration options:

- Find and set ``kafka_lag_predictor.enabled`` to **Enabled** position. This enables the lag predictor to compute predictions for all consumer groups across all topics.
- Find ``kafka_lag_predictor.group_filters`` and enter the desired consumer group pattern. This specifies which consumer groups to consider during lag prediction calculations.
Expand All @@ -35,7 +37,7 @@ Enable via Aiven Console

By default, the consumer lag predictor calculates the lag of all consumer groups. To restrict the calculation to specific groups, use the ``kafka_lag_predictor.group_filters`` option.

5. Select **Save configurations** to save your changes and enable consumer lag prediction.
6. Select **Save configurations** to save your changes and enable consumer lag prediction.

Enable via Aiven CLI
------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/products/kafka/kafka-mirrormaker/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Create a new Aiven for Apache Kafka MirrorMaker 2 dedicated service:

1. Log in to the `Aiven Console <https://console.aiven.io/>`_ and select the **Aiven for Apache Kafka®** service for which you want to create a dedicated Aiven for Apache Kafka® MirrorMaker 2 service.

2. Scroll down to the **Service Integration** section on the service Overview page and select **Manage integrations**.
2. Click **Integrations** on the sidebar.

3. In the **Integrations** screen, select **Apache Kafka MirrorMaker 2**.
3. On the **Integrations** screen, choose **Apache Kafka MirrorMaker**.

4. Select the **New service** option.

Expand Down
22 changes: 13 additions & 9 deletions docs/products/kafka/karapace/howto/enable-karapace.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
Enable Karapace schema registry and REST APIs
Enable Karapace schema registry and REST APIs
=============================================

To enable **Karapace schema registry** and **REST APIs** on Aiven for Apache Kafka® from the Aiven Console, follow these steps:
To enable **Karapace schema registry** and **REST APIs** on Aiven for Apache Kafka® from the Aiven Console, follow these steps:

1. In the `Aiven Console <https://console.aiven.io/>`_, click on the service to view its overview screen.
2. Look for **Schema Registry (Karapace)** or **Apache Kafka REST API (Karapace)**, and enable the setting for either one of the features based on your requirements.
1. In the `Aiven Console <https://console.aiven.io/>`_, and select your Aiven for Apache Kafka service.
2. Click **Service settings** on the sidebar.
3. In the **Service management** section, click **Actions** (**...**).
4. From the dropdown menu, enable the setting for either or both of the features based on your requirements:
a. Click **Enable REST API (Karapace)**. Confirm your choice in the dialog by clicking **Enable**.
b. Click **Enable Schema Registry (Karapace)**. Confirm your choice in the dialog by clicking **Enable**.

To learn more about Karapace and its features, see the `Karapace homepage <https://www.karapace.io/>`_ and `GitHub project <https://github.com/aiven/karapace>`_.
To learn more about Karapace and its features, visit the [Karapace homepage](https://www.karapace.io) and the [Karapace GitHub project](https://github.com/aiven/karapace).

.. tip::
If you use any of our automation or other integrations, the parameters to enable schema registry or REST APIs on your service are named ``schema_registry`` and ``kafka_rest``.
.. tip::
For automation or integration setups, use the parameters ``schema_registry`` and ``kafka_rest`` to enable the schema registry or REST APIs on your service.

More resources
--------------
For more information on how to setup Karapace with Aiven for Apache Kafka® using `Aiven Terraform Provider <https://registry.terraform.io/providers/aiven/aiven/latest/docs>`_, see `Apache Kafka® with Karapace Schema Registry <https://aiven.io/developer/apache-kafka-karapace>`_.

For instructions on setting up Karapace with Aiven for Apache Kafka® using `Aiven Terraform Provider <https://registry.terraform.io/providers/aiven/aiven/latest/docs>`_, see `Apache Kafka® with Karapace Schema Registry <https://aiven.io/developer/apache-kafka-karapace>`_.

4 changes: 2 additions & 2 deletions docs/products/m3db/howto/grafana.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Integrate M3DB and Grafana
--------------------------

1. Log into `Aiven Console <https://console.aiven.io>`_ and select your Aiven for M3DB service.
2. On the service overview page, scroll to **Service integrations** and select **Manage Integrations**.
2. Click **Integrations** on the sidebar.
3. Select **Monitor Data in Grafana**.
4. Choose either a new or existing service.
4. Choose either a new service or existing service.

- When creating a new service you will need to select the cloud, region and plan to use. You should also give your service a name. The service overview page shows the nodes rebuilding, and then indicates when they are ready.
- If you're already using Grafana on Aiven, you can integrate your M3DB as a data source for that existing Grafana.
Expand Down
2 changes: 1 addition & 1 deletion docs/products/mysql/concepts/mysql-replication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If a statement like the above matched 500 rows and the table had a million rows
Replication use in Aiven for MySQL
----------------------------------

The considerations presented on the :ref:`Replication Overview <myslq-replication-overview>` section are not only valid for services that actually have standby nodes or read-only replicas. Whenever the Aiven management platform needs to create a new node for a service, the node is first initialized from backup to most recent backed up state. This includes applying the full replication stream that has been created after the most recent full base backup. Once the latest backed
The considerations presented on the :ref:`Replication overview <myslq-replication-overview>` section are not only valid for services that actually have standby nodes or read-only replicas. Whenever the Aiven management platform needs to create a new node for a service, the node is first initialized from backup to most recent backed up state. This includes applying the full replication stream that has been created after the most recent full base backup. Once the latest backed
up state has been restored the node will connect to the current master, if available, and replicate latest state from that, which is also affected by possible replication slowness.

When new nodes are created, it needs to perform replication and having large tables without primary keys may make operations such as replacing failed nodes, upgrading service plan, migrating service to a different cloud provider or region, starting up new read-only replica service, forking a service, and some others to take extremely long time or depending on the situation practically not complete at all without manual operator intervention (e.g. new read-only replica might never be able to catch up with existing master because replication is too slow).
Expand Down
2 changes: 1 addition & 1 deletion docs/products/mysql/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Start a service

This view shows the connection parameters for your MySQL service and its current status.

3. You can make changes to the service configuration in the **Overview** page, even while the service is being built.
3. On the **Overview** page, select **Service settings** from the sidebar to access the **Advanced configuration** section and make changes to the service configuration, even while the service is being built.

You can find the available configuration options in the :doc:`reference article </docs/products/mysql/reference/advanced-params>`.

Expand Down
2 changes: 1 addition & 1 deletion docs/products/mysql/howto/create-missing-primary-keys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ When executing the ``ALTER TABLE`` statement for a large table, you may encounte
Creating index 'PRIMARY' required more than 'mysql.innodb_online_alter_log_max_size' bytes of modification log. Please try again.
For the operation to succeed, you need to set a value that is high enough. Depending on the table size, this could be a few gigabytes or even more for very large tables. You can change ``mysql.innodb_online_alter_log_max_size`` as follows: `Aiven Console <https://console.aiven.io/>`_ > your Aiven for MySQL service > the **Overview** page of your service > the **Advanced configuration** section > **Change** > **Add configuration option** > ``mysql.innodb_online_alter_log_max_size`` > set a value > **Save advanced configuration**.
For the operation to succeed, you need to set a value that is high enough. Depending on the table size, this could be a few gigabytes or even more for very large tables. You can change ``mysql.innodb_online_alter_log_max_size`` as follows: `Aiven Console <https://console.aiven.io/>`_ > your Aiven for MySQL service's page > the **Service settings** page of the service > the **Advanced configuration** section > **Configure** > **Add configuration options** > ``mysql.innodb_online_alter_log_max_size`` > set a value > **Save configuration**.

.. seealso::

Expand Down
14 changes: 8 additions & 6 deletions docs/products/mysql/howto/create-tables-without-primary-keys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ Create new tables without primary keys
If your Aiven for MySQL® service was created after 2020-06-03, by default it does not allow creating new tables without primary keys. You can check this by taking the following steps:

1. Log in to `Aiven Console <https://console.aiven.io/>`_.
2. In the **Services** page, select your Aiven for MySQL service that you want to check.
3. In the **Overview** page of your service, scroll down to the **Advanced configuration** section.
4. Check the **Advanced configuration** section for the ``mysql.sql_require_primary_key`` parameter and its status.
2. On the **Services** page, select your Aiven for MySQL service that you want to check.
3. On your service's page, select **Service settings** from the sidebar.
4. On the **Service settings** page of your service, scroll down to the **Advanced configuration** section.
5. Check the **Advanced configuration** section for the ``mysql.sql_require_primary_key`` parameter and its status.

If ``mysql.sql_require_primary_key`` is enabled, your Aiven for MySQL does not allow you to create new tables without primary keys. Attempts to create tables without primary keys will result in the following error message:

Expand All @@ -31,9 +32,10 @@ You have two options to create the tables:
* Disabling ``mysql.sql_require_primary_key`` parameter. To disable the ``mysql.sql_require_primary_key`` parameter, take the following steps:

1. Log in to `Aiven Console <https://console.aiven.io/>`_.
2. In the **Services** page, select your Aiven for MySQL service that you want to check.
3. In the **Overview** page of your service, scroll down to the **Advanced configuration** section and select **Change**.
4. In the **Edit advanced configuration** window, find ``mysql.sql_require_primary_key`` and disable it by using the toggle switch. Select **Save advanced configuration**.
2. On the **Services** page, select your Aiven for MySQL service that you want to check.
3. On your service's page, select **Service settings** from the sidebar.
4. On the **Service settings** page of your service, scroll down to the **Advanced configuration** section and select **Configure**.
5. In the **Advanced configuration** window, find ``mysql.sql_require_primary_key`` and disable it by using the toggle switch. Select **Save configuration**.

.. warning::

Expand Down
12 changes: 5 additions & 7 deletions docs/products/mysql/howto/enable-slow-queries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ Follow these steps to enable your slow queries in your Aiven for MySQL service v

1. Log in to `Aiven Console <https://console.aiven.io/>`_.
2. In the **Services** page, select your Aiven for MySQL service.
3. In the **Overview** page of your service, scroll down to the **Advanced configuration** section and select **Change**.
4. In the **Edit advanced configuration** window
3. In the **Service settings** page of your service, scroll down to the **Advanced configuration** section and select **Configure**.
4. In the **Advanced configuration** window

1. Select **Add configuration option**. From the unfolded list, choose ``mysql.slow_query_log``. Enable ``mysql.slow_query_log`` by toggling it to ``On``. By default, ``mysql.slow_query_log`` is disabled.
2. Select **Add configuration option**. From the unfolded list, choose ``mysql.long_query_time``. Set ``mysql.long_query_time`` according to your specific need.
3. Select **Save advanced configuration**.
1. Select **Add configuration options**. From the unfolded list, choose ``mysql.slow_query_log``. Enable ``mysql.slow_query_log`` by toggling it to ``On``. By default, ``mysql.slow_query_log`` is disabled.
2. Select **Add configuration options**. From the unfolded list, choose ``mysql.long_query_time``. Set ``mysql.long_query_time`` according to your specific need.
3. Select **Save configuration**.

Your Aiven for MySQL service can now log slow queries. If you want to simulate slow queries to check this feature, check the next section.

Expand Down Expand Up @@ -72,5 +72,3 @@ You can expect to receive an output similar to the following:
.. warning::
Disabling the ``mysql.slow_query_log`` setting truncates the ``mysql.slow_query_log`` table. Make sure to back up the data from the ``mysql.slow_query_log`` table in case you need it for further analysis.
Loading

0 comments on commit ea8cff3

Please sign in to comment.