yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-08-23 16:38:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tips on how to format and private key for the UI and in YAML (#10370)

Browse Source 
Co-authored-by: kcd <1108143-kcd@users.noreply.gitlab.com>
This commit is contained in:
kcd83 2023-03-01 09:18:21 +13:00 committed by GitHub
parent 40b68ca841
commit c0f06191b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
openmetadata-docs/content/connectors/database/snowflake/cli.md
View File

@ -133,7 +133,9 @@ source:
account: <account>
# database: <database>
# hostPort: account.region.service.snowflakecomputing.com
# privateKey: <privateKey>
# privateKey: |
# <privateKey>
# <...>
# snowflakePrivatekeyPassphrase: <passphrase>
# role: <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"`

5
openmetadata-docs/content/connectors/database/snowflake/index.md
View File

@ -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"`