Enhance azd init to auto-detect Dockerfile ARGS and update azure.yaml
#4639
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Menghua1
requested review from
ellismg,
wbreza,
vhvb1989,
hemarina,
weikanglim and
JeffreyCA
as code owners
Azure Dev CLI Install InstructionsInstall scriptsMacOS/Linux
bash: pwsh: WindowsPowerShell install MSI install Standalone Binary
MSI
Documentationlearn.microsoft.com documentationtitle: Azure Developer CLI reference
|
1 task
ellismg
reviewed
Jan 11, 2025
| if strings.HasPrefix(line, "ARG ") { | ||
| argLine := strings.TrimPrefix(line, "ARG ") | ||
| if len(argLine) > 0 { | ||
| buildArgs = append(buildArgs, osutil.NewExpandableString(argLine)) |
There was a problem hiding this comment.
I wonder if creating an osutil.ExpandableString here is the right thing? I think that we probably just want to use string (or maybe a structured type that contains the arg name and optional default value). I don't think you'd ever want to call Envsubst or MustEnvsubst on this value since the docker language doesn't think about doing env-var substitution for ARGs.
For the docs, it looks like the ARG directive in a dockerfile could look like this:
ARG foo=${BAR}Which from my understanding would mean an argument called "foo" with the default value of ${BAR}.
I'm a little worried that when faced with a file like this, we'd end up doing the wrong thing end to end (but I will admit that from the linked issue, I also don't have a great idea of what the expectation is here either).
There was a problem hiding this comment.
@ellismg The use of the osutil.ExpandableString type to store buildArgs is to populate the buildArgs configuration in the azure.yaml file. Later, when parsing the azure.yaml file, Envsubst() will be used to replace the environment variable of arg in buildArgs.
For the ARG instruction ARG foo=${BAR} in the Dockerfile, the underlying processing flow of Azd is as follows:
-
If the
fooarg is not configured in thebuildArgsin azure.yaml, the bottom layer finally runs thedocker build .command to build the project. Since--build-arg foois not specified, the value offoois the defined default value${BAR}. -
If the
fooarg is configured inbuildArgsin azure.yaml:- When the value of the arg
foois hardcode, the Azd bottom layer will build the project by running the commanddocker build . --build-arg foo=xxxxxx. - When the value of the arg
foois the environment variable${AZURE_BAR}, the environment variable is replaced with the corresponding value, and the Azd bottom layer will finally build the project by runningdocker build . --build-arg foo=xxxxxx.
- When the value of the arg
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix issue #4606, this PR adds automatic detection of ARG parameters in Dockerfiles during
azd init.When a user runs
azd initto initialize an existing application as an azd project, the command will now scan the Dockerfile, identify all defined ARG parameters, and automatically populate them into thebuildArgssection of the generatedazure.yamlfile.@rajeshkamal5050 for notification.