From 8499fb1807f9b2c17daf78e4b7afdfb4f7f6a2d7 Mon Sep 17 00:00:00 2001 From: Reuven Lazarus Date: Wed, 24 May 2017 14:16:14 -0400 Subject: [PATCH] Add docs for validation mode. --- docs/operations/cli.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/operations/cli.rst b/docs/operations/cli.rst index fd88f987826b..24139f828ac2 100644 --- a/docs/operations/cli.rst +++ b/docs/operations/cli.rst @@ -10,6 +10,17 @@ following are the command line options that Envoy supports. *(required)* The path to the :ref:`JSON configuration file `. +.. option:: --mode + + *(optional)* One of the operating modes for Envoy: + + * ``serve``: *(default)* Validate the JSON configuration and then serve traffic normally. + + * ``validate``: Validate the JSON configuration and then exit, printing either an "OK" message (in + which case the exit code is 0) or any errors generated by the configuration file (exit code 1). + No network traffic is generated, and the hot restart process is not performed, so no other Envoy + process on the machine will be disturbed. + .. option:: --admin-address-path *(optional)* The output file path where the admin address and port will be written.