You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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.
The text was updated successfully, but these errors were encountered:
lindhe
added a commit
to lindhe/neuvector-helm
that referenced
this issue
Nov 11, 2023
lindhe
changed the title
Bad naming convention: "pod" in deployment name
Incorrect and inconsistent resource type suffix in resource names
Nov 15, 2023
lindhe
changed the title
Incorrect and inconsistent resource type suffix in resource names
Incorrect and inconsistent resource names
Nov 15, 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:neuvector-helm/charts/core/templates/updater-cronjob.yaml
Line 11 in 0d0faff
neuvector-helm/charts/core/templates/scanner-deployment.yaml
Line 9 in 0d0faff
neuvector-helm/charts/core/templates/enforcer-daemonset.yaml
Line 9 in 0d0faff
neuvector-helm/charts/monitor/templates/secret.yaml
Line 5 in 0d0faff
Inconsistent names
Sometimes the short name is used and sometimes the long name:
neuvector-helm/charts/core/templates/controller-service.yaml
Line 5 in 0d0faff
neuvector-helm/charts/core/templates/manager-service.yaml
Line 5 in 0d0faff
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:
neuvector-helm/charts/core/templates/serviceaccount-least.yaml
Line 5 in 0d0faff
neuvector-helm/charts/core/templates/rolebinding.yaml
Line 14 in 0d0faff
neuvector-helm/charts/core/templates/pvc.yaml
Line 6 in 0d0faff
neuvector-helm/charts/core/templates/clusterrolebinding-least.yaml
Line 14 in 0d0faff
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.
The text was updated successfully, but these errors were encountered: