services/nodemanager/README.rst

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