|
| 1 | +--- |
| 2 | +slug: release-v1.5 |
| 3 | +title: Release v1.5 |
| 4 | +tags: [v1.5, release] |
| 5 | +--- |
| 6 | + |
| 7 | +Release 1.5 |
| 8 | + |
| 9 | +This is the WattTime v3 update. Most notable changes that may require action are for deployment configuration, and these are minor. |
| 10 | + |
| 11 | +### Added |
| 12 | + |
| 13 | +WattTime v3 API support. This is an inplace upgrade for v2. |
| 14 | + |
| 15 | +- [PR #532 Watt Time v3 Support ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/532) |
| 16 | +- [PR #340 Add example for 'podman play kube' ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/340) |
| 17 | +- [PR #536 Updated azure-regions.json with new regions ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/536) |
| 18 | +- [#519 Remove hackathon sentence from our website banner ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/519) |
| 19 | +- [#510 Gap Analysis for WattTime v3 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/510) |
| 20 | +- [#262 Feature Contribution: Publish the docker file in a docker registry ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/262) |
| 21 | + |
| 22 | +### Removed |
| 23 | + |
| 24 | +WattTime v2 API support due to v3 in place replacement. |
| 25 | + |
| 26 | +### Fixed |
| 27 | + |
| 28 | +- [PR #522 Remove Hack mention from the Docs's banner ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/522) |
| 29 | +- [#535 Bug: Configuration for locations loads twice ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/535) |
| 30 | +- [PR #516 Update published documentation to .NET 8 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/516) |
| 31 | +- [PR #515 overview.md: Fixed three broken links Signed-off-by: joecus1 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/515) |
| 32 | +- [#506 Check our published documentation to identify any references to .NET7 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/506) |
| 33 | +- [#512 Bug: Broken links in overview.md file ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/512) |
| 34 | + |
| 35 | +### Changed |
| 36 | + |
| 37 | +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). |
| 38 | + |
| 39 | +#### API |
| 40 | + |
| 41 | +No changes |
| 42 | + |
| 43 | +#### API Deployment |
| 44 | + |
| 45 | +Due to the change for WattTime v3, there is change to the configuration for WattTime users. |
| 46 | + |
| 47 | +With some of the changes to the code, some of the configuration will also needs to change. |
| 48 | + |
| 49 | +| Config (v2) | Config (v3) | Description | |
| 50 | +|------------------------------------|----------------------------------|------------------------------| |
| 51 | +| `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 | |
| 52 | +| n/a | `AuthenticationBaseUrl` | **NEW** This is the base URL for the WattTime Authentication API and defaults to `https://api.watttime.org/` if not set. | |
| 53 | + |
| 54 | +Example below if set (note they do not have to be set) |
| 55 | +```json |
| 56 | +"wattTime_no-proxy": { |
| 57 | + "Type": "WattTime", |
| 58 | + "Username": "the_username", |
| 59 | + "Password": "super_secret_secret", |
| 60 | + "BaseURL": "https://api.watttime.org/v3/", |
| 61 | + "AutenticationBaseURL": "https://api.watttime.org", // This is new but not mandatory in config |
| 62 | + "RegionCacheTTL": 86400, // This is changed but not mandatory in config |
| 63 | + "Proxy": { |
| 64 | + "UseProxy": false |
| 65 | + } |
| 66 | +``` |
| 67 | + |
| 68 | +#### SDK |
| 69 | + |
| 70 | +No changes |
| 71 | + |
| 72 | + |
| 73 | +#### Other |
| 74 | + |
| 75 | +No changes |
| 76 | + |
| 77 | + |
| 78 | +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) |
0 commit comments