Authentication #

Example #

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

  # plugin specific configuration
  # Learn more about the configuration options at https://cql.ink/tailscale_source
  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 #

• 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)

  A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
• scheduler (string) (optional) (default: dfs)

  The scheduler to use when determining the priority of resources to sync. Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.

  For more information about this, see performance tuning.