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.

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

Default value of ee_base_registry_username is declared as ee_registry_username in README.md when in fact ee_registry_username default value is ee_base_registry_username #133

Open
osiengse opened this issue Oct 19, 2023 · 1 comment
Labels
bug Something isn't working help wanted Extra attention is needed

Comments

@osiengse
Copy link

Summary

Default value of ee_base_registry_username & ee_base_registry_password is declared as ee_registry_username & ee_registry_password in README.md when in fact ee_registry_username & ee_registry_password default value is ee_base_registry_username & ee_base_registry_password

Issue Type

  • Documentation

# Desired Behavior

Default value of ee_base_registry_username and ee_base_registry_password declared in default folder must reflect what has been stated in README.md

# Actual Behavior

Default value of ee_base_registry_username & ee_base_registry_password is declared as ee_registry_username & ee_registry_password in README.md when in fact ee_registry_username & ee_registry_password default value is ee_base_registry_username & ee_base_registry_password

https://github.com/redhat-cop/ee_utilities/blob/763646409558e5ebbd29407768ad96321d518371/roles/ee_builder/README.md?plain=1#L57

[ee_registry_username: "{{ ee_base_registry_username | default(omit, true) }}"](https://github.com/redhat-cop/ee_utilities/blob/763646409558e5ebbd29407768ad96321d518371/roles/ee_builder/defaults/main.yml#L11C1-L11C21)

@sean-m-sullivan
Copy link
Contributor

sean-m-sullivan commented Nov 26, 2023

Sorry I missed this, I've been overwhelmed.

Your PR is not the right solution.

There are few scenarios envisioned.

The most common that the role tries to default to, in this order:

  1. The base image and the destination registry are the same, so they use the same authentication.
    This is why the base user/pass defaults to the ee_registery user/pass, its assuming you are pulling/pushing from/to a galaxy/automation hub

  2. You are pulling the base image from registry.redhat.io, or someplace like a private repository separate from the destionation.
    This means you set the base auth different from the destionation auth, as you cannot write to the base auth

  3. You are pulling from a public repo that doesn't need authentication, so you would set the base user/pass as ""
    This is the least likely scenario, as you are more likely to use ee_update_base_images set to false to not pull base images from the start.

Trying to figure out how to make this better for documentation, but these are the cases its built around, If you have a case that doesn't match these 3, comment here, and can figure out how best to change things. However change the behavior as you've set out would break things for users as is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants