The `requires` keyword to describe a relation is confusing
Bug #1950008 reported by
Simon Déziel
This bug affects 1 person
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Canonical Juju |
Triaged
|
Wishlist
|
Unassigned |
Bug Description
https:/
> those under the `requires` keyword define services/interfaces that the
> charm consumes from others. Despite their name, requires relations are
> not always essential for the application to function - charm authors
> can indicate optionality in the metadata
This is confusing and the informational-only `optional` flag helps only marginally.
Optional relations could be listed under a `consumes` section to better convey that they are not required.
description: | updated |
To post a comment you must log in.
I think there is, indeed, a bit of a logical disconnect between a 'requires' that is optional. There is a different use for 'consumes' (when you offer a cross model relation, that gets consumed in the target model).
So it probably isn't a word that we would switch to. It might be worth brainstorming alternative words, though at this point we are unlikely to change the word that charms have been using for quite some time.