helm_registry_auth module to authenticate in OCI registry #800

yurnov · 2024-11-29T14:11:08Z

SUMMARY

The new module helm_registry_auth module support login and logout to OCI registry (helm registry login and helm registry logout command)

It's addressed issue #578

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

helm_registry_auth

ADDITIONAL INFORMATION

Similar was started as #601 but it wasn't completed for a while. Module in this PR is already used in my lab environment.

PR include a changelog, documentation and integration tests.

softwarefactory-project-zuul · 2024-11-29T14:21:43Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/cd7947bfd4ad4d1c8ff85986c5f0a096

✔️ ansible-galaxy-importer SUCCESS in 2m 55s
✔️ build-ansible-collection SUCCESS in 5m 24s

softwarefactory-project-zuul · 2024-11-29T14:41:58Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/c1a99a3d283d4c4484bd9eec54fdd0aa

✔️ ansible-galaxy-importer SUCCESS in 3m 51s
✔️ build-ansible-collection SUCCESS in 6m 47s

softwarefactory-project-zuul · 2024-11-29T15:18:16Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/93abfc76ba7d4e0f8317000f47396c10

✔️ ansible-galaxy-importer SUCCESS in 4m 52s
✔️ build-ansible-collection SUCCESS in 5m 51s

softwarefactory-project-zuul · 2024-11-29T15:34:56Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/e45be249a77f422fb801f9e4d05e7089

✔️ ansible-galaxy-importer SUCCESS in 3m 55s
✔️ build-ansible-collection SUCCESS in 5m 54s

softwarefactory-project-zuul · 2024-11-29T15:58:39Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/4f898c5e04824576ba38e7abd20e5eee

✔️ ansible-galaxy-importer SUCCESS in 4m 17s
✔️ build-ansible-collection SUCCESS in 6m 25s

softwarefactory-project-zuul · 2024-11-29T16:15:30Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/1fbcd5fd5d5e408a8855eba16e541244

✔️ ansible-galaxy-importer SUCCESS in 4m 36s
✔️ build-ansible-collection SUCCESS in 5m 19s

yurnov · 2024-11-29T16:15:39Z

Hi @gravesm @abikouo,

it seems that Kubevirt tests failed for a reason that is not related to this PR. Could you please check? And also review this PR.

to fix linters in actions

unit test was missing initially

softwarefactory-project-zuul · 2024-12-10T17:52:06Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/76a6d9b10b2e49c9a6a12fb395771854

✔️ ansible-galaxy-importer SUCCESS in 5m 28s
✔️ build-ansible-collection SUCCESS in 5m 43s

changelogs/fragments/20241116-helm_registry_auth.yaml

plugins/modules/helm_registry_auth.py

remove changlog fragment

softwarefactory-project-zuul · 2024-12-11T15:10:29Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/b5eb38dd59674698bf011a226083e7d0

✔️ ansible-galaxy-importer SUCCESS in 4m 27s
✔️ build-ansible-collection SUCCESS in 5m 53s

plugins/modules/helm_registry_auth.py

plugins/module_utils/helm.py

plugins/modules/helm_registry_auth.py

Co-authored-by: Bikouo Aubin <[email protected]>

softwarefactory-project-zuul · 2024-12-12T11:59:03Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/5b88e17cdd4343a897534ccc3fda3a39

✔️ ansible-galaxy-importer SUCCESS in 3m 57s
✔️ build-ansible-collection SUCCESS in 5m 25s

abikouo · 2024-12-12T14:44:02Z

@yurnov, another thing: integration tests are not running because the following file is missing: tests/integration/targets/helm_registry_auth/aliases. Please add it with the following content: time=16. It seems this is the estimated time for the target to run.

yurnov · 2024-12-12T14:58:54Z

@yurnov, another thing: integration tests are not running because the following file is missing: tests/integration/targets/helm_registry_auth/aliases. Please add it with the following content: time=16. It seems this is the estimated time for the target to run.

Done

softwarefactory-project-zuul · 2024-12-12T15:15:36Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/65b2da53666f4c16bd22190ab823c482

✔️ ansible-galaxy-importer SUCCESS in 3m 50s
✔️ build-ansible-collection SUCCESS in 5m 20s

softwarefactory-project-zuul · 2024-12-12T15:25:20Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/4e3503cd41284ce987cacc31a5000822

✔️ ansible-galaxy-importer SUCCESS in 2m 54s
✔️ build-ansible-collection SUCCESS in 5m 54s

yurnov · 2024-12-12T15:40:17Z

Finally, integration test fixed

softwarefactory-project-zuul · 2024-12-12T15:50:47Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/02b3422cb6584ae6be240a20e092e6c3

✔️ ansible-galaxy-importer SUCCESS in 4m 27s
✔️ build-ansible-collection SUCCESS in 5m 17s

Goal is to bring c8a33c7 into helm_login

softwarefactory-project-zuul · 2024-12-14T07:43:05Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/577e8f9280a04b638c719fff73a353d1

✔️ ansible-galaxy-importer SUCCESS in 3m 25s
✔️ build-ansible-collection SUCCESS in 5m 40s

yurnov · 2024-12-14T09:11:32Z

Merged main to PR to bring #827 (fix for helm tests)

abikouo · 2024-12-17T11:00:50Z

@yurnov CI is stable now, could you please rebase your PR and address merge conflicts? Thanks

this commit bring a fix for the integration text merged witin the PR ansible-collections#830

yurnov · 2024-12-17T11:20:48Z

@yurnov CI is stable now, could you please rebase your PR and address merge conflicts? Thanks

Sure, I just did this.

Thanks for your valuable help. May I ask you also to review PR #831 and add a skip-changelog label as it trivial documendation-only change?

softwarefactory-project-zuul · 2024-12-17T11:27:48Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/35a46b4b27b24ff5b5fc6696b4423581

✔️ ansible-galaxy-importer SUCCESS in 3m 10s
✔️ build-ansible-collection SUCCESS in 5m 37s

…ollections#830

softwarefactory-project-zuul · 2024-12-17T11:48:04Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/974c76bdafe841b692967f986af59d42

✔️ ansible-galaxy-importer SUCCESS in 2m 54s
✔️ build-ansible-collection SUCCESS in 5m 21s

patchback · 2024-12-17T14:39:46Z

Backport to stable-5: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-5/aee847431af7e96dce5bb0f2b14adaf150813db8/pr-800

Backported as #836

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

* new module helm_registry_auth * Initial integration tests * final update copyright and integration test before pr * update link to pr in changelog fragment * reformat plugins/module_utils/helm.py with black to fix linters in actions * attempt to fix unit test unit test was missing initially * fix https://pycqa.github.io/isort/ linter * next attemp to fix unit-test * remove unused and unsupported helm_args_common * remove unused imports and fix other linters errors * another fix for unit test * fix issue introducied by commit ff02893 * add binary_path to arg_spec * return helm_cmd in the output of check mode remove changlog fragment * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * remove changed from module return Co-authored-by: Bikouo Aubin <[email protected]> * remove redundant code Co-authored-by: Bikouo Aubin <[email protected]> * Update plugins/modules/helm_registry_auth.py Co-authored-by: Bikouo Aubin <[email protected]> * consider support of logout when user is not logged in Co-authored-by: Bikouo Aubin <[email protected]> * consider support helm < 3.0.0 * Revert "consider support helm < 3.0.0" This reverts commit f20004d. * reintroduce support of helm version less than 3.8.0 reference: https://helm.sh/docs/topics/registries/#enabling-oci-support-prior-to-v380 * revert reintroducing support of helm < 3.8.0 reason: didn't find a quick way to deal with tests * update documentation with the recent module updates * Update plugins/modules/helm_registry_auth.py Co-authored-by: Bikouo Aubin <[email protected]> * add test of logout impendency Co-authored-by: Bikouo Aubin <[email protected]> * fix linters * fix intendations in the integration tests * create tests/integration/targets/helm_registry_auth/aliases * fix integration test (typo) * fix integration tests (test wrong cred) * add stderr when module fail * another attempt to fix integration test * fix assertion in integration test to be not affceted by the #830 --------- Co-authored-by: Bikouo Aubin <[email protected]> (cherry picked from commit aee8474)

* new module helm_registry_auth * Initial integration tests * final update copyright and integration test before pr * update link to pr in changelog fragment * reformat plugins/module_utils/helm.py with black to fix linters in actions * attempt to fix unit test unit test was missing initially * fix https://pycqa.github.io/isort/ linter * next attemp to fix unit-test * remove unused and unsupported helm_args_common * remove unused imports and fix other linters errors * another fix for unit test * fix issue introducied by commit ff02893 * add binary_path to arg_spec * return helm_cmd in the output of check mode remove changlog fragment * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * description suggestion from reviewer/maintainer Co-authored-by: Bikouo Aubin <[email protected]> * remove changed from module return Co-authored-by: Bikouo Aubin <[email protected]> * remove redundant code Co-authored-by: Bikouo Aubin <[email protected]> * Update plugins/modules/helm_registry_auth.py Co-authored-by: Bikouo Aubin <[email protected]> * consider support of logout when user is not logged in Co-authored-by: Bikouo Aubin <[email protected]> * consider support helm < 3.0.0 * Revert "consider support helm < 3.0.0" This reverts commit f20004d. * reintroduce support of helm version less than 3.8.0 reference: https://helm.sh/docs/topics/registries/#enabling-oci-support-prior-to-v380 * revert reintroducing support of helm < 3.8.0 reason: didn't find a quick way to deal with tests * update documentation with the recent module updates * Update plugins/modules/helm_registry_auth.py Co-authored-by: Bikouo Aubin <[email protected]> * add test of logout impendency Co-authored-by: Bikouo Aubin <[email protected]> * fix linters * fix intendations in the integration tests * create tests/integration/targets/helm_registry_auth/aliases * fix integration test (typo) * fix integration tests (test wrong cred) * add stderr when module fail * another attempt to fix integration test * fix assertion in integration test to be not affceted by the #830 --------- Co-authored-by: Bikouo Aubin <[email protected]> (cherry picked from commit aee8474) Co-authored-by: Yuriy Novostavskiy <[email protected]>

yurnov added 13 commits December 10, 2024 17:38

new module helm_registry_auth

0a3f7c7

Initial integration tests

a79ee9d

final update copyright and integration test before pr

88b80dd

update link to pr in changelog fragment

b15ea2c

reformat plugins/module_utils/helm.py with black

82f00df

to fix linters in actions

attempt to fix unit test

187efa0

unit test was missing initially

fix https://pycqa.github.io/isort/ linter

b1421bc

next attemp to fix unit-test

8c2d17e

remove unused and unsupported helm_args_common

68ba05d

remove unused imports and fix other linters errors

65641ba

another fix for unit test

ef29dc9

fix issue introducied by commit ff02893

bbe2dc5

add binary_path to arg_spec

61c6926

yurnov force-pushed the helm_login branch from f85a56b to 61c6926 Compare December 10, 2024 17:40

yurnov mentioned this pull request Dec 10, 2024

Release versions 3.3.0 and 5.1.0 #813

Closed

32 tasks

gravesm reviewed Dec 11, 2024

View reviewed changes

changelogs/fragments/20241116-helm_registry_auth.yaml Outdated Show resolved Hide resolved

plugins/modules/helm_registry_auth.py Outdated Show resolved Hide resolved

return helm_cmd in the output of check mode

a6100bc

remove changlog fragment

gravesm added the skip-changelog label Dec 11, 2024

abikouo requested changes Dec 11, 2024

View reviewed changes

yurnov and others added 2 commits December 11, 2024 18:36

description suggestion from reviewer/maintainer

f2d507a

Co-authored-by: Bikouo Aubin <[email protected]>

description suggestion from reviewer/maintainer

dedfc3c

Co-authored-by: Bikouo Aubin <[email protected]>

fix intendations in the integration tests

92ca518

create tests/integration/targets/helm_registry_auth/aliases

ee66a9b

fix integration test (typo)

9350a44

fix integration tests (test wrong cred)

b91c777

yurnov added 2 commits December 12, 2024 15:29

add stderr when module fail

ced6ffd

another attempt to fix integration test

f13429f

abikouo approved these changes Dec 12, 2024

View reviewed changes

abikouo added the test-all-the-targets In order to tell to the integration test splitter to test all targets label Dec 13, 2024

Merge branch 'main' into helm_login

a80fb34

Goal is to bring c8a33c7 into helm_login

abikouo added the backport-5 label Dec 17, 2024

Merge remote-tracking branch 'upstream/main' into helm_login

099b57e

this commit bring a fix for the integration text merged witin the PR ansible-collections#830

fix assertion in integration test to be not affceted by the ansible-c…

5f48d1b

…ollections#830

abikouo merged commit aee8474 into ansible-collections:main Dec 17, 2024
56 checks passed

patchback bot mentioned this pull request Dec 17, 2024

[PR #800/aee84743 backport][stable-5] helm_registry_auth module to authenticate in OCI registry #836

Merged

helm_registry_auth module to authenticate in OCI registry #800

helm_registry_auth module to authenticate in OCI registry #800

Uh oh!

Conversation

yurnov commented Nov 29, 2024

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

Uh oh!

softwarefactory-project-zuul bot commented Nov 29, 2024

Uh oh!

softwarefactory-project-zuul bot commented Nov 29, 2024

Uh oh!

softwarefactory-project-zuul bot commented Nov 29, 2024

Uh oh!

softwarefactory-project-zuul bot commented Nov 29, 2024

Uh oh!

softwarefactory-project-zuul bot commented Nov 29, 2024

Uh oh!

softwarefactory-project-zuul bot commented Nov 29, 2024

Uh oh!

yurnov commented Nov 29, 2024

Uh oh!

softwarefactory-project-zuul bot commented Dec 10, 2024

Uh oh!

Uh oh!

Uh oh!

softwarefactory-project-zuul bot commented Dec 11, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

softwarefactory-project-zuul bot commented Dec 12, 2024

Uh oh!

abikouo commented Dec 12, 2024

Uh oh!

yurnov commented Dec 12, 2024

Uh oh!

softwarefactory-project-zuul bot commented Dec 12, 2024

Uh oh!

softwarefactory-project-zuul bot commented Dec 12, 2024

Uh oh!

yurnov commented Dec 12, 2024

Uh oh!

softwarefactory-project-zuul bot commented Dec 12, 2024

Uh oh!

softwarefactory-project-zuul bot commented Dec 14, 2024

Uh oh!

yurnov commented Dec 14, 2024

Uh oh!

abikouo commented Dec 17, 2024

Uh oh!

yurnov commented Dec 17, 2024

Uh oh!

softwarefactory-project-zuul bot commented Dec 17, 2024

Uh oh!

softwarefactory-project-zuul bot commented Dec 17, 2024

Uh oh!

Uh oh!

patchback bot commented Dec 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Backport to stable-5: 💚 backport PR created

Uh oh!

Uh oh!

patchback bot commented Dec 17, 2024 •

edited

Loading