Official

Premium

Tailscale

The CloudQuery Tailscale plugin pulls configuration out of Tailscale resources and loads it into any supported CloudQuery destination

Publisher

cloudquery

Latest version

v5.4.0

Type

Source

Platforms

Date Published

September 25, 2024

Price per 1M rows

Starting from $15

monthly free quota

1M rows

Documentation Tables Changelog Destinations

Overview

Set up process #

brew install cloudquery/tap/cloudquery

1. Download CLI and login

See installation options

2. Create source and destination configs

Plugin configuration

cloudquery sync tailscale.yml postgresql.yml

3. Run the sync

CloudQuery sync

Overview #

The CloudQuery Tailscale plugin pulls configuration out of Tailscale resources and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more).

Authentication #

In order to fetch information from Tailscale, cloudquery needs to be authenticated. The suggested way is to use an OAuth client. The previous way of using an API key is also supported.

Example #

This example syncs from Tailscale to a Postgres destination, using OAuth authentication. The (top level) source spec section is described in the Source Spec Reference.

kind: source
# Common source-plugin configuration
spec:
  name: tailscale
  path: cloudquery/tailscale
  registry: cloudquery
  version: "v5.4.0"
  tables: ["*"]
  destinations: ["postgresql"]

  # plugin specific configuration
  spec:
    # required
    client_id: "${TAILSCALE_CLIENT_ID}"
    # required
    client_secret: "${TAILSCALE_CLIENT_SECRET}"
    # required
    tailnet: "${TAILSCALE_TAILNET}"
    # optional parameters
    # api_key: <API_KEY> # not recommended to use this, but can be used instead of client_id & client_secret
    # endpoint_url: "<YOUR_BASE_URL>"
    # concurrency: 20000

Spec #

This is the (nested) spec used by the Tailscale source plugin.

client_id (string) (required)
Client ID of the OAuth Client.
client_secret (string) (required)
Client secret of the OAuth Client (Make sure to use environment variable expansion and not hard code the keys in the config YAML).
tailnet (string) (required)
This is your Tailscale tailnet name (also known as organization name).
api_key (string) (optional)
This way of authentication is not recommended. An API key to access Tailscale resources. This can be obtained from Tailscale Keys Settings Page.
endpoint_url (string) (optional)
Endpoint URL to make the API requests to.
concurrency (integer) (optional) (default: 20000)
The best effort maximum number of Go routines to use. Lower this number to reduce memory usage.