CloudQuery Platform
  • Introduction
    • Welcome to CloudQuery Platform
    • Getting Help
  • Quickstart
    • Creating a New Account
    • Platform Activation
  • Core Concepts
    • Integrations
    • Syncs
    • Filters & Queries
    • SQL Console
    • Reports
  • Integration Guides
    • Setting up an AWS Integration
    • Setting up an AWS Cost and Usage Integration
    • Setting up a GCP Integration
    • Setting up an Azure Integration
    • Setting up a GitHub Integration
    • Setting up a K8s Integration
      • Using AWS EKS
      • Using Azure AKS
      • Using GCP GKE
    • General Integration Setup Guide
    • General Destination Setup Guide
  • Syncs
    • Setting up a Sync
    • Monitoring Sync Status
  • Cloud insights
    • From cloud asset inventory to insights
      • Security-focused queries
      • Compliance-focused queries
      • FinOps-focused queries
  • Production Deployment
    • Enabling Single Sign-on (SSO)
      • Single Sign-On with Google
      • Single Sign-On with Microsoft
      • Single Sign-On with Okta
  • User Management
    • Platform Roles Overview
    • Workspace Roles Overview
  • Advanced Topics
    • Custom Columns
    • Understanding Platform Views
    • Performance Tuning
  • Reference
    • Search & Filter Query Syntax
  • API Reference
  • CLI Docs
  • CloudQuery Hub
Powered by GitBook
On this page

Was this helpful?

  1. Integration Guides

General Destination Setup Guide

PreviousGeneral Integration Setup GuideNextSetting up a Sync

Last updated 2 months ago

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.

Next Steps

With your destination created, you can now proceed to use it in a . This will give you the opportunity to specify when your sync should be run, and what to sync from.

new sync
integration