@grnsft/if 0.5.0 → 0.6.0-beta.0

package/manifests/examples/builtins/time-sync/success.yml

@@ -17,8 +17,8 @@ tree:
   children:
     child:
       pipeline:
-        - time-sync
-      config:
+        compute:
+          - time-sync
       inputs:
         - timestamp: '2023-12-12T00:00:00.000Z'
           duration: 1

package/manifests/examples/{builtins/groupby/failure-invalid-config-group.yml → features/regroup/failure-invalid-regroup.yml}

@@ -1,19 +1,12 @@
-name: groupby
-description: failure when `config->group-by->group` is not an array
+name: regroup
+description: failure when `regroup` is not an array
 initialize:
-  outputs: ['yaml']
-  plugins:
-    group-by:
-      path: "builtin"
-      method: GroupBy
+  plugins: {}
 tree:
   children:
     my-app:
       pipeline:
-        - group-by
-      config:
-        group-by:
-          group: cloud/region
+        regroup: cloud/region
       inputs:
         - timestamp: 2023-07-06T00:00
           duration: 300

package/manifests/examples/{builtins/groupby → features/regroup}/failure-missing-cloud-instance-type.yml

@@ -1,21 +1,14 @@
-name: groupby
-description: 
+name: regroup
+description:
 initialize:
- # outputs: ['yaml']
   plugins:
-    group-by:
-      path: "builtin"
-      method: GroupBy
 tree:
   children:
     my-app:
       pipeline:
-        - group-by
-      config:
-        group-by:
-          group:
-            - cloud/region
-            - cloud/instance-type
+        regroup:
+          - cloud/region
+          - cloud/instance-type
       inputs:
         - timestamp: 2023-07-06T00:00
           duration: 300

package/manifests/examples/{builtins/groupby → features/regroup}/success.yml

@@ -1,21 +1,14 @@
-name: groupby
+name: regroup
 description: successful path
 initialize:
-  # outputs: ['yaml']
   plugins:
-    group-by:
-      path: "builtin"
-      method: GroupBy
 tree:
   children:
     my-app:
       pipeline:
-        - group-by
-      config:
-        group-by:
-          group:
-            - cloud/region
-            - cloud/instance-type
+        regroup:
+          - cloud/region
+          - cloud/instance-type
       inputs:
         - timestamp: 2023-07-06T00:00
           duration: 300

package/manifests/examples/pipelines/generics.yml

@@ -2,17 +2,16 @@ name: generics
 description: a pipeline that does arbitrary calculations using our generic arithmetic builtins
 tags:
 initialize:
-  # outputs: [yaml]
   plugins:
     "interpolate":
       method: Interpolation
-      path: 'builtin'
+      path: "builtin"
       global-config:
         method: linear
         x: [0, 10, 50, 100]
         y: [0.12, 0.32, 0.75, 1.02]
-        input-parameter: 'cpu/utilization'
-        output-parameter: 'cpu-factor'
+        input-parameter: "cpu/utilization"
+        output-parameter: "cpu-factor"
     "cpu-factor-to-wattage":
       method: Multiply
       path: builtin
@@ -63,15 +62,15 @@ tree:
   children:
     child-1:
       pipeline:
-        - interpolate
-        - cpu-factor-to-wattage
-        - wattage-times-duration
-        - wattage-to-energy-kwh
-        - calculate-vcpu-ratio
-        - correct-cpu-energy-for-vcpu-ratio      
-        - coefficient
-        - multiply
-      config:
+        compute:
+          - interpolate
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+          - calculate-vcpu-ratio
+          - correct-cpu-energy-for-vcpu-ratio
+          - coefficient
+          - multiply
       defaults:
         cpu/thermal-design-power: 100
         vcpus-allocated: 1

package/manifests/examples/pipelines/instance-metadata.yml

@@ -11,7 +11,7 @@ initialize:
           https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/cloud-metdata-azure-instances.csv
         query:
           instance-class: cloud/instance-type
-        output: '*'
+        output: "*"
     extract-processor-name:
       path: builtin
       method: Regex
@@ -19,14 +19,13 @@ initialize:
         parameter: cpu-model-name
         match: /^([^,])+/g
         output: cpu/name
-  outputs:
-    - yaml
 tree:
   children:
     child:
       pipeline:
-        - cloud-instance-metadata
-        - extract-processor-name
+        compute:
+          - cloud-instance-metadata
+          - extract-processor-name
       inputs:
         - timestamp: 2023-08-06T00:00
           duration: 3600

package/manifests/examples/pipelines/nesting.yml

@@ -6,27 +6,51 @@ tags:
   category: on-premise
 aggregation:
   metrics:
-    - "carbon"
+    - carbon
   type: "both"
-params:
 initialize:
-  # outputs: ['yaml']
   plugins:
     "interpolate":
       method: Interpolation
-      path: 'builtin'
+      path: "builtin"
       global-config:
         method: linear
         x: [0, 10, 50, 100]
         y: [0.12, 0.32, 0.75, 1.02]
-        input-parameter: 'cpu/utilization'
-        output-parameter: 'cpu-factor'
+        input-parameter: "cpu/utilization"
+        output-parameter: "cpu-factor"
+      parameter-metadata:
+        inputs:
+          cpu/utilization:
+            unit: percentage
+            description: refers to CPU utilization.
+            aggregation-method: avg
+        outputs:
+          cpu-factor:
+            unit: kWh
+            description: result of interpolate
+            aggregation-method: avg
     "cpu-factor-to-wattage":
       method: Multiply
       path: builtin
       global-config:
         input-parameters: ["cpu-factor", "cpu/thermal-design-power"]
         output-parameter: "cpu-wattage"
+      parameter-metadata:
+        inputs:
+          cpu-factor:
+            unit: kWh
+            description: result of interpolate
+            aggregation-method: avg
+          cpu/thermal-design-power:
+            unit: kWh
+            description: thermal design power for a processor
+            aggregation-method: avg
+        outputs:
+          cpu-wattage:
+            unit: kWh
+            description: the energy used by the CPU
+            aggregation-method: sum
     "wattage-times-duration":
       method: Multiply
       path: builtin
@@ -40,6 +64,17 @@ initialize:
         numerator: cpu-wattage-times-duration
         denominator: 3600000
         output: cpu-energy-raw
+      parameter-metadata:
+        inputs:
+          cpu-wattage-times-duration:
+            unit: kWh
+            description: CPU wattage multiplied by duration
+            aggregation-method: sum
+        outputs:
+          cpu-energy-raw:
+            unit: kWh
+            description: Raw energy used by CPU in kWh
+            aggregation-method: sum
     "calculate-vcpu-ratio":
       method: Divide
       path: "builtin"
@@ -47,6 +82,12 @@ initialize:
         numerator: vcpus-total
         denominator: vcpus-allocated
         output: vcpu-ratio
+      parameter-metadata:
+        outputs:
+          vcpu-ratio:
+            unit: none
+            description: Ratio of vCPUs
+            aggregation-method: none
     "correct-cpu-energy-for-vcpu-ratio":
       method: Divide
       path: "builtin"
@@ -63,11 +104,32 @@ initialize:
       global-config:
         input-parameters: ["cpu-energy-kwh", "grid/carbon-intensity"]
         output-parameter: "carbon-operational"
+      parameter-metadata:
+        inputs:
+          cpu-energy-kwh:
+            unit: kWh
+            description: Corrected CPU energy in kWh
+            aggregation-method: sum
+          grid/carbon-intensity:
+            unit: gCO2eq/kWh
+            description: Carbon intensity for the grid
+            aggregation-method: avg
+        outputs:
+          carbon-operational:
+            unit: gCO2eq
+            description: Operational carbon footprint
+            aggregation-method: sum
     sci:
       path: "builtin"
       method: Sci
       global-config:
         functional-unit: "requests"
+      parameter-metadata:
+        inputs:
+          requests:
+            unit: none
+            description: expressed the final SCI value
+            aggregation-method: sum
     "sum-carbon":
       path: "builtin"
       method: Sum
@@ -76,6 +138,21 @@ initialize:
           - carbon-operational
           - carbon-embodied
         output-parameter: carbon
+      parameter-metadata:
+        inputs:
+          carbon-operational:
+            description: Operational carbon footprint
+            unit: gCO2eq
+            aggregation-method: sum
+          carbon-embodied:
+            description: Embodied carbon footprint
+            unit: gCO2eq
+            aggregation-method: sum
+        outputs:
+          carbon:
+            description: Total carbon footprint
+            unit: gCO2eq
+            aggregation-method: sum
     time-sync:
       method: TimeSync
       path: "builtin"
@@ -84,6 +161,32 @@ initialize:
         end-time: "2023-12-12T00:01:00.000Z"
         interval: 5
         allow-padding: true
+      parameter-metadata:
+        inputs:
+          timestamp:
+            unit: RFC3339
+            description: refers to the time of occurrence of the input
+            aggregation-method: none
+          duration:
+            unit: seconds
+            description: refers to the duration of the input
+            aggregation-method: sum
+          cloud/instance-type:
+            unit: none
+            description: type of Cloud Instance name used in the cloud provider APIs
+            aggregation-method: none
+          cloud/region:
+            unit: none
+            description: region cloud instance
+            aggregation-method: none
+          time-reserved:
+            unit: seconds
+            description: time reserved for a component
+            aggregation-method: avg
+          network/energy:
+            description: "Energy consumed by the Network of the component"
+            unit: "kWh"
+            aggregation-method: "sum"
 tree:
   children:
     child-0:
@@ -96,17 +199,18 @@ tree:
         vcpus-allocated: 1
         vcpus-total: 8
       pipeline:
-        - interpolate
-        - cpu-factor-to-wattage
-        - wattage-times-duration
-        - wattage-to-energy-kwh
-        - calculate-vcpu-ratio
-        - correct-cpu-energy-for-vcpu-ratio
-        - sci-embodied
-        - operational-carbon
-        - sum-carbon
-        - time-sync
-        - sci
+        compute:
+          - interpolate
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+          - calculate-vcpu-ratio
+          - correct-cpu-energy-for-vcpu-ratio
+          - sci-embodied
+          - operational-carbon
+          - sum-carbon
+          - time-sync
+          - sci
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           cloud/instance-type: A1
@@ -146,17 +250,18 @@ tree:
         vcpus-allocated: 1
         vcpus-total: 8
       pipeline:
-        - interpolate
-        - cpu-factor-to-wattage
-        - wattage-times-duration
-        - wattage-to-energy-kwh
-        - calculate-vcpu-ratio
-        - correct-cpu-energy-for-vcpu-ratio
-        - sci-embodied
-        - operational-carbon
-        - sum-carbon
-        - time-sync
-        - sci
+        compute:
+          - interpolate
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+          - calculate-vcpu-ratio
+          - correct-cpu-energy-for-vcpu-ratio
+          - sci-embodied
+          - operational-carbon
+          - sum-carbon
+          - time-sync
+          - sci
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           cloud/instance-type: A1
@@ -198,17 +303,18 @@ tree:
             vcpus-allocated: 1
             vcpus-total: 8
           pipeline:
-            - interpolate
-            - cpu-factor-to-wattage
-            - wattage-times-duration
-            - wattage-to-energy-kwh
-            - calculate-vcpu-ratio
-            - correct-cpu-energy-for-vcpu-ratio
-            - sci-embodied
-            - operational-carbon
-            - sum-carbon
-            - time-sync
-            - sci
+            compute:
+              - interpolate
+              - cpu-factor-to-wattage
+              - wattage-times-duration
+              - wattage-to-energy-kwh
+              - calculate-vcpu-ratio
+              - correct-cpu-energy-for-vcpu-ratio
+              - sci-embodied
+              - operational-carbon
+              - sum-carbon
+              - time-sync
+              - sci
           inputs:
             - timestamp: "2023-12-12T00:00:00.000Z"
               cloud/instance-type: A1
@@ -248,17 +354,18 @@ tree:
             vcpus-allocated: 1
             vcpus-total: 8
           pipeline:
-            - interpolate
-            - cpu-factor-to-wattage
-            - wattage-times-duration
-            - wattage-to-energy-kwh
-            - calculate-vcpu-ratio
-            - correct-cpu-energy-for-vcpu-ratio
-            - sci-embodied
-            - operational-carbon
-            - sum-carbon
-            - time-sync
-            - sci
+            compute:
+              - interpolate
+              - cpu-factor-to-wattage
+              - wattage-times-duration
+              - wattage-to-energy-kwh
+              - calculate-vcpu-ratio
+              - correct-cpu-energy-for-vcpu-ratio
+              - sci-embodied
+              - operational-carbon
+              - sum-carbon
+              - time-sync
+              - sci
           inputs:
             - timestamp: "2023-12-12T00:00:00.000Z"
               cloud/instance-type: A1