Back to source list
Official
Premium
Oracle
The CloudQuery Oracle plugin extracts Oracle Cloud Infrastructure data and loads it into any supported CloudQuery destination
Publisher
cloudquery
Latest version
v7.5.0
Type
Source
Platforms
Date Published
Price per 1M rows
Starting from $17
monthly free quota
1M rows
Set up process #
brew install cloudquery/tap/cloudquery1. Download CLI and login
2. Create source and destination configs
Plugin configurationOverview #
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-1Option 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 PRIVATEConfiguration #
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: "v7.5.0"
destinations: ["postgresql"]
tables: ["oracle_compute_instances"]
# Learn more about the configuration options at https://cql.ink/oracle_source
spec:
# Optional parameters
# concurrency: 10000See 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)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 aredfs(depth-first search),round-robin,shuffleandshuffle-queue.For more information about this, see performance tuning.
Dedicated regions #
OCI Dedicated regions can be accessed via the following procedure:
- Specify the region to be used for the discovery as the dedicated region. The following options are available:
- Set
OCI_CLI_regionenvironment variable - Set
regionvalue in the configuration file
- Specify the dedicated region information: The following options are available:
- Set
OCI_REGION_METADATAenvironment variable - Add information to the regions config file
Licenses #
The following tools / packages are used in this plugin:
| Name | License |
|---|---|
| github.com/adrg/xdg | MIT |
| github.com/apache/arrow/go/v13 | Apache-2.0 |
| github.com/apache/arrow/go/v17 | Apache-2.0 |
| github.com/apapsch/go-jsonmerge/v2 | MIT |
| github.com/aws/aws-sdk-go-v2 | Apache-2.0 |
| github.com/aws/aws-sdk-go-v2/config | Apache-2.0 |
| github.com/aws/aws-sdk-go-v2/credentials | Apache-2.0 |
| github.com/aws/aws-sdk-go-v2/feature/ec2/imds | Apache-2.0 |
| github.com/aws/aws-sdk-go-v2/internal/configsources | Apache-2.0 |
| github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 | Apache-2.0 |
| github.com/aws/aws-sdk-go-v2/internal/ini | Apache-2.0 |
| github.com/aws/aws-sdk-go-v2/internal/sync/singleflight | BSD-3-Clause |
| github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding | Apache-2.0 |
| github.com/aws/aws-sdk-go-v2/service/internal/presigned-url | Apache-2.0 |
| github.com/aws/aws-sdk-go-v2/service/licensemanager | Apache-2.0 |
| github.com/aws/aws-sdk-go-v2/service/marketplacemetering | Apache-2.0 |
| github.com/aws/aws-sdk-go-v2/service/sso | Apache-2.0 |
| github.com/aws/aws-sdk-go-v2/service/ssooidc | Apache-2.0 |
| github.com/aws/aws-sdk-go-v2/service/sts | Apache-2.0 |
| github.com/aws/smithy-go | Apache-2.0 |
| github.com/aws/smithy-go/internal/sync/singleflight | BSD-3-Clause |
| github.com/bahlo/generic-list-go | BSD-3-Clause |
| github.com/buger/jsonparser | MIT |
| github.com/cenkalti/backoff/v4 | MIT |
| github.com/cloudquery/cloudquery-api-go | MPL-2.0 |
| github.com/cloudquery/plugin-pb-go | MPL-2.0 |
| github.com/cloudquery/plugin-sdk/v2/internal/glob | MIT |
| github.com/cloudquery/plugin-sdk/v2/schema | MIT |
| github.com/cloudquery/plugin-sdk/v2/types | MPL-2.0 |
| github.com/cloudquery/plugin-sdk/v4 | MPL-2.0 |
| github.com/cloudquery/plugin-sdk/v4/glob | MIT |
| github.com/cloudquery/plugin-sdk/v4/scalar | MIT |
| github.com/davecgh/go-spew/spew | ISC |
| github.com/ghodss/yaml | MIT |
| github.com/go-logr/logr | Apache-2.0 |
| github.com/go-logr/stdr | Apache-2.0 |
| github.com/goccy/go-json | MIT |
| github.com/gofrs/flock | BSD-3-Clause |
| github.com/golang/mock/gomock | Apache-2.0 |
| github.com/google/flatbuffers/go | Apache-2.0 |
| github.com/google/uuid | BSD-3-Clause |
| github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors | Apache-2.0 |
| github.com/grpc-ecosystem/grpc-gateway/v2 | BSD-3-Clause |
| github.com/hashicorp/go-cleanhttp | MPL-2.0 |
| github.com/hashicorp/go-retryablehttp | MPL-2.0 |
| github.com/invopop/jsonschema | MIT |
| github.com/klauspost/compress | Apache-2.0 |
| github.com/klauspost/compress/internal/snapref | BSD-3-Clause |
| github.com/klauspost/compress/zstd/internal/xxhash | MIT |
| github.com/mailru/easyjson | MIT |
| github.com/mattn/go-colorable | MIT |
| github.com/mattn/go-isatty | MIT |
| github.com/oapi-codegen/runtime | Apache-2.0 |
| github.com/oracle/oci-go-sdk/v65 | Apache-2.0 |
| github.com/pierrec/lz4/v4 | BSD-3-Clause |
| github.com/pmezard/go-difflib/difflib | BSD-3-Clause |
| github.com/rs/zerolog | MIT |
| github.com/samber/lo | MIT |
| github.com/santhosh-tekuri/jsonschema/v6 | Apache-2.0 |
| github.com/sony/gobreaker | MIT |
| github.com/spf13/cobra | Apache-2.0 |
| github.com/spf13/pflag | BSD-3-Clause |
| github.com/stretchr/testify | MIT |
| github.com/thoas/go-funk | MIT |
| github.com/wk8/go-ordered-map/v2 | Apache-2.0 |
| github.com/zeebo/xxh3 | BSD-2-Clause |
| go.opentelemetry.io/otel | Apache-2.0 |
| go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp | Apache-2.0 |
| go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp | Apache-2.0 |
| go.opentelemetry.io/otel/exporters/otlp/otlptrace | Apache-2.0 |
| go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp | Apache-2.0 |
| go.opentelemetry.io/otel/log | Apache-2.0 |
| go.opentelemetry.io/otel/metric | Apache-2.0 |
| go.opentelemetry.io/otel/sdk | Apache-2.0 |
| go.opentelemetry.io/otel/sdk/log | Apache-2.0 |
| go.opentelemetry.io/otel/sdk/metric | Apache-2.0 |
| go.opentelemetry.io/otel/trace | Apache-2.0 |
| go.opentelemetry.io/proto/otlp | Apache-2.0 |
| golang.org/x/exp | BSD-3-Clause |
| golang.org/x/net | BSD-3-Clause |
| golang.org/x/sync | BSD-3-Clause |
| golang.org/x/sys | BSD-3-Clause |
| golang.org/x/text | BSD-3-Clause |
| golang.org/x/xerrors | BSD-3-Clause |
| google.golang.org/genproto/googleapis/api/httpbody | Apache-2.0 |
| google.golang.org/genproto/googleapis/rpc/status | Apache-2.0 |
| google.golang.org/grpc | Apache-2.0 |
| google.golang.org/protobuf | BSD-3-Clause |
| gopkg.in/yaml.v2 | Apache-2.0 |
| gopkg.in/yaml.v3 | MIT |