Remove unused credentials and deprecated purview settings (feathr-ai#708

) * Remove unused credentials and deprecated purview settings
hyingyang-linkedin · Oct 25, 2022 · ecdf585 · ecdf585
1 parent ce32b17
commit ecdf585
Show file tree

Hide file tree

Showing 7 changed files with 7 additions and 29 deletions.
diff --git a/docs/how-to-guides/azure-deployment-cli.md b/docs/how-to-guides/azure-deployment-cli.md
@@ -117,7 +117,6 @@ echo "AZURE_TENANT_ID: $sp_tenantid"
 echo "AZURE_CLIENT_SECRET: $sp_password"
 This will give three variables: AZURE_CLIENT_ID, AZURE_TENANT_ID and AZURE_CLIENT_SECRET. You will need them later.
 ```
-
 Note: **You should save AZURE_CLIENT_SECRET because you will only see it once here**
 
 ## Create a storage account

diff --git a/docs/how-to-guides/feathr-configuration-and-env.md b/docs/how-to-guides/feathr-configuration-and-env.md
@@ -77,9 +77,9 @@ Feathr will get the configurations in the following order:
 | ONLINE_STORE__REDIS__SSL_ENABLED                      | Whether SSL is enabled to access Redis cluster.                                                                                                                                                                                                                                    | Required if using Redis as online store.                                  |
 | REDIS_PASSWORD                                        | Password for the Redis cluster.                                                                                                                                                                                                                                                    | Required if using Redis as online store.                                  |
 | FEATURE_REGISTRY__API_ENDPOINT                        | Specifies registry endpoint.                                                                                                                                                                                                                                                       | Required if using registry service.                                       |
-| FEATURE_REGISTRY__PURVIEW__PURVIEW_NAME               | Configure the name of the purview endpoint.                                                                                                                                                                                                                                        | Required if using Purview directly without registry service. Deprecate soon, see [here](#deprecation) for more details.|
-| FEATURE_REGISTRY__PURVIEW__DELIMITER                  | See [here](#FEATURE_REGISTRY__PURVIEW__DELIMITER) for more details.                                                                                                                                                                                                                | Required if using Purview directly without registry service. Deprecate soon, see [here](#deprecation) for more details.|
-| FEATURE_REGISTRY__PURVIEW__TYPE_SYSTEM_INITIALIZATION | Controls whether the type system (think this as the "schema" for the registry) will be initialized or not. Usually this is only required to be set to `True` to initialize schema, and then you can set it to `False` to shorten the initialization time.                          | Required if using Purview directly without registry service. Deprecate soon, see [here](#deprecation) for more details.|
+| FEATURE_REGISTRY__PURVIEW__PURVIEW_NAME  (Deprecated Soon)             | Configure the name of the purview endpoint.                                                                                                                                                                                                                                        | Required if using Purview directly without registry service. Deprecate soon, see [here](#deprecation) for more details.|
+| FEATURE_REGISTRY__PURVIEW__DELIMITER  (Deprecated Soon)           | See [here](#FEATURE_REGISTRY__PURVIEW__DELIMITER) for more details.                                                                                                                                                                                                                | Required if using Purview directly without registry service. Deprecate soon, see [here](#deprecation) for more details.|
+| FEATURE_REGISTRY__PURVIEW__TYPE_SYSTEM_INITIALIZATION (Deprecated Soon)| Controls whether the type system (think this as the "schema" for the registry) will be initialized or not. Usually this is only required to be set to `True` to initialize schema, and then you can set it to `False` to shorten the initialization time.                          | Required if using Purview directly without registry service. Deprecate soon, see [here](#deprecation) for more details.|
 
 # Explanation for selected configurations
 

diff --git a/docs/quickstart_synapse.md b/docs/quickstart_synapse.md
@@ -61,9 +61,6 @@ project_config:
     # Redis password for your online store
     - "REDIS_PASSWORD"
     # Client IDs and Client Secret for the service principal. Read the getting started docs on how to get those information.
-    - "AZURE_CLIENT_ID"
-    - "AZURE_TENANT_ID"
-    - "AZURE_CLIENT_SECRET"
 
 offline_store:
 ---
@@ -98,9 +95,6 @@ These values can also be retrieved by using cloud key value store, such as [Azur
 ```python
 import os
 os.environ['REDIS_PASSWORD'] = ''
-os.environ['AZURE_CLIENT_ID'] = ''
-os.environ['AZURE_TENANT_ID'] = ''
-os.environ['AZURE_CLIENT_SECRET'] = ''
 ```
 
 Please refer to [A note on using azure key vault to store credentials](https://github.com/feathr-ai/feathr/blob/41e7496b38c43af6d7f8f1de842f657b27840f6d/docs/how-to-guides/feathr-configuration-and-env.md#a-note-on-using-azure-key-vault-to-store-credentials) for more details.

diff --git a/docs/samples/customer360/Customer360.ipynb b/docs/samples/customer360/Customer360.ipynb
@@ -192,9 +192,6 @@
             "  project_name: 'customer360'\n",
             "  required_environment_variables:\n",
             "    - 'REDIS_PASSWORD'\n",
-            "    - 'AZURE_CLIENT_ID'\n",
-            "    - 'AZURE_TENANT_ID'\n",
-            "    - 'AZURE_CLIENT_SECRET'\n",
             "    - 'ADLS_ACCOUNT'\n",
             "    - 'ADLS_KEY'\n",
             "    - 'WASB_ACCOUNT'\n",
@@ -239,10 +236,7 @@
             "    port: 6380\n",
             "    ssl_enabled: True\n",
             "feature_registry:\n",
-            "  purview:\n",
-            "    type_system_initialization: true\n",
-            "    purview_name: '<replace_with_your_purview>'\n",
-            "    delimiter: '__'\n",
+            "  api_endpoint: \"https://<replace_with_your_api_endpoint>.azurewebsites.net/api/v1\"\n",
             "\"\"\"\n",
             "# write this configuration string to a temporary location and load it to Feathr\n",
             "tmp = tempfile.NamedTemporaryFile(mode='w', delete=False)\n",
@@ -331,9 +325,6 @@
          "source": [
             "import os\n",
             "os.environ['REDIS_PASSWORD'] = ''\n",
-            "os.environ['AZURE_CLIENT_ID'] = ''\n",
-            "os.environ['AZURE_TENANT_ID'] = ''\n",
-            "os.environ['AZURE_CLIENT_SECRET'] = ''\n",
             "os.environ['ADLS_ACCOUNT'] = ''\n",
             "os.environ['ADLS_KEY'] = ''\n",
             "os.environ['WASB_ACCOUNT'] = \"\"\n",

diff --git a/docs/samples/databricks/databricks_quickstart_nyc_taxi_driver.ipynb b/docs/samples/databricks/databricks_quickstart_nyc_taxi_driver.ipynb
@@ -332,9 +332,6 @@
         "  project_name: 'feathr_getting_started2'\n",
         "  required_environment_variables:\n",
         "    - 'REDIS_PASSWORD'\n",
-        "    - 'AZURE_CLIENT_ID'\n",
-        "    - 'AZURE_TENANT_ID'\n",
-        "    - 'AZURE_CLIENT_SECRET'\n",
         "offline_store:\n",
         "  adls:\n",
         "    adls_enabled: true\n",
@@ -364,10 +361,7 @@
         "    port: 6380\n",
         "    ssl_enabled: True\n",
         "feature_registry:\n",
-        "  purview:\n",
-        "    type_system_initialization: true\n",
-        "    purview_name: '<replace_with_your_purview>'\n",
-        "    delimiter: '__'\n",
+        "  api_endpoint: \"https://<replace_with_your_api_endpoint>.azurewebsites.net/api/v1\"\n",
         "\"\"\"\n",
         "tmp = tempfile.NamedTemporaryFile(mode='w', delete=False)\n",
         "with open(tmp.name, \"w\") as text_file:\n",

diff --git a/docs/samples/product_recommendation_demo.ipynb b/docs/samples/product_recommendation_demo.ipynb
@@ -260,7 +260,7 @@
         "\n",
         "You should setup the environment variables in order to run this sample. More environment variables can be set by referring to [feathr_config.yaml](https://github.com/linkedin/feathr/blob/main/feathr_project/feathrcli/data/feathr_user_workspace/feathr_config.yaml) and use that as the source of truth. It also has more explanations on the meaning of each variable.\n",
         "\n",
-        "To run this notebook, for Azure users, you need AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET and REDIS_PASSWORD.\n",
+        "To run this notebook, for Azure users, you need REDIS_PASSWORD.\n",
         "To run this notebook, for Databricks useres, you need DATABRICKS_WORKSPACE_TOKEN_VALUE and REDIS_PASSWORD."
       ]
     },

diff --git a/docs/samples/product_recommendation_demo_advanced.ipynb b/docs/samples/product_recommendation_demo_advanced.ipynb
@@ -389,7 +389,7 @@
             "\n",
             "You should setup the environment variables in order to run this sample. More environment variables can be set by referring to [feathr_config.yaml](https://github.com/linkedin/feathr/blob/main/feathr_project/feathrcli/data/feathr_user_workspace/feathr_config.yaml) and use that as the source of truth. It also has more explanations on the meaning of each variable.\n",
             "\n",
-            "To run this notebook, for Azure users, you need AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET and REDIS_PASSWORD.\n",
+            "To run this notebook, for Azure users, you need REDIS_PASSWORD.\n",
             "To run this notebook, for Databricks useres, you need DATABRICKS_WORKSPACE_TOKEN_VALUE and REDIS_PASSWORD."
          ]
       },