Add carbon emissions admin configuration options #16307
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Server location can be set as a valid ISO 3166 code. This is used to determine the carbon intensity based off of the galaxy instance server location - A non-default power usage effectiveness value can be set - Carbon emissions reporting can be toggled
- Add `geographical_server_location_code`, `geographical_server_location_name` and `carbon_intensity` flags. - Alphabetically sort the list of config flags in galaxy init file. - Add logic to set `geographical_server_location_name` and `carbon_intensity` based off of `geographical_server_location_code`.
…values - Simplify the component API by making its consumers pass all necessary props
ElectronicBlueberry
approved these changes
Jul 6, 2023
davelopez
reviewed
Jul 6, 2023
…ions flags - `carbon_intensity` and `geographical_server_location_name` are automatically computed on startup and are never set by an admin. So they don't need to be in the config at all.
|
Thanks for the comments, @davelopez! I've addressed points you've mentioned :) |
|
Thanks a lot @Renni771! Awesome work |
|
This PR was merged without a "kind/" label, please correct. |
4 tasks
mvdbeek
reviewed
Dec 11, 2023
| @@ -34,6 +34,7 @@ | |||
|
|
|||
| import yaml | |||
|
|
|||
| from galaxy.carbon_emissions import get_carbon_intensity_entry | |||
There was a problem hiding this comment.
This is breaking the config module
There was a problem hiding this comment.
Is this still causing an issue and, if so, how exactly is it breaking the config module?
There was a problem hiding this comment.
it is, the config package can't import from carbon_emissions.
There was a problem hiding this comment.
Work on a fix is underway in #17159
There was a problem hiding this comment.
Thanks for the update!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #15046. This feature branch adds admin config parameters and admin documentation for carbon emissions reporting. The following admin flags were added:
geographical_server_location_codean ISO 3166 code specifying the geographical location of the galaxy instance.power_usage_effectivenessthe PUE value to use in carbon emissions calculations.carbon_emission_estimatesa feature toggle flag so reporting can be completely disabled when needed.The following flags are automatically set based on the value of
geographical_server_location_code:geographical_server_location_namethe actual name corresponding togeographical_server_location_code.carbon_intensitythe carbon intensity value corresponding to the configured location.The location is picked from a list of supported locations in ISO 3166 format which is documented over here. This standard allows users to specify both countries and regions within larger countries. If no location is set or the configured location is invalid or unsupported, the config logic defaults to global values. The UI is dynamic and will display the location name, carbon intensity and PUE values. If global values are used, the UI reflects this too. Here's what the UI looks like:
Here's a list of further additions:
doc/source/admin/carbon_emissions.md.geographical_server_location_codeis invalid or unsupported, the global default values are used and the event is logged.What else changed:
lib/galaxy/config/__init__.pywere refactored to be sorted alphabetically.How to test the changes?
(Select all options that apply)
galaxy.yml.samplefile and assess the behaviour on the client.License