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

Commit

Permalink
fix markup
Browse files Browse the repository at this point in the history
  • Loading branch information
@ArthurFlag
ArthurFlag committed Jan 18, 2024
1 parent ddb244d commit 8ed0733
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 72 deletions.
57 changes: 16 additions & 41 deletions docs/products/clickhouse/concepts/features-overview.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,69 +13,44 @@ Effortless setup

With the managed ClickHouse service, you can offload on Aiven multiple time-consuming and laborious operations on your data infrastructure: database initialization and configuration, cluster provisioning and management, or your infrastructure maintenance and monitoring are off your shoulders.

Pre-configured settings
The managed ClickHouse service is pre-configured with a rational set of parameters and settings appropriate for the plan you have selected. You can easily launch production-ready ClickHouse clusters in minutes in a cloud of your choice.
**Pre-configured settings:** The managed ClickHouse service is pre-configured with a rational set of parameters and settings appropriate for the plan you have selected. You can easily launch production-ready ClickHouse clusters in minutes in a cloud of your choice.

Easy management
---------------

Scalability
You can seamlessly :doc:`scale your ClickHouse cluster </docs/platform/howto/scale-services>` horizontally or vertically as your data and needs change using the pre-packaged plans. Aiven for ClickHouse also supports :doc:`sharding </docs/products/clickhouse/howto/use-shards-with-distributed-table>` as a horizontal cluster scaling strategy.

Resource tags
You can assign metadata to your services in the form of tags. They help you organize, search, and filter Aiven resources. You can :doc:`tag your service </docs/platform/howto/tag-resources>` by purpose, owner, environment, or any other criteria.

Forking
Forking an Aiven for ClickHouse service creates a new database service containing the latest snapshot of an existing service. Forks don't stay up-to-date with the parent database, but you can write to them. It provides a risk-free way of working with your production data and schema. For example, you can use them to test upgrades, new schema migrations, or load test your app with a different plan. Learn how to :doc:`fork an Aiven service </docs/platform/howto/console-fork-service>`.
- **Scalability:** You can seamlessly :doc:`scale your ClickHouse cluster </docs/platform/howto/scale-services>` horizontally or vertically as your data and needs change using the pre-packaged plans. Aiven for ClickHouse also supports :doc:`sharding </docs/products/clickhouse/howto/use-shards-with-distributed-table>` as a horizontal cluster scaling strategy.
- **Resource tags:** You can assign metadata to your services in the form of tags. They help you organize, search, and filter Aiven resources. You can :doc:`tag your service </docs/platform/howto/tag-resources>` by purpose, owner, environment, or any other criteria.
- **Forking:** Forking an Aiven for ClickHouse service creates a new database service containing the latest snapshot of an existing service. Forks don't stay up-to-date with the parent database, but you can write to them. It provides a risk-free way of working with your production data and schema. For example, you can use them to test upgrades, new schema migrations, or load test your app with a different plan. Learn how to :doc:`fork an Aiven service </docs/platform/howto/console-fork-service>`.

Effective maintenance
---------------------

Automatic maintenance updates
With 99.99% SLA, Aiven makes sure that the ClickHouse software and the underlying platform stays up-to-date with the latest patches and updates with zero downtime. You can set :doc:`maintenance windows </docs/platform/concepts/maintenance-window>` for your service to make sure the changes occur during times that do not affect productivity.

Backups and disaster recovery
Aiven for ClickHouse has automatic backups taken every 24 hours. The retention period depends on your plan tier. Check out the details on `Plan comparison <https://aiven.io/pricing?product=clickhouse&tab=plan-comparison>`_.
- **Automatic maintenance updates:** With 99.99% SLA, Aiven makes sure that the ClickHouse software and the underlying platform stays up-to-date with the latest patches and updates with zero downtime. You can set :doc:`maintenance windows </docs/platform/concepts/maintenance-window>` for your service to make sure the changes occur during times that do not affect productivity.
- **Backups and disaster recovery:** Aiven for ClickHouse has automatic backups taken every 24 hours. The retention period depends on your plan tier. Check out the details on `Plan comparison <https://aiven.io/pricing?product=clickhouse&tab=plan-comparison>`_.

Intelligent observability
-------------------------

Service health monitoring
Aiven for ClickHouse provides metrics and logs for your cluster at no additional charge. You can enable pre-integrated Aiven observability services, such as Grafana®, M3®, or OpenSearch® or push available metrics and logs to external observability tools, such as Prometheus, AWS CloudWatch, or Google Cloud Logging. For more details, see :doc:`Monitor Aiven for ClickHouse metrics </docs/products/clickhouse/howto/monitor-performance>`.

Notifications and alerts
The service is pre-configured to alert you on, for example, your disk running out of space or CPU consumption running high when resource usage thresholds are exceeded. Email notifications are sent to admins and technical contacts of the project under which your service is created. Check :doc:`Receive technical notifications </docs/platform/howto/technical-emails>` to learn how you can sign up for such alerts.
- **Service health monitoring:** Aiven for ClickHouse provides metrics and logs for your cluster at no additional charge. You can enable pre-integrated Aiven observability services, such as Grafana®, M3®, or OpenSearch® or push available metrics and logs to external observability tools, such as Prometheus, AWS CloudWatch, or Google Cloud Logging. For more details, see :doc:`Monitor Aiven for ClickHouse metrics </docs/products/clickhouse/howto/monitor-performance>`.
- **Notifications and alerts:** The service is pre-configured to alert you on, for example, your disk running out of space or CPU consumption running high when resource usage thresholds are exceeded. Email notifications are sent to admins and technical contacts of the project under which your service is created. Check :doc:`Receive technical notifications </docs/platform/howto/technical-emails>` to learn how you can sign up for such alerts.

Security and compliance
-----------------------

Single tenancy
Your service runs on dedicated instances, thus offering true data isolation that contributes to the optimal protection and an increased security.

Network isolation
Aiven platform supports VPC peering as a mechanism for connecting directly to your ClickHouse service via private IP, thus providing a more secure network setup. The platform also supports PrivateLink connectivity.

Regulatory compliance
ClickHouse runs on Aiven platform that is ISO 27001:2013, SOC2, GDPR, HIPAA, and PCI/DSS compliant.
- **Single tenancy:** Your service runs on dedicated instances, thus offering true data isolation that contributes to the optimal protection and an increased security.
- **Network isolation:** Aiven platform supports VPC peering as a mechanism for connecting directly to your ClickHouse service via private IP, thus providing a more secure network setup. The platform also supports PrivateLink connectivity.
- **Regulatory compliance:** ClickHouse runs on Aiven platform that is ISO 27001:2013, SOC2, GDPR, HIPAA, and PCI/DSS compliant.

Role based Access Control (RBAC)
To learn what kind of granular access is possible in Aiven for ClickHouse, check out :ref:`RBAC with Zookeeper <zookeeper>`.

Zero lock-in
Aiven for ClickHouse offers compatibility with open source software (OSS), which protects you from software and vendor lock-in. You can easily migrate between clouds and regions.
- **Zero lock-in:** Aiven for ClickHouse offers compatibility with open source software (OSS), which protects you from software and vendor lock-in. You can easily migrate between clouds and regions.

.. seealso::

Check out more details on security and compliance in Aiven for ClickHouse in :doc:`Secure a managed ClickHouse® service </docs/products/clickhouse/howto/secure-service>`.
Check out more details on security and compliance in Aiven for ClickHouse in :doc:`Secure a managed ClickHouse® service </docs/products/clickhouse/howto/secure-service>`.

Devops-friendly tools
---------------------

Automation
`Aiven Provider for Terraform <https://registry.terraform.io/providers/aiven/aiven/latest/docs>`_ helps you automate the orchestration of your ClickHouse clusters.

Command-line tooling
:doc:`Aiven CLI </docs/tools/cli>` client provides greater flexibility of use for proficient administrators allowing scripting repetitive actions with ease.

REST APIs
:doc:`Aiven APIs </docs/tools/api>` allow you to manage Aiven resources in a programmatic way using HTTP requests. The whole functionality available via Aiven Console is also available via APIs enabling you to build custom integrations with ClickHouse and the Aiven platform.
- **Automation:** `Aiven Provider for Terraform <https://registry.terraform.io/providers/aiven/aiven/latest/docs>`_ helps you automate the orchestration of your ClickHouse clusters.
- **Command-line tooling:** :doc:`Aiven CLI </docs/tools/cli>` client provides greater flexibility of use for proficient administrators allowing scripting repetitive actions with ease.
- **REST APIs:** :doc:`Aiven APIs </docs/tools/api>` allow you to manage Aiven resources in a programmatic way using HTTP requests. The whole functionality available via Aiven Console is also available via APIs enabling you to build custom integrations with ClickHouse and the Aiven platform.
11 changes: 3 additions & 8 deletions docs/products/clickhouse/concepts/strings.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,6 @@ ClickHouse supports a wide range of functions for working with JSON. With specif

.. topic:: Examples

``visitParamExtractString(params, name)``
Parse the string in double quotes.

``JSONExtractString(json[, indices_or_keys]…)``
Parse a JSON and extract a string.

``toJSONString``
Convert a value of any data type to its JSON representation.
- ``visitParamExtractString(params, name)``: Parse the string in double quotes.
- ``JSONExtractString(json[, indices_or_keys]…)``: Parse a JSON and extract a string.
- ``toJSONString``: Convert a value of any data type to its JSON representation.
11 changes: 6 additions & 5 deletions docs/products/postgresql/howto/connect-java.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,12 @@ Add the following to ``PostgresqlExample.java`` and replace the placeholder with

This code creates a PostgreSQL client and opens a connection to the database. Then runs a query checking the database version and prints the response

Before running the code replace
* **HOST** to ``HOSTNAME``
* **PORT**: to ``PORT``
* **DATABASE** to ``DATABASE``
* **PASSWORD** to ``PASSWORD``
Before running the code, change:

* **HOST** to ``HOSTNAME``
* **PORT**: to ``PORT``
* **DATABASE** to ``DATABASE``
* **PASSWORD** to ``PASSWORD``

To run the code:

Expand Down
25 changes: 7 additions & 18 deletions docs/products/redis/howto/manage-ssl-connectivity.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Client support for SSL-encrypted connections

Default support
~~~~~~~~~~~~~~~
Aiven for Redis®* uses SSL encrypted connections by default. This is shown by the use of ``rediss://`` (with double s) prefix in the ``Service URI`` on the `Aiven Console <https://console.aiven.io/>`_.
Aiven for Redis®* uses SSL encrypted connections by default. This is shown by the use of ``rediss://`` (with double ``s``) prefix in the ``Service URI`` on the `Aiven Console <https://console.aiven.io/>`_.

.. Tip::

Expand Down Expand Up @@ -56,22 +56,13 @@ To understand the global options of the ``stunnel`` configuration, please check

For ``service-level option``, the following parameters are configured:

``accept`` => *[host:]port*
**Accept connections on specified address**
- ``accept => *[host:]port*``: Accept connections on the specified address.
- ``connect => *[host:]port*``: Connect to a remote address.
- ``TIMEOUTclose => *seconds*``: Time to wait for close_notify.

.. note:: It is important to make changes accordingly to your service. On the **Overview** page you can find your **Overview** > **Host** and **Overview** > **Port** to configure the ``connect`` parameter.


``connect`` => *[host:]port*
**Connect to a remote address**



``TIMEOUTclose`` => *seconds*
**Time to wait for close_notify**

.. note:: It is important to make changes accordingly to your service. On the *Overview* page you can find your **Overview** > **Host** and **Overview** > **Port** to configure the ``connect`` parameter.

It is important to note that when SSL is in use, HAProxy will be responsible for terminating the SSL connections before they get forwarded to Redis. This process has a connection timeout set to 12 hours which is not configurable by the customer. If you allow very long Redis timeouts, this SSL-terminating HAProxy may end up closing the connection before the Redis timeout has expired. This timeout is independent of Redis timeout.
When SSL is in use, HAProxy is responsible for terminating the SSL connections before they get forwarded to Redis. This process has a connection timeout set to 12 hours which is not configurable by the customer. If you allow very long Redis timeouts, this SSL-terminating HAProxy may end up closing the connection before the Redis timeout has expired. This timeout is independent of Redis timeout.

Allow plain-text connections
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -88,6 +79,4 @@ To disable SSL on an existing Redis instance use the following Aiven CLI command
avn service update <my-redis> -c "redis_ssl=false"
After executing the command, the ``Service URI`` will change and point at the new location, it will also start with the ``redis://`` (removing the extra s) prefix denoting that it's a direct Redis connection which does not use SSL.


After executing the command, the ``Service URI`` points to the new location and starts with the ``redis://`` (removing the extra ``s``) prefix meaning it's a direct Redis connection which does not use SSL.

0 comments on commit 8ed0733

Please sign in to comment.