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.

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

update to the README: description, images and roadmap #120

Merged
merged 3 commits into from
Sep 18, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
43 changes: 35 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,33 @@

The CNCF Green Reviews Working Group (WG) is an open-source, community-led project that is part of the [CNCF Environmental Sustainability Technical Advisory Group (TAG ENV)](https://github.com/cncf/tag-env-sustainability).

The aim of the Green Reviews WG is to set up infrastructure to measure the sustainability footprint of [CNCF Projects](https://www.cncf.io/projects).
The aim of the Green Reviews WG is to set up infrastructure to measure the sustainability footprint of [CNCF Projects](https://www.cncf.io/projects).

Measuring the sustainability footprint of software is not an easy task. Our vision is that the WG will compute the sustainability data for every release of a CNCF project that requests a sustainability footprint assessment. To achieve such a vision, our goal is to develop a workflow that can integrate well with the existing software lifecycle of other CNCF projects.

A good way to practically understand the first version of the workflow that the WG is designing is to take a look at the following architecture diagram:

![green reviews workflow](./docs/images/workflow-vision.png)

The WG’s workflow vision is that every release requesting a sustainability footprint assessment will trigger a Github Action specified in the Green Reviews repo that will start a benchmarking pipeline. The pipeline’s job is to:

1. Spin up the Equinix Metal resources
2. Install Kubernetes and all the needed observability tools
AntonioDiTuri marked this conversation as resolved.
Show resolved Hide resolved
3. Install the software that will be assessed
4. Execute the necessary benchmark test cases
5. Gather sustainability-related metrics
6. Publish sustainability metrics

If you are curious and want to discover more a good:
nikimanoledaki marked this conversation as resolved.
Show resolved Hide resolved
- You can read the deep dive [article](https://tag-env-sustainability.cncf.io/blog/2024-green-reviews-working-group-measuring-sustainability/)
- You can watch the Kubecon EU '24 [Maintainer Talk](https://www.youtube.com/watch?v=UFa8hxOGKwQ)

## Releases

| Release | Date | Notes
|---|---|---|
| 0.1.0 | 14.05.24 | [Release Notes](https://github.com/cncf-tags/green-reviews-tooling/releases/tag/0.1.0)
| 0.2.0 | Planned before Kubecon NA '24 | [Tracking issue](https://github.com/cncf-tags/green-reviews-tooling/issues/83)

## Community

Expand Down Expand Up @@ -31,11 +57,12 @@ The roadmap contains some of the short and long-term goals of the Green Reviews
| Timeline | Goals |
|---|---|
| Q4 '23 / Before & After KubeCon NA | Announce Green Reviews WG during KubeCon NA Keynotes |
| | Draft of the implementation for the sustainability footprint measurement workflow (tracking issue) |
| | Cluster up and running on Equinix (tracking issue) |
| | Draft of the implementation for the sustainability footprint measurement workflow (tracking issue) |
nikimanoledaki marked this conversation as resolved.
Show resolved Hide resolved
| | Cluster up and running on Equinix (tracking issue) |
nikimanoledaki marked this conversation as resolved.
Show resolved Hide resolved
| Q1 '24 / Before KubeCon EU | Measure the cloud native sustainability footprint of Falco [milestone](https://github.com/cncf-tags/green-reviews-tooling/milestone/1) |
| | Present architecture as part of the maintainer track at KubeCon EU |
| Q2 '24 / After KubeCon EU | Automate cloud native sustainability footprint measuring of the Falco project (alpha version) |
|| First stats published publicly on devstats.cncf.io |
|| Identify the next CNCF Project |
| Q3 '24 / Before KubeCon NA | Reproduce workflow with next CNCF Project |
| | Present architecture as part of the maintainer track at KubeCon EU |
| Q2 - Q3 '24 / Before KubeCon NA | Automate cloud native sustainability footprint measuring of the Falco project (alpha version) - [Tracking issue](https://github.com/cncf-tags/green-reviews-tooling/issues/83) |
| Q4 '24 / After KubeCon NA | TBD: below possible ideas |
| | Experiment with a different Energy metrics provider like [Scaphandre](https://github.com/hubblo-org/scaphandre) and compare results
| | Identify new project |
| | Reproduce workflow with next CNCF Project |
Binary file added docs/images/workflow-vision.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.