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

Commit

Permalink
clickhouse credentials integration
Browse files Browse the repository at this point in the history
  • Loading branch information
wojcik-dorota committed Jan 17, 2024
1 parent 841f78e commit cd8dbe9
Showing 1 changed file with 27 additions and 17 deletions.
44 changes: 27 additions & 17 deletions docs/products/clickhouse/howto/data-service-integration.rst
Original file line number Diff line number Diff line change
@@ -1,35 +1,41 @@
Manage Aiven for ClickHouse® data service integrations
Set up Aiven for ClickHouse® data service integrations
======================================================

Aiven for ClickHouse supports two types of integrations:
Connect an Aiven for ClickHouse® service with another Aiven service or external data source to make your data available in the Aiven for ClickHouse service. Depending on your use case, select either the managed-database integration or the managed-credentials integration.

- Regular integrations: Logs, metrics, dataflow/replication, and authentication integrations among your Aiven services and with external applications
- Data service integrations: Integrations with other Aiven services to use them as data sources
About data service integrations
-------------------------------

This article details how to set up and use data service integrations in Aiven for ClickHouse.
Aiven for ClickHouse allows the in-Aiven integrations (between Aiven services) and external integrations (between an Aiven service and an external data source or application).

.. seealso::
Depending on objectives and actual objects of the integration, Aiven for ClickHouse supports two types of integrations:

For information on how to set up and use regular integrations in Aiven for ClickHouse, see intregration guides in :doc:`Integrate your Aiven for ClickHouse® service </docs/products/clickhouse/howto/list-integrations>`.

About data service integrations
-------------------------------
- :doc:`Observability integrations </docs/products/clickhouse/howto/list-integrations>`: connecting to other services (either in-Aiven or external) to expose and process logs and metrics

Check failure on line 13 in docs/products/clickhouse/howto/data-service-integration.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/products/clickhouse/howto/data-service-integration.rst#L13

[Aiven.common_replacements] Use 'ClickHouse' instead of 'clickhouse'.
Raw output
{"message": "[Aiven.common_replacements] Use 'ClickHouse' instead of 'clickhouse'.", "location": {"path": "docs/products/clickhouse/howto/data-service-integration.rst", "range": {"start": {"line": 13, "column": 52}}}, "severity": "ERROR"}
- Data service integrations: connecting to other services (either in-Aiven or external) to use them as data sources

By enabling data service integrations in Aiven for ClickHouse, you create streaming data pipelines across services. Aiven for ClickHouse supports data service integrations with Aiven for Kafka® and Aiven for PostgreSQL®.

You can create Aiven for ClickHouse® data service integrations in the `Aiven web console <https://console.aiven.io/>`_.
For integrating with external data sources, Aiven for ClickHouse provides two types of data service integrations:

.. topic:: Integration databases

When creating integrations in the **Data service integrations** wizard, you can also create integration databases connected to the services you are integrating with.
* Managed databases
* Managed credentials

If you prefer to create a data service integration without adding integration databases, you can create integration databases for your service any time later. See :doc:`Manage Aiven for ClickHouse® integration databases </docs/products/clickhouse/howto/integration-databases>` for guidance on how to do that.
Managed credentials integration
'''''''''''''''''''''''''''''''

The managed credentials integration is built on the `ClickHouse named collections' <https://clickhouse.com/docs/en/operations/named-collections>`_ logic. It allows storing key-value pairs that are to be used as credentials required to connect to external data sources. Querying data is easiler, more efficient, and less time-consumig since you no longer need connections parameters in each query. They are stored in available from in-Aiven credential storage.

Check failure on line 26 in docs/products/clickhouse/howto/data-service-integration.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/products/clickhouse/howto/data-service-integration.rst#L26

[Aiven.aiven_spelling] 'easiler' does not seem to be a recognised word
Raw output
{"message": "[Aiven.aiven_spelling] 'easiler' does not seem to be a recognised word", "location": {"path": "docs/products/clickhouse/howto/data-service-integration.rst", "range": {"start": {"line": 26, "column": 287}}}, "severity": "ERROR"}

With the managed credentials integration enabled, you create your tables yourlself using table engines.

Check failure on line 28 in docs/products/clickhouse/howto/data-service-integration.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/products/clickhouse/howto/data-service-integration.rst#L28

[Aiven.aiven_spelling] 'yourlself' does not seem to be a recognised word
Raw output
{"message": "[Aiven.aiven_spelling] 'yourlself' does not seem to be a recognised word", "location": {"path": "docs/products/clickhouse/howto/data-service-integration.rst", "range": {"start": {"line": 28, "column": 74}}}, "severity": "ERROR"}

.. note::

Currently, you can set up the managed credentials integration with external PostgreSQL and MySQL data stores.

Prerequisites
-------------

* Aiven account
* Access to `Aiven web console <https://console.aiven.io/>`_
* Aiven organization, project, and Aiven for ClickHouse service
* Access to the `Aiven Console <https://console.aiven.io/>`_

.. _create-data-service-integration:

Expand Down Expand Up @@ -61,6 +67,10 @@ Create data service integrations

#. In the **Integration databases** view, select either **Enable without databases** or **Add databases** depending on whether you want to enable your integration with databases:

.. note::

If you prefer to create a data service integration without adding integration databases, you can create integration databases for your service any time later. See :doc:`Manage Aiven for ClickHouse® integration databases </docs/products/clickhouse/howto/integration-databases>` for guidance on how to do that.

Check failure on line 72 in docs/products/clickhouse/howto/data-service-integration.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/products/clickhouse/howto/data-service-integration.rst#L72

[Aiven.common_replacements] Use 'ClickHouse' instead of 'clickhouse'.
Raw output
{"message": "[Aiven.common_replacements] Use 'ClickHouse' instead of 'clickhouse'.", "location": {"path": "docs/products/clickhouse/howto/data-service-integration.rst", "range": {"start": {"line": 72, "column": 240}}}, "severity": "ERROR"}

- To enable your integration **with** databases:

#. In the **Integration databases** view, select **Add databases**.
Expand Down

0 comments on commit cd8dbe9

Please sign in to comment.