Merge pull request #935 from Green-Software-Foundation/update-readme-…

…files Update readme files
Green-Software-Foundation · Aug 6, 2024 · 53c4ffa · 53c4ffa
2 parents c7cab7f + 5c59248
commit 53c4ffa
Show file tree

Hide file tree

Showing 23 changed files with 100 additions and 327 deletions.
diff --git a/Refactor-migration-guide.md b/Refactor-migration-guide.md
@@ -125,24 +125,23 @@ There have also been some changes to the structure of manifest files. Some of th
 
 - **Node level config**
 
-  We have also introduced the concept of node-level config. This is designed for pluin configuration that might vary between components in the tree. For example, for each child in the tree you might wish to use the `groupby` plugin to group the outputs according to a different set of keys.
+  We have also introduced the concept of node-level config. This is designed for pluin configuration that might vary between components in the tree. For example, for each child in the tree you might wish to use the `regroup` feature to group the outputs according to a different set of keys.
 
   ```yaml
   tree:
     children:
       child-1:
         pipeline:
-          - teads-curve
-          - sci-e
-          - sci-embodied
-          - sci-o
-          - time-sync
-          - sci
-        config:
-          group-by:
-            group:
-              - region
-              - cloud/instance-type
+          compute:
+            - teads-curve
+            - sci-e
+            - sci-embodied
+            - sci-o
+            - time-sync
+            - sci
+          regroup:
+            - region
+            - cloud/instance-type
   ```
 
 - **Defaults**
@@ -156,12 +155,13 @@ There have also been some changes to the structure of manifest files. Some of th
     children:
       child-1:
         pipeline:
-          - teads-curve
-          - sci-e
-          - sci-embodied
-          - sci-o
-          - time-sync
-          - sci
+          compute:
+            - teads-curve
+            - sci-e
+            - sci-embodied
+            - sci-o
+            - time-sync
+            - sci
        defaults:
           cpu/thermal-design-power: 100
           grid/carbon-intensity: 800
@@ -215,40 +215,6 @@ aggregation:
   type: 'both'
 ```
 
-### Groupby
-
-Groupby allows you to regroup your outputs according to keys you define. For example, maybe you want to group your outputs by region (show me all the outputs for applications run in `uk-south` etc). Groupby _is_ a plugin that needs to be initialized in the manifest.
-
-You can initialize the plugin as follows:
-
-```yaml
-initialize:
-  plugins:
-    'group-by':
-      path: builtin
-      method: GroupBy
-```
-
-Then you configure groupby for each component in the node level config. In the following example we will regroup the outputs by the `region`:
-
-```yaml
-tree:
-  children:
-    child-1:
-      pipeline:
-        - teads-curve
-        - sci-e
-        - sci-embodied
-        - sci-o
-        - time-sync
-        - group-by
-        - sci
-      config:
-        group-by:
-          group:
-            - region
-```
-
 ### Exhaust
 
 We have introduced `exhaust` as an IF feature. This is a wrapper around export plugins and it allows community contributors to create plugins for exporting to different formats.

diff --git a/.../regroup/failure-invalid-config-group.yml → ...tures/regroup/failure-invalid-regroup.yml b/.../regroup/failure-invalid-config-group.yml → ...tures/regroup/failure-invalid-regroup.yml
@@ -1,13 +1,12 @@
 name: regroup
-description: failure when `config->group-by->group` is not an array
+description: failure when `regroup` is not an array
 initialize:
   plugins: {}
 tree:
   children:
     my-app:
       pipeline:
-        regroup:
-          cloud/region
+        regroup: cloud/region
       inputs:
         - timestamp: 2023-07-06T00:00
           duration: 300

diff --git a/manifests/examples/features/regroup/failure-missing-cloud-instance-type.yml b/manifests/examples/features/regroup/failure-missing-cloud-instance-type.yml
@@ -2,9 +2,6 @@ name: regroup
 description:
 initialize:
   plugins:
-    group-by:
-      path: "builtin"
-      method: GroupBy
 tree:
   children:
     my-app:

diff --git a/manifests/examples/features/regroup/success.yml b/manifests/examples/features/regroup/success.yml
@@ -2,9 +2,6 @@ name: regroup
 description: successful path
 initialize:
   plugins:
-    group-by:
-      path: "builtin"
-      method: GroupBy
 tree:
   children:
     my-app:

diff --git a/...eatures/failure-invalid-config-group.yaml → ...uts/features/failure-invalid-regroup.yaml b/...eatures/failure-invalid-config-group.yaml → ...uts/features/failure-invalid-regroup.yaml
@@ -1,31 +1,31 @@
-name: groupby
-description: failure when `config->group-by->group` is not an array
+name: regroup
+description: failure when `regroup` is not an array
 initialize:
   plugins: {}
 execution:
   status: fail
   command: >-
-    /Users/mariamkhalatova/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
-    /Users/mariamkhalatova/Projects/UK/if/src/index.ts -m
-    manifests/outputs/plugins/groupby/failure-invalid-config-group.yml -o
-    manifests/outputs/plugins/groupby/failure-invalid-config-group
+    /Users/manushak/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
+    /Users/manushak/Documents/Projects/Green-Software/if/src/if-run/index.ts -m
+    manifests/examples/features/regroup/failure-invalid-regroup.yml -o
+    manifests/outputs/features/failure-invalid-regroup.yaml
   environment:
-    if-version: 0.4.0
+    if-version: 0.5.0
     os: macOS
-    os-version: "13.2"
-    node-version: 18.14.2
-    date-time: 2024-07-02T19:11:23.166Z (UTC)
+    os-version: 13.6.7
+    node-version: 18.20.0
+    date-time: 2024-08-05T14:53:00.560Z (UTC)
     dependencies:
-      - "@babel/[email protected]"
-      - "@babel/[email protected]"
-      - "@commitlint/[email protected]"
-      - "@commitlint/[email protected]"
-      - "@grnsft/[email protected].10"
-      - "@jest/[email protected]"
-      - "@types/[email protected]"
-      - "@types/[email protected]"
-      - "@types/[email protected]"
-      - "@types/[email protected]"
+      - '@babel/[email protected]'
+      - '@babel/[email protected]'
+      - '@commitlint/[email protected]'
+      - '@commitlint/[email protected]'
+      - '@grnsft/[email protected].16'
+      - '@jest/[email protected]'
+      - '@types/[email protected]'
+      - '@types/[email protected]'
+      - '@types/[email protected]'
+      - '@types/[email protected]'
       - [email protected]
       - [email protected]
       - [email protected]
@@ -34,6 +34,7 @@ execution:
       - [email protected]
       - [email protected]
       - [email protected]
+      - [email protected] extraneous -> file:../../if-eco-ci-plugin
       - [email protected]
       - [email protected]
       - [email protected]
@@ -45,16 +46,15 @@ execution:
       - [email protected]
       - [email protected]
       - [email protected]
-      - zod@3.22.4
+      - zod@3.23.8
   error: >-
     InputValidationError: "groups" parameter is expected array, received string.
     Error code: invalid_type.
 tree:
   children:
     my-app:
       pipeline:
-        regroup:
-          cloud/region
+        regroup: cloud/region
       inputs:
         - timestamp: 2023-07-06T00:00
           duration: 300

diff --git a/src/__mocks__/fs/index.ts b/src/__mocks__/fs/index.ts
@@ -52,8 +52,9 @@ cpu-cores-available,cpu-cores-utilized,cpu-manufacturer,cpu-model-name,cpu-tdp,g
   tree:
     children:
       front-end:
-        pipeline: 
-          - boavizta-cpu
+        pipeline:
+          compute:
+            - boavizta-cpu
         config:
           boavizta-cpu:
             core-units: 24

diff --git a/src/__mocks__/mock-manifest.yaml b/src/__mocks__/mock-manifest.yaml
@@ -57,7 +57,8 @@ tree:
   children:
     child:
       pipeline:
-        - memory-energy-from-memory-util
+        compute:
+          - memory-energy-from-memory-util
       config: null
       inputs:
         - timestamp: 2023-12-12T00:00:00.000Z

diff --git a/src/if-env/config/env-template.yml b/src/if-env/config/env-template.yml
@@ -14,7 +14,8 @@ tree:
   children: # add a chile for each distinct component you want to measure
     child:
       pipeline: # the pipeline is an ordered list of plugins you want to execute
-        - memory-energy-from-memory-util # must match the name in initialize!
+        compute:
+          - memory-energy-from-memory-util # must match the name in initialize!
       config: # any plugin specific, node-level config
       inputs:
         - timestamp: 2023-12-12T00:00:00.000Z # ISO 8061 string