From 2b5286d1c83c580d1c08f3dbe7d2df37e63e9852 Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Sat, 25 Nov 2023 15:56:08 +0100 Subject: [PATCH 1/7] pg docs updates for the new service settings page in aiven console --- docs/products/postgresql/howto/enable-jit.rst | 15 ++++++++------- .../postgresql/howto/migrate-cloud-region.rst | 6 ++++-- .../howto/migrate-db-to-aiven-via-console.rst | 13 +++++++------ .../postgresql/howto/prevent-full-disk.rst | 5 +++-- docs/products/postgresql/howto/restore-backup.rst | 10 ++++++---- docs/products/postgresql/howto/upgrade.rst | 10 ++++------ .../reference/log-formats-supported.rst | 4 ++-- 7 files changed, 34 insertions(+), 29 deletions(-) diff --git a/docs/products/postgresql/howto/enable-jit.rst b/docs/products/postgresql/howto/enable-jit.rst index b4bf5ad38c..0548b8d83c 100644 --- a/docs/products/postgresql/howto/enable-jit.rst +++ b/docs/products/postgresql/howto/enable-jit.rst @@ -10,14 +10,15 @@ Enable JIT on the global level You can enable JIT for the complete Aiven for PostgreSQL service both via `Aiven Console `_ and :doc:`Aiven CLI `. -To enable JIT in the `Aiven console `_, take the following steps: +To enable JIT in the `Aiven Console `_, take the following steps: -#. Log in to the `Aiven web console `_. +#. Log in to the `Aiven Console `_. #. From the **Services** page, select the the Aiven for PostgreSQL service where you want to enable JIT. -#. In your service's **Overview** page, scroll down to the **Advanced configuration** settings, and select **Change**. -#. In the **Edit advanced configuration** window, select **Add configuration option**. -#. Select parameter ``pg.jit``, and switch the toggle to ``on``. -#. Select **Save advanced configuration**. +#. From the sidebar on your service's page, select **Service settings**. +#. On the **Service settings** page, navigate to the **Advanced configuration** section, and select **Configure**. +#. In the **Advanced configuration** window, select **Add configuration options**. +#. Select parameter ``pg.jit``, and switch the toggle to ``Enabled``. +#. Select **Save configuration**. To enable JIT via :doc:`Aiven CLI `, you can use the :ref:`service update command `: @@ -30,7 +31,7 @@ Enable JIT for a specific database You might not want to use JIT for most simple queries since it would increase the cost. JIT can also be enabled for a single database: -1. Connect to the database where you want to enable JIT. E.g. with ``psql`` and the service URI available in the Aiven for PostgreSQL service overview console page +1. Connect to the database where you want to enable JIT, for example, with ``psql`` and the service URI available in `Aiven Console `_ > your Aiven for PostgreSQL service > the **Overview** page. .. code:: diff --git a/docs/products/postgresql/howto/migrate-cloud-region.rst b/docs/products/postgresql/howto/migrate-cloud-region.rst index 2e19bd27e3..f748c17167 100644 --- a/docs/products/postgresql/howto/migrate-cloud-region.rst +++ b/docs/products/postgresql/howto/migrate-cloud-region.rst @@ -6,8 +6,10 @@ Any Aiven service can be relocated to a different cloud vendor or region. This i To migrate a PostgreSQL service to a new cloud provider/region 1. Log in to `Aiven Console `_, and select the PostgreSQL instance you want to move. -2. In the **Overview** page, select **Migrate cloud**. -3. Select the new cloud provider and region where you want to deploy the PostgreSQL instance, then click **Create** +2. From the sidebar on your service's page, select **Service settings**. +3. On the **Service settings** page, navigate to the **Cloud and network** section, and select **Change cloud or region**. +4. In the **Migrate service to another cloud** window, select the new cloud provider and region where you want to deploy the PostgreSQL instance. +5. Select **Migrate**. The PostgreSQL cluster will enter the ``REBALANCING`` state, still serving queries from the old provider/region. diff --git a/docs/products/postgresql/howto/migrate-db-to-aiven-via-console.rst b/docs/products/postgresql/howto/migrate-db-to-aiven-via-console.rst index dc80ec178c..ec58cd9d6c 100644 --- a/docs/products/postgresql/howto/migrate-db-to-aiven-via-console.rst +++ b/docs/products/postgresql/howto/migrate-db-to-aiven-via-console.rst @@ -208,13 +208,14 @@ Migrate a database 1. Log in to the `Aiven Console `_. 2. On the **Services** page, select the service where your target database is located. -3. On the **Overview** page of the selected service, scroll down to the **Migrate database** section and select **Set up migration**. -4. Guided by the migration wizard, go through all the migration steps. +3. From the sidebar on your service's page, select **Service settings**. +4. On the **Service settings** page, navigate to the **Service management** section, and select **Import database**. +5. Guided by the migration wizard, go through all the migration steps. Step 1: Configure ''''''''''''''''' -Get familiar with the guidelines provided in the **PostgreSQL migration configuration guide** window and select **Get started**. +Get familiar with the guidelines provided in the **PostgreSQL migration configuration guide** window, and select **Get started**. Step 2: Validation '''''''''''''''''' @@ -252,7 +253,7 @@ Trigger the migration by selecting **Start migration** in the **Database migrati While the migration is in progress, you can take the following actions: -* Let it proceed until completed by selecting **Close window**, which closes the wizard. You can come back to check the status at any time on the **Overview** page of the service in the **Migrate database** section. +* Let it proceed until completed by selecting **Close window**, which closes the wizard. You can come back to check the status at any time on the **Service settings** page > the **Service management** section > **Import database**. * Write to the target database. * Discontinue the migration by selecting **Stop migration**. Although the data already migrated is retained, you cannot restart the stopped process. To continue with the migration, you need to start a new migration process from scratch. @@ -277,8 +278,8 @@ As soon as the wizard communicates the completion of the migration, check if the This information in the wizard means that your data has been transferred to Aiven, but some new data is still continuously being synced between the connected databases. -* If there is no replication in progress, select **Close connection** in the migration wizard to finalize the migration process. As a result, on the **Overview** page of the service > the **Migrate database** section, you'll see the **Ready** tag. -* If the replication mode is active, you can select **Keep replicating**. As a result, on the **Overview** page of the service > the **Migrate database** section, you'll see the **Syncing** tag, and you'll be able to check the status of the migration process by selecting **Status update**. +* If there is no replication in progress, select **Close connection** in the migration wizard to finalize the migration process. As a result, on the **Service settings** page > the **Service management** section > **Import database**, you'll see the **Ready** tag. +* If the replication mode is active, you can select **Keep replicating**. As a result, on the **Service settings** page > the **Service management** section > **Import database**, you'll see the **Syncing** tag, and you'll be able to check the status of the migration process by selecting **Status update**. .. topic:: Result diff --git a/docs/products/postgresql/howto/prevent-full-disk.rst b/docs/products/postgresql/howto/prevent-full-disk.rst index 40c684499f..100c9925cb 100644 --- a/docs/products/postgresql/howto/prevent-full-disk.rst +++ b/docs/products/postgresql/howto/prevent-full-disk.rst @@ -20,8 +20,9 @@ You can upgrade the Aiven for PostgreSQL service plan via the `Aiven console `_: 1. Log in to `Aiven Console `_, and select your Aiven for PostgreSQL service. -2. In the **Overview** page of your service, scroll down to the **Service plan** section, and select **Change plan**. -3. In the **Change service plan** window, select a new plan with a higher capacity, and select **Change**. +2. Select **Service settings** from the sidebar of your service's page. +3. Navigate to the **Service plan** section, and select **Change plan** from the **Actions** (**...**) menu. +4. In the **Change service plan** window, select a new plan with a higher capacity, and select **Change**. Once the new nodes with the increased disk capacity are up and running, the disk usage drops below the critical level and the system automatically sets the ``default_transaction_read_only`` parameter to ``OFF`` allowing write operations again. diff --git a/docs/products/postgresql/howto/restore-backup.rst b/docs/products/postgresql/howto/restore-backup.rst index ad71b07f7b..22b63ceb50 100644 --- a/docs/products/postgresql/howto/restore-backup.rst +++ b/docs/products/postgresql/howto/restore-backup.rst @@ -8,13 +8,15 @@ Aiven for PostgreSQL® databases are automatically backed up and can be restored To restore a PostgreSQL database, take the following steps: -1. Log in to the `Aiven web console `_. +1. Log in to the `Aiven Console `_. 2. Select your Aiven for PostgreSQL service from the **Services** page. -3. In the **Overview** page of your service, select **New database fork**. -4. Enter a service name and choose a project name, database version, cloud region and plan for the new instance. -5. Select the **Source service state** defining the backup point, the options are as follows: +3. Select **Service settings** from the sidebar of your service's page. +4. Navigate to the **Service management** section, and select **Fork database** from the **Actions** (**...**) menu. +5. Enter a service name, and choose a project name, database version, cloud region and plan for the new instance. +6. Select the **Source service state** defining the backup point, the options are as follows: * **Latest transaction** * **Point in time** - the date selector allows to chose a precise point in time within the available backup retention period. +7. With all the fork settings configured, select **Create fork**. Once the new service is running, you can change your application's connection settings to point to it. diff --git a/docs/products/postgresql/howto/upgrade.rst b/docs/products/postgresql/howto/upgrade.rst index 5318bfbbe1..a13dfd21e5 100644 --- a/docs/products/postgresql/howto/upgrade.rst +++ b/docs/products/postgresql/howto/upgrade.rst @@ -25,16 +25,14 @@ without affecting the running service. This is useful in two main aspects: Here are the steps to upgrade a PostgreSQL service: 1. Log in to `Aiven Console `_, and select the instance that you want to upgrade. - -2. In the **Overview** page of your service, scroll down to the **PostgreSQL version** section, and select **Upgrade version**. - -3. In the **Upgrade Aiven for PostgreSQL Confirmation** window, select the version that you want to upgrade to from the dropdown menu. +2. Select **Service settings** from the sidebar of your service's page. +3. Navigate to the **Service management** section, and select **Upgrade versioin** from the **Actions** (**...**) menu. +4. In the **Upgrade Aiven for PostgreSQL Confirmation** window, select the version that you want to upgrade to from the dropdown menu. .. Note:: When you select the version, the system checks the compatibility of the upgrade. - -4. Select **Upgrade**. +5. Select **Upgrade**. The system starts applying the upgrade. diff --git a/docs/products/postgresql/reference/log-formats-supported.rst b/docs/products/postgresql/reference/log-formats-supported.rst index 7aaafd98c8..ca3475394e 100644 --- a/docs/products/postgresql/reference/log-formats-supported.rst +++ b/docs/products/postgresql/reference/log-formats-supported.rst @@ -5,7 +5,7 @@ Aiven for PostgreSQL® supports setting different log formats which are compatib You can customise this functionality by navigating to your PostgreSQL® service on the `Aiven Console `_. -Scroll down to the end of the **Overview** page under **Advanced configuration** and select the **Change** button. You can then select the ``pg.log_line_prefix`` parameter and select the needed format based on a pre-fixed list. +From the sidebar on your service's page, select **Service settings**. On the **Service settings** page, navigate to the **Advanced configuration** section, and select **Configure** > **Add configuration options**. Next, you can select the ``pg.log_line_prefix`` parameter and a desired format based on a pre-fixed list. The supported log formats are available below with an example of the output: @@ -30,7 +30,7 @@ The supported log formats are available below with an example of the output: [pg-user-test-1]2023-01-12T00:00:57.839867[postgresql-14][18-1] 2023-01-12 00:00:57.839 GMT [1323] [user=postgres,db=defaultdb,app=[unknown]] LOG: connection authorized: user=postgres database=defaultdb application_name=aiven-pruned [pg-user-test-1]2023-01-12T00:00:57.849223[postgresql-14][19-1] 2023-01-12 00:00:57.849 GMT [1323] [user=postgres,db=defaultdb,app=aiven-pruned] LOG: disconnection: session time: 0:00:00.010 user=postgres database=defaultdb host=[local] -After selecting one of the available log formats from the drop down menu, you can click the **Save advanced configuration** button to have the change take effect. Once the setting has been enabled, you can navigate to the logs tab on your service page to check if the log format has been successfully changed. +After selecting one of the available log formats from the drop down menu, select **Save configuration** to have the change take effect. Once the setting has been enabled, you can navigate to the logs tab on your service page to check if the log format has been successfully changed. At the moment, the formats available are known to be compatible with majority of the log analysis tools. From 972623887599b7aee4a97990928ad9ae06922230 Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Sat, 25 Nov 2023 19:17:44 +0100 Subject: [PATCH 2/7] mysql docs updates to align with the new service settings page in aiven console --- docs/products/mysql/concepts/mysql-replication.rst | 2 +- docs/products/mysql/get-started.rst | 2 +- .../mysql/howto/create-missing-primary-keys.rst | 2 +- .../howto/create-tables-without-primary-keys.rst | 14 ++++++++------ docs/products/mysql/howto/enable-slow-queries.rst | 12 +++++------- .../howto/migrate-db-to-aiven-via-console.rst | 13 +++++++------ .../howto/migrate-db-to-aiven-via-console.rst | 2 +- 7 files changed, 24 insertions(+), 23 deletions(-) diff --git a/docs/products/mysql/concepts/mysql-replication.rst b/docs/products/mysql/concepts/mysql-replication.rst index 368b189e9a..2b88f2127d 100644 --- a/docs/products/mysql/concepts/mysql-replication.rst +++ b/docs/products/mysql/concepts/mysql-replication.rst @@ -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 ` 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 ` 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). diff --git a/docs/products/mysql/get-started.rst b/docs/products/mysql/get-started.rst index 36823ba617..4021c48f02 100644 --- a/docs/products/mysql/get-started.rst +++ b/docs/products/mysql/get-started.rst @@ -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 `. diff --git a/docs/products/mysql/howto/create-missing-primary-keys.rst b/docs/products/mysql/howto/create-missing-primary-keys.rst index a63d478b7b..c4a2799872 100644 --- a/docs/products/mysql/howto/create-missing-primary-keys.rst +++ b/docs/products/mysql/howto/create-missing-primary-keys.rst @@ -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 `_ > 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 `_ > 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:: diff --git a/docs/products/mysql/howto/create-tables-without-primary-keys.rst b/docs/products/mysql/howto/create-tables-without-primary-keys.rst index 889584e9b7..46622ddf41 100644 --- a/docs/products/mysql/howto/create-tables-without-primary-keys.rst +++ b/docs/products/mysql/howto/create-tables-without-primary-keys.rst @@ -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 `_. -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:: @@ -28,9 +29,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 `_. -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:: diff --git a/docs/products/mysql/howto/enable-slow-queries.rst b/docs/products/mysql/howto/enable-slow-queries.rst index 3c6ac28965..66f2e62ee0 100644 --- a/docs/products/mysql/howto/enable-slow-queries.rst +++ b/docs/products/mysql/howto/enable-slow-queries.rst @@ -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 `_. 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. @@ -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. - - diff --git a/docs/products/mysql/howto/migrate-db-to-aiven-via-console.rst b/docs/products/mysql/howto/migrate-db-to-aiven-via-console.rst index 399a9e785f..d17c388d69 100644 --- a/docs/products/mysql/howto/migrate-db-to-aiven-via-console.rst +++ b/docs/products/mysql/howto/migrate-db-to-aiven-via-console.rst @@ -115,7 +115,7 @@ Pre-configure the source .. code-block:: bash - GRANT ALL ON .* TO ‘username'@‘%'; + GRANT ALL ON DATABASE_NAME.* TO USERNAME_CONNECTING_TO_SOURCE_DB; Reload the grant tables to apply the changes to the permissions. @@ -130,15 +130,16 @@ Pre-configure the source Migrate a database ------------------ -1. Log in to `Aiven Console `_. -2. From the **Services** list, select the service where your target database is located. -3. In the **Overview** page of the selected service, navigate to the **Migrate database** section and select **Set up migration**. -4. Guided by the **MySQL migration configuration guide** wizard, go through all the migration steps. +1. Log in to the `Aiven Console `_. +2. On the **Services** page, select the service where your target database is located. +3. From the sidebar on your service's page, select **Service settings**. +4. On the **Service settings** page, navigate to the **Service management** section, and select **Import database**. +5. Guided by the migration wizard, go through all the migration steps. Step 1 - configure '''''''''''''''''' -Make sure your configuration is in line with **Guidelines for successful database migration** provided in the migration wizard and select **Get started**. +Get familiar **Guidelines for successful database migration** provided in the **MySQL migration configuration guide** window, make sure your configuration is in line with them, and select **Get started**. Step 2 - validation ''''''''''''''''''' diff --git a/docs/products/postgresql/howto/migrate-db-to-aiven-via-console.rst b/docs/products/postgresql/howto/migrate-db-to-aiven-via-console.rst index ec58cd9d6c..5a53490ea8 100644 --- a/docs/products/postgresql/howto/migrate-db-to-aiven-via-console.rst +++ b/docs/products/postgresql/howto/migrate-db-to-aiven-via-console.rst @@ -215,7 +215,7 @@ Migrate a database Step 1: Configure ''''''''''''''''' -Get familiar with the guidelines provided in the **PostgreSQL migration configuration guide** window, and select **Get started**. +Get familiar with the guidelines provided in the **PostgreSQL migration configuration guide** window, make sure your configuration is in line with them, and select **Get started**. Step 2: Validation '''''''''''''''''' From ebd6ef041d3f5250df299d47eddd4022a1986abc Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Sun, 26 Nov 2023 07:35:47 +0100 Subject: [PATCH 3/7] cassandra docs updates to align with the new service settings page in aiven console --- .../manage-cross-cluster-replication.rst | 20 ++++++++++++------- docs/products/cassandra/overview.rst | 2 +- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/products/cassandra/howto/manage-cross-cluster-replication.rst b/docs/products/cassandra/howto/manage-cross-cluster-replication.rst index d76571bbe6..f90efe2db7 100644 --- a/docs/products/cassandra/howto/manage-cross-cluster-replication.rst +++ b/docs/products/cassandra/howto/manage-cross-cluster-replication.rst @@ -32,18 +32,19 @@ Change the service plan .. note:: - It's recommended to use the `Aiven console `_ for changing the plan for a CCR-enabled service. + It's recommended to use `Aiven Console `_ for changing the plan for a CCR-enabled service. 1. Log in to `Aiven Console `_. 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 @@ -62,14 +63,19 @@ Add an extra disk space 1. Log in to `Aiven Console `_. 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: diff --git a/docs/products/cassandra/overview.rst b/docs/products/cassandra/overview.rst index 90b7184d03..fa8b107adb 100644 --- a/docs/products/cassandra/overview.rst +++ b/docs/products/cassandra/overview.rst @@ -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 `. \ No newline at end of file +Take your first steps with Aiven for Apache Cassandra® by following :doc:`Get started with Aiven for Apache Cassandra `. From 2f1793323cade54fedae4ef484d26595c16253a2 Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Sun, 26 Nov 2023 08:18:19 +0100 Subject: [PATCH 4/7] clickhouse docs updates to align with the new service settings page in aiven console --- .../clickhouse/howto/connect-with-clickhouse-cli.rst | 2 +- docs/products/clickhouse/howto/enable-tiered-storage.rst | 2 +- docs/products/clickhouse/howto/secure-service.rst | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/products/clickhouse/howto/connect-with-clickhouse-cli.rst b/docs/products/clickhouse/howto/connect-with-clickhouse-cli.rst index 29486d0a50..d6b1b3a15a 100644 --- a/docs/products/clickhouse/howto/connect-with-clickhouse-cli.rst +++ b/docs/products/clickhouse/howto/connect-with-clickhouse-cli.rst @@ -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 `_. +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 `_. Command template ---------------- diff --git a/docs/products/clickhouse/howto/enable-tiered-storage.rst b/docs/products/clickhouse/howto/enable-tiered-storage.rst index 4440528b62..c4a2488741 100644 --- a/docs/products/clickhouse/howto/enable-tiered-storage.rst +++ b/docs/products/clickhouse/howto/enable-tiered-storage.rst @@ -34,7 +34,7 @@ Prerequisites * You have an Aiven organization and at least one project. * You have a command line tool (:doc:`ClickHouse client `) 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 ---------------------------------- diff --git a/docs/products/clickhouse/howto/secure-service.rst b/docs/products/clickhouse/howto/secure-service.rst index 63232b005e..b1708b289c 100644 --- a/docs/products/clickhouse/howto/secure-service.rst +++ b/docs/products/clickhouse/howto/secure-service.rst @@ -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 `_, 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 `_, 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 From 4a8d64bf1346547f6c8466fd87189ab964f7eb0c Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Mon, 27 Nov 2023 14:11:11 +0100 Subject: [PATCH 5/7] Update EOL article --- docs/platform/reference/eol-for-major-versions.rst | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/platform/reference/eol-for-major-versions.rst b/docs/platform/reference/eol-for-major-versions.rst index 73a364bff2..c02ac833e4 100644 --- a/docs/platform/reference/eol-for-major-versions.rst +++ b/docs/platform/reference/eol-for-major-versions.rst @@ -227,12 +227,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 ` 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. -.. Tip:: - Navigate to the service's ``Overview`` page and scroll down until - you see a ``New database fork`` button. This will allow you to make a - separate new database service that is cloned from the current one's - backups. From 939320e626a86eb87d485689182566f8a4caa927 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy Date: Thu, 30 Nov 2023 23:06:24 +0100 Subject: [PATCH 6/7] Update instructions to reflect Service settings UI --- .../grafana/howto/dashboard-previews.rst | 26 ++++++++----------- .../howto/enabled-consumer-lag-predictor.rst | 10 ++++--- .../kafka-mirrormaker/getting-started.rst | 4 +-- .../kafka/karapace/howto/enable-karapace.rst | 22 +++++++++------- docs/products/m3db/howto/grafana.rst | 4 +-- .../howto/opensearch-log-integration.rst | 22 +++++----------- .../howto/migrate-redis-aiven-via-console.rst | 7 ++--- 7 files changed, 45 insertions(+), 50 deletions(-) diff --git a/docs/products/grafana/howto/dashboard-previews.rst b/docs/products/grafana/howto/dashboard-previews.rst index 3798a8e840..5ffc05aff1 100644 --- a/docs/products/grafana/howto/dashboard-previews.rst +++ b/docs/products/grafana/howto/dashboard-previews.rst @@ -11,21 +11,17 @@ The dashboard previews feature is an opt-in beta feature available in Grafana 9. Enable dashboard previews ------------------------- -Follow these steps to enable dashboard previews for your Aiven for Grafana service: - -1. Log in to the `Aiven Console `_. -2. On the **Services** page, click the Grafana service for which you want to enable dashboard previews. -3. On the **Services overview** page, scroll down to the **Advanced configuration** section. -4. Click the **Change** button. -5. In the **Edit advanced configuration** pop-up screen, turn the toggle on next to ``dashboad_previews_enabled`` to enable the feature. -6. Click the **Save advanced configuration** button. You will notice the status next to ``dashboad_previews_enabled`` change from ``not synced`` to ``synced``. - -.. image:: /images/products/grafana/enable-dashboard-previews.png - :alt: Enable dashboard previews in Advanced configuration - -7. Using the **Service URI**, open the Grafana login page. -8. Enter the username and password, and click **Log in**. -9. Click **Dashboards** on the left side menu, and select the grid layout to view dashboard previews of all the dashboards. Dashboard previews are rendered as thumbnails and can be sorted alphabetically. +To enable dashboard previews for your Aiven for Grafana service, follow these steps: + +1. Log in to `Aiven Console `_, and select the Aiven for Grafana service where you want to enable dashboard previews. +2. Click **Service settings** on the sidebar. +3. Scroll to the **Advanced configuration** section, and select **Configure**. +4. On the **Advanced configuration** screen, click **Add configuration options**. +5. Locate ``dashboard_previews_enabled`` using the search bar and set it to the **Enabled** position. +6. Select **Save configuration**. You will see the status next to ``dashboard_previews_enabled`` change from ``not synced`` to ``synced``. +7. Go to the **Overview** page and use the **Service URI** to open the Grafana login page. +8. Enter your username and password, then click **Log in**. +9. To view dashboard previews, click **Dashboards** in the left menu and choose the grid layout. Previews will appear as thumbnails and can be organized alphabetically. .. image:: /images/products/grafana/dashboard-previews-on-grafana.png :alt: Dashboard previews on Grafana diff --git a/docs/products/kafka/howto/enabled-consumer-lag-predictor.rst b/docs/products/kafka/howto/enabled-consumer-lag-predictor.rst index 1866cc85e8..3627e6333f 100644 --- a/docs/products/kafka/howto/enabled-consumer-lag-predictor.rst +++ b/docs/products/kafka/howto/enabled-consumer-lag-predictor.rst @@ -22,11 +22,13 @@ Enable 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**. +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. @@ -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 ------------------------------------------------ diff --git a/docs/products/kafka/kafka-mirrormaker/getting-started.rst b/docs/products/kafka/kafka-mirrormaker/getting-started.rst index cd3abae0c9..07a8fbfede 100644 --- a/docs/products/kafka/kafka-mirrormaker/getting-started.rst +++ b/docs/products/kafka/kafka-mirrormaker/getting-started.rst @@ -17,9 +17,9 @@ Create a new Aiven for Apache Kafka MirrorMaker 2 dedicated service: 1. Log in to the `Aiven Console `_ 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. diff --git a/docs/products/kafka/karapace/howto/enable-karapace.rst b/docs/products/kafka/karapace/howto/enable-karapace.rst index 3525bece24..2902bc5b78 100644 --- a/docs/products/kafka/karapace/howto/enable-karapace.rst +++ b/docs/products/kafka/karapace/howto/enable-karapace.rst @@ -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 `_, 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 `_, 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 `_ and `GitHub project `_. +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 `_, see `Apache Kafka® with Karapace Schema Registry `_. - +For instructions on setting up Karapace with Aiven for Apache Kafka® using `Aiven Terraform Provider `_, see `Apache Kafka® with Karapace Schema Registry `_. + \ No newline at end of file diff --git a/docs/products/m3db/howto/grafana.rst b/docs/products/m3db/howto/grafana.rst index e5e34badf5..382cff9f3a 100644 --- a/docs/products/m3db/howto/grafana.rst +++ b/docs/products/m3db/howto/grafana.rst @@ -7,9 +7,9 @@ Integrate M3DB and Grafana -------------------------- 1. Log into `Aiven Console `_ 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. diff --git a/docs/products/opensearch/howto/opensearch-log-integration.rst b/docs/products/opensearch/howto/opensearch-log-integration.rst index 239b589e23..8c08138bc3 100644 --- a/docs/products/opensearch/howto/opensearch-log-integration.rst +++ b/docs/products/opensearch/howto/opensearch-log-integration.rst @@ -45,14 +45,10 @@ There are two parameters that you can adjust when integrating logs to your OpenS You can change the configuration of the ``index prefix`` and ``index retention limit`` after the integration is enabled. 1. Log in to the `Aiven Console `_, and select the Aiven for OpenSearch service. - -2. On the service's **Overview** screen, scroll to **Service integrations**, and select **Manage integrations**. - -4. From the list in the **Integrations** screen, find the service to configure. - -5. Select **Edit** from the drop-down menu (ellipsis), and make the necessary changes to the parameters. - -6. Select **Edit** to save your changes. +2. Click **Integrations** on the sidebar. +3. Identify the service you want to configure in the Integrations page. +4. Click **Actions** (**...**) menu, select **Edit** to modify the necessary parameters. +5. After making the changes, click **Edit** again to save them. Disable logs integration @@ -60,12 +56,8 @@ Disable logs integration If you no longer wish to send logs from your service to OpenSearch, follow these steps to disable the integration: -1. On the **Overview** page, scroll down to the **Service integrations**. - -2. Select **Manage integrations**. - -3. From the list in the **Integrations** screen, find the service to disable the integration. - -4. Select **Disconnect** from the drop-down menu (ellipsis). +1. In your Aiven for OpenSearch service, navigate to the **Integrations** screen using the left sidebar and locate the service you want to modify. +2. From the **Actions** (**...**) menu, select **Disconnect** to proceed with disabling the integration. +3. In the confirmation window, click **Disconnect** again to confirm and save the changes. Your log integration for OpenSearch will be disabled. diff --git a/docs/products/redis/howto/migrate-redis-aiven-via-console.rst b/docs/products/redis/howto/migrate-redis-aiven-via-console.rst index 5e295ad9c4..574a38e313 100644 --- a/docs/products/redis/howto/migrate-redis-aiven-via-console.rst +++ b/docs/products/redis/howto/migrate-redis-aiven-via-console.rst @@ -35,9 +35,10 @@ Migrate a Redis®* database Follow these steps to migrate a Redis®* database to Aiven for Redis®* service: 1. Log in to the `Aiven Console `_, and select the target Aiven for Redis®* service to which you want to migrate the Redis®* database. -2. From the **Overview** tab, scroll down to the **Migrate database** section. -3. Select **Set up migration**. -4. You will see a wizard that guides you through the database migration process. +2. Click **Service settings** on the sidebar. +3. Scroll to the **Service management** section, and click **Actions** (**...**) menu. +4. Click **Import database** to initiate the import process. +5. You will see a wizard that guides you through the database migration process. Step 1: Configure ````````````````````` From d7b491e09e17de7ac9c13a95d8b504d872a86eef Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy Date: Thu, 30 Nov 2023 23:20:24 +0100 Subject: [PATCH 7/7] Fixed broken ext link --- docs/products/grafana/howto/dashboard-previews.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/products/grafana/howto/dashboard-previews.rst b/docs/products/grafana/howto/dashboard-previews.rst index 5ffc05aff1..4edef088d3 100644 --- a/docs/products/grafana/howto/dashboard-previews.rst +++ b/docs/products/grafana/howto/dashboard-previews.rst @@ -32,4 +32,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 `_. + For more information on Dashboard previews, see `Grafana documentation `_.