Various fixes (#2315)

aiven · Dec 7, 2023 · 29e141f · 29e141f
1 parent 79ec873
commit 29e141f
Show file tree

Hide file tree

Showing 39 changed files with 209 additions and 189 deletions.
diff --git a/docs/integrations/datadog.rst b/docs/integrations/datadog.rst
@@ -1,7 +1,7 @@
 Datadog and Aiven
 =================
 
-`Datadog <https://datadoghq.com/>`_ 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 <https://www.datadoghq.com/>`_ 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
@@ -1,7 +1,7 @@
 Send Aiven logs to Logtail
 ==========================
 
-`Logtail <https://betterstack.com/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 <https://betterstack.com/logs>`_ 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
@@ -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) </docs/platform/concepts/byoc>`.
+option. See :doc:`Bring Your Own Cloud (BYOC) </docs/platform/concepts/byoc>`.
 
 Migrating
 ----------------

diff --git 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
@@ -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 <backup-and-restore>`.
+    For more information on Aiven for ClickHouse backups, see :doc:`Backup and restore </docs/products/clickhouse/concepts/disaster-recovery>`.
 
 Access to backups
 -----------------

diff --git 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 <https://console.a
 
 4. In the **Upgrade service storage** window, use the slider to add disk storage.
 
-.. note::
+   .. note::
 
       The price shown for the additional storage includes backup costs.
 
@@ -87,4 +87,5 @@ For example, if you use a ``Startup-4`` plan with a 80-GiB disk by default and y
 .. note::
 
    - When you perform a service upgrade or downgrade horizontally, remember to include all additional disks the service uses. For example, when switching from ``Startup-4`` to ``Business-4`` or from ``Business-4`` to ``Startup-4``, include all the additional disks available for this service.
+
    - Similarly, when you fork an existing service, include all additional disks the service uses.
diff --git a/docs/platform/howto/billing-google-cloud-platform-marketplace-subscription.rst b/docs/platform/howto/billing-google-cloud-platform-marketplace-subscription.rst
@@ -8,15 +8,15 @@ First, there are some steps that need to be completed on the Google Cloud Market
 Google Cloud Marketplace setup
 ------------------------------
 
-1. Navigate to `Aiven Managed Database Services on the Google Cloud Marketplace <https://console.cloud.google.com/marketplace/product/aiven-public/aiven>`_.  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 <https://console.cloud.google.com/marketplace/product/aiven-public/aiven>`_.  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 <https://console.gcp.aiven.io/>`_, where you can manage your Aiven services as normal.
+#. You can now proceed to the `Aiven console for GCP <https://console.gcp.aiven.io/>`_, 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
@@ -19,13 +19,11 @@ With the BYOC feature enabled, you can :doc:`create custom clouds </docs/platfor
 Later, you can come back to the **Available projects** tab in your cloud's page in `Aiven Console <https://console.aiven.io/>`_ and update the settings you configured during the :doc:`initial custom cloud's setup </docs/platform/howto/byoc/create-custom-cloud>`.
 
 
-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
@@ -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
@@ -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
@@ -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
@@ -87,4 +87,4 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.
 Troubleshooting
 ---------------
 
-If you have issues, you can use the `SAML Tracer browser extension <https://addons.mozilla.org/firefox/addon/saml-tracer/>`_ to check the process step by step. 
+If you have issues, you can use the `SAML Tracer browser extension <https://addons.mozilla.org/en-US/firefox/addon/saml-tracer>`_ 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
@@ -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
@@ -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
@@ -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::