services/nodemanager/README.rst

   1 .. Copyright (C) The Arvados Authors. All rights reserved.
   2 ..
   3 .. SPDX-License-Identifier: AGPL-3.0
   4
   5 ====================
   6 Arvados Node Manager
   7 ====================
   8
   9 Overview
  10 --------
  11
  12 This package provides ``arvados-node-manager``.  It dynamically starts
  13 and stops compute nodes on an Arvados_ cloud installation based on job
  14 demand.
  15
  16 .. _Arvados: https://arvados.org/
  17
  18 Setup
  19 -----
  20
  21 1. Install the package.
  22
  23 2. Write a configuration file.  ``doc/ec2.example.cfg`` documents all
  24    of the options available, with specific tunables for EC2 clouds.
  25
  26 3. Run ``arvados-node-manager --config YOURCONFIGFILE`` using whatever
  27    supervisor you like (e.g., runit).
  28
  29 Testing and Development
  30 -----------------------
  31
  32 To run tests, just run::
  33
  34   python setup.py test
  35
  36 Our `hacking guide
  37 <https://arvados.org/projects/arvados/wiki/Hacking_Node_Manager>`_
  38 provides an architectural overview of the Arvados Node Manager to help
  39 you find your way around the source.  The `Lifecycle of an Arvados
  40 compute node
  41 <https://arvados.org/projects/arvados/wiki/Lifecycle_of_an_Arvados_compute_node>`_
  42 page explains how it works in concert with other Arvados components to
  43 prepare a node for compute work.