From 072dec0aaff903326f1741b55588a1da67b1c076 Mon Sep 17 00:00:00 2001 From: Shannon Bradshaw Date: Mon, 17 Jan 2022 17:23:38 +0000 Subject: [PATCH] GitBook: [#83] Clarified when to use different authentication methods. --- docs/openmetadata/connectors/snowflake.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/openmetadata/connectors/snowflake.md b/docs/openmetadata/connectors/snowflake.md index 0676ac8661a..babdf0032fc 100644 --- a/docs/openmetadata/connectors/snowflake.md +++ b/docs/openmetadata/connectors/snowflake.md @@ -98,11 +98,11 @@ pip3 install 'openmetadata-ingestion[snowflake]' Create a new file called `snowflake.json` in the current directory. Note that the current directory should be the `openmetadata` directory you created in Step 1. -To create a configuration file for Snowflake, you’ll need to select one of the three options below and then customize the appropriate template to match your environment. +To create a configuration file for Snowflake, you’ll need to select one of the three options below and then customize the appropriate template to match your needs. -* SSO without Password -* SSO with Password -* Non-SSO +* Authenticate with SSO using an External Browser Popup +* Authenticate with SSO Specifying Provider, Username, and Password +* Authenticate with Username and Password The choice of a template depends on how your Snowflake user will be authenticated. @@ -112,7 +112,9 @@ Please select the form of authentication you will use for Snowflake and select t Note: The `source.config` field in the configuration JSON will include the majority of the settings for your connector. In the steps below we describe how to customize the key-value pairs in the `source.config` field to meet your needs. {% endhint %} -#### SSO without Password +#### Authenticate with SSO using an External Browser Popup + +Use this method to test metadata ingestion on a Snowflake instance to which you authenticate using single-sign-on (SSO). This method will pop up a browser window to enable you to authenticate using your SSO method. ```json { @@ -156,7 +158,9 @@ Note: The `source.config` field in the configuration JSON will include the major } ``` -#### SSO with Password +#### Authenticate with SSO Specifying Provider, Username, and Password + +Use this method to test metadata ingestion on a Snowflake instance to which you authenticate using single-sign-on (SSO). Using this method, you will specify a url for your authentication provider and a username and password that will authenticate against this provider. ```json { @@ -201,7 +205,9 @@ Note: The `source.config` field in the configuration JSON will include the major } ``` -#### Non-SSO +#### Authenticate with Username and Password + +Use this method in production OpenMetadata deployments in which you plan to configure scheduled metadata ingestion. For this method your Snowflake instance must support authentication using username and password. ```json {