Merge pull request #160 from giffels/release-0.5.0

Release 0.5.0
MatterMiners · Dec 10, 2020 · 1139be8 · 1139be8
2 parents 6b04a31 + 23b87ec
commit 1139be8
Show file tree

Hide file tree

Showing 23 changed files with 85 additions and 13 deletions.
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -0,0 +1,31 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist
+        twine upload dist/*
diff --git a/docs/source/adapters/batchsystem.rst b/docs/source/adapters/batchsystem.rst
@@ -169,7 +169,7 @@ Available configuration options
 
 .. content-tabs:: left-col
 
-    +----------------+---------------------------------------------------------------- --+-----------------+
+    +----------------+-------------------------------------------------------------------+-----------------+
     | Option         | Short Description                                                 | Requirement     |
     +================+===================================================================+=================+
     | adapter        | Name of the adapter (Slurm)                                       |  **Required**   |

diff --git a/docs/source/api/tardis.adapters.batchsystems.rst b/docs/source/api/tardis.adapters.batchsystems.rst
@@ -10,6 +10,8 @@ Submodules
 ----------
 
 .. toctree::
+   :maxdepth: 4
 
    tardis.adapters.batchsystems.fakebatchsystem
    tardis.adapters.batchsystems.htcondor
+   tardis.adapters.batchsystems.slurm
diff --git a/docs/source/api/tardis.adapters.batchsystems.slurm.rst b/docs/source/api/tardis.adapters.batchsystems.slurm.rst
@@ -0,0 +1,7 @@
+tardis.adapters.batchsystems.slurm module
+=========================================
+
+.. automodule:: tardis.adapters.batchsystems.slurm
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/tardis.adapters.rst b/docs/source/api/tardis.adapters.rst
@@ -10,6 +10,7 @@ Subpackages
 -----------
 
 .. toctree::
+   :maxdepth: 4
 
    tardis.adapters.batchsystems
    tardis.adapters.sites
diff --git a/docs/source/api/tardis.adapters.sites.rst b/docs/source/api/tardis.adapters.sites.rst
@@ -10,6 +10,7 @@ Submodules
 ----------
 
 .. toctree::
+   :maxdepth: 4
 
    tardis.adapters.sites.cloudstack
    tardis.adapters.sites.fakesite

diff --git a/docs/source/api/tardis.agents.rst b/docs/source/api/tardis.agents.rst
@@ -10,6 +10,7 @@ Submodules
 ----------
 
 .. toctree::
+   :maxdepth: 4
 
    tardis.agents.batchsystemagent
    tardis.agents.siteagent
diff --git a/docs/source/api/tardis.configuration.rst b/docs/source/api/tardis.configuration.rst
@@ -10,6 +10,7 @@ Submodules
 ----------
 
 .. toctree::
+   :maxdepth: 4
 
    tardis.configuration.configuration
    tardis.configuration.utilities
diff --git a/docs/source/api/tardis.exceptions.rst b/docs/source/api/tardis.exceptions.rst
@@ -10,6 +10,7 @@ Submodules
 ----------
 
 .. toctree::
+   :maxdepth: 4
 
    tardis.exceptions.executorexceptions
    tardis.exceptions.tardisexceptions
diff --git a/docs/source/api/tardis.interfaces.rst b/docs/source/api/tardis.interfaces.rst
@@ -10,6 +10,7 @@ Submodules
 ----------
 
 .. toctree::
+   :maxdepth: 4
 
    tardis.interfaces.batchsystemadapter
    tardis.interfaces.borg

diff --git a/docs/source/api/tardis.plugins.elasticsearchmonitoring.rst b/docs/source/api/tardis.plugins.elasticsearchmonitoring.rst
@@ -0,0 +1,7 @@
+tardis.plugins.elasticsearchmonitoring module
+=============================================
+
+.. automodule:: tardis.plugins.elasticsearchmonitoring
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/tardis.plugins.rst b/docs/source/api/tardis.plugins.rst
@@ -10,7 +10,9 @@ Submodules
 ----------
 
 .. toctree::
+   :maxdepth: 4
 
+   tardis.plugins.elasticsearchmonitoring
    tardis.plugins.prometheusmonitoring
    tardis.plugins.sqliteregistry
    tardis.plugins.telegrafmonitoring
diff --git a/docs/source/api/tardis.resources.rst b/docs/source/api/tardis.resources.rst
@@ -10,6 +10,7 @@ Submodules
 ----------
 
 .. toctree::
+   :maxdepth: 4
 
    tardis.resources.drone
    tardis.resources.dronestates

diff --git a/docs/source/api/tardis.rst b/docs/source/api/tardis.rst
@@ -10,6 +10,7 @@ Subpackages
 -----------
 
 .. toctree::
+   :maxdepth: 4
 
    tardis.adapters
    tardis.agents

diff --git a/docs/source/api/tardis.utilities.executors.rst b/docs/source/api/tardis.utilities.executors.rst
@@ -10,6 +10,7 @@ Submodules
 ----------
 
 .. toctree::
+   :maxdepth: 4
 
    tardis.utilities.executors.shellexecutor
    tardis.utilities.executors.sshexecutor
diff --git a/docs/source/api/tardis.utilities.rst b/docs/source/api/tardis.utilities.rst
@@ -10,6 +10,7 @@ Subpackages
 -----------
 
 .. toctree::
+   :maxdepth: 4
 
    tardis.utilities.executors
    tardis.utilities.simulators
@@ -18,6 +19,7 @@ Submodules
 ----------
 
 .. toctree::
+   :maxdepth: 4
 
    tardis.utilities.asynccachemap
    tardis.utilities.attributedict

diff --git a/docs/source/api/tardis.utilities.simulators.rst b/docs/source/api/tardis.utilities.simulators.rst
@@ -10,6 +10,7 @@ Submodules
 ----------
 
 .. toctree::
+   :maxdepth: 4
 
    tardis.utilities.simulators.periodicvalue
    tardis.utilities.simulators.randomgauss
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -1,18 +1,19 @@
-.. Created by changelog.py at 2020-12-08, command
+.. Created by changelog.py at 2020-12-09, command
    '/Users/giffler/.cache/pre-commit/repor6pnmwlm/py_env-python3.9/bin/changelog docs/source/changes compile --output=docs/source/changelog.rst'
    based on the format of 'https://keepachangelog.com/'
 
 #########
 CHANGELOG
 #########
 
-[Unreleased] - 2020-12-08
-=========================
+[0.5.0] - 2020-12-09
+====================
 
 Added
 -----
 
 * Export tardis environment variable via slurm site adapter
+* Added support for Slurm overlay batch system
 
 [0.4.0] - 2020-06-03
 ====================

diff --git a/docs/source/changes/129.add_slurm_overlay_batchsystem_adapter.yaml b/docs/source/changes/129.add_slurm_overlay_batchsystem_adapter.yaml
@@ -0,0 +1,7 @@
+category: added
+summary: "Added support for Slurm overlay batch system"
+description: |
+  The Slurm batch system is now also supported as overlay batch system to manage dynamic resources.
+pull requests:
+- 129
+version: 0.5.0
diff --git a/docs/source/changes/157.export_tardis_env_via_slurm_site_adapter.yaml b/docs/source/changes/157.export_tardis_env_via_slurm_site_adapter.yaml
@@ -7,3 +7,4 @@ description: |
   underlying resources in the OBS.
 pull requests:
 - 157
+version: 0.5.0
diff --git a/docs/source/changes/versions.yaml b/docs/source/changes/versions.yaml
@@ -1,3 +1,5 @@
+- semver: 0.5.0
+  date: '2020-12-09'
 - semver: 0.4.0
   date: '2020-06-03'
 - semver: 0.3.0

diff --git a/tardis/__about__.py b/tardis/__about__.py
@@ -3,7 +3,7 @@
 __summary__ = "Transparent Adaptive Resource Dynamic Integration System"
 __url__ = "https://github.com/matterminers/tardis"
 
-__version__ = "0.4.0"
+__version__ = "0.5.0"
 __author__ = "Manuel Giffels, Matthias Schnepf"
 __email__ = "[email protected]"
 __copyright__ = "2018 - 2020 %s and Contributors" % __author__

diff --git a/tardis/adapters/batchsystems/slurm.py b/tardis/adapters/batchsystems/slurm.py
@@ -107,7 +107,7 @@ async def disintegrate_machine(self, drone_uuid: str) -> None:
         in Freiburg).
 
         :param drone_uuid: Uuid of the worker node, for some sites corresponding
-        to the host name of the drone.
+            to the host name of the drone.
         :type drone_uuid: str
         :return: None
         """
@@ -119,7 +119,7 @@ async def drain_machine(self, drone_uuid: str) -> None:
         jobs will be accepted
 
         :param drone_uuid: Uuid of the worker node, for some sites corresponding
-        to the host name of the drone.
+            to the host name of the drone.
         :type drone_uuid: str
         :return: None
         """
@@ -139,7 +139,7 @@ async def integrate_machine(self, drone_uuid: str) -> None:
         take care of it themselves)
 
         :param drone_uuid: Uuid of the worker node, for some sites corresponding
-        to the host name of the drone.
+            to the host name of the drone.
         :type drone_uuid: str
         :return: None
         """
@@ -152,7 +152,7 @@ async def get_resource_ratios(self, drone_uuid: str) -> Iterable[float]:
         ratio is given by allocated memory / total memory.
 
         :param drone_uuid: Uuid of the worker node, for some sites corresponding
-        to the host name of the drone.
+            to the host name of the drone.
         :type drone_uuid: str
         :return: Iterable of float containing the ratios
         :rtype: Iterable[float]
@@ -178,7 +178,7 @@ async def get_allocation(self, drone_uuid: str) -> float:
         Disk, etc.).
 
         :param drone_uuid: Uuid of the worker node, for some sites corresponding
-        to the host name of the drone.
+            to the host name of the drone.
         :type drone_uuid: str
         :return: The allocation of a worker node as described above.
         :rtype: float
@@ -191,10 +191,10 @@ async def get_machine_status(self, drone_uuid: str) -> MachineStatus:
         Drained, NotAvailable)
 
         :param drone_uuid: Uuid of the worker node, for some sites corresponding
-        to the host name of the drone.
+            to the host name of the drone.
         :type drone_uuid: str
         :return: The machine status in SLURM (Available, Draining, Drained,
-        NotAvailable)
+            NotAvailable)
         :rtype: MachineStatus
         """
 
@@ -241,7 +241,7 @@ async def get_utilisation(self, drone_uuid: str) -> float:
         Disk, etc.).
 
         :param drone_uuid: Uuid of the worker node, for some sites corresponding
-        to the host name of the drone.
+            to the host name of the drone.
         :type drone_uuid: str
         :return: The utilization of a worker node as described above.
         :rtype: float