Add manager for simple Kubernetes job creation

.gitlab-ci.yml

@@ -11,13 +11,13 @@ build:docker:
   script:
   - docker build --tag ${CI_REGISTRY_IMAGE}:${CI_COMMIT_BRANCH} .
   tags:
-  - docker
+  - docker-image-builder
 
 build:precommit:
   stage: build
   image: python:3.11
   before_script:
-  - pip3 install -r requirements-dev.txt
+  - pip install .[dev]
   script:
   - pre-commit run --all-files
 
@@ -27,8 +27,7 @@ build:test:
   services:
   - rabbitmq:latest
   before_script:
-  - pip3 install -r requirements.txt
-  - pip3 install -r requirements-dev.txt
+  - pip3 install .[dev]
   script:
   - pytest -v
 
@@ -41,7 +40,7 @@ build:dist:
     paths:
       - dist/
   tags:
-  - docker
+  - docker-image-builder
 
 # Stage: deploy
 ##############################################################################

Dockerfile

@@ -1,12 +1,19 @@
-FROM python:3.11
+# build stage
+FROM python:3.11 AS builder
 
-COPY requirements.txt /tmp
-RUN pip3 install -r /tmp/requirements.txt
+WORKDIR /build
+COPY . .
 
-COPY . /tmp/controller
-RUN cd /tmp/controller && \
-	python3 setup.py sdist && \
-	pip3 install dist/*.tar.gz && \
-	rm -rf /tmp/controller
+RUN pip install .
 
-ENTRYPOINT [ "villas-controller" ]
+RUN python3 setup.py sdist && \
+    pip install dist/*.tar.gz --target /install
+
+# minimal runtime image
+FROM python:3.11-slim AS runtime
+
+COPY --from=builder /install /usr/local/lib/python3.11/site-packages
+COPY etc/*.json etc/*.yaml /etc/villas/controller/
+COPY villas-controller.service /etc/systemd/system/
+
+ENTRYPOINT ["/usr/local/lib/python3.11/site-packages/bin/villas-controller"]

etc/config_simplekub.yaml

@@ -0,0 +1,17 @@
+---
+broker:
+  url: amqp://admin:vieQuoo2sieDahHee8ohM5aThaibiPei@villas-broker:5672/
+
+components:
+- type: generic
+  category: manager
+  name: Generic Manager
+  location: VM Iris
+  uuid: eddb51a0-557b-4848-ac7a-faccc7c51fa3
+
+- category: manager
+  type: kubernetes-simple
+  name: Simple Kubernetes Manager
+  location: VM Iris
+  uuid: 4f8fb73e-7e74-11eb-8f63-f3ccc3ab82f6
+  namespace: villas-controller

etc/params_k8s_dpsim.yaml

@@ -13,9 +13,9 @@ properties:
       name: dpsim
     spec:
       suspend: true
-      activeDeadlineSeconds: 120 # kill the Job after 1h
+      activeDeadlineSeconds: 3600 # kill the Job after 1h
       backoffLimit: 0 # only try to run pod once, no retries
-      ttlSecondsAfterFinished: 120 # delete the Job resources 1h after completion
+      ttlSecondsAfterFinished: 3600 # delete the Job resources 1h after completion
       template:
         spec:
           restartPolicy: Never

pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "villas-controller"
+dynamic = ["version"]
+description = "A controller/orchestration API for real-time power system simulators"
+readme = "README.md"
+requires-python = ">=3.7"
+authors = [
+    { name="Steffen Vogel", email="acs-software@eonerc.rwth-aachen.de" }
+]
+dependencies = [
+    "dotmap",
+    "kombu",
+    "termcolor",
+    "psutil",
+    "requests",
+    "villas-node>=0.10.2",
+    "kubernetes",
+    "xdg",
+    "PyYAML",
+    "tornado",
+    "jsonschema>=4.1.0",
+    "pyusb"
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest",
+  "pre-commit"
+]
+
+[project.license]
+text = "Apache-2.0"
+
+[tool.setuptools.dynamic]
+version = { attr = "villas.controller.__version__" }
+
+[tool.setuptools.packages.find]
+include = ["villas*"]
+
+[project.scripts]
+villas-controller = "villas.controller.main:main"
+villas-ctl = "villas.controller.main:main"

setup.py

@@ -1,69 +1,9 @@
-from setuptools import setup, find_namespace_packages
+from setuptools import setup
 from glob import glob
 
-import os
-import re
-
-
-def get_version():
-    here = os.path.abspath(os.path.dirname(__file__))
-    init_file = os.path.join(here, "villas", "controller", "__init__.py")
-
-    with open(init_file, "r") as f:
-        content = f.read()
-
-    match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", content, re.M)
-    if match:
-        return match.group(1)
-
-    raise RuntimeError("Version not found")
-
-
-with open('README.md') as f:
-    long_description = f.read()
-
 setup(
-    name='villas-controller',
-    version=get_version(),
-    description='A controller/orchestration API for real-time '
-                'power system simulators',
-    long_description=long_description,
-    long_description_content_type='text/markdown',
-    url='https://www.fein-aachen.org/projects/villas-controller/',
-    author='Steffen Vogel',
-    author_email='acs-software@eonerc.rwth-aachen.de',
-    license='Apache License 2.0',
-    keywords='simulation controller villas',
-    classifiers=[
-        'Development Status :: 3 - Alpha',
-        'License :: OSI Approved :: Apache Software License',
-        'Programming Language :: Python :: 3'
-    ],
-    packages=find_namespace_packages(include=['villas.*']),
-    install_requires=[
-        'dotmap',
-        'kombu',
-        'termcolor',
-        'psutil',
-        'requests',
-        'villas-node>=0.10.2',
-        'kubernetes',
-        'xdg',
-        'PyYAML',
-        'tornado',
-        'jsonschema>=4.1.0',
-        'psutil',
-        'pyusb'
-    ],
     data_files=[
         ('/etc/villas/controller', glob('etc/*.{json,yaml}')),
         ('/etc/systemd/system', ['villas-controller.service'])
-    ],
-    entry_points={
-        'console_scripts': [
-            'villas-ctl=villas.controller.main:main',
-            'villas-controller=villas.controller.main:main'
-        ],
-    },
-    include_package_data=True
+    ]
 )

villas/controller/__init__.py

@@ -1 +1 @@
-__version__ = "0.4.0"
+__version__ = "0.4.1"

villas/controller/component.py

@@ -107,7 +107,11 @@ def load_schema(self):
                 fo = resources.open_text(pkg, res)
                 loadedschema = yaml.load(fo, yaml.SafeLoader)
 
-                schema[name] = Draft202012Validator(loadedschema)
+                try:
+                    Draft202012Validator.check_schema(loadedschema)
+                    schema[name] = loadedschema
+                except jsonschema.exceptions.SchemaError:
+                    self.logger.warning("Schema is invalid!")
 
         return schema
 
@@ -148,7 +152,7 @@ def status(self):
                 **self.headers
             },
             'schema': {
-                name: v.schema for name, v in self.schema.items()
+                name: v for name, v in self.schema.items()
             }
         }
 
@@ -277,12 +281,15 @@ def from_dict(dict):
 
     def publish_status(self):
         if not self.mixin:
+            self.logger.warn('No mixin!')
             return
 
         self.mixin.publish(self.status, headers=self.headers)
 
     def publish_status_periodically(self):
-        self.logger.info('Start state publish thread')
+        self.logger.info('Start state publish thread, initial status: %s',
+                         self.status)
+        self.publish_status()  # publish the first update immediately
 
         while not self.publish_status_thread_stop.wait(
           self.publish_status_interval):

villas/controller/components/manager.py

@@ -28,6 +28,9 @@ def from_dict(dict):
         if type == 'kubernetes':
             from villas.controller.components.managers import kubernetes
             return kubernetes.KubernetesManager(**dict)
+        if type == 'kubernetes-simple':
+            from villas.controller.components.managers import kubernetes_simple
+            return kubernetes_simple.KubernetesManagerSimple(**dict)
         if type == 'villas-node':
             from villas.controller.components.managers import villas_node  # noqa E501
             return villas_node.VILLASnodeManager(**dict)
@@ -43,7 +46,6 @@ def from_dict(dict):
     def add_component(self, comp):
         if comp.uuid in self.mixin.components:
             existing_comp = self.mixin.components[comp.uuid]
-
             raise SimulationException(self, 'Component with same UUID ' +
                                       'already exists!',
                                       component=existing_comp)

villas/controller/components/managers/kubernetes.py

@@ -22,42 +22,36 @@ class KubernetesManager(Manager):
     def __init__(self, **args):
         super().__init__(**args)
 
-        self.thread_stop = threading.Event()
-
-        self.pod_watcher_thread = threading.Thread(
-            target=self._run_pod_watcher)
-        self.job_watcher_thread = threading.Thread(
-            target=self._run_job_watcher)
-        self.event_watcher_thread = threading.Thread(
-            target=self._run_event_watcher)
-
         if os.environ.get('KUBECONFIG'):
             k8s.config.load_kube_config()
         else:
             k8s.config.load_incluster_config()
 
-        self.namespace = args.get('namespace', 'default')
+        # the namespace in which to create the jobs
+        # and to watch for events
+        self.namespace = os.environ.get('NAMESPACE')
+        self.namespace = ''.join([self.namespace, '-controller'])
 
-        self.my_namespace = os.environ.get('NAMESPACE')
+        # name and UID of the pod in which this controller is running
+        # used in kubernetes simulator to set the owner reference
         self.my_pod_name = os.environ.get('POD_NAME')
         self.my_pod_uid = os.environ.get('POD_UID')
 
-        self._check_namespace(self.namespace)
+        self.thread_stop = threading.Event()
+
+        self.pod_watcher_thread = threading.Thread(
+            target=self._run_pod_watcher)
+        self.job_watcher_thread = threading.Thread(
+            target=self._run_job_watcher)
+        self.event_watcher_thread = threading.Thread(
+            target=self._run_event_watcher)
 
-        # self.pod_watcher_thread.start()
-        # self.job_watcher_thread.start()
         self.event_watcher_thread.setDaemon(True)
         self.event_watcher_thread.start()
 
-    def _check_namespace(self, ns):
-        c = k8s.client.CoreV1Api()
-
-        namespaces = c.list_namespace()
-        for namespace in namespaces.items:
-            if namespace.metadata.name == ns:
-                return
-
-        raise RuntimeError(f'Namespace {ns} does not exist')
+        # Not used yet, can support more complex logic
+        # self.pod_watcher_thread.start()
+        # self.job_watcher_thread.start()
 
     def _run_pod_watcher(self):
         w = k8s.watch.Watch()
@@ -107,6 +101,10 @@ def _run_event_watcher(self):
 
                         if _match(comp.job.metadata.name,
                                   eo.involved_object.name):
+                            if comp._state == 'stopping':
+                                # incoming events are old repetitions
+                                continue
+
                             if eo.reason == 'Completed':
                                 comp.change_state('stopping', True)
                             elif eo.reason == 'Started':