cloudfoundry / cli

The official command line client for Cloud Foundry
https://docs.cloudfoundry.org/cf-cli
Apache License 2.0
1.75k stars 926 forks source link

MOTD on cli #1932

Open agracey opened 4 years ago

agracey commented 4 years ago

Please provide details on the following items. Failure to do so may result in deletion of your feature request.

What's the user value of this feature request? A clear and concise description of what the user value is.

It'd be great for an admin to be able to send messages to users when they perform actions. Things like scheduled downtime or maintenance windows.

Who is the functionality for? Who will use this feature?

admins and end users

How often will this functionality be used by the user? How often will they use this feature?

daily? depends on when you have updates

Who else is affected by the change? Does this feature cause a breaking change? Are other users affected by this change?

I don't think this would interfere with anything?

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like A clear and concise description of what you want to happen.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

cf-gitbot commented 4 years ago

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/172724003

The labels on this github issue will be updated when the story is started.

heyjcollins commented 4 years ago

Thanks @agracey - Is this request trying to solve the problem of app developers/operators being caught unawares when the platform is being updated. That would be solved if there were some way to proactively communicate anticipated downtime/maintenance windows via some message block that's inserted into the output from each CLI command?

Could you confirm and/or describe the problem that you're trying to address in a bit more detail?

And if you had a solution in mind, what would be the workflow for the admin? What would the UX be for app developers & operators?

agracey commented 4 years ago

The problem that I'm trying to solve is that when we are planning upgrades or in the middle of an outage we need a better experience than random failures. Due to the way we are using the platform, there's not a good way to notify users outside of the platform itself. I believe this would be useful to any group acting as a cloud provider with CF.

What I'd like to see as an admin would be an additional cli command (and it's respective API endpoint) that would let me set the current MOTD.

cf motd set "<String>" [ -t Timeout ]

along with

cf motd clear, cf motd get

For the users, I'd love for this string to get printed when a user performs a cf api, cf login, cf target, or cf push

Does that clarify?

agracey commented 4 years ago

I'd also like for this functionality be available in Stratos as well but that'd be for a different ticket in that project once the API is build.