Skip to content

Commit

Permalink
Resolve code review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
blrchen committed Aug 5, 2022
1 parent 60dae88 commit 25c05c6
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/how-to-guides/feathr-configuration-and-env.md
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 | [Deprecated Soon] Configure the name of the purview endpoint. | Required if using Purview as the endpoint. |
| FEATURE_REGISTRY__PURVIEW__DELIMITER | [Deprecated Soon] See [here](#FEATURE_REGISTRY__PURVIEW__DELIMITER) for more details. | Required |
| 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 |
| 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.|

# Explanation for selected configurations

Expand Down Expand Up @@ -122,6 +122,11 @@ Another use case is to use `instance_pool_id`, where instead of creating the Spa

Other advanced settings includes `idempotency_token` to guarantee the idempotency of job run requests, etc.

## Deprecation

This section is about deprecation of some features in Feathr. Deprecated features are still available but planned for removal. Please migrate to the supported features as early as possible.
- Connect to Purview directly without registry service is deprecated soon. Please use registry service to connect to Purview.

## FEATURE_REGISTRY__PURVIEW__DELIMITER

Delimiter indicates that how the project name, feature names etc. are delimited. By default it will be '__'. this is for global reference (mainly for feature sharing). For example, when we setup a project called foo, and we have an anchor called 'taxi_driver' and the feature name is called 'f_daily_trips'. the feature will have a global unique name called 'foo__taxi_driver__f_daily_trips'
Expand Down

0 comments on commit 25c05c6

Please sign in to comment.