General Destination Setup Guide
Last updated
Was this helpful?
Last updated
Was this helpful?
CloudQuery Platform is installed with a default ClickHouse database destination. All Platform features, such as SQL Console or Asset Inventory, depend on this destination. Should you decide to sync to another destination, these features may not work as intended. If you plan to use these features, your additional destinations should only serve as auxiliary destinations.
To set up a new destination, go to Data Pipelines → Destinations and click Create Destination:
Search for the name of your destination. In the example below, we searched for PostgreSQL. Click the destination card in the search results.
On the next screen, enter the Destination Name to identify the destination by later (if unsure, use the name of the Destination).
If applicable, fill out the Yaml specification. The link to the integration documentation under the Yaml input box will have more information about the format required.
Most of the destinations will require some form of authentication. We recommend using the Secrets section below to make the values available to the sync as environment variables. Reference the variables using placeholders such as ${my_secret_value} in the YAML configuration.
To save the destination, click the Test Connection and save button. If there are any errors during the test, they will be displayed on the page and in the logs below.
With your destination created, you can now proceed to use it in a new sync. This will give you the opportunity to specify when your sync should be run, and what integration to sync from.
