Merge branch '16265-security-updates' into dependabot/bundler/apps/workbench/loofah...
[arvados.git] / doc / admin / management-token.html.textile.liquid
1 ---
2 layout: default
3 navsection: admin
4 title: Management token
5 ...
6
7 {% comment %}
8 Copyright (C) The Arvados Authors. All rights reserved.
9
10 SPDX-License-Identifier: CC-BY-SA-3.0
11 {% endcomment %}
12
13 To enable and collect health checks and metrics, services must be configured with a "management token".
14
15 Services must have ManagementToken configured.  This is used to authorize access monitoring endpoints.  If ManagementToken is not configured, monitoring endpoints will return the error @404 disabled@.
16
17 To access a monitoring endpoint, the requester must provide the HTTP header @Authorization: Bearer (ManagementToken)@.
18
19 h2. Node Manager
20
21 Set @port@ (the listen port) and @ManagementToken@ in the @Manage@ section of @node-manager.ini@.
22
23 <pre>
24 [Manage]
25 # The management server responds to http://addr:port/status.json with
26 # a snapshot of internal state.
27
28 # Management server listening address (default 127.0.0.1)
29 #address = 0.0.0.0
30
31 # Management server port number (default -1, server is disabled)
32 #port = 8989
33
34 ManagementToken = xxx
35 </pre>
36
37 h2. API server and other services
38
39 The following services also support monitoring.
40
41 * API server
42 * arv-git-httpd
43 * controller
44 * keep-balance
45 * keepproxy
46 * keepstore
47 * keep-web
48 * websockets
49
50 Set @ManagementToken@ in the appropriate section of @/etc/arvados/config.yml@.
51
52 <notextile>
53 <pre><code>Clusters:
54   <span class="userinput">ClusterID</span>:
55     # Token to be included in all healthcheck requests. Disabled by default.
56     # Server expects request header of the format "Authorization: Bearer xxx"
57     ManagementToken: xxx
58 </code></pre>
59 </notextile>