Skip to content

Add option to configure the networking stack in docker build #2036

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

Merged
merged 3 commits into from
Apr 29, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions docs/content/en/schemas/v1beta10.json
Original file line number Diff line number Diff line change
Expand Up @@ -632,6 +632,11 @@
"x-intellij-html-description": "locates the Dockerfile relative to workspace.",
"default": "Dockerfile"
},
"network": {
"type": "string",
"description": "passed through to docker and overrides the network configuration of docker builder. If unset, use whatever is configured in the underlying docker daemon. Valid modes are `Host`: use the host's networking stack. `Bridge`: use the bridged network configuration. `None`: no networking in the container.",
"x-intellij-html-description": "passed through to docker and overrides the network configuration of docker builder. If unset, use whatever is configured in the underlying docker daemon. Valid modes are <code>Host</code>: use the host's networking stack. <code>Bridge</code>: use the bridged network configuration. <code>None</code>: no networking in the container."
},
"target": {
"type": "string",
"description": "Dockerfile target name to build.",
Expand All @@ -642,6 +647,7 @@
"dockerfile",
"target",
"buildArgs",
"network",
"cacheFrom"
],
"additionalProperties": false,
Expand Down
6 changes: 6 additions & 0 deletions pkg/skaffold/docker/image.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"fmt"
"io"
"sort"
"strings"
"sync"

"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest"
Expand Down Expand Up @@ -159,6 +160,7 @@ func (l *localDaemon) Build(ctx context.Context, out io.Writer, workspace string
AuthConfigs: authConfigs,
Target: a.Target,
ForceRemove: l.forceRemove,
NetworkMode: a.NetworkMode,
})
if err != nil {
return "", errors.Wrap(err, "docker build")
Expand Down Expand Up @@ -358,5 +360,9 @@ func GetBuildArgs(a *latest.DockerArtifact) []string {
args = append(args, "--target", a.Target)
}

if a.NetworkMode != "" {
args = append(args, "--network", strings.ToLower(a.NetworkMode))
}

return args
}
14 changes: 11 additions & 3 deletions pkg/skaffold/docker/image_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -205,16 +205,24 @@ func TestGetBuildArgs(t *testing.T) {
},
want: []string{"--target", "stage1"},
},
{
description: "network mode",
artifact: &latest.DockerArtifact{
NetworkMode: "Bridge",
},
want: []string{"--network", "bridge"},
},
{
description: "all",
artifact: &latest.DockerArtifact{
BuildArgs: map[string]*string{
"key1": util.StringPtr("value1"),
},
CacheFrom: []string{"foo"},
Target: "stage1",
CacheFrom: []string{"foo"},
Target: "stage1",
NetworkMode: "None",
},
want: []string{"--build-arg", "key1=value1", "--cache-from", "foo", "--target", "stage1"},
want: []string{"--build-arg", "key1=value1", "--cache-from", "foo", "--target", "stage1", "--network", "none"},
},
}
for _, tt := range tests {
Expand Down
8 changes: 8 additions & 0 deletions pkg/skaffold/schema/latest/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -598,6 +598,14 @@ type DockerArtifact struct {
// For example: `{"key1": "value1", "key2": "value2"}`.
BuildArgs map[string]*string `yaml:"buildArgs,omitempty"`

// NetworkMode is passed through to docker and overrides the
// network configuration of docker builder. If unset, use whatever
// is configured in the underlying docker daemon. Valid modes are
// `Host`: use the host's networking stack.
// `Bridge`: use the bridged network configuration.
// `None`: no networking in the container.
NetworkMode string `yaml:"network,omitempty"`

// CacheFrom lists the Docker images used as cache sources.
// For example: `["golang:1.10.1-alpine3.7", "alpine:3.7"]`.
CacheFrom []string `yaml:"cacheFrom,omitempty"`
Expand Down
3 changes: 2 additions & 1 deletion pkg/skaffold/schema/v1beta9/upgrade.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ import (

// Upgrade upgrades a configuration to the next version.
// Config changes from v1beta9 to v1beta10
// 1. No additions
// 1. Additions:
// - DockerArtifact.NetworkMode
// 2. No removals
// 3. No updates
func (config *SkaffoldConfig) Upgrade() (util.VersionedConfig, error) {
Expand Down
23 changes: 22 additions & 1 deletion pkg/skaffold/schema/validation/validation.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,15 @@ import (
"github.com/GoogleContainerTools/skaffold/pkg/skaffold/yamltags"
)

var (
// for testing
validateYamltags = yamltags.ValidateStruct
)

// Process checks if the Skaffold pipeline is valid and returns all encountered errors as a concatenated string
func Process(config *latest.SkaffoldConfig) error {
errs := visitStructs(config, yamltags.ValidateStruct)
errs := visitStructs(config, validateYamltags)
errs = append(errs, validateDockerNetworkMode(config.Build.Artifacts)...)

if len(errs) == 0 {
return nil
Expand All @@ -40,6 +46,21 @@ func Process(config *latest.SkaffoldConfig) error {
return fmt.Errorf(strings.Join(messages, " | "))
}

// validateDockerNetworkMode makes sure that networkMode is one of `Bridge`, `None`, or `Host` if set.
func validateDockerNetworkMode(artifacts []*latest.Artifact) (errs []error) {
for _, a := range artifacts {
if a.DockerArtifact == nil || a.DockerArtifact.NetworkMode == "" {
continue
}
mode := strings.ToLower(a.DockerArtifact.NetworkMode)
if mode == "none" || mode == "bridge" || mode == "host" {
continue
}
errs = append(errs, fmt.Errorf("artifact %s has invalid networkMode '%s'", a.ImageName, mode))
}
return
}

// visitStructs recursively visits all fields in the config and collects errors found by the visitor
func visitStructs(s interface{}, visitor func(interface{}) error) []error {
v := reflect.ValueOf(s)
Expand Down
115 changes: 115 additions & 0 deletions pkg/skaffold/schema/validation/validation_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -251,3 +251,118 @@ func TestVisitStructs(t *testing.T) {
})
}
}

func TestValidateNetworkMode(t *testing.T) {
tests := []struct {
name string
artifacts []*latest.Artifact
shouldErr bool
}{
{
name: "not a docker artifact",
artifacts: []*latest.Artifact{
{
ImageName: "image/bazel",
ArtifactType: latest.ArtifactType{
BazelArtifact: &latest.BazelArtifact{},
},
},
},
},
{
name: "no networkmode",
artifacts: []*latest.Artifact{
{
ImageName: "image/no-network",
ArtifactType: latest.ArtifactType{
DockerArtifact: &latest.DockerArtifact{},
},
},
},
},
{
name: "bridge",
artifacts: []*latest.Artifact{
{
ImageName: "image/bridge",
ArtifactType: latest.ArtifactType{
DockerArtifact: &latest.DockerArtifact{
NetworkMode: "Bridge",
},
},
},
},
},
{
name: "none",
artifacts: []*latest.Artifact{
{
ImageName: "image/none",
ArtifactType: latest.ArtifactType{
DockerArtifact: &latest.DockerArtifact{
NetworkMode: "None",
},
},
},
},
},
{
name: "host",
artifacts: []*latest.Artifact{
{
ImageName: "image/host",
ArtifactType: latest.ArtifactType{
DockerArtifact: &latest.DockerArtifact{
NetworkMode: "Host",
},
},
},
},
},
{
name: "invalid networkmode",
shouldErr: true,
artifacts: []*latest.Artifact{
{
ImageName: "image/bad",
ArtifactType: latest.ArtifactType{
DockerArtifact: &latest.DockerArtifact{
NetworkMode: "Bad",
},
},
},
},
},
{
name: "case insensitive",
artifacts: []*latest.Artifact{
{
ImageName: "image/case-insensitive",
ArtifactType: latest.ArtifactType{
DockerArtifact: &latest.DockerArtifact{
NetworkMode: "bRiDgE",
},
},
},
},
},
}

origValidateYamlTags := validateYamltags
validateYamltags = func(_ interface{}) error { return nil }
defer func() { validateYamltags = origValidateYamlTags }()

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
err := Process(
&latest.SkaffoldConfig{
Pipeline: latest.Pipeline{
Build: latest.BuildConfig{
Artifacts: test.artifacts,
},
},
})
testutil.CheckError(t, test.shouldErr, err)
})
}
}