npm - @grnsft/if - Versions diffs - 1.0.1 → 1.1.0-beta.0 - Mend

@grnsft/if 1.0.1 → 1.1.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (319) hide show

package/manifests/examples/bugs/pipeline-ordering-error.yml ADDED Viewed

@@ -0,0 +1,91 @@
+name: pipeline-ordering-error
+description: a negative test case that fails because sci-o is invoked too early in the pipeline (before its inputs are generated)
+tags:
+initialize:
+  plugins:
+    "interpolate":
+      method: Interpolation
+      path: 'builtin'
+      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'
+    "cpu-factor-to-wattage":
+      method: Multiply
+      path: builtin
+      config:
+        input-parameters: ["cpu-factor", "cpu/thermal-design-power"]
+        output-parameter: "cpu-wattage"
+    "wattage-times-duration":
+      method: Multiply
+      path: builtin
+      config:
+        input-parameters: ["cpu-wattage", "duration"]
+        output-parameter: "cpu-wattage-times-duration"
+    "wattage-to-energy-kwh":
+      method: Divide
+      path: "builtin"
+      config:
+        numerator: cpu-wattage-times-duration
+        denominator: 3600000
+        output: cpu-energy-raw
+    "calculate-vcpu-ratio":
+      method: Divide
+      path: "builtin"
+      config:
+        numerator: vcpus-total
+        denominator: vcpus-allocated
+        output: vcpu-ratio
+    "correct-cpu-energy-for-vcpu-ratio":
+      method: Divide
+      path: "builtin"
+      config:
+        numerator: cpu-energy-raw
+        denominator: vcpu-ratio
+        output: cpu-energy-kwh
+tree:
+  children:
+    child-1:
+      pipeline:
+        compute:
+          - interpolate
+          - correct-cpu-energy-for-vcpu-ratio
+          - calculate-vcpu-ratio
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+      defaults:
+        cpu/thermal-design-power: 100
+        grid/carbon-intensity: 800
+        device/emissions-embodied: 1533.120 # gCO2eq
+        time-reserved: 3600 # 1hr in seconds
+        device/expected-lifespan: 94608000 # 3 years in seconds
+        vcpus-allocated: 1
+        vcpus-total: 8
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          duration: 1
+          cpu/utilization: 50
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 20
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 15
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15
+          network/energy: 0.000001

package/manifests/examples/builtins/divide/success-denominator-equal-zero.yml ADDED Viewed

@@ -0,0 +1,36 @@
+name: divide
+description: denominator is invalid, denominator is
+tags:
+initialize:
+  plugins:
+    cloud-metadata:
+      path: builtin
+      method: CSVLookup
+      config:
+        filepath: >-
+          https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/cloud-metdata-aws-instances.csv
+        query:
+          instance-class: cloud/instance-type
+        output: ["cpu-cores-utilized", "vcpus-allocated"]
+    divide:
+      method: Divide
+      path: "builtin"
+      config:
+        numerator: vcpus-allocated
+        denominator: 0
+        output: cpu/number-cores
+tree:
+  children:
+    child:
+      pipeline:
+        compute:
+          - cloud-metadata
+          - 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/examples/builtins/mock-observations/failure-invalid-config-cpu-range.yml CHANGED Viewed

@@ -4,7 +4,6 @@ tags:
 initialize:
   plugins:
     mock-observations:
-      kind: plugin
       method: MockObservations
       path: "builtin"
       config:

package/manifests/examples/builtins/mock-observations/failure-invalid-memory-utilization-range.yml CHANGED Viewed

@@ -4,7 +4,6 @@ tags:
 initialize:
   plugins:
     mock-observations:
-      kind: plugin
       method: MockObservations
       path: "builtin"
       config:

package/manifests/examples/builtins/mock-observations/failure-missing-timestamp-from-param.yml CHANGED Viewed

@@ -4,7 +4,6 @@ tags:
 initialize:
   plugins:
     mock-observations:
-      kind: plugin
       method: MockObservations
       path: "builtin"
       config:

package/manifests/examples/builtins/mock-observations/success.yml CHANGED Viewed

@@ -4,7 +4,6 @@ tags:
 initialize:
   plugins:
     mock-observations:
-      kind: plugin
       method: MockObservations
       path: "builtin"
       config:

package/manifests/examples/builtins/sci/failure-invalid-config-value.yml CHANGED Viewed

@@ -4,7 +4,6 @@ tags:
 initialize:
   plugins:
     sci:
-      kind: plugin
       method: Sci
       path: "builtin"
       # config:

package/manifests/examples/builtins/sci/failure-missing-input-param.yml CHANGED Viewed

@@ -5,7 +5,6 @@ initialize:
   #
   plugins:
     sci:
-      kind: plugin
       method: Sci
       path: "builtin"
       config:

package/manifests/examples/builtins/sci/success.yml CHANGED Viewed

@@ -4,7 +4,6 @@ tags:
 initialize:
   plugins:
     sci:
-      kind: plugin
       method: Sci
       path: "builtin"
       config:

package/manifests/examples/builtins/sci-embodied/failure-invalid-default-emission-value.yml ADDED Viewed

@@ -0,0 +1,22 @@
+name: sci-embodied
+description: failure with `vCPUs` being string instead of number
+tags:
+initialize:
+  plugins:
+    "sci-embodied": # a model that calculates m from te, tir, el, rr and rtor
+      method: SciEmbodied
+      path: "builtin"
+tree:
+  children:
+    child:
+      pipeline:
+        compute:
+          - sci-embodied # duration & config -> embodied
+      defaults:
+        vCPUs: fail
+        time-reserved: 3600 # 1hr in seconds
+        resources-reserved: 1
+        resources-total: 8
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600

package/manifests/examples/builtins/time-sync/failure-missing-config.yml CHANGED Viewed

@@ -2,8 +2,6 @@ name: time-sync
 description: missing config
 tags:
 initialize:
-  output:
-    - yaml
   plugins:
     'time-sync':
       method: TimeSync

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

@@ -2,8 +2,6 @@ name: time-sync
 description: successful path
 tags:
 initialize:
-  output:
-    - yaml
   plugins:
     'time-sync':
       method: TimeSync

package/manifests/examples/features/aggregate-failure-invalid-metrics.yml ADDED Viewed

@@ -0,0 +1,50 @@
+name: Aggregation
+description: Fails with invalid metric.
+aggregation:
+  metrics:
+    - 'test'
+  type: 'both'
+initialize:
+  plugins:
+    cloud-metadata:
+      path: builtin
+      method: CSVLookup
+      config:
+        filepath: >-
+          https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/cloud-metdata-aws-instances.csv
+        query:
+          instance-class: cloud/instance-type
+        output: ['cpu-cores-utilized', 'vcpus-allocated']
+tree:
+  children:
+    application:
+      pipeline:
+        compute:
+          - cloud-metadata
+      children:
+        uk-west:
+          children:
+            server-1:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 89
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 59
+            server-2:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 24
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 27

package/manifests/examples/features/aggregate-failure-missing-metric-in-inputs.yml ADDED Viewed

@@ -0,0 +1,50 @@
+name: Aggregation
+description: Fails with missing metric in inputs.
+aggregation:
+  metrics:
+    - 'cpu/utilization'
+  type: 'both'
+initialize:
+  plugins:
+    cloud-metadata:
+      path: builtin
+      method: CSVLookup
+      config:
+        filepath: >-
+          https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/cloud-metdata-aws-instances.csv
+        query:
+          instance-class: cloud/instance-type
+        output: ['cpu-cores-utilized', 'vcpus-allocated']
+tree:
+  children:
+    application:
+      pipeline:
+        compute:
+          - cloud-metadata
+      children:
+        uk-west:
+          children:
+            server-1:
+              inputs:
+                - timestamp: '2024-01-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 89
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 59
+            server-2:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                #  cpu/utilization: 110
+                - timestamp: '2024-02-26 00:15:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 27

package/manifests/examples/features/aggregate-horizontal.yml ADDED Viewed

@@ -0,0 +1,58 @@
+name: Aggregation
+description: Apply `horizontal` aggregation
+aggregation:
+  metrics:
+    - 'cpu/utilization'
+  type: 'horizontal'
+initialize:
+  plugins:
+    cloud-metadata:
+      path: builtin
+      method: CSVLookup
+      config:
+        filepath: >-
+          https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/cloud-metdata-aws-instances.csv
+        query:
+          instance-class: cloud/instance-type
+        output: ['cpu-cores-utilized', 'vcpus-allocated']
+      parameter-metadata:
+        inputs:
+          cpu/utilization:
+            unit: percentage
+            description: refers to CPU utilization.
+            aggregation-method:
+              time: avg
+              component: avg
+tree:
+  children:
+    application:
+      pipeline:
+        compute:
+          - cloud-metadata
+      children:
+        uk-west:
+          children:
+            server-1:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 89
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 59
+            server-2:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 24
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 27

package/manifests/examples/features/aggregate-vertical.yml ADDED Viewed

@@ -0,0 +1,58 @@
+name: Aggregation
+description: Apply `vertical` aggregation
+aggregation:
+  metrics:
+    - 'cpu/utilization'
+  type: 'vertical'
+initialize:
+  plugins:
+    cloud-metadata:
+      path: builtin
+      method: CSVLookup
+      config:
+        filepath: >-
+          https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/cloud-metdata-aws-instances.csv
+        query:
+          instance-class: cloud/instance-type
+        output: ['cpu-cores-utilized', 'vcpus-allocated']
+      parameter-metadata:
+        inputs:
+          cpu/utilization:
+            unit: percentage
+            description: refers to CPU utilization.
+            aggregation-method:
+              time: avg
+              component: avg
+tree:
+  children:
+    application:
+      pipeline:
+        compute:
+          - cloud-metadata
+      children:
+        uk-west:
+          children:
+            server-1:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 89
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 59
+            server-2:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 24
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 27

package/manifests/examples/features/aggregate.yml ADDED Viewed

@@ -0,0 +1,58 @@
+name: Aggregation
+description: Apply both `horizontal` and `vertical` aggregations
+aggregation:
+  metrics:
+    - 'cpu/utilization'
+  type: 'both'
+initialize:
+  plugins:
+    cloud-metadata:
+      path: builtin
+      method: CSVLookup
+      config:
+        filepath: >-
+          https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/cloud-metdata-aws-instances.csv
+        query:
+          instance-class: cloud/instance-type
+        output: ['cpu-cores-utilized', 'vcpus-allocated']
+      parameter-metadata:
+        inputs:
+          cpu/utilization:
+            unit: percentage
+            description: refers to CPU utilization.
+            aggregation-method:
+              time: avg
+              component: avg
+tree:
+  children:
+    application:
+      pipeline:
+        compute:
+          - cloud-metadata
+      children:
+        uk-west:
+          children:
+            server-1:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 89
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 59
+            server-2:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 24
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 27

package/manifests/examples/pipelines/cloud-metadata-divide.yml ADDED Viewed

@@ -0,0 +1,36 @@
+name: divide-demo
+description:
+tags:
+initialize:
+  plugins:
+    cloud-metadata:
+      path: builtin
+      method: CSVLookup
+      config:
+        filepath: >-
+          https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/cloud-metdata-aws-instances.csv
+        query:
+          instance-class: cloud/instance-type
+        output: ['cpu-cores-utilized', 'vcpus-allocated']
+    divide:
+      method: Divide
+      path: "builtin"
+      config:
+        numerator: vcpus-allocated
+        denominator: 2
+        output: cpu/number-cores
+tree:
+  children:
+    child:
+      pipeline:
+        compute:
+          - cloud-metadata
+          - 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/examples/pipelines/pipeline-with-mocks.yml CHANGED Viewed

@@ -8,7 +8,6 @@ aggregation:
 initialize:
   plugins:
     mock-observations:
-      kind: plugin
       method: MockObservations
       path: "builtin"
       config:

package/manifests/examples/pipelines/scenario-5.yml CHANGED Viewed

@@ -4,7 +4,6 @@ tags:
 initialize:
   plugins:
     mock-observations:
-      kind: plugin
       method: MockObservations
       path: "builtin"
       config:

package/manifests/outputs/bugs/mock-observations-failure-duration-is-zero.yaml CHANGED Viewed

@@ -4,7 +4,6 @@ tags: null
 initialize:
   plugins:
     mock-observations:
-      kind: plugin
       method: MockObservations
       path: builtin
       config:

package/manifests/outputs/builtins/mock-observations/failure-invalid-config-cpu-range.yaml CHANGED Viewed

@@ -6,7 +6,6 @@ tags: null
 initialize:
   plugins:
     mock-observations:
-      kind: plugin
       method: MockObservations
       path: builtin
       config:

package/manifests/outputs/builtins/mock-observations/failure-invalid-memory-utilization-range.yaml CHANGED Viewed

@@ -4,7 +4,6 @@ tags: null
 initialize:
   plugins:
     mock-observations:
-      kind: plugin
       method: MockObservations
       path: builtin
       config:

package/manifests/outputs/builtins/mock-observations/failure-missing-timestamp-from-param.yaml CHANGED Viewed

@@ -4,7 +4,6 @@ tags: null
 initialize:
   plugins:
     mock-observations:
-      kind: plugin
       method: MockObservations
       path: builtin
       config:

package/manifests/outputs/builtins/sci/failure-invalid-config-value.yaml CHANGED Viewed

@@ -4,7 +4,6 @@ tags: null
 initialize:
   plugins:
     sci:
-      kind: plugin
       method: Sci
       path: builtin
 execution:

package/manifests/outputs/builtins/sci/failure-missing-input-param.yaml CHANGED Viewed

@@ -4,7 +4,6 @@ tags: null
 initialize:
   plugins:
     sci:
-      kind: plugin
       method: Sci
       path: builtin
       config:

package/manifests/outputs/builtins/time-sync/failure-missing-config.yaml CHANGED Viewed

@@ -2,8 +2,6 @@ name: time-sync
 description: missing config
 tags: null
 initialize:
-  output:
-    - yaml
   plugins:
     time-sync:
       method: TimeSync