-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
allow reference to existing secret as imagePullSecret #7657
Merged
caseydavenport
merged 2 commits into
projectcalico:master
from
ozdanborne:helm-reference-image-pull-secret
May 25, 2023
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| package charttest | ||
|
|
||
| import ( | ||
| "os/exec" | ||
| "testing" | ||
|
|
||
| "github.com/onsi/ginkgo/reporters" | ||
| "github.com/projectcalico/calico/libcalico-go/lib/testutils" | ||
|
|
||
| . "github.com/onsi/ginkgo" | ||
| . "github.com/onsi/gomega" | ||
| ) | ||
|
|
||
| func init() { | ||
| testutils.HookLogrusForGinkgo() | ||
| } | ||
|
|
||
| func TestHelm(t *testing.T) { | ||
| // testutils.HookLogrusForGinkgo() | ||
| RegisterFailHandler(Fail) | ||
| junitReporter := reporters.NewJUnitReporter("../../report/helm_suite.xml") | ||
|
|
||
| _, err := exec.LookPath("helm") | ||
| if err != nil { | ||
| t.Skip("skipping exec tests since 'helm' is not installed") | ||
| } | ||
|
|
||
| RunSpecsWithDefaultAndCustomReporters(t, "Helm Suite", []Reporter{junitReporter}) | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| // Package charttest uses 'helm template' to render the helm package with various input values, | ||
| // unmarshals the resulting yaml into kubernetes resource types, and then tests that the correct fields | ||
| // are set accordingly. | ||
| package charttest | ||
|
|
||
| import ( | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| corev1 "k8s.io/api/core/v1" | ||
|
|
||
| "github.com/gruntwork-io/terratest/modules/helm" | ||
|
|
||
| . "github.com/onsi/gomega" | ||
| ) | ||
|
|
||
| func TestTigeraOperatorHelmChart(t *testing.T) { | ||
| t.Run("image pull secrets", func(t *testing.T) { | ||
| t.Run("using toplevel config field", func(t *testing.T) { | ||
| opts := &helm.Options{ | ||
| SetValues: map[string]string{ | ||
| "imagePullSecrets.my-secret": "secret1", | ||
| }, | ||
| } | ||
|
|
||
| t.Run("sets imagePullSecrets on serviceaccount", func(t *testing.T) { | ||
| g := NewWithT(t) | ||
| var serviceAccount corev1.ServiceAccount | ||
| err := renderChartResource(t, opts, "templates/tigera-operator/02-serviceaccount-tigera-operator.yaml", &serviceAccount) | ||
| g.Expect(err).To(HaveOccurred()) | ||
| g.Expect(serviceAccount.ImagePullSecrets).To(ConsistOf( | ||
| corev1.LocalObjectReference{Name: "my-secret"}, | ||
| )) | ||
| }) | ||
|
|
||
| t.Run("creates a secret", func(t *testing.T) { | ||
| g := NewWithT(t) | ||
| var secret corev1.Secret | ||
| err := renderChartResource(t, opts, "templates/tigera-operator/01-imagepullsecret.yaml", &secret) | ||
| g.Expect(err).To(HaveOccurred()) | ||
| g.Expect(secret.Name).To(Equal("my-secret")) | ||
| g.Expect(secret.Data).To(Equal(map[string][]byte{ | ||
| ".dockerconfigjson": []byte("secret1"), | ||
| })) | ||
| }) | ||
| }) | ||
|
|
||
| t.Run("using installation's config field", func(t *testing.T) { | ||
| opts := &helm.Options{ | ||
| SetValues: map[string]string{ | ||
| "installation.imagePullSecrets[0].name": "my-secret", | ||
| }, | ||
| } | ||
|
|
||
| t.Run("sets imagePullSecrets on serviceaccount", func(t *testing.T) { | ||
| g := NewWithT(t) | ||
| var serviceAccount corev1.ServiceAccount | ||
| err := renderChartResource(t, opts, "templates/tigera-operator/02-serviceaccount-tigera-operator.yaml", &serviceAccount) | ||
| g.Expect(err).To(HaveOccurred()) | ||
| g.Expect(serviceAccount.ImagePullSecrets).To(ConsistOf( | ||
| corev1.LocalObjectReference{Name: "my-secret"}, | ||
| )) | ||
| }) | ||
|
|
||
| t.Run("does not create a secret", func(t *testing.T) { | ||
| g := NewWithT(t) | ||
| // assert an error occured. no other way to assert "file was not rendered" | ||
| err := renderChartResource(t, opts, "templates/tigera-operator/01-imagepullsecret.yaml", &corev1.Secret{}) | ||
| g.Expect(err).To(HaveOccurred()) | ||
| }) | ||
| }) | ||
|
|
||
| t.Run("using both toplevel and installation fields", func(t *testing.T) { | ||
| opts := &helm.Options{ | ||
| SetValues: map[string]string{ | ||
| "imagePullSecrets.secret-1": "secret1", | ||
| "installation.imagePullSecrets[0].name": "secret-2", | ||
| }, | ||
| } | ||
|
|
||
| t.Run("sets both imagePullSecrets on serviceaccount", func(t *testing.T) { | ||
| g := NewWithT(t) | ||
| var serviceAccount corev1.ServiceAccount | ||
| err := renderChartResource(t, opts, "templates/tigera-operator/02-serviceaccount-tigera-operator.yaml", &serviceAccount) | ||
| g.Expect(err).ToNot(HaveOccurred()) | ||
| g.Expect(serviceAccount.ImagePullSecrets).To(ConsistOf( | ||
| corev1.LocalObjectReference{Name: "secret-1"}, | ||
| corev1.LocalObjectReference{Name: "secret-2"}, | ||
| )) | ||
| }) | ||
|
|
||
| t.Run("only creates a secret for the toplevel secret", func(t *testing.T) { | ||
| g := NewWithT(t) | ||
| var secret corev1.Secret | ||
| err := renderChartResource(t, opts, "templates/tigera-operator/01-imagepullsecret.yaml", &secret) | ||
| g.Expect(err).ToNot(HaveOccurred()) | ||
| g.Expect(secret.Name).To(Equal("secret-1")) | ||
| g.Expect(secret.Data).To(Equal(map[string][]byte{ | ||
| ".dockerconfigjson": []byte("secret1"), | ||
| })) | ||
| }) | ||
| }) | ||
| }) | ||
| } | ||
|
|
||
| func renderChartResource(t *testing.T, options *helm.Options, templatePath string, into any) error { | ||
| helmChartPath, err := filepath.Abs("../tigera-operator") | ||
| Expect(err).ToNot(HaveOccurred()) | ||
|
|
||
| output, err := helm.RenderTemplateE(t, options, helmChartPath, "tigera-operator", []string{templatePath}) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| helm.UnmarshalK8SYaml(t, output, &into) | ||
| return nil | ||
| } |
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
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
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
8 changes: 1 addition & 7 deletions
8
charts/tigera-operator/templates/tigera-operator/02-serviceaccount-tigera-operator.yaml
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,6 @@ | ||
| {{ $secrets := list }} | ||
| {{ range $name := keys .Values.imagePullSecrets -}} | ||
| {{ $item := dict "name" $name }} | ||
| {{ $secrets = append $secrets $item }} | ||
| {{ end }} | ||
|
|
||
| apiVersion: v1 | ||
| kind: ServiceAccount | ||
| metadata: | ||
| name: tigera-operator | ||
| namespace: {{.Release.Namespace}} | ||
| imagePullSecrets: {{- $secrets | toYaml | nindent 2 }} | ||
| imagePullSecrets: {{- include "tigera-operator.imagePullSecrets" . | nindent 2 }} |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suppose if a secret is defined in both places we'll get an error back from k8s?
This is probably OK, although I can definitely imagine users trying to put a secret in both places.