Merge pull request #926 from Green-Software-Foundation/update-output-…

…manifests

Update output manifests

manifests/examples/pipelines/pipeline-with-aggregate.yml

@@ -17,12 +17,38 @@ initialize:
         y: [0.12, 0.32, 0.75, 1.02]
         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
@@ -36,13 +62,39 @@ 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"
       global-config:
         numerator: vcpus-total
         denominator: vcpus-allocated
         output: vcpu-ratio
+      parameter-metadata:
+        inputs:
+          vcpus-total:
+            unit: count
+            description: total number of vcpus available on a particular resource
+            aggregation-method: none
+          vcpus-allocated:
+            unit: count
+            description: number of vcpus allocated to particular resource
+            aggregation-method: none
+        outputs:
+          vcpu-ratio:
+            unit: none
+            description: Ratio of vCPUs
+            aggregation-method: none
     "correct-cpu-energy-for-vcpu-ratio":
       method: Divide
       path: "builtin"
@@ -59,11 +111,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 # factor to convert per time to per f.unit
+      parameter-metadata:
+        inputs:
+          requests:
+            unit: none
+            description: expressed the final SCI value
+            aggregation-method: sum
     "sum-carbon":
       path: "builtin"
       method: Sum
@@ -80,6 +153,33 @@ 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
+        outputs:
+          synced-time:
+            unit: none
+            description: Synced time
+            aggregation-method: none
 tree:
   children:
     child-1:

manifests/examples/pipelines/pipeline-with-mocks.yml

@@ -43,7 +43,7 @@ initialize:
             description: region cloud instance
             unit: none
             aggregation-method: none
-    "interpolate":
+    interpolate:
       method: Interpolation
       path: "builtin"
       global-config:
@@ -63,37 +63,67 @@ initialize:
             description: result of interpolate
             unit: kWh
             aggregation-method: avg
-    "cpu-factor-to-wattage":
+    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:
+            description: result of interpolate
+            unit: kWh
+            aggregation-method: avg
           cpu/thermal-design-power:
             description: thermal design power for a processor
-            unit: kwh
+            unit: kWh
             aggregation-method: avg
         outputs:
           cpu-wattage:
             description: the energy used by the CPU
-            unit: kwh
+            unit: kWh
             aggregation-method: sum
-    "wattage-times-duration":
+    wattage-times-duration:
       method: Multiply
       path: builtin
       global-config:
         input-parameters: ["cpu-wattage", "duration"]
         output-parameter: "cpu-wattage-times-duration"
-    "wattage-to-energy-kwh":
+      parameter-metadata:
+        inputs:
+          cpu-wattage:
+            description: Energy used by the CPU
+            unit: kWh
+            aggregation-method: sum
+          duration:
+            description: Duration of the observation
+            unit: seconds
+            aggregation-method: sum
+        outputs:
+          cpu-wattage-times-duration:
+            description: CPU wattage multiplied by duration
+            unit: kWh
+            aggregation-method: sum
+    wattage-to-energy-kwh:
       method: Divide
       path: "builtin"
       global-config:
         numerator: cpu-wattage-times-duration
         denominator: 3600000
         output: cpu-energy-raw
-    "calculate-vcpu-ratio":
+      parameter-metadata:
+        inputs:
+          cpu-wattage-times-duration:
+            description: CPU wattage multiplied by duration
+            unit: kWh
+            aggregation-method: sum
+        outputs:
+          cpu-energy-raw:
+            description: Raw energy used by CPU in kWh
+            unit: kWh
+            aggregation-method: sum
+    calculate-vcpu-ratio:
       method: Divide
       path: "builtin"
       global-config:
@@ -110,37 +140,81 @@ initialize:
             description: number of vcpus allocated to particular resource
             unit: count
             aggregation-method: none
-    "correct-cpu-energy-for-vcpu-ratio":
+        outputs:
+          vcpu-ratio:
+            description: Ratio of vCPUs
+            unit: none
+            aggregation-method: none
+    correct-cpu-energy-for-vcpu-ratio:
       method: Divide
       path: "builtin"
       global-config:
         numerator: cpu-energy-raw
         denominator: vcpu-ratio
         output: cpu-energy-kwh
-    "sci-embodied":
+      parameter-metadata:
+        inputs:
+          cpu-energy-raw:
+            description: Raw energy used by CPU in kWh
+            unit: kWh
+            aggregation-method: sum
+          vcpu-ratio:
+            description: Ratio of vCPUs
+            unit: none
+            aggregation-method: none
+        outputs:
+          cpu-energy-kwh:
+            description: Corrected CPU energy in kWh
+            unit: kWh
+            aggregation-method: sum
+    sci-embodied:
       path: "builtin"
       method: SciEmbodied
-    "operational-carbon":
+    operational-carbon:
       method: Multiply
       path: builtin
       global-config:
         input-parameters: ["cpu-energy-kwh", "grid/carbon-intensity"]
         output-parameter: "carbon-operational"
       parameter-metadata:
         inputs:
+          cpu-energy-kwh:
+            description: Corrected CPU energy in kWh
+            unit: kWh
+            aggregation-method: sum
           grid/carbon-intensity:
             description: Carbon intensity for the grid
             unit: gCO2eq/kWh
             aggregation-method: avg
-    "sum-carbon":
+        outputs:
+          carbon-operational:
+            description: Operational carbon footprint
+            unit: gCO2eq
+            aggregation-method: sum
+    sum-carbon:
       path: "builtin"
       method: Sum
       global-config:
         input-parameters:
           - carbon-operational
           - carbon-embodied
         output-parameter: carbon
-    "sci":
+      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
+    sci:
       path: "builtin"
       method: Sci
       global-config:
@@ -151,7 +225,12 @@ initialize:
             description: expressed the final SCI value
             unit: none
             aggregation-method: sum
-    "time-sync":
+        outputs:
+          sci:
+            description: Scientific Carbon Intensity
+            unit: none
+            aggregation-method: none
+    time-sync:
       method: TimeSync
       path: "builtin"
       global-config:
@@ -165,9 +244,25 @@ initialize:
             description: time reserved for a component
             unit: seconds
             aggregation-method: avg
-    "group-by":
+        outputs:
+          synced-time:
+            description: Synced time
+            unit: none
+            aggregation-method: none
+    group-by:
       path: builtin
       method: GroupBy
+      parameter-metadata:
+        inputs:
+          group:
+            description: Group by fields
+            unit: none
+            aggregation-method: none
+        outputs:
+          grouped-data:
+            description: Grouped data
+            unit: none
+            aggregation-method: none
 tree:
   children:
     child-1: