Skip to content

fix(doc): add missing param in drain call #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jrxFive merged 1 commit into from
May 1, 2019
Merged

fix(doc): add missing param in drain call #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/api/node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,11 @@ import nomad

my_nomad = nomad.Nomad(host='192.168.33.10')

my_nomad.node.drain_node('ed1bbae7-c38a-df2d-1de7-50dbc753fc98')
#enable drain mode
my_nomad.node.drain_node('ed1bbae7-c38a-df2d-1de7-50dbc753fc98', enable=True)

#disable drain mode
my_nomad.node.drain_node('ed1bbae7-c38a-df2d-1de7-50dbc753fc98', enable=False)
```

### Drain node with DrainSpec
Expand Down Expand Up @@ -98,7 +102,7 @@ my_nomad.node.drain_node('ed1bbae7-c38a-df2d-1de7-50dbc753fc98', drain_spec={},

This endpoint toggles the eligibility of the node. When a node's "SchedulingEligibility" is ineligible the scheduler will not consider it for new placements.

https://www.nomadproject.io/api/nodes.html#drain-node
https://www.nomadproject.io/api/nodes.html#toggle-node-eligibility

Example:

Expand Down