add manager for simple kubernetes job creation

.pre-commit-config.yaml

@@ -14,7 +14,22 @@ repos:
   - id: check-symlinks
   - id: end-of-file-fixer
   - id: trailing-whitespace
-- repo: https://gitlab.com/pycqa/flake8
+- repo: https://github.com/pycqa/flake8
   rev: 3.8.4
   hooks:
   - id: flake8
+- repo: https://github.com/sirosen/check-jsonschema
+  rev: 8a14ffa1d4c81a56057f55e1da308daeccc3bcd6
+  hooks:
+  - id: check-jsonschema
+    name: "Check schemas"
+    language: python
+    files: ^villas/controller/schemas/.*\.yaml$
+    types: [yaml]
+    args: ["--schemafile", "https://json-schema.org/draft/2020-12/schema"]
+  - id: check-jsonschema
+    name: "Check OpenAPI doc"
+    language: python
+    files: ^doc/openapi.yaml$
+    types: [yaml]
+    args: ["--schemafile", "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.1/schema.json"]

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include villas/controller *

doc/openapi.yaml

@@ -0,0 +1,327 @@
+---
+openapi: 3.0.0
+info:
+  title: VILLAScontroller API
+  description: 'A HTTP/REST API for controlling VILLAScontroller remotely for querying component status as well as issuing control actions.'
+  version: 0.0.1
+  contact:
+    name: "Steffen Vogel"
+    email: "[email protected]"
+  license:
+    name: Apache-2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0
+
+servers:
+- url: https://villas.k8s.eonerc.rwth-aachen.de/controller/api/v1
+  description: Demo instance at RWTH Aachen
+
+paths:
+
+  /:
+    get:
+      summary: 'Get status of VILLAScontroller daemon'
+      operationId: getStatus
+      tags:
+      - status
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  components:
+                    type: array
+                    items:
+                      type: string
+                      format: uuid
+                  status:
+                    type: object
+                    properties:
+                      version:
+                        type: string
+                      uptime:
+                        type: number
+                      host:
+                        type: string
+                      kernel:
+                        type: object
+                        properties:
+                          sysname:
+                            type: string
+                          nodename:
+                            type: string
+                          release:
+                            type: string
+                          version:
+                            type: string
+                          machine:
+                            type: string
+
+              example:
+                components:
+                  - f4751894-205e-11eb-aefb-0741ff98abca
+                  - 3ddd318e-fee1-46d7-bff4-7c064d640d4e
+                status:
+                  version: 0.3.2
+                  uptime: 15.38102650642395
+                  host: lat.0l.de
+                  kernel:
+                    sysname: Linux
+                    nodename: lat.0l.de
+                    release: 5.13.14-200.fc34.x86_64
+                    version: '#1 SMP Fri Sep 3 15:33:01 UTC 2021'
+                    machine: x86_64
+
+  /health:
+    get:
+      operationId: getHealth
+      summary: Query health of daemon.
+      tags:
+      - status
+      responses:
+        '200':
+          description: The daemon is healthy
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+              example:
+                status: ok
+
+
+  /component/{uuid}:
+    get:
+      summary: 'Get the current status of a component'
+      operationId: getComponentStatus
+
+      parameters:
+      - name: uuid
+        in: path
+        required: true
+        schema:
+          type: string
+          format: uuid
+
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  components:
+                    type: array
+                    items:
+                      type: string
+                      format: uuid
+
+                  status:
+                    type: object
+                    properties:
+                      managed_by:
+                        type: string
+                        format: uuid
+
+                      state:
+                        type: string
+                        enum:
+                        - idle
+                        - starting
+                        - running
+                        - stopping
+                        - pausing
+                        - paused
+                        - resuming
+                        - error
+                        - resetting
+                        - shuttingdown
+                        - shutdown
+                        - gone
+
+                      version:
+                        type: string
+                      uptime:
+                        type: number
+                      host:
+                        type: string
+                      kernel:
+                        type: object
+                        properties:
+                          sysname:
+                            type: string
+                          nodename:
+                            type: string
+                          release:
+                            type: string
+                          version:
+                            type: string
+                          machine:
+                            type: string
+
+                  properties:
+                    type: object
+                    properties:
+                      category:
+                        type: string
+                        enum:
+                        - manager
+                        - simulator
+                        - gateway
+                      type:
+                        type: string
+                        pattern: '[a-z-]+'
+                      name:
+                        type: string
+                      realm:
+                        type: string
+                        pattern: '[a-z0-9-.]+'
+                      uuid:
+                        type: string
+                        format: uuid
+
+                    additionalProperties: true
+
+                  schema:
+                    type: object
+                    additionalProperties:
+                      $ref: 'https://json-schema.org/draft/2020-12/schema'
+
+              example:
+                components: []
+                status:
+                  state: idle
+                  version: 0.3.2
+                  uptime: 480.25064611434937
+                  host: lat.0l.de
+                  kernel:
+                    sysname: Linux
+                    nodename: lat.0l.de
+                    release: 5.13.14-200.fc34.x86_64
+                    version: '#1 SMP Fri Sep 3 15:33:01 UTC 2021'
+                    machine: x86_64
+                  managed_by: f4751894-205e-11eb-aefb-0741ff98abca
+                properties:
+                  category: manager
+                  type: generic
+                  name: Standard Controller
+                  realm: de.rwth-aachen.eonerc.acs
+                  uuid: f4751894-205e-11eb-aefb-0741ff98abca
+                schema:
+                  create:
+                    # $schema: 'http://json-schema.org/draft-07/schema'
+                    type: object
+                    default: {}
+                    required:
+                    - name
+                    - category
+                    - location
+                    - owner
+                    - realm
+                    - type
+                    - api_url
+                    - ws_url
+                    properties:
+                      name:
+                        type: string
+                        title: Component name
+                        default: New Component
+                        examples: 'Generic Simulator #1'
+                      owner:
+                        type: string
+                        title: Component owner
+                        examples:
+                        - rmr
+                        - svg
+                      realm:
+                        type: string
+                        title: Component realm
+                        default: ''
+                        examples:
+                        - de.rwth-aachen.eonerc.acs
+                      category:
+                        type: string
+                        title: Component category
+                        examples:
+                        - simulator
+                      location:
+                        type: string
+                        title: Component location
+                        examples:
+                        - Richard's PC
+                      type:
+                        type: string
+                        default: generic
+                      uuid:
+                        type: 'string'
+                        format: uuid
+                      ws_url:
+                        type: string
+                        examples:
+                        - 'https://villas.k8s.eonerc.rwth-aachen.de/ws/relay/generic_1'
+                      api_url:
+                        type: string
+                        examples:
+                        - 'https://villas.k8s.eonerc.rwth-aachen.de/api/ic/generic_1'
+                      shell:
+                        type: boolean
+                        default: false
+                        examples:
+                        - true
+                      whitelist:
+                        type: array
+                        title: The whitelist schema
+                        default: []
+                        examples:
+                        - - /sbin/ping
+                          - ^echo
+                        additionalItems: true
+                        items:
+                          anyOf:
+                          - type: string
+                            examples:
+                            - /sbin/ping
+                            - ^echo
+
+    post:
+      operationId: executeComponentAction
+      summary: 'Send a control action to the component'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                action:
+                  type: string
+                  enum:
+                  - start
+                  - stop
+                  - pause
+                  - resume
+                  - create
+                  - delete
+                  - shutdown
+                  - reset
+                parameters:
+                  oneOf:
+                  - $ref: ../villas/controller/schemas/manager/generic/create.yaml
+                  - $ref: ../villas/controller/schemas/manager/kubernetes/create.yaml
+                  - $ref: ../villas/controller/schemas/simulator/dpsim/start.yaml
+                  - $ref: ../villas/controller/schemas/simulator/dummy/start.yaml
+
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json: {}
+
+
+              # example:
+              #   runtime: 10.2

etc/config_simplekub.yaml

@@ -0,0 +1,14 @@
+---
+broker:
+  url: amqp://villas:Haegiethu0rohtee@kubernetes-master-1.os-cloud.eonerc.rwth-aachen.de:30809/%2F
+
+components:
+- type: generic
+  category: manager
+  uuid: ebbbbba0-557b-4848-ac7a-faa3e7c51fa3
+
+- category: manager
+  type: kubernetes-simple
+  uuid: 4bbbb73e-7e74-11eb-8f63-f3a5b3ab82f6
+
+  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

requirements.txt

@@ -5,4 +5,7 @@ requests
 villas-node>=0.10.2
 kubernetes
 xdg
+dotmap
 PyYAML
+tornado
+jsonschema>=4.1.0