airship/promenade
Code Issues Proposed changes

Fix docs

Browse Source 
Updating node-labels API details in doc.

Change-Id: I0d0410f1c617f9ec9c99b19e6bf68bda7477785f
This commit is contained in:
pallav 2018-09-21 14:21:03 +05:30
parent 13d6831aa5
commit d066a5c7b3
3 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -21,6 +21,7 @@ __pycache__
# Sphinx artifacts
/doc/build/
/doc/source/.doctrees/
/doc/*/_static/
/AUTHORS
/ChangeLog

6
doc/source/api.rst
View File

@ -1,5 +1,7 @@
Promenade API
=============
.. _api-ref:
Promenade API Documentation
===========================
/v1.0/health

5
doc/source/design.rst
View File

@ -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.