Mount Description

[djenriquez]

Reference: #102

This PR adds a description field to the generic secret mount display. Currently, Vault does not have the ability to update the description of a mount (hashicorp/vault#2645), but the logic for it is stubbed in here for when that feature does exist. I realized after doing the work that you can't "re-post" a mount to update, lame.

[msessa]

Hey @djenriquez,

I'd rather avoid putting the responsibility of discovering information about backends onto the specific backend UI code.

I've pushed some changes so the description of a backend is displayed by the navigation menu, which is more natural since that's where sys/mounts and sys/auth are enumerated in the first place.

[msessa]

In addition I've added a text field in the backend mount dialog so the description can be entered at creation.

But you're right, once the backend is mounted, seems like there's no way to update the description

[djenriquez]

@msessa I had thought about putting it in the menu, but it threw things off a bit when I had a long description, which, I'm not sure what users would have for theirs.

You're right that its un-natural to "re-retrieve" the mount description through another call to sys/mounts, but apparently its the only way to do it. So the question becomes, where do we place this? If in the menu, then we can efficiently grab the description on mount load. If not on the menu, then we have to recall sys/mounts or fetch it from some root level. I don't think its too messy for the client to make this call.

[djenriquez]

Can we/should we have the menu item grow with the description? That may be a valid compromise?

[msessa]

I just think having to update every backend with code to make that call, filter the result and display the description is just too much for such a small UI improvement.
Our priority should be to keep the modular backends code as lean as possible to promote development from the community.

What if we improved the UX on the menu around displaying overflowing text?
Something like this: https://jsfiddle.net/tb68dwqr/

[djenriquez]

Yea, I think thats a nice compromise, though I think the old school hover tooltip might actually be a better alternative. https://jsfiddle.net/tb68dwqr/29/ can be difficult to read since it just jumps to the end and goes through the middle quickly.

[fia5000]

@djenriquez From Release 2.2.0 it appears that this made it into the release but I am not seeing the ability to actually add descriptions to any mounts

[djenriquez]

@fia5000, you're right, that was left in unintentionally. I'll update the release notes to reflect whats really out. As far as this feature is concerned, we're stuck in a debate on how this should be implemented. Do you have any feedback on which implementation above ^ you prefer?

[tallpauley]

@djenriquez @msessa Honestly, I don't like the idea of a large tooltip, or a lot of text under the backend link. I think the right way to go is having the description at the top once you have loaded the backend like in @djenriquez's mockup above. If the description was wrapped up as a component I don't think it'd be too much for contributors to include.