Merge 13938cd into 05dea0b

simonsobs · Mar 14, 2022 · ac1d3e9 · ac1d3e9
2 parents 05dea0b + 13938cd
commit ac1d3e9
Show file tree

Hide file tree

Showing 34 changed files with 2,954 additions and 868 deletions.
diff --git a/agents/host_manager/host_manager.py b/agents/host_manager/host_manager.py
diff --git a/agents/host_master/host_master.py b/agents/host_master/host_master.py
diff --git a/agents/ocs_plugin_standard.py b/agents/ocs_plugin_standard.py
@@ -11,7 +11,7 @@
 for n,f in [
         ('RegistryAgent', 'registry/registry.py'),
         ('AggregatorAgent', 'aggregator/aggregator_agent.py'),
-        ('HostMaster', 'host_master/host_master.py'),
+        ('HostManager', 'host_manager/host_manager.py'),
         ('FakeDataAgent', 'fake_data/fake_data_agent.py'),
         ('InfluxDBAgent', 'influxdb_publisher/influxdb_publisher.py'),
 ]:

diff --git a/bin/ocsbow b/bin/ocsbow
diff --git a/docs/_static/ocs_web_hostmanager.png b/docs/_static/ocs_web_hostmanager.png
diff --git a/docs/agents/host_manager.rst b/docs/agents/host_manager.rst
@@ -0,0 +1,63 @@
+.. highlight:: rst
+
+.. _host_manager:
+
+=================
+HostManager Agent
+=================
+
+The HostManager Agent helps to manage the many Agent instances that
+need to run on a single host machine, providing a way to start and
+stop Agents without connecting to the host system.
+
+For a complete discussion of this Agent and how to best use it, see
+:ref:`centralized_management`.
+
+
+.. argparse::
+   :module: agents.host_manager.host_manager
+   :func: make_parser
+   :prog: host_manager.py
+
+
+
+Configuration File Examples
+---------------------------
+
+Note that the HostManager Agent usually runs on the native system,
+and not in a Docker container.  (If you did set up a HostManager in a
+Docker container, it would only be able to start/stop agents within
+that container.)
+
+OCS Site Config
+```````````````
+
+Here's an example configuration block:
+
+.. code-block:: yaml
+
+     {'agent-class': 'HostManager',
+      'instance-id': 'hm-mydaqhost1'}
+
+By convention, the HostManager responsible for host ``<hostname>``
+should be given instance-id ``hm-<hostname>``.
+
+
+Description
+-----------
+
+Please see :ref:`centralized_management`.
+
+
+Agent API
+---------
+
+.. autoclass:: agents.host_manager.host_manager.HostManager
+    :members:
+
+Supporting APIs
+---------------
+
+.. automethod:: agents.host_manager.host_manager.HostManager._process_target_states
+
+.. automethod:: agents.host_manager.host_manager.HostManager._reload_config
diff --git a/docs/agents/host_master.rst b/docs/agents/host_master.rst
diff --git a/docs/developer/site_config.rst b/docs/developer/site_config.rst
@@ -230,7 +230,7 @@ works like this:
   should be included in the ``agent-paths`` variable in the SCF for
   this host.  For example, we might put the file in ``/simonsobs/agents``
   and call it ``ocs_plugin_simonsobs.py``.
-- When the site_config system (specifically the HostMaster agent)
+- When the site_config system (specifically the HostManager agent)
   needs to find a particular agent script, it:
 
   - Adds any directories in ``agent-paths`` to the Python import path.
@@ -245,7 +245,3 @@ works like this:
 
 A good example of a plugin script can be found in the OCS agents
 directory, ``ocs_plugins_standard.py``.
-
-
-Systemd Integration [empty]
-===========================
diff --git a/docs/index.rst b/docs/index.rst
@@ -35,7 +35,7 @@ write OCS Agents or Clients.
     agents/influxdb_publisher
     agents/registry
     agents/fake_data
-    agents/host_master
+    agents/host_manager
 
 
 .. toctree::