status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updating maint.html to remove node maint (#3354) 

* Updating maint.html to remove node maint

as discussed in #3268 maint mode does not have any affect on the node health.

* Update maint.html.markdown.erb
This commit is contained in:
phanidileep 2017-09-01 17:49:51 -07:00 committed by James Phillips
parent c8f35bf6be
commit 93ea4d66d2
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
website/source/docs/commands/maint.html.markdown.erb
View File

@ -10,14 +10,14 @@ description: >
Command: `consul maint`
The `maint` command provides control of both service and node maintenance mode.
Using the command, it is possible to mark a service provided by a node or the
The `maint` command provides control of service maintenance mode.
Using the command, it is possible to mark a service provided by a node or all the services on the
node as a whole as "under maintenance". In this mode of operation, the service
or node will not appear in DNS query results, or API results. This effectively
takes the service or node out of the pool of available "healthy" nodes.
will not appear in DNS query results, or API results. This effectively
takes the service out of the pool of available "healthy" nodes of a service.
Under the hood, maintenance mode is activated by registering a health check in
critical status against a node or service, and deactivated by deregistering the
critical status against a service, and deactivated by deregistering the
health check.
## Usage
@ -30,19 +30,17 @@ Usage: `consul maint [options]`
#### Command Options
* `-enable` - Enable maintenance mode on a given service or node. If
* `-enable` - Enable maintenance mode on all services on a node. If
combined with the `-service` flag, we operate on a specific service ID.
Otherwise, node maintenance mode is enabled.
* `-disable` - Disable maintenance mode on a given service or node. If
* `-disable` - Disable maintenance mode on all service on a node. If
combined with the `-service` flag, we operate on a specific service ID.
Otherwise, node maintenance mode is disabled.
* `-reason` - An optional reason for placing the node or service into
* `-reason` - An optional reason for placing the service into
maintenance mode. If provided, this reason will be visible in the newly-
registered critical check's "Notes" field.
* `-service` - An optional service ID to control node maintenance mode for. By
* `-service` - An optional service ID to control maintenance mode for a given service. By
providing this flag, the `-enable` and `-disable` flags functionality is
modified to operate on the given service ID.