Skip to content

Commit

Permalink
add preperatory 3.0 release notes, and update the authentication docs…
Browse files Browse the repository at this point in the history
… to highlight the correct state of the world
  • Loading branch information
baronfel committed Jan 17, 2023
1 parent cb428eb commit c63821f
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 8 deletions.
14 changes: 8 additions & 6 deletions docs/RegistryAuthentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,20 @@ The following registries have been explicitly tested:
* GitLab Container Registry
* Google Cloud Artifact Registry
* Quay.io
* AWS Elastic Container Registry
* GitHub Package Registry
* Docker Hub*

## Known-unsupported registries

* Docker Hub
* needs changes to the code to differentiate between pushing to a local daemon and the remote hub
* AWS Elastic Container Registry
* blob upload is canceled by ECR, unknown reason
* GitHub Package Registry
* blob upload is canceled by the registry, unknown reason
None! We're compatible with most registries.

## Notes for specific registries

### Azure Container Registry

When authenticating to an Azure Container Registry, at this moment only authentication with an admin username and password is supported. This is the same as running `az acr login -n <registry> -u <username> -p <password>`. Token-based login, like `az acr login -n <registry>` is not supported yet.

### Docker Hub

When using Docker Hub as a base image registry (via ContainerBaseImage) or as the destination registry for pushing your images, you must use the `registry-1.docker.io` domain name instead of `docker.io`. The `docker.io` domain does not respond to the Registry API in the expected way.
13 changes: 13 additions & 0 deletions docs/ReleaseNotes/v0.3.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Microsoft.NET.Build.Containers v0.2.0

This is the third public release of the .NET SDK containerization feature. This version brings support for

* [Supplying more than one container tag via the ContainerTags property](https://github.com/dotnet/sdk-container-builds/pull/239)
* More resilient pushes thanks to [retry support](https://github.com/dotnet/sdk-container-builds/pull/256) and [request chunking](https://github.com/dotnet/sdk-container-builds/pull/258)
* [Authentication to Amazon Elastic Container Service Registries](https://github.com/dotnet/sdk-container-builds/pull/279)
* [Authentication to registries whose authentication servers are on different domains](https://github.com/dotnet/sdk-container-builds/pull/286)
* [Authentication to Google Cloud Artifact Registry and Container Registry](https://github.com/dotnet/sdk-container-builds/pull/287)
* [Support for more RIDs than just `linux-x64`](https://github.com/dotnet/sdk-container-builds/pull/247)
* Enhanced support for rootless containers

To start containerizing your projects, see our [Getting Started](http://github.com/dotnet/sdk-container-builds/blob/main/docs/GettingStarted.md) docs.
4 changes: 2 additions & 2 deletions packaging/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ This package lets you build container images from your projects with a single co
## Getting Started

To build a container from the SDK, add this package and run the `publish` command,
specifying the `DefaultContainer` PublishProfile. You can learn more about Publish Profiles [in the documentation](https://docs.microsoft.com/aspnet/core/host-and-deploy/visual-studio-publish-profiles?view=aspnetcore-6.0#publish-profiles).
specifying the `DefaultContainer` PublishProfile. You can learn more about Publish Profiles [in the documentation](https://learn.microsoft.com/aspnet/core/host-and-deploy/visual-studio-publish-profiles?view=aspnetcore-6.0#publish-profiles).

```shell
>dotnet add package Microsoft.NET.Build.Containers --prerelease
>dotnet add package Microsoft.NET.Build.Containers
>dotnet publish --os linux --arch x64 -p:PublishProfile=DefaultContainer
...
Pushed container '<your app name>:<your app version>' to registry 'docker://'
Expand Down

0 comments on commit c63821f

Please sign in to comment.