summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMathieu Mitchell <mmitchell@iweb.com>2017-01-31 07:02:59 -0500
committerMathieu Mitchell <mmitchell@iweb.com>2017-01-31 07:02:59 -0500
commit5b1a217195e2b282ccbf7989b6ff4213a7dca478 (patch)
treebe76cea4d5925c20622adee2384e338cf18a4795
parentb787b01f6cfd355ec2f1d97207bc260225bd7c67 (diff)
downloadironic-python-agent-5b1a217195e2b282ccbf7989b6ff4213a7dca478.tar.gz
Remove vendor_passthru mentions from lookup/heartbeat documentation
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
-rw-r--r--doc/source/index.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index d322deda..c6b7a2a3 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -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.