endava / endava-gsf-impactframework-plugins

Endava Impact Framework Plugins

PLEASE NOTE: This repository contains three plugins developed by Endava for the Green Software Foundation's CarbonHack 24. The current structure, types and parameters may change in the future if and when the plugins are officially integrated with the IF plugin ecosystem.

All Endava plugins are released under the MIT licence - please see README.md and LICENCE files in each individual plugin directory for more details.

Before

Clone the repository

npm run install

How to run

npm link - at root level

npm link if-endava where you have your manifest file

The path of the plugins in the yml file would be if-endava (is the same as the name on the package.json) The methods used would be:

1. AwsImporter
2. ClimatiqCalculator
3. BoavistaStorage

This is an example where the code was commented and just to log the values inside each plugin As you can notice from the image, when we run npm link if-endava it will create a node_modules folder where our repository is added by the name if-endava this would be the path used in the yml file. The main file where you export the plugins will be the identifier for each plugin function used in the method key in the manifest.

endava-gsf-impactframework-plugins's Issues

Error getting EC2 instance data when trying aws-importer.yml example

Describe the bug
It seems that plugin is not correctly getting EC2 instance data. You execute the plugin with the aws-importer.yml configured as input.

To Reproduce
Steps to reproduce the behavior:

1. Clone repository (using node 18 right now)
2. run npm install
3. configure aws-importer.yml, only difference is EC2 instance info:

      global-config:
        aws-importer:
          tag: green-software
          location: us-east-1
          aws-services: ec2
          aws-observation: 60
        metric:
          cloudwatch-namespace: 'CloudwatchAgentMetrics'
          client-namespace: 'AWS/EC2'

5. configure .env file with AWS credenciales
6. run ie --manifest ./examples/manifests/aws-importer.yml --output ./examples/manifests/aws-importer-computed.yml in root folder of project
7. execution outputs:

error: The request must contain the parameter volumes
MissingParameter: The request must contain the parameter volumes

Expected behavior
Plugin should run and complete the aws-importer-computed.yml with information and data from the instance.

Screenshots

Additional context
We are just testing the plugin, don't know if it is 100% ready for end user usage. I don't know if this error is related to the plugin or related to AWS or Cloudwatch configuration.