Fix: rename 'timeout' containers to 'timeout_task' to avoid conflicts with docker keyword

Author: tollsimy

config/logger.conf

@@ -16,9 +16,9 @@ keys=root,
      send_kcidb,
      tarball,
      test_report,
-     timeout,
-     timeout-closing,
-     timeout-holdoff,
+     timeout-task,
+     timeout-task-closing,
+     timeout-task-holdoff,
      trigger
 
 [handlers]
@@ -113,22 +113,22 @@ handlers=consoleHandler, timedRotatingHandler
 qualname=test_report
 propagate=0
 
-[logger_timeout]
+[logger_timeout-task]
 level=DEBUG
 handlers=consoleHandler, timedRotatingHandler
-qualname=timeout
+qualname=timeout-task
 propagate=0
 
-[logger_timeout-closing]
+[logger_timeout-task-closing]
 level=DEBUG
 handlers=consoleHandler, timedRotatingHandler
-qualname=timeout-closing
+qualname=timeout-task-closing
 propagate=0
 
-[logger_timeout-holdoff]
+[logger_timeout-task-holdoff]
 level=DEBUG
 handlers=consoleHandler, timedRotatingHandler
-qualname=timeout-holdoff
+qualname=timeout-task-holdoff
 propagate=0
 
 [logger_trigger]

doc/pipeline-details.md

@@ -74,7 +74,7 @@ Each environment needs to have its own API token set up locally to be able to su
 
 ### Timeout
 
-The timeout service periodically checks all nodes' state. If a node is not in "done" state, then it checks whether the maximum wait time (timeout) is over. If so, it sets the node and all its child nodes to "done" state.
+The timeout-task service periodically checks all nodes' state. If a node is not in "done" state, then it checks whether the maximum wait time (timeout) is over. If so, it sets the node and all its child nodes to "done" state.
 If the node is in "available" state and not timed-out, it will check for holdoff time. If the holdoff reached, and all its child nodes are completed, the node state will be moved to "done", otherwise the state will be set to "closing".
 The parent node with "closing" state can not have any new child nodes.
 This will generate pub/sub event of node update.

docker-compose.yaml

@@ -184,7 +184,7 @@ services:
     extra_hosts:
       - "host.docker.internal:host-gateway"
 
-  timeout:
+  timeout-task:
     <<: *base-service
     container_name: 'kernelci-pipeline-timeout'
     command:
@@ -197,7 +197,7 @@ services:
     extra_hosts:
       - "host.docker.internal:host-gateway"
 
-  timeout-closing:
+  timeout-task-closing:
     <<: *base-service
     container_name: 'kernelci-pipeline-closing'
     command:
@@ -210,7 +210,7 @@ services:
     extra_hosts:
       - "host.docker.internal:host-gateway"
 
-  timeout-holdoff:
+  timeout-task-holdoff:
     <<: *base-service
     container_name: 'kernelci-pipeline-holdoff'
     command:

kube/aks/nodehandlers.yaml

@@ -20,7 +20,7 @@ spec:
         app: timeout
     spec:
       containers:
-        - name: timeout
+        - name: timeout-task
           image: kernelci/kernelci:pipeline@sha256:bb01424c4dedcd2ffa87cef225b09116cf874bc2b91fc63ed6d993d6fc5c43cb
           imagePullPolicy: Always
           command:
@@ -68,7 +68,7 @@ spec:
         app: closing
     spec:
       containers:
-        - name: timeout
+        - name: timeout-task
           image: kernelci/kernelci:pipeline@sha256:bb01424c4dedcd2ffa87cef225b09116cf874bc2b91fc63ed6d993d6fc5c43cb
           imagePullPolicy: Always
           command:
@@ -112,7 +112,7 @@ spec:
         app: holdoff
     spec:
       containers:
-        - name: timeout
+        - name: timeout-task
           image: kernelci/kernelci:pipeline@sha256:bb01424c4dedcd2ffa87cef225b09116cf874bc2b91fc63ed6d993d6fc5c43cb
           imagePullPolicy: Always
           command:

kube/minikube/deployments/timeout-closing-deployment.yaml

@@ -6,19 +6,19 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: kernelci-pipeline-timeout-closing
+  name: kernelci-pipeline-timeout-task-closing
 spec:
   replicas: 1
   selector:
     matchLabels:
-      app: kernelci-pipeline-timeout-closing
+      app: kernelci-pipeline-timeout-task-closing
   template:
     metadata:
       labels:
-        app: kernelci-pipeline-timeout-closing
+        app: kernelci-pipeline-timeout-task-closing
     spec:
       containers:
-        - name: kernelci-pipeline-timeout-closing
+        - name: kernelci-pipeline-timeout-task-closing
           image: kernelci/staging-kernelci
           env:
             - name: KCI_API_TOKEN

kube/minikube/deployments/timeout-holdoff-deployment.yaml

@@ -1,19 +1,19 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: kernelci-pipeline-timeout-holdoff
+  name: kernelci-pipeline-timeout-task-holdoff
 spec:
   replicas: 1
   selector:
     matchLabels:
-      app: kernelci-pipeline-timeout-holdoff
+      app: kernelci-pipeline-timeout-task-holdoff
   template:
     metadata:
       labels:
-        app: kernelci-pipeline-timeout-holdoff
+        app: kernelci-pipeline-timeout-task-holdoff
     spec:
       containers:
-        - name: kernelci-pipeline-timeout-holdoff
+        - name: kernelci-pipeline-timeout-task-holdoff
           image: kernelci/staging-kernelci
           env:
             - name: KCI_API_TOKEN

src/timeout.py

@@ -105,7 +105,7 @@ def _submit_lapsed_nodes(self, lapsed_nodes, state, mode):
 class Timeout(TimeoutService):
 
     def __init__(self, configs, args):
-        super().__init__(configs, args, 'timeout')
+        super().__init__(configs, args, 'timeout-task')
 
     def _check_pending_nodes(self, pending_nodes):
         timeout_nodes = {}
@@ -132,7 +132,7 @@ def _run(self, ctx):
 class Holdoff(TimeoutService):
 
     def __init__(self, configs, args):
-        super().__init__(configs, args, 'timeout-holdoff')
+        super().__init__(configs, args, 'timeout-task-holdoff')
 
     def _get_available_nodes(self):
         nodes = self._api.node.find({
@@ -177,7 +177,7 @@ def _run(self, ctx):
 class Closing(TimeoutService):
 
     def __init__(self, configs, args):
-        super().__init__(configs, args, 'timeout-closing')
+        super().__init__(configs, args, 'timeout-task-closing')
 
     def _get_closing_nodes(self):
         nodes = self._api.node.find({'state': 'closing'})