diff --git a/openmetadata-docs/content/connectors/database/snowflake/cli.md b/openmetadata-docs/content/connectors/database/snowflake/cli.md index 41c368bd7df..3644824513c 100644 --- a/openmetadata-docs/content/connectors/database/snowflake/cli.md +++ b/openmetadata-docs/content/connectors/database/snowflake/cli.md @@ -133,7 +133,9 @@ source: account: # database: # hostPort: account.region.service.snowflakecomputing.com - # privateKey: + # privateKey: | + # + # <...> # snowflakePrivatekeyPassphrase: # role: sourceConfig: @@ -182,8 +184,9 @@ workflowConfig: - **role**: Enter the details of the Snowflake Account Role. This is an optional detail. - **warehouse**: Warehouse name. - **database**: The database of the data source is an optional parameter, if you would like to restrict the metadata reading to a single database. If left blank, OpenMetadata ingestion attempts to scan all the databases. -- **privateKey**: Connection to Snowflake instance via Private Key. -- **snowflakePrivatekeyPassphrase**: Snowflake Passphrase Key used with Private Key. +- **privateKey**: Connection to Snowflake instance via Private Key instead of a Password. + - The multi-line key needs to be correctly formatted in YAML so a literal block scalar which retains new lines is recommended (`|`). +- **snowflakePrivatekeyPassphrase**: Snowflake Passphrase Key used with and encrypted Private Key. - **Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to Snowflake during the connection. These details must be added as Key-Value pairs. - **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Snowflake during the connection. These details must be added as Key-Value pairs. - In case you are using Single-Sign-On (SSO) for authentication, add the `authenticator` details in the Connection Arguments as a Key-Value pair as follows: `"authenticator" : "sso_login_url"` diff --git a/openmetadata-docs/content/connectors/database/snowflake/index.md b/openmetadata-docs/content/connectors/database/snowflake/index.md index 0421d74d19a..45b64827ca3 100644 --- a/openmetadata-docs/content/connectors/database/snowflake/index.md +++ b/openmetadata-docs/content/connectors/database/snowflake/index.md @@ -207,8 +207,9 @@ the changes. - **Role (Optional)**: Enter the details of the Snowflake Account Role. This is an optional detail. - **Warehouse**: Warehouse name. - **Database (Optional)**: The database of the data source is an optional parameter, if you would like to restrict the metadata reading to a single database. If left blank, OpenMetadata ingestion attempts to scan all the databases. -- **Private Key (Optional)**: Connection to Snowflake instance via Private Key. -- **Snowflake Passphrase Key (Optional)**: Snowflake Passphrase Key used with Private Key. +- **Private Key (Optional)**: Connection to Snowflake instance via Private Key instead of a Password. + - The multi-line key needs to be converted to one line with `\n` for line endings i.e. `-----BEGIN ENCRYPTED PRIVATE KEY-----\nMII...\n...\n-----END ENCRYPTED PRIVATE KEY-----` +- **Snowflake Passphrase Key (Optional)**: Snowflake Passphrase Key used with an encrypted Private Key. - **Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to Snowflake during the connection. These details must be added as Key-Value pairs. - **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Snowflake during the connection. These details must be added as Key-Value pairs. - In case you are using Single-Sign-On (SSO) for authentication, add the `authenticator` details in the Connection Arguments as a Key-Value pair as follows: `"authenticator" : "sso_login_url"`