16427: Merge branch 'master'
[arvados.git] / doc / admin / management-token.html.textile.liquid
index 33027ad88701b06723cbeed1089e664efec32c0c..881227b3fa9a84ce084f107de771aa862c1949c5 100644 (file)
@@ -16,32 +16,44 @@ Services must have ManagementToken configured.  This is used to authorize access
 
 To access a monitoring endpoint, the requester must provide the HTTP header @Authorization: Bearer (ManagementToken)@.
 
-h2. API server
+h2. Node Manager
 
-Set @MangementToken@ in @application.yml@
+Set @port@ (the listen port) and @ManagementToken@ in the @Manage@ section of @node-manager.ini@.
 
 <pre>
-  # Token to be included in all healthcheck requests. Disabled by default.
-  # Server expects request header of the format "Authorization: Bearer xxx"
-  ManagementToken: ...
-</pre>
+[Manage]
+# The management server responds to http://addr:port/status.json with
+# a snapshot of internal state.
 
-h2. Node Manager
+# Management server listening address (default 127.0.0.1)
+#address = 0.0.0.0
 
-Set @port@ (the listen port) and @MangementToken@ in the @Manage@ section of @node-manager.ini@ .
+# Management server port number (default -1, server is disabled)
+#port = 8989
 
-<pre>
-[Manage]
-port=8888
-ManagementToken=...
+ManagementToken = xxx
 </pre>
 
-h2. Other services
+h2. API server and other services
 
-The following services also support health check.  Set @MangementToken@ in the respective yaml config file for each service.
+The following services also support monitoring.
 
+* API server
+* arv-git-httpd
+* controller
+* keep-balance
+* keepproxy
 * keepstore
 * keep-web
-* keepproxy
-* arv-git-httpd
 * websockets
+
+Set @ManagementToken@ in the appropriate section of @/etc/arvados/config.yml@.
+
+<notextile>
+<pre><code>Clusters:
+  <span class="userinput">ClusterID</span>:
+    # Token to be included in all healthcheck requests. Disabled by default.
+    # Server expects request header of the format "Authorization: Bearer xxx"
+    ManagementToken: xxx
+</code></pre>
+</notextile>