From 0e666c3253ebdf7e4c4f7a087114fba227263581 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Thu, 14 Sep 2023 14:59:10 +0200 Subject: [PATCH 01/55] Add docs for managed users feature --- _toc.yml | 3 +++ docs/platform/howto/managed-users.rst | 10 ++++++++++ .../howto/set-authentication-policies.rst | 16 ++++++++++++++++ 3 files changed, 29 insertions(+) create mode 100644 docs/platform/howto/managed-users.rst create mode 100644 docs/platform/howto/set-authentication-policies.rst diff --git a/_toc.yml b/_toc.yml index c828787b35..95943fce77 100644 --- a/_toc.yml +++ b/_toc.yml @@ -67,7 +67,9 @@ entries: - file: docs/platform/howto/list-user title: User and access management entries: + - file: docs/platform/howto/managed-users - file: docs/platform/howto/manage-org-users + title: Invite and remove organization users - file: docs/platform/howto/list-user-profile entries: - file: docs/platform/howto/edit-user-profile @@ -77,6 +79,7 @@ entries: - file: docs/platform/howto/add-authentication-method - file: docs/platform/reference/password-policy - file: docs/platform/howto/user-2fa + - file: docs/platform/howto/set-authentication-policies - file: docs/platform/concepts/authentication-tokens - file: docs/platform/howto/create_authentication_token - file: docs/platform/howto/list-saml diff --git a/docs/platform/howto/managed-users.rst b/docs/platform/howto/managed-users.rst new file mode 100644 index 0000000000..18bb571ab7 --- /dev/null +++ b/docs/platform/howto/managed-users.rst @@ -0,0 +1,10 @@ +Managed users +============== + +Managed users provides a centralized way of managing all of your organization's users, including editing their profiles, resetting passwords, and :doc:`setting authentication policies `. + +When you :doc:`verify a domain `, your organization users automatically become managed users. These users are managed through your identitiy provider (IdP), meaning they are provisioned through the IdP. + +Managed users are not allowed to edit their user profiles. They cannot create new organizations unless they are the owner of the organization that they are managed by. + +To see a list of all users in your organization go to **Admin** and select **Users**. \ No newline at end of file diff --git a/docs/platform/howto/set-authentication-policies.rst b/docs/platform/howto/set-authentication-policies.rst new file mode 100644 index 0000000000..a3b73ddcec --- /dev/null +++ b/docs/platform/howto/set-authentication-policies.rst @@ -0,0 +1,16 @@ +Set authentication policies for managed users +============================================== + + +Set an authentication policy +------------------------------ + +To set an authentication policy for all users in an organization: + +#. Click **Admin**. + +#. Click **Authentication**. + +#. + + From 3b9c7bb80e1bdf9f5f587f636365ba7b79a61add Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Fri, 15 Sep 2023 15:06:46 +0200 Subject: [PATCH 02/55] Add docs for managed users --- _toc.yml | 3 ++- docs/platform/concepts/managed-users.rst | 10 ++++++++++ docs/platform/howto/managed-users.rst | 10 ---------- .../howto/set-authentication-policies.rst | 15 +++++++++++---- 4 files changed, 23 insertions(+), 15 deletions(-) create mode 100644 docs/platform/concepts/managed-users.rst delete mode 100644 docs/platform/howto/managed-users.rst diff --git a/_toc.yml b/_toc.yml index 95943fce77..366d7c8b49 100644 --- a/_toc.yml +++ b/_toc.yml @@ -67,9 +67,9 @@ entries: - file: docs/platform/howto/list-user title: User and access management entries: - - file: docs/platform/howto/managed-users - file: docs/platform/howto/manage-org-users title: Invite and remove organization users + - file: docs/platform/concepts/managed-users - file: docs/platform/howto/list-user-profile entries: - file: docs/platform/howto/edit-user-profile @@ -80,6 +80,7 @@ entries: - file: docs/platform/reference/password-policy - file: docs/platform/howto/user-2fa - file: docs/platform/howto/set-authentication-policies + title: Set authentication policies - file: docs/platform/concepts/authentication-tokens - file: docs/platform/howto/create_authentication_token - file: docs/platform/howto/list-saml diff --git a/docs/platform/concepts/managed-users.rst b/docs/platform/concepts/managed-users.rst new file mode 100644 index 0000000000..ab8a934055 --- /dev/null +++ b/docs/platform/concepts/managed-users.rst @@ -0,0 +1,10 @@ +Managed users +============== + +The managed users feature provides a centralized way of managing all of your organization's users, including editing their profiles, resetting passwords, and :doc:`setting authentication policies `. + +When you :doc:`verify a domain `, existing organization users automatically become managed users. New users can be provisioned and managed through your identity provider (IdP). + +A managed user cannot create new organizations unless they are a super admin of the organization that they are managed by. They are also not allowed to edit their user profiles. + +To see a list of all users in your organization go to **Admin** and select **Users**. \ No newline at end of file diff --git a/docs/platform/howto/managed-users.rst b/docs/platform/howto/managed-users.rst deleted file mode 100644 index 18bb571ab7..0000000000 --- a/docs/platform/howto/managed-users.rst +++ /dev/null @@ -1,10 +0,0 @@ -Managed users -============== - -Managed users provides a centralized way of managing all of your organization's users, including editing their profiles, resetting passwords, and :doc:`setting authentication policies `. - -When you :doc:`verify a domain `, your organization users automatically become managed users. These users are managed through your identitiy provider (IdP), meaning they are provisioned through the IdP. - -Managed users are not allowed to edit their user profiles. They cannot create new organizations unless they are the owner of the organization that they are managed by. - -To see a list of all users in your organization go to **Admin** and select **Users**. \ No newline at end of file diff --git a/docs/platform/howto/set-authentication-policies.rst b/docs/platform/howto/set-authentication-policies.rst index a3b73ddcec..44706474fd 100644 --- a/docs/platform/howto/set-authentication-policies.rst +++ b/docs/platform/howto/set-authentication-policies.rst @@ -1,16 +1,23 @@ -Set authentication policies for managed users -============================================== +Set authentication policies for organization users +=================================================== +The authentication policy for your organization specifies the ways that users can access your organization on the Aiven platform. + +You can, for example, restrict organization users to using single sign-on through a :doc:`verified domain `. Alternatively, you can allow them to create a password or use third-party authentication providers like Google, Microsoft, and GitHub. For an added layer of security, you can enforce two-factor authentication for password logins. + +:doc:`Managed users ` cannot log in with disabled authentication methods. Users that are not managed can log in with disabled methods, but they won't have access to the organization if they do. Set an authentication policy ------------------------------ To set an authentication policy for all users in an organization: -#. Click **Admin**. +#. In the organization, click **Admin**. #. Click **Authentication**. -#. +#. Click the toggle for each authentication method that you want to allow. + +#. Click **Save changes**. From 36598a2f9561a10e87f3499657cf53e4b132da5d Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Fri, 29 Sep 2023 16:15:01 +0200 Subject: [PATCH 03/55] Remove managed users doc --- _toc.yml | 1 - docs/platform/concepts/managed-users.rst | 10 ---------- docs/platform/howto/set-authentication-policies.rst | 2 +- 3 files changed, 1 insertion(+), 12 deletions(-) delete mode 100644 docs/platform/concepts/managed-users.rst diff --git a/_toc.yml b/_toc.yml index 366d7c8b49..d898f53995 100644 --- a/_toc.yml +++ b/_toc.yml @@ -69,7 +69,6 @@ entries: entries: - file: docs/platform/howto/manage-org-users title: Invite and remove organization users - - file: docs/platform/concepts/managed-users - file: docs/platform/howto/list-user-profile entries: - file: docs/platform/howto/edit-user-profile diff --git a/docs/platform/concepts/managed-users.rst b/docs/platform/concepts/managed-users.rst deleted file mode 100644 index ab8a934055..0000000000 --- a/docs/platform/concepts/managed-users.rst +++ /dev/null @@ -1,10 +0,0 @@ -Managed users -============== - -The managed users feature provides a centralized way of managing all of your organization's users, including editing their profiles, resetting passwords, and :doc:`setting authentication policies `. - -When you :doc:`verify a domain `, existing organization users automatically become managed users. New users can be provisioned and managed through your identity provider (IdP). - -A managed user cannot create new organizations unless they are a super admin of the organization that they are managed by. They are also not allowed to edit their user profiles. - -To see a list of all users in your organization go to **Admin** and select **Users**. \ No newline at end of file diff --git a/docs/platform/howto/set-authentication-policies.rst b/docs/platform/howto/set-authentication-policies.rst index 44706474fd..8619d76d70 100644 --- a/docs/platform/howto/set-authentication-policies.rst +++ b/docs/platform/howto/set-authentication-policies.rst @@ -16,7 +16,7 @@ To set an authentication policy for all users in an organization: #. Click **Authentication**. -#. Click the toggle for each authentication method that you want to allow. +#. Click the toggle for each authentication method that you want to allow. #. Click **Save changes**. From 691302b29a7052a2564cbaaf1d52bdd403aead42 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Fri, 29 Sep 2023 17:34:13 +0200 Subject: [PATCH 04/55] Add info on auth types --- docs/platform/howto/set-authentication-policies.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/platform/howto/set-authentication-policies.rst b/docs/platform/howto/set-authentication-policies.rst index 8619d76d70..a61f8fee9f 100644 --- a/docs/platform/howto/set-authentication-policies.rst +++ b/docs/platform/howto/set-authentication-policies.rst @@ -18,6 +18,10 @@ To set an authentication policy for all users in an organization: #. Click the toggle for each authentication method that you want to allow. +* Passoword authentication: users log in using their email address and password +* Third-party authentication: users can log in using one of the supported providers (Google, Mircosoft, or GitHub) +* Organization SSO: users from a :doc:`verified domain ` can log in using an identity provider + #. Click **Save changes**. From a0468e50f16914200085def98384a1dd2b977014 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Fri, 27 Oct 2023 15:14:41 +0200 Subject: [PATCH 05/55] Fix typos --- docs/platform/howto/set-authentication-policies.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/platform/howto/set-authentication-policies.rst b/docs/platform/howto/set-authentication-policies.rst index a61f8fee9f..679e3000a9 100644 --- a/docs/platform/howto/set-authentication-policies.rst +++ b/docs/platform/howto/set-authentication-policies.rst @@ -18,8 +18,8 @@ To set an authentication policy for all users in an organization: #. Click the toggle for each authentication method that you want to allow. -* Passoword authentication: users log in using their email address and password -* Third-party authentication: users can log in using one of the supported providers (Google, Mircosoft, or GitHub) +* Password authentication: users log in using their email address and password +* Third-party authentication: users can log in using one of the supported providers (Google, Microsoft, or GitHub) * Organization SSO: users from a :doc:`verified domain ` can log in using an identity provider #. Click **Save changes**. From e559f76a42a380a0979cd2db066588890fd09734 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Tue, 14 Nov 2023 16:53:44 +0100 Subject: [PATCH 06/55] Add descriptions of auth types --- .../howto/set-authentication-policies.rst | 22 ++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/platform/howto/set-authentication-policies.rst b/docs/platform/howto/set-authentication-policies.rst index 679e3000a9..eecb54e3ed 100644 --- a/docs/platform/howto/set-authentication-policies.rst +++ b/docs/platform/howto/set-authentication-policies.rst @@ -1,11 +1,27 @@ Set authentication policies for organization users =================================================== -The authentication policy for your organization specifies the ways that users can access your organization on the Aiven platform. +The authentication policy for your organization specifies the ways that users can access your organization on the Aiven platform: with a password, third-party authentication, or organization single sign-on (SSO). :doc:`Managed users ` cannot log in with disabled authentication methods. Users that are not managed can log in with disabled methods, but they won't have access to the organization if they do. -You can, for example, restrict organization users to using single sign-on through a :doc:`verified domain `. Alternatively, you can allow them to create a password or use third-party authentication providers like Google, Microsoft, and GitHub. For an added layer of security, you can enforce two-factor authentication for password logins. +Authentication types +--------------------- -:doc:`Managed users ` cannot log in with disabled authentication methods. Users that are not managed can log in with disabled methods, but they won't have access to the organization if they do. +Passwords and two-factor authentication +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +With password authentication enabled, users log in with their email address and password. For an added layer of security, you can enforce two-factor authentication (2FA) for password logins for all users in your organization. + +When two-factor authentication is required, users will be prompted to set up 2FA using an authenticator app. They won't be able to access any resources in your organization until they do this. + +Third-party authentication +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +With third-party authentication enabled, users can choose to log in using Google, Microsoft, or GitHub. + +Organization SSO +~~~~~~~~~~~~~~~~~ + +You can restrict your organization users to using SSO through a :doc:`verified domain `. Set an authentication policy ------------------------------ From 158ef185f94c7ce35cde861211718451d8dea926 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Thu, 16 Nov 2023 13:50:17 +0100 Subject: [PATCH 07/55] 2FA description --- docs/platform/howto/set-authentication-policies.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platform/howto/set-authentication-policies.rst b/docs/platform/howto/set-authentication-policies.rst index eecb54e3ed..971fb58f9c 100644 --- a/docs/platform/howto/set-authentication-policies.rst +++ b/docs/platform/howto/set-authentication-policies.rst @@ -11,7 +11,7 @@ Passwords and two-factor authentication With password authentication enabled, users log in with their email address and password. For an added layer of security, you can enforce two-factor authentication (2FA) for password logins for all users in your organization. -When two-factor authentication is required, users will be prompted to set up 2FA using an authenticator app. They won't be able to access any resources in your organization until they do this. +When two-factor authentication is required, users won't be able to access any resources in your organization until they set up 2FA. Third-party authentication ~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 4f7f34902fd21b3f9559d0547857b8f61c24a008 Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 28 Nov 2023 06:02:22 +0000 Subject: [PATCH 08/55] OpenSearch - Update Advanced parameters --- includes/config-opensearch.rst | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/includes/config-opensearch.rst b/includes/config-opensearch.rst index 663f0717ab..e3c9584426 100644 --- a/includes/config-opensearch.rst +++ b/includes/config-opensearch.rst @@ -1,4 +1,9 @@ +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** @@ -114,13 +119,13 @@ ~~~~~~~~~~~~~ *['string', 'null']* -**The key in the JSON payload that stores the user's roles** The key in the JSON payload that stores the user's roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT +**The key in the JSON payload that stores the user’s roles** The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT ``subject_key`` ~~~~~~~~~~~~~~~ *['string', 'null']* -**The key in the JSON payload that stores the user's name** The key in the JSON payload that stores the user's name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. +**The key in the JSON payload that stores the user’s name** The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. ``jwt_header`` ~~~~~~~~~~~~~~ @@ -416,19 +421,19 @@ ``email_sender_name`` ~~~~~~~~~~~~~~~~~~~~~ -*['string']* +*string* **Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore** This should be identical to the Sender name defined in Opensearch dashboards ``email_sender_username`` ~~~~~~~~~~~~~~~~~~~~~~~~~ -*['string']* +*string* **Sender username for Opensearch alerts** ``email_sender_password`` ~~~~~~~~~~~~~~~~~~~~~~~~~ -*['string']* +*string* **Sender password for Opensearch alerts to authenticate with SMTP server** Sender password for Opensearch alerts to authenticate with SMTP server From 27a45d2b25260956b74d99f508babc54ec952686 Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 28 Nov 2023 06:06:22 +0000 Subject: [PATCH 09/55] KafkaConnector - Update Advanced parameters --- includes/config-kafka_connect.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/includes/config-kafka_connect.rst b/includes/config-kafka_connect.rst index 150889af93..b185a3f359 100644 --- a/includes/config-kafka_connect.rst +++ b/includes/config-kafka_connect.rst @@ -1,4 +1,10 @@ +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** + ``ip_filter`` @@ -117,7 +123,7 @@ ~~~~~~~~~~~~~~~~~~~~~~ *integer* -**The timeout used to detect failures when using Kafka's group management facilities** The timeout in milliseconds used to detect failures when using Kafka's group management facilities (defaults to 10000). +**The timeout used to detect failures when using Kafka’s group management facilities** The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000). From 1d20408a5f3a3dd48fa433f21c3926dadddfb9ae Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 28 Nov 2023 06:07:07 +0000 Subject: [PATCH 10/55] Kafka - Update Advanced parameters --- includes/config-kafka.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/includes/config-kafka.rst b/includes/config-kafka.rst index 3e318fdc8b..6809498e8f 100644 --- a/includes/config-kafka.rst +++ b/includes/config-kafka.rst @@ -1,4 +1,11 @@ +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** + + ``custom_domain`` ----------------- @@ -420,6 +427,12 @@ **transaction.remove.expired.transaction.cleanup.interval.ms** The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (defaults to 3600000 (1 hour)). +``transaction_partition_verification_enable`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +*boolean* + +**transaction.partition.verification.enable** Enable verification that checks that the partition has been added to the transaction before writing transactional records to the partition + ``kafka_authentication_methods`` @@ -550,7 +563,7 @@ ~~~~~~~~~~~~~~~~~~~~~~ *integer* -**The timeout used to detect failures when using Kafka's group management facilities** The timeout in milliseconds used to detect failures when using Kafka's group management facilities (defaults to 10000). +**The timeout used to detect failures when using Kafka’s group management facilities** The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000). From e4d50fc8c8f46268db770f1f65a5f3deef9a4f05 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Wed, 29 Nov 2023 11:00:09 +0100 Subject: [PATCH 11/55] Fix TOC --- _toc.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/_toc.yml b/_toc.yml index d898f53995..732a85d757 100644 --- a/_toc.yml +++ b/_toc.yml @@ -67,8 +67,6 @@ entries: - file: docs/platform/howto/list-user title: User and access management entries: - - file: docs/platform/howto/manage-org-users - title: Invite and remove organization users - file: docs/platform/howto/list-user-profile entries: - file: docs/platform/howto/edit-user-profile From b7ca055c057dea7ba01c3b727da53c454fb11e0d Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Wed, 29 Nov 2023 11:13:09 +0100 Subject: [PATCH 12/55] Update UI terms for SAML articles --- docs/platform/howto/saml/saml-authentication.rst | 4 ++-- docs/platform/howto/saml/setup-saml-auth0.rst | 4 ++-- docs/platform/howto/saml/setup-saml-azure.rst | 4 ++-- docs/platform/howto/saml/setup-saml-fusionauth.rst | 4 ++-- docs/platform/howto/saml/setup-saml-google.rst | 4 ++-- docs/platform/howto/saml/setup-saml-jumpcloud.rst | 4 ++-- docs/platform/howto/saml/setup-saml-okta.rst | 4 ++-- docs/platform/howto/saml/setup-saml-onelogin.rst | 4 ++-- docs/platform/howto/set-authentication-policies.rst | 2 +- 9 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/platform/howto/saml/saml-authentication.rst b/docs/platform/howto/saml/saml-authentication.rst index 2a8a688502..f1e7bd79ae 100644 --- a/docs/platform/howto/saml/saml-authentication.rst +++ b/docs/platform/howto/saml/saml-authentication.rst @@ -28,9 +28,9 @@ SAML Authentication methods are configured at the organization level: #. In the organization, click **Admin**. -#. Select **Authentication**. +#. Select **Identity providers**. -#. Click on **Add authentication method**. +#. Click **Add identity provider**. #. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method. diff --git a/docs/platform/howto/saml/setup-saml-auth0.rst b/docs/platform/howto/saml/setup-saml-auth0.rst index 12ed3f92eb..b48e164bc6 100644 --- a/docs/platform/howto/saml/setup-saml-auth0.rst +++ b/docs/platform/howto/saml/setup-saml-auth0.rst @@ -8,9 +8,9 @@ Prerequisite steps in Aiven Console #. In the organization, click **Admin**. -#. Select **Authentication**. +#. Select **Identity providers**. -#. Click **Add authentication method**. +#. Click **Add identity provider**. #. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method. diff --git a/docs/platform/howto/saml/setup-saml-azure.rst b/docs/platform/howto/saml/setup-saml-azure.rst index b5912d80dd..4f5ae9abf2 100644 --- a/docs/platform/howto/saml/setup-saml-azure.rst +++ b/docs/platform/howto/saml/setup-saml-azure.rst @@ -9,9 +9,9 @@ Prerequisite steps in Aiven Console #. In the organization, click **Admin**. -#. Select **Authentication**. +#. Select **Identity providers**. -#. Click **Add authentication method**. +#. Click **Add identity provider**. #. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method. diff --git a/docs/platform/howto/saml/setup-saml-fusionauth.rst b/docs/platform/howto/saml/setup-saml-fusionauth.rst index 8b6d9bf5a7..e6af259a25 100644 --- a/docs/platform/howto/saml/setup-saml-fusionauth.rst +++ b/docs/platform/howto/saml/setup-saml-fusionauth.rst @@ -8,9 +8,9 @@ Prerequisite steps in Aiven Console #. In the organization, click **Admin**. -#. Select **Authentication**. +#. Select **Identity providers**. -#. Click **Add authentication method**. +#. Click **Add identity provider**. #. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method. diff --git a/docs/platform/howto/saml/setup-saml-google.rst b/docs/platform/howto/saml/setup-saml-google.rst index e3b0183cbf..34a6887df5 100644 --- a/docs/platform/howto/saml/setup-saml-google.rst +++ b/docs/platform/howto/saml/setup-saml-google.rst @@ -8,9 +8,9 @@ Prerequisite steps in Aiven Console #. In the organization, click **Admin**. -#. Select **Authentication**. +#. Select **Identity providers**. -#. Click **Add authentication method**. +#. Click **Add identity provider**. #. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method. diff --git a/docs/platform/howto/saml/setup-saml-jumpcloud.rst b/docs/platform/howto/saml/setup-saml-jumpcloud.rst index ce268d1941..0d5649be64 100644 --- a/docs/platform/howto/saml/setup-saml-jumpcloud.rst +++ b/docs/platform/howto/saml/setup-saml-jumpcloud.rst @@ -8,9 +8,9 @@ Prerequisite steps in Aiven Console #. In the organization, click **Admin**. -#. Select **Authentication**. +#. Select **Identity providers**. -#. Click **Add authentication method**. +#. Click **Add identity provider**. #. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method. diff --git a/docs/platform/howto/saml/setup-saml-okta.rst b/docs/platform/howto/saml/setup-saml-okta.rst index 55aa928f01..99e8977723 100644 --- a/docs/platform/howto/saml/setup-saml-okta.rst +++ b/docs/platform/howto/saml/setup-saml-okta.rst @@ -8,9 +8,9 @@ Prerequisite steps in Aiven Console #. In the organization, click **Admin**. -#. Select **Authentication**. +#. Select **Identity providers**. -#. Click **Add authentication method**. +#. Click **Add identity provider**. #. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method. diff --git a/docs/platform/howto/saml/setup-saml-onelogin.rst b/docs/platform/howto/saml/setup-saml-onelogin.rst index 0148834577..97c7806cf9 100644 --- a/docs/platform/howto/saml/setup-saml-onelogin.rst +++ b/docs/platform/howto/saml/setup-saml-onelogin.rst @@ -8,9 +8,9 @@ Prerequisite steps in Aiven Console #. In the organization, click **Admin**. -#. Select **Authentication**. +#. Select **Identity providers**. -#. Click **Add authentication method**. +#. Click **Add identity provider**. #. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method. diff --git a/docs/platform/howto/set-authentication-policies.rst b/docs/platform/howto/set-authentication-policies.rst index 971fb58f9c..c463aeb69f 100644 --- a/docs/platform/howto/set-authentication-policies.rst +++ b/docs/platform/howto/set-authentication-policies.rst @@ -21,7 +21,7 @@ With third-party authentication enabled, users can choose to log in using Google Organization SSO ~~~~~~~~~~~~~~~~~ -You can restrict your organization users to using SSO through a :doc:`verified domain `. +You can restrict your organization users to log in using SSO through an :doc:`identity provider `. Set an authentication policy ------------------------------ From ecd7ded6fff2997e1a2b5a534a79b997adf0e38a Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Wed, 29 Nov 2023 11:18:35 +0100 Subject: [PATCH 13/55] Update org SSO section --- docs/platform/howto/set-authentication-policies.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/platform/howto/set-authentication-policies.rst b/docs/platform/howto/set-authentication-policies.rst index c463aeb69f..9673b58564 100644 --- a/docs/platform/howto/set-authentication-policies.rst +++ b/docs/platform/howto/set-authentication-policies.rst @@ -16,12 +16,12 @@ When two-factor authentication is required, users won't be able to access any re Third-party authentication ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -With third-party authentication enabled, users can choose to log in using Google, Microsoft, or GitHub. +Users can choose to log in using Google, Microsoft, or GitHub. -Organization SSO -~~~~~~~~~~~~~~~~~ +Organization identity providers (SSO) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You can restrict your organization users to log in using SSO through an :doc:`identity provider `. +Organization users are restricted to logging in using SSO through an :doc:`identity provider `. Set an authentication policy ------------------------------ From 55f3a19fa478cf95b9d8e15c09d39e9342b0c275 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Wed, 29 Nov 2023 11:26:01 +0100 Subject: [PATCH 14/55] Fix TOC --- _toc.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_toc.yml b/_toc.yml index 732a85d757..d898f53995 100644 --- a/_toc.yml +++ b/_toc.yml @@ -67,6 +67,8 @@ entries: - file: docs/platform/howto/list-user title: User and access management entries: + - file: docs/platform/howto/manage-org-users + title: Invite and remove organization users - file: docs/platform/howto/list-user-profile entries: - file: docs/platform/howto/edit-user-profile From c1b7cba0bb9ff5d446786ee546932c3aa5f2704b Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Wed, 29 Nov 2023 11:52:57 +0100 Subject: [PATCH 15/55] Remove managed users reference --- docs/platform/howto/set-authentication-policies.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platform/howto/set-authentication-policies.rst b/docs/platform/howto/set-authentication-policies.rst index 9673b58564..2c1013d70b 100644 --- a/docs/platform/howto/set-authentication-policies.rst +++ b/docs/platform/howto/set-authentication-policies.rst @@ -1,7 +1,7 @@ Set authentication policies for organization users =================================================== -The authentication policy for your organization specifies the ways that users can access your organization on the Aiven platform: with a password, third-party authentication, or organization single sign-on (SSO). :doc:`Managed users ` cannot log in with disabled authentication methods. Users that are not managed can log in with disabled methods, but they won't have access to the organization if they do. +The authentication policy for your organization specifies the ways that users can access your organization on the Aiven platform: with a password, third-party authentication, or organization single sign-on (SSO). Authentication types --------------------- From 9dc5c11b3ec9c3cf2259de5b5b1eab0ac58658fc Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Wed, 29 Nov 2023 12:25:35 +0100 Subject: [PATCH 16/55] Fix link --- docs/platform/howto/set-authentication-policies.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platform/howto/set-authentication-policies.rst b/docs/platform/howto/set-authentication-policies.rst index 2c1013d70b..563d1b4d0c 100644 --- a/docs/platform/howto/set-authentication-policies.rst +++ b/docs/platform/howto/set-authentication-policies.rst @@ -21,7 +21,7 @@ Users can choose to log in using Google, Microsoft, or GitHub. Organization identity providers (SSO) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Organization users are restricted to logging in using SSO through an :doc:`identity provider `. +Organization users are restricted to logging in using SSO through an :doc:`identity provider `. Set an authentication policy ------------------------------ From 8871a3faecfa709c0e4ba7a71affa2c4a17b529f Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Wed, 29 Nov 2023 13:49:13 +0100 Subject: [PATCH 17/55] Remve duplicate info --- docs/platform/howto/set-authentication-policies.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/platform/howto/set-authentication-policies.rst b/docs/platform/howto/set-authentication-policies.rst index 563d1b4d0c..890705ccb8 100644 --- a/docs/platform/howto/set-authentication-policies.rst +++ b/docs/platform/howto/set-authentication-policies.rst @@ -34,10 +34,6 @@ To set an authentication policy for all users in an organization: #. Click the toggle for each authentication method that you want to allow. -* Password authentication: users log in using their email address and password -* Third-party authentication: users can log in using one of the supported providers (Google, Microsoft, or GitHub) -* Organization SSO: users from a :doc:`verified domain ` can log in using an identity provider - #. Click **Save changes**. From 532eaca761c109fa44b6f85e056c9e08b4b1b743 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Fri, 1 Dec 2023 15:57:27 +0100 Subject: [PATCH 18/55] Update config-kafka.rst --- includes/config-kafka.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/includes/config-kafka.rst b/includes/config-kafka.rst index 6809498e8f..db5f2eac56 100644 --- a/includes/config-kafka.rst +++ b/includes/config-kafka.rst @@ -1,9 +1,4 @@ -``additional_backup_regions`` ------------------------------ -*array* - -**Additional Cloud Regions for Backup Replication** From b44466510ecb38227d3c6953551cde70e7683ad7 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Fri, 1 Dec 2023 15:59:25 +0100 Subject: [PATCH 19/55] Update config-kafka_connect.rst --- includes/config-kafka_connect.rst | 7 ------- 1 file changed, 7 deletions(-) diff --git a/includes/config-kafka_connect.rst b/includes/config-kafka_connect.rst index b185a3f359..b7d297b16a 100644 --- a/includes/config-kafka_connect.rst +++ b/includes/config-kafka_connect.rst @@ -1,11 +1,4 @@ -``additional_backup_regions`` ------------------------------ -*array* - -**Additional Cloud Regions for Backup Replication** - - ``ip_filter`` ------------- From 9d437e756e55eeda637ab8c95207f79a49788f53 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Fri, 1 Dec 2023 16:00:58 +0100 Subject: [PATCH 20/55] Update config-opensearch.rst --- includes/config-opensearch.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/includes/config-opensearch.rst b/includes/config-opensearch.rst index e3c9584426..636f2c9a4a 100644 --- a/includes/config-opensearch.rst +++ b/includes/config-opensearch.rst @@ -1,9 +1,4 @@ -``additional_backup_regions`` ------------------------------ -*array* - -**Additional Cloud Regions for Backup Replication** From cade709d8965834deb6ba9e3454ea0df10b7b20a Mon Sep 17 00:00:00 2001 From: Roman Inflianskas Date: Fri, 1 Dec 2023 17:26:49 +0200 Subject: [PATCH 21/55] scripts, cloud list: add more information to description column in cloud list --- includes/clouds-list.rst | 246 +++++++++++++++++++-------------------- requirements.txt | 3 +- scripts/aiven/clouds.py | 94 +++++++++------ 3 files changed, 181 insertions(+), 162 deletions(-) diff --git a/includes/clouds-list.rst b/includes/clouds-list.rst index 06f25dbafe..a0a9a193c1 100644 --- a/includes/clouds-list.rst +++ b/includes/clouds-list.rst @@ -10,85 +10,85 @@ Amazon Web Services - Description * - Africa - ``aws-af-south-1`` - - Africa, South Africa + - Africa, South Africa: Cape Town * - Asia-Pacific - ``aws-ap-east-1`` - - Asia, Hong Kong + - Asia, Hong Kong: Hong Kong * - Asia-Pacific - ``aws-ap-northeast-1`` - - Asia, Japan + - Asia, Japan: Tokyo * - Asia-Pacific - ``aws-ap-northeast-2`` - - Asia, Korea + - Asia, Korea: Seoul * - Asia-Pacific - ``aws-ap-northeast-3`` - - Asia, Japan + - Asia, Japan: Osaka * - Asia-Pacific - ``aws-ap-south-1`` - - Asia, India + - Asia, India: Mumbai * - Asia-Pacific - ``aws-ap-south-2`` - - Asia, India + - Asia, India: Hyderabad * - Asia-Pacific - ``aws-ap-southeast-1`` - - Asia, Singapore + - Asia, Singapore: Singapore * - Asia-Pacific - ``aws-ap-southeast-3`` - - Asia, Jakarta + - Asia, Jakarta: Jakarta * - Australia - ``aws-ap-southeast-2`` - - Australia, New South Wales + - Australia, New South Wales: Sydney * - Australia - ``aws-ap-southeast-4`` - - Australia, Melbourne + - Australia, Melbourne: Melbourne * - Europe - ``aws-eu-central-1`` - - Europe, Germany + - Europe, Germany: Frankfurt * - Europe - ``aws-eu-central-2`` - - Europe, Switzerland + - Europe, Switzerland: Zurich * - Europe - ``aws-eu-north-1`` - - Europe, Sweden + - Europe, Sweden: Stockholm * - Europe - ``aws-eu-south-1`` - - Europe, Italy + - Europe, Italy: Milan * - Europe - ``aws-eu-south-2`` - - Europe, Spain + - Europe, Spain: Madrid * - Europe - ``aws-eu-west-1`` - - Europe, Ireland + - Europe, Ireland: Ireland * - Europe - ``aws-eu-west-2`` - - Europe, England + - Europe, England: London * - Europe - ``aws-eu-west-3`` - - Europe, France + - Europe, France: Paris * - Middle East - ``aws-me-central-1`` - - Middle East, UAE + - Middle East, UAE: UAE * - Middle East - ``aws-me-south-1`` - - Middle East, Bahrain + - Middle East, Bahrain: Bahrain * - North America - ``aws-ca-central-1`` - - Canada, Quebec + - Canada, Quebec: Canada Central * - North America - ``aws-us-east-1`` - - United States, Virginia + - United States, Virginia: N. Virginia * - North America - ``aws-us-east-2`` - - United States, Ohio + - United States, Ohio: Ohio * - North America - ``aws-us-west-1`` - - United States, California + - United States, California: N. California * - North America - ``aws-us-west-2`` - - United States, Oregon + - United States, Oregon: Oregon * - South America - ``aws-sa-east-1`` - - South America, Brazil + - South America, Brazil: São Paulo Azure ----------------------------------------------------- @@ -100,118 +100,118 @@ Azure - Description * - Africa - ``azure-south-africa-north`` - - Africa, South Africa + - Africa, South Africa: South Africa North * - Asia-Pacific - ``azure-eastasia`` - - Asia, Hong Kong + - Asia, Hong Kong: East Asia * - Asia-Pacific - ``azure-india-central`` - - Asia, India + - Asia, India: Central India * - Asia-Pacific - ``azure-india-south`` - - Asia, India + - Asia, India: South India * - Asia-Pacific - ``azure-india-west`` - - Asia, India + - Asia, India: West India * - Asia-Pacific - ``azure-japaneast`` - - Asia, Japan + - Asia, Japan: Japan East * - Asia-Pacific - ``azure-japanwest`` - - Asia, Japan + - Asia, Japan: Japan West * - Asia-Pacific - ``azure-korea-central`` - - Asia, Korea + - Asia, Korea: Korea Central * - Asia-Pacific - ``azure-korea-south`` - - Asia, Korea + - Asia, Korea: Korea South * - Asia-Pacific - ``azure-southeastasia`` - - Asia, Singapore + - Asia, Singapore: Southeast Asia * - Australia - ``azure-australia-central`` - - Australia, Canberra + - Australia, Canberra: Australia Central * - Australia - ``azure-australiaeast`` - - Australia, New South Wales + - Australia, New South Wales: Australia East * - Australia - ``azure-australiasoutheast`` - - Australia, Victoria + - Australia, Victoria: Australia Southeast * - Europe - ``azure-france-central`` - - Europe, France + - Europe, France: France Central * - Europe - ``azure-germany-north`` - - Europe, Germany + - Europe, Germany: Germany North * - Europe - ``azure-germany-westcentral`` - - Europe, Germany + - Europe, Germany: Germany West Central * - Europe - ``azure-northeurope`` - - Europe, Ireland + - Europe, Ireland: North Europe * - Europe - ``azure-norway-east`` - - Europe, Norway + - Europe, Norway: Norway East * - Europe - ``azure-norway-west`` - - Europe, Norway + - Europe, Norway: Norway West * - Europe - ``azure-sweden-central`` - - Europe, Gävle + - Europe, Gävle: Sweden Central * - Europe - ``azure-switzerland-north`` - - Europe, Switzerland + - Europe, Switzerland: Switzerland North * - Europe - ``azure-uksouth`` - - Europe, England + - Europe, England: UK South * - Europe - ``azure-ukwest`` - - Europe, Wales + - Europe, Wales: UK West * - Europe - ``azure-westeurope`` - - Europe, Netherlands + - Europe, Netherlands: West Europe * - Middle East - ``azure-qatar-central`` - - Middle East, Doha + - Middle East, Doha: Qatar Central * - Middle East - ``azure-uae-north`` - - Middle East, United Arab Emirates + - Middle East, United Arab Emirates: Middle East * - North America - ``azure-canadacentral`` - - Canada, Ontario + - Canada, Ontario: Canada Central * - North America - ``azure-canadaeast`` - - Canada, Quebec + - Canada, Quebec: Canada East * - North America - ``azure-centralus`` - - United States, Iowa + - United States, Iowa: Central US * - North America - ``azure-eastus`` - - United States, Virginia + - United States, Virginia: East US * - North America - ``azure-eastus2`` - - United States, Virginia + - United States, Virginia: East US 2 * - North America - ``azure-northcentralus`` - - United States, Illinois + - United States, Illinois: North Central US * - North America - ``azure-southcentralus`` - - United States, Texas + - United States, Texas: South Central US * - North America - ``azure-westcentralus`` - - United States, Wyoming + - United States, Wyoming: West Central US * - North America - ``azure-westus`` - - United States, California + - United States, California: West US * - North America - ``azure-westus2`` - - United States, Washington + - United States, Washington: West US 2 * - North America - ``azure-westus3`` - - United States, Phoenix + - United States, Phoenix: West US 3 * - South America - ``azure-brazilsouth`` - - South America, Brazil + - South America, Brazil: Brazil South DigitalOcean ----------------------------------------------------- @@ -223,31 +223,31 @@ DigitalOcean - Description * - Asia-Pacific - ``do-blr`` - - Asia, India + - Asia, India: Bangalore * - Asia-Pacific - ``do-sgp`` - - Asia, Singapore + - Asia, Singapore: Singapore * - Australia - ``do-syd`` - - Australia, New South Wales + - Australia, New South Wales: Sydney * - Europe - ``do-ams`` - - Europe, Netherlands + - Europe, Netherlands: Amsterdam * - Europe - ``do-fra`` - - Europe, Germany + - Europe, Germany: Frankfurt * - Europe - ``do-lon`` - - Europe, England + - Europe, England: London * - North America - ``do-nyc`` - - United States, New York + - United States, New York: New York * - North America - ``do-sfo`` - - United States, California + - United States, California: San Francisco * - North America - ``do-tor`` - - Canada, Ontario + - Canada, Ontario: Toronto Google Cloud ----------------------------------------------------- @@ -259,112 +259,112 @@ Google Cloud - Description * - Asia-Pacific - ``google-asia-east1`` - - Asia, Taiwan + - Asia, Taiwan: Taiwan * - Asia-Pacific - ``google-asia-east2`` - - Asia, Hong Kong + - Asia, Hong Kong: Hong Kong * - Asia-Pacific - ``google-asia-northeast1`` - - Asia, Japan + - Asia, Japan: Tokyo * - Asia-Pacific - ``google-asia-northeast2`` - - Asia, Japan + - Asia, Japan: Osaka * - Asia-Pacific - ``google-asia-northeast3`` - - Asia, Korea + - Asia, Korea: Seoul * - Asia-Pacific - ``google-asia-south1`` - - Asia, India + - Asia, India: Mumbai * - Asia-Pacific - ``google-asia-south2`` - - Asia, India + - Asia, India: Delhi * - Asia-Pacific - ``google-asia-southeast1`` - - Asia, Singapore + - Asia, Singapore: Singapore * - Asia-Pacific - ``google-asia-southeast2`` - - Asia, Indonesia + - Asia, Indonesia: Jakarta * - Australia - ``google-australia-southeast1`` - - Australia, New South Wales + - Australia, New South Wales: Sydney * - Australia - ``google-australia-southeast2`` - - Australia, Victoria + - Australia, Victoria: Melbourne * - Europe - ``google-europe-central2`` - - Europe, Poland + - Europe, Poland: Warsaw * - Europe - ``google-europe-north1`` - - Europe, Finland + - Europe, Finland: Finland * - Europe - ``google-europe-southwest1`` - - Europe, Madrid + - Europe, Madrid: Spain * - Europe - ``google-europe-west1`` - - Europe, Belgium + - Europe, Belgium: Belgium * - Europe - ``google-europe-west2`` - - Europe, England + - Europe, England: London * - Europe - ``google-europe-west3`` - - Europe, Germany + - Europe, Germany: Frankfurt * - Europe - ``google-europe-west4`` - - Europe, Netherlands + - Europe, Netherlands: Netherlands * - Europe - ``google-europe-west6`` - - Europe, Switzerland + - Europe, Switzerland: Zürich * - Europe - ``google-europe-west8`` - - Europe, Italy, Milan + - Europe, Italy: Milan * - Europe - ``google-europe-west9`` - - Europe, France + - Europe, France: Paris * - Europe - ``google-europe-west12`` - - Europe, Italy, Turin + - Europe, Italy: Turin * - Middle East - ``google-me-west1`` - - Middle East, Israel + - Middle East, Israel: Tel Aviv * - North America - ``google-northamerica-northeast1`` - - Canada, Quebec + - Canada, Quebec: Montréal * - North America - ``google-northamerica-northeast2`` - - Canada, Ontario + - Canada, Ontario: Toronto * - North America - ``google-us-central1`` - - United States, Iowa + - United States, Iowa: Iowa * - North America - ``google-us-east1`` - - United States, South Carolina + - United States, South Carolina: South Carolina * - North America - ``google-us-east4`` - - United States, Virginia + - United States, Virginia: Northern Virginia * - North America - ``google-us-east5`` - - United States, Ohio + - United States, Ohio: Columbus * - North America - ``google-us-south1`` - - United States, Texas + - United States, Texas: Dallas * - North America - ``google-us-west1`` - - United States, Oregon + - United States, Oregon: Oregon * - North America - ``google-us-west2`` - - United States, California + - United States, California: Los Angeles * - North America - ``google-us-west3`` - - United States, Utah + - United States, Utah: Salt Lake City * - North America - ``google-us-west4`` - - United States, Nevada + - United States, Nevada: Las Vegas * - South America - ``google-southamerica-east1`` - - South America, Brazil + - South America, Brazil: Sao Paulo * - South America - ``google-southamerica-west1`` - - South America, Chile + - South America, Chile: Santiago UpCloud ----------------------------------------------------- @@ -376,40 +376,40 @@ UpCloud - Description * - Asia-Pacific - ``upcloud-sg-sin`` - - Asia, Singapore + - Asia, Singapore: Singapore * - Australia - ``upcloud-au-syd`` - - Australia, New South Wales + - Australia, New South Wales: Sydney * - Europe - ``upcloud-de-fra`` - - Europe, Germany + - Europe, Germany: Frankfurt * - Europe - ``upcloud-es-mad`` - - Europe, Spain + - Europe, Spain: Madrid * - Europe - ``upcloud-fi-hel`` - - Europe, Finland + - Europe, Finland: Helsinki * - Europe - ``upcloud-fi-hel1`` - - Europe, Finland + - Europe, Finland: Helsinki * - Europe - ``upcloud-fi-hel2`` - - Europe, Finland + - Europe, Finland: Helsinki * - Europe - ``upcloud-nl-ams`` - - Europe, Netherlands + - Europe, Netherlands: Amsterdam * - Europe - ``upcloud-pl-waw`` - - Europe, Poland + - Europe, Poland: Warsaw * - Europe - ``upcloud-se-sto`` - - Europe, Sweden + - Europe, Sweden: Stockholm * - North America - ``upcloud-us-chi`` - - United States, Illinois + - United States, Illinois: Chicago * - North America - ``upcloud-us-nyc`` - - United States, New York + - United States, New York: New York * - North America - ``upcloud-us-sjo`` - - United States, California \ No newline at end of file + - United States, California: San Jose \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index 660f517c3d..e76a9b9e4f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -15,4 +15,5 @@ sphinx-sitemap==2.2.0 sphinx-notfound-page==0.8 pygments==2.15.0 python-dotenv==0.21.0 -algoliasearch==3.0.0 \ No newline at end of file +algoliasearch==3.0.0 +natsort==8.4.0 diff --git a/scripts/aiven/clouds.py b/scripts/aiven/clouds.py index b98f48d414..792f7940af 100644 --- a/scripts/aiven/clouds.py +++ b/scripts/aiven/clouds.py @@ -1,24 +1,54 @@ -import requests import argparse -from typing import Dict +import re +import requests +from dataclasses import dataclass +from typing import Dict, Self +from natsort import natsorted + + +@dataclass +class CloudEntry: + description: str + geo_region: str + name: str + vendor_code: str + vendor_name: str + @classmethod + def from_dict(cls: type[Self], cloud: dict[str, str | float], /) -> Self: + """Create cloud entry from dict -def create_cloud_entry(cloud: Dict) -> str: - """Creates cloud entry with formatted info. + :param cloud: contains relevant info about cloud + :rtype: CloudEntry + """ - :param cloud: contains relevant info about cloud - :returns: formatted string with cloud info - :rtype: str - """ - entry = "" - # Printing in title case to make it look better - entry += f' * - {cloud["geo_region"].title()}' - entry += "\n" - entry += f' - ``{cloud["cloud_name"]}``' - entry += "\n" - prefix = cloud["cloud_description"][0 : cloud["cloud_description"].find("-")] - entry += f" - {prefix}" - return entry + description_parts = [ + description_part.strip() + for description_part in re.split(r"[,:-]", cloud["cloud_description"]) + ] + vendor_name = description_parts.pop(2) + description = f"{description_parts[0]}, {description_parts[1]}: {description_parts[2]}" + cloud_name = cloud["cloud_name"] + vendor_code = cloud_name[0:cloud_name.index("-")] + return cls( + description=description, + geo_region=cloud["geo_region"].title(), # Printing in title case to make it look better + name=cloud_name, + vendor_code=vendor_code, + vendor_name=vendor_name, + ) + + def to_str(self) -> str: + """Creates cloud entry with formatted info. + + :returns: formatted string with cloud info + :rtype: str + """ + result = "" + result += f" * - {self.geo_region}\n" + result += f" - ``{self.name}``\n" + result += f" - {self.description}" + return result def main(): @@ -33,33 +63,21 @@ def main(): response = requests.get("https://api.aiven.io/v1/clouds") data = response.json()["clouds"] - # Sorting the data by vendor and region - # * Vendor is contained in the cloud_name field, between the start and the '-' symbol - # * geographical region is contained in the geo_region field - # * the cloud name itself is contained in the cloud_name field - data = sorted( - data, - key=lambda k: k["cloud_name"][0 : k["cloud_name"].find("-")] - + " " - + k["geo_region"] - + k["cloud_name"], + cloud_entries = natsorted( + (CloudEntry.from_dict(cloud) for cloud in data), + key=lambda cloud: (cloud.vendor_code, cloud.geo_region, cloud.name), ) # This helps creating a new section every time there is a change in the Cloud vendor - prev_cloud = None + prev_cloud_vendor_code = None res = "" - for cloud in data: - # Extracting the cloud vendor information available in the cloud_description field between the `-` symbol and the `:` symbol - curr_cloud = cloud["cloud_description"][ - cloud["cloud_description"].find("-") - + 2 : cloud["cloud_description"].find(":") - ] + for cloud_entry in cloud_entries: res += "\n" # If current_cloud is different than the previous cloud, let's create a new title, section, table - if curr_cloud != prev_cloud: - prev_cloud = curr_cloud + if cloud_entry.vendor_code != prev_cloud_vendor_code: + prev_cloud_vendor_code = cloud_entry.vendor_code res += "\n" - res += curr_cloud + res += cloud_entry.vendor_name res += "\n" res += "-----------------------------------------------------" res += "\n" @@ -76,7 +94,7 @@ def main(): res += " - Description" res += "\n" - res += create_cloud_entry(cloud) + res += cloud_entry.to_str() with open(filename, "w") as text_file: text_file.write(res) From 295ad26f48f6ee4a2a5f5b837fd3863dee9ec8fa Mon Sep 17 00:00:00 2001 From: Roman Inflianskas Date: Fri, 1 Dec 2023 17:51:38 +0200 Subject: [PATCH 22/55] github actions, cloud list: run cloud list job every day --- .github/workflows/cloud-list.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/cloud-list.yaml b/.github/workflows/cloud-list.yaml index cf15b180e6..83ded24718 100644 --- a/.github/workflows/cloud-list.yaml +++ b/.github/workflows/cloud-list.yaml @@ -2,7 +2,7 @@ name: Cloud - Create PR to update available list on: schedule: - - cron: "0 6 * * 2" + - cron: "0 6 * * *" workflow_dispatch: jobs: From fbf5eecc547e1e4d10258a498b0aa8c6a4427ea9 Mon Sep 17 00:00:00 2001 From: Joshua Rule Date: Mon, 4 Dec 2023 15:51:50 +1300 Subject: [PATCH 23/55] PostgreSQL - Update replica server failover documentation The read replica service endpoint is never pointed at the primary PostgreSQL server. Update the documentation to reflect this and inform that in the event of standby node (replica) failure the read replica endpoint will be unavailble on a Business plan until a new replica is available. [SUP-845] --- docs/products/postgresql/concepts/upgrade-failover.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/products/postgresql/concepts/upgrade-failover.rst b/docs/products/postgresql/concepts/upgrade-failover.rst index cac7bd60d3..0dc5a13337 100644 --- a/docs/products/postgresql/concepts/upgrade-failover.rst +++ b/docs/products/postgresql/concepts/upgrade-failover.rst @@ -31,9 +31,15 @@ After the replica promotion, ``servicename-projectname.aivencloud.com`` would po Replica server disconnection """""""""""""""""""""""""""" -If the **replica** server disappears, Aiven's management platform uses a **300-second timeout** before marking the server as down and creating a new replica server. During this period, the DNS ``replica-servicename-projectname.aivencloud.com`` points to the disappeared server that might not serve queries anymore. The DNS record pointing to the primary server (``servicename-projectname.aivencloud.com``) remains unchanged. +If the **replica** server disappears, Aiven's management platform uses a **60-second timeout** before marking the server as down and creating a new replica server. -If the replica server does not come back online during these 300 seconds, ``replica-servicename-projectname.aivencloud.com`` is pointed to the primary server until a new replica server is fully functional. +.. note:: + Each Aiven for PostgreSQL® Business plan supports one replica server only, which is why the service's read replica endpoint ``replica-SERVICE_NAME-PROJECT_NAME.aivencloud.com`` remains unavailable and queries to this endpoint time-out until a new replica is available. + +.. tip:: + For higher availability on a service's read replica endpoint, you can upgrade to a Premium plan with two standby servers used as read replicas. + +The DNS record pointing to primary server ``SERVICE_NAME-PROJECT_NAME.aivencloud.com`` remains unchanged during the recovery of the replica server. Controlled switchover during upgrades or migrations --------------------------------------------------- From dbf7acf27ba585551bfed229937affbe95dbd078 Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Dec 2023 06:02:23 +0000 Subject: [PATCH 24/55] OpenSearch - Update Advanced parameters --- includes/config-opensearch.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/includes/config-opensearch.rst b/includes/config-opensearch.rst index 636f2c9a4a..006c0a732e 100644 --- a/includes/config-opensearch.rst +++ b/includes/config-opensearch.rst @@ -1,4 +1,9 @@ +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** @@ -34,6 +39,14 @@ +``service_log`` +--------------- +*['boolean', 'null']* + +**Service logging** Store logs for the service so that they are available in the HTTP API and console. + + + ``static_ips`` -------------- *boolean* From 6d6a9ec78c49e6916f469992453be63d97bc3c35 Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Dec 2023 06:02:25 +0000 Subject: [PATCH 25/55] InfluxDB - Update Advanced parameters --- includes/config-influxdb.rst | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/includes/config-influxdb.rst b/includes/config-influxdb.rst index 3c41fef68a..ecf7b41fd5 100644 --- a/includes/config-influxdb.rst +++ b/includes/config-influxdb.rst @@ -1,9 +1,9 @@ -.. - ``additional_backup_regions`` - ----------------------------- - *array* - **Additional Cloud Regions for Backup Replication** +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** @@ -23,6 +23,14 @@ +``service_log`` +--------------- +*['boolean', 'null']* + +**Service logging** Store logs for the service so that they are available in the HTTP API and console. + + + ``static_ips`` -------------- *boolean* From 4a913734c18d87d17b49f2b5c9aa51fc2903bc93 Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Dec 2023 06:02:32 +0000 Subject: [PATCH 26/55] Flink - Update Advanced parameters --- includes/config-flink.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/includes/config-flink.rst b/includes/config-flink.rst index ebc6c4c9c2..47552d47bf 100644 --- a/includes/config-flink.rst +++ b/includes/config-flink.rst @@ -1,4 +1,12 @@ +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** + + + ``ip_filter`` ------------- *array* @@ -7,6 +15,14 @@ +``service_log`` +--------------- +*['boolean', 'null']* + +**Service logging** Store logs for the service so that they are available in the HTTP API and console. + + + ``static_ips`` -------------- *boolean* From 2aa0b2464377354ecc4e4ae4676c1c03944ffe2a Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Dec 2023 06:03:22 +0000 Subject: [PATCH 27/55] M3DB - Update Advanced parameters --- includes/config-m3db.rst | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/includes/config-m3db.rst b/includes/config-m3db.rst index cfc5c7697a..6ae08fd091 100644 --- a/includes/config-m3db.rst +++ b/includes/config-m3db.rst @@ -15,6 +15,14 @@ +``service_log`` +--------------- +*['boolean', 'null']* + +**Service logging** Store logs for the service so that they are available in the HTTP API and console. + + + ``static_ips`` -------------- *boolean* @@ -116,12 +124,12 @@ **Allow clients to connect to m3coordinator from the public internet for service nodes that are in a project VPC or another type of private network** -.. - ``additional_backup_regions`` - ----------------------------- - *array* - **Additional Cloud Regions for Backup Replication** +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** From b9be772f35471f0b4ba18102d64b28af670d76b0 Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Dec 2023 06:03:55 +0000 Subject: [PATCH 28/55] MySQL - Update Advanced parameters --- includes/config-mysql.rst | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/includes/config-mysql.rst b/includes/config-mysql.rst index c7721cb0c5..da9d176f52 100644 --- a/includes/config-mysql.rst +++ b/includes/config-mysql.rst @@ -1,9 +1,9 @@ -.. - ``additional_backup_regions`` - ----------------------------- - *array* - **Additional Cloud Regions for Backup Replication** +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** @@ -15,6 +15,14 @@ +``service_log`` +--------------- +*['boolean', 'null']* + +**Service logging** Store logs for the service so that they are available in the HTTP API and console. + + + ``static_ips`` -------------- *boolean* From 0ea58d7162a0c3695df2d8830a5717b208204218 Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Dec 2023 06:04:10 +0000 Subject: [PATCH 29/55] KafkaMirrorMaker - Update Advanced parameters --- includes/config-kafka_mirrormaker.rst | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/includes/config-kafka_mirrormaker.rst b/includes/config-kafka_mirrormaker.rst index 2801afe2f9..a1e90c7c30 100644 --- a/includes/config-kafka_mirrormaker.rst +++ b/includes/config-kafka_mirrormaker.rst @@ -1,9 +1,9 @@ -.. - ``additional_backup_regions`` - ----------------------------- - *array* - **Additional Cloud Regions for Backup Replication** +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** @@ -15,6 +15,14 @@ +``service_log`` +--------------- +*['boolean', 'null']* + +**Service logging** Store logs for the service so that they are available in the HTTP API and console. + + + ``static_ips`` -------------- *boolean* From 264a7ea818c666d3cc474ebdf89928f2f63a4c1d Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Dec 2023 06:04:50 +0000 Subject: [PATCH 30/55] Grafana - Update Advanced parameters --- includes/config-grafana.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/includes/config-grafana.rst b/includes/config-grafana.rst index efd8e9a596..d52f25554b 100644 --- a/includes/config-grafana.rst +++ b/includes/config-grafana.rst @@ -1,3 +1,12 @@ + +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** + + + ``custom_domain`` ----------------- *['string', 'null']* @@ -14,6 +23,14 @@ +``service_log`` +--------------- +*['boolean', 'null']* + +**Service logging** Store logs for the service so that they are available in the HTTP API and console. + + + ``static_ips`` -------------- *boolean* From 0287666e76eba50228cbc624ce0eae17ec4c79e6 Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Dec 2023 06:05:27 +0000 Subject: [PATCH 31/55] Cassandra - Update Advanced parameters --- includes/config-cassandra.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/includes/config-cassandra.rst b/includes/config-cassandra.rst index 3b938549d5..e38e6d1946 100644 --- a/includes/config-cassandra.rst +++ b/includes/config-cassandra.rst @@ -7,6 +7,14 @@ +``service_log`` +--------------- +*['boolean', 'null']* + +**Service logging** Store logs for the service so that they are available in the HTTP API and console. + + + ``static_ips`` -------------- *boolean* From 65996feaf1a2faba8ebe73ebedc338bdef572557 Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Dec 2023 06:05:50 +0000 Subject: [PATCH 32/55] M3Aggregator - Update Advanced parameters --- includes/config-m3aggregator.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/includes/config-m3aggregator.rst b/includes/config-m3aggregator.rst index 98fb429cf6..399a14d66e 100644 --- a/includes/config-m3aggregator.rst +++ b/includes/config-m3aggregator.rst @@ -15,6 +15,14 @@ +``service_log`` +--------------- +*['boolean', 'null']* + +**Service logging** Store logs for the service so that they are available in the HTTP API and console. + + + ``static_ips`` -------------- *boolean* From 505d7e06719296fa6c764023df9468b5ea488c2b Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Dec 2023 06:06:17 +0000 Subject: [PATCH 33/55] KafkaConnector - Update Advanced parameters --- includes/config-kafka_connect.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/includes/config-kafka_connect.rst b/includes/config-kafka_connect.rst index b7d297b16a..a338db5b91 100644 --- a/includes/config-kafka_connect.rst +++ b/includes/config-kafka_connect.rst @@ -1,4 +1,11 @@ +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** + + ``ip_filter`` ------------- @@ -8,6 +15,14 @@ +``service_log`` +--------------- +*['boolean', 'null']* + +**Service logging** Store logs for the service so that they are available in the HTTP API and console. + + + ``static_ips`` -------------- *boolean* From 171ef1b41263e0cf85d87b553e4b1fadb8daf791 Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Dec 2023 06:06:56 +0000 Subject: [PATCH 34/55] Kafka - Update Advanced parameters --- includes/config-kafka.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/includes/config-kafka.rst b/includes/config-kafka.rst index db5f2eac56..5f3b243d82 100644 --- a/includes/config-kafka.rst +++ b/includes/config-kafka.rst @@ -1,4 +1,9 @@ +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** @@ -18,6 +23,14 @@ +``service_log`` +--------------- +*['boolean', 'null']* + +**Service logging** Store logs for the service so that they are available in the HTTP API and console. + + + ``static_ips`` -------------- *boolean* @@ -642,6 +655,12 @@ **consumer.request.timeout.ms** The maximum total time to wait for messages for a request if the maximum number of messages has not yet been reached +``name_strategy_validation`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +*boolean* + +**name.strategy.validation** If true, validate that given schema is registered under expected subject name by the used name strategy when producing messages. + ``simpleconsumer_pool_size_max`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ *integer* From a39a21a67ca88745c0797ecc5965a32a235729e6 Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Dec 2023 06:06:58 +0000 Subject: [PATCH 35/55] Redis - Update Advanced parameters --- includes/config-redis.rst | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/includes/config-redis.rst b/includes/config-redis.rst index 9d1dce56db..c3a04ca271 100644 --- a/includes/config-redis.rst +++ b/includes/config-redis.rst @@ -1,9 +1,9 @@ -.. - ``additional_backup_regions`` - ----------------------------- - *array* - **Additional Cloud Regions for Backup Replication** +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** @@ -15,6 +15,14 @@ +``service_log`` +--------------- +*['boolean', 'null']* + +**Service logging** Store logs for the service so that they are available in the HTTP API and console. + + + ``static_ips`` -------------- *boolean* From 068ceb3b01a22a0a287ec62ca3c80f4446f5484e Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Dec 2023 06:07:10 +0000 Subject: [PATCH 36/55] ClickHouse - Update Advanced parameters --- includes/config-clickhouse.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/includes/config-clickhouse.rst b/includes/config-clickhouse.rst index 6009249852..6879bbe143 100644 --- a/includes/config-clickhouse.rst +++ b/includes/config-clickhouse.rst @@ -1,4 +1,12 @@ +``additional_backup_regions`` +----------------------------- +*array* + +**Additional Cloud Regions for Backup Replication** + + + ``ip_filter`` ------------- *array* @@ -7,6 +15,14 @@ +``service_log`` +--------------- +*['boolean', 'null']* + +**Service logging** Store logs for the service so that they are available in the HTTP API and console. + + + ``static_ips`` -------------- *boolean* From 9b5b6f4a04f657b8f99dc874f075874f2920ca27 Mon Sep 17 00:00:00 2001 From: Stacey Salamon <111294980+staceysalamon-aiven@users.noreply.github.com> Date: Tue, 5 Dec 2023 15:42:07 +0100 Subject: [PATCH 37/55] Add verification tag for Zendesk (#2320) --- _templates/base.html | 3 +++ 1 file changed, 3 insertions(+) diff --git a/_templates/base.html b/_templates/base.html index b1a8183116..bf370b74f9 100644 --- a/_templates/base.html +++ b/_templates/base.html @@ -5,6 +5,9 @@ + + + From b2d11faea8c6af5fcc2a3b80d9ddeceaf956e74c Mon Sep 17 00:00:00 2001 From: dorota <114921900+wojcik-dorota@users.noreply.github.com> Date: Wed, 6 Dec 2023 13:24:15 +0100 Subject: [PATCH 38/55] Update config-clickhouse.rst --- includes/config-clickhouse.rst | 8 -------- 1 file changed, 8 deletions(-) diff --git a/includes/config-clickhouse.rst b/includes/config-clickhouse.rst index 6879bbe143..64d6766a1b 100644 --- a/includes/config-clickhouse.rst +++ b/includes/config-clickhouse.rst @@ -1,12 +1,4 @@ -``additional_backup_regions`` ------------------------------ -*array* - -**Additional Cloud Regions for Backup Replication** - - - ``ip_filter`` ------------- *array* From 38de53e58ba7996cffb650d2350f1c5b020f64a4 Mon Sep 17 00:00:00 2001 From: dorota <114921900+wojcik-dorota@users.noreply.github.com> Date: Wed, 6 Dec 2023 13:25:43 +0100 Subject: [PATCH 39/55] Update config-mysql.rst --- includes/config-mysql.rst | 8 -------- 1 file changed, 8 deletions(-) diff --git a/includes/config-mysql.rst b/includes/config-mysql.rst index da9d176f52..deb0c300eb 100644 --- a/includes/config-mysql.rst +++ b/includes/config-mysql.rst @@ -1,12 +1,4 @@ -``additional_backup_regions`` ------------------------------ -*array* - -**Additional Cloud Regions for Backup Replication** - - - ``ip_filter`` ------------- *array* From dc6b6055de085914cd772a5acd4f0d2ef5373252 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Wed, 6 Dec 2023 13:41:45 +0100 Subject: [PATCH 40/55] Update config-redis.rst --- includes/config-redis.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/includes/config-redis.rst b/includes/config-redis.rst index c3a04ca271..7573e29add 100644 --- a/includes/config-redis.rst +++ b/includes/config-redis.rst @@ -1,10 +1,4 @@ -``additional_backup_regions`` ------------------------------ -*array* - -**Additional Cloud Regions for Backup Replication** - ``ip_filter`` From 54175b8fdf0aee67600963a3f03aa8d0a30f3165 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Wed, 6 Dec 2023 13:43:06 +0100 Subject: [PATCH 41/55] Update config-kafka.rst --- includes/config-kafka.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/includes/config-kafka.rst b/includes/config-kafka.rst index 5f3b243d82..2424997c7a 100644 --- a/includes/config-kafka.rst +++ b/includes/config-kafka.rst @@ -1,9 +1,4 @@ -``additional_backup_regions`` ------------------------------ -*array* - -**Additional Cloud Regions for Backup Replication** From 6e5b0a5715ebb228ae6f37cf658b4b711ea25668 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Wed, 6 Dec 2023 16:05:15 +0100 Subject: [PATCH 42/55] Update config-grafana.rst --- includes/config-grafana.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/includes/config-grafana.rst b/includes/config-grafana.rst index d52f25554b..1bb69ee0da 100644 --- a/includes/config-grafana.rst +++ b/includes/config-grafana.rst @@ -1,9 +1,4 @@ -``additional_backup_regions`` ------------------------------ -*array* - -**Additional Cloud Regions for Backup Replication** From 1f4718bb31411819d5182c1ddd47d1705be01d61 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Wed, 6 Dec 2023 16:05:58 +0100 Subject: [PATCH 43/55] Update config-kafka_connect.rst --- includes/config-kafka_connect.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/includes/config-kafka_connect.rst b/includes/config-kafka_connect.rst index a338db5b91..5ca4ad08ee 100644 --- a/includes/config-kafka_connect.rst +++ b/includes/config-kafka_connect.rst @@ -1,9 +1,5 @@ -``additional_backup_regions`` ------------------------------ -*array* -**Additional Cloud Regions for Backup Replication** From c4e8bb1d4460c90ad4ae33ed511d566a234c3a3b Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Wed, 6 Dec 2023 16:06:42 +0100 Subject: [PATCH 44/55] Update config-kafka_mirrormaker.rst --- includes/config-kafka_mirrormaker.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/includes/config-kafka_mirrormaker.rst b/includes/config-kafka_mirrormaker.rst index a1e90c7c30..b0910031be 100644 --- a/includes/config-kafka_mirrormaker.rst +++ b/includes/config-kafka_mirrormaker.rst @@ -1,9 +1,4 @@ -``additional_backup_regions`` ------------------------------ -*array* - -**Additional Cloud Regions for Backup Replication** From 6bc1081df6c0ac4f0d97d357619f4719de2a6cae Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Wed, 6 Dec 2023 16:08:00 +0100 Subject: [PATCH 45/55] Update config-m3db.rst --- includes/config-m3db.rst | 8 -------- 1 file changed, 8 deletions(-) diff --git a/includes/config-m3db.rst b/includes/config-m3db.rst index 6ae08fd091..2619940a85 100644 --- a/includes/config-m3db.rst +++ b/includes/config-m3db.rst @@ -125,14 +125,6 @@ -``additional_backup_regions`` ------------------------------ -*array* - -**Additional Cloud Regions for Backup Replication** - - - ``m3_version`` -------------- *['string', 'null']* From 4e887741fbcfa8a08687d8b2cca15b2bcc45d243 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Wed, 6 Dec 2023 16:08:46 +0100 Subject: [PATCH 46/55] Update config-flink.rst --- includes/config-flink.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/includes/config-flink.rst b/includes/config-flink.rst index 47552d47bf..d5ba1a899a 100644 --- a/includes/config-flink.rst +++ b/includes/config-flink.rst @@ -1,10 +1,4 @@ -``additional_backup_regions`` ------------------------------ -*array* - -**Additional Cloud Regions for Backup Replication** - ``ip_filter`` From 18da5fe0265d92fa11e98cfa0715a32bbad258df Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Wed, 6 Dec 2023 16:28:27 +0100 Subject: [PATCH 47/55] Update config-influxdb.rst --- includes/config-influxdb.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/includes/config-influxdb.rst b/includes/config-influxdb.rst index ecf7b41fd5..6a195ef6fb 100644 --- a/includes/config-influxdb.rst +++ b/includes/config-influxdb.rst @@ -1,10 +1,4 @@ -``additional_backup_regions`` ------------------------------ -*array* - -**Additional Cloud Regions for Backup Replication** - ``custom_domain`` From 4235dde7f77c00a1ac0b611e6de0c76921b0759c Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com> Date: Wed, 6 Dec 2023 16:29:07 +0100 Subject: [PATCH 48/55] Update config-opensearch.rst --- includes/config-opensearch.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/includes/config-opensearch.rst b/includes/config-opensearch.rst index 006c0a732e..dccb64131a 100644 --- a/includes/config-opensearch.rst +++ b/includes/config-opensearch.rst @@ -1,10 +1,4 @@ -``additional_backup_regions`` ------------------------------ -*array* - -**Additional Cloud Regions for Backup Replication** - ``opensearch_version`` From 29e141f41a57216655d0c9ecfe32a93a92c2476d Mon Sep 17 00:00:00 2001 From: Arthur <28596581+ArthurFlageul@users.noreply.github.com> Date: Thu, 7 Dec 2023 12:15:49 +0100 Subject: [PATCH 49/55] Various fixes (#2315) --- docs/integrations/datadog.rst | 2 +- docs/integrations/rsyslog/logtail.rst | 2 +- .../concepts/enhanced-compliance-env.rst | 31 +++++++----- docs/platform/concepts/free-plan.rst | 7 +-- docs/platform/concepts/service_backups.rst | 2 +- docs/platform/howto/add-storage-space.rst | 3 +- ...loud-platform-marketplace-subscription.rst | 17 +++---- .../byoc/assign-project-custom-cloud.rst | 8 ++-- .../howto/cleanup-powered-off-services.rst | 2 + docs/platform/howto/console-fork-service.rst | 12 +++-- docs/platform/howto/private-ip-resolution.rst | 8 ++-- docs/platform/howto/saml/setup-saml-auth0.rst | 2 +- docs/platform/howto/use-azure-privatelink.rst | 8 ++-- .../use-google-private-service-connect.rst | 47 ++++++++++--------- docs/platform/howto/vnet-peering-azure.rst | 18 +++---- docs/platform/howto/vpc-peering-upcloud.rst | 8 ++-- docs/products/flink/howto/slack-connector.rst | 2 +- .../grafana/concepts/grafana-features.rst | 7 ++- .../grafana/howto/dashboard-previews.rst | 12 ++--- .../howto/pitr-process-for-grafana.rst | 10 ++-- .../howto/replace-expression-string.rst | 2 +- .../kafka/concepts/configuration-backup.rst | 4 +- .../kafka/concepts/kafka-tiered-storage.rst | 2 + .../kafka/concepts/upgrade-procedure.rst | 22 ++++----- docs/products/kafka/howto/best-practices.rst | 2 +- .../kafka/howto/connect-with-nodejs.rst | 31 ++++++------ .../products/kafka/howto/fake-sample-data.rst | 4 +- docs/products/kafka/howto/schema-registry.rst | 10 ++-- .../howto/gcp-bigquery-sink-prereq.rst | 2 +- .../kafka-connect/howto/gcs-sink-prereq.rst | 4 +- .../concepts/mysql-tuning-and-concurrency.rst | 6 ++- .../create-tables-without-primary-keys.rst | 21 +++++---- .../postgresql/concepts/aiven-db-migrate.rst | 14 +++--- .../products/postgresql/concepts/pgvector.rst | 19 +++----- docs/products/postgresql/getting-started.rst | 25 +++++----- docs/products/postgresql/howto.rst | 2 +- .../howto/analyze-with-google-data-studio.rst | 16 +++---- .../postgresql/howto/list-integrations.rst | 2 +- .../howto/create-manage-teams.rst | 2 +- 39 files changed, 209 insertions(+), 189 deletions(-) diff --git a/docs/integrations/datadog.rst b/docs/integrations/datadog.rst index 11d976d1a8..97f12fc233 100644 --- a/docs/integrations/datadog.rst +++ b/docs/integrations/datadog.rst @@ -1,7 +1,7 @@ Datadog and Aiven ================= -`Datadog `_ is a monitoring platform, allowing you to keep an eye on all aspects of your cloud estate. Aiven has integrations that make it easy to include an Aiven service in your Datadog dashboards. +`Datadog `_ is a monitoring platform, allowing you to keep an eye on all aspects of your cloud estate. Aiven has integrations that make it easy to include an Aiven service in your Datadog dashboards. Datadog for metrics ------------------- diff --git a/docs/integrations/rsyslog/logtail.rst b/docs/integrations/rsyslog/logtail.rst index 5d6eb5dc2d..240b5a2f18 100644 --- a/docs/integrations/rsyslog/logtail.rst +++ b/docs/integrations/rsyslog/logtail.rst @@ -1,7 +1,7 @@ Send Aiven logs to Logtail ========================== -`Logtail `_ is a logging service with solid database backing and a cool SQL query interface. You can use the Aiven :doc:`/docs/integrations/rsyslog` to send your logs to Logtail. This article will show you how to set this up. +`Logtail `_ is a logging service with solid database backing and a cool SQL query interface. You can use the Aiven :doc:`/docs/integrations/rsyslog` to send your logs to Logtail. This article will show you how to set this up. 1. Set up an Rsyslog source on Logtail. Choose **Connect source**, give your source a **Name**, and select "Rsyslog" as the **Platform**. diff --git a/docs/platform/concepts/enhanced-compliance-env.rst b/docs/platform/concepts/enhanced-compliance-env.rst index f7095d17bf..ee0a4e8a20 100644 --- a/docs/platform/concepts/enhanced-compliance-env.rst +++ b/docs/platform/concepts/enhanced-compliance-env.rst @@ -50,24 +50,31 @@ Environment: The necessary peering information to enable the peer from our end. This differs between clouds: -AWS: - * AWS account ID - * VPC ID -GCP: - * GCP Project ID - * VPC Network Name -Azure: - * Azure Tenant ID - * Azure App ID - * Azure VNet ID +**AWS:** + +* AWS account ID +* VPC ID + +**GCP:** + +* GCP Project ID +* VPC Network Name + +**Azure:** + +* Azure Tenant ID +* Azure App ID +* Azure VNet ID What compliances are covered? -------------------------------- Although not exhaustive, Aiven is capable of supporting both the Health Insurance Portability and Accountability Act (HIPAA) and the Payment Card Industry Data Security Standard (PCI DSS) -compliances. If you require compliance beyond these please contact our sales department so we +compliances. + +If you require compliance beyond these please contact our sales department so we can better understand your specific needs. Additionally, we also offer an alternative deployment -option -- :doc:`Bring Your Own Cloud (BYOC) `. +option. See :doc:`Bring Your Own Cloud (BYOC) `. Migrating ---------------- diff --git a/docs/platform/concepts/free-plan.rst b/docs/platform/concepts/free-plan.rst index 887e3e2b0f..081abf170d 100644 --- a/docs/platform/concepts/free-plan.rst +++ b/docs/platform/concepts/free-plan.rst @@ -24,9 +24,10 @@ Free plans include: * Backups * Integrations between different Aiven services including free, paid, and trial services * AWS hosting in a limited number of regions: - * EMEA: aws-eu-north-1, aws-eu-west-1, aws-eu-west-2, aws-eu-west-3 - * Americas: aws-us-east-1, aws-us-east-2, aws-us-west-2, aws-ca-central-1 - * APAC: aws-ap-south-1 + + * EMEA: aws-eu-north-1, aws-eu-west-1, aws-eu-west-2, aws-eu-west-3 + * Americas: aws-us-east-1, aws-us-east-2, aws-us-west-2, aws-ca-central-1 + * APAC: aws-ap-south-1 There are some limitations of the free plan services: diff --git a/docs/platform/concepts/service_backups.rst b/docs/platform/concepts/service_backups.rst index 6742a91e66..0a411d5487 100644 --- a/docs/platform/concepts/service_backups.rst +++ b/docs/platform/concepts/service_backups.rst @@ -173,7 +173,7 @@ Aiven for ClickHouse backups contain database lists, table schemas, table conten .. seealso:: - For more information on Aiven for ClickHouse backups, see :ref:`Backup and restore `. + For more information on Aiven for ClickHouse backups, see :doc:`Backup and restore `. Access to backups ----------------- diff --git a/docs/platform/howto/add-storage-space.rst b/docs/platform/howto/add-storage-space.rst index 3def20a8f0..7a8691fae7 100644 --- a/docs/platform/howto/add-storage-space.rst +++ b/docs/platform/howto/add-storage-space.rst @@ -29,7 +29,7 @@ You can add storage to your running service in `Aiven Console `_. This page contains information about all of Aiven's services and how the marketplace subscription works. Click the **Subscribe** button on this page. +#. Navigate to `Aiven Managed Database Services on the Google Cloud Marketplace `_. This page contains information about all of Aiven's services and how the marketplace subscription works. Click the **Subscribe** button on this page. -2. Select your desired billing account, then read and agree to the terms and conditions. +#. Select your desired billing account, then read and agree to the terms and conditions. -3. When you are ready, click the **Subscribe** button at the bottom of the page. You will NOT be charged by clicking this button; this only sets up a billing subscription between GCP and Aiven. You will only be charged after deploying Aiven services. +#. When you are ready, click the **Subscribe** button at the bottom of the page. You will NOT be charged by clicking this button; this only sets up a billing subscription between GCP and Aiven. You will only be charged after deploying Aiven services. -4. You should now see a message that says "Your order request has been sent to Aiven". Click on the **Go to product page** button. +#. You should now see a message that says "Your order request has been sent to Aiven". Click on the **Go to product page** button. -5. Everything is now complete in your GCP account, but you still need to setup the Aiven account. Click on the **Manage on provider** button to go to the Aiven console to complete the process. +#. Everything is now complete in your GCP account, but you still need to setup the Aiven account. Click on the **Manage on provider** button to go to the Aiven console to complete the process. .. image:: /images/platform/howto/gcp-manage-on-provider.png :alt: Google Cloud Marketplace page after subscribing, showing the "Manage on provider" button @@ -25,14 +25,15 @@ Google Cloud Marketplace setup Aiven account setup ------------------- -6. You should now be on a signup page at Aiven, asking you for your email address to create a new account. +#. You should now be on a signup page at Aiven, asking you for your email address to create a new account. -7. After entering your email address, you will be sent an email to confirm your registration. Click on the link. +#. After entering your email address, you will be sent an email to confirm your registration. Click on the link. -8. You can now proceed to the `Aiven console for GCP `_, where you can manage your Aiven services as normal. +#. You can now proceed to the `Aiven console for GCP `_, where you can manage your Aiven services as normal. .. image:: /images/platform/howto/gcp-console.png :alt: The GCP version of the Aiven web console + .. note:: Note the URL is https://console.gcp.aiven.io - this uses a different account system than https://console.aiven.io. If you have an existing Aiven account you will need to create a new Aiven GCP account using the Aiven GCP console, and when coming back to Aiven in the future, you will need to use https://console.gcp.aiven.io to login. diff --git a/docs/platform/howto/byoc/assign-project-custom-cloud.rst b/docs/platform/howto/byoc/assign-project-custom-cloud.rst index 3e21235836..726d2757cf 100644 --- a/docs/platform/howto/byoc/assign-project-custom-cloud.rst +++ b/docs/platform/howto/byoc/assign-project-custom-cloud.rst @@ -19,13 +19,11 @@ With the BYOC feature enabled, you can :doc:`create custom clouds `_ and update the settings you configured during the :doc:`initial custom cloud's setup `. -1. In the **Custom cloud's availability in your organization** section, select either +1. In the **Custom cloud's availability in your organization** section, select either: -* **By default for all projects** to make your custom cloud available in all existing and future projects in the organization + * **By default for all projects** to make your custom cloud available in all existing and future projects in the organization, or; -or - -* **By selection** to pick specific projects or organizational units where you want your custom cloud to be available. + * **By selection** to pick specific projects or organizational units where you want your custom cloud to be available. 2. If you go for the **By selection** option, the **Assign organizational units** field and the **Assign projects** field show up. Enter the names of organizational units and/ or projects in which you want to be able to use your custom cloud. diff --git a/docs/platform/howto/cleanup-powered-off-services.rst b/docs/platform/howto/cleanup-powered-off-services.rst index 5f782dce71..933dc22afd 100644 --- a/docs/platform/howto/cleanup-powered-off-services.rst +++ b/docs/platform/howto/cleanup-powered-off-services.rst @@ -8,7 +8,9 @@ The Aiven platform receive regular maintenance updates to keep the services upda Keeping services in powered-off state for a long time lowers the feasibility of a smooth upgrade path, making it harder for Aiven to continue supporting your needs. .. note:: + * It is recommended that you regularly review your services and delete those that are no longer needed. This allows Aiven to focus on supporting the services that you actively use and better utilize platform resources. + * If a service has been powered off for 90 days, you will receive email notifications reminding you that the service has been inactive for a prolonged period. If the service remains powered off for 180 consecutive days, it is subject to automatic deletion. diff --git a/docs/platform/howto/console-fork-service.rst b/docs/platform/howto/console-fork-service.rst index 37dc20a5f5..2e03da4976 100644 --- a/docs/platform/howto/console-fork-service.rst +++ b/docs/platform/howto/console-fork-service.rst @@ -28,13 +28,17 @@ Fork a service using the Aiven client (CLI) 1. Prepare the command to create a new service, this will contain the new copy of your data store. 2. Add the ``service_to_fork_from`` parameter to specify the service to use as the source. -Change service type accordingly with ``-t``, run the following command to see available options:: + Change service type accordingly with ``-t``, run the following command to see available options: - avn service types + .. code:: + + avn service types -For example, if you want to create a fork of your ``forker`` PostgreSQL® service, and name it ``forked``, the command would be something like:: +For example, if you want to create a fork of your ``forker`` PostgreSQL® service, and name it ``forked``, the command would be something like: - avn service create forked -t pg --plan business-4 -c service_to_fork_from=forker +.. code:: + + avn service create forked -t pg --plan business-4 -c service_to_fork_from=forker .. topic:: Result diff --git a/docs/platform/howto/private-ip-resolution.rst b/docs/platform/howto/private-ip-resolution.rst index ad3de40617..844836ab97 100644 --- a/docs/platform/howto/private-ip-resolution.rst +++ b/docs/platform/howto/private-ip-resolution.rst @@ -22,15 +22,15 @@ DNS-rebinding protection on your network. To verify this assumption: ``8.8.8.8``. This has no rebinding protection so serves as a good test. You can use the ``dig`` command: -.. code:: + .. code:: - dig +short myservice-myproject.aivencloud.com @8.8.8.8 + dig +short myservice-myproject.aivencloud.com @8.8.8.8 3. Compare the output of the above command with the response from your default DNS resolver: -.. code:: + .. code:: - dig +short myservice-myproject.aivencloud.com + dig +short myservice-myproject.aivencloud.com 4. If the response from your default DNS resolver does not return the same IP address as the earlier test, then your default DNS resolver is blocking the diff --git a/docs/platform/howto/saml/setup-saml-auth0.rst b/docs/platform/howto/saml/setup-saml-auth0.rst index aab3637ca6..d6dd1a705b 100644 --- a/docs/platform/howto/saml/setup-saml-auth0.rst +++ b/docs/platform/howto/saml/setup-saml-auth0.rst @@ -87,4 +87,4 @@ Go back to the **Authentication** page in `Aiven Console `_ to check the process step by step. +If you have issues, you can use the `SAML Tracer browser extension `_ to check the process step by step. diff --git a/docs/platform/howto/use-azure-privatelink.rst b/docs/platform/howto/use-azure-privatelink.rst index 1f8c33de14..9cccb42c25 100644 --- a/docs/platform/howto/use-azure-privatelink.rst +++ b/docs/platform/howto/use-azure-privatelink.rst @@ -186,9 +186,9 @@ To acquire connection information for your service component using Azure Private * For SSL connection information for your service component using Azure Private Link, run the following command: -.. code-block:: bash + .. code-block:: bash - avn service connection-info UTILITY_NAME SERVICE_NAME -p PRIVATELINK_CONNECTION_ID + avn service connection-info UTILITY_NAME SERVICE_NAME -p PRIVATELINK_CONNECTION_ID .. topic:: Where @@ -198,9 +198,9 @@ To acquire connection information for your service component using Azure Private * For SASL connection information for Aiven for Apache Kafka® service components using Azure Private Link, run the following command: -.. code-block:: bash + .. code-block:: bash - avn service connection-info UTILITY_NAME SERVICE_NAME -p PRIVATELINK_CONNECTION_ID -a sasl + avn service connection-info UTILITY_NAME SERVICE_NAME -p PRIVATELINK_CONNECTION_ID -a sasl .. topic:: Where diff --git a/docs/platform/howto/use-google-private-service-connect.rst b/docs/platform/howto/use-google-private-service-connect.rst index d5fd317cbf..1457e06ba2 100644 --- a/docs/platform/howto/use-google-private-service-connect.rst +++ b/docs/platform/howto/use-google-private-service-connect.rst @@ -84,36 +84,39 @@ Step 3: Approve the created connection 1. Update the state of Private Service Connect connections for your Aiven service by running -.. code:: shell + .. code:: shell - avn service privatelink google refresh MY_SERVICE_NAME + avn service privatelink google refresh MY_SERVICE_NAME 2. Retry the following command until it returns the pending-user-approval status: -.. code:: shell + .. code:: shell - avn service privatelink google connection list MY_SERVICE_NAME + avn service privatelink google connection list MY_SERVICE_NAME -.. code:: shell + .. code:: shell - PRIVATELINK_CONNECTION_ID PSC_CONNECTION_ID STATE USER_IP_ADDRESS - ========================= ================= ===================== =============== - plc3fd852bec98 12870921937223780 pending-user-approval null + PRIVATELINK_CONNECTION_ID PSC_CONNECTION_ID STATE USER_IP_ADDRESS + ========================= ================= ===================== =============== + plc3fd852bec98 12870921937223780 pending-user-approval null -.. note:: - * PSC_CONNECTION_ID is the identifier assigned to Google for the connection, and you can use it to verify that the connection is indeed matching your Private Service Connect endpoint. - * PRIVATELINK_CONNECTION_ID is an Aiven internal identifier for the connection, which is needed in the final connection approval step. + .. note:: + + * PSC_CONNECTION_ID is the identifier assigned to Google for the connection, and you can use it to verify that the connection is indeed matching your Private Service Connect endpoint. + + * PRIVATELINK_CONNECTION_ID is an Aiven internal identifier for the connection, which is needed in the final connection approval step. 3. To enable a connection, approve it. -.. note:: - By approving the connection, you provide the IP address assigned to your PSC endpoint - whether automatically assigned or static. Aiven uses this IP address for pointing the service DNS records necessary for the clients to reach the Aiven service through the Private Service Connect connection. + .. note:: + + By approving the connection, you provide the IP address assigned to your PSC endpoint - whether automatically assigned or static. Aiven uses this IP address for pointing the service DNS records necessary for the clients to reach the Aiven service through the Private Service Connect connection. -To approve the connection, run the following approval command: + To approve the connection, run the following approval command: -.. code:: shell + .. code:: shell - avn service privatelink google connection approve MY_SERVICE_NAME --privatelink-connection-id PRIVATELINK_CONNECTION_ID --user-ip-address PSC_ENDPOINT_IP_ADDRESS + avn service privatelink google connection approve MY_SERVICE_NAME --privatelink-connection-id PRIVATELINK_CONNECTION_ID --user-ip-address PSC_ENDPOINT_IP_ADDRESS As a result, the connection initially transitions to the user-approved state. @@ -127,13 +130,13 @@ As a result, the connection initially transitions to the user-approved state. ========================= ================= ============= =============== plc3fd852bec98 12870921937223780 user-approved 10.0.0.100 -You may be need to run the ``avn service privatelink google refresh`` command at this point since updates to service attachment accept lists are not immediately reflected in the states of returned connected endpoints. +You may need to run the ``avn service privatelink google refresh`` command at this point since updates to service attachment accept lists are not immediately reflected in the states of returned connected endpoints. .. code:: shell avn service privatelink google refresh MY_SERVICE_NAME -After establishing the connection and populating DNS records , the connection appears as ``active``. +After establishing the connection and populating DNS records, the connection appears as ``active``. .. code:: shell @@ -195,9 +198,9 @@ To acquire connection information for your service component using Private Servi * For SSL connection information for your service component using Private Service Connect, run the following command: -.. code-block:: bash + .. code-block:: bash - avn service connection-info UTILITY_NAME SERVICE_NAME -p PRIVATELINK_CONNECTION_ID + avn service connection-info UTILITY_NAME SERVICE_NAME -p PRIVATELINK_CONNECTION_ID .. topic:: Where @@ -207,9 +210,9 @@ To acquire connection information for your service component using Private Servi * For SASL connection information for Aiven for Apache Kafka® service components using Private Service Connect, run the following command: -.. code-block:: bash + .. code-block:: bash - avn service connection-info UTILITY_NAME SERVICE_NAME -p PRIVATELINK_CONNECTION_ID -a sasl + avn service connection-info UTILITY_NAME SERVICE_NAME -p PRIVATELINK_CONNECTION_ID -a sasl .. topic:: Where diff --git a/docs/platform/howto/vnet-peering-azure.rst b/docs/platform/howto/vnet-peering-azure.rst index 6a675188c1..91df49535e 100644 --- a/docs/platform/howto/vnet-peering-azure.rst +++ b/docs/platform/howto/vnet-peering-azure.rst @@ -48,9 +48,9 @@ Using the Azure CLI: az account clear az login -| This should open a window in your browser prompting to choose an Azure - account to log in with. An account with at least the **Application - administrator** role assignment will be needed for the later steps. +This should open a window in your browser prompting to choose an Azure +account to log in with. An account with at least the **Application +administrator** role assignment will be needed for the later steps. If you manage multiple Azure subscriptions, also configure the Azure CLI to default to the correct subscription for the subsequent commands. This @@ -107,8 +107,8 @@ as ``$user_app_secret`` below 5. find the id properties of your virtual network ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This can be found in the Azure portal in "Virtual networks" -> name of -your network -> “JSON View” -> "Resource ID", or using +This can be found in the Azure portal in **Virtual networks** > name of +your network > **JSON View** > **Resource ID**, or using .. code:: @@ -117,11 +117,11 @@ your network -> “JSON View” -> "Resource ID", or using Save the ``id`` field which will be referred to as ``$user_vnet_id`` . Also grab -- the Azure Subscription ID ("Properties" -> "Subscription ID") or the +- the Azure Subscription ID (**Properties** > **Subscription ID**) or the part after ``/subscriptions/`` in the resource ID. This is referred to as ``$user_subscription_id`` -- the resource group name ("Properties" -> "Resource group") or the +- the resource group name (**Properties** > **Resource group**) or the ``resourceGroup`` field in the output. This is referred to as ``$user_resource_group`` @@ -220,8 +220,8 @@ with ~~~~~~~~~~~~~~~~~~~~~~~~~~ The ID of your AD tenant will be needed in the next step. Find it from -the Azure portal from "Azure Active Directory" -> "Properties" -> -"Directory ID" or with the Azure CLI using +the Azure portal from **Azure Active Directory** > **Properties** > +**Directory ID** or with the Azure CLI using .. code:: diff --git a/docs/platform/howto/vpc-peering-upcloud.rst b/docs/platform/howto/vpc-peering-upcloud.rst index 4900060fe3..05fc4e88ce 100644 --- a/docs/platform/howto/vpc-peering-upcloud.rst +++ b/docs/platform/howto/vpc-peering-upcloud.rst @@ -150,15 +150,15 @@ To refresh the DHCP lease for a network interface, run the following commands: 1. To clear the existing DHCP lease - .. code-block:: bash + .. code-block:: bash - dhclient -r NETWORK_INTERFACE_NAME + dhclient -r NETWORK_INTERFACE_NAME 2. To request a renewal of the DHCP lease - .. code-block:: bash + .. code-block:: bash - dhclient NETWORK_INTERFACE_NAME + dhclient NETWORK_INTERFACE_NAME Related reading --------------- diff --git a/docs/products/flink/howto/slack-connector.rst b/docs/products/flink/howto/slack-connector.rst index 57c496ccf8..d07d759d4d 100644 --- a/docs/products/flink/howto/slack-connector.rst +++ b/docs/products/flink/howto/slack-connector.rst @@ -8,7 +8,7 @@ You can access the open-source Slack connect for Apache Flink on Aiven's GitHub Prerequisites ------------- -* Slack app created and ready for use. For more information, refer to the `Set-up Slack Application section `_ on the GitHub repository and the `Slack documentation `_. +* Slack app created and ready for use. For more information, refer to the `Set-up Slack Application section `_ on the GitHub repository and the `Slack documentation `_. * Note the **channel ID** and **token value**, as these will be required in the sink connector Table SQL when configuring the connection in your Flink application. diff --git a/docs/products/grafana/concepts/grafana-features.rst b/docs/products/grafana/concepts/grafana-features.rst index 1d944b10f8..14fc226600 100644 --- a/docs/products/grafana/concepts/grafana-features.rst +++ b/docs/products/grafana/concepts/grafana-features.rst @@ -25,11 +25,10 @@ You can also integrate with popular logs management solutions such as OpenSearch Monitoring with dashboards, plugins, and alerting ------------------------------------------------- -Dashboards and plugins - With Aiven for Grafana, you can monitor your data using ready-made dashboards. Benefit from over 60 advanced panel and :doc:`data source plugins ` that provide a high level of customization to your monitoring solution. -Monitoring and alerting - Aiven for Grafana allows you to create monitoring solutions for all teams, enabling everyone to keep track of critical metrics. Additionally, you can implement an observability platform with alerting, ensuring that you are promptly notified in case of any issues. +- **Dashboards and plugins:** With Aiven for Grafana, you can monitor your data using ready-made dashboards. Benefit from over 60 advanced panel and :doc:`data source plugins ` that provide a high level of customization to your monitoring solution. + +- **Monitoring and alerting:** Aiven for Grafana allows you to create monitoring solutions for all teams, enabling everyone to keep track of critical metrics. Additionally, you can implement an observability platform with alerting, ensuring that you are promptly notified in case of any issues. Automation -------------- diff --git a/docs/products/grafana/howto/dashboard-previews.rst b/docs/products/grafana/howto/dashboard-previews.rst index 3798a8e840..5c468a9ec3 100644 --- a/docs/products/grafana/howto/dashboard-previews.rst +++ b/docs/products/grafana/howto/dashboard-previews.rst @@ -20,15 +20,15 @@ Follow these steps to enable dashboard previews for your Aiven for Grafana servi 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 + .. 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. +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. -.. image:: /images/products/grafana/dashboard-previews-on-grafana.png - :alt: Dashboard previews on Grafana + .. image:: /images/products/grafana/dashboard-previews-on-grafana.png + :alt: Dashboard previews on Grafana Limitations ----------- @@ -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 `_. + For more information on Dashboard previews, see `Grafana documentation `_. diff --git a/docs/products/grafana/howto/pitr-process-for-grafana.rst b/docs/products/grafana/howto/pitr-process-for-grafana.rst index 0d80b1973d..805526bfdb 100644 --- a/docs/products/grafana/howto/pitr-process-for-grafana.rst +++ b/docs/products/grafana/howto/pitr-process-for-grafana.rst @@ -4,7 +4,7 @@ Point-in-time recovery (PITR) process for Aiven for Grafana® The Point-in-Time Recovery (PITR) process allows you to restore your Grafana service using a backup from a specific point in time. When you initiate the restore using the PITR backup for Grafana, a new service will be created to host the restored data. Follow the steps below to perform PITR for Aiven for Grafana: -1. In the Aiven for Grafana Service, select **Backups** from the left sidebar. +1. In the Aiven for Grafana Service, select **Backups** from the left sidebar. 2. Click **Fork & restore**. @@ -22,12 +22,12 @@ The Point-in-Time Recovery (PITR) process allows you to restore your Grafana ser - Choose your cloud provider, preferred cloud region, and the service plan accordingly. -.. image:: /images/products/grafana/grafana-pitr-new-db-fork-popup.png - :alt: popup for setting specifics of the service restore. + .. image:: /images/products/grafana/grafana-pitr-new-db-fork-popup.png + :alt: popup for setting specifics of the service restore. 4. Click **Create fork** to create the new forked service. 5. You will be redirected to the **Overview** page of the newly forked service. The service is in the **Rebuilding** status while it is being created. Once the service is ready, the status changes to **Running**. -.. image:: /images/products/grafana/grafana-pitr-after-fork.png - :alt: restore is rebuilding after clicking 'create fork' + .. image:: /images/products/grafana/grafana-pitr-after-fork.png + :alt: restore is rebuilding after clicking 'create fork' diff --git a/docs/products/grafana/howto/replace-expression-string.rst b/docs/products/grafana/howto/replace-expression-string.rst index 36b989207c..b4bf5a1393 100644 --- a/docs/products/grafana/howto/replace-expression-string.rst +++ b/docs/products/grafana/howto/replace-expression-string.rst @@ -48,7 +48,7 @@ To get your API key (``GRAFANA_API_KEY``): * Otherwise, select **Add API key** and fill in the *Key name*, *Role* and *Time to live*. Click **Add** and then save the new API key. - .. tip:: *Role* must be either *Editor* or *Admin*. + .. tip:: *Role* must be either *Editor* or *Admin*. To get the Grafana dashboard URL and UID ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/products/kafka/concepts/configuration-backup.rst b/docs/products/kafka/concepts/configuration-backup.rst index 547713d10c..4cc5038a61 100644 --- a/docs/products/kafka/concepts/configuration-backup.rst +++ b/docs/products/kafka/concepts/configuration-backup.rst @@ -23,8 +23,8 @@ Some of the key benefits of configuration backups include the following: * Configurations are backed up in 3 hours intervals. * It helps with speedy disaster recovery in certain situations. -.. note:: - In a rare scenario where all the nodes are lost, the configurations are lost and not accessible anymore. + .. note:: + In a rare scenario where all the nodes are lost, the configurations are lost and not accessible anymore. * It helps application users with a quick re-creation of Apache Kafka® services, allowing them to focus on development tasks rather than re-configuring the platform. diff --git a/docs/products/kafka/concepts/kafka-tiered-storage.rst b/docs/products/kafka/concepts/kafka-tiered-storage.rst index dd9a3d880d..d751a8f975 100644 --- a/docs/products/kafka/concepts/kafka-tiered-storage.rst +++ b/docs/products/kafka/concepts/kafka-tiered-storage.rst @@ -9,7 +9,9 @@ Tiered storage in Aiven for Apache Kafka® enables more effective data managemen .. note:: + - Tiered storage for Aiven for Apache Kafka® is supported starting from Apache Kafka® version 3.6. + - Tiered storage for Aiven for Apache Kafka® is not available for startup-2 plans. diff --git a/docs/products/kafka/concepts/upgrade-procedure.rst b/docs/products/kafka/concepts/upgrade-procedure.rst index 6458210a0f..27bb1716c3 100644 --- a/docs/products/kafka/concepts/upgrade-procedure.rst +++ b/docs/products/kafka/concepts/upgrade-procedure.rst @@ -44,14 +44,15 @@ The following set of steps are executed during an upgrade procedure: 2. Once the new nodes are running, they join the Apache Kafka cluster -.. Note:: - The Apache Kafka cluster now contains a mix of old and new nodes + .. Note:: + + The Apache Kafka cluster now contains a mix of old and new nodes 3. The partition data and leadership is transferred to new nodes -.. mermaid:: + .. mermaid:: - flowchart TD; + flowchart TD; subgraph KafkaCluster subgraph Node1 @@ -87,23 +88,22 @@ The following set of steps are executed during an upgrade procedure: PartitionB2 -.-> PartitionNewB2 PartitionC2 -.-> PartitionNewC2 -.. Warning:: + .. Warning:: - This step is CPU intensive due to the additional data movement overhead. + This step is CPU intensive due to the additional data movement overhead. 4. Once old nodes don't have any partition data, they are retired from the cluster. -.. Note:: - - Depending on the cluster size more new nodes are added (by default up to 6 nodes at a time are replaced) + .. Note:: + Depending on the cluster size more new nodes are added (by default up to 6 nodes at a time are replaced) 5. The process is completed once the last old node has been removed from the cluster -.. mermaid:: + .. mermaid:: - flowchart TD; + flowchart TD; subgraph KafkaCluster subgraph NewNode1 diff --git a/docs/products/kafka/howto/best-practices.rst b/docs/products/kafka/howto/best-practices.rst index 723a8e4948..36eb57961b 100644 --- a/docs/products/kafka/howto/best-practices.rst +++ b/docs/products/kafka/howto/best-practices.rst @@ -26,7 +26,7 @@ with a low number that allows efficient data processing and increase it if needed. As a general rule of thumb, the recommendation is to have max 4000 -partitions per broker, and max 200 000 partitions per cluster (`source `_). +partitions per broker, and max 200 000 partitions per cluster (`source `_). .. note:: Ordering is guaranteed only per partition. If you require relative ordering of records, you need to put that subset of data into the same partition. diff --git a/docs/products/kafka/howto/connect-with-nodejs.rst b/docs/products/kafka/howto/connect-with-nodejs.rst index 91fb9becf4..fcba8242d8 100644 --- a/docs/products/kafka/howto/connect-with-nodejs.rst +++ b/docs/products/kafka/howto/connect-with-nodejs.rst @@ -7,29 +7,28 @@ Pre-requisites --------------- #. Install `node-rdkafka `_. Make sure that you have OpenSSL set up on your machine. +#. Go to the *Overview* page of your Aiven for Apache Kafka service and choose how to authenticate. -Go to the *Overview* page of your Aiven for Apache Kafka service. + * To connect with SSL authentication, in the *Connection information* section: -* If you are going to connect with SSL authentication: + #. If **Authentication Method** is shown, choose **Client Certificate** + #. Next to *Access Key*, click **Download** and save the ``service.key`` file. + #. Next to *Access Certificate*, click **Download** and save the ``service.cert`` file. + #. Next to *CA Certificate*, click **Download** and save the ``ca.pem`` file. - * In the *Connection information* section: + * To connect using SASL authentication: - #. If **Authentication Method** is shown, choose **Client Certificate** - #. Next to *Access Key*, click **Download** and save the ``service.key`` file. - #. Next to *Access Certificate*, click **Download** and save the ``service.cert`` file. - #. Next to *CA Certificate*, click **Download** and save the ``ca.pem`` file. + #. Follow the instructions at `Use SASL Authentication with Apache Kafka® `_ to enable SASL. -* If you are going to connect using SASL authentication: + #. In the *Connection Information* section - #. Follow the instructions at `Use SASL Authentication with Apache Kafka® `_ to enable SASL. + #. Select **SASL** as the **Authentication Method** + #. Next to *CA Certificate*, click **Download** and save the ``ca.pem`` file + #. Note the *Password* required for the SASL, we'll need it for authentication - #. In the *Connection Information* section - - #. Select **SASL** as the **Authentication Method** - #. Next to *CA Certificate*, click **Download** and save the ``ca.pem`` file - #. Note the *Password* required for the SASL, we'll need it for authentication - -Note that the *CA Certificate* ``ca.pem`` file has the same contents by either route. +.. note:: + + The *CA Certificate* ``ca.pem`` file has the same content regardless of the authentication method. .. Warning:: diff --git a/docs/products/kafka/howto/fake-sample-data.rst b/docs/products/kafka/howto/fake-sample-data.rst index e65708ebcd..ad49b0e1dd 100644 --- a/docs/products/kafka/howto/fake-sample-data.rst +++ b/docs/products/kafka/howto/fake-sample-data.rst @@ -17,9 +17,9 @@ To learn data streaming, you need a continuous flow of data and for that you can 1. Clone the repository: -.. code:: + .. code:: - git clone https://github.com/aiven/fake-data-producer-for-apache-kafka-docker + git clone https://github.com/aiven/fake-data-producer-for-apache-kafka-docker 2. Copy the file ``conf/env.conf.sample`` to ``conf/env.conf`` diff --git a/docs/products/kafka/howto/schema-registry.rst b/docs/products/kafka/howto/schema-registry.rst index ae704d9507..12f3685c3d 100644 --- a/docs/products/kafka/howto/schema-registry.rst +++ b/docs/products/kafka/howto/schema-registry.rst @@ -70,15 +70,17 @@ Once the schema is defined, you need to compile it, and it can be done **manuall Manual schema compilation ~~~~~~~~~~~~~~~~~~~~~~~~~~ -In case of manual schema compilation, download ``avro-tools-1.11.0.jar`` from https://avro.apache.org/releases.html or via maven using the following:: +In case of manual schema compilation, download ``avro-tools-1.11.0.jar`` from https://avro.apache.org/releases.html or via maven using the following: - mvn org.apache.maven.plugins:maven-dependency-plugin:2.8:get -Dartifact=org.apache.avro:avro-tools:1.11.0:jar -Ddest=avro-tools-1.11.0.jar +.. code:: + + mvn org.apache.maven.plugins:maven-dependency-plugin:2.8:get -Dartifact=org.apache.avro:avro-tools:1.11.0:jar -Ddest=avro-tools-1.11.0.jar The schema defined in the previous step, can be now compiled to produce a Java class ``ClickRecord.java`` in the ``io.aiven.avro.example`` package (taken from the ``namespace`` parameter): - .. code:: +.. code:: - java -jar avro-tools-1.11.0.jar compile schema ClickRecord.avsc . + java -jar avro-tools-1.11.0.jar compile schema ClickRecord.avsc . .. Note:: diff --git a/docs/products/kafka/kafka-connect/howto/gcp-bigquery-sink-prereq.rst b/docs/products/kafka/kafka-connect/howto/gcp-bigquery-sink-prereq.rst index 88b25ecd8b..9561da649a 100644 --- a/docs/products/kafka/kafka-connect/howto/gcp-bigquery-sink-prereq.rst +++ b/docs/products/kafka/kafka-connect/howto/gcp-bigquery-sink-prereq.rst @@ -15,7 +15,7 @@ To be able to sink data from Apache Kafka® to Google BigQuery via the dedicated Create a new Google service account and generate a JSON service key ------------------------------------------------------------------- -Follow the `instructions `_ to: +Follow the `instructions `_ to: * create a new Google service account * create a JSON service key diff --git a/docs/products/kafka/kafka-connect/howto/gcs-sink-prereq.rst b/docs/products/kafka/kafka-connect/howto/gcs-sink-prereq.rst index 5c15b843a2..2e95e5ae14 100644 --- a/docs/products/kafka/kafka-connect/howto/gcs-sink-prereq.rst +++ b/docs/products/kafka/kafka-connect/howto/gcs-sink-prereq.rst @@ -4,7 +4,7 @@ Configure GCP for a Google Cloud Storage sink connector To be able to sink data from Apache Kafka® to Google Cloud Storage via the dedicated Aiven connector, you need to perform the following steps in the `GCP console `_: * Create a `Google Cloud Storage (GCS) bucket `_ where the data is going to be stored -* Create a new `Google service account and generate a JSON service key `_ +* Create a new `Google service account and generate a JSON service key `_ * Grant the service account access to the GCS bucket .. _gcs-sink-connector-google-bucket: @@ -19,7 +19,7 @@ You can create the GCS bucket using the `dedicated Google cloud console page `_ to: +Follow the `instructions `_ to: * create a new Google service account * create a JSON service key diff --git a/docs/products/mysql/concepts/mysql-tuning-and-concurrency.rst b/docs/products/mysql/concepts/mysql-tuning-and-concurrency.rst index bcc106bc9a..47afc1744c 100644 --- a/docs/products/mysql/concepts/mysql-tuning-and-concurrency.rst +++ b/docs/products/mysql/concepts/mysql-tuning-and-concurrency.rst @@ -13,8 +13,10 @@ There are several key calculations which are fundamental to tuning: - Concurrency .. Important:: - | **Query output is for reference only** - | Queries should be run per service for accuracy and re-evaluated periodically for change. + + **Query output is for reference only** + + Queries should be run per service for accuracy and re-evaluated periodically for change. Service memory 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..c95e731562 100644 --- a/docs/products/mysql/howto/create-tables-without-primary-keys.rst +++ b/docs/products/mysql/howto/create-tables-without-primary-keys.rst @@ -8,14 +8,17 @@ If your Aiven for MySQL® service was created after 2020-06-03, by default it do 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. -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:: - - Unable to create or change a table without a primary key, when the system variable 'sql_require_primary_key' is set. Add a primary key to the table or unset this variable to avoid this message. Note that tables without a primary key can cause performance problems in row-based replication, so please consult your DBA before changing this setting. - -If creating tables without primary keys is prevented and the table that you're trying to create is known to be small, you may override this setting and create the table anyway. - + 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: + + .. code:: + + Unable to create or change a table without a primary key, when the system variable 'sql_require_primary_key' is set. Add a primary key to the table or unset this variable to avoid this message. Note that tables without a primary key can cause performance problems in row-based replication, so please consult your DBA before changing this setting. + + If creating tables without primary keys is prevented and the table that you're trying to create is known to be small, you may override this setting and create the table anyway. + .. seealso:: - You can read more about the MySQL replication in the :ref:`Replication overview ` article. + + You can read more about the MySQL replication in the :ref:`Replication overview ` article. You have two options to create the tables: @@ -32,9 +35,9 @@ You have two options to create the tables: 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**. - .. warning:: + .. warning:: - It is only recommended to use this approach when the table is created by an external application and using the session variable is not an option. To prevent more problematic tables from being unexpectedly created in the future you should enable the setting again once you finished creating the tables without primary keys. + It is only recommended to use this approach when the table is created by an external application and using the session variable is not an option. To prevent more problematic tables from being unexpectedly created in the future you should enable the setting again once you finished creating the tables without primary keys. .. seealso:: diff --git a/docs/products/postgresql/concepts/aiven-db-migrate.rst b/docs/products/postgresql/concepts/aiven-db-migrate.rst index 8992d793a8..2c51817e67 100644 --- a/docs/products/postgresql/concepts/aiven-db-migrate.rst +++ b/docs/products/postgresql/concepts/aiven-db-migrate.rst @@ -17,19 +17,19 @@ Migration requirements The following are the two basic requirements for a migration: -1. The source server is publicly available or there is a virtual private cloud (VPC) peering connection between the private networks -2. A user account with access to the destination cluster from an external IP, as configured in ``pg_hba.conf`` on the source cluster is present +#. The source server is publicly available or there is a virtual private cloud (VPC) peering connection between the private networks +#. A user account with access to the destination cluster from an external IP, as configured in ``pg_hba.conf`` on the source cluster is present. - Additionally to perform a **logical replication**, the following need to be valid: +Additionally to perform a **logical replication**, the following need to be valid: -3. PostgreSQL® version 10 or newer -4. Credentials with superuser access to the source cluster or the ``aiven-extras`` extension installed (see also: `Aiven Extras on GitHub `_) +#. PostgreSQL® version 10 or newer +#. Credentials with superuser access to the source cluster or the ``aiven-extras`` extension installed (see also: `Aiven Extras on GitHub `_) .. Note:: The ``aiven_extras`` extension allows you to perform publish/subscribe-style logical replication without a superuser account, and it is preinstalled on Aiven for PostgreSQL servers. -* An available replication slot on the destination cluster for each database migrated from the source cluster. -* ``wal_level`` setting on the source cluster to ``logical``. + * An available replication slot on the destination cluster for each database migrated from the source cluster. + * ``wal_level`` setting on the source cluster to ``logical``. Migration pre-checks '''''''''''''''''''' diff --git a/docs/products/postgresql/concepts/pgvector.rst b/docs/products/postgresql/concepts/pgvector.rst index 483b773b35..e8a6a119de 100644 --- a/docs/products/postgresql/concepts/pgvector.rst +++ b/docs/products/postgresql/concepts/pgvector.rst @@ -26,16 +26,11 @@ In most cases, vector similarity calculations use distance metrics, for example, How pgvector works ------------------ -Enabling pgvector - You enable the extension on your database. -Vectorizing data - You generate embeddings for your data, for example, for a products catalog using tools such as the `OpenAI API `_ client. -Storing embeddings - You store the embeddings in Aiven for PostgreSQL using the pgvector extension. -Querying embeddings - You use the embeddings for the vector similarity search on the products catalog. -Adding indices - By default, pgvector executes the *exact* nearest neighbor search, which gives the perfect recall. If you add an index to use the *approximate* nearest neighbor search, you can speed up your search, trading off some recall for performance. +- Enabling pgvector: You enable the extension on your database. +- Vectorizing data: You generate embeddings for your data, for example, for a products catalog using tools such as the `OpenAI API `_ client. +- Storing embeddings: You store the embeddings in Aiven for PostgreSQL using the pgvector extension. +- Querying embeddings: You use the embeddings for the vector similarity search on the products catalog. +- Adding indices: By default, pgvector executes the *exact* nearest neighbor search, which gives the perfect recall. If you add an index to use the *approximate* nearest neighbor search, you can speed up your search, trading off some recall for performance. Why use pgvector ---------------- @@ -55,8 +50,8 @@ There are multiple industry applications for similarity searches over vector emb .. topic:: Examples - * AI-powered tools can find similarities between products or transactions, which can be used to produce product recommendations or detect potential scams or frauds. - * Sentiment analysis: words represented with similar vector embeddings have similar sentiment scores. + * AI-powered tools can find similarities between products or transactions, which can be used to produce product recommendations or detect potential scams or frauds. + * Sentiment analysis: words represented with similar vector embeddings have similar sentiment scores. What's next ----------- diff --git a/docs/products/postgresql/getting-started.rst b/docs/products/postgresql/getting-started.rst index ced9d82f8f..1afcd113f4 100644 --- a/docs/products/postgresql/getting-started.rst +++ b/docs/products/postgresql/getting-started.rst @@ -46,9 +46,9 @@ If you're checking out PostgreSQL, loading a test dataset will give you somethin \c dellstore -.. Tip:: + .. Tip:: - Your ``psql`` terminal prefix will change to ``dellstore==>`` when you are connected to the correct database. + Your ``psql`` terminal prefix will change to ``dellstore==>`` when you are connected to the correct database. 5. Populate the database by executing the following command from ``psql``: @@ -83,15 +83,16 @@ The output should look like this: public | reorder | table | avnadmin (12 rows) -Further reading ----------------- -Here are some more resources to help you on your PostgreSQL journey: +.. seealso:: -* Code examples for connecting to PostgreSQL from your application: - * :doc:`Go ` - * :doc:`Python ` -* How to :doc:`use PgAdmin ` with Aiven for PostgreSQL -* How to :doc:`migrate your PostgreSQL to Aiven ` -* Learn PostgreSQL with some `PostgreSQL Exercises `_ -* The `awesome PostgreSQL ecosystem `_ of tools and solutions + - Code examples for connecting to PostgreSQL from your application: + + - :doc:`Go ` + - :doc:`Python ` + + - How to :doc:`use PgAdmin ` with Aiven for PostgreSQL + - How to :doc:`migrate your PostgreSQL to Aiven ` + - Learn PostgreSQL with some `PostgreSQL Exercises `_ + - The `awesome PostgreSQL ecosystem `_ of tools and solutions + \ No newline at end of file diff --git a/docs/products/postgresql/howto.rst b/docs/products/postgresql/howto.rst index 4f66fe0051..afa94322d6 100644 --- a/docs/products/postgresql/howto.rst +++ b/docs/products/postgresql/howto.rst @@ -64,7 +64,7 @@ Aiven for PostgreSQL® how-tos - :doc:`Monitor PostgreSQL metrics with Grafana® ` - :doc:`Monitor PostgreSQL metrics with pgwatch2 ` - :doc:`Visualize data with Grafana® ` - - :doc:`Report and analyze with Google Data Studio ` + - :doc:`Report and analyze with Google Looker Studio ` - :doc:`Integrate two PostgreSQL services ` .. dropdown:: Cluster management diff --git a/docs/products/postgresql/howto/analyze-with-google-data-studio.rst b/docs/products/postgresql/howto/analyze-with-google-data-studio.rst index e6e9f1870a..527b7cfd07 100644 --- a/docs/products/postgresql/howto/analyze-with-google-data-studio.rst +++ b/docs/products/postgresql/howto/analyze-with-google-data-studio.rst @@ -1,12 +1,12 @@ -Report and analyze with Google Data Studio -========================================== +Report and analyze with Google Looker Studio +============================================ -Google Data Studio allows you to create reports and visualisations of the data in your Aiven for PostgreSQL® database, and combine these with data from many other data sources. +Google Looker Studio (previously Data Studio) allows you to create reports and visualisations of the data in your Aiven for PostgreSQL® database, and combine these with data from many other data sources. Variables --------- -These are the values you will need to connect to Google Data Studio: +These are the values you will need to connect to Google Looker Studio: ================== =========================================================================== Variable Description @@ -20,14 +20,14 @@ Variable Description Pre-requisites -------------- -1. You will need a Google account, to access Google Data Studio. +1. You will need a Google account, to access Google Looker Studio. 2. On the Aiven Console service page for your PostgreSQL database, download the CA certificate. The default filename is ``ca.pem``. -Connect your Aiven for PostgreSQL data source to Google Data Studio -------------------------------------------------------------------- +Connect your Aiven for PostgreSQL data source to Google Looker Studio +--------------------------------------------------------------------- -#. Login to Google and open `Google Data Studio `__ . +#. Login to Google and open `Google Looker Studio `__ . #. Select **Create** and choose **Data source**. diff --git a/docs/products/postgresql/howto/list-integrations.rst b/docs/products/postgresql/howto/list-integrations.rst index 202d99e7ab..77b4fd31a0 100644 --- a/docs/products/postgresql/howto/list-integrations.rst +++ b/docs/products/postgresql/howto/list-integrations.rst @@ -19,7 +19,7 @@ Aiven for PostgreSQL® integrations :shadow: md :margin: 2 2 0 0 - .. grid-item-card:: :doc:`Report and analyze with Google Data Studio ` + .. grid-item-card:: :doc:`Report and analyze with Google Looker Studio ` :shadow: md :margin: 2 2 0 0 diff --git a/docs/tools/aiven-console/howto/create-manage-teams.rst b/docs/tools/aiven-console/howto/create-manage-teams.rst index 2e72057bab..921ddc1392 100644 --- a/docs/tools/aiven-console/howto/create-manage-teams.rst +++ b/docs/tools/aiven-console/howto/create-manage-teams.rst @@ -7,7 +7,7 @@ Create and manage teams .. important:: **Teams are becoming groups** - :doc:`Groups ` are an easier way to control access to your organization's projects and services for a group of users. + Groups are an easier way to control access to your organization's projects and services for a group of users. See :ref:`migrate_teams_to_groups`. Create a new team From eb1269431127382d7e700806ce75276b2fa868c0 Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Thu, 7 Dec 2023 14:32:31 +0100 Subject: [PATCH 50/55] fix host --- docs/platform/reference/service-ip-address.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/platform/reference/service-ip-address.rst b/docs/platform/reference/service-ip-address.rst index 8070b820c3..66a4103916 100644 --- a/docs/platform/reference/service-ip-address.rst +++ b/docs/platform/reference/service-ip-address.rst @@ -1,8 +1,8 @@ Default service IP address and hostname -========================================= +======================================= Default service IP address ----------------------------- +-------------------------- When a new Aiven service is created, the chosen cloud service provider will dynamically assign one or more public IP address from their connection pool. This IP address is not permanent, and with every service maintenance (in case of failover, maintenance upgrade or cloud migration) the IP address changes since Aiven creates a new node, migrates the existing data to it and then retire the old node. @@ -19,14 +19,15 @@ When a new service is being provisioned, its hostname is defined as follows: .. code:: - -.aivencloud.com + -.*.aivencloud.com -where: +where * ```` is the name of the service * ```` is the name of the project +* ``*`` is a variable component .. Note:: - If the ```` is too short or was recently used (e.g. if you drop and recreate a service with the same name) then the hostname format could be ``<3RANDOMLETTERS>-.aivencloud.com`` + If the ```` is too short or was recently used (for example, if you drop and recreate a service with the same name), the hostname format could be ``<3RANDOMLETTERS>-.*.aivencloud.com``. From 2bc860f4caf3f746c8a70970a190560b10dea5e2 Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Thu, 7 Dec 2023 14:40:02 +0100 Subject: [PATCH 51/55] fix host --- docs/platform/reference/service-ip-address.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platform/reference/service-ip-address.rst b/docs/platform/reference/service-ip-address.rst index 66a4103916..ab8c58c91b 100644 --- a/docs/platform/reference/service-ip-address.rst +++ b/docs/platform/reference/service-ip-address.rst @@ -26,7 +26,7 @@ where * ```` is the name of the service * ```` is the name of the project -* ``*`` is a variable component +* ``*`` is a variable component consisting of one or more letters of alphanumeric subdomains .. Note:: From 09c5fda5b22f30a621187d91e59d5a3fc0d3c69f Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Thu, 7 Dec 2023 14:53:50 +0100 Subject: [PATCH 52/55] fix host --- docs/platform/reference/service-ip-address.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/platform/reference/service-ip-address.rst b/docs/platform/reference/service-ip-address.rst index ab8c58c91b..148ec2136b 100644 --- a/docs/platform/reference/service-ip-address.rst +++ b/docs/platform/reference/service-ip-address.rst @@ -26,7 +26,15 @@ where * ```` is the name of the service * ```` is the name of the project -* ``*`` is a variable component consisting of one or more letters of alphanumeric subdomains +* ``*`` is a variable component consisting of one or more levels of alphanumeric subdomains for the purpose of load balancing between DNS zones. + +.. note:: + + * Second-level domain part of ``aivencloud.com`` might change to another name in the future if the domain becomes unavailable for updates. + +.. important:: + + Always use a fully-qualified domain name returned by Aiven API. Make sure your code doesn't put any constraints on the domain part or format of the returned service hostname. .. Note:: From 600083c74badbb82ae718eb699bf30fadb49857a Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Thu, 7 Dec 2023 15:49:28 +0100 Subject: [PATCH 53/55] fix host --- docs/platform/reference/service-ip-address.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platform/reference/service-ip-address.rst b/docs/platform/reference/service-ip-address.rst index 148ec2136b..5665fea808 100644 --- a/docs/platform/reference/service-ip-address.rst +++ b/docs/platform/reference/service-ip-address.rst @@ -30,7 +30,7 @@ where .. note:: - * Second-level domain part of ``aivencloud.com`` might change to another name in the future if the domain becomes unavailable for updates. + Second-level domain part of ``aivencloud.com`` might change to another name in the future if the domain becomes unavailable for updates. .. important:: From ba90813a86018a455bcc03f9b07b85e4e720f22c Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Fri, 8 Dec 2023 09:58:33 +0100 Subject: [PATCH 54/55] Update cloud regions --- docs/platform/concepts/free-plan.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/platform/concepts/free-plan.rst b/docs/platform/concepts/free-plan.rst index 081abf170d..c4ae5e5ba8 100644 --- a/docs/platform/concepts/free-plan.rst +++ b/docs/platform/concepts/free-plan.rst @@ -23,11 +23,11 @@ Free plans include: * Monitoring for metrics and logs * Backups * Integrations between different Aiven services including free, paid, and trial services -* AWS hosting in a limited number of regions: +* DigitalOcean hosting in a limited number of regions: - * EMEA: aws-eu-north-1, aws-eu-west-1, aws-eu-west-2, aws-eu-west-3 - * Americas: aws-us-east-1, aws-us-east-2, aws-us-west-2, aws-ca-central-1 - * APAC: aws-ap-south-1 + * EMEA: do-ams (Amsterdam), do-ldn (London), do-fra (Frankfurt) + * Americas: do-nyc (New York), do-sfo (San Francisco), do-tor (Toronto) + * APAC: do-blr (Bangalore) There are some limitations of the free plan services: @@ -36,7 +36,7 @@ There are some limitations of the free plan services: * No forking * For PostgreSQL: no connection pooling * Support only through the `Aiven Community Forum `_ -* Only a limited number of AWS regions, no other cloud providers +* Only a limited number of DigitalOcean regions, no other cloud providers * Only one service per service type per user and :doc:`organization ` * Not covered under Aiven's 99.99% SLA From 52e5abf907bedc03aabcebc89d92428161e9d92c Mon Sep 17 00:00:00 2001 From: Arthur <28596581+ArthurFlageul@users.noreply.github.com> Date: Fri, 8 Dec 2023 12:31:50 +0100 Subject: [PATCH 55/55] remove container (#2335) --- docs/platform/howto/saml/setup-saml-auth0.rst | 23 +- .../reference/eol-for-major-versions.rst | 287 ++++++++-------- .../reference/list-of-extensions.rst | 306 +++++------------- docs/tools/aiven-console.rst | 2 +- docs/tools/terraform/get-started.rst | 175 +++++----- 5 files changed, 315 insertions(+), 478 deletions(-) diff --git a/docs/platform/howto/saml/setup-saml-auth0.rst b/docs/platform/howto/saml/setup-saml-auth0.rst index d6dd1a705b..8bfc877c99 100644 --- a/docs/platform/howto/saml/setup-saml-auth0.rst +++ b/docs/platform/howto/saml/setup-saml-auth0.rst @@ -42,15 +42,15 @@ Configure SAML on Auth0 10. In the **Settings** section for the Application Callback URL, remove the existing configuration and add the following field mapping configuration: -.. code-block:: shell - - { - "email": "email", - "first_name": "first_name", - "identity": "email", - "last_name": "last_name", - "mapUnknownClaimsAsIs": true - } + .. code-block:: shell + + { + "email": "email", + "first_name": "first_name", + "identity": "email", + "last_name": "last_name", + "mapUnknownClaimsAsIs": true + } 11. Click **Enable** and **Save**. @@ -81,8 +81,9 @@ Go back to the **Authentication** page in `Aiven Console `_ is Aiven's service offering for Elasticsearch. -.. container:: intercom-interblocks-table-container - - - +-------------+---------------+--------------------+ - | **Version** | **Aiven EOL** | **Upstream EOL** | - | | | | - +-------------+---------------+--------------------+ - | 2.x | 2020-10-30 | 2018-02-28 | - +-------------+---------------+--------------------+ - | 5.x | 2020-10-30 | 2019-03-11 | - +-------------+---------------+--------------------+ - | 6.x | 2020-11-20 | 2020-11-20 | - +-------------+---------------+--------------------+ - | 7.x | 2022-03-23 | 2022-05-11 (v7.10) | - +-------------+---------------+--------------------+ ++-------------+---------------+--------------------+ +| **Version** | **Aiven EOL** | **Upstream EOL** | +| | | | ++-------------+---------------+--------------------+ +| 2.x | 2020-10-30 | 2018-02-28 | ++-------------+---------------+--------------------+ +| 5.x | 2020-10-30 | 2019-03-11 | ++-------------+---------------+--------------------+ +| 6.x | 2020-11-20 | 2020-11-20 | ++-------------+---------------+--------------------+ +| 7.x | 2022-03-23 | 2022-05-11 (v7.10) | ++-------------+---------------+--------------------+ Aiven for OpenSearch® @@ -56,20 +53,17 @@ Aiven for OpenSearch® Aiven for OpenSearch® is the open source continuation of the original Elasticsearch service. -.. container:: intercom-interblocks-table-container - ++-------------+------------------------+------------------+------------------+ +| **Version** | **Aiven EOL** | **Availability | **Upstream EOL** | +| | | end on Aiven | | +| | | Platform** | | ++-------------+------------------------+------------------+------------------+ +| 1.x | `TBA*` | `TBA*` | `TBA*` | ++-------------+------------------------+------------------+------------------+ +| 2.x | `TBA*` | `TBA*` | `TBA*` | ++-------------+------------------------+------------------+------------------+ - +-------------+------------------------+------------------+------------------+ - | **Version** | **Aiven EOL** | **Availability | **Upstream EOL** | - | | | end on Aiven | | - | | | Platform** | | - +-------------+------------------------+------------------+------------------+ - | 1.x | `TBA*` | `TBA*` | `TBA*` | - +-------------+------------------------+------------------+------------------+ - | 2.x | `TBA*` | `TBA*` | `TBA*` | - +-------------+------------------------+------------------+------------------+ - - `*` To be announced +`*` To be announced .. note:: The EOL for Aiven for OpenSearch® is generally dependent on the upstream project. @@ -81,29 +75,27 @@ Aiven for PostgreSQL® Aiven for PostgreSQL® major versions will reach EOL on the same date as the upstream open source project's EOL . -.. container:: intercom-interblocks-table-container - - +-------------+---------------+------------------+------------------+ - | **Version** | **Aiven EOL** | **Availability | **Availability | - | | | end on Aiven | start on Aiven | - | | | Platform** | Platform** | - +-------------+---------------+------------------+------------------+ - | 9.5 | 2021-04-15 | 2021-01-26 | 2015-12-22 | - +-------------+---------------+------------------+------------------+ - | 9.6 | 2021-11-11 | 2021-05-11 | 2016-09-29 | - +-------------+---------------+------------------+------------------+ - | 10 | 2022-11-10 | 2022-05-10 | 2017-01-14 | - +-------------+---------------+------------------+------------------+ - | 11 | 2023-11-09 | 2023-05-09 | 2017-03-06 | - +-------------+---------------+------------------+------------------+ - | 12 | 2024-11-14 | 2024-05-14 | 2019-11-18 | - +-------------+---------------+------------------+------------------+ - | 13 | 2025-11-13 | 2025-05-13 | 2021-02-15 | - +-------------+---------------+------------------+------------------+ - | 14 | 2026-11-12 | 2026-05-12 | 2021-11-11 | - +-------------+---------------+------------------+------------------+ - | 15 | 2027-11-11 | 2027-05-12 | 2022-12-12 | - +-------------+---------------+------------------+------------------+ ++-------------+---------------+------------------+------------------+ +| **Version** | **Aiven EOL** | **Availability | **Availability | +| | | end on Aiven | start on Aiven | +| | | Platform** | Platform** | ++-------------+---------------+------------------+------------------+ +| 9.5 | 2021-04-15 | 2021-01-26 | 2015-12-22 | ++-------------+---------------+------------------+------------------+ +| 9.6 | 2021-11-11 | 2021-05-11 | 2016-09-29 | ++-------------+---------------+------------------+------------------+ +| 10 | 2022-11-10 | 2022-05-10 | 2017-01-14 | ++-------------+---------------+------------------+------------------+ +| 11 | 2023-11-09 | 2023-05-09 | 2017-03-06 | ++-------------+---------------+------------------+------------------+ +| 12 | 2024-11-14 | 2024-05-14 | 2019-11-18 | ++-------------+---------------+------------------+------------------+ +| 13 | 2025-11-13 | 2025-05-13 | 2021-02-15 | ++-------------+---------------+------------------+------------------+ +| 14 | 2026-11-12 | 2026-05-12 | 2021-11-11 | ++-------------+---------------+------------------+------------------+ +| 15 | 2027-11-11 | 2027-05-12 | 2022-12-12 | ++-------------+---------------+------------------+------------------+ .. _aiven-for-kafka: @@ -113,49 +105,47 @@ Aiven for Apache Kafka® Starting with v2.5, Aiven for Kafka® ``major.minor`` version will reach EOL one year after it's made available on Aiven platform. -.. container:: intercom-interblocks-table-container - - +-------------+---------------+------------------+------------------+ - | **Version** | **Aiven EOL** | **Availability | **Availability | - | | | end on Aiven | start on Aiven | - | | | Platform** | Platform** | - +-------------+---------------+------------------+------------------+ - | 1.0.x | 2021-02-01 | | 2017-11-01 | - +-------------+---------------+------------------+------------------+ - | 1.1.x | 2021-02-01 | | 2018-07-31 | - +-------------+---------------+------------------+------------------+ - | 2.0.x | 2021-02-01 | | 2018-07-30 | - +-------------+---------------+------------------+------------------+ - | 2.1.x | 2021-02-01 | | 2018-12-04 | - +-------------+---------------+------------------+------------------+ - | 2.2.x | 2021-02-01 | | 2019-04-19 | - +-------------+---------------+------------------+------------------+ - | 2.3.x | 2021-08-13 | 2021-08-13 | 2019-09-05 | - +-------------+---------------+------------------+------------------+ - | 2.4.x | 2021-08-13 | 2021-08-13 | 2019-10-21 | - +-------------+---------------+------------------+------------------+ - | 2.5.x | 2021-08-13 | 2021-08-13 | 2020-05-05 | - +-------------+---------------+------------------+------------------+ - | 2.6.x | 2021-08-13 | 2021-08-13 | 2020-08-13 | - +-------------+---------------+------------------+------------------+ - | 2.7.x | 2022-01-24 | 2021-10-21 | 2021-01-21 | - +-------------+---------------+------------------+------------------+ - | 2.8.x | 2022-06-02 | 2022-01-26 | 2021-04-26 | - +-------------+---------------+------------------+------------------+ - | 3.0 | 2022-11-22 | 2022-07-04 | 2021-11-22 | - +-------------+---------------+------------------+------------------+ - | 3.1 | 2023-02-14 | 2022-10-26 | 2022-02-14 | - +-------------+---------------+------------------+------------------+ - | 3.2 | 2023-06-27 | 2023-03-28 | 2022-06-21 | - +-------------+---------------+------------------+------------------+ - | 3.3 | 2023-12-12 | 2023-09-12 | 2022-12-23 | - +-------------+---------------+------------------+------------------+ - | 3.4 | 2024-05-13 | 2024-02-13 | 2023-05-09 | - +-------------+---------------+------------------+------------------+ - | 3.5 | 2024-07-31 | 2024-03-30 | 2023-07-31 | - +-------------+---------------+------------------+------------------+ - | 3.6 | 2024-10-18 | 2024-07-18 | 2023-10-18 | - +-------------+---------------+------------------+------------------+ ++-------------+---------------+------------------+------------------+ +| **Version** | **Aiven EOL** | **Availability | **Availability | +| | | end on Aiven | start on Aiven | +| | | Platform** | Platform** | ++-------------+---------------+------------------+------------------+ +| 1.0.x | 2021-02-01 | | 2017-11-01 | ++-------------+---------------+------------------+------------------+ +| 1.1.x | 2021-02-01 | | 2018-07-31 | ++-------------+---------------+------------------+------------------+ +| 2.0.x | 2021-02-01 | | 2018-07-30 | ++-------------+---------------+------------------+------------------+ +| 2.1.x | 2021-02-01 | | 2018-12-04 | ++-------------+---------------+------------------+------------------+ +| 2.2.x | 2021-02-01 | | 2019-04-19 | ++-------------+---------------+------------------+------------------+ +| 2.3.x | 2021-08-13 | 2021-08-13 | 2019-09-05 | ++-------------+---------------+------------------+------------------+ +| 2.4.x | 2021-08-13 | 2021-08-13 | 2019-10-21 | ++-------------+---------------+------------------+------------------+ +| 2.5.x | 2021-08-13 | 2021-08-13 | 2020-05-05 | ++-------------+---------------+------------------+------------------+ +| 2.6.x | 2021-08-13 | 2021-08-13 | 2020-08-13 | ++-------------+---------------+------------------+------------------+ +| 2.7.x | 2022-01-24 | 2021-10-21 | 2021-01-21 | ++-------------+---------------+------------------+------------------+ +| 2.8.x | 2022-06-02 | 2022-01-26 | 2021-04-26 | ++-------------+---------------+------------------+------------------+ +| 3.0 | 2022-11-22 | 2022-07-04 | 2021-11-22 | ++-------------+---------------+------------------+------------------+ +| 3.1 | 2023-02-14 | 2022-10-26 | 2022-02-14 | ++-------------+---------------+------------------+------------------+ +| 3.2 | 2023-06-27 | 2023-03-28 | 2022-06-21 | ++-------------+---------------+------------------+------------------+ +| 3.3 | 2023-12-12 | 2023-09-12 | 2022-12-23 | ++-------------+---------------+------------------+------------------+ +| 3.4 | 2024-05-13 | 2024-02-13 | 2023-05-09 | ++-------------+---------------+------------------+------------------+ +| 3.5 | 2024-07-31 | 2024-03-30 | 2023-07-31 | ++-------------+---------------+------------------+------------------+ +| 3.6 | 2024-10-18 | 2024-07-18 | 2023-10-18 | ++-------------+---------------+------------------+------------------+ .. _h_0f2929c770: @@ -166,36 +156,33 @@ Aiven for Apache Cassandra® Starting with v4, Aiven for Cassandra® ``major`` version will reach EOL six months after it's made available on Aiven platform. -.. container:: intercom-interblocks-table-container - +-------------+---------------+------------------+------------------+ - | **Version** | **Aiven EOL** | **Availability | **Availability | - | | | end on Aiven | start on Aiven | - | | | Platform** | Platform** | - +-------------+---------------+------------------+------------------+ - | 3 | 2022-07-27 | 2022-04-27 | 2018-11-08 | - +-------------+---------------+------------------+------------------+ - | 4 | N/A | N/A | 2021-12-09 | - +-------------+---------------+------------------+------------------+ ++-------------+---------------+------------------+------------------+ +| **Version** | **Aiven EOL** | **Availability | **Availability | +| | | end on Aiven | start on Aiven | +| | | Platform** | Platform** | ++-------------+---------------+------------------+------------------+ +| 3 | 2022-07-27 | 2022-04-27 | 2018-11-08 | ++-------------+---------------+------------------+------------------+ +| 4 | N/A | N/A | 2021-12-09 | ++-------------+---------------+------------------+------------------+ Aiven for M3DB '''''''''''''' Starting from v1.5, Aiven for M3DB version will reach EOL six months after **newer major/minor version** is made available on Aiven platform. -.. container:: intercom-interblocks-table-container - - +-------------+---------------+------------------+------------------+ - | **Version** | **Aiven EOL** | **Availability | **Availability | - | | | end on Aiven | start on Aiven | - | | | Platform** | Platform** | - +-------------+---------------+------------------+------------------+ - | 1.1 | 2023-09-01 | 2023-06-01 | 2021-02-23 | - +-------------+---------------+------------------+------------------+ - | 1.2 | 2023-09-01 | 2023-06-01 | 2021-10-11 | - +-------------+---------------+------------------+------------------+ - | 1.5 | N/A | N/A | 2022-05-05 | - +-------------+---------------+------------------+------------------+ ++-------------+---------------+------------------+------------------+ +| **Version** | **Aiven EOL** | **Availability | **Availability | +| | | end on Aiven | start on Aiven | +| | | Platform** | Platform** | ++-------------+---------------+------------------+------------------+ +| 1.1 | 2023-09-01 | 2023-06-01 | 2021-02-23 | ++-------------+---------------+------------------+------------------+ +| 1.2 | 2023-09-01 | 2023-06-01 | 2021-10-11 | ++-------------+---------------+------------------+------------------+ +| 1.5 | N/A | N/A | 2022-05-05 | ++-------------+---------------+------------------+------------------+ EOL policy for major versions ''''''''''''''''''''''''''''' @@ -248,47 +235,41 @@ Alongside `Aiven Console `_, Aiven offers multiple to Aiven CLI ''''''''' -.. container:: intercom-interblocks-table-container - - +-------------+---------------+ - | **Version** | **Aiven EOL** | - | | | - +-------------+---------------+ - | 1.x | 2023-12-11 | - +-------------+---------------+ - | 2.x | 2023-12-11 | - +-------------+---------------+ - | 3.x | 2023-12-11 | - +-------------+---------------+ - | 4.x | `TBA*` | - +-------------+---------------+ ++-------------+---------------+ +| **Version** | **Aiven EOL** | +| | | ++-------------+---------------+ +| 1.x | 2023-12-11 | ++-------------+---------------+ +| 2.x | 2023-12-11 | ++-------------+---------------+ +| 3.x | 2023-12-11 | ++-------------+---------------+ +| 4.x | `TBA*` | ++-------------+---------------+ Aiven Terraform provider '''''''''''''''''''''''' -.. container:: intercom-interblocks-table-container - - +-------------+---------------+ - | **Version** | **Aiven EOL** | - | | | - +-------------+---------------+ - | 1.x | 2023-12-31 | - +-------------+---------------+ - | 2.x | 2023-12-31 | - +-------------+---------------+ - | 3.x | 2023-12-31 | - +-------------+---------------+ - | 4.x | `TBA*` | - +-------------+---------------+ ++-------------+---------------+ +| **Version** | **Aiven EOL** | +| | | ++-------------+---------------+ +| 1.x | 2023-12-31 | ++-------------+---------------+ +| 2.x | 2023-12-31 | ++-------------+---------------+ +| 3.x | 2023-12-31 | ++-------------+---------------+ +| 4.x | `TBA*` | ++-------------+---------------+ Aiven Kubernetes operator ''''''''''''''''''''''''' -.. container:: intercom-interblocks-table-container - - +-------------+---------------+ - | **Version** | **Aiven EOL** | - | | | - +-------------+---------------+ - | 0.x | `TBA*` | - +-------------+---------------+ ++-------------+---------------+ +| **Version** | **Aiven EOL** | +| | | ++-------------+---------------+ +| 0.x | `TBA*` | ++-------------+---------------+ diff --git a/docs/products/postgresql/reference/list-of-extensions.rst b/docs/products/postgresql/reference/list-of-extensions.rst index 98ff081de9..ab742d0078 100644 --- a/docs/products/postgresql/reference/list-of-extensions.rst +++ b/docs/products/postgresql/reference/list-of-extensions.rst @@ -13,216 +13,103 @@ To check the details, including the version number of the extension, run ``selec .. |PG14only| replace:: :bdg-secondary:`PG14 only` .. note:: - Not all extensions listed in ``pg_available_extensions`` are able to be installed. See :ref:`Superuser-only Extensions` for more. + + Not all extensions listed in ``pg_available_extensions`` are able to be installed. See :ref:`Superuser-only Extensions` for more. Data types ---------- -``chkpass`` - https://www.postgresql.org/docs/10/chkpass.html - Data type for auto-encrypted passwords. |PG10only| - -``citext`` - https://www.postgresql.org/docs/current/citext.html - Data type for case-insensitive character strings. - -``cube`` - https://www.postgresql.org/docs/current/cube.html - Data type for multidimensional cubes. - -``hll`` - https://github.com/citusdata/postgresql-hll - Type for storing ``hyperloglog`` data. |PG11onwards| - -``hstore`` - https://www.postgresql.org/docs/current/hstore.html - Data type for storing sets of (key, value) pairs. - -``isn`` - https://www.postgresql.org/docs/current/isn.html - Data types for international product numbering standards. - -``ltree`` - https://www.postgresql.org/docs/current/ltree.html - Data type for hierarchical tree-like structures. - -``pgvector`` - https://github.com/pgvector/pgvector - Type for vector similarity search. |PG13onwards| - -``seg`` - https://www.postgresql.org/docs/current/seg.html - Data type for representing line segments or floating-point intervals. - -``timescaledb`` - https://github.com/timescale/timescaledb - Enables scalable inserts and complex queries for time-series data. - -``unit`` - https://github.com/df7cb/postgresql-unit - SI units extension. - -``uuid-ossp`` - https://www.postgresql.org/docs/current/uuid-ossp.html - Generate universally unique identifiers (UUIDs). +- `chkpass `__. Data type for auto-encrypted passwords. |PG10only| +- `citext `__. Data type for case-insensitive character strings. +- `cube `__. Data type for multidimensional cubes. +- `hll `__. Type for storing ``hyperloglog`` data. |PG11onwards| +- `hstore `__. Data type for storing sets of (key, value) pairs. +- `isn `__. Data types for international product numbering standards. +- `ltree `__. Data type for hierarchical tree-like structures. +- `pgvector `__. Type for vector similarity search. |PG13onwards| +- `seg `__. Data type for representing line segments or floating-point intervals. +- `timescaledb `__. Enables scalable inserts and complex queries for time-series data. +- `unit `__. SI units extension. +- `uuid-ossp `__. Generate universally unique identifiers (UUIDs). Search and text handling ------------------------ -``bloom`` - https://www.postgresql.org/docs/current/bloom.html - Bloom access method - signature file based index. - -``btree_gin`` - https://www.postgresql.org/docs/current/btree-gin.html - Support for indexing common data types in GIN. - -``btree_gist`` - https://www.postgresql.org/docs/current/btree-gist.html - Support for indexing common data types in GiST. - -``dict_int`` - https://www.postgresql.org/docs/current/dict-int.html - Text search dictionary template for integers. - -``fuzzystrmatch`` - https://www.postgresql.org/docs/current/fuzzystrmatch.html - Determine similarities and distance between strings. - -``pg_similarity`` - https://github.com/eulerto/pg_similarity - Support similarity queries. |PG13onwards| - -``pg_trgm`` - https://www.postgresql.org/docs/current/pgtrgm.html - Text similarity measurement and index searching based on trigrams. - -``pgcrypto`` - https://www.postgresql.org/docs/current/pgcrypto.html - Cryptographic functions. - -``rum`` - https://github.com/postgrespro/rum - RUM index access method. - -``unaccent`` - https://www.postgresql.org/docs/current/unaccent.html - Text search dictionary that removes accents. +- `bloom `__. Bloom access method - signature file based index. +- `btree_gin `__. Support for indexing common data types in GIN. +- `btree_gist `__. Support for indexing common data types in GiST. +- `dict_int `__. Text search dictionary template for integers. +- `fuzzystrmatch `__. Determine similarities and distance between strings. +- `pg_similarity `__. Support similarity queries. |PG13onwards| +- `pg_trgm `__. Text similarity measurement and index searching based on trigrams. +- `pgcrypto `__. Cryptographic functions. +- `rum `__. RUM index access method. +- `unaccent `__. Text search dictionary that removes accents. Auditing ------------------------ -``tcn`` - https://www.postgresql.org/docs/current/tcn.html - Triggered change notifications. +- `tcn `__. Triggered change notifications. Geographical features --------------------- -``address_standardizer`` - https://postgis.net/docs/standardize_address.html - Used to parse an address into constituent elements. Generally used to support geocoding address normalization step. - -``address_standardizer_data_us`` - https://postgis.net/docs/standardize_address.html - ``Address standardizer`` US dataset example. - -``earthdistance`` - https://www.postgresql.org/docs/current/earthdistance.html - Calculate great-circle distances on the surface of the Earth. - -``pgrouting`` - https://github.com/pgRouting/pgrouting - Extends the PostGIS/PostgreSQL geospatial database to provide geospatial routing and other network analysis functionality. - -``postgis`` - https://postgis.net/ - PostGIS geometry and geography spatial types and functions. - -``postgis_legacy`` - https://postgis.net/ - Legacy functions for PostGIS. - -``postgis_raster`` - https://postgis.net/docs/RT_reference.html - PostGIS raster types and functions. - -``postgis_sfcgal`` - http://postgis.net/docs/reference.html#reference_sfcgal - PostGIS SFCGAL functions. - -``postgis_tiger_geocoder`` - https://postgis.net/docs/Extras.html#Tiger_Geocoder - PostGIS tiger geocoder and reverse geocoder. - -``postgis_topology`` - https://postgis.net/docs/Topology.html - PostGIS topology spatial types and functions. +- `address_standardizer `__. Used to parse an address into constituent elements. Generally used to support geocoding address normalization step. +- `address_standardizer_data_us `__. ``Address standardizer`` US dataset example. +- `earthdistance `__. Calculate great-circle distances on the surface of the Earth. +- `pgrouting `__. Extends the PostGIS/PostgreSQL geospatial database to provide geospatial routing and other network analysis functionality. +- `postgis `__. PostGIS geometry and geography spatial types and functions. +- `postgis_legacy `__. Legacy functions for PostGIS. +- `postgis_raster `__. PostGIS raster types and functions. +- ``postgis_sfcgal`` - http://postgis.net/docs/reference.html#reference_sfcgal. PostGIS SFCGAL functions. +- `postgis_tiger_geocoder `__. PostGIS tiger geocoder and reverse geocoder. +- `postgis_topology `__. PostGIS topology spatial types and functions. Procedural language ------------------- -``plcoffee`` - https://github.com/plv8/plv8 - PL/CoffeeScript (v8) trusted procedural language. |PG10only| - -``plls`` - https://github.com/plv8/plv8 - PL/LiveScript (v8) trusted procedural language. |PG10only| - -``plperl`` - https://www.postgresql.org/docs/current/plperl.html - PL/Perl procedural language. - -``plpgsql`` - https://www.postgresql.org/docs/current/plpgsql.html - PL/pgSQL procedural language. - -``plv8`` - https://github.com/plv8/plv8 - PL/JavaScript (v8) trusted procedural language. |PG10only| +- `plcoffee `__. PL/CoffeeScript (v8) trusted procedural language. |PG10only| +- `plls `__. PL/LiveScript (v8) trusted procedural language. |PG10only| +- `plperl `__. PL/Perl procedural language. +- `plpgsql `__. PL/pgSQL procedural language. +- `plv8 `__. PL/JavaScript (v8) trusted procedural language. |PG10only| Connectivity ------------ -``dblink`` - https://www.postgresql.org/docs/current/contrib-dblink-function.html - Connect to other PostgreSQL databases from within a database. +- `dblink `__. Connect to other PostgreSQL databases from within a database. -``postgres_fdw`` - https://www.postgresql.org/docs/current/postgres-fdw.html - Foreign-data wrapper for remote PostgreSQL servers. +- `postgres_fdw `__. Foreign-data wrapper for remote PostgreSQL servers. Utilities --------- -``aiven_extras`` - https://github.com/aiven/aiven-extras - This extension is meant for use in environments where you want non-superusers to be able to use certain database features. - -``bool_plperl`` - https://www.postgresql.org/docs/current/plperl-funcs.html - Transform between ``bool`` and ``plperl``. |PG13onwards| - -``intagg`` - https://www.postgresql.org/docs/current/intagg.html - Integer aggregator and enumerator (obsolete). - -``intarray`` - https://www.postgresql.org/docs/current/intarray.html - Functions, operators, and index support for 1-D arrays of integers. - -``jsonb_plperl`` - https://www.postgresql.org/docs/current/datatype-json.html - Transform between ``jsonb`` and ``plperl``. - -``lo`` - https://www.postgresql.org/docs/current/lo.html - Large Object maintenance. - -``pageinspect`` - https://www.postgresql.org/docs/current/pageinspect.html - Inspect the contents of database pages at a low level. - -``pg_buffercache`` - https://www.postgresql.org/docs/current/pgbuffercache.html - Examine the shared buffer cache. - -``pg_cron`` - https://github.com/citusdata/pg_cron - Job scheduler for PostgreSQL. - -``pg_partman`` - https://github.com/pgpartman/pg_partman - Extension to manage partitioned tables by time or ID. - -``pg_prewarm`` - https://www.postgresql.org/docs/current/pgprewarm.html - Prewarm relation data. |PG11onwards| - -``pg_prometheus`` - https://github.com/timescale/pg_prometheus - Prometheus metrics for PostgreSQL. |PG12earlier| - -``pg_repack`` - https://pgxn.org/dist/pg_repack/1.4.6/ - Reorganize tables in PostgreSQL databases with minimal locks. - -``pg_stat_statements`` - https://www.postgresql.org/docs/current/pgstatstatements.html - Track planning and execution statistics of all SQL statements executed. - -``pgrowlocks`` - https://www.postgresql.org/docs/current/pgrowlocks.html - Show row-level locking information. - -``pgstattuple`` - https://www.postgresql.org/docs/current/pgstattuple.html - Show tuple-level statistics. - -``sslinfo`` - https://www.postgresql.org/docs/current/sslinfo.html - Information about SSL certificates. - -``tablefunc`` - https://www.postgresql.org/docs/current/tablefunc.html - Functions that manipulate whole tables, including ``crosstab``. - -``timetravel`` - https://www.postgresql.org/docs/6.3/c0503.htm - Functions for implementing time travel. |PG11earlier| - -``tsm_system_rows`` - https://www.postgresql.org/docs/current/tsm-system-rows.html - TABLESAMPLE method which accepts number of rows as a limit. - -``tsm_system_time`` - https://www.postgresql.org/docs/current/tsm-system-time.html - TABLESAMPLE method which accepts time in milliseconds as a limit. +- `aiven_extras `__. This extension is meant for use in environments where you want non-superusers to be able to use certain database features. +- `bool_plperl `__. Transform between ``bool`` and ``plperl``. |PG13onwards| +- `intagg `__. Integer aggregator and enumerator (obsolete). +- `intarray `__. Functions, operators, and index support for 1-D arrays of integers. +- `jsonb_plperl `__. Transform between ``jsonb`` and ``plperl``. +- `lo `__. Large Object maintenance. +- `pageinspect `__. Inspect the contents of database pages at a low level. +- `pg_buffercache `__. Examine the shared buffer cache. +- `pg_cron `__. Job scheduler for PostgreSQL. +- `pg_partman `__. Extension to manage partitioned tables by time or ID. +- `pg_prewarm `__. Prewarm relation data. |PG11onwards| +- `pg_prometheus `__. Prometheus metrics for PostgreSQL. |PG12earlier| +- `pg_repack `__. Reorganize tables in PostgreSQL databases with minimal locks. +- `pg_stat_statements `__. Track planning and execution statistics of all SQL statements executed. +- `pgrowlocks `__. Show row-level locking information. +- `pgstattuple `__. Show tuple-level statistics. +- `sslinfo `__. Information about SSL certificates. +- `tablefunc `__. Functions that manipulate whole tables, including ``crosstab``. +- `timetravel `__. Functions for implementing time travel. |PG11earlier| +- `tsm_system_rows `__. TABLESAMPLE method which accepts number of rows as a limit. +- `tsm_system_time `__. TABLESAMPLE method which accepts time in milliseconds as a limit. .. _avn_superuser_only_extensions: @@ -231,53 +118,20 @@ Superuser-only extensions The following extensions can only be installed by superusers, **and are not generally available**. -``amcheck`` - https://www.postgresql.org/docs/current/amcheck.html - Functions for verifying relation integrity. - -``autoinc`` - https://www.postgresql.org/docs/current/contrib-spi.html - Functions for auto-incrementing fields. - -``bool_plperlu`` - https://www.postgresql.org/docs/current/plperl-funcs.html - Transform between ``bool`` and ``plperlu``. |PG13onwards| - -``dict_xsyn`` - https://www.postgresql.org/docs/current/dict-xsyn.html - Text search dictionary template for extended synonym processing. - -``file_fdw`` - https://www.postgresql.org/docs/current/file-fdw.html - Foreign-data wrapper for flat file access. - -``hstore_plperl`` - https://www.postgresql.org/docs/current/hstore.html - Transform between ``hstore`` and ``plperl``. - -``hstore_plperlu`` - https://www.postgresql.org/docs/current/hstore.html - Transform between ``hstore`` and ``plperlu``. - -``insert_username`` - https://www.postgresql.org/docs/current/contrib-spi.html - Functions for tracking who changed a table. - -``jsonb_plperlu`` - https://www.postgresql.org/docs/current/datatype-json.html - Transform between ``jsonb`` and ``plperlu``. - -``moddatetime`` - https://www.postgresql.org/docs/10/contrib-spi.html - Functions for tracking last modification time. - -``old_snapshot`` - https://www.postgresql.org/docs/current/oldsnapshot.html - Utilities in support of old_snapshot_threshold. |PG14only| - -``pageinspect`` - https://www.postgresql.org/docs/current/pageinspect.html - Inspect the contents of database pages at a low level. - -``pg_freespacemap`` - https://www.postgresql.org/docs/current/pgfreespacemap.html - Examine the free space map (FSM). - -``pg_surgery`` - https://www.postgresql.org/docs/current/pgsurgery.html - Extension to perform surgery on a damaged relation. |PG14only| - -``pg_visibility`` - https://www.postgresql.org/docs/current/pgvisibility.html - Examine the visibility map (VM) and page-level visibility info. - -``plperlu`` - https://www.postgresql.org/docs/current/plperl-trusted.html - PL/PerlU untrusted procedural language. - -``refint`` - https://www.postgresql.org/docs/current/contrib-spi.html - Functions for implementing referential integrity (obsolete). +- `amcheck `__. Functions for verifying relation integrity. +- `autoinc `__. Functions for auto-incrementing fields. +- `bool_plperlu `__. Transform between ``bool`` and ``plperlu``. |PG13onwards| +- `dict_xsyn `__. Text search dictionary template for extended synonym processing. +- `file_fdw `__. Foreign-data wrapper for flat file access. +- `hstore_plperl `__. Transform between ``hstore`` and ``plperl``. +- `hstore_plperlu `__. Transform between ``hstore`` and ``plperlu``. +- `insert_username `__. Functions for tracking who changed a table. +- `jsonb_plperlu `__. Transform between ``jsonb`` and ``plperlu``. +- `moddatetime `__. Functions for tracking last modification time. +- `old_snapshot `__. Utilities in support of old_snapshot_threshold. |PG14only| +- `pageinspect `__. Inspect the contents of database pages at a low level. +- `pg_freespacemap `__. Examine the free space map (FSM). +- `pg_surgery `__. Extension to perform surgery on a damaged relation. |PG14only| +- `pg_visibility `__. Examine the visibility map (VM) and page-level visibility info. +- `plperlu `__. PL/PerlU untrusted procedural language. +- `refint `__. Functions for implementing referential integrity (obsolete). diff --git a/docs/tools/aiven-console.rst b/docs/tools/aiven-console.rst index 6b8cfdba7b..a3b3c5659d 100644 --- a/docs/tools/aiven-console.rst +++ b/docs/tools/aiven-console.rst @@ -47,7 +47,7 @@ If you don't have an organization, click **Create organization** to :doc:`create Organization and organizational unit settings are available on the **Admin** page. Here you can: -* :doc:`Manage your groups` +* :doc:`Manage your groups ` * Create new projects under an organization or organizational unit * Configure :doc:`authentication methods for an organization ` * View logs of activity such as the adding or removing of users, changing authentication methods, and more diff --git a/docs/tools/terraform/get-started.rst b/docs/tools/terraform/get-started.rst index 812364dc8c..11e7c05577 100644 --- a/docs/tools/terraform/get-started.rst +++ b/docs/tools/terraform/get-started.rst @@ -25,76 +25,76 @@ Terraform files declare the structure of the infrastructure, the dependencies, a Set up the Terraform project in an empty folder: -1. Create a new Terraform file, ``provider.tf``, to declare a dependency on the Aiven Provider for Terraform. +#. Create a new Terraform file, ``provider.tf``, to declare a dependency on the Aiven Provider for Terraform. -Add the following code to the file and specify the version in the ``required_providers`` block. You can find the latest version on the `Aiven Provider page `_. - -.. code:: terraform - - terraform { - required_providers { - aiven = { - source = "aiven/aiven" - version = ">=4.0.0, < 5.0.0" + Add the following code to the file and specify the version in the ``required_providers`` block. You can find the latest version on the `Aiven Provider page `_. + + .. code:: terraform + + terraform { + required_providers { + aiven = { + source = "aiven/aiven" + version = ">=4.0.0, < 5.0.0" + } + } + } + + provider "aiven" { + api_token = var.aiven_api_token } - } - } - - provider "aiven" { - api_token = var.aiven_api_token - } - -3. Create a file named ``redis.tf``. - -Add the following code to define the configuration of a single-node Aiven for Redis®* service: - -.. code:: terraform - # Redis service - - resource "aiven_redis" "single-node-aiven-redis" { - project = var.project_name - cloud_name = "google-northamerica-northeast1" - plan = "startup-4" - service_name = "gcp-single-node-redis1" - maintenance_window_dow = "monday" - maintenance_window_time = "10:00:00" - - redis_user_config { - redis_maxmemory_policy = "allkeys-random" - - public_access { - redis = true +#. Create a file named ``redis.tf``. + + Add the following code to define the configuration of a single-node Aiven for Redis®* service: + + .. code:: terraform + + # Redis service + + resource "aiven_redis" "single-node-aiven-redis" { + project = var.project_name + cloud_name = "google-northamerica-northeast1" + plan = "startup-4" + service_name = "gcp-single-node-redis1" + maintenance_window_dow = "monday" + maintenance_window_time = "10:00:00" + + redis_user_config { + redis_maxmemory_policy = "allkeys-random" + + public_access { + redis = true + } } } - } -5. Create a file named ``variables.tf``. This is used to avoid including sensitive information in source control. +#. Create a file named ``variables.tf``. This is used to avoid including sensitive information in source control. -Add the following code to declare the API token and project name variables: + Add the following code to declare the API token and project name variables: -.. code:: terraform - - variable "aiven_api_token" { - description = "Aiven console API token" - type = string - } + .. code:: terraform - variable "project_name" { - description = "Aiven console project name" - type = string - } + variable "aiven_api_token" { + description = "Aiven console API token" + type = string + } + + variable "project_name" { + description = "Aiven console project name" + type = string + } -6. Create a file named ``terraform.tfvars`` to define the values of the sensitive information. - -Add the following code, replacing ``AIVEN_AUTHENTICATION_TOKEN`` with your API token and ``AIVEN_PROJECT_NAME`` with the name of your project: - -.. code:: terraform +#. Create a file named ``terraform.tfvars`` to define the values of the sensitive information. - aiven_api_token = "AIVEN_AUTHENTICATION_TOKEN" - project_name = "AIVEN_PROJECT_NAME" + Add the following code, replacing ``AIVEN_AUTHENTICATION_TOKEN`` with your API token and ``AIVEN_PROJECT_NAME`` with the name of your project: + + .. code:: terraform + + aiven_api_token = "AIVEN_AUTHENTICATION_TOKEN" + project_name = "AIVEN_PROJECT_NAME" .. _plan-and-apply: @@ -102,29 +102,29 @@ Add the following code, replacing ``AIVEN_AUTHENTICATION_TOKEN`` with your API t Plan and apply the configuration ''''''''''''''''''''''''''''''''' -1. The ``init`` command prepares the working directly for use with Terraform. Run this command to automatically find, download, and install the necessary Aiven Provider plugins: +#. The ``init`` command prepares the working directly for use with Terraform. Run this command to automatically find, download, and install the necessary Aiven Provider plugins: -.. code:: bash - - terraform init + .. code:: bash -2. Run the ``plan`` command to create an execution plan and preview the changes that will be made (for example, what resources will be created or modified): + terraform init -.. code:: bash +#. Run the ``plan`` command to create an execution plan and preview the changes that will be made (for example, what resources will be created or modified): - terraform plan - -3. To create the resources, run: + .. code:: bash + + terraform plan -.. code:: bash +#. To create the resources, run: - terraform apply --auto-approve + .. code:: bash + + terraform apply --auto-approve The output will be similar to the following: .. code:: bash - Apply complete! Resources: 1 added, 0 changed, 0 destroyed. + Apply complete! Resources: 1 added, 0 changed, 0 destroyed. You can also see the new Redis service in the `Aiven Console `_. @@ -133,32 +133,33 @@ Clean up To delete the service and its data: -1. Create a destroy plan and preview the changes to your infrastructure with the following command: - -.. code:: bash - - terraform plan -destroy +#. Create a destroy plan and preview the changes to your infrastructure with the following command: -2. To delete the resources and all data, run: - -.. code:: bash - - terraform destroy + .. code:: bash + + terraform plan -destroy -3. Enter "yes" to confirm. The output will be similar to the following: +#. To delete the resources and all data, run: -.. code:: bash + .. code:: bash + + terraform destroy - Do you really want to destroy all resources? - Terraform will destroy all your managed infrastructure, as shown above. - There is no undo. Only 'yes' will be accepted to confirm. +#. Enter "yes" to confirm. The output will be similar to the following: - Enter a value: yes - ... - Destroy complete! Resources: 1 destroyed. + .. code:: bash + + Do you really want to destroy all resources? + Terraform will destroy all your managed infrastructure, as shown above. + There is no undo. Only 'yes' will be accepted to confirm. + + Enter a value: yes + ... + Destroy complete! Resources: 1 destroyed. Next steps ''''''''''' + * Try `another sample project `_ to set up integrated Aiven for Kafka®, PostgreSQL®, InfluxDB®, and Grafana® services. * Read the `Terraform Docs `_ to learn about more complex project structures.