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

3. Run the sync

CloudQuery sync

Overview #

The CloudQuery Confluence plugin extracts Confluence information and loads it into any supported CloudQuery destination. It is based on the Confluence API.

Authentication #

In order for CloudQuery to sync resources from your Confluence setup, you will need to use one of the supported authentication methods. More detials on each method are provided in the configuration reference section.

Example Configuration #

kind: source
spec:
  name: "confluence"
  path: "cloudquery/confluence"
  registry: cloudquery
  version: "v1.0.2"
  destinations: ["postgresql"]
  tables: ["*"]
  spec:
    auth_method: api_key
    # Note that [email protected] here is the email address for the Atlassian account you're using to create the token
    username: "[email protected]"
    api_key: ${CONFLUENCE_API_KEY}
    base_url: "https://mycompany.atlassian.net"

Configuration Reference #

This is the (nested) spec used by the Confluence source plugin:

base_url (string) (required)
Your Confluence base URL. For hosted versions URI is https://your_account_name.atlassian.net/
auth_method (string) (optional, default: api_key)
This plugin supports different authentication methods when communicating with the Confluence API. Depending on the chosen authentication method, additional configuration parameters are required.
Supported values are api_key and bearer_token. If the api_key method is selected, the following additional configuration parameters will be used. If the bearer_token method is selected, the following additional configuration parameters will be used.
concurrency (integer) (optional, default: 10)
The best effort maximum number of Go routines to use. Lower this number to reduce memory usage.

API Key Configuration Reference #

To use this authentication method, you will need to generate a Confluence API Key.

username (string) (required)
The username to authenticate with.
api_key (string) (required)
Personal access key to authenticate with (recommendation: Use environment variable instead of hardcoded the key in the config).

Bearer Token Configuration Reference #

To use this authentication method, you will need an OAuth 2.0 integration.

bearer_token (string) (required)
The OAuth 2.0 Bearer Token to authenticate with (recommendation: Use environment variable instead of hardcoded the token in the config).