Fix docu, examples, base image

Documentation/quick-start.md

@@ -14,30 +14,37 @@ Steps for getting a demo to run on a local Linux Helm environment and a local Ki
 - Helm
 - KinD
 
-## Ensure access to container registry (CODECO private repo for now)
+## Ensure access to container registry
 
-- Create appropriate access token in CODECO container registry, with scopes
+- Create appropriate access token in private container registry, with scopes
   - api
   - read_registry
 - In local shell:  (=> enter username and access token as password)
   
   ```bash
-  docker login https://colab-repo.intracom-telecom.com (=> enter username and access token as password)
+  DOCKERUSER=<your_docker_username>
+  ACCESSTOKEN=<your_access_token>
+  REGISTRYHOST=colab-repo.intracom-telecom.com
+  REGISTRYNAME=${REGISTRYHOST}:5050
+  REGISTRYURL=https://${REGISTRYNAME}
+  REPOHOST=colab-repo.intracom-telecom.com
+  REPOGROUP=/colab-projects/he-codeco/swm/
+  docker login ${REGISTRYURL} -u ${DOCKERUSER} -p ${ACCESSTOKEN}
   ```
 
 - Test registry access (optional)
   
   ```bash
-  docker pull colab-repo.intracom-telecom.com:5050/colab-projects/he-codeco/swm/qos-scheduler/custom-scheduler:main
+  docker pull ${REGISTRYNAME}${REPOGROUP}qos-scheduler/custom-scheduler:main
   ```
 
 ## Copy required scripts to local environment
 
-- One way is to clone the CODECO private repository
+- One way is to clone the private repository
 
   ```bash
   cd <qos-scheduler-directory>
-  git clone https://colab-repo.intracom-telecom.com/colab-projects/he-codeco/swm/qos-scheduler.git
+  git clone https://${REPOHOST}${REPOGROUP}qos-scheduler.git
   ```
 
 - **Attention:** If this is done in Windows (using Visual Studio Code - VSC), depending on the settings of VSC, it may happen that text files use a CRLF (Carriage Return Line Feed) as line separation (the "Windows way"). Scripts will not execute with this or throw errors. The solution to this problem:
@@ -57,7 +64,7 @@ Steps for getting a demo to run on a local Linux Helm environment and a local Ki
 
 - This will install a KinD cluster with one master and two worker nodes
   - The K8s config to access the cluster will be appended to ~/.kube/config and in case there are multiple clusters in the config file, the context (of kubectl) will be switched to the new KinD cluster
-- Check whether cluster is working
+- Check whether cluster is working and whether your K8s config is pointing to the right cluster
 
   ```bash
   kubectl get nodes
@@ -74,13 +81,13 @@ Steps for getting a demo to run on a local Linux Helm environment and a local Ki
 
 # Install QoS scheduler
 
-## Install QoS Scheduler and Optimizer
+## Install QoS Scheduler and Solver
 
 - In local shell:
 
   ```bash
   make chart
-  helm install qostest --namespace=controllers-system --create-namespace --set global.image.credentials.username=<your-docker-username> --set global.image.credentials.password=<your-docker-token> --set global.image.credentials.email=<docker-token-user>@<your-domain> tmp/helm
+  helm install qostest --namespace=controllers-system --create-namespace --set global.image.credentials.username=${DOCKERUSER} --set global.image.credentials.password=${ACCESSTOKEN} --set global.image.credentials.email=${DOCKERUSER} --set global.image.credentials.registry=${REGISTRYURL} tmp/helm
   ```
 
 - Show network topology/ network links (Custom Resources)
@@ -89,14 +96,14 @@ Steps for getting a demo to run on a local Linux Helm environment and a local Ki
   kubectl get networklinks -A
   ```
 
-  This should show you links in the network-k8s-namespace and network-loopback-namespace namespaces.
+  This should show you links in the network-k8s-namespace namespace.
 - Show network paths (Custom Resources)
 
   ```bash
   kubectl get networkpaths -A
   ```
 
-  This should show you paths in both the above namespaces.
+  This should show you paths in both the above namespace.
 
 # Deploy sample ApplicationGroup and Application
 
@@ -121,14 +128,14 @@ Steps for getting a demo to run on a local Linux Helm environment and a local Ki
 
   ```bash
   kubectl apply -f config/demo/applicationgroup.yaml
-  kubectl apply -f config/demo/app1.yaml
+  kubectl apply -f config/demo/app-besteffort.yaml
   ```
 
-- This will create an *ApplicationGroup* with minimum 1 Applications and the Application App1, which consists of
+- This will create an *ApplicationGroup* with minimum 1 Applications and the Application app-besteffort, which consists of
   - Two *Workloads* w1 and w2
     - each Workload has a container wbitt/network-multitool (which has a couple of networking tools to test and demonstrate communication)
   - *Channel* "ernie" from w1 to w2 (5Mbit/s, 150µs)
-  - *Channel* with a generated name (app1-w2-to-app1-w1) from w2 to w1 (2Mbit/s, 200µs)
+  - *Channel* with a generated name (app-besteffort-w2-to-app-besteffort-w1) from w2 to w1 (2Mbit/s, 200µs)
 
 *Channel* "ernie" requests the *BESTEFFORT* network service class, which the default Helm chart
 maps to the *k8s* network (which gets created automatically).

config/demo/app-assured-with-recommendations.yaml

@@ -46,9 +46,8 @@ spec:
         port: 3333
       basename: ernie
       serviceClass: ASSURED
-      bandwidth: "1M"
-      framesize: "150"
-      maxDelay: "100E-4"
+      bandwidth: "5M"
+      maxDelay: "150E-6"
   - basename: w2
     nodeRecommendations:
       c1: 0.2
@@ -76,7 +75,6 @@ spec:
         applicationName: app1-assured
         port: 4444
       serviceClass: ASSURED
-      bandwidth: "1M"
-      framesize: "150"
-      maxDelay: "100E-4"
+      bandwidth: "2M"
+      maxDelay: "200E-6"
 

config/demo/app-besteffort.yaml

@@ -50,9 +50,8 @@ spec:
         port: 3333
       basename: ernie
       serviceClass: BESTEFFORT
-      bandwidth: "1M"
-      framesize: "150"
-      maxDelay: "100E-4"
+      bandwidth: "5M"
+      maxDelay: "150E-6"
   - basename: w2
     template:
       metadata:
@@ -84,6 +83,5 @@ spec:
         applicationName: app-besteffort
         port: 4444
       serviceClass: BESTEFFORT
-      bandwidth: "1M"
-      framesize: "150"
-      maxDelay: "100E-4"
+      bandwidth: "2M"
+      maxDelay: "200E-6"

config/demo/cluster-config.yaml

@@ -26,7 +26,7 @@ nodes:
             nodeRegistration:
               name: "C1"
               kubeletExtraArgs:
-                node-labels: "mac-address=5e0d.6660.a485"
+                node-labels: "mac-address=5e0d.6660.a485,siemens.com.qosscheduler.c1=true"
         - role: worker
           image: kindest/node:v1.23.1
           kubeadmConfigPatches:
@@ -35,5 +35,5 @@ nodes:
             nodeRegistration:
               name: "C2"
               kubeletExtraArgs:
-                node-labels: "mac-address=da69.022b.c8fc"
+                node-labels: "mac-address=da69.022b.c8fc,siemens.com.qosscheduler.c2=true"
 

config/demo/sample-topology-hybrid-cluster.yaml

@@ -22,8 +22,8 @@ spec:
       - source: ipc1
         target: ipc2
         capabilities:
-           bandWidthBits: "100M"
-           latencyNanos: "100e-6"
+           bandWidthBits: "100M" # unit: bit/s, default: 1Gbit/s
+           latencyNanos: "100e-6" # unit: seconds, default: 100µs
       - source: ipc2
         target: ipc1
         capabilities:
@@ -48,4 +48,13 @@ spec:
         target: ipc2
         capabilities:
            bandWidthBits: "10M"
-           latencyNanos: "20e-3"
+           latencyNanos: "20e-3"
\ No newline at end of file
+# Loopback links (need to be explicitely specified)
+      - source: ipc1
+        target: ipc1     
+      - source: ipc2
+        target: ipc2     
+      - source: cloud
+        target: cloud    
+      - source: control-plane
+        target: control-plane     

config/demo/sample-topology.yaml

@@ -24,7 +24,7 @@ spec:
         target: c2
         capabilities:
            bandWidthBits: "100M" # unit: bit/s, default: 1Gbit/s
-           latencyNanos: "200e-6" # unit: seconds, default: 100µs
+           latencyNanos: "150e-6" # unit: seconds, default: 100µs
       - source: c2
         target: c1
       - source: c1

container/deploy/Dockerfile-controller

 # SPDX-FileCopyrightText: 2023 Siemens AG
 # SPDX-License-Identifier: Apache-2.0
 
-# Use distroless as minimal base image to package the manager binary
-# Refer to https://github.com/GoogleContainerTools/distroless for more details
-FROM gcr.io/distroless/static:nonroot
+FROM alpine:3.13.5
 ARG TARGETARCH
 WORKDIR /bin
 COPY manager_${TARGETARCH} /bin/manager

container/deploy/Dockerfile-networkoperator

 # SPDX-FileCopyrightText: 2023 Siemens AG
 # SPDX-License-Identifier: Apache-2.0
 
-# Use distroless as minimal base image to package the manager binary
-# Refer to https://github.com/GoogleContainerTools/distroless for more details
-
-FROM gcr.io/distroless/static:nonroot
+FROM alpine:3.13.5
 ARG TARGETARCH
 WORKDIR /bin
 COPY k8s-nw-operator_$TARGETARCH /bin/k8s-nw-operator

helm/qos-scheduler/charts/controller/templates/role.yaml

@@ -228,3 +228,4 @@ rules:
   verbs:
   - get
   - list
+  - watch