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 @MangementToken@ in @application.yml@
  22
  23 <pre>
  24   # Token to be included in all healthcheck requests. Disabled by default.
  25   # Server expects request header of the format "Authorization: Bearer xxx"
  26   ManagementToken: ...
  27 </pre>
  28
  29 h2. Node Manager
  30
  31 Set @port@ (the listen port) and @MangementToken@ in the @Manage@ section of @node-manager.ini@ .
  32
  33 <pre>
  34 [Manage]
  35 port=8888
  36 ManagementToken=...
  37 </pre>
  38
  39 h2. Other services
  40
  41 The following services also support health check.  Set @MangementToken@ in the respective yaml config file for each service.
  42
  43 * keepstore
  44 * keep-web
  45 * keepproxy
  46 * arv-git-httpd
  47 * websockets