4139: Add README to Node Manager.

Refs #4139.

diff --git a/services/nodemanager/README.rst b/services/nodemanager/README.rst
new file mode 100644 (file)
index 0000000..4a1b162
--- /dev/null
+++ b/services/nodemanager/README.rst
@@ -0,0 +1,35 @@
+====================
+Arvados Node Manager
+====================
+
+Overview
+--------
+
+This package provides ``arvados-node-manager``.  It dynamically starts
+and stops compute nodes on an Arvados_ cloud installation based on job
+demand.
+
+.. _Arvados: https://arvados.org/
+
+Setup
+-----
+
+1. Install the package.
+
+2. Write a configuration file.  ``doc/ec2.example.cfg`` documents all
+   of the options available, with specific tunables for EC2 clouds.
+
+3. Run ``arvados-node-manager --config YOURCONFIGFILE`` using whatever
+   supervisor you like (e.g., runit).
+
+Testing and Development
+-----------------------
+
+To run tests, just run::
+
+  python setup.py test
+
+Our `hacking guide
+<https://arvados.org/projects/arvados/wiki/Hacking_Node_Manager>`_
+provides an architectural overview of the Arvados Node Manager to help
+you find your way around the source.

diff --git a/services/nodemanager/setup.py b/services/nodemanager/setup.py
index fabb883d4275d053cdf06c95e888d917d875732b..44a35f592a47dd9ea418583ba1a121218d4c29ac 100644 (file)
--- a/services/nodemanager/setup.py
+++ b/services/nodemanager/setup.py
@@ -22,6 +22,7 @@ else:
 setup(name='arvados-node-manager',
       version='0.1',
       description='Arvados compute node manager',
+      long_description=open(os.path.join(SETUP_DIR, 'README.rst')).read(),
       author='Arvados',
       author_email='info@arvados.org',
       url="https://arvados.org",