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

Document Entra ID and new Azure API pattern for Redis, PostgreSQL, and SQLServer #1704

Closed
eerhardt opened this issue Sep 27, 2024 · 0 comments · Fixed by #1867
Closed

Document Entra ID and new Azure API pattern for Redis, PostgreSQL, and SQLServer #1704

eerhardt opened this issue Sep 27, 2024 · 0 comments · Fixed by #1867
Assignees
Labels
doc-enhancement Improve the current content [org][type][category] documentation Improvements or additions to documentation in-pr okr-freshness OKR: Freshness of content Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest. 📦 release-9.0 Used to track doc updates for release 9.0 of .NET Aspire.
Milestone

Comments

@eerhardt
Copy link
Member

eerhardt commented Sep 27, 2024

Describe the issue or suggestion

With supporting Microsoft Entra ID in Redis and PostgreSQL we needed to introduce a new API pattern for working with these resources that can be either locally in a container or as Azure managed resources.

  1. The existing [Publish]AsAzureRedis and [Publish]AsAzurePostgresFlexibleServer methods are marked Obsolete
  2. New AddAzureRedis and AddAzurePostgresFlexibleServer methods are introduced for when you want an Azure resource.
    1. These methods configure Entra ID by default instead of using secrets.
    2. To use them in your app, you need to configure managed identity in your app. See
      1. https://github.com/Azure/Microsoft.Azure.StackExchangeRedis
      2. https://devblogs.microsoft.com/dotnet/using-postgre-sql-with-dotnet-and-entra-id/
    3. To continue using password and access key auth - new WithAccessKeyAuth/WithPasswordAuth methods can be invoked.
  3. To use a non-Azure container locally, a new RunAsContainer method can be called.

For more information:


Associated WorkItem - 340205

@eerhardt eerhardt added the 📦 release-9.0 Used to track doc updates for release 9.0 of .NET Aspire. label Sep 27, 2024
@dotnetrepoman dotnetrepoman bot added the ⌚ Not Triaged Not triaged label Sep 27, 2024
@IEvangelist IEvangelist added this to the 9.0 milestone Oct 21, 2024
@IEvangelist IEvangelist self-assigned this Nov 4, 2024
@IEvangelist IEvangelist added documentation Improvements or additions to documentation 🗺️ reQUEST Triggers an issue to be imported into Quest. Pri1 High priority, do before Pri2 and Pri3 doc-enhancement Improve the current content [org][type][category] okr-freshness OKR: Freshness of content labels Nov 4, 2024
@dotnetrepoman dotnetrepoman bot added 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. and removed 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. labels Nov 4, 2024
@IEvangelist IEvangelist added 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. and removed ⌚ Not Triaged Not triaged labels Nov 4, 2024
@dotnetrepoman dotnetrepoman bot removed the 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. label Nov 4, 2024
IEvangelist added a commit that referenced this issue Nov 4, 2024
@sequestor sequestor bot added 📌 seQUESTered Identifies that an issue has been imported into Quest. and removed 🗺️ reQUEST Triggers an issue to be imported into Quest. labels Nov 5, 2024
IEvangelist added a commit that referenced this issue Nov 11, 2024
IEvangelist added a commit that referenced this issue Nov 12, 2024
* Initial bits...WIP, early draft

* Add draft SDK content

* A few more bits

* SDK

* Tons of updates, additions, removals, and whatnot.

* Sweeping updates

* Fix links

* Initial parts of eventing

* Fix a few build issues

* More issues

* Add eventing to TOC

* Added txt for console output

* Eventing API content, getting closer

* A bit more clean up

* Fix hosting meilisearch

* More SDK updates

* More SDK clarification

* index tweaks

* Try using uppercase slug

* Fix publish API

* Add zones to upgrade

* Some breaking changes

* More links to API change

* Add API removal text

* TOC updates

* More breaking changes and fix podman

* Trying a few things with the TOC

* Generate the breaking-changes

* Clean up

* Add AI metadata

* Fix TOC

* Add a few more bits for the upgrade content

* Fix lightbox attribute

* Missing attribute

* New line

* Edit pass

* Upgrade quickstart to .NET Aspire 9.0, and update some dashboard images

* Update dashboard bits, images, and add actions section

* Fix link, no troubleshooting

* More resource action updates

* Remove edges

* Fixes #1823

* Add details for app host lifecylce

* Demote alert

* Edit pass

* Edit pass and additions.

* Edit pass and highlighting

* Let's see how far we've come

* Lots of updates

* Move a few things

* Added error

* Remove discards.

* Apply suggestions from code review

Co-authored-by: Safia Abdalla <safia@safia.rocks>

* Additional feedback

* Fix learn site issue reporting.

* Fix link...

* Fixes #2003

* Edit pass on explore dashboard

* More clean up

* Add details for WaitFor/Completion APIs.

* Fixes from build report.

* Remove snippets for Functions

* Update overview.md

* Update dotnet-aspire-sdk.md

* Update eventing.md

* Update eventing.md

* Update docs/app-host/eventing.md

* Add Ollama integration updates.

* Fix headings and sections

* Lots of updates and fixes

* Upgrade a few more bits, quickstart and setup/tooling

* Fix build

* Additions, version fixes, etc.

* Clean up some of the image/diagrams

* Fixing updated APIs

* Added a few bits to address #1704

* Addresses #2004

* Apply suggestions from code review

Co-authored-by: Aaron Powell <me@aaron-powell.com>

* Fix broken link

* Rewrite the toolkit overview. Update some images

* Remove images

* Fix link and minor edits

* Move Azure Cache for Redis to the bottom

* Fix MD lint

* Edit pass on the Orleans content. Also, fixes #1818

* Move Azure PostgreSQL bits to the bottom of the page

* Try fixing the zones

* Fix MD lint error

* Fix more broken zones

* Add see also section

* Setup and tooling TOC updates

* Re-order TOC

* Update docs/app-host/eventing.md

* Updates for the tutorial on adding Aspire to existing app

* Repurpose RC1, redirects, edit pass, links, etc.

* Fix the TOC

* Edit pass and cleanup of explore and what's new in .NET Aspire 9

* Added custom command article

* Add to TOC

* Fix #2016, update to latest templates

* Fix #2022

* A bit of container love

* A bit more clean up

* Be more consistent with references to NuGet packages

* Fix #2027

* Fix regex replace. :|

* Fix #2026

* Apply suggestions from code review

Co-authored-by: Aaron Powell <me@aaron-powell.com>

* A few bits of peer feedback

* Some fixes related to #2024

* Fix #2017

* Apply suggestions from code review

Co-authored-by: Jose Perez Rodriguez <joperezr@microsoft.com>

* Fix suggestion

* Update docs/fundamentals/aspire-sdk-templates.md

Co-authored-by: Jose Perez Rodriguez <joperezr@microsoft.com>

* A few peer bits of feedback

* Fix (update) create new project images

* Fix include and delete legacy media

* Isolate to selection, readd media

* Fix #1993

* A few more bits of cleanup

* Remove .NET Aspire SDK as a prereq

* A few bits of additional context.

* More links

* Tidy

* Consistent sentence

* Bump DOTNET_VERSION

* Remove install of workload

---------

Co-authored-by: Safia Abdalla <safia@safia.rocks>
Co-authored-by: Mitch Denny <midenn@microsoft.com>
Co-authored-by: Aaron Powell <me@aaron-powell.com>
Co-authored-by: Jose Perez Rodriguez <joperezr@microsoft.com>
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in dotnet/docs November 2024 sprint Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement Improve the current content [org][type][category] documentation Improvements or additions to documentation in-pr okr-freshness OKR: Freshness of content Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest. 📦 release-9.0 Used to track doc updates for release 9.0 of .NET Aspire.
Projects
No open projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

2 participants