Back to plugin list
oracle
Official

Oracle

The CloudQuery Oracle plugin extracts Oracle Cloud Infrastructure data and loads it into any supported CloudQuery destination

Publisher

cloudquery

Repositorygithub.com
Latest version

v4.3.5

Type

Source

Platforms
Date Published

Price

Free

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

3. Run the sync

CloudQuery sync

Overview

Oracle Source Plugin

The CloudQuery Oracle plugin extracts Oracle Cloud Infrastructure data (oci) and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more). It is based on the OCI Go SDK and the Oracle Cloud REST API.

Authentication

In order for CloudQuery to sync resources from your Oracle Cloud setup, you will need to authenticate with your Oracle Cloud account. CloudQuery supports the same authentication methods as the OCI Go SDK, and uses the "default" configuration provider. You can read about how to create an Oracle Cloud configuration file in https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm.
 

Option 1: Config file

An example configuration file (e.g. in ~/.oci/config) looks like this:
[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
region=us-ashburn-1

Option 2: Environment variables

Environment variables can be either prefixed with OCI_CLI or TF_VAR (e.g. OCI_CLI_tenancy_ocid or TF_VAR_tenancy_ocid). See the documentation for a full list of available variables.
Example environment variables:
export OCI_CLI_security_token_file=/path/to/token/file
export OCI_CLI_fingerprint="<your_fingerprint>"
export OCI_CLI_tenancy_ocid="ocid1.tenancy.oc1..<unique_ID>"
export OCI_CLI_user_ocid="ocid1.user.oc1..<unique_ID>"
export OCI_CLI_region="us-ashburn-1"
export OCI_CLI_private_key_path="~/.oci/oci_api_key.pem"
# Can be used instead of `OCI_CLI_private_key_path`, starting from version v4.3.0 of the Oracle source plugin
export OCI_CLI_private_key="<raw-content-of-private-key-with-line-breaks-replaced-with-\n>" # e.g. -----BEGIN PRIVATE KEY-----\n<private-key-content>\n-----END PRIVATE

Configuration

In order to get started with the Oracle plugin, you need to create a YAML file in your CloudQuery configuration directory (e.g. named oracle.yml).
The following example sets up the Oracle plugin, and connects it to a postgresql destination:
kind: source
spec:
  name: "oracle"
  path: cloudquery/oracle
  registry: cloudquery
  version: "v4.3.5"
  destinations: ["postgresql"]
  tables: ["oracle_compute_instances"]
  spec:
    # Optional parameters
    # concurrency: 10000
See tables for a full list of available tables.

Oracle Spec

This is the (nested) spec used by Oracle Source Plugin
  • concurrency (integer) (optional) (default: 10000)
    The best effort maximum number of Go routines to use. Lower this number to reduce memory usage.

Dedicated regions

OCI Dedicated regions can be accessed via the following procedure:
  1. Specify the region to be used for the discovery as the dedicated region. The following options are available:
    • Set OCI_CLI_region environment variable
    • Set region value in the configuration file
  2. Specify the dedicated region information: The following options are available:


Subscribe to product updates

Be the first to know about new features.