@grnsft/if 0.3.3-beta.0 → 0.4.0-beta.0

package/manifests/plugins/coefficient/failure-output-param-is-null.yaml

@@ -0,0 +1,24 @@
+name: coefficient-demo
+description: value of output-param is missing
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    coefficient:
+      method: Coefficient
+      path: "builtin"
+      global-config:
+        input-parameter: "carbon"
+        coefficient: 3
+        output-parameter: 
+tree:
+  children:
+    child:
+      pipeline:
+        - coefficient
+      config:
+        sum:
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          carbon: 30

package/manifests/plugins/coefficient/success.yml

@@ -6,7 +6,7 @@ initialize:
   plugins:
     coefficient:
       method: Coefficient
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         input-parameter: "carbon"
         coefficient: 3

package/manifests/plugins/csv-lookup/failure-missing-column.yml

@@ -0,0 +1,26 @@
+name: csv-lookup-demo
+description:
+tags:
+initialize:
+  # outputs:
+  #   - yaml
+  plugins:
+    cloud-metadata:
+      method: CSVLookup
+      path: 'builtin'
+      global-config:
+        filepath: https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/region-metadata.csv
+        query:
+          cloud-provider: "nonexistant"
+          cloud-region: "cloud/region"
+        output: "*"
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cloud/provider: Google Cloud
+          cloud/region: asia-east1

package/manifests/plugins/csv-lookup/failure-missing-output.yml

@@ -0,0 +1,26 @@
+name: csv-lookup-demo
+description:
+tags:
+initialize:
+  # outputs:
+  #   - yaml
+  plugins:
+    cloud-metadata:
+      method: CSVLookup
+      path: 'builtin'
+      global-config:
+        filepath: https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/region-metadata.csv
+        query:
+          cloud-provider: "cloud/provider"
+          cloud-region: "cloud/region"
+        output: "*"
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cloud/provider: Google Cloud
+          cloud/region: asia-east1

package/manifests/plugins/csv-lookup/success-renaming.yml

@@ -0,0 +1,26 @@
+name: csv-lookup-demo
+description:
+tags:
+initialize:
+  # outputs:
+  #   - yaml
+  plugins:
+    cloud-metadata:
+      method: CSVLookup
+      path: 'builtin'
+      global-config:
+        filepath: https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/region-metadata.csv
+        query:
+          cloud-provider: "cloud/provider"
+          cloud-region: "cloud/region"
+        output: ['em-zone-id','renamed-em-zone-data']
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cloud/provider: Google Cloud
+          cloud/region: asia-east1

package/manifests/plugins/csv-lookup/success.yml

@@ -0,0 +1,26 @@
+name: csv-lookup-demo
+description:
+tags:
+initialize:
+  # outputs:
+  #   - yaml
+  plugins:
+    cloud-metadata:
+      method: CSVLookup
+      path: 'builtin'
+      global-config:
+        filepath: https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/region-metadata.csv
+        query:
+          cloud-provider: "cloud/provider"
+          cloud-region: "cloud/region"
+        output: "*"
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cloud/provider: Google Cloud
+          cloud/region: asia-east-1

package/manifests/plugins/divide/failure-denominator-equal-zero.yml

@@ -0,0 +1,39 @@
+name: divide
+description: denominator is invalid, denominator is
+tags:
+initialize:
+#  outputs: ['yaml']
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"
+    divide:
+      method: Divide
+      path: "builtin"
+      global-config:
+        numerator: vcpus-allocated
+        denominator: 0
+        output: cpu/number-cores
+    boavizta-cpu:
+      method: BoaviztaCpuOutput
+      path: "@grnsft/if-unofficial-plugins"
+      global-config:
+        allocation: LINEAR
+        verbose: true
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+        - divide
+        - boavizta-cpu
+      config:
+        divide:
+      defaults:
+        cloud/vendor: aws
+        cloud/instance-type: m5n.large
+        cpu/name: Intel® Core™ i7-1185G7
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/utilization: 80

package/manifests/plugins/divide/failure-invalid-config-denominator.yml

@@ -9,7 +9,7 @@ initialize:
       path: "@grnsft/if-plugins"
     divide:
       method: Divide
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         numerator: vcpus-allocated
         denominator: 'vcpus'

package/manifests/plugins/divide/failure-missing-numerator.yml

@@ -0,0 +1,39 @@
+name: divide
+description: success path
+tags:
+initialize:
+#  outputs: ['yaml']
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"
+    divide:
+      method: Divide
+      path: "builtin"
+      global-config:
+        #numerator: vcpus-allocated
+        denominator: 2
+        output: cpu/number-cores
+    boavizta-cpu:
+      method: BoaviztaCpuOutput
+      path: "@grnsft/if-unofficial-plugins"
+      global-config:
+        allocation: LINEAR
+        verbose: true
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+        - divide
+        - boavizta-cpu
+      config:
+        divide:
+      defaults:
+        cloud/vendor: aws
+        cloud/instance-type: m5n.large
+        cpu/name: Intel® Core™ i7-1185G7
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/utilization: 80

package/manifests/plugins/divide/success.yml

@@ -2,14 +2,14 @@ name: divide
 description: success path
 tags:
 initialize:
-  outputs: ['yaml']
+#  outputs: ['yaml']
   plugins:
     cloud-metadata:
       method: CloudMetadata
       path: "@grnsft/if-plugins"
     divide:
       method: Divide
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         numerator: vcpus-allocated
         denominator: 2

package/manifests/plugins/groupby/failure-missing-cloud-instance-type.yml

@@ -0,0 +1,49 @@
+name: groupby
+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
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 300
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 99
+        - timestamp: 2023-07-06T05:00
+          duration: 300
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 23
+        - timestamp: 2023-07-06T10:00
+          duration: 300
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 12
+        - timestamp: 2023-07-06T00:00 # note this time restarts at the start timstamp
+          duration: 300
+          cloud/instance-type: B1
+          cloud/region: uk-west
+          cpu/utilization: 11
+        - timestamp: 2023-07-06T05:00
+          duration: 300
+          cloud/instance-type: B1
+          cloud/region: uk-west
+          cpu/utilization: 67
+        - timestamp: 2023-07-06T10:00
+          duration: 300
+          #cloud/instance-type: B1  -- missing value
+          cloud/region: uk-west
+          cpu/utilization: 1

package/manifests/plugins/interpolation/interpolation.yml

@@ -0,0 +1,24 @@
+name: interpolation-demo
+description: simple demo of interpolation plugin
+tags:
+initialize:
+  plugins:
+    interpolation:
+      method: Interpolation
+      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: "result"
+
+tree:
+  children:
+    child:
+      pipeline:
+        - interpolation
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
+          cpu/utilization: 45

package/manifests/plugins/mock-observations/failure-invalid-config-cpu-range.yml

@@ -7,7 +7,7 @@ initialize:
     mock-observations:
       kind: plugin
       method: MockObservations
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         timestamp-from: 2023-07-06T00:00
         timestamp-to: 2023-07-06T00:10

package/manifests/plugins/mock-observations/failure-invalid-memory-utilization-range.yml

@@ -0,0 +1,34 @@
+name: mock-observation-demo
+description: a manifest demonstrating how to use the mock observations feature
+tags:
+initialize:
+ # outputs: ['yaml']
+  plugins:
+    mock-observations:
+      kind: plugin
+      method: MockObservations
+      path: "builtin"
+      global-config:
+        timestamp-from: 2023-07-06T00:00
+        timestamp-to: 2023-07-06T00:10
+        duration: 60
+        components:
+          - cloud/instance-type: A1
+          - cloud/instance-type: B1
+        generators:
+          common:
+            region: uk-west
+            common-key: common-val
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99
+            memory/utilization:
+              min: 99
+              max: 10
+tree:
+  children:
+    child:
+      pipeline:
+        - mock-observations
+      inputs:

package/manifests/plugins/mock-observations/failure-missing-timestamp-from-param.yml

@@ -0,0 +1,34 @@
+name: mock-observation-demo
+description: a manifest demonstrating how to use the mock observations feature
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    mock-observations:
+      kind: plugin
+      method: MockObservations
+      path: "builtin"
+      global-config:
+        #timestamp-from: 2023-07-06T00:00
+        timestamp-to: 2023-07-06T00:10
+        duration: 60
+        components:
+          - cloud/instance-type: A1
+          - cloud/instance-type: B1
+        generators:
+          common:
+            region: uk-west
+            common-key: common-val
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99
+            memory/utilization:
+              min: 1
+              max: 99
+tree:
+  children:
+    child:
+      pipeline:
+        - mock-observations
+      inputs:

package/manifests/plugins/mock-observations/success.yml

@@ -2,12 +2,12 @@ name: mock-observation-demo
 description: a manifest demonstrating how to use the mock observations feature
 tags:
 initialize:
-  outputs: ['yaml']
+ # outputs: ['yaml']
   plugins:
     mock-observations:
       kind: plugin
       method: MockObservations
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         timestamp-from: 2023-07-06T00:00
         timestamp-to: 2023-07-06T00:10

package/manifests/plugins/multiply/failure-input-parameter-is-missing.yml

@@ -6,7 +6,7 @@ initialize:
   plugins:
     multiply:
       method: Multiply
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         input-parameters: ["cpu/energy", "network/energy"]
         output-parameter: "energy-product"

package/manifests/plugins/multiply/success-with-multiple-inputs.yml

@@ -0,0 +1,32 @@
+name: multiply
+description: a manifest demonstrating how to use the multiply feature
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    multiply:
+      method: Multiply
+      path: "builtin"
+      global-config:
+        input-parameters: ["cpu/energy", "network/energy"]
+        output-parameter: "energy-product"
+tree:
+  children:
+    child:
+      pipeline:
+        - multiply
+      config:
+        sum: 
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/energy: 0.001
+          network/energy: 0.002
+        - timestamp: 2023-08-06T10:00
+          duration: 3600
+          cpu/energy: 0.005
+          network/energy: -0.002
+        - timestamp: 2023-08-06T10:00
+          duration: 3600
+          cpu/energy: 0.005
+          network/energy: 0

package/manifests/plugins/multiply/success.yml

@@ -2,11 +2,11 @@ name: multiply
 description: a manifest demonstrating how to use the multiply feature
 tags:
 initialize:
-  outputs: ['yaml']
+ # outputs: ['yaml']
   plugins:
     multiply:
       method: Multiply
-      path: "@grnsft/if-plugins"
+      path: builtin
       global-config:
         input-parameters: ["cpu/energy", "network/energy"]
         output-parameter: "energy-product"
@@ -16,7 +16,7 @@ tree:
       pipeline:
         - multiply
       config:
-        sum:
+        sum: 
       inputs:
         - timestamp: 2023-08-06T00:00
           duration: 3600

package/manifests/plugins/regex/failure-missing-input-param.yml

@@ -6,7 +6,7 @@ initialize:
   plugins:
     regex:
       method: Regex
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         parameter: physical-processor
         match: ^(.*),

package/manifests/plugins/regex/failure-not-matching-with-regex.yml

@@ -0,0 +1,24 @@
+name: regex
+description: physical processor doesn't match the regex expression
+tags:
+initialize:
+ # outputs: ['yaml']
+  plugins:
+    regex:
+      method: Regex
+      path: "builtin"
+      global-config:
+        parameter: physical-processor
+        match: ^
+        output: cpu/name
+tree:
+  children:
+    child:
+      pipeline:
+        - regex
+      config:
+        regex:
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          physical-processor: Intel® Xeon® Platinum 8272CL,Intel® Xeon® 8171M 2.1 GHz,Intel® Xeon® E5-2673 v4 2.3 GHz,Intel® Xeon® E5-2673 v3 2.4 GHz

package/manifests/plugins/regex/success.yml

@@ -2,11 +2,11 @@ name: regex
 description: successful path
 tags:
 initialize:
-  outputs: ['yaml']
+  # outputs: ['yaml']
   plugins:
     regex:
       method: Regex
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         parameter: physical-processor
         match: ^(.*),

package/manifests/plugins/sci/failure-invalid-config-value.yml

@@ -7,9 +7,9 @@ initialize:
     sci:
       kind: plugin
       method: Sci
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       # global-config:
-      #   functional-unit-time: 1 minute
+      #   functional-unit: 1 minute
 tree:
   children:
     child:
@@ -17,7 +17,6 @@ tree:
         - sci
       config:
         sci:
-          functional-unit-time: 1 sec
           functional-unit: 999 # factor to convert per time to per f.unit
       inputs:
         - timestamp: 2023-07-06T00:00

package/manifests/plugins/sci/failure-missing-input-param.yml

@@ -0,0 +1,27 @@
+name: sci
+description: missing input value (carbon-embodied)
+tags:
+initialize:
+  #outputs: ['yaml']
+  plugins:
+    sci:
+      kind: plugin
+      method: Sci
+      path: "builtin"
+      # global-config:
+      #   functional-unit: requests
+tree:
+  children:
+    child:
+      pipeline:
+        - sci
+      config:
+        sci:
+          functional-unit-time: 1 sec
+          functional-unit: requests # factor to convert per time to per f.unit
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
+          energy: 5
+          carbon-operational: 5
+          requests: 100

package/manifests/plugins/sci/success.yml

@@ -2,14 +2,14 @@ name: sci
 description: successful path
 tags:
 initialize:
-  outputs: ['yaml']
+  # outputs: ['yaml']
   plugins:
     sci:
       kind: plugin
       method: Sci
-      path: "@grnsft/if-plugins"
-      # global-config:
-      #   functional-unit-time: 1 minute
+      path: "builtin"
+      global-config:
+        functional-unit: requests
 tree:
   children:
     child:
@@ -25,4 +25,5 @@ tree:
           energy: 5
           carbon-operational: 5
           carbon-embodied: 0.02
+          carbon: 5.02
           requests: 100

package/manifests/plugins/{sci-m → sci-embodied}/failure-invalid-default-emission-value.yml

@@ -1,18 +1,17 @@
-name: sci-m
+name: sci-embodied
 description: failure with `defaults.device/emissions-embodied` being string instead of number
 tags:
 initialize:
   outputs: ['yaml']
   plugins:
-    "sci-m": # a model that calculates m from te, tir, el, rr and rtor
-      method: SciM
-      verbose: false
-      path: "@grnsft/if-plugins"
+    "sci-embodied": # a model that calculates m from te, tir, el, rr and rtor
+      method: SciEmbodied
+      path: "builtin"
 tree:
   children:
     child:
       pipeline:
-        - sci-m # duration & config -> embodied
+        - sci-embodied # duration & config -> embodied
       defaults:
         device/emissions-embodied: 'fail' # gCO2eq
         time-reserved: 3600 # 1hr in seconds

package/manifests/plugins/sci-embodied/failure-missing-expected-lifespan.yml

@@ -0,0 +1,23 @@
+name: sci-embodied
+description: missing device/expected-lifespan
+tags:
+initialize:
+  #outputs: ['yaml']
+  plugins:
+    "sci-embodied": # a model that calculates m from te, tir, el, rr and rtor
+      method: SciEmbodied
+      path: "builtin"
+tree:
+  children:
+    child:
+      pipeline:
+        - sci-embodied # duration & config -> embodied
+      defaults:
+        device/emissions-embodied: 1533.120 # gCO2eq
+        time-reserved: 3600 # 1hr in seconds
+        #device/expected-lifespan: 94608000 # 3 years in seconds
+        resources-reserved: 1
+        resources-total: 8
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600