From 93ea4d66d2b6e1f74732d12f613aa2ebd9e12c62 Mon Sep 17 00:00:00 2001 From: phanidileep Date: Fri, 1 Sep 2017 17:49:51 -0700 Subject: [PATCH] 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 --- .../docs/commands/maint.html.markdown.erb | 20 +++++++++---------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/website/source/docs/commands/maint.html.markdown.erb b/website/source/docs/commands/maint.html.markdown.erb index f1f9dcd793..5a594d7ce1 100644 --- a/website/source/docs/commands/maint.html.markdown.erb +++ b/website/source/docs/commands/maint.html.markdown.erb @@ -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.