diff --git a/README.md b/README.md index 04c6ccb..f47e10f 100644 --- a/README.md +++ b/README.md @@ -31,14 +31,16 @@ async def create_actor(dispatch: DispatchInfo, receiver: Receiver[DispatchInfo]) async def run(): url = os.getenv("DISPATCH_API_URL", "grpc://dispatch.url.goes.here.example.com") - key = os.getenv("DISPATCH_API_KEY", "some-key") + auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "some-key") + sign_secret = os.getenv("DISPATCH_API_SIGN_SECRET") microgrid_id = 1 async with Dispatcher( microgrid_id=microgrid_id, server_url=url, - key=key, + auth_key=auth_key, + sign_secret=sign_secret, ) as dispatcher: await dispatcher.start_managing( dispatch_type="EXAMPLE_TYPE", diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 0fc1f87..af271ed 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -2,12 +2,13 @@ ## Summary - +This is the first major version release with authentication parameter updates and dependency version expansion. ## Upgrading -* The `key` parameter in the `Dispatcher` constructor is now deprecated. Use `auth_key` instead. The `sign_secret` parameter is an additional optional parameter for signing. -* The `components` property in `DispatchInfo` is now deprecated. Use `target` instead. +* The `key` parameter in the `Dispatcher` constructor is deprecated. Use `auth_key` instead. +* The `sign_secret` parameter is available and should be used for authentication. It will be soon required. +* The `components` property in `DispatchInfo` is deprecated. Use `target` instead. ## New Features diff --git a/pyproject.toml b/pyproject.toml index e07547d..489f06e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,7 +40,7 @@ dependencies = [ # plugins.mkdocstrings.handlers.python.import) "frequenz-sdk >= 1.0.0-rc2100, < 1.0.0-rc2200", "frequenz-channels >= 1.6.1, < 2.0.0", - "frequenz-client-dispatch >= 0.11.3, < 0.12.0", + "frequenz-client-dispatch >= 0.11.3, < 1.0.0", "frequenz-client-base >= 0.11.0, < 0.12.0", ] dynamic = ["version"] diff --git a/src/frequenz/dispatch/_actor_dispatcher.py b/src/frequenz/dispatch/_actor_dispatcher.py index 2219f36..4419b5e 100644 --- a/src/frequenz/dispatch/_actor_dispatcher.py +++ b/src/frequenz/dispatch/_actor_dispatcher.py @@ -181,14 +181,16 @@ def _update_dispatch_information(self, dispatch_update: DispatchInfo) -> None: async def main(): url = os.getenv("DISPATCH_API_URL", "grpc://dispatch.url.goes.here.example.com") - key = os.getenv("DISPATCH_API_KEY", "some-key") + auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "some-key") + sign_secret = os.getenv("DISPATCH_API_SIGN_SECRET") microgrid_id = 1 async with Dispatcher( microgrid_id=microgrid_id, server_url=url, - key=key + auth_key=auth_key, + sign_secret=sign_secret, ) as dispatcher: status_receiver = dispatcher.new_running_state_event_receiver("EXAMPLE_TYPE")