From 4fe89203a10225838121514688139700e171577a Mon Sep 17 00:00:00 2001 From: Riccardo Pittau Date: Tue, 26 May 2020 12:07:08 +0200 Subject: [PATCH] Add agent_token param to docstrings Where required, adding param entry for the agent_token. Change-Id: Id19f9dc542e5678600d320e0dc4de689ad1b6f95 --- ironic/api/controllers/v1/ramdisk.py | 1 + ironic/conductor/manager.py | 1 + ironic/conductor/rpcapi.py | 1 + 3 files changed, 3 insertions(+) diff --git a/ironic/api/controllers/v1/ramdisk.py b/ironic/api/controllers/v1/ramdisk.py index 8d68032b71..a79b070fa7 100644 --- a/ironic/api/controllers/v1/ramdisk.py +++ b/ironic/api/controllers/v1/ramdisk.py @@ -184,6 +184,7 @@ class HeartbeatController(rest.RestController): before sending agent_version was introduced so agent v3.0.0 (the last release before sending agent_version was introduced) will be assumed. + :param agent_token: randomly generated validation token. :raises: NodeNotFound if node with provided UUID or name was not found. :raises: InvalidUuidOrName if node_ident is not valid name or UUID. :raises: NoValidHost if RPC topic for node could not be retrieved. diff --git a/ironic/conductor/manager.py b/ironic/conductor/manager.py index c662173365..bcb28f5c93 100644 --- a/ironic/conductor/manager.py +++ b/ironic/conductor/manager.py @@ -3089,6 +3089,7 @@ class ConductorManager(base_manager.BaseConductorManager): agent_version, in these cases assume agent v3.0.0 (the last release before sending agent_version was introduced). :param callback_url: URL to reach back to the ramdisk. + :param agent_token: randomly generated validation token. :raises: NoFreeConductorWorker if there are no conductors to process this heartbeat request. """ diff --git a/ironic/conductor/rpcapi.py b/ironic/conductor/rpcapi.py index 4b1929b027..64447b61a2 100644 --- a/ironic/conductor/rpcapi.py +++ b/ironic/conductor/rpcapi.py @@ -905,6 +905,7 @@ class ConductorAPI(object): :param node_id: node ID or UUID. :param callback_url: URL to reach back to the ramdisk. :param topic: RPC topic. Defaults to self.topic. + :param agent_token: randomly generated validation token. :param agent_version: the version of the agent that is heartbeating """ new_kws = {}