openstack/ironic-python-agent
Code Issues Proposed changes

Remove vendor_passthru mentions from lookup/heartbeat documentation

Browse Source 
Currently, the documentation index provides the old lookup/heartbeat
URLs. Commit b033bfd9 removed usage for these URLs.

This commit replaces old URLs from docs with the ones actually used.

Change-Id: I375045c23663768e4971d76162c87b731ee82eb3
Related-bug: #1640533
This commit is contained in:
Mathieu Mitchell 2017-01-31 07:02:59 -05:00
parent b787b01f6c
commit 5b1a217195
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/index.rst
View File

@ -49,13 +49,13 @@ drivers for IPA, see the Ironic drivers documentation [0]_.
Lookup
~~~~~~
On startup, the agent performs a lookup in Ironic to determine its node UUID
by sending a hardware profile to the Ironic vendor_passthru lookup endpoint:
``/v1/drivers/{driver}/vendor_passthru/lookup``.
by sending a hardware profile to the Ironic lookup endpoint:
``/v1/lookup``.
Heartbeat
~~~~~~~~~
After successfully looking up its node, the agent heartbeats via
``/v1/nodes/{node_ident}/vendor_passthru/heartbeat`` every N seconds, where
``/v1/heartbeat/{node_ident}`` every N seconds, where
N is the Ironic conductor's agent.heartbeat_timeout value multiplied by a
number between .3 and .6.