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

Update the auth flags for registering repositories #3101

Merged
merged 1 commit into from
May 6, 2022

Conversation

mortent
Copy link
Contributor

@mortent mortent commented May 6, 2022

We will eventually add support for other auth types than just basic auth. Therefore we need a convention for how we name the flags used for authentication against package repositories. This updates the current flags to follow the following convention:

  • Flags used the format: repo-<auth type>-<input>
    • Every flag use the repo- prefix to make it clear it pertains to repository auth (rather than cluster) and to avoid conflicts with existing flags we inherit from kubectl (examples are username and password).
    • The auth type section tells which type of authentication this flag is used for. Currently we only support basic auth.
    • The last part contains the name of data needed for the specified auth type. For example, for basic auth, we need username and password.

Following this convention, the flags for specifying username and password for basic auth results in the flags repo-basic-username and repo-basic-password.

@mortent mortent requested a review from martinmaly May 6, 2022 18:06
Copy link
Contributor

@martinmaly martinmaly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the name is a bit long but better start with accurate (albeit long) name than not. We can evolve as needed.

@mortent mortent merged commit c61877e into kptdev:main May 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants