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

Add blog article for .NET 8 upgrade #524

Merged
merged 36 commits into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
3a7c681
Add blog article for .NET 8 upgrade
YaSuenag May 16, 2024
8f1297a
Update article
YaSuenag May 24, 2024
301db94
Fix
YaSuenag Jun 26, 2024
a734c56
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
8bf03bc
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
28e0c2f
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
16ba58b
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
4c72759
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
0daeb94
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
fc11261
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
670b6c0
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
af44de1
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
cee7dd5
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
9af35e5
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
8b7930d
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
bdebd19
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
9a5fa5f
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
7e60a26
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
7dfe8ca
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
d415c3a
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
1d375ab
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
b49f6c1
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
a51a284
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
f30a4a8
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
25c6833
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
5f405b0
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
e80947a
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
ea59427
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
406f7b0
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
42d991e
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
6cecab3
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
bdfb40b
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
a4e5a03
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
0f15148
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
c076597
Update casdk-docs/blog/2024-05-16-dotnet8/index.md
YaSuenag Jul 9, 2024
6cdcabc
Fix comments
YaSuenag Jul 10, 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
Binary file added casdk-docs/blog/2024-05-16-dotnet8/fig1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added casdk-docs/blog/2024-05-16-dotnet8/fig3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added casdk-docs/blog/2024-05-16-dotnet8/fig4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
156 changes: 156 additions & 0 deletions casdk-docs/blog/2024-05-16-dotnet8/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
---
slug: .NET 8 upgrade
title: Carbon Aware SDK 1.4, behind the scenes
tags: [dotnet8]
---

As most software nowadays, the Carbon Aware SDK relies on a stack of utilities, and while adding a new feature is usually the most appealing for a project, it’s also critical to maintain the stack, especially in a community effort.

Containerization has helped shifting the upgrading work to a more convenient time for the development team, but there are still various motivation for keeping a stack up to date with current versions: security, bug fixes, performance, support… but the best is to couple with new feature development: such was the case for .NET framework.
Copy link
Contributor

@Sophietn Sophietn Jun 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

..has helped shift…
..various motivations for …


However, those updates often have ripple effects, as their dependencies are not always foreseeable, making software upgrade workload hard to predict.
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

As NTT and NTT DATA were key participants in this contribution, this is a good occasion to cast a light on the behind the scenes, and the way this new Carbon Aware SDK is being used internally.

# Why .NET 8 ?

Carbon Aware SDK v1.4.0 was released on May 2024, its core evolution was the upgrade to .NET 8. Until v1.3.x, the Carbon Aware SDK has relied on the LTS (Long Term Support) version .NET 6. With an EOL (End of Life) set for November 2024, an upgrade was unavoidable.
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

Microsoft released .NET 8 in Nov 2023, this is the latest LTS version of .NET and [will be supported until Nov 2026](https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core).
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

Wanting to display the Software Carbon Intensity ([SCI - Software Carbon Intensity](https://sci.greensoftware.foundation/) as adopted in [ISO/IEC 21031:2024](https://www.iso.org/standard/86612.html)) metrics from the Carbon Aware SDK WebAPI, made .NET 8 a requirement, as .NET 8 introduced an [enhanced supports for implementing metrics features](https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-8/runtime#extensions-metrics).
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

Indeed, the newly introduced [IMeterFactory](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.metrics.imeterfactory?view=net-8.0) interface enabled us to create a [Meter](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.metrics.meter?view=net-8.0) instance while maintaining modularity by using dependency injection (i.e. use the .NET 8 implementation of the feature, instead of recreating it… another software development sustainable pattern).

In summary, Carbon Intensity metrics handling was combined with the necessary support extension that .NET 8 upgrade provides.
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

# In practice

The initial work for upgrading to .NET 8 was done in [Pull Request #404](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/404) (aka PR, basically a code change proposal, which once approved will be merged in the main code).
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

Without being a C# expert, it’s still interesting to look at the PR and see that: it involves several individuals working together as a community, many files were impacted, tests and samples are as critical as they should.
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

For the nitty gritty (else jump to the next paragraph): the core work is “simply” updating the target framework version.

It can be done in the property window of each C# projects, for example in the Japanese version of Visual Studio (Fig.1).
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

![fig1](./fig1.png)

Fig.1 Property window of C# project in Carbon Aware SDK on Visual Studio Community Edition

Carbon Aware SDK includes 30 C# projects (in v1.3.0 at least), so automation is welcomed. The target framework version is described in `/Project/PropertyGroup/TargetFramework` in `.csproj` file. For example, running the command on WSL:
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

```
find . -name "*.csproj" -exec sed -i 's|^\(\s\+\)<TargetFramework>net6.0</TargetFramework>$|\1<TargetFramework>net8.0</TargetFramework>|g' {} \;
```

.NET version is specified in many other places, which need to be updated as well (`grep` will list them all).
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

* Base image in Docker file
* Use tag `8.0` instead of `6.0` for `mcr.microsoft.com/dotnet/sdk`
* Tool configurations
* global.json
* dotnet-tools.json
* launch.json for VSCode
* Target framework version for OpenAPI generator for .NET
* .NET version for [actions/setup-dotnet](https://github.com/actions/setup-dotnet) in GitHub Actions Workflow
* Comments in source files
* Documents

While the updating part is done, the work does not end there…

# Unexpected work items

While the .NET 8 upgrade was done, some unexpected issues surfaced.

## Ripple effect on sample code

To help onboard new comers to the Carbon Aware SDK, a sample running on Azure Functions is provided.
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

Azure Functions for .NET is transitioning one of its execution modes (the In-process model) for the Isolated worker model ([more details here](https://learn.microsoft.com/en-us/azure/azure-functions/dotnet-isolated-in-process-differences)). Moreover, .NET 8 did not provide yet an option to use the former model in its initial release (cf. [roadmap of Azure Functions](https://techcommunity.microsoft.com/t5/apps-on-azure-blog/net-on-azure-functions-august-2023-roadmap-update/ba-p/3910098)).
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

As our sample was still implementing the in-process model (to be deprecated and not available in .NET 8 at this time), it made sense to migrate to the isolated worker model.

For the code lover, there is an helpful [guide](https://learn.microsoft.com/en-us/azure/azure-functions/migrate-dotnet-to-isolated-model?tabs=net8) for the migration. This led to:
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

* Change the version of container images to build and test
* Update the `.csproj` file
* Replace `Startup.cs` with `Program.cs`
* Replace `FunctionName` attribute with `Function`
* Change loggers to be obtained from the DI container
* Update the document

For more details browse: [Pull Request #420](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/420).

## Port Number Breaking change

As Carbon Aware SDK WebAPI uses ASP.NET Core technology another collateral must do change was required since .NET 8 changed its default port number from 80 to 8080 [Microsoft Learn document](https://learn.microsoft.com/en-us/dotnet/core/compatibility/containers/8.0/aspnet-port)).
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

Changing the port number from WebAPI container, which affects the containerPort in Helm chart and some GitHub Workflows which uses WebAPI.
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

## Broken build pipeline on GitHub Actions

Thanks to GitHub, a lot of automation is available in order to publish code, allowing to focus more on coding, in particular the Carbon Aware SDK repository is configured to publish WebAPI container image (like a snapshot build) when a commit occurs on the dev branch.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

… allowing ‘contributors’ to focus more on coding. In particular…


However, it suddenly stopped working after .NET 8 upgrade.
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

The team investigated the logs (Fig. 2), as a container image for both AMD64 and Arm64 Linux in GitHub Actions with [docker/build-push-action](https://github.com/docker/build-push-action): a mysterious segmentation fault (SEGV) was occurring after the upgrade… the code was not changed, `dotnet publish` was outside the scope.

```
> [linux/arm64 build-env 4/6] RUN dotnet publish CarbonAware.WebApi/src/CarbonAware.WebApi.csproj -c Release -o publish:
7.209 MSBuild version 17.9.6+a4ecab324 for .NET
24.69 Determining projects to restore...
41.42 Segmentation fault (core dumped)
```

Fig.2 Logs in `dotnet publish` on GitHub Actions

Further investigation was done, and thanks to a [.NET blog](https://devblogs.microsoft.com/dotnet/improving-multiplatform-container-support/), about multi-platform container support, that an unsupported approach was used for the build, and needed to be amended. More precisely, since .NET 6, QEMU static binaries were used to build container image for multi platforms.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

…thanks to a .NET blog about multi-platform container support, we identified that…


Fortunately .NET blog guides how to build multi platform container images, and the workflow was fixed accordingly in [Pull Request #498](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/498). So WebAPI container image with .NET 8 can be pulled from [GitHub Packages](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pkgs/container/carbon-aware-sdk) now!
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

# Use case in NTT / NTT DATA

While NTT & NTT DATA have been contributing to the Carbon Aware SDK a long time, none appeared in the [adopters list](https://github.com/Green-Software-Foundation/carbon-aware-sdk/blob/dev/casdk-docs/docs/overview/adopters.md), it is now changed thanks to those uses cases.
Copy link
Contributor

@Sophietn Sophietn Jun 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

…a long time, we had not previously publicly referenced our adoption of the tool.
The Carbon Aware SDK v1.4.0 carbon metrics exporter (dependent on .NET8 upgrade) has increased the usefulness of the SDK due to increased visualization capabilities. …


## Carbon Intensity map

Thanks to the new Carbon Aware SDK v1.4.0 carbon metrics exporter (thanks to .NET 8), more visualization capability are reachable.

This feature facilitate integration with monitoring solutions like [Prometheus](https://prometheus.io/) and furthermore with a visualization solution like [Grafana](https://grafana.com/docs/grafana/latest/panels-visualizations/visualizations/): unlocking geomap style visualization (showing metrics at specified locations on a map). By enabling the exporter and making some settings on Grafana, carbon intensities can be exported from Carbon Aware SDK to a geomap, this is part of a dashboard to monitor carbon emissions for software systems.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feature facilitate -> This feature facilitates


The Carbon Intensity can be intuitively visualized with size and colors on a geomap, beyond raising awareness, this can guide decisions on location or time shift.
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

![fig3](./fig3.png)

## Green Dashboard for Kubernetes

Carbon Aware SDK helps increase awareness around Carbon emission, and it is now possible to monitor carbon emission per application within Kubernetes.

In practice, each container energy consumption is evaluated through [Kepler](https://www.cncf.io/projects/kepler/) (sandbox project in Cloud Native Cloud Foundation, [CNCF](https://www.cncf.io/)), and thanks to the Carbon Aware SDK, the carbon emission can be evaluated.
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

All those emission data from power grid can be accessed through Prometheus exporter with Carbon Aware SDK (starting v1.4.0), and a visualized with Grafana dashboard.
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

The power consumption, energy consumption, carbon emission, and SCI can be seen at a glance!

One of the upside of micro-services architecture, as Kubernetes facilitates it, is to be able to work on different piece of an application in a relatively independant fashion (maintaining, scaling, optimizing…).
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

The Green Dashboard allows a team to check an application global energy consumption and carbon emission (dashboard left side), while drilling down at sustainability-related metrics for each micro-service (dashboard right side).
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

It shows the SCI, allowing to get a sense of the rate of Carbon Emission down to a particular piece of an architecture (R being the [functional unit](https://learn.greensoftware.foundation/measurement/#software-carbon-intensity-specification) for that service - for example an API call, the data is being shown per R unit or over an hour).
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

While in monolitic application optimization need customized instrumentation, and often have rippled effect, this green dashboard helps identifying which micro-service refactoring would have the maximum impact on the application carbon footprint, leveraging the team effort more efficiently.
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

![fig4](./fig4.png)

# Moving Forward

With the Cloud Computing expansion, and Kubernetes flexibility, more and more choices exist for running a workload, and while business and economical constraints seem obvious to lead those decisions, Carbon footprint have to be taken in account. Its relevance will be more and more pregnant.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pregnant isn’t right here.
… While business and economical constraints often lead those decisions, the carbon footprint is becoming an increasingly critical consideration.


This is a difficult endeavour, and the first step is to know where one stands, measure but also later evaluate and confirm what action would lead to improvement. That was one of the intent behind the Green Dashboard for Kubernetes, and the Carbon Aware SDK 1.4 is key element in this approach.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

..one of the intentions


By providing a standard interface to the carbon emissions of the energy, the Carbon Aware SDK is a key element for IT sustainability: from evaluating current carbon footprint up to taking in account carbon intensity for geo or time shifting…
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved

Thanks to the community effort the first step is a click away with the quickstarting guide, available for everyone.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add link to getting started guide


No excuse !
YaSuenag marked this conversation as resolved.
Show resolved Hide resolved
Loading