From d066a5c7b3b4a5f7af737976088ea17c0b617322 Mon Sep 17 00:00:00 2001 From: pallav Date: Fri, 21 Sep 2018 14:21:03 +0530 Subject: [PATCH] Fix docs Updating node-labels API details in doc. Change-Id: I0d0410f1c617f9ec9c99b19e6bf68bda7477785f --- .gitignore | 1 + doc/source/api.rst | 6 ++++-- doc/source/design.rst | 5 +++-- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index ac468f41..e67afe0e 100644 --- a/.gitignore +++ b/.gitignore @@ -21,6 +21,7 @@ __pycache__ # Sphinx artifacts /doc/build/ +/doc/source/.doctrees/ /doc/*/_static/ /AUTHORS /ChangeLog diff --git a/doc/source/api.rst b/doc/source/api.rst index 1b39fa8d..96b1dd50 100644 --- a/doc/source/api.rst +++ b/doc/source/api.rst @@ -1,5 +1,7 @@ -Promenade API -============= +.. _api-ref: + +Promenade API Documentation +=========================== /v1.0/health diff --git a/doc/source/design.rst b/doc/source/design.rst index 3438186a..3c0e80e5 100644 --- a/doc/source/design.rst +++ b/doc/source/design.rst @@ -107,8 +107,9 @@ implemented. Adding and removing node labels ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This is currently only possible directly via ``kubectl``, though API support -for this functionality is planned. +Promenade provides ``node-labels`` API for updating node labels. +For more information about updating node labels, please reference +the :ref:`api-ref`. It through relabeling nodes that key day 2 operations functionality like moving a master node are achieved.