Merge pull request #236 from gardlt/docs/troubleshoot/readme-upon-failed-envs

[WIP][docs] creating-troubleshooting-sub-directory

docs/developer/minikube.md

@@ -266,53 +266,6 @@ If you have any questions, comments, or find any bugs, please submit an issue so
 
 # Troubleshooting
 
-In order to protect your general sanity, we've included a curated list of verification and troubleshooting steps that may help you avoid some potential issues while developing Openstack-Helm.
+* [Openstack-Helm Minikube Troubleshooting](../troubleshooting/ts-minikube.md)
 
-**MariaDB**<br>
-To verify the state of MariaDB, use the following command:
 
-```
-$ kubectl exec mariadb-0 -it -n openstack -- mysql -uroot -ppassword -e 'show databases;'
-+--------------------+
-| Database           |
-+--------------------+
-| information_schema |
-| mysql              |
-| performance_schema |
-+--------------------+
-$
-```
-
-**Helm Server/Repository**<br>
-Sometimes you will run into Helm server or repository issues. For our purposes, it's mostly safe to whack these. If you are developing charts for other projects, use at your own risk (you most likely know how to resolve these issues already).
-
-To check for a running instance of Helm Server:
-
-```
-$ ps -a | grep "helm serve"
-29452 ttys004    0:00.23 helm serve .
-35721 ttys004    0:00.00 grep --color=auto helm serve
-```
-
-Kill the "helm serve" running process:
-
-```
-$ kill 29452
-```
-
-To clear out previous Helm repositories, and reinstall a local repository:
-
-```
-$ helm repo list
-NAME  	URL
-stable	https://kubernetes-charts.storage.googleapis.com/
-local 	http://localhost:8879/charts
-$
-$ helm repo remove local
-```
-
-This allows you to readd your local repository, if you ever need to do these steps:
-
-```
-$ helm repo add local http://localhost:8879/charts
-```

docs/troubleshooting/README.md

@@ -0,0 +1,17 @@
+# Troubleshooting
+
+Sometimes things go wrong. These guides will help you solve many common issues.
+
+* [Minikube issues](ts-minikube.md)
+* [Networking issues](ts-networking.md)
+* [Persistent Storage issues](ts-persistent-storage.md)
+
+## Getting Help
+
+### Channels
+
+[Contact Information](../../README.md#openstack-helm)
+
+### Bugs and Feature requests
+
+When discovering a new bug, please create a new issue in the [GitHub Tracking System](https://github.com/att-comdev/openstack-helm/issues/new)

docs/troubleshooting/ts-minikube.md

@@ -0,0 +1,57 @@
+# Troubleshooting - Minikube
+
+This troubleshooting guide is intended to assist users who are developing charts within this repository when using minikube.
+If you discover any issues with Minikube itself, submit an issue to the Minikube repository.
+
+## Diagnosing the problem
+
+In order to protect your general sanity, we've included a curated list of verification and troubleshooting steps that may help you avoid some potential issues while developing Openstack-Helm.
+
+**MariaDB**<br>
+To verify the state of MariaDB, use the following command:
+
+```
+$ kubectl exec mariadb-0 -it -n openstack -- mysql -u root -p password -e 'show databases;'
++--------------------+
+| Database           |
++--------------------+
+| information_schema |
+| mysql              |
+| performance_schema |
++--------------------+
+$
+```
+
+**Helm Server/Repository**<br>
+Sometimes you will run into Helm server or repository issues. For our purposes, it's mostly safe to whack these. If you are developing charts for other projects, use at your own risk (you most likely know how to resolve these issues already).
+
+To check for a running instance of Helm Server:
+
+```
+$ ps -a | grep "helm serve"
+29452 ttys004    0:00.23 helm serve .
+35721 ttys004    0:00.00 grep --color=auto helm serve
+```
+
+Kill the "helm serve" running process:
+
+```
+$ kill 29452
+```
+
+To clear out previous Helm repositories, and reinstall a local repository:
+
+```
+$ helm repo list
+NAME  	URL
+stable	https://kubernetes-charts.storage.googleapis.com/
+local 	http://localhost:8879/charts
+$
+$ helm repo remove local
+```
+
+This allows you to read your local repository, if you ever need to do these steps:
+
+```
+$ helm repo add local http://localhost:8879/charts
+```

docs/troubleshooting/ts-networking.md

@@ -0,0 +1,6 @@
+# Troubleshooting - Networking
+
+This guide is to help users debug any networking issues when deploying Charts in this repository.
+
+# Diagnosing the problem
+

docs/troubleshooting/ts-persistent-storage.md

@@ -0,0 +1,5 @@
+# Troubleshooting - Persistent Storage
+
+This guide is to help users debug any general storage issues when deploying Charts in this repository.
+
+# Diagnosing the problem