search

MicrosoftDocs / azure-docs

Open source documentation of Microsoft Azure
https://docs.microsoft.com/azure
Creative Commons Attribution 4.0 International
10.26k stars 21.43k forks source link

Missing documentation around "DOCKER_CUSTOM_IMAGE_NAME" and many other things #120320

Closed SRNissen closed 6 months ago

SRNissen commented 8 months ago

Relevant Azure service or technology

Web app configuration

Link to article

There is no article about this, which is the problem.

Clear, specific feedback that the author can act on

The documentation is missing... Well it's missing a lot of things to be honest but what I was searching for today was DOCKER_CUSTOM_IMAGE_NAME

Etc./ etc./ - this is an incredibly branching tree of "if X then Y?" and I'm sure I'm missing many of the leaf nodes.

But it can be abbreviated to 1 question and two follow ups depending on the answer to that 1 question:

Searching through Learn there are two articles mentioning the value and neither say anything about it except "it exists."

https://learn.microsoft.com/en-us/search/?scope=App%20Service&terms=%22DOCKER_CUSTOM_IMAGE_NAME%22

Really, expand that to: "Where is the full reference documentation for anything in Azure?" How does this platform work? Tutorials are all well and good for playing around and getting things up and running, now how do I build reliable software on top of it?

Tech support and product feedback

Otherwise, you can submit product feedback for most Azure products in the following product feedback forum: https://feedback.azure.com/d365community/forum/79b1327d-d925-ec11-b6e6-000d3a4f06a4

Absolutely not.

First: There are 125 forums with overlapping names, making it impossible to know where you're actually supposed to leave feedback.

Second: For this question, I believe "Web Apps" might be the appropriate site - go to "web apps," sort by newest, then scroll until you find somebody getting an answer to their question. It's more than a year ago (Possibly never but I stopped after reaching "1 year ago")

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

Naveenommi-MSFT commented 8 months ago

@SRNissen Thanks for your feedback! We will investigate and update as appropriate.

btardif commented 6 months ago

please-close this is already explaining in the article:

The image is specified in the property DOCKER_CUSTOM_IMAGE_NAME. When the web app is deployed through Azure DevOps or Azure Resource Manager templates, the image can also appear in a property named LinuxFxVersion. Both properties serve the same purpose. If both are present in the web app's configuration, LinuxFxVersion takes precedence.

What it comes down to is DOCKER_CUSTOM_IMAGE_NAME is an older way to express this configuration and LinuxFxVersion property is the preferred way to do it.

SRNissen commented 6 months ago

this is already explaining in the article:

That answers none of the questions I asked.

btardif commented 6 months ago

@SRNissen the DOCKER_CUSTOM_IMAGE_NAME is under your control. this is an app setting and you can chose to add it to your app or not.

The recommended way to configure this is to use the LinuxFX version.

Changing either LinuxFX version property or DOCKER_CUSTOM_IMAGE_NAME will trigger an app re-start and the app will pull the image based on your configuration....

So if your app is currently using the DOCKER_CUSTOM_IMAGE_NAME property to define the docker image to pull... I would:

1) Update your config to have the image configured using the LinuxFX version (note this will trigger a re-start of the app) 2) Delete the app setting.

SRNissen commented 6 months ago

I feel like I haven't conveyed the issue well enough here.

When you write:

Changing (...) DOCKER_CUSTOM_IMAGE_NAME will trigger an app re-start

Which article would I have had to read to learn that?

That's what this issue is about - where is the actual reference documentation for how the Azure platform works? I cannot find it.

btardif commented 6 months ago

@SRNissen this is an app setting and UX informs about this:

image

But I take your point, I think we can be more explicit in the docs about app setting in general triggering re-starts.

SRNissen commented 6 months ago

Oh you meant in the regular sense that all app settings restart the app, right. I misunderstood, I thought you meant there was something special about DOCKER_CUSTOM_IMAGE_NAME.

On that, though:

But I take your point, I think we can be more explicit in the docs about app setting in general triggering re-starts.

Maybe, maybe not - I knew already from the UI, I just didn't have my head in the right place to understand what you said because I'm specifically thinking about docs.

But "app updates restart the app" is just a special case of the actual issue which is "The functionality of the Azure cloud environment is barely documented"

For example, you say:

The recommended way to configure this is to use the LinuxFX version.

That moves us along to: How does LinuxFxVersion work?

I don't mean "For me and my specific app," I mean for this programmer:

https://github.com/microsoft/azure-pipelines-tasks/issues/14805

Which documentation should that issue's reporter have read ahead of time to have avoided this problem?

To quote the opening message in this issue:

Where is the full reference documentation for anything in Azure?" How does this platform work? Tutorials are all well and good for playing around and getting things up and running, now how do I build reliable software on top of it?

What is the Azure equivalent of reading so much of the ISO C++ standard that you can make useful contributions to cppreference.com?

Does that level of documentation even exist, or can this platform only be learned by experimenting with it?

That is what I opened issue is about. My apologies for mentioning DOCKER_CUSTOM_IMAGE_NAME in the post, it isn't important, it was just the most recent thing I couldn't find documented when I opened the issue.