Fix: pipes and unwanted chars (#2288)

aiven · Nov 24, 2023 · 319b677 · 319b677
1 parent f7ed8b4
commit 319b677
Show file tree

Hide file tree

Showing 20 changed files with 163 additions and 169 deletions.
diff --git a/docs/platform/concepts/aiven-node-firewall-configuration.rst b/docs/platform/concepts/aiven-node-firewall-configuration.rst
@@ -7,7 +7,7 @@ Intra-node connections are limited to point-to-point connections to specific IP
 Service ports that you can connect to depend on the service type and deployment type. The configuration can also affect the ports that are available:
 
 * Is the service in a public network, :doc:`dedicated VPC </docs/platform/howto/manage-vpc-peering>`, virtual cloud account, or a  :doc:`Bring Your Own Cloud (BYOC) </docs/platform/concepts/byoc>` setup ?
-* Have you configured IP ranges in  user_config.ip_filter?
+* Have you configured IP ranges in  user_config.ip_filter?
 * Have you :doc:`enabled public internet access for services in a VPC </docs/platform/howto/public-access-in-vpc>`?
 
 Commonly opened ports

diff --git a/docs/platform/concepts/enhanced-compliance-env.rst b/docs/platform/concepts/enhanced-compliance-env.rst
@@ -2,7 +2,7 @@ Enhanced compliance environments (ECE)
 ===========================================
 
 As a business that collects, manages, and operates on sensitive data that is protected by privacy and
-compliance rules and regulations – any vendor that assists with this collection, management and
+compliance rules and regulations - any vendor that assists with this collection, management and
 operation is subject to these same rules and regulations. Aiven meets the needs of these
 businesses by providing specialized enhanced compliance environments (ECE) that comply with many
 of the most common compliance requirements.
@@ -12,7 +12,7 @@ compliance requirement that no ECE VPC is shared and the managed environment is
 from the standard Aiven deployment environment. This decreases the blast radius of the environment
 to prevent inadvertent data sharing. Furthermore, users of an ECE **must** encrypt all data prior
 to reaching an Aiven service. As part of the increased compliance of the environment, enhanced logging
-is enabled for – ``stderr``, ``stout``, and ``stdin``.
+is enabled for - ``stderr``, ``stout``, and ``stdin``.
 
 Who is eligible?
 ----------------
@@ -73,7 +73,7 @@ Migrating
 ----------------
 Migrations to Aiven are fairly straightforward in general, but migrating to an ECE can add a
 tiny bit of complexity. If the migration is for a new service there are a few standard
-migration methods that will work – please contact `sales <[email protected]>`_ and a Solution Architect
+migration methods that will work - please contact `sales <[email protected]>`_ and a Solution Architect
 will be able to help.
 
 If you need to migrate an existing Aiven service to an ECE the standard automated migration

diff --git a/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst b/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst
@@ -61,19 +61,19 @@ Ensure that you use port 6733, the default port for Jolokia. Replace ``joljkr2l:
 .. code-block:: shell
 
    curl --cacert ca.pem \
-       -X POST \
-       https://joljkr2l:PWD@HOST_IP:6733/jolokia/  \
-       -d \
+       -X POST \
+       https://joljkr2l:PWD@HOST_IP:6733/jolokia/  \
+       -d \
    '{"type":"read","mbean":"kafka.server:type=ReplicaManager,name=PartitionCount"}'
 
 Jolokia supports searching beans using ``search`` command:
 
 .. code-block:: shell
 
    curl --cacert ca.pem \
-       -X POST \
-       https://joljkr2l:PWD@HOST_IP:6733/jolokia/  \
-       -d \
+       -X POST \
+       https://joljkr2l:PWD@HOST_IP:6733/jolokia/  \
+       -d \
    '{"type":"search","mbean":"kafka.server:*"}'
 
 
diff --git a/docs/platform/howto/integrations/prometheus-metrics.rst b/docs/platform/howto/integrations/prometheus-metrics.rst
@@ -22,9 +22,9 @@ Check Prometheus support for your service
 
 Usually one Prometheus integration endpoint can be used for all services in the same project. To check if Prometheus is supported on your service, you need to verify if the project for this service has a Prometheus integration endpoint created. For this purpose, take the following steps:
 
-#. | Log in to `Aiven Console <https://console.aiven.io/>`_, go to **Projects** in the top navigation bar, and select your project from the dropdown list.
-#. | On the **Services** page, select **Integration endpoints** from the left sidebar.
-#. | On the **Integration endpoints** page, select **Prometheus** from the list available integration endpoints, and check if there is any endpoint available under **Endpoint Name**.
+#. Log in to `Aiven Console <https://console.aiven.io/>`_, go to **Projects** in the top navigation bar, and select your project from the dropdown list.
+#. On the **Services** page, select **Integration endpoints** from the left sidebar.
+#. On the **Integration endpoints** page, select **Prometheus** from the list available integration endpoints, and check if there is any endpoint available under **Endpoint Name**.
 
 If there is a Prometheus endpoint available, your service supports Prometheus. If there's no Prometheus endpoint available, proceed to :ref:`Enable Prometheus on your Aiven project <enable-prometheus>` to set up Prometheus for your service (project).
 
@@ -35,21 +35,21 @@ Enable Prometheus
 
 Aiven offers Prometheus endpoints for your services. To enable this feature, take the following steps:
 
-#. | Log in to `Aiven Console <https://console.aiven.io/>`_, go to **Projects** in the top navigation bar, and select your project from the dropdown list.
-#. | On the **Services** page, select **Integration endpoints** from the left sidebar.
-#. | On the **Integration endpoints** page, select **Prometheus** from the list available integration endpoints, and select **Add new endpoint**.
-#. | In the **Create new Prometheus endpoint** window, enter the details for the endpoint, and select **Create**. 
-#. | Select **Services** from the sidebar, and navigate to the service that you would like to monitor.
-#. | On the **Overview** page of your service, go to the **Service integrations** section, and select **Manage integrations**.
-#. | On the **Integrations** page, select **Prometheus**. 
-#. | In the **Prometheus integration** window, select the endpoint name you created from the dropdown list, and select **Enable**.
+#. Log in to `Aiven Console <https://console.aiven.io/>`_, go to **Projects** in the top navigation bar, and select your project from the dropdown list.
+#. On the **Services** page, select **Integration endpoints** from the left sidebar.
+#. On the **Integration endpoints** page, select **Prometheus** from the list available integration endpoints, and select **Add new endpoint**.
+#. In the **Create new Prometheus endpoint** window, enter the details for the endpoint, and select **Create**. 
+#. Select **Services** from the sidebar, and navigate to the service that you would like to monitor.
+#. On the **Overview** page of your service, go to the **Service integrations** section, and select **Manage integrations**.
+#. On the **Integrations** page, select **Prometheus**. 
+#. In the **Prometheus integration** window, select the endpoint name you created from the dropdown list, and select **Enable**.
 
    .. note::
 
       At the top of the **Integrations** page, you will see the Prometheus integration listed and status ``active``. 
 
-#. | From the **Integrations** page, go to the **Overview** page > the **Connection information** section > the **Prometheus** tab.
-#. | Copy **Service URI**, and use it in your browser to access the Prometheus dashboard.
+#. From the **Integrations** page, go to the **Overview** page > the **Connection information** section > the **Prometheus** tab.
+#. Copy **Service URI**, and use it in your browser to access the Prometheus dashboard.
 
 .. topic:: Result
 

diff --git a/docs/platform/howto/use-aws-privatelinks.rst b/docs/platform/howto/use-aws-privatelinks.rst
@@ -25,27 +25,27 @@ AWS PrivateLink. You also need the AWS console or CLI to create a VPC endpoint.
 **Note:** Aiven for Apache Cassandra® and Aiven for M3 services do not
 currently support AWS PrivateLink.
 
-#. | Create an AWS PrivateLink resource on the Aiven service:
+#. Create an AWS PrivateLink resource on the Aiven service:
 
-   | The Amazon Resource Name (ARN) for the principals that are allowed
-     to connect to the VPC endpoint service and the AWS network load
-     balancer requires your Amazon account ID. In addition, you can set
-     the access scope for an entire AWS account, a given user account,
-     or a given role. Only give permissions to roles that you trust, as
-     an allowed role can connect from any VPC.
+   The Amazon Resource Name (ARN) for the principals that are allowed
+   to connect to the VPC endpoint service and the AWS network load
+   balancer requires your Amazon account ID. In addition, you can set
+   the access scope for an entire AWS account, a given user account,
+   or a given role. Only give permissions to roles that you trust, as
+   an allowed role can connect from any VPC.
 
    -  Using the Aiven CLI, run the following command including your AWS
       account ID, the access scope, and the name of your Aiven service:
 
       .. code::
 
-         $ avn service privatelink aws create --principal arn:aws:iam::$AWS_account_ID:$access_scope $Aiven_service_name
+         avn service privatelink aws create --principal arn:aws:iam::$AWS_account_ID:$access_scope $Aiven_service_name
 
       For example:
 
       .. code::
 
-         $ avn service privatelink aws create --principal arn:aws:iam::012345678901:user/mwf my-kafka
+         avn service privatelink aws create --principal arn:aws:iam::012345678901:user/mwf my-kafka
 
    -  Using `Aiven Console <https://console.aiven.io>`__:
 
@@ -58,65 +58,67 @@ currently support AWS PrivateLink.
 
       #. In the **Create Privatelink** window, enter the Amazon Resource Names (ARN) for the principals that you want to use, and select **Create** .
 
-   | This creates an AWS network load balancer dedicated to your Aiven
-     service and attaches it to an AWS VPC endpoint service that you can
-     later use to connect to your account's VPC endpoint.
-
-   | The PrivateLink resource stays in the initial ``creating`` state
-     for up to a few minutes while the load balancer is being launched.
-     After the load balancer and VPC endpoint service have been created,
-     the state changes to ``active`` and the ``aws_service_id`` and
-     ``aws_service_name`` values are set.
+         This creates an AWS network load balancer dedicated to your Aiven
+         service and attaches it to an AWS VPC endpoint service that you can
+         later use to connect to your account's VPC endpoint.
+   
+         The PrivateLink resource stays in the initial ``creating`` state
+         for up to a few minutes while the load balancer is being launched.
+         After the load balancer and VPC endpoint service have been created,
+         the state changes to ``active`` and the ``aws_service_id`` and
+         ``aws_service_name`` values are set.
 
 #. In the AWS CLI, run the following command to create a VPC endpoint:
 
    .. code::
 
-      $ aws ec2 --region eu-west-1 create-vpc-endpoint --vpc-endpoint-type Interface --vpc-id $your_vpc_id --subnet-ids $space_separated_list_of_subnet_ids --security-group-ids $security_group_ids --service-name com.amazonaws.vpce.eu-west-1.vpce-svc-0b16e88f3b706aaf1
+      aws ec2 --region eu-west-1 create-vpc-endpoint --vpc-endpoint-type Interface --vpc-id $your_vpc_id --subnet-ids $space_separated_list_of_subnet_ids --security-group-ids $security_group_ids --service-name com.amazonaws.vpce.eu-west-1.vpce-svc-0b16e88f3b706aaf1
 
-   | 
-   | Replace the ``--service-name`` value with the value shown next to
-     **Network** > **AWS service name** in `Aiven Console <https://console.aiven.io>`__ or by
-     running the following command in the Aiven CLI:
+     
+   Replace the ``--service-name`` value with the value shown next to
+   **Network** > **AWS service name** in `Aiven Console <https://console.aiven.io>`__ or by
+   running the following command in the Aiven CLI:
 
-   .. code::
+   .. code:: 
 
-      $ avn service privatelink aws get aws_service_name
+      avn service privatelink aws get aws_service_name
 
-   | 
-   | Note that for fault tolerance, you should specify a subnet ID for
-     each availability zone in the region. The security groups determine
-     the instances that are allowed to connect to the endpoint network
-     interfaces created by AWS into the specified subnets.
+     
+   Note that for fault tolerance, you should specify a subnet ID for
+   each availability zone in the region. The security groups determine
+   the instances that are allowed to connect to the endpoint network
+   interfaces created by AWS into the specified subnets.
 
-   | Alternatively, you can create the VPC endpoint in `AWS Console <https://console.aws.amazon.com>`__ under **VPC** > **Endpoints** > **Create endpoint** . See the `AWS documentation <https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html#create-interface-endpoint>`__ for details.
+   Alternatively, you can create the VPC endpoint in `AWS Console <https://console.aws.amazon.com>`__ under **VPC** > **Endpoints** > **Create endpoint** . See the `AWS documentation <https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html#create-interface-endpoint>`__ for details.
 
-   | **Note:** For Aiven for Apache Kafka® services, the security group
-     for the VPC endpoint must allow ingress in the port range
-     ``10000-31000`` to accommodate the pool of Kafka broker ports used
-     in our PrivateLink implementation.
+   .. note::
+
+      For Aiven for Apache Kafka® services, the security group
+      for the VPC endpoint must allow ingress in the port range
+      ``10000-31000`` to accommodate the pool of Kafka broker ports used
+      in our PrivateLink implementation.
 
-   | It takes a while before the endpoint is ready to use as AWS
-     provisions network interfaces to each of the subnets and connects
-     them to the Aiven VPC endpoint service. Once the AWS endpoint state
-     changes to ``available`` , the connection is visible in Aiven.
+      It takes a while before the endpoint is ready to use as AWS
+      provisions network interfaces to each of the subnets and connects
+      them to the Aiven VPC endpoint service. Once the AWS endpoint state
+      changes to ``available`` , the connection is visible in Aiven.
 
-#. | Enable PrivateLink access for Aiven service components:
+#. Enable PrivateLink access for Aiven service components:
 
-   | You can control each service component separately - for example,
-     you can enable PrivateLink access for Kafka while allowing Kafka
-     Connect to connect via VPC peering connections only.
+   You can control each service component separately - for example,
+   you can enable PrivateLink access for Kafka while allowing Kafka
+   Connect to connect via VPC peering connections only.
 
    -  In the Aiven CLI, set
       ``user_config.privatelink_access.<service component>`` to ``true``
       for the components that you want to enable. For example:
 
       .. code::
 
-         $ avn service update -c privatelink_access.kafka=true $Aiven_service_name
-         $ avn service update -c privatelink_access.kafka_connect=true $Aiven_service_name
-         $ avn service update -c privatelink_access.kafka_rest=true $Aiven_service_name
-         $ avn service update -c privatelink_access.schema_registry=true $Aiven_service_name
+         avn service update -c privatelink_access.kafka=true $Aiven_service_name
+         avn service update -c privatelink_access.kafka_connect=true $Aiven_service_name
+         avn service update -c privatelink_access.kafka_rest=true $Aiven_service_name
+         avn service update -c privatelink_access.schema_registry=true $Aiven_service_name
 
    -  In `Aiven Console <https://console.aiven.io>`__:
 
@@ -163,32 +165,32 @@ To acquire connection information for your service component using AWS PrivateLi
 
 * For SSL connection information for your service component using AWS PrivateLink, run the following command:
 
-.. code-block:: bash
-
-   avn service connection-info UTILITY_NAME SERVICE_NAME --privatelink-connection-id PRIVATELINK_CONNECTION_ID
-
+  .. code-block:: bash
+  
+     avn service connection-info UTILITY_NAME SERVICE_NAME --privatelink-connection-id PRIVATELINK_CONNECTION_ID
+  
 .. topic:: Where
-
-  * UTILITY_NAME for Aiven for Apache Kafka®, for example, can be ``kcat``.
-  * SERVICE_NAME for Aiven for Apache Kafka®, for example, can be ``kafka-12a3b4c5``.
-  * PRIVATELINK_CONNECTION_ID can be ``plc39413abcdef``.
+  
+   * UTILITY_NAME for Aiven for Apache Kafka®, for example, can be ``kcat``.
+   * SERVICE_NAME for Aiven for Apache Kafka®, for example, can be ``kafka-12a3b4c5``.
+   * PRIVATELINK_CONNECTION_ID can be ``plc39413abcdef``.
 
 * For SASL connection information for Aiven for Apache Kafka® service components using AWS PrivateLink, run the following command:
 
-.. code-block:: bash
-
-   avn service connection-info UTILITY_NAME SERVICE_NAME --privatelink-connection-id PRIVATELINK_CONNECTION_ID -a sasl
-
+  .. code-block:: bash
+  
+     avn service connection-info UTILITY_NAME SERVICE_NAME --privatelink-connection-id PRIVATELINK_CONNECTION_ID -a sasl
+  
 .. topic:: Where
-
-  * UTILITY_NAME for Aiven for Apache Kafka®, for example, can be ``kcat``.
-  * SERVICE_NAME for Aiven for Apache Kafka®, for example, can be ``kafka-12a3b4c5``.
-  * PRIVATELINK_CONNECTION_ID can be ``plc39413abcdef``.
-
+  
+   * UTILITY_NAME for Aiven for Apache Kafka®, for example, can be ``kcat``.
+   * SERVICE_NAME for Aiven for Apache Kafka®, for example, can be ``kafka-12a3b4c5``.
+   * PRIVATELINK_CONNECTION_ID can be ``plc39413abcdef``.
+  
 .. note::
-
+  
    SSL certificates and SASL credentials are the same for all the connections. You can use the same credentials with any access route.
-
+  
 .. _h_2a1689a687:
 
 Update the allowed principals list
@@ -203,7 +205,7 @@ allowed to connect a VPC endpoint:
 
       # avn service privatelink aws update --principal arn:aws:iam::$AWS_account_ID:$access_scope $Aiven_service_name
 
-   | **Note:** When you add an entry, also include the ``--principal`` arguments for existing entries.
+     **Note:** When you add an entry, also include the ``--principal`` arguments for existing entries.
 
 -  In `Aiven Console <https://console.aiven.io>`__:
 
@@ -226,7 +228,7 @@ Deleting a privatelink connection
 
    .. code::
 
-      $ avn service privatelink aws delete $Aiven_service_name
+      avn service privatelink aws delete $Aiven_service_name
 
    .. code::
 

diff --git a/docs/platform/howto/vnet-peering-azure.rst b/docs/platform/howto/vnet-peering-azure.rst
@@ -58,7 +58,7 @@ is not needed if there's only one subscription:
 
 .. code::
 
-   az account set --subscription <subscription name or id> 
+   az account set --subscription <subscription name or id> 
 
 
 2. create application object

diff --git a/docs/products/clickhouse.rst b/docs/products/clickhouse.rst
@@ -1,7 +1,7 @@
 Aiven for ClickHouse®
 =====================
 
-Aiven for ClickHouse® is a fully managed distributed columnar database based on open source ClickHouse – a fast, resource effective solution tailored for data warehouse and generation of real-time analytical data reports using advanced SQL queries.
+Aiven for ClickHouse® is a fully managed distributed columnar database based on open source ClickHouse - a fast, resource effective solution tailored for data warehouse and generation of real-time analytical data reports using advanced SQL queries.
 
 -------------------