Skip to content

feat: add docker build network option to azure.yaml #7361

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.

Sign up for GitHub

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

Merged
spboyer merged 6 commits into from
Apr 2, 2026
Merged

feat: add docker build network option to azure.yaml #7361

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
286748d
feat: add docker build network option to azure.yaml
spboyer Mar 27, 2026
d05ae4e
Add Network field to gRPC proto and mapper
spboyer Mar 31, 2026
6cc2bfe
Regenerate models.pb.go with protoc for Network field
spboyer Mar 31, 2026
6e8e72e
Add Network field coverage to mapper tests
spboyer Apr 1, 2026
2026f46
Fix staticcheck SA5011 false positives in tests
spboyer Apr 1, 2026
3f5bdf7
Fix staticcheck SA5011: use require.NotNil for fluent builder test
spboyer Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cli/azd/grpc/proto/models.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ message DockerProjectOptions {
string tag = 7;
bool remote_build = 8;
repeated string build_args = 9;
string network = 10;
}

// ServiceContext defines the shared pipeline state across all phases of the service lifecycle
Expand Down
8 changes: 8 additions & 0 deletions cli/azd/pkg/azdext/models.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions cli/azd/pkg/project/container_helper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,7 @@ func (ch *ContainerHelper) Build(
resolvedBuildArgs,
dockerOptions.BuildSecrets,
dockerEnv,
dockerOptions.Network,
previewerWriter,
)
ch.console.StopPreviewer(ctx, false)
Expand Down
1 change: 1 addition & 0 deletions cli/azd/pkg/project/framework_service_docker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ type DockerProjectOptions struct {
Image osutil.ExpandableString `yaml:"image,omitempty" json:"image"`
Tag osutil.ExpandableString `yaml:"tag,omitempty" json:"tag"`
RemoteBuild bool `yaml:"remoteBuild,omitempty" json:"remoteBuild,omitempty"`
Network string `yaml:"network,omitempty" json:"network,omitempty"`
Comment thread
spboyer marked this conversation as resolved.
BuildArgs []osutil.ExpandableString `yaml:"buildArgs,omitempty" json:"buildArgs,omitempty"`
// not supported from azure.yaml directly yet. Adding it for Aspire to use it, initially.
// Aspire would pass the secret keys, which are env vars that azd will set just to run docker build.
Expand Down
3 changes: 3 additions & 0 deletions cli/azd/pkg/project/mapper_registry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@ func registerProjectMappings() {
Tag: tag,
RemoteBuild: src.RemoteBuild,
BuildArgs: buildArgs,
Network: src.Network,
Comment thread
spboyer marked this conversation as resolved.
}, nil
})

Expand Down Expand Up @@ -413,6 +414,7 @@ func registerProjectMappings() {
Image: osutil.NewExpandableString(src.Image),
Tag: osutil.NewExpandableString(src.Tag),
RemoteBuild: src.RemoteBuild,
Network: src.Network,
}

if len(src.BuildArgs) > 0 {
Expand Down Expand Up @@ -440,6 +442,7 @@ func registerProjectMappings() {
Image: osutil.NewExpandableString(src.Image),
Tag: osutil.NewExpandableString(src.Tag),
RemoteBuild: src.RemoteBuild,
Network: src.Network,
}

if len(src.BuildArgs) > 0 {
Expand Down
1 change: 1 addition & 0 deletions cli/azd/pkg/tools/docker/acceptance/acceptance_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ func Test_DockerAcceptance(t *testing.T) {
buildArgs,
buildSecrets,
buildEnv,
"",
&buildOutput,
)
require.NoError(t, err, "build should succeed")
Expand Down
5 changes: 5 additions & 0 deletions cli/azd/pkg/tools/docker/docker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ func (d *Cli) Build(
buildArgs []string,
buildSecrets []string,
buildEnv []string,
buildNetwork string,
buildProgress io.Writer,
) (string, error) {
if strings.TrimSpace(platform) == "" {
Expand Down Expand Up @@ -105,6 +106,10 @@ func (d *Cli) Build(
args = append(args, "--target", target)
}

if buildNetwork != "" {
args = append(args, "--network", buildNetwork)
}

if tagName != "" {
args = append(args, "-t", tagName)
}
Expand Down
68 changes: 65 additions & 3 deletions cli/azd/pkg/tools/docker/docker_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ func Test_DockerBuild(t *testing.T) {
buildArgs,
nil,
nil,
"",
nil,
)

Expand Down Expand Up @@ -131,6 +132,7 @@ func Test_DockerBuild(t *testing.T) {
buildArgs,
nil,
nil,
"",
nil,
)

Expand Down Expand Up @@ -188,7 +190,7 @@ func Test_DockerBuildEmptyPlatform(t *testing.T) {
})

result, err := docker.Build(
context.Background(), cwd, dockerFile, "", "", dockerContext, imageName, buildArgs, nil, nil, nil)
context.Background(), cwd, dockerFile, "", "", dockerContext, imageName, buildArgs, nil, nil, "", nil)

require.Equal(t, true, ran)
require.Nil(t, err)
Expand Down Expand Up @@ -237,7 +239,7 @@ func Test_DockerBuildArgsEmpty(t *testing.T) {
})

result, err := docker.Build(
context.Background(), cwd, dockerFile, "", "", dockerContext, imageName, buildArgs, nil, nil, nil)
context.Background(), cwd, dockerFile, "", "", dockerContext, imageName, buildArgs, nil, nil, "", nil)

require.Equal(t, true, ran)
require.Nil(t, err)
Expand Down Expand Up @@ -288,13 +290,73 @@ func Test_DockerBuildArgsMultiple(t *testing.T) {
})

result, err := docker.Build(
context.Background(), cwd, dockerFile, "", "", dockerContext, imageName, buildArgs, nil, nil, nil)
context.Background(), cwd, dockerFile, "", "", dockerContext, imageName, buildArgs, nil, nil, "", nil)

require.Equal(t, true, ran)
require.Nil(t, err)
require.Equal(t, mockedDockerImgId, result)
}

func Test_DockerBuildNetwork(t *testing.T) {
tests := []struct {
name string
network string
expectIn bool
}{
{"WithHostNetwork", "host", true},
{"WithEmptyNetwork", "", false},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ran := false
cwd := "."
dockerFile := "./Dockerfile"
dockerContext := "../"
imageName := "IMAGE_NAME"

mockContext := mocks.NewMockContext(context.Background())
docker := NewCli(mockContext.CommandRunner)

mockContext.CommandRunner.When(func(args exec.RunArgs, command string) bool {
return strings.Contains(command, "docker build")
}).RespondFn(func(args exec.RunArgs) (exec.RunResult, error) {
ran = true

argsNoFile := args.Args[:len(args.Args)-2]
value := args.Args[len(args.Args)-1]

if tt.expectIn {
require.Contains(t, argsNoFile, "--network")
require.Contains(t, argsNoFile, tt.network)
} else {
require.NotContains(t, argsNoFile, "--network")
}

err := os.WriteFile(value, []byte(mockedDockerImgId), 0600)
require.NoError(t, err)

return exec.RunResult{
Stdout: mockedDockerImgId,
ExitCode: 0,
}, nil
})

result, err := docker.Build(
context.Background(),
cwd, dockerFile, "", "",
dockerContext, imageName,
nil, nil, nil,
tt.network, nil,
)

require.True(t, ran)
require.NoError(t, err)
require.Equal(t, mockedDockerImgId, result)
})
}
}

func Test_DockerTag(t *testing.T) {
cwd := "."
imageName := "image-name"
Expand Down
5 changes: 5 additions & 0 deletions schemas/alpha/azure.yaml.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -957,6 +957,11 @@
"type": "string"
}
},
"network": {
"type": "string",
"title": "Optional. The networking mode for RUN instructions during docker build",
"description": "Sets the networking mode for RUN instructions during build. Passed as --network to docker build. For example, use 'host' to allow the build container to access the host network."
},
"remoteBuild": {
"type": "boolean",
"title": "Optional. Whether to build the image remotely",
Expand Down
5 changes: 5 additions & 0 deletions schemas/v1.0/azure.yaml.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -863,6 +863,11 @@
"type": "string"
}
},
"network": {
"type": "string",
"title": "Optional. The networking mode for RUN instructions during docker build",
"description": "Sets the networking mode for RUN instructions during build. Passed as --network to docker build. For example, use 'host' to allow the build container to access the host network."
},
"remoteBuild": {
"type": "boolean",
"title": "Optional. Whether to build the image remotely",
Expand Down
Loading