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

…manifests Update output manifests
Green-Software-Foundation · Aug 1, 2024 · b4eb9e6 · b4eb9e6
2 parents 7784397 + b615bc6
commit b4eb9e6
Show file tree

Hide file tree

Showing 4 changed files with 732 additions and 557 deletions.
diff --git a/manifests/examples/pipelines/nesting.yml b/manifests/examples/pipelines/nesting.yml
@@ -20,12 +20,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
@@ -39,13 +65,30 @@ 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:
+        outputs:
+          vcpu-ratio:
+            unit: none
+            description: Ratio of vCPUs
+            aggregation-method: none
     "correct-cpu-energy-for-vcpu-ratio":
       method: Divide
       path: "builtin"
@@ -62,11 +105,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
@@ -83,6 +147,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: