From 402bf14d2e43c5a24a7f415b958458bf8288857f Mon Sep 17 00:00:00 2001 From: Jason Colyer Date: Wed, 28 Aug 2019 09:34:45 -0500 Subject: Adding Kubernetes troubleshooting doc * Added more content to kubernetes.md --- doc/administration/troubleshooting/kubernetes.md | 50 ++++++++++++++++++++++-- 1 file changed, 47 insertions(+), 3 deletions(-) diff --git a/doc/administration/troubleshooting/kubernetes.md b/doc/administration/troubleshooting/kubernetes.md index 33ad83a244b..222284fcf52 100644 --- a/doc/administration/troubleshooting/kubernetes.md +++ b/doc/administration/troubleshooting/kubernetes.md @@ -72,9 +72,15 @@ Troubleshooting Kubernetes requires: - **Volume**: A directory containing data, accessible to the containers in a pod. -## Kubernetes Workflows +## Troubleshooting workflows -### Helm Workflow +The type of problem will determine what steps to take. The possible +troubleshooting workflows are for: + +- Helm +- Kubernetes integration + +### Helm workflow ```mermaid graph TD; @@ -119,7 +125,7 @@ graph TD; T(It is likely the issue you are
encountering is either a
Kubernetes, bug, issue, or
configuration issue. You
should escalate to GitLab
support.) ``` -### Kubernetes Integration Workflow +### Kubernetes integration Workflow ```mermaid graph LR; A --> |Yes| B @@ -140,3 +146,41 @@ graph LR; H[Check the logs for this pod.
It likely will show errors.
Those would need to be resolved] I[This may be a bug/issue
in GitLab and will require
deeper investigation. Escalate
to GitLab support.] ``` + +## Troubleshooting walkthrough + +Most Kubernetes troubleshooting can be broken down into 2 categories: + +- [Troubleshooting helm](#troubleshooting-helm) +- [Troubleshooting Kubernetes integration](#troubleshooting-kubernetes-integration) + +Generally speaking, if it does not fall into those two categories, it is either: + +- Something GitLab support needs to look into. +- Something a Kubernetes administrator needs to look into. + +Exercise caution. Issues that appear to be GitLab problems can be Kubernetes or +infrastructure issues. + +### Troubleshooting helm + +TBD + +### Troubleshooting Kubernetes integration + +TBD + +## Common issues + +TBD + +## Replication + +Setting up Kubernetes can be tricky and costly. + +The easiest method is to spin up a minikube instance locally. If you are +wanting to troubleshoot the Kubernetes integration, you would also want to spin +up a local GitLab install (docker usually works best for this). + +You can read more using minkube via +[Kubernetes documentation](https://kubernetes.io/docs/setup/learning-environment/minikube/). -- cgit v1.2.1