@grnsft/if 0.5.0-beta.0 → 0.5.0

package/manifests/bugs/azure-importer-ignoring-defaults.yml

@@ -1,64 +0,0 @@
-name: pipeline-demo
-description: https://github.com/Green-Software-Foundation/if-unofficial-plugins/issues/81
-tags:
-# aggregation:
-# metrics:
-# - "carbon"
-# - "energy"
-#type: "both"
-initialize:
-  outputs:
-    - yaml
-    # - csv
-  plugins:
-    "azure-importer":
-      method: AzureImporter
-      path: "@grnsft/if-unofficial-plugins"
-    "try-defaults-1":
-      path: "builtin"
-      method: Coefficient
-      global-config:
-        input-parameter: grid/carbon-intensity
-        coefficient: 0.1
-        output-parameter: grid/carbon-intensity
-    "try-defaults-2":
-      path: "builtin"
-      method: Coefficient
-      global-config:
-        input-parameter: network/energy
-        coefficient: 1000
-        output-parameter: network/energy
-    "operational-carbon":
-      method: Multiply
-      path: builtin
-      global-config:
-        input-parameters: ["energy", "grid/carbon-intensity"]
-        output-parameter: "carbon-operational"
-    "group-by":
-      path: "builtin"
-      method: GroupBy
-tree:
-  children:
-    web-front: # name this according to the sub-system, e.g. portal, APIs/backend, DB
-      pipeline:
-        - azure-importer
-        #- try-defaults-1
-        #- try-defaults-2
-        - sci-o
-      config:
-        group-by:
-          group:
-            - instance-type
-        azure-importer:
-          azure-observation-window: 60 min
-          azure-observation-aggregation: "average"
-          azure-subscription-id: 30b6e171-af2c-4fe6-b00d-d4c70f6291fe
-          azure-resource-group: gcf-app_group
-          azure-vm-name: gcf-app
-      defaults:
-        grid/carbon-intensity: 800 # adjust for SG grid
-        network/energy: 0.001 # review for naming accuracy
-      inputs:
-        - timestamp: "2024-04-04T08:00:00.001Z"
-          duration: 3600
-          energy: 100

package/manifests/bugs/azure-importer-incorrect-calculation.yml

@@ -1,59 +0,0 @@
-name: pipeline-demo
-description: https://github.com/Green-Software-Foundation/if-unofficial-plugins/issues/81
-tags: null
-initialize:
-  plugins:
-    azure-importer:
-      path: '@grnsft/if-unofficial-plugins'
-      method: AzureImporter
-    try-defaults-1:
-      path: 'builtin'
-      method: Coefficient
-      global-config:
-        input-parameter: grid/carbon-intensity
-        coefficient: 0.1
-        output-parameter: grid/carbon-intensity
-    try-defaults-2:
-      path: 'builtin'
-      method: Coefficient
-      global-config:
-        input-parameter: network/energy
-        coefficient: 1000
-        output-parameter: network/energy
-    "operational-carbon":
-      method: Multiply
-      path: builtin
-      global-config:
-        input-parameters: ["energy", "grid/carbon-intensity"]
-        output-parameter: "carbon-operational"
-    group-by:
-      path: builtin
-      method: GroupBy
-  outputs:
-    - yaml
-if-version: v0.3.2
-tree:
-  children:
-    web-front:
-      pipeline:
-        - azure-importer
-        - try-defaults-1
-        - try-defaults-2
-      config:
-        group-by:
-          group:
-            - instance-type
-        azure-importer:
-          azure-observation-window: 60 min
-          azure-observation-aggregation: average
-          azure-subscription-id: 30b6e171-af2c-4fe6-b00d-d4c70f6291fe
-          azure-resource-group: gcf-app_group
-          azure-vm-name: gcf-app
-      defaults:
-        grid/carbon-intensity: 800
-        network/energy: 0.001
-      inputs:
-        - timestamp: '2024-04-04T08:00:00.001Z'
-          duration: 3600
-          energy: 100
-   

package/manifests/bugs/initialize-error-no-config.yml

@@ -1,26 +0,0 @@
-name: initialize-error-no-config
-description: a negative test case that fails due to plugin initialization missing some required config 
-tags:
-initialize:
-  plugins:
-    "interpolate":
-      method: Interpolation
-      path: 'builtin'
-      global-config:
-tree:
-  children:
-    child-0:
-      defaults:
-        cpu/thermal-design-power: 100
-      pipeline:
-        - interpolate
-      inputs:
-        - timestamp: 2023-07-06T00:00
-          duration: 1
-          cpu/utilization: 20
-        - timestamp: 2023-07-06T00:01
-          duration: 1
-          cpu/utilization: 80
-        - timestamp: 2023-07-06T00:02
-          duration: 1
-          cpu/utilization: 20

package/manifests/bugs/initialize-error-no-path.yml

@@ -1,32 +0,0 @@
-name: initialize-error-no-path
-description: a negative test case that fails because the path is mising in a plugin initialization
-tags:
-initialize:
-  plugins:
-    "interpolate":
-      method: Interpolation
-      path:
-      global-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'
-  # outputs: ['yaml']
-tree:
-  children:
-    child-0:
-      defaults:
-        cpu/thermal-design-power: 100
-      pipeline:
-        - interpolate
-      inputs:
-        - timestamp: 2023-07-06T00:00
-          duration: 1
-          cpu/utilization: 20
-        - timestamp: 2023-07-06T00:01
-          duration: 1
-          cpu/utilization: 80
-        - timestamp: 2023-07-06T00:02
-          duration: 1
-          cpu/utilization: 20

package/manifests/bugs/initialize-error-no-plugins.yml

@@ -1,23 +0,0 @@
-name: initialize-error-no-path
-description: a negative test case that fails becuase no plugins are included in the initialize block
-tags:
-initialize:
-  plugins:
-  outputs: ['yaml']
-tree:
-  children:
-    child-0:
-      defaults:
-        cpu/thermal-design-power: 100
-      pipeline:
-        - teads-curve
-      inputs:
-        - timestamp: 2023-07-06T00:00
-          duration: 1
-          cpu/utilization: 20
-        - timestamp: 2023-07-06T00:01
-          duration: 1
-          cpu/utilization: 80
-        - timestamp: 2023-07-06T00:02
-          duration: 1
-          cpu/utilization: 20

package/manifests/bugs/input-error-missing-duration.yml

@@ -1,25 +0,0 @@
-name: input-error-missing-duration
-description: a negative test case that fails due to the required `duration` field being omitted from input data
-tags:
-initialize:
-  plugins:
-    "interpolate":
-      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: 'cpu-factor'
-  # outputs: ['yaml']
-tree:
-  children:
-    child-0:
-      defaults:
-        cpu/thermal-design-power: 100
-      pipeline:
-        - interpolate
-      inputs:
-        - timestamp: 2023-07-06T00:00
-          cpu/utilization: 20

package/manifests/bugs/mock-observations-failure-duration-is-zero.yml

@@ -1,34 +0,0 @@
-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: 0
-        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/bugs/pipeline-error-naming-mismatch.yml

@@ -1,32 +0,0 @@
-name: pipeline-error-naming-mismatch
-description: a negative test case that fails due to the plugin name in the pipeline not matching the name given in initialize 
-tags:
-initialize:
-  plugins:
-    "interpolate":
-      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: 'cpu-factor'
-  outputs: ['yaml']
-tree:
-  children:
-    child-0:
-      defaults:
-        cpu/thermal-design-power: 100
-      pipeline:
-        - wrong-name
-      inputs:
-        - timestamp: 2023-07-06T00:00
-          duration: 1
-          cpu/utilization: 20
-        - timestamp: 2023-07-06T00:01
-          duration: 1
-          cpu/utilization: 80
-        - timestamp: 2023-07-06T00:02
-          duration: 1
-          cpu/utilization: 20

package/manifests/bugs/pipeline-error-uninitialized-plugin.yml

@@ -1,33 +0,0 @@
-name: pipeline-uninitialized-plugin-error
-description: a negative test case that fails due to an uninitialized plugin being invoked in a pipeline
-tags:
-initialize:
- # outputs: ['yaml']
-  plugins:
-    "interpolate":
-      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: 'cpu-factor'
-tree:
-  children:
-    child-0:
-      defaults:
-        cpu/thermal-design-power: 100
-      pipeline:
-        - interpolate
-        - multiply
-      inputs:
-        - timestamp: 2023-07-06T00:00
-          duration: 1
-          cpu/utilization: 20
-        - timestamp: 2023-07-06T00:01
-          duration: 1
-          cpu/utilization: 80
-        - timestamp: 2023-07-06T00:02
-          duration: 1
-          cpu/utilization: 20

package/manifests/bugs/pipeline-ordering-error.yml

@@ -1,91 +0,0 @@
-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'
-      global-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
-      global-config:
-        input-parameters: ["cpu-factor", "cpu/thermal-design-power"]
-        output-parameter: "cpu-wattage"
-    "wattage-times-duration":
-      method: Multiply
-      path: builtin
-      global-config:
-        input-parameters: ["cpu-wattage", "duration"]
-        output-parameter: "cpu-wattage-times-duration"
-    "wattage-to-energy-kwh":
-      method: Divide
-      path: "builtin"
-      global-config:
-        numerator: cpu-wattage-times-duration
-        denominator: 3600000
-        output: cpu-energy-raw
-    "calculate-vcpu-ratio":
-      method: Divide
-      path: "builtin"
-      global-config:
-        numerator: vcpus-total
-        denominator: vcpus-allocated
-        output: vcpu-ratio
-    "correct-cpu-energy-for-vcpu-ratio":
-      method: Divide
-      path: "builtin"
-      global-config:
-        numerator: cpu-energy-raw
-        denominator: vcpu-ratio
-        output: cpu-energy-kwh    
-tree:
-  children:
-    child-1:
-      pipeline:
-        - interpolate
-        - correct-cpu-energy-for-vcpu-ratio   
-        - calculate-vcpu-ratio
-        - cpu-factor-to-wattage
-        - wattage-times-duration
-        - wattage-to-energy-kwh
-      config:
-      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/bugs/sci-embodied-missing-resources-total.yml

@@ -1,23 +0,0 @@
-name: sci-embodied
-description: receiving incorrect error message when running sci-embodied without `resources-total` issue #716
-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

package/manifests/examples/copy.yaml

@@ -1,20 +0,0 @@
-name: copy-param
-description:
-tags:
-initialize:
-  plugins:
-    copy-param:
-      path: builtin
-      method: Copy
-      global-config:
-        keep-existing: true
-        from: original
-        to: copy
-tree:
-  children:
-    child-1:
-      pipeline:
-        - copy-param
-      inputs:
-        - timestamp: "2023-12-12T00:00:00.000Z"
-          original: 'hello'

package/manifests/examples/mock-cpu-util-to-carbon.yml

@@ -1,76 +0,0 @@
-name: mock-cpu-util-to-carbon
-description: a complete pipeline that starts with mocked CPU utilization data and outputs operational carbon in gCO2eq
-initialize:
-  #outputs: ['yaml']
-  plugins: 
-    group-by: 
-      path: 'builtin'
-      method: GroupBy   
-    operational-carbon:
-      path: 'builtin'
-      method: Multiply
-      global-config:
-        input-parameters: ['cpu/energy', 'grid/carbon-intensity']
-        output-parameter: 'carbon'       
-    watttime:
-      path: '@grnsft/if-unofficial-plugins'           
-      method: WattTimeGridEmissions    
-    teads-curve:
-      path: '@grnsft/if-unofficial-plugins'
-      method: TeadsCurve
-      global-config:
-        interpolation: spline  
-    cloud-metadata:
-      path: builtin
-      method: CSVLookup
-      global-config:
-        filepath: >-
-          https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/cloud-metdata-azure-instances.csv
-        query:
-          instance-class: cloud/instance-type
-        output: ['cpu-cores-utilized', 'vcpus-allocated']
-    mock-observations:
-      path: 'builtin'
-      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: westus3            
-        generators:
-          common:
-            cloud/vendor: azure
-          randint:
-            cpu/utilization:
-              min: 1
-              max: 99           
-    'time-sync':
-      method: TimeSync
-      path: "builtin"
-      global-config: 
-        start-time: '2024-03-05T00:00:00.000Z'
-        end-time: '2024-03-05T00:01:00.000Z'
-        interval: 5
-        allow-padding: true
-tree: 
-  pipeline:
-    - mock-observations
-    - group-by
-    - time-sync
-    - cloud-metadata
-    - watttime
-    - teads-curve
-    - operational-carbon
-  defaults:
-  config:
-    group-by:
-      group:
-        - cloud/region
-        - name
-  inputs: null

package/manifests/examples/region-metadata.yml

@@ -1,26 +0,0 @@
-name: csv-demo
-description:
-tags:
-initialize:
-  plugins:
-    cloud-region-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-region-metadata
-      inputs:
-        - timestamp: 2023-08-06T00:00
-          duration: 3600
-          cpu/energy: 0.001
-          instance-id: AMD A10-9700
-          cloud-provider: "Google Cloud"
-          cloud-region: "asia-east1"

package/manifests/examples/tdp-finder.yml

@@ -1,23 +0,0 @@
-name: csv-demo
-description:
-tags:
-initialize:
-  plugins:
-    tdp-finder:
-      method: CSVLookup
-      path: "builtin"
-      global-config:
-        filepath: https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/tdp-data-1.csv
-        query:
-          name: instance-id
-        output: "tdp"
-tree:
-  children:
-    child:
-      pipeline:
-        - tdp-finder
-      inputs:
-        - timestamp: 2023-08-06T00:00
-          duration: 3600
-          cpu/energy: 0.001
-          instance-id: "AMD A10-9700"

package/manifests/features/aggregate-failure-invalid-metrics.yml

@@ -1,49 +0,0 @@
-name: Aggregation
-description: Fails with invalid metric.
-aggregation:
-  metrics:
-    - 'test'
-  type: 'both'
-initialize:
-  plugins:
-    cloud-metadata:
-      path: builtin
-      method: CSVLookup
-      global-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:
-        - 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