meaning of default in 'juju config' output is ambiguous

Bug #1709692 reported by James Troup
16
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Canonical Juju
Fix Released
Medium
Anastasia

Bug Description

'juju config' uses 'default' to apparently mean "the value of this
config option is the same as the default", but it could very easily be
read as "the default value of this config option is 'true'". e.g.:

| osd-encrypt:
| default: true
| description: |
| By default, the charm will not encrypt Ceph OSD devices; however, by
| setting osd-encrypt to True, Ceph's dmcrypt support will be used to
| encrypt OSD devices.
| .
| Specifying this option on a running Ceph OSD node will have no effect
| until new disks are added, at which point new disks will be encrypted.
| type: boolean
| value: false

If the name was 'is_default' (for example), this would remove the
ambiguity.

Revision history for this message
Witold Krecicki (wpk) wrote :

Would is_default or default_value be more useful in this case?

Revision history for this message
James Troup (elmo) wrote : Re: [Bug 1709692] Re: meaning of default in 'juju config' output is ambiguous

Witold Krecicki <email address hidden> writes:

> Would is_default or default_value be more useful in this case?

Either would be more useful than the current situation, yes.

--
James

Revision history for this message
Anastasia (anastasia-macmood) wrote :

There is more discussion around this topic on bug # 1697837.

However, I'll keep this bug dedicated to just how/if to display that the value is the same as defined on charm, i.e. currently known as "default".

Changed in juju:
status: New → Triaged
importance: Undecided → Medium
tags: added: usability
Revision history for this message
Paul Gear (paulgear) wrote :
Revision history for this message
Anastasia (anastasia-macmood) wrote :

@Paul Gear (paulgear),

This is not a dupe of bug # 1496639. That report was about regression and was a functional failure. This report is just about fixing how we display, specifically labeling, of values in the output.

I agree - "is_default" is a lot clearer \o/

Changed in juju:
status: Triaged → In Progress
assignee: nobody → Anastasia (anastasia-macmood)
Revision history for this message
Anastasia (anastasia-macmood) wrote :
Changed in juju:
milestone: none → 2.3-alpha1
Changed in juju:
status: In Progress → Fix Committed
Revision history for this message
Anastasia (anastasia-macmood) wrote :
Changed in juju:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.