Update documentation to use new auth parameters

- Replace deprecated 'key' parameter with 'auth_key' in examples
- Add 'sign_secret' parameter to examples
- Update environment variable names from DISPATCH_API_KEY to DISPATCH_API_AUTH_KEY
- Add DISPATCH_API_SIGN_SECRET environment variable

Signed-off-by: Mathias L. Baumann <[email protected]>

Author: Marenz

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",

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")