Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme for cloud metadata plugin #67

Merged
merged 2 commits into from
Apr 4, 2024
Merged

Update readme for cloud metadata plugin #67

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6f4979
fix(lib): update readme for cloud metadata plugin
jmcook1186 Apr 3, 2024
b950e95
Update src/lib/cloud-metadata/README.md
jmcook1186 Apr 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions src/lib/cloud-metadata/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,32 @@ Not Needed

### Inputs

- `timestamp`: ISO 8061 string,
- `duration`: number of seconds the observation spans,
- `cloud/vendor`: the cloud platform provider, e.g. `aws`
- `cloud/instance-type`: the name of the specific instance being used, e.g. `m5n.large`

## Returns

An array containing:

- `cloud/instance-type`: echo input `instance-type`
- `cloud/vendor`: echo input `vendor`
- `physical-processor`: physical processor used in the given instance

- `timestamp`: "2023-07-06T00:01"
- `duration`: 10
- `cloud/vendor`: the name of the cloud vendor as a string, options are "azure", "gcp" or "aws"
- `cloud/instance-type`: name of the instance type as a string, e.g. "m5n.large"
- `vcpus-allocated`: number of vCPUs allocated to this instance
- `vcpus-total`: total number of vCPUs available to this instance
- `memory-available`: total memory available on this instance, in GB,
- `physical-processor`: name of the physical processor used by this instance as a string, e.g. "Intel® Xeon® Platinum 8259CL" (note some instances return multiple possible processors separated by commas)
- `cpu/thermal-design-power`: the thermal design power of the given processor (selects the first in the list of multiple are returned)


## IF Implementation

IF implements this plugin using data from Cloud Carbon Footprint. This allows determination of cpu for type of instance in a cloud and can be invoked as part of a plugin pipeline defined in a `manifest`.

Cloud Metadata currently implements only for 'AWS' and 'Azure'.
Note that "gcp" data are not yet available in our implementation.

## Usage

Expand Down Expand Up @@ -95,6 +103,8 @@ name: cloud-metadata
description: example manifest invoking Cloud Metadata plugin
tags:
initialize:
outputs:
- yaml
plugins:
cloud-metadata:
method: CloudMetadata
Expand Down Expand Up @@ -128,7 +138,7 @@ You can run this example `manifest` by saving it as `./examples/manifests/test/c
```sh
npm i -g @grnsft/if
npm i -g @grnsft/if-plugins
ie --manifest ./examples/manifests/test/cim.yml --output ./examples/outputs/cim.yml
ie --manifest ./examples/manifests/test/cloud-metadata.yml --output ./examples/outputs/cloud-metadata
```

The results will be saved to a new `yaml` file in `./examples/outputs`.
Loading