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. API server
  20
  21 Set @ManagementToken@ in the appropriate section of @application.yml@
  22
  23 <pre>
  24 production:
  25   # Token to be included in all healthcheck requests. Disabled by default.
  26   # Server expects request header of the format "Authorization: Bearer xxx"
  27   ManagementToken: xxx
  28 </pre>
  29
  30 h2. Node Manager
  31
  32 Set @port@ (the listen port) and @ManagementToken@ in the @Manage@ section of @node-manager.ini@.
  33
  34 <pre>
  35 [Manage]
  36 # The management server responds to http://addr:port/status.json with
  37 # a snapshot of internal state.
  38
  39 # Management server listening address (default 127.0.0.1)
  40 #address = 0.0.0.0
  41
  42 # Management server port number (default -1, server is disabled)
  43 #port = 8989
  44
  45 ManagementToken = xxx
  46 </pre>
  47
  48 h2. Other services
  49
  50 The following services also support monitoring.  Set @ManagementToken@ in the respective yaml config file for each service.
  51
  52 * keepstore
  53 * keep-web
  54 * keepproxy
  55 * arv-git-httpd
  56 * websockets