trafficcontrol
trafficcontrol copied to clipboard
Provide a better message on DS create/update/delete to indicate if a CDN snapshot and/or queue updates is required
I'm submitting a ...
- [ ] bug report
- [ ] new feature / enhancement request
- [x] improvement request (usability, performance, tech debt, etc.)
- [ ] other
Traffic Control components affected ...
- [ ] CDN in a Box
- [ ] Documentation
- [ ] Grove
- [ ] Traffic Control Client
- [ ] Traffic Monitor
- [x] Traffic Ops
- [ ] Traffic Ops ORT
- [x] Traffic Portal
- [ ] Traffic Router
- [ ] Traffic Stats
- [ ] Traffic Vault
- [ ] unknown
Current behavior:
Currently when you successfully create/edit/delete a delivery service you get a very simple message like "DS create/updated/deleted successfully". However, creating, updating and deleting a delivery service requires more than simply persisting the change to the database. In some cases it requires a cdn snapshot and/or an ATS config file update via a queue updates of all servers in the cdn for the change to take affect.
Expected / new behavior:
IMO it would be very helpful if the success message was something like:
-
DS updated successfully. A CDN snapshot is required for the changes to take affect.
-
DS updated successfully. Queue updates on all servers in the cdn for the changes to take affect.
-
DS updated successfully. Queue updates on all servers in the cdn and perform a CDN snapshot for the changes to take affect.
-
DS created successfully. Queue updates on all servers in the cdn then perform a CDN snapshot for the changes to take affect.
-
DS deleted successfully. Perform a CDN snapshot then queue updates on all servers in the cdn for the changes to take affect.
Of course in the case of an update this would require inspecting which properties changed to determine the appropriate message.
In fact, this more informative message could apply to any delivery service related change that requires a queue updates and/or a cdn snapshot such as:
- updating ds regexes
- updating ds static dns entries
- updating ds ssl keys
- updating ds url sig keys
- updating ds uri signing keys
- updating ds/server assignments
- updating ds origins
Minimal reproduction of the problem with instructions:
create/update or delete a DS via the TO API or TP and observe the very non-informative message that is returned from the API and presented in TP.
it's very unclear what the user is supposed to do after making changes to a ds. should i queue updates? snapshot? both? i'm going to mark this as high impact as i believe it to be "high value" from a user perspective but i know that's very debatable.