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 and other services
  20
  21 The following services also support monitoring.
  22
  23 * API server
  24 * controller
  25 * keep-balance
  26 * keepproxy
  27 * keepstore
  28 * keep-web
  29 * arvados-ws
  30
  31 Set @ManagementToken@ in the appropriate section of @/etc/arvados/config.yml@.
  32
  33 <notextile>
  34 <pre><code>Clusters:
  35   <span class="userinput">ClusterID</span>:
  36     # Token to be included in all healthcheck requests. Disabled by default.
  37     # Server expects request header of the format "Authorization: Bearer xxx"
  38     ManagementToken: xxx
  39 </code></pre>
  40 </notextile>