Create a persistent password shouldn't point to sample method

[davidfowl]

https://github.com/dotnet/docs-aspire/blob/main/docs/fundamentals/persist-data-volumes.md#create-a-persistent-password

Creating a persistent password should show how to set the parameter value and not show these helper extension methods.

Instead, we should show how to set parameter values named appropriately:

We should document all of the resources that generate passwords, and we should talk about the parameter names for those generated passwords. We should also show how you can set the passwords without changing any code.

• Postgres
• SqlServer
• MySql
• RabbitMq

For example:

var builder = DistributedApplication.CreateBuilder(args);

var db = builder.AddSqlServer("sql").AddDatabase("db");

builder.AddProject<Projects.WebApplication10>("api")
       .WithExternalHttpEndpoints()
       .WithReference(db);

builder.Build().Run();

You can set a persistent password for sqlserver by setting the parameter value in user secrets in the AppHost project:

dotnet user-secrets add Parameters:sql-password {somepassword}

This will override the auto generated password used by the sql server resources above. The pattern for auto generated password parameters is Parameters:{resourcename}-password.

cc @eerhardt

---

Associated WorkItem - 250486

[eerhardt]

I believe @DamianEdwards's intention with this code was that when you don't dotnet user-secrets add ... and just run the app you get an error. People were confused and thought that the app was broken. So the thinking was to "just make it work".

[davidfowl]

Sure but we shouldn't document it, that's a sample. We should just tell people to set the user secret.

[theo-albers]

We should document all of the resources that generate passwords, and we should talk about the parameter names for those generated passwords.

Would it be possible to dump the used environment variables to the console via a config switch *)? That way you wouldn't have to document it, disconnected from the code.

*) dump the name with a brief description, not the actual values.

[davidfowl]

I think that's an unrelated feature request.

[tmds]

I found this issue while looking for any issues about the Create a persistent password section.

Currently this section shows some code and it's not clear how Aspire would be using the samplepassword value.

[rmarinho]

Yeah I hitted this myself doing the eShop workshop to get familiar with aspire. I did tried to add as Parameter but then it said it didn't found it on my settings.

[rudivs]

Just to mention, the correct command to set the persistent password is:

dotnet user-secrets set Parameters:sql-password {somepassword}

If you don't have user secrets configured yet, you first need to run:

dotnet user-secrets init

[davidfowl]

Good call out. The apphost should have a user secrets id set from preview 5 onwards (so it should be init-ed already).