cq-source-hrobot

README

CloudQuery Scaleway Source Plugin

A Hetzner Robot source plugin for CloudQuery that loads data from Hetzner Robot WebService API to any database, data warehouse or data lake supported by CloudQuery, such as PostgreSQL, BigQuery, Athena, and many more.

Links

• CloudQuery Quickstart Guide
• Supported Tables

Authentication

Credentials are used from the HETZNER_TOKEN environment variable with format "{robot-generated-username}:{password}".

For more information on how to obtain an account, refer to the official Hetzner Robot documentation.

Additionally, to use the Server ordering endpoints such as standard server products and the market market ones, follow the official instructions.

Configuration

The following source configuration file will sync all data from Scaleway to a PostgreSQL database. See the CloudQuery Quickstart for more information on how to configure the source and destination.

kind: source
spec:
  name: "serverness"
  path: "serverness/hrobot"
  version: "${VERSION}"
  tables:
    - "*"
  skip_tables:
    - "hrobot_order_market_servers"
  destinations: 
    - "postgresql"
  backend: local
  spec:
    # plugin spec section

Plugin Spec

Development

Run tests

make test

Run linter

make lint

Generate docs

make gen-docs

Release a new version

1. Run git tag v1.0.0 to create a new tag for the release (replace v1.0.0 with the new version number)
2. Run git push origin v1.0.0 to push the tag to GitHub

Once the tag is pushed, a new GitHub Actions workflow will be triggered to build the release binaries and create the new release on GitHub. To customize the release notes, see the Go releaser changelog configuration docs.