Skip to content

Commit

Permalink
1.5 WattTime v3 Updates (#547)
Browse files Browse the repository at this point in the history
* doc initial set up using classic template and typescript - doc is currently copied into casdk-docs/docs to get live updates (copied and not moved so changes in main can be easily identified when rebasing once it all works)

* favicon

* reoganising first draft

* doc link fixes

* github pages pipelines to accomodate customisations

* Update WattTime registration link

Signed-off-by: Phil Huang <[email protected]>

* Create adopters.md

Signed-off-by: tkuramoto33 <[email protected]>

* Initial codespace branch and associated docs

* Add Vestas.

Signed-off-by: tkuramoto33 <[email protected]>

* Remove a hyphen for consistent appearance

Signed-off-by: tkuramoto33 <[email protected]>

* Create enablement.md

table of content


Signed-off-by: Rintaro Ikeda <[email protected]>

* link fix

* workflow update

* updated github action

* ensuring there is a yarn lock file

* removed working directory from setup node action

* trying to have the working directory at a higher level

* trying cache dependency path property

* dont break the build on broken links for now

* updated user

* removed user

* updated user to deploy pages

* draft of enablement.md

Signed-off-by: Rintaro Ikeda <[email protected]>

* Update containerization.md

Small typo ("arbon" => "Carbon")

Signed-off-by: Richard Jackson <[email protected]>

* github token permissions updated to ensure contents write

* workflows fixes

* Ensuring username was not needed

* Support location source setting in Helm chart

Signed-off-by: Yasumasa Suenaga <[email protected]>

* Update carbon-aware-cli.md

Fixes bugs with Linux scripts

Signed-off-by: JasonLuuk <[email protected]>

* Update overview.md

Change the net url inside the prerequisites, I think the sdk requires version 6.0 net instead of the latest 8.0, which can mislead users.

Signed-off-by: JasonLuuk <[email protected]>

* Update quickstart.md

Fix wrong links

Signed-off-by: JasonLuuk <[email protected]>

* verify azure function workflow not to trigger on casdk-docs changes only

* Link fixes (may be related to latest version now erroring)

* test doc file

* restoring username and email and removing the test file

* updated vs code extensions

* DCO Remediation Commit for Dan Benitah <[email protected]>

I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 44578f4
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 3ae9a00

Signed-off-by: Dan Benitah <[email protected]>

* Update the description

Signed-off-by: tkuramoto33 <[email protected]>

* Update the description to mention pull requests

Signed-off-by: tkuramoto33 <[email protected]>

* Update README.md

* More updates

More updates

* Added plcaeholder images

Added plcaeholder images

* Create tests.md

test coverage  #413 

Signed-off-by: Dan Benitah <[email protected]>

* Updated images

Updates all images and compressed some images, cleaned up naming for the avif file.

* More updates

New images, and some updates to the copy after stepping away from it for a bit.

* Updates with theory of change details

Updates with theory of change details

* Update README.md

* More updates

More updates

* Added plcaeholder images

Added plcaeholder images

* Updated images

Updates all images and compressed some images, cleaned up naming for the avif file.

* More updates

New images, and some updates to the copy after stepping away from it for a bit.

* Updates with theory of change details

Updates with theory of change details

* Minor updates, included adopters page link

Minor updates, included adopters page link

* Further updates to clean up merge duplication

* Signed-off-by: Vaughan Knight <[email protected]>

DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: da70ec4
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6be74ff
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: fe5cef9
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: b4a7973
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: d0a954a
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 996d084
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 648a1ce
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 581267c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 3c90f55
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6c1514e
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0592710
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: c59057c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0cec58f
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 028a179

Signed-off-by: Vaughan Knight <[email protected]>

* blog posts - unpublished / placeholder posts currently sit in blog_preview sub folder

* annoucementBar #416 to include disclaimer as well as CarbonHack link

* CarbonHack24 Update to README.md

Signed-off-by: Dan Benitah <[email protected]>

* bold disclaimer / banner message

* ensuring samples get deployed as part of the docs too

* working directory correction for moving samples in docs deployment workflow

* normalisation of the workflow name to others

* latest docusaurus updates to check the latest workflow

* docusaurus broken links build warning + move all samples folder

* Update CONTRIBUTING.md

Signed-off-by: Sophie Trinder <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Sophie Trinder <[email protected]>

* Update CHANGELOG.md

Signed-off-by: Dan Benitah <[email protected]>

* Update CHANGELOG.md with first draft release notes for 1.2

Signed-off-by: Dan Benitah <[email protected]>

* Update CHANGELOG.md

Signed-off-by: Dan Benitah <[email protected]>

* Update CHANGELOG.md

Updating release date

Signed-off-by: Dan Benitah <[email protected]>

* Update WattTime registration link

Signed-off-by: Phil Huang <[email protected]>

* Update containerization.md

Small typo ("arbon" => "Carbon")

Signed-off-by: Richard Jackson <[email protected]>

* Create adopters.md

Signed-off-by: tkuramoto33 <[email protected]>

* Add Vestas.

Signed-off-by: tkuramoto33 <[email protected]>

* Remove a hyphen for consistent appearance

Signed-off-by: tkuramoto33 <[email protected]>

* Update the description

Signed-off-by: tkuramoto33 <[email protected]>

* Update the description to mention pull requests

Signed-off-by: tkuramoto33 <[email protected]>

* Create enablement.md

table of content


Signed-off-by: Rintaro Ikeda <[email protected]>

* draft of enablement.md

Signed-off-by: Rintaro Ikeda <[email protected]>

* Update carbon-aware-cli.md

Fixes bugs with Linux scripts

Signed-off-by: JasonLuuk <[email protected]>

* Initial codespace branch and associated docs

* updated vs code extensions

* DCO Remediation Commit for Dan Benitah <[email protected]>

I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 44578f4
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 3ae9a00

Signed-off-by: Dan Benitah <[email protected]>

* Update README.md

* More updates

More updates

* Added plcaeholder images

Added plcaeholder images

* Updated images

Updates all images and compressed some images, cleaned up naming for the avif file.

* More updates

New images, and some updates to the copy after stepping away from it for a bit.

* Updates with theory of change details

Updates with theory of change details

* Minor updates, included adopters page link

Minor updates, included adopters page link

* Update README.md

* More updates

More updates

* Added plcaeholder images

Added plcaeholder images

* Updated images

Updates all images and compressed some images, cleaned up naming for the avif file.

* More updates

New images, and some updates to the copy after stepping away from it for a bit.

* Updates with theory of change details

Updates with theory of change details

* Signed-off-by: Vaughan Knight <[email protected]>

DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: da70ec4
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6be74ff
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: fe5cef9
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: b4a7973
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: d0a954a
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 996d084
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 648a1ce
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 581267c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 3c90f55
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6c1514e
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0592710
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: c59057c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0cec58f
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 028a179

Signed-off-by: Vaughan Knight <[email protected]>

* Update tests.md

our current coverage is 74.6% so adjusting until we can improve

Signed-off-by: Dan Benitah <[email protected]>

* Update README.md

linking to the new banner

Signed-off-by: Dan Benitah <[email protected]>

* adding the banner image

Signed-off-by: Dan Benitah <[email protected]>

* Create SECURITY.md

* merge and bug fixes

* Qucikstart fix and overview link adjustment following move

* Up Helm chart version to 1.1.0

Signed-off-by: Yasumasa Suenaga <[email protected]>

* Signed-off-by: Vaughan Knight <[email protected]>

DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: da70ec4
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6be74ff
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: fe5cef9
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: b4a7973
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: d0a954a
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 996d084
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 648a1ce
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 581267c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 3c90f55
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6c1514e
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0592710
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: c59057c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0cec58f
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 028a179

Signed-off-by: Vaughan Knight <[email protected]>

* CarbonHack24 Update to README.md

Signed-off-by: Dan Benitah <[email protected]>

* Create tests.md

test coverage  #413

Signed-off-by: Dan Benitah <[email protected]>

* Update tests.md

our current coverage is 74.6% so adjusting until we can improve

Signed-off-by: Dan Benitah <[email protected]>

* Signed-off-by: Vaughan Knight <[email protected]>

DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: da70ec4
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6be74ff
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: fe5cef9
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: b4a7973
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: d0a954a
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 996d084
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 648a1ce
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 581267c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 3c90f55
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6c1514e
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0592710
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: c59057c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0cec58f
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 028a179

Signed-off-by: Vaughan Knight <[email protected]>

* blog updates

* DCO Remediation Commit for Dan Benitah <[email protected]>

I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 356ce09
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 2c342a8
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 04be596
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: c437b5b
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 46958d9
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 21a0e16
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 8bbe72e
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 62e2a95
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 5183d73
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 93267d6
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: ee8841c
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 2d7b4dd
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 68bbb2f
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 735a515
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: a31b391
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: b7483b6
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 4cece7b
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 83f3073
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 4799d7a
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: d2d823d
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: c3d832c
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: ec96b52
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 9567c45
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 4527514
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: ff729b0
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 1bdd2ad
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 012ca25
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: c7d4563
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: a51782f
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: cc15035
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 3c62bd4
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 590f262

Signed-off-by: Dan Benitah <[email protected]>

DCO Remediation Commit for danuw <[email protected]>

I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: fbc602c
I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: ac1432f
I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: 8166cf2
I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: 48f117e

Signed-off-by: danuw <[email protected]>

* DCO Remediation Commit for danuw <[email protected]>

I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: fbc602c
I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: ac1432f
I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: 8166cf2
I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: 48f117e

Signed-off-by: danuw <[email protected]>
Signed-off-by: Dan Benitah <[email protected]>

* Update baseURL docusaurus config

Signed-off-by: Osama Jandali <[email protected]>

* Update docusaurus.config.js

Signed-off-by: Osama Jandali <[email protected]>

* Revert changes 

Signed-off-by: Osama Jandali <[email protected]>

* Update domain from docusaurus

Signed-off-by: Osama Jandali <[email protected]>

* Update docusaurus.config.js

Signed-off-by: Osama Jandali <[email protected]>

* Create CNAME file

Signed-off-by: Osama Jandali <[email protected]>

* clean up for title

* Option to show the samples in the local docs using `nm run start-with-samples` . Will need deleting manually for now

* seo for the doc site

* docs fixes

* layout update for blogs

* Update SECURITY.md

Updated with @Willmish recommendations for the document which were lost in a comment 👍

* DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 2dc06f8

Signed-off-by: Vaughan Knight <[email protected]>

* Ensure pictures on the blog are correctly sized

* updated links to videos

* Update README.md

* Change "Withing" to "Within"

I'm genuinely unsure on what word this should be, possible "Using", but I'm sure it's not "Withing".

Signed-off-by: Richard Jackson <[email protected]>

* Update README.md

Two other typos
- programatically -> programmatically
- soruces -> sources

Signed-off-by: Richard Jackson <[email protected]>

* first draft of release 1.3 changelog

* Update README.md with updated link to overview

Signed-off-by: Dan Benitah <[email protected]>

* Fix overview URL in README

Signed-off-by: Szymon Duchniewicz <[email protected]>

* Update README.md

Update FAQ link for Carbon Hack

Signed-off-by: Russell Trow <[email protected]>

* Updates to the contribution documentation

Updates to the contribution documentation

* DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: f267eba

Signed-off-by: Vaughan Knight <[email protected]>

* Readme as project overview in docs, disclaimer update for graduated project, and docs deploying pipeline updates

* DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: bd7ad15
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 693beed
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 1d78756
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: a7bc0fc
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 571e217
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: a07870f
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0314c47
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 3af6f73
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 932a665
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 9f09493
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 02ea4d6
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 183a676
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0481081

Signed-off-by: Vaughan Knight <[email protected]>

* Migrate to .NET 8

#404
#420
#421
#422

Co-authored-by: Takuya Iwatsuka <[email protected]>
Signed-off-by: Yasumasa Suenaga <[email protected]>

* fix typos

Signed-off-by: omahs <[email protected]>

* fix typo

Signed-off-by: omahs <[email protected]>

* fix typo

Signed-off-by: omahs <[email protected]>

* fix typos

Signed-off-by: omahs <[email protected]>

* fix typos

Signed-off-by: omahs <[email protected]>

* fix typos

Signed-off-by: omahs <[email protected]>

* Update agenda-template.md

Signed-off-by: Sophie Trinder <[email protected]>

* Resolve NU1605 relating to System.IO.FileSystem.Primitives

https://learn.microsoft.com/en-us/nuget/reference/errors-and-warnings/nu1605#example-3

Signed-off-by: Yasumasa Suenaga <[email protected]>

* Use RID rather than QEMU to build WebAPI container image

https://devblogs.microsoft.com/dotnet/improving-multiplatform-container-support/

Signed-off-by: Yasumasa Suenaga <[email protected]>

* Separate OpenAPI document generation from build-env stage

Signed-off-by: Yasumasa Suenaga <[email protected]>

* Create case-study-template.md

Creating the case study template.

Signed-off-by: Vaughan Knight <[email protected]>

* Update case-study-template.md

Minor updates.

Signed-off-by: Vaughan Knight <[email protected]>

* Up Helm chart version to 1.2.0 (#500)

Signed-off-by: Yasumasa Suenaga <[email protected]>

* First draft of the ADR for watt time v3 changes

First draft of the ADR for watt time v3 changes.  Looking at path mappings and parameters.  Still plenty to work on.

* Initial changelog 1.4.0 (#511)

Signed-off-by: Dan Benitah <[email protected]>

* overview.md: Fixed three broken links Signed-off-by: joecus1 <[email protected]>

* DCO Remediation Commit for joecus1 <[email protected]>

I, joecus1 <[email protected]>, hereby add my Signed-off-by to this commit: c6b2c14

Signed-off-by: joecus1 <[email protected]>

* Update enablement.md

update older .Net reference 

Signed-off-by: nttDamien <[email protected]>

* (fix) broken links - Update enablement.md

Signed-off-by: nttDamien <[email protected]>

* Moved ADR to correct location

Moved ADR to correct location

* Further updates for the watt time v2 to v3 upgrade

Signed-off-by: Vaughan Knight <[email protected]>

* Further updates for the watt time v2 to v3 upgrade

Signed-off-by: Vaughan Knight <[email protected]>

* Update SECURITY.md (.NET 8 upgrade)

Signed-off-by: nttDamien <[email protected]>

* Update enablement.md 

2 missed references...

Signed-off-by: nttDamien <[email protected]>

* Update docusaurus.config.js

removed banner's mention of Hack

Signed-off-by: Dan Benitah <[email protected]>

* Update docusaurus.config.js

Signed-off-by: Dan Benitah <[email protected]>

* Update 0016-watt-time-v3.md

updated notes for BA

Signed-off-by: Vaughan Knight <[email protected]>

* First draft of the ADR for watt time v3 changes

First draft of the ADR for watt time v3 changes.  Looking at path mappings and parameters.  Still plenty to work on.

* Moved ADR to correct location

Moved ADR to correct location

* Further updates for the watt time v2 to v3 upgrade

Signed-off-by: Vaughan Knight <[email protected]>

* Update 0016-watt-time-v3.md

updated notes for BA

Signed-off-by: Vaughan Knight <[email protected]>

* Create 0016-watt-time-v3.md

More updates.

* Added base url to the configuration with validation

Added AuthenticationBaseUrl to the configuration and updated Authentication to leverage the v3 authenication path - note the API is not updated and will require further updates.

* Updated start and end configuration

Updated start and end configuration to new values

* Balancing Authority Parameter Renamed to Region

Balancing Authority Renamed to Region.  Does not include updates to API, just the Query String parameter.

* Add example for 'podman play kube' (#340)

* Add example for 'podman play kube'

Signed-off-by: Yasumasa Suenaga <[email protected]>

* Update Swagger JSON URL

Signed-off-by: Yasumasa Suenaga <[email protected]>

---------

Signed-off-by: Yasumasa Suenaga <[email protected]>

* Updates for historical data API

Updates for historical data API

* Removed accidental file

Removed accidental file

* Lots of test updates

Lots of test updates, need to do some fixes.

* Historical forecasts updated

Historical forecasts updated

* DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: b9490e4
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: b991bac
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: e4f1494
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: b443e9e
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: ab1205d
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 7c115fa
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: e047c9a
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: aa81382
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 8640c8c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 880fcf7

Signed-off-by: Vaughan Knight <[email protected]>

* Many tests reworked, a few to go

Many tests reworked, a few to go.  Consolidated a lot of the hand crafted json objects into objects that get serialized as the purist JsonObject format was prone to errors - in some cases tests were passing even with bad typing.

* Further test updates

Further test updates

* Further updates, just 1 test left to remediate

Further updates, just 1 test left to remediate

* Updated to add authentication client to the service builder for the tests

Updated to add authentication client to the service builder for the tests.  All tests now passing.

* Renaming of Balancing Authority to Region

Renaming of Balancing Authority to Region through all code and comments.  This will also need updating through documentation.

* Fixed spelling error in latitude

Fixed spelling error in latitude

* Fixed a bug where location sources were loading twice

Fixed a bug where location sources were loading twice.  Added a semaphore to stop any threading issues, and also stopped it loading twice in the service configuration.

* Fixed typo for method name

Fixed typo for method name

* DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: e324f36
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: be6663c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 39e45a6
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: fbfcac1
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 9aabd27
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 8127a92
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 4ff0151
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: d93320f
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 91799f7
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 4665813

Signed-off-by: Vaughan Knight <[email protected]>

* Updates based on code review for WattTime Tests

Updates based on code review for WattTime Tests.  Mostly cleanup of constants which were removed elsewhere in tests.

* Cleaned up a lot of the string literals

Cleaned up a lot of the string literals.  They were causing too much fragility in the code base, and made it complex when updating the WattTime API.

* More cleanup of some of the strings

More cleanup of some of the strings.  Creating consistency for using the test data on parameters and not just reponses also.

* Updates to documentation and changelog

Updates to documentation and changelog

* Update azure-regions.json (#536)

Latest azure-regions.json list 
Adds italynorth, polandcentral, spaincentral, mexicocentral, israelcentral, qatarcentral, brazilus, eastusstg
(Also seems to remove trailing zeros in some existing coordinates)

Signed-off-by: Dan Benitah <[email protected]>

* Update CHANGELOG.md for v1.5

Signed-off-by: Dan Benitah <[email protected]>

* Update CHANGELOG.md

layout update

Signed-off-by: Dan Benitah <[email protected]>

---------

Signed-off-by: Phil Huang <[email protected]>
Signed-off-by: tkuramoto33 <[email protected]>
Signed-off-by: Rintaro Ikeda <[email protected]>
Signed-off-by: Richard Jackson <[email protected]>
Signed-off-by: Yasumasa Suenaga <[email protected]>
Signed-off-by: JasonLuuk <[email protected]>
Signed-off-by: Dan Benitah <[email protected]>
Signed-off-by: Vaughan Knight <[email protected]>
Signed-off-by: Sophie Trinder <[email protected]>
Signed-off-by: danuw <[email protected]>
Signed-off-by: Osama Jandali <[email protected]>
Signed-off-by: Szymon Duchniewicz <[email protected]>
Signed-off-by: Russell Trow <[email protected]>
Signed-off-by: Yasumasa Suenaga <[email protected]>
Signed-off-by: omahs <[email protected]>
Signed-off-by: joecus1 <[email protected]>
Signed-off-by: nttDamien <[email protected]>
Co-authored-by: danuw <[email protected]>
Co-authored-by: Dan Benitah <[email protected]>
Co-authored-by: Phil Huang <[email protected]>
Co-authored-by: tkuramoto33 <[email protected]>
Co-authored-by: Rintaro Ikeda <[email protected]>
Co-authored-by: rinikeda <[email protected]>
Co-authored-by: Richard Jackson <[email protected]>
Co-authored-by: yasuenag <[email protected]>
Co-authored-by: JasonLuuk <[email protected]>
Co-authored-by: Szymon Duchniewicz <[email protected]>
Co-authored-by: Sophie Trinder <[email protected]>
Co-authored-by: Osama Jandali <[email protected]>
Co-authored-by: Szymon Duchniewicz <[email protected]>
Co-authored-by: Russell Trow <[email protected]>
Co-authored-by: Takuya Iwatsuka <[email protected]>
Co-authored-by: omahs <[email protected]>
Co-authored-by: joecus1 <[email protected]>
Co-authored-by: nttDamien <[email protected]>
  • Loading branch information
19 people authored Jul 23, 2024
1 parent 90a4ea6 commit 46f66d8
Show file tree
Hide file tree
Showing 50 changed files with 1,254 additions and 558 deletions.
73 changes: 73 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,79 @@

All notable changes to the Carbon Aware SDK will be documented in this file.

## [1.5.0] - 2024-05

This is the WattTime v3 update. Most notable changes that may require action are for deployment configuration, and these are minor.

### Added

WattTime v3 API support. This is an inplace upgrade for v2.

- [PR #532] Watt Time v3 Support ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/532)
- [PR #340] Add example for 'podman play kube' ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/340)
- [PR #536] Updated azure-regions.json with new regions ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/536)
- [#519] Remove hackathon sentence from our website banner ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/519)
- [#510] Gap Analysis for WattTime v3 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/510)
- [#262] [Feature Contribution]: Publish the docker file in a docker registry ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/262)

### Removed

WattTime v2 API support due to v3 in place replacement.

### Fixed

- [PR #522] Remove Hack mention from the Docs's banner ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/522)
- [#535] [Bug]: Configuration for locations loads twice ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/535)
- [PR #516] Update published documentation to .NET 8 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/516)
- [PR #515] overview.md: Fixed three broken links Signed-off-by: joecus1 <joecusa… ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/515)
- [#506] Check our published documentation to identify any references to .NET7 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/506)
- [#512] [Bug]: Broken links in overview.md file ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/512)

### Changed

Updates for WattTime v3 API endpoint from v2, details in the [ADR for WattTime v3 changes](./casdk-docs/docs/architecture//decisions/0016-watt-time-v3.md).

#### API

No changes

#### API Deployment

Due to the change for WattTime v3, there is change to the configuration for WattTime users.

With some of the changes to the code, some of the configuration will also needs to change.

| Config (v2) | Config (v3) | Description |
|------------------------------------|----------------------------------|------------------------------|
| `BalancingAuthorityCacheTTL` | `RegionCacheTTL` | This is the cache for regions data in seconds, and has a default value of 1 day. This only needs updating if you set it |
| n/a | `AuthenticationBaseUrl` | **NEW** This is the base URL for the WattTime Authentication API and defaults to `https://api.watttime.org/` if not set. |

Example below if set (note they do not have to be set)
```json
"wattTime_no-proxy": {
"Type": "WattTime",
"Username": "the_username",
"Password": "super_secret_secret",
"BaseURL": "https://api.watttime.org/v3/",
"AutenticationBaseURL": "https://api.watttime.org", // This is new but not mandatory in config
"RegionCacheTTL": 86400, // This is changed but not mandatory in config
"Proxy": {
"UseProxy": false
}
```

#### SDK

No changes


#### Other

No changes


For more details, checkout [https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/503](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/503)


## [1.4.0] - 2024-05

Expand Down
86 changes: 86 additions & 0 deletions casdk-docs/docs/architecture/decisions/0016-watt-time-v3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@

# 0015. WattTime v3 Changes

## Status

Proposed

## Context
As part of the update to Watt Time v3 we are proposing the changes to the underlying API calls. This needs to be tracked so we understand the impacts, and if multiple options are available, which option was selected and why.

This wll impact the `CarbonAware.DataSources.WattTime` project primarily - however all test will need changing where there are downstream tests that are impacted, and for example, if any initialization needs reconfiguring it will impact dependency injection and likely `Program.cs` in the WattTime API projects.

## Decision

The proposal is for the outlined WattTime API mapping and changes.

## WattTime v2, v3 Mapping

The following document and guidelines was used to understand the impact to the Carbon Aware SDK for the WattTime v3 updates. https://docs.watttime.org/#tag/Transitioning-from-APIv2-to-APIv3

### Base URL
The base URL will need to change. This is configured in the `appsettings.config` and can be set from environment variables.

|Base URL (v2) | Based URL (v3) |
|---|---|
| /v2 | /v3 |


### Paths
The paths will also need to change.

The following is configured at `CarbonAware.DataSources.WattTime/src/Constants/Paths.cs`

All response types for emission data include a response/data object, and a `meta` object which contains information such as `region`. As such historical data, forecast data, and historical forecast data objects will change significantly. These will be moved across to their own `...Response` record objects to abstract any future changes in the response type. Previously these objects had a lot of overlap so where the same class and this will cause significant rework of the code and tests, and breaking these out now will abstract them.

The `Login` is now at a different base URL, and to avoid any future issues a different HTTP client will be used for authentication, and the existing HTTP client will be used for API interaction. These will still sit in the `WattTimeClient` and as such no impacts to the dependent classes/logic.

| API Endpoint | Description | Path (v2) | Path (v3) | Notes |
|--------------|-------------|-----------|-----------|---|
| Data | Get data | /data | /historical | _Request_ <li> `starttime` is now `start` and mandatory <li> `endtime` is now `end` and mandatory <li> `ba` is now `region` <li> `signal_type` added <br> _Response_ <li> `signal_type` added
| Forecast | Get forecast| /forecast | /forecast | <br> No longer be used for historical data <br> _Request_ <li> `ba` is now `region` <li> `extended_forecast` removed <li> `horizon_hours` added <li> `signal_type` added <li> Historical forecasts are now at `/forecast/historical` <br> _Response_ <li> `signal_type` added
| Historical | Get historical forecast data | /historical (?) | /forecast/historical (?) | This changed signficantly. <br> _Request_ <li> `ba` is now `region` <li> `starttime` is now `start` and mandatory <li> `endtime` is now `end` and mandatory <li> `signal_type` added <br> _Response_ <li> `signal_type` added
| Balancing Authority From Location | Get balancing authority from location | /ba-from-loc | /region-from-loc | Check if the CA SDK uses BA at all <br><br> _Request_ <li> `name` is now `region_full_name` <li> `abbrev` is now `region` <li> `signal_type` added <br> _Response_ <li> `id` removed <li> `signal_type` added |
| Login | User login | https://api2.watttime.org/v2/login | https://api.watttime.org/login | Path has changed from being version specific to being no longer related to the API version. <br><br> Updated in `WattTimeClient` to now have 2 HTTP clients to decouple versions from the login.

### Query Strings

#### Signal Type
Everything call takes an optional `signal_type` parameter that defaults to `co2_moer`.

The following comes from `CarbonAware.DataSources.WattTime/src/Constants/QueryStrings.cs` and the changes are consistent with the discussion above.

| Query String (v2) | Query String if Changed (v3) | Description |
|------------------------------------|----------------------------------|------------------------------|
| `ba` | `region` | Balancing Authority / Region |
| `starttime` | `start` | Start Time |
| `endtime` | `end` | End Time |
| `latitude` | - | Latitude |
| `longitude` | - | Longitude |
| `username` | - | Username |

## Update Changes
With some of the changes to the code, some of the configuration will also needs to change.

| Config (v2) | Config (v3) | Description |
|------------------------------------|----------------------------------|------------------------------|
| `BalancingAuthorityCacheTTL` | `RegionCacheTTL` | This is the cache for regions data in seconds, and has a default value of 1 day. |
| n/a | `AuthenticationBaseUrl` | **NEW** This is the base URL for the WattTime Authentication API and defaults to `https://api.watttime.org/` if not set. |

Example below if set (note they do not have to be set)
```json
"wattTime_no-proxy": {
"Type": "WattTime",
"Username": "the_username",
"Password": "super_secret_secret",
"BaseURL": "https://api.watttime.org/v3/",
"AutenticationBaseURL": "https://api.watttime.org", // This is new but not mandatory
"RegionCacheTTL": 86400, // This is new but not mandatory
"Proxy": {
"UseProxy": false
}
```
## Green Impact

Neutral

2 changes: 1 addition & 1 deletion casdk-docs/docs/tutorial-extras/carbon-aware-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ EmissionsForecast()
#### Locations

Each WattTime emissions data point is associated with a particular named
balancing authority. For transparency, this value is also used in
region often referred to as a balancing authority. For transparency, this value is also used in
`EmissionsData` response objects. It is not overwritten to match the named
datacenter provided by any request.

Expand Down
2 changes: 1 addition & 1 deletion casdk-docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ const config = {
id: 'announcementBar-0', // Increment on change
// content: `⭐️ If you like Docusaurus, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/facebook/docusaurus">GitHub</a> and follow us on <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/docusaurus">Twitter ${TwitterSvg}</a>`,
//content: `🎉️ <b><a target="_blank" href="https://docusaurus.io/blog/releases/3.0">Docusaurus v3.0</a> is now out!</b> 🥳️`,
content:`<strong>\u26A0 Graduated Project: This project is a Graduated Project, supported by the Green Software Foundation. The publicly available version documented in the README is trusted by the GSF. New versions of the project may be released, or it may move to the Maintained or Archived Stage. <br><br> 🎉️ We are running a Hackathon! CarbonHack is open to all, including software practitioners and those with a passion for Green Software. Find out more on the <a href="https://grnsft.org/hack/github">CarbonHack website</a> </strong>`,
content:`<strong>\u26A0 Graduated Project: This project is a Graduated Project, supported by the Green Software Foundation. The publicly available version documented in the README is trusted by the GSF. New versions of the project may be released, or it may move to the Maintained or Archived Stage.</strong> `,
backgroundColor:'#EBF2D7',
textColor:'#00524f'
},
Expand Down
64 changes: 64 additions & 0 deletions samples/casdk-demo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Carbon Aware SDK demonstration on Podman

This folder contains an example for Carbon Aware SDK and Swagger UI for the SDK. The user can demonstrate Carbon Aware SDK via Swagger UI with just one command.

This demonstration uses `podman play kube` to deploy apps like a Kubernetes application. Deployment is defined in [demo.yaml](demo.yaml).

## Requirements

- Podman

## Ports to open

Podman creates virtual network, then all of containers in the deployment would be located flatten. So Each containers can access each other as a `localhost`. We need to consider TCP port:

* 8080: Carbon Aware SDK
* 8081: Swagger UI
* 8082: NGINX (for reverse proxy)

NGINX is a reverse proxy to both Carbon Aware SDK and Swagger UI. To avoid CORS error, you can access Swagger UI via NGINX ( http://localhost:8082/swagger-ui/ ).

## Reverse proxy rule

See [nginx-rp.conf](nginx-rp.conf)

/ -> Carbon Aware SDK
/swagger.yaml -> OpenAPI document provided by Carbon Aware SDK
/swagger-ui/ -> Swagger UI for Carbon Aware SDK

## How to run

1. Set environment variables prefixed with `CASDK_`: e.g. `CASDK_DataSources__EmissionsDataSource`

2. Start demonstration

```
./demo.sh start
```

:::warning

* [demo.sh](demo.sh) would create `/tmp/casdk-config.yaml` which may contain credentials (e.g. API token of backend service). This file would be removed by `./demo.sh stop`.
* [demo.sh](demo.sh) would change security context of [nginx-rp.conf](nginx-rp.conf) to `container_file_t` if SELinux is enabled. It would not recover in `./demo.sh stop`, so you need to recover manually via `restorecon` if need.

:::

3. Access endpoints (e.g. http://localhost:8082/swagger-ui/ )

4. Stop demonstration

```
./demo.sh stop
```

## Example

Run demonstration with ElectricityMapsFree datasource

```
export CASDK_DataSources__EmissionsDataSource=ElectricityMapsFree
export CASDK_DataSources__Configurations__ElectricityMapsFree__Type=ElectricityMapsFree
export CASDK_DataSources__Configurations__ElectricityMapsFree__token=YOUR_SECRET_TOKEN
./demo.sh start
```
6 changes: 6 additions & 0 deletions samples/casdk-demo/casdk-config.yaml.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
apiVersion: v1
kind: ConfigMap
metadata:
name: casdk-config
data:
# Environment variables would be added by demo.sh
55 changes: 55 additions & 0 deletions samples/casdk-demo/demo.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
#!/bin/sh

THISFILE=$0
BASEDIR=$(dirname $THISFILE)
SUBCMD=$1
CONFIGMAP=/tmp/casdk-config.yaml

help_and_exit () {
echo "Usage:"
echo " $THISFILE [start|stop]"

rm -f $CONFIGMAP
exit 1
}

start () {
# Create ConfigMap for envvars in CASDK container
cp -f $BASEDIR/casdk-config.yaml.template $CONFIGMAP
for CASDK_ENV in `env | grep CASDK_`; do
KEY=`echo $CASDK_ENV | cut -d '=' -f 1 | sed -e 's/^CASDK_//'`
VALUE=`echo $CASDK_ENV | cut -d '=' -f '2'`

echo " $KEY: $VALUE" >> $CONFIGMAP
done


# Change security context of nginx-rp.conf because it would be mounted by
# NGINX container in demo.yaml.
SELINUX_MODE=`getenforce 2>/dev/null`
if [ "$SELINUX_MODE" = 'Enforcing' ]; then
chcon -t container_file_t $BASEDIR/nginx-rp.conf
fi

# Start Podman
# Move to BASEDIR because demo.yaml should refer nginx-rp.conf in that dir.
pushd $BASEDIR > /dev/null 2>&1
podman play kube --configmap=$CONFIGMAP demo.yaml
popd > /dev/null 2>&1
}

stop () {
podman play kube --down $BASEDIR/demo.yaml
rm -f $CONFIGMAP
}

case "$SUBCMD" in
start)
start;;

stop)
stop;;

*)
help_and_exit;;
esac
47 changes: 47 additions & 0 deletions samples/casdk-demo/demo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: casdk-demo
labels:
app: casdk-demo
spec:
selector:
matchLabels:
app: casdk-demo
template:
metadata:
labels:
app: casdk-demo
spec:
containers:
- name: carbon-aware-sdk
image: ghcr.io/green-software-foundation/carbon-aware-sdk:pre
envFrom:
- configMapRef:
name: casdk-config
ports:
- containerPort: 8080
hostPort: 8080
- name: swagger-ui
image: swaggerapi/swagger-ui
env:
- name: SWAGGER_JSON_URL
value: /swagger.yaml
- name: PORT
value: "8081"
ports:
- containerPort: 8081
hostPort: 8081
- name: nginx
image: nginx
ports:
- containerPort: 8082
hostPort: 8082
volumeMounts:
- name: rp-config
mountPath: /etc/nginx/conf.d/default.conf
volumes:
- name: rp-config
hostPath:
path: nginx-rp.conf
type: File
16 changes: 16 additions & 0 deletions samples/casdk-demo/nginx-rp.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
server {
listen 8082;

location / {
proxy_pass http://localhost:8080;
}

location /swagger.yaml {
proxy_pass http://localhost:8080/api/v1/swagger.yaml;
}

location /swagger-ui/ {
proxy_pass http://localhost:8081/;
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ public async Task EmissionsForecasts_RequestedAtOptions_ReturnsExpectedData()
IgnoreTestForDataSource("data source does not implement '--requested-at'", DataSourceType.ElectricityMaps);

// Arrange
_dataSourceMocker.SetupBatchForecastMock();
_dataSourceMocker.SetupHistoricalBatchForecastMock();

// Act
var exitCode = await InvokeCliAsync($"emissions-forecasts -l eastus -r 2022-09-01");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ public void SetupDataMock(DateTimeOffset start, DateTimeOffset end, string locat
SetupResponseGivenGetRequest(Paths.PastRange, pastRange);
}

public void SetupBatchForecastMock()
public void SetupHistoricalBatchForecastMock()
{
throw new NotImplementedException();
}
Expand Down
Loading

0 comments on commit 46f66d8

Please sign in to comment.