Skip to content

feat: implement kaniko.imagePullSecret for pulling images from private registry w/ auth #9665

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
alphanota merged 9 commits into from
Jan 15, 2025
Merged

feat: implement kaniko.imagePullSecret for pulling images from private registry w/ auth #9665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0cf18ce
feat: add config option kaniko.imagePullSecret
dherges Dec 21, 2024
6f5fe9e
feat: pull kaniko images from private registry w/ pull secret
dherges Dec 21, 2024
ad28434
test: verify pod spec for kaniko.imagePullSecret
dherges Dec 21, 2024
da5ec48
format test
alphanota Jan 14, 2025
671c6a1
Merge branch 'GoogleContainerTools:main' into feat/kaniko-imagepullse…
alphanota Jan 14, 2025
485fb4f
Merge branch 'GoogleContainerTools:main' into feat/kaniko-imagepullse…
alphanota Jan 15, 2025
3ab685d
add period to end of ImagePullSecret description
alphanota Jan 15, 2025
a29eb3b
regenerate v4beta12 schema
alphanota Jan 15, 2025
12833d7
fix indentation with gofmt
alphanota Jan 15, 2025
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-v2/content/en/schemas/v4beta12.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2763,6 +2763,11 @@
"description": "specify a file to save the image name with digest of the built image to.",
"x-intellij-html-description": "specify a file to save the image name with digest of the built image to."
},
"imagePullSecret": {
"type": "string",
"description": "name of the Kubernetes secret for pulling kaniko image and kaniko init image from a private registry.",
"x-intellij-html-description": "name of the Kubernetes secret for pulling kaniko image and kaniko init image from a private registry."
},
"initImage": {
"type": "string",
"description": "image used to run init container which mounts kaniko context.",
Expand Down Expand Up @@ -2929,6 +2934,7 @@
"target",
"initImage",
"image",
"imagePullSecret",
"destination",
"digestFile",
"imageFSExtractRetry",
Expand Down
7 changes: 7 additions & 0 deletions pkg/skaffold/build/cluster/pod.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,13 @@ func (b *Builder) kanikoPodSpec(artifact *latest.KanikoArtifact, tag string, pla
addSecretVolume(pod, kaniko.DefaultSecretName, b.ClusterDetails.PullSecretMountPath, b.ClusterDetails.PullSecretName)
}

// Add secret for pulling kaniko images from a private registry
if artifact.ImagePullSecret != "" {
pod.Spec.ImagePullSecrets = []v1.LocalObjectReference{{
Name: artifact.ImagePullSecret,
}}
}

// Add host path volume for cache
if artifact.Cache != nil && artifact.Cache.HostPath != "" {
addHostPathVolume(pod, kaniko.DefaultCacheDirName, kaniko.DefaultCacheDirMountPath, artifact.Cache.HostPath)
Expand Down
10 changes: 7 additions & 3 deletions pkg/skaffold/build/cluster/pod_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,9 +181,10 @@ func TestKanikoArgs(t *testing.T) {

func TestKanikoPodSpec(t *testing.T) {
artifact := &latest.KanikoArtifact{
Image: "image",
DockerfilePath: "Dockerfile",
InitImage: "init/image",
Image: "image",
DockerfilePath: "Dockerfile",
InitImage: "init/image",
ImagePullSecret: "image-pull-secret",
Destination: []string{
"gcr.io/foo/bar:test-1",
"gcr.io/foo/bar:test-2",
Expand Down Expand Up @@ -353,6 +354,9 @@ func TestKanikoPodSpec(t *testing.T) {
},
},
}},
ImagePullSecrets: []v1.LocalObjectReference{{
Name: "image-pull-secret",
}},
ServiceAccountName: "aVerySpecialSA",
SecurityContext: &v1.PodSecurityContext{
RunAsUser: &runAsUser,
Expand Down
3 changes: 3 additions & 0 deletions pkg/skaffold/schema/latest/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1471,6 +1471,9 @@ type KanikoArtifact struct {
// Defaults to the latest released version of `gcr.io/kaniko-project/executor`.
Image string `yaml:"image,omitempty"`

// ImagePullSecret is the name of the Kubernetes secret for pulling kaniko image and kaniko init image from a private registry.
ImagePullSecret string `yaml:"imagePullSecret,omitempty"`

// Destination is additional tags to push.
Destination []string `yaml:"destination,omitempty"`

Expand Down