Inventory Configuration
Inventory Configuration
Object.
This section describes inventory configuration file structure. This file, usually named inventory.yaml
, can be referenced via --inventory-file
option of the command line interface.
Properties
-
data_sources
:Inventory
.
Inventory
Used in: data_sources
map of String keys to`Inventory Datasource`.
Mapping of identifiers to database connection details. The identifiers can be used in a transformation configuration to refer to the databases without leaking the connection details to the configuration.
Please note that the following CLI options are equivalent to the inventory data sources
with one source (with the name
If these options are specified together with |
Inventory Datasource
Used in: data_sources
Object.
The database connection details.
Properties
-
jdbc_url
:String.
-
user
:Credentials
.
-
password
:Credentials
.
-
read_only
:Boolean.
Indicates if the data source can be used as source only (default: false)
Credentials
Object.
Depending on type
property value, can be one of the following:
|
|
|
|
|
|
|
RawCredentials
Raw credentials, no integration with secret managers required
Properties
-
type = raw
-
value
:String.
GcpCredentials
The values stored in Google Cloud Secret Manager
Properties
-
type = gcp
-
project
:String.
-
secret
:String.
-
version
:String.
AwsCredentials
The values stored in AWS Secrets Manager
Properties
-
type = aws
-
secret
:String.
The ARN or name of the secret to retrieve.
-
version
:String.
The unique identifier of the version of the secret to retrieve. If you don’t specify the version, then theAWSCURRENT
version is used.
VaultCredentials
The values stored in Hashicorp Vault
Properties
-
type = vault
-
storage
:String.
The name of the secret storage (e.g. "secret", "database", "cubbyhole", etc).
-
path
:String.
The mount path of the secret.
-
secret
:String.
The name of the secret to retrieve.
-
versioned
:Boolean.
Indicates if the current secret storage is versioned ("false" by default).
-
version
:String.
The unique identifier of the version of the secret to retrieve. Using 0 as the default value for the current version.