search

cloud-native-toolkit / automation-solutions

A collection of Bills of Materials that address solution/use-case scenarios.
https://cloud-native-toolkit.github.io/automation-solutions/
Apache License 2.0
3 stars 9 forks source link

Common troubleshooting information #124

Closed triceam closed 2 years ago

triceam commented 2 years ago
  1. Create a common Troubleshooting/Uninstall markdown file. Include details on how to uninstall our automation, and how to troubleshoot.
  2. Symlink the markdown file into the files directory of all of our boms
  3. Edit the readme for each of the boms/packages to reference the troubleshooting markdown file
  4. publish changes for all impacted boms/solutions
triceam commented 2 years ago

In the automation solutions repo I created a common software Troubleshooting Guide: https://github.com/cloud-native-toolkit/automation-solutions/blob/main/boms/software/_common/TROUBLESHOOTING.md

I’ve symlinked this into the cp4d, datafabric, integration, maximo and turbonomic folders (in the files directory), and added to the readme for each of them, so that this common troubleshooting guide will be included with all of our automation packages when they are generated.

This includes common uninstallation steps, plus details common error cases like Resources stuck in Terminating state, Variables may not be used here, invalid credentials, among others. This lets us define the steps/fixes/workarounds in one place, and it will be applied to all solutions.

I did not publish any of the generated output yet. I’ll let the owners of each of those solutions generate at their own pace