Docker Image on Windows Base Image #439 #2332

jwdb · 2024-01-03T13:47:09Z

With this PR it's possible to build a Windows version of the Azurite container. I've not added the required steps to the package.json since the current steps very much look internally used and I would be unable to test them.

It is based upon the work from @shanrath in the issue (#439), expanding it with a NodeJS baseimage because of the lack of a proper nodejs windows baseimage that can be trusted to be updated regularly.

The image is based upon the LTSC 2022 version of Windows Nanoserver.

Thanks for contribution! Please go through following checklist before sending PR.

PR Branch Destination

For Azurite V3, please send PR to main branch.
For legacy Azurite V2, please send PR to legacy-dev branch.

Always Add Test Cases

Make sure test cases are added to cover the code change.

Add Change Log

Add change log for the code change in Upcoming Release section in ChangeLog.md.

Development Guideline

Please go to CONTRIBUTION.md for steps about setting up development environment and recommended Visual Studio Code extensions.

jwdb · 2024-01-03T13:48:58Z

@microsoft-github-policy-service agree

blueww · 2024-01-04T07:34:21Z

@jwdb

Thanks for the contribution!

Would you please confirm:
Would you like Azurite team to release windows base docker image, or just keep this script in Azurite to help customer create image locally?

If you would like Azurite to release windows based docker image, please also add:

Update package.json so we can build the docker image from npm command. You can refer this PR: feat: add scripts for building multi-architecture azurite docker images #1569
Add Unit test for windows base docker image build / run. You can refer:

Azurite/azure-pipelines.yml

Line 528 in 3f64420

- job: docker

If you just would like to keep this script in Azurite repo, would you please:
Give the detail steps to build windows based docker image, and better update Readme.md with it (if the step is long, you can add a doc into https://github.com/Azure/Azurite/tree/main/docs/designs, and link Readme.md with it.).

jwdb · 2024-01-04T09:10:24Z

Hi @blueww,

I would like the image to be released, that way it's easier to use & make it easier for the windows image to stay up-to-date with the latest version of Azurite.

I've added the build steps I think are neccesary to the package.json & azure-pipelines.yml.

blueww · 2024-01-04T09:39:21Z

It looks there are something wrong with the pipeline change, only 3 PR checks run, but originally there are 30+ PR checks.

blueww · 2024-01-04T09:43:22Z

package.json

    "docker:publish-arm64": "cross-var docker push xstoreazurite.azurecr.io/public/azure-storage/azurite:$npm_package_version-arm64",
-    "docker:create-manifest-versioned": "cross-var docker manifest create xstoreazurite.azurecr.io/public/azure-storage/azurite:$npm_package_version xstoreazurite.azurecr.io/public/azure-storage/azurite:$npm_package_version-amd64 xstoreazurite.azurecr.io/public/azure-storage/azurite:$npm_package_version-arm64",
-    "docker:create-manifest-latest": "cross-var docker manifest create xstoreazurite.azurecr.io/public/azure-storage/azurite:latest xstoreazurite.azurecr.io/public/azure-storage/azurite:$npm_package_version-amd64 xstoreazurite.azurecr.io/public/azure-storage/azurite:$npm_package_version-arm64",
+    "docker:create-manifest-versioned": "cross-var docker manifest create xstoreazurite.azurecr.io/public/azure-storage/azurite:$npm_package_version xstoreazurite.azurecr.io/public/azure-storage/azurite:$npm_package_version-amd64 xstoreazurite.azurecr.io/public/azure-storage/azurite:$npm_package_version-windows-amd64 xstoreazurite.azurecr.io/public/azure-storage/azurite:$npm_package_version-arm64",


Just to check what's the effect after publish the manifest.
With the originally manifest, when user run Azurite docker image without specifying platform, docker will choose the docker image most match the current platform (ARM64 platform will choose AMD64 docker image, AMD64 platform will choose AMD64 docker image). After the windows-amd64 image is added, what will happen when user run Azurite docker image without specifying platform?

The platform is chooses includes the os name, hence it currently throwing an error on windows ( no matching manifest for windows/amd64 in the manifest list entries) adding this image will add that specific platform to the manifest.

With current Azurite release (before the change), I will install AMD64 docker image in my machine (my machine is windows with AMD64).
So after your change, what will happen on different platform/OS?

And for the error, do you mean you will resolve it, or it's already resolved?

If you are running Docker in Windows Container mode (this is an option within Docker-Desktop), with the current release this will throw an error.
After the change, the other platforms will be unaffected (since they will use the linux/amd64 image).

You can view the platform docker is running internally on with docker info -f "{{.OSType}}". For me this gives windows.

Get it. Thanks!

And on my windows machine run docker info -f "{{.OSType}}", will get result "linux".

blueww · 2024-01-04T09:50:12Z

I tried to build windows based image in code space, and meet following error:

@blueww ➜ /workspaces/Azurite (main) $ npm run docker:build-windows-amd64

> [email protected] docker:build-windows-amd64
> cross-var docker buildx build --platform windows/amd64 --load --no-cache --rm -f "Dockerfile.Windows" -t xstoreazurite.azurecr.io/public/azure-storage/azurite:$npm_package_version-windows-amd64 .

[+] Building 0.8s (2/2) FINISHED                                                                                                                                                                                                                                                  docker:default
 => [internal] load build definition from Dockerfile.Windows                                                                                                                                                                                                                                0.4s
 => => transferring dockerfile: 1.18kB                                                                                                                                                                                                                                                      0.0s
 => [internal] load .dockerignore                                                                                                                                                                                                                                                           0.4s
 => => transferring context: 282B                                                                                                                                                                                                                                                           0.0s
Dockerfile.Windows:34
--------------------
  32 |     # Production image
  33 |     #
  34 | >>> FROM Node-Windows
  35 |     
  36 |     ENV NODE_ENV=productions
--------------------
ERROR: failed to solve: failed to parse stage name "Node-Windows": invalid reference format: repository name must be lowercase

jwdb · 2024-01-04T09:57:50Z

Interesting enough I do not encounter that error when running it locally.
I've changed the Dockerfile for a lowercase stage name.
Also I saw that the Azure pipeline error'ed on the curl, I've added a workdir change to hopefully mitigate that issue.

blueww · 2024-01-04T10:06:15Z

Interesting enough I do not encounter that error when running it locally. I've changed the Dockerfile for a lowercase stage name. Also I saw that the Azure pipeline error'ed on the curl, I've added a workdir change to hopefully mitigate that issue.

If possible, I would suggest you testing the build docker image step in the github code space (it's linux based), and make sure it passes.

jwdb · 2024-01-04T10:17:14Z

It is not possible to build or run a Windows container on a Linux machine, as far as I know there isn't a (proper) way to run Windows on a Github codespace.

Dockerfile.Windows

azure-pipelines.yml

blueww · 2024-12-11T09:23:43Z

It looks the PR check still fail.
And please resolve the conflict.

Adding workdir change to node base image

…ows containers documentation.

…sage on custom entrypoint

jwdb · 2025-01-06T10:08:04Z

The PR Checks succeeded, are there any stoppers left for this PR?

ChangeLog.md

Dockerfile.Windows

blueww · 2025-01-07T10:06:17Z

@XiaoningLiu , @EmmaZhu
Would you please help to review, and see if any potential issue?

blueww · 2025-01-07T10:16:22Z

Dockerfile.Windows

+
+WORKDIR C:\\Node\\node-v20.0.0-win-x64\\
+
+CMD "azurite -l c:/data --blobHost 0.0.0.0 --queueHost 0.0.0.0 --tableHost 0.0.0.0"


The first docker run command sample in Readme file(link) will fail per my test.
It looks the command in line 71 doesn't work.

D:\code\azurite>docker run -p 10000:10000 -p 10001:10001 -p 10002:10002 xstoreazurite.azurecr.io/public/azure-storage/azurite:latest
'"azurite -l c:/data --blobHost 0.0.0.0 --queueHost 0.0.0.0 --tableHost 0.0.0.0' is not recognized as an internal or external command, operable program or batch file.

If we run with customized command like following, it works:

D:\code\azurite>docker run -p 10000:10000 -p 10001:10001 -p 10002:10002 xstoreazurite.azurecr.io/public/azure-storage/azurite:latest azurite --blobHost 0.0.0.0

This should function now again, there is some weird escaping done with the CMD command on Windows containers

blueww · 2025-01-09T03:01:30Z

Thanks @jwdb for the fix!
It work well in my testing. I build the docker image with "npm run docker:build-windows", and run the docker image works well.

@XiaoningLiu , @EmmaZhu,

Would you please help to review and see if the change is good for you?

blueww self-requested a review January 4, 2024 07:47

blueww self-assigned this Jan 4, 2024

blueww reviewed Jan 4, 2024

View reviewed changes

blueww reviewed Jan 8, 2024

View reviewed changes

Dockerfile.Windows Show resolved Hide resolved

blueww reviewed Jan 8, 2024

View reviewed changes

Dockerfile.Windows Outdated Show resolved Hide resolved

jwdb force-pushed the main branch from 0ac3aff to 6ca2744 Compare December 5, 2024 09:50

blueww reviewed Dec 9, 2024

View reviewed changes

azure-pipelines.yml Show resolved Hide resolved

jwdb force-pushed the main branch from d25ea2e to d652f15 Compare December 11, 2024 10:53

jwdb added 13 commits January 6, 2025 08:07

Dockerfile for Windows container

309bdff

Add build scripts to package.json

ec04260

Add build step for windows docker container

f630252

Rename jobname because the name has to be a letter, number or underscore

a132141

changing the Node-Windows stage name to nodewindows.

1bd4dc2

Adding workdir change to node base image

Add cmd to run command to validate docker image in line with the wind…

a26d72f

…ows containers documentation.

upgraded node version used in windows docker builds

ea464f2

Add line between jobs in azure pipelines

220a235

Add github action for docker windows

41a70a0

run no prepare as container administrator

0800f3e

extend permission scope to after installing package

c746f66

chown azurite files within the container

1194a75

use containeradministrator user

12ba46d

jwdb added 2 commits January 6, 2025 08:07

take ownership of files in container

9335fda

Use workdir in npm to work around windows's containers lack of PATH u…

1966b88

…sage on custom entrypoint

jwdb force-pushed the main branch from 551f3c0 to 1966b88 Compare January 6, 2025 07:08

blueww reviewed Jan 7, 2025

View reviewed changes

ChangeLog.md Show resolved Hide resolved

Revert changes to changelog

ea7c480

blueww reviewed Jan 7, 2025

View reviewed changes

Dockerfile.Windows Show resolved Hide resolved

blueww reviewed Jan 7, 2025

View reviewed changes

Dockerfile.Windows Outdated Show resolved Hide resolved

blueww reviewed Jan 7, 2025

View reviewed changes

jwdb added 2 commits January 8, 2025 08:27

Set Path differently, Use node 22 and update to ltsc 2025

823abf6

Downgrade to ltsc 2022

bbbbbc4

blueww approved these changes Jan 9, 2025

View reviewed changes

XiaoningLiu approved these changes Jan 16, 2025

View reviewed changes

blueww merged commit c3f9344 into Azure:main Jan 16, 2025
35 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docker Image on Windows Base Image #439 #2332

Docker Image on Windows Base Image #439 #2332

jwdb commented Jan 3, 2024 •

edited

Loading

jwdb commented Jan 3, 2024

blueww commented Jan 4, 2024 •

edited

Loading

jwdb commented Jan 4, 2024

blueww commented Jan 4, 2024

blueww Jan 4, 2024

jwdb Jan 4, 2024

blueww Jan 4, 2024

jwdb Jan 4, 2024

blueww Jan 4, 2024 •

edited

Loading

blueww commented Jan 4, 2024 •

edited

Loading

jwdb commented Jan 4, 2024

blueww commented Jan 4, 2024 •

edited

Loading

jwdb commented Jan 4, 2024

blueww commented Dec 11, 2024

jwdb commented Jan 6, 2025

blueww commented Jan 7, 2025

blueww Jan 7, 2025 •

edited

Loading

jwdb Jan 8, 2025

blueww commented Jan 9, 2025


		WORKDIR C:\\Node\\node-v20.0.0-win-x64\\

		CMD "azurite -l c:/data --blobHost 0.0.0.0 --queueHost 0.0.0.0 --tableHost 0.0.0.0"

Docker Image on Windows Base Image #439 #2332

Docker Image on Windows Base Image #439 #2332

Conversation

jwdb commented Jan 3, 2024 • edited Loading

PR Branch Destination

Always Add Test Cases

Add Change Log

Development Guideline

jwdb commented Jan 3, 2024

blueww commented Jan 4, 2024 • edited Loading

jwdb commented Jan 4, 2024

blueww commented Jan 4, 2024

blueww Jan 4, 2024

Choose a reason for hiding this comment

jwdb Jan 4, 2024

Choose a reason for hiding this comment

blueww Jan 4, 2024

Choose a reason for hiding this comment

jwdb Jan 4, 2024

Choose a reason for hiding this comment

blueww Jan 4, 2024 • edited Loading

Choose a reason for hiding this comment

blueww commented Jan 4, 2024 • edited Loading

jwdb commented Jan 4, 2024

blueww commented Jan 4, 2024 • edited Loading

jwdb commented Jan 4, 2024

blueww commented Dec 11, 2024

jwdb commented Jan 6, 2025

blueww commented Jan 7, 2025

blueww Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

jwdb Jan 8, 2025

Choose a reason for hiding this comment

blueww commented Jan 9, 2025

jwdb commented Jan 3, 2024 •

edited

Loading

blueww commented Jan 4, 2024 •

edited

Loading

blueww Jan 4, 2024 •

edited

Loading

blueww commented Jan 4, 2024 •

edited

Loading

blueww commented Jan 4, 2024 •

edited

Loading

blueww Jan 7, 2025 •

edited

Loading