@grnsft/if 0.3.2 → 0.3.4

package/manifests/integrations/mock-obs-groupby.yml

@@ -0,0 +1,39 @@
+name: Mock observations + Group by
+description: Integration of `mock observations` + `groupby plugins`
+initialize: 
+  plugins: 
+    mock-observations:
+      path: '@grnsft/if-plugins'
+      method: MockObservations
+      global-config:
+        timestamp-from: '2024-03-05T00:00:00.000Z'
+        timestamp-to: '2024-03-05T00:01:00.000Z'
+        duration: 10
+        components:
+          - name: server-1
+            cloud/instance-type: Standard_E64_v3
+            cloud/region: westus3
+          - name: server-2
+            cloud/instance-type: Standard_E64_v3
+            cloud/region: france            
+        generators:
+          common:
+            cloud/vendor: azure
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99
+    group-by: 
+      path: 'builtin'
+      method: GroupBy          
+tree: 
+  pipeline:
+    - mock-observations
+    - group-by
+  defaults:
+  config:
+    group-by:
+      group:
+        - cloud/region
+        - name
+  inputs: null

package/manifests/integrations/mock-obs-time-sync.yml

@@ -0,0 +1,65 @@
+name: Mock observation and time sync integration
+description: Integration of `mock observation` + `time sync`
+tags:
+initialize:
+  plugins:
+    mock-observations:
+      kind: plugin
+      method: MockObservations
+      path: "@grnsft/if-plugins"
+      global-config:
+        timestamp-from: 2023-07-06T00:00
+        timestamp-to: 2023-07-06T00:10
+        duration: 60
+        components:
+          - cloud/instance-type: A1
+        generators:
+          common:
+            cloud/region: uk-west
+            common-key: common-val
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99
+    "teads-curve":
+      path: "@grnsft/if-unofficial-plugins"
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+    "time-sync":
+      method: TimeSync
+      path: "builtin"
+      global-config:
+        start-time: "2023-12-12T00:00:00.000Z"
+        end-time: "2023-12-12T00:01:00.000Z"
+        interval: 5
+        allow-padding: true
+tree:
+  children:
+    child-1:
+      pipeline:
+        - teads-curve
+        - time-sync        
+      defaults:
+        cpu/thermal-design-power: 100
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          duration: 1
+          cpu/utilization: 10
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 20
+          cloud/instance-type: A1
+          cloud/region: uk-west
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 15
+          cloud/instance-type: A1
+          cloud/region: uk-west
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15

package/manifests/plugins/cloud-metadata/failure-invalid-vendor.yaml

@@ -0,0 +1,21 @@
+name: cloud-metadata
+description: failure with invalid `inputs.cloud/vendor`
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+      config:
+      inputs:
+        - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
+          cloud/vendor: gcp
+          cloud/instance-type: m5n.large
+          duration: 100
+          cpu/utilization: 10

package/{examples/manifests/cloud-metadata.yml → manifests/plugins/cloud-metadata/success.yml}

@@ -1,7 +1,8 @@
 name: cloud-metadata
-description: example impl invoking Cloud Metadata plugin
+description: successful path
 tags:
 initialize:
+  outputs: ['yaml']
   plugins:
     cloud-metadata:
       method: CloudMetadata

package/manifests/plugins/coefficient/failure-invalid-config-input-param.yml

@@ -0,0 +1,24 @@
+name: coefficient-demo
+description: failure with ivalid `global-config.input-parameter`
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    coefficient:
+      method: Coefficient
+      path: "@grnsft/if-plugins"
+      global-config:
+        input-parameter: 4
+        coefficient: 3
+        output-parameter: "carbon-product"
+tree:
+  children:
+    child:
+      pipeline:
+        - coefficient
+      config:
+        sum:
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          carbon: 30

package/{examples/manifests/coefficient.yml → manifests/plugins/coefficient/success.yml}

@@ -1,7 +1,8 @@
 name: coefficient-demo
-description:
+description: successful path
 tags:
 initialize:
+  outputs: ['yaml']
   plugins:
     coefficient:
       method: Coefficient

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

@@ -0,0 +1,39 @@
+name: divide
+description: failure when `global-config.denominator` is string
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"
+    divide:
+      method: Divide
+      path: "@grnsft/if-plugins"
+      global-config:
+        numerator: vcpus-allocated
+        denominator: 'vcpus'
+        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

@@ -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: "@grnsft/if-plugins"
+      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/groupby/failure-invalid-config-group.yml

@@ -0,0 +1,47 @@
+name: groupby
+description: failure when `config->group-by->group` is not an array
+initialize:
+  outputs: ['yaml']
+  plugins:
+    group-by:
+      path: "builtin"
+      method: GroupBy
+tree:
+  children:
+    my-app:
+      pipeline:
+        - group-by
+      config:
+        group-by:
+          group: cloud/region
+      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
+          cloud/region: uk-west
+          cpu/utilization: 1

package/{examples/manifests/group-by.yml → manifests/plugins/groupby/success.yml}

@@ -1,6 +1,7 @@
-name: groupby-demo
-description: demo pipeline
+name: groupby
+description: successful path
 initialize:
+  outputs: ['yaml']
   plugins:
     group-by:
       path: "builtin"

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

@@ -0,0 +1,34 @@
+name: mock-observation-demo
+description: failure with `global-config->generators->randint->cpu/utilization->min` is greater than `max`
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    mock-observations:
+      kind: plugin
+      method: MockObservations
+      path: "@grnsft/if-plugins"
+      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: 99
+              max: 10
+            memory/utilization:
+              min: 1
+              max: 99
+tree:
+  children:
+    child:
+      pipeline:
+        - mock-observations
+      inputs:

package/{examples/manifests/mock-observation.yml → manifests/plugins/mock-observations/success.yml}

@@ -1,7 +1,8 @@
 name: mock-observation-demo
-description: example invoking mock-observation plugin
+description: a manifest demonstrating how to use the mock observations feature
 tags:
 initialize:
+  outputs: ['yaml']
   plugins:
     mock-observations:
       kind: plugin

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

@@ -0,0 +1,24 @@
+name: multiply
+description: failure `inputs` is missing `cpu/energy` parameter
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    multiply:
+      method: Multiply
+      path: "@grnsft/if-plugins"
+      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: 0.001
+          network/energy: 0.002

package/{examples/manifests/multiply.yml → manifests/plugins/multiply/success.yml}

@@ -1,7 +1,8 @@
-name: multiply-demo
-description:
+name: multiply
+description: a manifest demonstrating how to use the multiply feature
 tags:
 initialize:
+  outputs: ['yaml']
   plugins:
     multiply:
       method: Multiply

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

@@ -0,0 +1,24 @@
+name: regex
+description: failure with missing `physical-processor` field from `inputs`
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    regex:
+      method: Regex
+      path: "@grnsft/if-plugins"
+      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: 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/{examples/manifests/regex.yml → manifests/plugins/regex/success.yml}

@@ -1,7 +1,8 @@
-name: regex-demo
-description:
+name: regex
+description: successful path
 tags:
 initialize:
+  outputs: ['yaml']
   plugins:
     regex:
       method: Regex

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

@@ -0,0 +1,28 @@
+name: sci
+description: failure with `config.sci.functional-unit` value being number
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    sci:
+      kind: plugin
+      method: Sci
+      path: "@grnsft/if-plugins"
+      # global-config:
+      #   functional-unit-time: 1 minute
+tree:
+  children:
+    child:
+      pipeline:
+        - 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
+          duration: 3600
+          energy: 5
+          carbon-operational: 5
+          carbon-embodied: 0.02
+          requests: 100

package/{examples/manifests/sci.yml → manifests/plugins/sci/success.yml}

@@ -1,7 +1,8 @@
-name: sci-demo
-description: example invoking sci model
+name: sci
+description: successful path
 tags:
 initialize:
+  outputs: ['yaml']
   plugins:
     sci:
       kind: plugin

package/manifests/plugins/sci-m/failure-invalid-default-emission-value.yml

@@ -0,0 +1,24 @@
+name: sci-m
+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"
+tree:
+  children:
+    child:
+      pipeline:
+        - sci-m # duration & config -> embodied
+      defaults:
+        device/emissions-embodied: 'fail' # 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

package/{examples/manifests/sci-m.yml → manifests/plugins/sci-m/success.yml}

@@ -1,7 +1,8 @@
 name: sci-m
-description: simple demo invoking sci-m
+description: successful path
 tags:
 initialize:
+  outputs: ['yaml']
   plugins:
     "sci-m": # a model that calculates m from te, tir, el, rr and rtor
       method: SciM

package/manifests/plugins/shell/failure-invalid-command.yml

@@ -0,0 +1,21 @@
+name: shell
+description: falure with `global-config.command` being number instead od string
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    shell:
+      method: Shell
+      path: "@grnsft/if-plugins"
+      global-config:
+        command: 1000
+tree:
+  children:
+    child:
+      pipeline:
+        - shell
+      inputs:
+        - timestamp: "2023-11-02T10:35:31.820Z"
+          duration: 3600
+          cpu/energy: 0.002
+          memory/energy: 0.000005

package/{examples/manifests/shell.yml → manifests/plugins/shell/success.yml}

@@ -1,7 +1,8 @@
-name: shell-demo
-description: example impl invoking shell model
+name: shell
+description: successful path
 tags:
 initialize:
+  outputs: ['yaml']
   plugins:
     shell:
       method: Shell

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

@@ -0,0 +1,24 @@
+name: sum
+description: failure with `inputs[0]` misses one of `global-config.input-parameters`
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    sum:
+      method: Sum
+      path: "@grnsft/if-plugins"
+      global-config:
+        input-parameters: ["cpu/energy", "network/energy"]
+        output-parameter: "energy"
+tree:
+  children:
+    child:
+      pipeline:
+        - sum
+      config:
+        sum:
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu: 0.001
+          network/energy: 0.001

package/{examples/manifests/sum.yml → manifests/plugins/sum/success.yml}

@@ -1,7 +1,8 @@
-name: sci-e-demo
-description:
+name: sum
+description: successful path
 tags:
 initialize:
+  outputs: ['yaml']
   plugins:
     sum:
       method: Sum

package/manifests/plugins/tdp-finder/failure-missing-input-param.yml

@@ -0,0 +1,18 @@
+name: tdp-finder
+description: failure with `inputs` missing `physical-processor` param
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    tdp-finder: # a model that returns an embodied value given the sci embodied attribution equation.
+      method: TdpFinder
+      path: "@grnsft/if-plugins"
+tree:
+  children:
+    child:
+      pipeline:
+        - tdp-finder
+      config:
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 300

package/{examples/manifests/tdp-finder.yml → manifests/plugins/tdp-finder/success.yml}

@@ -1,7 +1,8 @@
 name: tdp-finder
-description: demo
+description: successful path
 tags:
 initialize:
+  outputs: ['yaml']
   plugins:
     tdp-finder: # a model that returns an embodied value given the sci embodied attribution equation.
       method: TdpFinder

package/manifests/plugins/time-sync/failure-config-start-later-end.yml

@@ -0,0 +1,34 @@
+name: time-sync
+description: failure with `global-config.start-time` being later than `global-config.end-time`
+tags:
+initialize:
+  output:
+    - yaml
+  plugins:
+    'time-sync':
+      method: TimeSync
+      path: "builtin"
+      global-config: 
+        start-time: '2023-12-12T00:01:00.000Z'
+        end-time: '2023-12-12T00:00:00.000Z'
+        interval: 5
+        allow-padding: true
+tree:
+  children:
+    child:
+      pipeline:
+        - time-sync
+      config:
+      inputs:
+        - timestamp: '2023-12-12T00:00:00.000Z'
+          duration: 1
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:01.000Z'
+          duration: 5
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:06.000Z'
+          duration: 7
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:13.000Z'
+          duration: 30
+          energy-cpu: 0.001

package/{examples/manifests/time-sync.yml → manifests/plugins/time-sync/success.yml}

@@ -1,7 +1,9 @@
-name: time-sync-demo
-description:
+name: time-sync
+description: successful path
 tags:
 initialize:
+  output:
+    - yaml
   plugins:
     'time-sync':
       method: TimeSync