cli: rename global namespace flag #1887
Conversation
This change is an RFC to discuss the proposal to rename the global namespace flag exposed in osm cli, which reflects the control plane namespace. The reason to do so is because local command flags could also expose a namespace flag, which don't show up in the help text for the command. Moreover, the global namespace flag isn't used by several commands (ex. osm metrics, osm proxy etc.). The proposal is to rename the global flag to represent OSM's namespace to `osm-namespace` so that local commands wanting to expose `namespace` as a flag can do so with command specific description. Part of openservicemesh#1884
Codecov Report
@@ Coverage Diff @@
## main #1887 +/- ##
==========================================
- Coverage 58.53% 58.32% -0.21%
==========================================
Files 129 129
Lines 5265 5265
==========================================
- Hits 3082 3071 -11
- Misses 2180 2191 +11
Partials 3 3
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
I like this change a lot. Makes it much more clear what namespace means. I have been wondering whether we really need this flag on every command. If that is overkill, we should add it per command rather than globally. It seems like we use to it to target a control plane but I'm wondering if that is even necessary since we now ensure mesh name is unique to the cluster.
Very valid point you have there. I considered removing this global flag altogether, then noticed several cli commands are leveraging it via the |
I might have missed cleaning up something, is there any documentation in particular that needs to reflect this? |
|
@shashankram - nvm just thought there might be some --namespace references in the manual demo guide but there isn't. |
There was a problem hiding this comment.
The CLI help text just needs to be updated. https://github.com/openservicemesh/osm/blob/main/cmd/cli/install.go#L35-L38
@michelleN it already is in this PR: https://github.com/openservicemesh/osm/pull/1887/files#diff-4afa5892801237e567fde7607da3a3923912b6cffb91cb33e0df10a9e6d4bb95R35 |
shashankram
changed the title
Those use the local command flags. |
This change is an RFC to discuss the proposal to rename the global namespace flag exposed in osm cli, which reflects the control plane namespace. The reason to do so is because local command flags could also expose a namespace flag, which don't show up in the help text for the command. Moreover, the global namespace flag isn't used by several commands (ex. osm metrics, osm proxy etc.). The proposal is to rename the global flag to represent OSM's namespace to `osm-namespace` so that local commands wanting to expose `namespace` as a flag can do so with command specific description. Part of openservicemesh#1884
Description:
This change is an RFC to discuss the proposal
to rename the global namespace flag exposed in
osm cli, which reflects the control plane namespace.
The reason to do so is because local command flags
could also expose a namespace flag, which don't
show up in the help text for the command. Moreover,
the global namespace flag isn't used by several
commands (ex. osm metrics, osm proxy etc.).
The proposal is to rename the global flag to represent
OSM's namespace to
osm-namespaceso that localcommands wanting to expose
namespaceas a flag cando so with command specific description.
Part of #1884
Affected area:
Please answer the following questions with yes/no.
No