Skip to content

Remove unused credentials and deprecated purview settings #708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
enya-yx merged 4 commits into from
Oct 12, 2022
Merged

Remove unused credentials and deprecated purview settings #708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bf84b36
remove unused credentials and deprcated purview settings
Sep 27, 2022
538e4a5
fix typo
Sep 27, 2022
84bc071
quick fix
Sep 30, 2022
1afb3bc
quick fix
Sep 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/how-to-guides/azure-deployment-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Comment thread
enya-yx marked this conversation as resolved.
```

Note: **You should save AZURE_CLIENT_SECRET because you will only see it once here**

## Create a storage account
Expand Down
6 changes: 3 additions & 3 deletions docs/how-to-guides/feathr-configuration-and-env.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 0 additions & 6 deletions docs/quickstart_synapse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
---
Expand Down Expand Up @@ -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.
Expand Down
11 changes: 1 addition & 10 deletions docs/samples/customer360/Customer360.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
8 changes: 1 addition & 7 deletions docs/samples/databricks/databricks_quickstart_nyc_taxi_driver.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion docs/samples/product_recommendation_demo.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
]
},
Expand Down
2 changes: 1 addition & 1 deletion docs/samples/product_recommendation_demo_advanced.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
]
},
Expand Down