odo preference - cleanup

[kadel]

there should be the following set of subcommands for odo preference command

• odo preference set - sets value for single value item (UpdateNotification, Timeout, PushTimeout, RegistryCacheTime, Ephemeral, ConsentTelemetry) (Preference cleanup (1/n) #5822 )
• odo preference unset - unsets value (restores it to default) for single value item (UpdateNotification, Timeout, PushTimeout, RegistryCacheTime, Ephemeral, ConsentTelemetry) (Preference cleanup (1/n) #5822 )
• odo preference add - adds value to array items (registry) (Add preference add and remove commands #5873 )
• odo preference remove - removes value from array items (registry) (Add preference add and remove commands #5873 )
• odo preference view - view all preferences, and move registry list to view (Update preference view to show list of devfile registries #5850)
• review name of the preference items, if needed rename it and add description (Preference cleanup (1/n) #5822 )
• Drop odo preference registry update; if needed, user can always remove and add registry (Remove odo preference registry update command #5853)

examples

$ odo preference set ConsentTelemetry true

Value of 'ConsentTelemetry' preference was set to 'true'

$ odo preference unset ConsentTelemetry

Value of 'ConsentTelemetry' was removed from preferences. Its default value will be used.

$ odo preference add registry StagingRegistry https://registry.stage.devfile.io```

New Devfile registry was added to odo.

$ odo preference remove registry StagingRegistry

Devfile registry 'StagingRegistry' was removed from odo.

$ odo preference view

Preference parameters:
PARAMETER             VALUE
UpdateNotification    true (default)
Timeout               
PushTimeout           
RegistryCacheTime     
Ephemeral             
ConsentTelemetry      false


Devfile registries:
NAME                       URL                                   
StagingRegistry            https://registry.stage.devfile.io     
DefaultDevfileRegistry     https://registry.devfile.io           
``

[dharmit]

[ ] odo preference set - sets value for single value item (UpdateNotification, Timeout, PushTimeout, RegistryCacheTime, Ephemeral, ConsentTelemetry)

We have been using int for all timeouts so far. I suggest using time.Duration for it. We can use DurationVar instead of IntVar from cobra point of view. Two benefits that I can think of by doing this:

• Not having to convert int to time.Duration as the values are now in time.Duration by default.
• Clearer CLI documentation, IMO. For example, odo watch -h from main branch looks like:

  $ odo watch -h
  ....
  --delay int              Time in seconds blah blah blah (default 1)
  ....

  But with --delay being set to DurationVar, here it is:

  $ odo watch -h
  ....
  --delay duration         Time in seconds blah blah blah (default 1s)
  ....

[valaparthvi]

@dharmit, taking your suggestion into account, the commands will look like the following:
odo preference set

$ odo preference set timeout 4m
? timeout is already set. Do you want to override it in the config Yes
Global preference was successfully updated

odo preference view

$ odo preference view           
PARAMETER             CURRENT_VALUE
UpdateNotification    false
Timeout               4m0s
PushTimeout           
RegistryCacheTime     
Ephemeral             
ConsentTelemetry      true

odo preference --help

$ odo preference --help
Modifies odo specific configuration settings within the global preference file.


Available Global Parameters:
 ...
 ...
 Timeout - Timeout (in Duration) for cluster server connection check (Default: 1s)
 ...

...
...
Examples:

  ...
  ...
  # All available preference values you can set
  ...
  odo preference set Timeout 1s
  ...
 ...

Is this what you were going for?

cc: @kadel

[dharmit]

@valaparthvi yeah, that looks more like what I had in mind. 👍🏾

[valaparthvi]

@kadel What plans do you have for odo preference registry list, and odo preference registry update? Will we still keep them as is and only move add, and remove?

[valaparthvi]

@kadel What plans do you have for odo preference registry list, and odo preference registry update? Will we still keep them as is and only move add, and remove?

From the cabal discussion:

• Drop odo preference registry update; if needed, user can always remove and add registry
• Move odo preference registry list to odo preference view

[dharmit]

• Drop odo preference registry update; if needed, user can always remove and add registry

• Move odo preference registry list to odo preference view

@valaparthvi IMO, we should add these to the issue's acceptance criteria.