Merge pull request #413 from CARV-ICS-FORTH/docs

Bump version
CARV-ICS-FORTH · Jun 25, 2023 · add645d · add645d
2 parents 35797cd + bc3d859
commit add645d
Show file tree

Hide file tree

Showing 136 changed files with 626 additions and 622 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,8 @@
 ### Changed defaults / behaviours
 - Moved charts from `charts/{category}` to `examples/apps`. This allows to have the apps and the test-cases on the same directory. Additionally, that
   means that chart releasing is no longer part of the frisbee release -- which shouldn't have been the case in the first place.
+- Renamed template to be in the format 'frisbee.system...' and 'frisbee.apps'. This, however, warrants a new release because 
+  the renamed systems templates affect the controller.
 - ...
 
 ### New Features & Functionality

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-v1.0.41
+v1.0.42
diff --git a/charts/system/templates/chaos/network-delay.yml b/charts/system/templates/chaos/network-delay.yml
@@ -2,7 +2,7 @@
 apiVersion: frisbee.dev/v1alpha1
 kind: Template
 metadata:
-  name: system.chaos.network.delay
+  name: frisbee.system.chaos.network.delay
 spec:
   inputs:
     parameters:

diff --git a/charts/system/templates/chaos/network-duplicate.yml b/charts/system/templates/chaos/network-duplicate.yml
@@ -2,7 +2,7 @@
 apiVersion: frisbee.dev/v1alpha1
 kind: Template
 metadata:
-  name: system.chaos.network.duplicate
+  name: frisbee.system.chaos.network.duplicate
 spec:
   inputs:
     parameters:

diff --git a/charts/system/templates/chaos/network-loss.yml b/charts/system/templates/chaos/network-loss.yml
@@ -2,7 +2,7 @@
 apiVersion: frisbee.dev/v1alpha1
 kind: Template
 metadata:
-  name: system.chaos.network.loss
+  name: frisbee.system.chaos.network.loss
 spec:
   inputs:
     parameters:

diff --git a/charts/system/templates/chaos/network-partition.yml b/charts/system/templates/chaos/network-partition.yml
@@ -4,7 +4,7 @@
 apiVersion: frisbee.dev/v1alpha1
 kind: Template
 metadata:
-  name: system.chaos.network.partition.partial
+  name: frisbee.system.chaos.network.partition.partial
 spec:
   inputs:
     parameters:

diff --git a/charts/system/templates/chaos/pod-kill.yml b/charts/system/templates/chaos/pod-kill.yml
@@ -2,7 +2,7 @@
 apiVersion: frisbee.dev/v1alpha1
 kind: Template
 metadata:
-  name: system.chaos.pod.kill
+  name: frisbee.system.chaos.pod.kill
 spec:
   inputs:
     parameters:

diff --git a/charts/system/templates/telemetry/cadvisor/cadvisor.yml b/charts/system/templates/telemetry/cadvisor/cadvisor.yml
@@ -10,7 +10,7 @@
 apiVersion: frisbee.dev/v1alpha1
 kind: Template
 metadata:
-  name: system.telemetry.resources
+  name: frisbee.system.telemetry.resources
 spec:
   service:
     decorators:
@@ -76,5 +76,5 @@ spec:
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: system.telemetry.resources.config
+  name: frisbee.system.telemetry.resources.config
 data: {{(.Files.Glob "dashboards/*.json").AsConfig | nindent 2}}
diff --git a/charts/system/templates/telemetry/dataviewer/dataviewer.yml b/charts/system/templates/telemetry/dataviewer/dataviewer.yml
@@ -2,7 +2,7 @@
 apiVersion: frisbee.dev/v1alpha1
 kind: Template
 metadata:
-  name: system.telemetry.dataviewer.template
+  name: frisbee.system.telemetry.dataviewer
 spec:
   service:
     decorators:

diff --git a/charts/system/templates/telemetry/grafana/grafana.yml b/charts/system/templates/telemetry/grafana/grafana.yml
@@ -2,7 +2,7 @@
 apiVersion: frisbee.dev/v1alpha1
 kind: Template
 metadata:
-  name: system.telemetry.grafana.template
+  name: frisbee.system.telemetry.grafana
 spec:
   service:
     decorators:

diff --git a/charts/system/templates/telemetry/prometheus/prometheus.yml b/charts/system/templates/telemetry/prometheus/prometheus.yml
@@ -39,7 +39,7 @@ subjects:
 apiVersion: frisbee.dev/v1alpha1
 kind: Template
 metadata:
-  name: system.telemetry.prometheus.template
+  name: frisbee.system.telemetry.prometheus
 spec:
   inputs:
     scenario: "default"

diff --git a/cmd/kubectl-frisbee/commands/tests/validate.go b/cmd/kubectl-frisbee/commands/tests/validate.go
@@ -17,6 +17,7 @@ limitations under the License.
 package tests
 
 import (
+	"github.com/jaytaylor/go-find"
 	"os"
 	"path/filepath"
 
@@ -67,18 +68,21 @@ func NewValidateTestCmd() *cobra.Command {
 					return
 				}
 
-				// Helm charts (and therefore templates) are validated by Helm
-				if _, err := os.Stat(testFile + "/Chart.yaml"); err == nil {
-					err = validateChart(testFile)
+				// search for all the directories that container Chart.yaml files.
+				// this file indicates that it's a helm chart that needs to be validated
+				finder := find.NewFind(testFile).Name("Chart.yaml")
+				hits, err := finder.Evaluate()
+				ui.ExitOnError("Unable to walk directory:"+testFile, err)
 
-					ui.ExitOnError("Chart Validation ...", err)
+				for _, hit := range hits {
+					// we only need the chart directory, not the path to Chart.yaml.
+					hit = filepath.Dir(hit)
 
-					ui.Success("Chart validated.", testFile)
+					err = validateChart(hit)
+					ui.ExitOnError("Chart Validation failed: "+hit, err)
 
-					return
+					ui.Success("Chart validated.", hit)
 				}
-
-				ui.Failf("Validation path should point to a Helm Chart or to an Examples directory.")
 			} else {
 				err := validateScenario(testFile)
 				ui.ExitOnError("Validating ...", err)

diff --git a/examples/apps/cockroachdb/examples/5.scaleup-scheduled.yml b/examples/apps/cockroachdb/examples/5.scaleup-scheduled.yml
@@ -9,7 +9,7 @@ spec:
     - action: Cluster
       name: masters
       cluster:
-        templateRef: cockroach.cluster.master
+        templateRef: frisbee.apps.cockroach.server
         instances: 3
         inputs:
           - { join: "masters-1:26257,masters-2:26257,masters-3:26257" }
@@ -28,7 +28,7 @@ spec:
       depends: { success: [ boot ] }
       name: loader
       service:
-        templateRef: ycsb.cockroach.loader
+        templateRef: frisbee.apps.ycsb.cockroach.loader
         inputs:
           - { server: .cluster.masters.one , workload: workloada, recordcount: "100000000", threads: "40" }
 
@@ -38,7 +38,7 @@ spec:
       name: more-servers
       depends: { running: [ loader ] }
       cluster:
-        templateRef: cockroach.cluster.master
+        templateRef: frisbee.apps.cockroach.server
         instances: 10
         inputs:
           - { join: "masters-1:26257" }

diff --git a/examples/apps/cockroachdb/examples/6.scaleup-conditional.yml b/examples/apps/cockroachdb/examples/6.scaleup-conditional.yml
@@ -9,7 +9,7 @@ spec:
     - action: Cluster
       name: masters
       cluster:
-        templateRef: cockroach.cluster.master
+        templateRef: frisbee.apps.cockroach.server
         instances: 3
         inputs:
           - { join: "masters-1:26257,masters-2:26257,masters-3:26257" }
@@ -27,7 +27,7 @@ spec:
       name: loaders
       depends: { success: [ boot ] }
       cluster:
-        templateRef: ycsb.cockroach.loader
+        templateRef: frisbee.apps.ycsb.cockroach.loader
         instances: 100
         inputs:
           - { server: .cluster.masters.one, workload: workloada, recordcount: "100000000", threads: "40", delay: "15" }
@@ -40,7 +40,7 @@ spec:
       name: more-servers
       depends: { success: [ boot ] }
       cluster:
-        templateRef: cockroach.cluster.master
+        templateRef: frisbee.apps.cockroach.server
         instances: 10
         inputs:
           - { join: "masters-1:26257" }

diff --git a/examples/apps/cockroachdb/examples/7.scaledown-delete.yml b/examples/apps/cockroachdb/examples/7.scaledown-delete.yml
@@ -9,7 +9,7 @@ spec:
     - action: Cluster
       name: masters
       cluster:
-        templateRef: cockroach.cluster.master
+        templateRef: frisbee.apps.cockroach.server
         instances: 3
         inputs:
           - { join: "masters-1:26257,masters-2:26257,masters-3:26257" }
@@ -29,7 +29,7 @@ spec:
       depends: { success: [ boot ] }
       name: loader
       service:
-        templateRef: ycsb.cockroach.loader
+        templateRef: frisbee.apps.ycsb.cockroach.loader
         inputs:
           - { server: .cluster.masters.one , workload: workloada, recordcount: "100000000", threads: "4", delay: "15" }
 
@@ -39,7 +39,7 @@ spec:
       name: groupa
       depends: { running: [ loader ] }
       cluster:
-        templateRef: cockroach.cluster.master
+        templateRef: frisbee.apps.cockroach.server
         instances: 5
         inputs:
           - { join: "masters-1:26257" }
@@ -49,7 +49,7 @@ spec:
       name: groupb
       depends: { running: [ groupa ] }
       cluster:
-        templateRef: cockroach.cluster.master
+        templateRef: frisbee.apps.cockroach.server
         instances: 5
         inputs:
           - { join: "masters-1:26257" }

diff --git a/examples/apps/cockroachdb/examples/8.scaledown-stop.yml b/examples/apps/cockroachdb/examples/8.scaledown-stop.yml
@@ -9,7 +9,7 @@ spec:
     - action: Cluster
       name: masters
       cluster:
-        templateRef: cockroach.cluster.master
+        templateRef: frisbee.apps.cockroach.server
         instances: 3
         inputs:
           - { join: "masters-1:26257,masters-2:26257,masters-3:26257" }
@@ -30,7 +30,7 @@ spec:
       depends: { success: [ boot ] }
       name: loader
       service:
-        templateRef: ycsb.cockroach.loader
+        templateRef: frisbee.apps.ycsb.cockroach.loader
         inputs:
           - { server: masters-1 , workload: workloada, recordcount: "100000000", threads: "4", delay: "15" }
 
@@ -40,7 +40,7 @@ spec:
       name: more-servers
       depends: { running: [ loader ] }
       cluster:
-        templateRef: cockroach.cluster.master
+        templateRef: frisbee.apps.cockroach.server
         instances: 10
         inputs:
           - { join: "masters-1:26257" }

diff --git a/examples/apps/cockroachdb/examples/9.scaledown-kill.yml b/examples/apps/cockroachdb/examples/9.scaledown-kill.yml
@@ -9,7 +9,7 @@ spec:
     - action: Cluster
       name: masters
       cluster:
-        templateRef: cockroach.cluster.master
+        templateRef: frisbee.apps.cockroach.server
         instances: 3
         inputs:
           - { join: "masters-1:26257,masters-2:26257,masters-3:26257" }
@@ -29,7 +29,7 @@ spec:
       depends: { success: [ boot ] }
       name: loader
       service:
-        templateRef: ycsb.cockroach.loader
+        templateRef: frisbee.apps.ycsb.cockroach.loader
         inputs:
           - { server: .cluster.masters.one , workload: workloada, recordcount: "100000000", threads: "4", delay: "15" }
 
@@ -39,7 +39,7 @@ spec:
       name: more-servers
       depends: { running: [ loader ] }
       cluster:
-        templateRef: cockroach.cluster.master
+        templateRef: frisbee.apps.cockroach.server
         instances: 10
         inputs:
           - { join: "masters-1:26257" }
@@ -52,7 +52,7 @@ spec:
       name: killer
       depends: { running: [ more-servers ] }
       cascade:
-        templateRef: system.chaos.pod.kill
+        templateRef: frisbee.system.chaos.pod.kill
         inputs:
           - { target: more-servers-4 }
           - { target: more-servers-7 }

diff --git a/examples/apps/cockroachdb/templates/server.yml b/examples/apps/cockroachdb/templates/server.yml
@@ -2,7 +2,7 @@
 apiVersion: frisbee.dev/v1alpha1
 kind: Template
 metadata:
-  name: cockroach.cluster.master
+  name: frisbee.apps.cockroach.server
 spec:
   inputs:
     parameters:
@@ -11,8 +11,8 @@ spec:
   service:
     decorators:
       telemetry:
-        - cockroach.telemetry.server
-        - system.telemetry.resources
+        - frisbee.apps.cockroach.server.telemetry
+        - frisbee.system.telemetry.resources
 
     volumes: # Create an ephemeral volume, backed by a file
       - name: scratch-volume

diff --git a/examples/apps/cockroachdb/templates/telemetry.yml b/examples/apps/cockroachdb/templates/telemetry.yml
@@ -2,7 +2,7 @@
 apiVersion: frisbee.dev/v1alpha1
 kind: Template
 metadata:
-  name: cockroach.telemetry.server
+  name: frisbee.apps.cockroach.server.telemetry
 spec:
   service:
     decorators:
@@ -46,5 +46,5 @@ spec:
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: cockroach.telemetry.server.config
+  name: frisbee.apps.cockroach.server.telemetry.config
 data: {{(.Files.Glob "dashboards/*.json").AsConfig | nindent 2}}
diff --git a/charts/system/templates/tools/debugger.yml → examples/apps/debugger/tools/debugger.yml b/charts/system/templates/tools/debugger.yml → examples/apps/debugger/tools/debugger.yml
diff --git a/charts/system/templates/tools/docker.yml → examples/apps/debugger/tools/docker.yml b/charts/system/templates/tools/docker.yml → examples/apps/debugger/tools/docker.yml
diff --git a/examples/apps/fedbed/examples/all_combined.yml b/examples/apps/fedbed/examples/all_combined.yml
@@ -2,7 +2,7 @@
 apiVersion: frisbee.dev/v1alpha1
 kind: Scenario
 metadata:
-  name: all_combined
+  name: all-combined
 spec:
   actions:
     # Step 0: Cache the downloaded dataset to the host (for multi-host setups, the host may change across executions)
@@ -17,7 +17,7 @@ spec:
     - action: Service
       name: server
       service:
-        templateRef: fedbed.server
+        templateRef: frisbee.apps.fedbed.server
         inputs:
           - { min_fit_clients: 3 }
 
@@ -26,7 +26,7 @@ spec:
       name: clients
       depends: { running: [ server ], success: [ cifar10-download ] }
       cluster:
-        templateRef: fedbed.client-shared-dataset
+        templateRef: frisbee.apps.fedbed.client-shared-dataset
         inputs:
           - { fl_server: server, dataset: fl.datasets.cifar10, backend: "pytorch", total_nodes: 3, node_id: 0 }
           - { fl_server: server, dataset: fl.datasets.cifar10, backend: "pytorch", total_nodes: 3, node_id: 0 }

diff --git a/examples/apps/fedbed/examples/cached-dataset.yml b/examples/apps/fedbed/examples/cached-dataset.yml
@@ -17,7 +17,7 @@ spec:
     - action: Service
       name: server
       service:
-        templateRef: fedbed.server
+        templateRef: frisbee.apps.fedbed.server
         inputs:
           - { min_fit_clients: 3 }
 
@@ -26,7 +26,7 @@ spec:
       name: clients
       depends: { running: [ server ], success: [ cifar10-download ] }
       cluster:
-        templateRef: fedbed.client-shared-dataset
+        templateRef: frisbee.apps.fedbed.client-shared-dataset
         inputs:
           - { fl_server: server, dataset: fl.datasets.cifar10, backend: "pytorch", total_nodes: 3, node_id: 0 }
           - { fl_server: server, dataset: fl.datasets.cifar10, backend: "pytorch", total_nodes: 3, node_id: 1 }

diff --git a/examples/apps/fedbed/examples/resource-distribution.yml b/examples/apps/fedbed/examples/resource-distribution.yml
@@ -9,7 +9,7 @@ spec:
     - action: Service
       name: server
       service:
-        templateRef: fedbed.server
+        templateRef: frisbee.apps.fedbed.server
         inputs:
           - { min_fit_clients: 3 }
 
@@ -18,7 +18,7 @@ spec:
       name: clients
       depends: { running: [ server ]}
       cluster:
-        templateRef: fedbed.client
+        templateRef: frisbee.apps.fedbed.client
         inputs:
           - { fl_server: server, dataset: "MNIST", backend: "pytorch", total_nodes: 3, node_id: 0 }
           - { fl_server: server, dataset: "MNIST", backend: "pytorch", total_nodes: 3, node_id: 1 }