Official

Orca source integration documentation

Name: CloudQuery Orca Integration
Author: CloudQuery

This plugin is in preview.

Sync from Orca to any destination

Publisher

cloudquery

Latest version

v2.10.13

Type

Source

Platforms

Date Published

Start Syncing

Overview Licenses

Overview #

The CloudQuery Orca plugin pulls data out of Orca and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more).

Authentication #

In order to fetch information from Orca, cloudquery needs to be authenticated. An API Token is required for authentication.

Orca Source Plugin Configuration Reference

Example #

This example syncs from Orca to a Postgres destination. The (top level) source spec section is described in the Source Spec Reference.

kind: source
spec:
  name: orca
  path: cloudquery/orca
  registry: cloudquery
  version: "v2.10.13"
  tables: ["orca_cloud_accounts"]
  destinations: ["postgresql"]

  # Learn more about the configuration options at https://cql.ink/orca_source
  spec:
    # required
    api_token: "${ORCA_API_TOKEN}"
    # optional
    # base_url: https://api.orcasecurity.io/api
    # cloud_account_ids: 
    #   - bbe3483c-cde3-477b-b882-4719f93aacdf
    #   - 5aa0f19f-a8e1-489d-9488-65d7b185ba77

Orca Spec #

This is the (nested) spec used by the Orca source plugin.

api_token (string) (required)
An API Token to access Orca resources.
base_url (string) (optional, default: https://api.orcasecurity.io/api)
The URL of the Orca API. With or without a trailing slash.
Should be set based on the region hosting your Orca backend. Defaults to the US backend.
For example:
```
# The following config will sync from the backend hosted in EU
spec:
  api_token: "${ORCA_API_TOKEN}"
  base_url: https://api.eu.orcasecurity.io/api
```
```
# Or the backend hosted in India
spec:
  api_token: "${ORCA_API_TOKEN}"
  base_url: https://api.in.orcasecurity.io/api
```
Refer to Orca's Regions and IPs documentation page for up to date list of API Domains.
cloud_account_ids ([]string) (default: empty. Will sync all accounts)
List of specific CloudAccounts to sync data from. Only these accounts will be synced.
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 are dfs (depth-first search), round-robin, shuffle and shuffle-queue.
For more information about this, see performance tuning.

Licenses #

The following tools / packages are used in this plugin:

Name	License
github.com/adrg/xdg	MIT
github.com/apache/arrow-go/v18	Apache-2.0
github.com/apache/arrow-go/v18	BSD-3-Clause
github.com/apache/arrow/go/v13	Apache-2.0
github.com/apache/arrow/go/v13	BSL-1.0
github.com/apache/arrow/go/v13	MIT
github.com/apache/arrow/go/v13	BSD-2-Clause
github.com/apache/arrow/go/v13	BSD-3-Clause
github.com/apache/arrow/go/v13	LicenseRef-C-Ares
github.com/apache/arrow/go/v13	OpenSSL
github.com/apache/arrow/go/v13	Zlib
github.com/apache/arrow/go/v13	NCSA
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/sync/singleflight	BSD-3-Clause
github.com/aws/aws-sdk-go-v2/internal/v4a	Apache-2.0
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/signin	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/aws/smithy-go/transport/http/protocol/internal/json/internal/stdlib	BSD-3-Clause
github.com/bahlo/generic-list-go	BSD-3-Clause
github.com/buger/jsonparser	MIT
github.com/cenkalti/backoff/v5	MIT
github.com/cespare/xxhash/v2	MIT
github.com/cloudquery/cloudquery-api-go	MPL-2.0
github.com/cloudquery/codegen/jsonschema/docs	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/getsentry/sentry-go	MIT
github.com/ghodss/yaml	MIT
github.com/ghodss/yaml	BSD-3-Clause
github.com/go-logr/logr	Apache-2.0
github.com/go-logr/stdr	Apache-2.0
github.com/goccy/go-json	MIT
github.com/google/flatbuffers/go	Apache-2.0
github.com/google/uuid	BSD-3-Clause
github.com/gorilla/mux	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	MIT
github.com/klauspost/compress	Apache-2.0
github.com/klauspost/compress	BSD-3-Clause
github.com/klauspost/compress/internal/snapref	BSD-3-Clause
github.com/klauspost/compress/zstd/internal/xxhash	MIT
github.com/mattn/go-colorable	MIT
github.com/mattn/go-isatty	MIT
github.com/oapi-codegen/runtime	Apache-2.0
github.com/pb33f/ordered-map/v2	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/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/zeebo/xxh3	BSD-2-Clause
go.opentelemetry.io/auto/sdk	Apache-2.0
go.opentelemetry.io/otel	Apache-2.0
go.opentelemetry.io/otel	BSD-3-Clause
go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp	Apache-2.0
go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp	BSD-3-Clause
go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp	Apache-2.0
go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp	BSD-3-Clause
go.opentelemetry.io/otel/exporters/otlp/otlptrace	Apache-2.0
go.opentelemetry.io/otel/exporters/otlp/otlptrace	BSD-3-Clause
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp	Apache-2.0
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp	BSD-3-Clause
go.opentelemetry.io/otel/log	Apache-2.0
go.opentelemetry.io/otel/log	BSD-3-Clause
go.opentelemetry.io/otel/metric	Apache-2.0
go.opentelemetry.io/otel/metric	BSD-3-Clause
go.opentelemetry.io/otel/sdk	Apache-2.0
go.opentelemetry.io/otel/sdk	BSD-3-Clause
go.opentelemetry.io/otel/sdk/log	Apache-2.0
go.opentelemetry.io/otel/sdk/log	BSD-3-Clause
go.opentelemetry.io/otel/sdk/metric	Apache-2.0
go.opentelemetry.io/otel/sdk/metric	BSD-3-Clause
go.opentelemetry.io/otel/trace	Apache-2.0
go.opentelemetry.io/otel/trace	BSD-3-Clause
go.opentelemetry.io/proto/otlp	Apache-2.0
go.yaml.in/yaml/v4	MIT
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

Loading plugin documentation

Overview #

The CloudQuery Orca plugin pulls data out of Orca and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more).

Authentication #

In order to fetch information from Orca, cloudquery needs to be authenticated. An API Token is required for authentication.

Orca Source Plugin Configuration Reference

Example #

This example syncs from Orca to a Postgres destination. The (top level) source spec section is described in the Source Spec Reference.

kind: source
spec:
  name: orca
  path: cloudquery/orca
  registry: cloudquery
  version: "v2.10.13"
  tables: ["orca_cloud_accounts"]
  destinations: ["postgresql"]

  # Learn more about the configuration options at https://cql.ink/orca_source
  spec:
    # required
    api_token: "${ORCA_API_TOKEN}"
    # optional
    # base_url: https://api.orcasecurity.io/api
    # cloud_account_ids: 
    #   - bbe3483c-cde3-477b-b882-4719f93aacdf
    #   - 5aa0f19f-a8e1-489d-9488-65d7b185ba77

Orca Spec #

This is the (nested) spec used by the Orca source plugin.

api_token (string) (required)
An API Token to access Orca resources.
base_url (string) (optional, default: https://api.orcasecurity.io/api)
The URL of the Orca API. With or without a trailing slash.
Should be set based on the region hosting your Orca backend. Defaults to the US backend.
For example:
```
# The following config will sync from the backend hosted in EU
spec:
  api_token: "${ORCA_API_TOKEN}"
  base_url: https://api.eu.orcasecurity.io/api
```
```
# Or the backend hosted in India
spec:
  api_token: "${ORCA_API_TOKEN}"
  base_url: https://api.in.orcasecurity.io/api
```
Refer to Orca's Regions and IPs documentation page for up to date list of API Domains.
cloud_account_ids ([]string) (default: empty. Will sync all accounts)
List of specific CloudAccounts to sync data from. Only these accounts will be synced.
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 are dfs (depth-first search), round-robin, shuffle and shuffle-queue.
For more information about this, see performance tuning.

Name

License

github.com/adrg/xdg

MIT

github.com/apache/arrow-go/v18

Apache-2.0

github.com/apache/arrow-go/v18

BSD-3-Clause