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

Incorrect and inconsistent resource names #327

Open
lindhe opened this issue Nov 10, 2023 · 0 comments
Open

Incorrect and inconsistent resource names #327

lindhe opened this issue Nov 10, 2023 · 0 comments

Comments

@lindhe
Copy link
Contributor

lindhe commented Nov 10, 2023

I've noticed that the resources have no clear naming convention. This both looks messy and is somewhat misleading. This takes two different forms: incorrect names, inconsistent names and missing (or redundant) names.

Incorrect name suffix

Many non-pod resources has -pod in their names, for example:

name: neuvector-prometheus-exporter-pod-secret

Inconsistent names

Sometimes the short name is used and sometimes the long name:

name: neuvector-service-webui

Being consistent is pretty important, so one can easily grep for names when debugging.

Missing (or redundant) name suffix

Many resources do not have the resource kind as part of their names, for example:

This, however, may not be an actual issue. Why have the resource type in the name at all? It's not necessary, since the type is almost always clear from context. I would argue we should drop the resource kind from the names altogether, since it is evidently hard to maintain this naming scheme consistently for all resources.

But the important point here is that we should be consistent.

lindhe added a commit to lindhe/neuvector-helm that referenced this issue Nov 11, 2023
@lindhe lindhe changed the title Bad naming convention: "pod" in deployment name Incorrect and inconsistent resource type suffix in resource names Nov 15, 2023
@lindhe lindhe changed the title Incorrect and inconsistent resource type suffix in resource names Incorrect and inconsistent resource names Nov 15, 2023
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 a pull request may close this issue.

1 participant