Skip to content

doc: Document dedicated region access #16063

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kodiakhq merged 8 commits into from
Jan 5, 2024
+20 −6
Merged

doc: Document dedicated region access #16063

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
40b873e
tidy
candiduslynx Jan 5, 2024
1e55be7
add RegionMetadata spec
candiduslynx Jan 5, 2024
3316637
use custom region for discovery
candiduslynx Jan 5, 2024
8f1610d
doc
candiduslynx Jan 5, 2024
1147d3d
less diff
candiduslynx Jan 5, 2024
bb9b68f
no need for spec
candiduslynx Jan 5, 2024
ce652aa
github md, too
candiduslynx Jan 5, 2024
01b45bc
rm tf var
candiduslynx Jan 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions plugins/source/oracle/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import (
"fmt"
"strings"

"github.com/cloudquery/cloudquery/plugins/source/oracle/client/spec"
"github.com/cloudquery/plugin-sdk/v4/schema"
"github.com/oracle/oci-go-sdk/v65/common"
"github.com/oracle/oci-go-sdk/v65/identity"
Expand Down Expand Up @@ -36,7 +35,7 @@ type Client struct {
logger zerolog.Logger
}

func New(ctx context.Context, logger zerolog.Logger, _ spec.Spec) (schema.ClientMeta, error) {
func New(ctx context.Context, logger zerolog.Logger) (schema.ClientMeta, error) {
// common.DefaultRetryPolicy handles (409, IncorrectState), (429, TooManyRequests) + 5XX errors
defaultRetryPolicy := common.DefaultRetryPolicy()
common.GlobalRetry = &defaultRetryPolicy
Expand Down
20 changes: 18 additions & 2 deletions plugins/source/oracle/docs/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,26 @@ The following example sets up the Oracle plugin, and connects it to a postgresql

See [tables](/docs/plugins/sources/oracle/tables) for a full list of available tables.

## Oracle Spec
### Oracle Spec

This is the (nested) spec used by Oracle Source Plugin

- `concurrency` (int, optional, default: 10000):
- `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](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/dedicatedregions.htm) 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 `TF_VAR_region` environment variable
Comment thread
candiduslynx marked this conversation as resolved.
Outdated
* Set `region` value in the configuration file

2. Specify the dedicated region information:
The following options are available:
* Set `OCI_REGION_METADATA` [environment variable](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_adding_new_region_endpoints.htm#SDK_Adding_Regions_Environment_Variable)
* Add information to the [regions config file](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_adding_new_region_endpoints.htm#SDK_Adding_Regions_Config_File)
2 changes: 1 addition & 1 deletion plugins/source/oracle/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ require (
github.com/cloudquery/plugin-sdk/v4 v4.25.0
github.com/oracle/oci-go-sdk/v65 v65.28.3
github.com/rs/zerolog v1.31.0
github.com/stretchr/testify v1.8.4
golang.org/x/exp v0.0.0-20231226003508-02704c960a9b
)

Expand Down Expand Up @@ -88,7 +89,6 @@ require (
github.com/sony/gobreaker v0.5.0 // indirect
github.com/spf13/cobra v1.6.1 // indirect
github.com/spf13/pflag v1.0.5 // indirect
github.com/stretchr/testify v1.8.4 // indirect
github.com/tdewolff/minify/v2 v2.20.10 // indirect
github.com/tdewolff/parse/v2 v2.7.7 // indirect
github.com/thoas/go-funk v0.9.3 // indirect
Expand Down
2 changes: 1 addition & 1 deletion plugins/source/oracle/resources/plugin/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func (c *Client) Sync(ctx context.Context, options plugin.SyncOptions, res chan<
c.logger.Warn().Msg("State backend not supported in plugin, skipping")
}

schedulerClient, err := client.New(ctx, c.logger, c.config)
schedulerClient, err := client.New(ctx, c.logger)
if err != nil {
return err
}
Expand Down