Skip to content
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

Jump to bottom

fix: static credentials Secret generation #717

Merged
merged 4 commits into from
Jun 13, 2024
Merged

fix: static credentials Secret generation #717

merged 4 commits into from
Jun 13, 2024

Conversation

dkoshkin
Copy link
Contributor

What problem does this PR solve?:
While working in this package I was confused why createSecretIfNeeded was called that since it always generated a Secret.
Turns out there was a bug in these files that it never checked if the passed in configs []providerConfig even have static credentials. Added some failing unit tests and fixed the logic to skip generating the Secret and the corresponding file if not needed.
While writing the tests, I also noticed that the templating was not generating valid JSON for multiple registries. To keep that separator logic simple I moved the docker.io alias into Go code.

Which issue(s) this PR fixes:
Fixes #

How Has This Been Tested?:

New unit tests and brought up a Nutanix cluster with docker.io creds.

Special notes for your reviewer:

dkoshkin added 3 commits June 11, 2024 21:30
@dkoshkin
test: add failing tests Secret getting generated for all registries
6637b42
@dkoshkin
fix: correctly handle registries without credentials
5471841 
1. Only generate the Secret if registries have credentials.
2. Correctly format JSON with multiple registries.
@dkoshkin
refactor: rename Secret again
26e453e 
I misunderstood what this Secret is used for because of the bug.
This Secret is only used to hold static credentials.
@dkoshkin dkoshkin requested review from jimmidyson and supershal June 12, 2024 04:44
@dkoshkin dkoshkin self-assigned this Jun 12, 2024
@github-actions github-actions bot added the fix label Jun 12, 2024
@jimmidyson jimmidyson enabled auto-merge (squash) June 12, 2024 08:53
@jimmidyson
Copy link
Member

@dkoshkin Thanks for fixing this! I updated the templating a little to use range index for separator addition rather than do it in the code, all works (no changes to test for that). Hope you're ok with that change.

@jimmidyson jimmidyson merged commit 3247b87 into main Jun 13, 2024
17 checks passed
@jimmidyson jimmidyson deleted the dkoshkin/fix-credentials-secret-generation branch June 13, 2024 15:48
@github-actions github-actions bot mentioned this pull request Jun 13, 2024
Merged
faiq pushed a commit that referenced this pull request Jun 24, 2024
@jimmidyson @github-actions
release(main): v0.10.0 (#685)
2d2a3f7 
🤖 I have created a release *beep* *boop*
---


## 0.10.0 (2024-06-24)

<!-- Release notes generated using configuration in .github/release.yaml
at main -->

## What's Changed
### Exciting New Features 🎉
* feat: Upgrade to Cilium v1.15.5 by @jimmidyson in
#689
* feat: Upgrade to Calico v3.28.0 by @jimmidyson in
#688
* feat: bumps caaph to v0.2.3 by @faiq in
#691
* feat: Add local-path-provisioner CSI by @jimmidyson in
#693
* feat: cluster-api v1.7.3 by @jimmidyson in
#714
* feat: bumps caaph to 0.2.4 by @faiq in
#718
* feat: Controller that copies ClusterClasses to namespaces by
@dlipovetsky in
#715
* feat: adds a mindthegap container and deployment by @faiq in
#637
* feat: implements BeforeClusterUpgrade hook by @faiq in
#682
### Fixes 🔧
* fix: use external Nutanix API types directly by @dkoshkin in
#698
* fix: Post-process clusterconfig CRDs for supported CSI providers by
@jimmidyson in
#695
* fix: nutanix credentials Secrets owner refs by @dkoshkin in
#711
* fix: credential provider response secret ownership by @dkoshkin in
#709
* fix: static credentials Secret generation by @dkoshkin in
#717
* fix: set ownerReference on imageRegistry and globalMirror Secrets by
@dkoshkin in
#720
* fix: Allow Nutanix CSI snapshot controller & webhook to run on CP
nodes by @dlipovetsky in
#723
* refactor: Use maps for CSI providers and storage classes by
@jimmidyson in
#696
* fix: CredentialProviderConfig matchImages to support registries with
port by @dkoshkin in
#724
* fix: Allow Node Feature Discovery garbage collector to run on
control-plane nodes by @dlipovetsky in
#722
* fix: RBAC role for namespace-sync controller to watch,list namespaces
by @dkoshkin in
#738
* fix: image registries not handling CA certificates by @dkoshkin in
#729
* fix: adds a docker buildx step before release-snapshot by @faiq in
#741
### Other Changes
* docs: Add released version to helm and clusterctl install by
@jimmidyson in
#683
* revert: Temporary lint config fix until next golangci-lint release
(#629) by @jimmidyson in
#686
* refactor: Delete unused code by @jimmidyson in
#687
* refactor: Reduce log verbosity for skipped handlers by @jimmidyson in
#692
* build: update Go to 1.22.4 by @dkoshkin in
#700
* build(deps): Upgrade CAPX version to v1.4.0 by @thunderboltsid in
#707
* build: Move CSI supported provider logic to script by @jimmidyson in
#703
* build: Add testifylint linter by @jimmidyson in
#706
* build: Update all tools by @jimmidyson in
#704
* refactor: rename credential provider response secret by @dkoshkin in
#710
* refactor: Simplify code by using slices.Clone by @jimmidyson in
#712
* refactor: consistently use the same SetOwnerReference function by
@dkoshkin in
#713
* refactor: kube-vip commands by @dkoshkin in
#699
* build: Fix an incorrect make variable passed to goreleaser by
@dlipovetsky in
#716
* build: Add 'chart-docs' make target by @dlipovetsky in
#727
* build: Make CAREN mindthegap reg multiarch by @jimmidyson in
#730
* Add helm values schema plugin by @dlipovetsky in
#728
* test(e2e): Use mesosphere fork with CRSBinding fix by @jimmidyson in
#736

## New Contributors
* @thunderboltsid made their first contribution in
#707

**Full Changelog**:
v0.9.0...v0.10.0

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@faiq faiq faiq approved these changes

@jimmidyson jimmidyson jimmidyson approved these changes

@supershal supershal Awaiting requested review from supershal

Assignees

@dkoshkin dkoshkin

Labels
fix
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dkoshkin @jimmidyson @faiq