Official

Premium

Orb

This plugin is in preview.

The CloudQuery Orb plugin pulls data from the Orb usage-based billing platform APIs and loads it into any supported CloudQuery destination. https://www.withorb.com/

Publisher

cloudquery

Latest version

v1.1.0

Type

Source

Platforms

Date Published

October 22, 2024

Price

Free while in preview

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 orb.yml postgresql.yml

3. Run the sync

CloudQuery sync

Overview #

Orb Source Plugin

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

Authentication #

In order for CloudQuery to sync resources from your Orb setup, you will need to use an Orb API key. More details on each method are provided in the configuration reference section.

Example Configuration #

kind: source
spec:
  name: "orb"
  path: "cloudquery/orb"
  registry: cloudquery
  version: "v1.1.0"
  destinations: ["postgresql"]
  tables: ["*"]
  # Learn more about the configuration options at https://cql.ink/orb_source
  spec:
    api_key: ${ORB_API_KEY}
    # Optional:
    # page_fetch_limit: 500
    # max_retries: 3
    # timeframe_start: 2023-01-01T00:00:00Z
    # timeframe_end: 2024-01-01T00:00:00Z
    # concurrency: 50000

Configuration Reference #

This is the spec used by the Orb source plugin:

api_key (string) (required)
Orb API key to authenticate with (recommendation: Use environment variable instead of hardcoded the key in the config).
page_fetch_limit (integer) (optional, default: 500)
The maximum number of items to fetch in a single request.
max_retries (integer) (optional, default: 3)
The maximum number of times to retry a failed request.
timeframe_start (string) (optional)
A date-time string in RFC3339 format. For example, "2024-01-01T00:00:00Z" will sync all items created on or after January 1, 2024. If not specified, the plugin will fetch items from the past year.
timeframe_end (string) (optional)
A date-time string in RFC3339 format. For example, "2024-01-01T00:00:00Z" will sync all items created before January 1, 2024. If not specified, the plugin will fetch items up to the current time.
concurrency (integer, optional, default: 50000) 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.