vertexproject · vEpiphyte · Jun 30, 2020 · Jun 29, 2020 · Jun 29, 2020 · Jun 29, 2020
diff --git a/Dockerfile b/Dockerfile
@@ -15,3 +15,5 @@ COPY synapse/docker/start-cron.sh /start-cron.sh
 
 COPY docker/bootstrap.sh /build/synapse/bootstrap.sh
 RUN /build/synapse/bootstrap.sh
+
+VOLUME /vertex/storage
diff --git a/docs/synapse/devguides/devops_axon.rst b/docs/synapse/devguides/devops_axon.rst
@@ -1,4 +1,10 @@
 Axon Operations
 ===============
 
-TBD
+The Axon is an interface for providing binary / blob storage inside of the Synapse ecosystem. This indexes binaries
+based on SHA-256 hash so we do not duplicate the storage of the same set of bytes twice.
+
+Configuration Options
+---------------------
+
+For a list of boot time configuration options for the Axon, see the listing at :ref:`autodoc-axon-conf`.
diff --git a/docs/synapse/devguides/devops_cell.rst b/docs/synapse/devguides/devops_cell.rst
@@ -27,6 +27,18 @@ Cell implementations can extend the configuration variables available by specify
 
 Depending on deployment requirements, a combination of methods can be used for loading the configurations into the Cell.
 
+.. note::
+    The service directory (refered to as ``dirn``) should be considered a persistent directory for a given Synapse
+    service. Inside of this directory there are several files stored which are neccesary in order for a given instance
+    of a service deployment to work properly.
+
+    Docker images made by Vertex to support Synapse services will have default volumes for ``/vertex/storage``.
+    We use this as the default service directory for default entry points in documentation. This location can either
+    have a persistent docker volume present for it created, or a external location on disk can be mapped into this
+    location. Any orchestration tooling should consider the requirements for service directory data to be persistent,
+    unless stated otherwise.
+
+
 Config File
 ***********
 

diff --git a/docs/synapse/devguides/devops_cortex.rst b/docs/synapse/devguides/devops_cortex.rst
@@ -90,3 +90,8 @@ Cleanup
 *******
 
 After migration is fully complete, delete the now-unused directory "migration" inside the cortex directory.
+
+Configuration Options
+---------------------
+
+For a list of boot time configuration options for the Cortex, see the listing at :ref:`autodoc-cortex-conf`.
diff --git a/docs/synapse/devguides/devops_cryotank.rst b/docs/synapse/devguides/devops_cryotank.rst
@@ -1,4 +1,7 @@
 Cryotank Operations
 ===================
 
-TDB
+Configuration Options
+---------------------
+
+For a list of boot time configuration options for the Cryotank, see the listing at :ref:`autodoc-cryocell-conf`.
diff --git a/docs/synapse/devguides/index_autoconf.rst b/docs/synapse/devguides/index_autoconf.rst
@@ -0,0 +1,13 @@
+Cell Configuration Options
+##########################
+
+The following section contains configuration options for Synapse Cell implementations which are baked into the core
+Synapse package. These boot-time options may be set using information found at :ref:`devops-cell-config`.
+
+.. toctree::
+    :titlesonly:
+
+    ../autodocs/conf_axon
+    ../autodocs/conf_cortex
+    ../autodocs/conf_cryocell
+    ../autodocs/conf_syncmigrator
diff --git a/docs/synapse/devguides/index_cells.rst b/docs/synapse/devguides/index_cells.rst
@@ -0,0 +1,15 @@
+
+Synapse Devops
+##############
+
+The DevOps guide contains information useful for running **Synapse** ecosystem components. This will continue to be
+updated and expanded over time.
+
+.. toctree::
+    :titlesonly:
+
+    devops_general
+    devops_cell
+    devops_cortex
+    devops_axon
+    devops_cryotank
diff --git a/docs/synapse/devops.rst b/docs/synapse/devops.rst
@@ -12,15 +12,7 @@ updated and expanded over time.
 .. toctree::
     :titlesonly:
 
-    devguides/devops_general
-    devguides/devops_cell
-    devguides/devops_cortex
-    devguides/devops_axon
-    devguides/devops_cryotank
-
-    autodocs/conf_axon
-    autodocs/conf_cortex
-    autodocs/conf_cryocell
-    autodocs/conf_syncmigrator
+    devguides/index_cells
+    devguides/index_autoconf
 
 .. _index:              ../index.html
diff --git a/synapse/tests/test_tools_autodoc.py b/synapse/tests/test_tools_autodoc.py
@@ -49,6 +49,7 @@ async def test_tools_autodoc_confdefs(self):
                 buf = fd.read()
             s = buf.decode()
 
+            self.isin('autodoc-stormvarservicecell-conf', s)
             self.isin('StormvarServiceCell Configuration Options', s)
             self.isin('See :ref:`devops-cell-config` for', s)
             self.isin('auth\:passwd', s)

diff --git a/synapse/tools/autodoc.py b/synapse/tools/autodoc.py
@@ -363,7 +363,7 @@ async def docConfdefs(ctor, reflink=':ref:`devops-cell-config`'):
     clsname = cls.__name__
     conf = cls.initCellConf()  # type: s_config.Config
 
-    rst.addHead(f'{clsname} Configuration Options', lvl=0)
+    rst.addHead(f'{clsname} Configuration Options', lvl=0, link=f'.. _autodoc-{clsname.lower()}-conf:')
     rst.addLines(f'The following are boot-time configuration options for the cell.')
 
     rst.addLines(f'See {reflink} for details on how to set these options.')