Enhance the teardown documentation for clarity
Closed this issue · 6 comments
edwardchalstrey1 commented
✅ Checklist
- I have searched open and closed issues for duplicates
- This is a request for a change to documentation
- This isn't a feature request or bug report
- This isn't an open-ended question (open a discussion if it is).
📒 Where is the problem?
📝 Required documentation changes
- Explain a bit more exactly what will happen when running
dsh sre teardown YOUR_SRE_NAMEordsh shm teardownso System Managers new to DSH don't delete things without meaning - Add some big scary warnings, especially to the SHM teardown part saying "deleting this will affect all SREs" etc
- I'm not sure if in DSH v5 the storage account is now falling under the SRE resources as oppose to the SHM subscription (as was the case in v4)? If so, also add big scary warning saying data will be deleted by SRE teardown (unless this is not the case, in which case explain that)
craddm commented
On this note, maybe we should be preventing the SHM from being torn down if any SREs are still deployed... or at least give a warning
jemrobinson commented
+1 for prevention (with an error message explaining why).
edwardchalstrey1 commented
On this note, maybe we should be preventing the SHM from being torn down if any SREs are still deployed... or at least give a warning
Also, perhaps in both teardown scripts multiple "Are you sure you really want to do this" prompts
JimMadge commented
Great 🚀.
I think the other thing to do is make some code changes,
- adding an extra prompt for the user to confirm teardown
- blocking teardown of SHM if SREs are deployed
We can do that in another PR. I would be happy bumping that to 5.0.2, what do you think?