Skip to content

Add UPSTREAM_CLIENT_TYPE user agent environment variable to kaniko pod #2723

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
merged 1 commit into from
Aug 28, 2019
Merged

Add UPSTREAM_CLIENT_TYPE user agent environment variable to kaniko pod #2723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion pkg/skaffold/build/cluster/sources/gcs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import (
"github.com/GoogleContainerTools/skaffold/pkg/skaffold/gcp"
"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest"
"github.com/GoogleContainerTools/skaffold/pkg/skaffold/sources"
"github.com/GoogleContainerTools/skaffold/pkg/skaffold/version"
"github.com/pkg/errors"
v1 "k8s.io/api/core/v1"
)
Expand Down Expand Up @@ -61,7 +62,7 @@ func (g *GCSBucket) Setup(ctx context.Context, out io.Writer, artifact *latest.A

// Pod returns the pod template for this builder
func (g *GCSBucket) Pod(args []string) *v1.Pod {
return podTemplate(g.clusterDetails, g.artifact, args)
return podTemplate(g.clusterDetails, g.artifact, args, version.Get().Version)
}

// ModifyPod does nothing here, since we just need to let kaniko run to completion
Expand Down
3 changes: 2 additions & 1 deletion pkg/skaffold/build/cluster/sources/localdir.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"os"
"path/filepath"

"github.com/GoogleContainerTools/skaffold/pkg/skaffold/version"
"github.com/pkg/errors"
v1 "k8s.io/api/core/v1"

Expand Down Expand Up @@ -86,7 +87,7 @@ func (g *LocalDir) Pod(args []string) *v1.Pod {
Resources: resourceRequirements(g.clusterDetails.Resources),
}

p := podTemplate(g.clusterDetails, g.artifact, args)
p := podTemplate(g.clusterDetails, g.artifact, args, version.Get().Version)
p.Spec.InitContainers = []v1.Container{ic}
p.Spec.Containers[0].VolumeMounts = append(p.Spec.Containers[0].VolumeMounts, vm)
p.Spec.Volumes = append(p.Spec.Volumes, v)
Expand Down
3 changes: 3 additions & 0 deletions pkg/skaffold/build/cluster/sources/localdir_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ func TestPod(t *testing.T) {
env := []v1.EnvVar{{
Name: "GOOGLE_APPLICATION_CREDENTIALS",
Value: "/secret/kaniko-secret",
}, {
Name: "UPSTREAM_CLIENT_TYPE",
Value: "UpstreamClient(skaffold-)",
}}
reqs := &latest.ResourceRequirements{
Requests: &latest.ResourceRequirement{
Expand Down
9 changes: 8 additions & 1 deletion pkg/skaffold/build/cluster/sources/sources.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package sources

import (
"context"
"fmt"
"io"

v1 "k8s.io/api/core/v1"
Expand Down Expand Up @@ -53,10 +54,16 @@ func Retrieve(cli *kubectl.CLI, clusterDetails *latest.ClusterDetails, artifact
}
}

func podTemplate(clusterDetails *latest.ClusterDetails, artifact *latest.KanikoArtifact, args []string) *v1.Pod {
func podTemplate(clusterDetails *latest.ClusterDetails, artifact *latest.KanikoArtifact, args []string, version string) *v1.Pod {
userAgent := fmt.Sprintf("UpstreamClient(skaffold-%s)", version)

env := []v1.EnvVar{{
Name: "GOOGLE_APPLICATION_CREDENTIALS",
Value: "/secret/kaniko-secret",
}, {
// This should be same https://github.com/GoogleContainerTools/kaniko/blob/77cfb912f3483c204bfd09e1ada44fd200b15a78/pkg/executor/push.go#L49
Name: "UPSTREAM_CLIENT_TYPE",
Value: userAgent,
}}

env = setProxy(clusterDetails, env)
Expand Down
14 changes: 13 additions & 1 deletion pkg/skaffold/build/cluster/sources/sources_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ func TestPodTemplate(t *testing.T) {
Env: []v1.EnvVar{{
Name: "GOOGLE_APPLICATION_CREDENTIALS",
Value: "/secret/kaniko-secret",
}, {
Name: "UPSTREAM_CLIENT_TYPE",
Value: "UpstreamClient(skaffold-test)",
}},
VolumeMounts: []v1.VolumeMount{{
Name: "kaniko-secret",
Expand Down Expand Up @@ -99,6 +102,9 @@ func TestPodTemplate(t *testing.T) {
Env: []v1.EnvVar{{
Name: "GOOGLE_APPLICATION_CREDENTIALS",
Value: "/secret/kaniko-secret",
}, {
Name: "UPSTREAM_CLIENT_TYPE",
Value: "UpstreamClient(skaffold-test)",
}},
VolumeMounts: []v1.VolumeMount{
{
Expand Down Expand Up @@ -163,6 +169,9 @@ func TestPodTemplate(t *testing.T) {
Env: []v1.EnvVar{{
Name: "GOOGLE_APPLICATION_CREDENTIALS",
Value: "/secret/kaniko-secret",
}, {
Name: "UPSTREAM_CLIENT_TYPE",
Value: "UpstreamClient(skaffold-test)",
}},
VolumeMounts: []v1.VolumeMount{{
Name: "kaniko-secret",
Expand Down Expand Up @@ -208,6 +217,9 @@ func TestPodTemplate(t *testing.T) {
Env: []v1.EnvVar{{
Name: "GOOGLE_APPLICATION_CREDENTIALS",
Value: "/secret/kaniko-secret",
}, {
Name: "UPSTREAM_CLIENT_TYPE",
Value: "UpstreamClient(skaffold-test)",
}},
VolumeMounts: []v1.VolumeMount{{
Name: "kaniko-secret",
Expand Down Expand Up @@ -244,7 +256,7 @@ func TestPodTemplate(t *testing.T) {

for _, test := range tests {
testutil.Run(t, test.description, func(t *testutil.T) {
actual := podTemplate(test.initial, test.artifact, test.args)
actual := podTemplate(test.initial, test.artifact, test.args, "test")

t.CheckDeepEqual(test.expected, actual, opt)
})
Expand Down