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

Filter Naming Scheme #291

Closed
XAMPPRocky opened this issue Jun 4, 2021 · 5 comments · Fixed by #484
Closed

Filter Naming Scheme #291

XAMPPRocky opened this issue Jun 4, 2021 · 5 comments · Fixed by #484
Labels
area/filters Related to Quilkin's filter API. kind/design Proposal discussing new features / fixes and how they should be implemented priority/high Issues that should be addressed as soon as possible.

Comments

@XAMPPRocky
Copy link
Collaborator

XAMPPRocky commented Jun 4, 2021

I think now that the extensions/filters directory changes we'll need to update this along the current filters' names to fit the new scheme…

Originally posted by @iffyio in #286 (comment)

@XAMPPRocky
Copy link
Collaborator Author

Right now I'm thinking of something along the lines of the following, I think the main question is where to put the version in the name, assuming we do want to version filters independently from quilkin. I'm personally leaning towards having the version as a prefix rather than suffix.

quilkin.filters.v1alpha1.compress
// or
quilkin.filters.compress.v1alpha1

@markmandel
Copy link
Member

I'm more inclined towards quilkin.filters.v1alpha1.compress (it's what Envoy does), for whatever reason it reads better to my eyes.

@XAMPPRocky
Copy link
Collaborator Author

You say "more inclined", but your statement is in agreement with what I proposed. It's the current IDs where the version string is a suffix to the filter module (e.g. quilkin.extensions.filters.debug_filter.v1alpha1.Debug)

@markmandel
Copy link
Member

You say "more inclined", but your statement is in agreement with what I proposed. It's the current IDs where the version string is a suffix to the filter module (e.g. quilkin.extensions.filters.debug_filter.v1alpha1.Debug)

Oh that's a good point. I didn't read it like that. Yes. I agree - quilkin.extensions.filters.debug_filter.v1alpha1.Debug is the one I like 😄

@XAMPPRocky XAMPPRocky added area/filters Related to Quilkin's filter API. kind/design Proposal discussing new features / fixes and how they should be implemented labels Jul 5, 2021
@XAMPPRocky XAMPPRocky added this to the Release milestone Jul 5, 2021
@XAMPPRocky XAMPPRocky added the priority/high Issues that should be addressed as soon as possible. label Jul 5, 2021
@iffyio
Copy link
Collaborator

iffyio commented Jul 7, 2021

quilkin.extensions.filters.debug_filter.v1alpha1.Debug SGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/filters Related to Quilkin's filter API. kind/design Proposal discussing new features / fixes and how they should be implemented priority/high Issues that should be addressed as soon as possible.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants