summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcel Amirault <mamirault@gitlab.com>2019-08-07 13:57:50 +0900
committerMarcel Amirault <mamirault@gitlab.com>2019-08-07 13:57:50 +0900
commitfc1850489724a43efcd59a2aa04637827590f11c (patch)
tree3e343016933cb62303b90c8a3e0d3a031fb92ccf
parent567d35346ad3c341faffe5e0db92d90620711247 (diff)
downloadgitlab-ce-docs-debug-atanayno.tar.gz
Update k8s cheat sheet with suggestionsdocs-debug-atanayno
Fix capitalization, fix link, etc
-rw-r--r--doc/administration/troubleshooting/kubernetes_cheat_sheet.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/administration/troubleshooting/kubernetes_cheat_sheet.md b/doc/administration/troubleshooting/kubernetes_cheat_sheet.md
index 5653eb102be..95cdb1508fa 100644
--- a/doc/administration/troubleshooting/kubernetes_cheat_sheet.md
+++ b/doc/administration/troubleshooting/kubernetes_cheat_sheet.md
@@ -69,12 +69,12 @@ and they will assist you with any issues you are having.
NOTE: **Note:**
No logs are kept in the containers/pods themselves, everything is written to stdout.
- This is the principle of kubernetes, read [Twelve-factor app](https://12factor.net/)
+ This is the principle of Kubernetes, read [Twelve-factor app](https://12factor.net/)
for details.
## Gitlab-specific kubernetes information
-- A Minimal config that can be used to test a Kubernetes helm chart can be found
+- Minimal config that can be used to test a Kubernetes helm chart can be found
[here](https://gitlab.com/charts/gitlab/issues/620).
- Tailing logs of a separate pod. An example for a unicorn pod:
@@ -90,7 +90,7 @@ and they will assist you with any issues you are having.
- [kail: kubernetes tail](https://github.com/boz/kail)
- [stern](https://github.com/wercker/stern)
-- Check all events in the gitlab namespace (the namespace name can be different if you
+- Check all events in the `gitlab` namespace (the namespace name can be different if you
specified a different one when deploying the helm chart):
```bash
@@ -126,14 +126,14 @@ and they will assist you with any issues you are having.
You can also use `gitlab-rake`, instead of `/usr/local/bin/gitlab-rake`.
-- Troubleshooting Operations > Kubernetes integration:
+- Troubleshooting **Operations > Kubernetes** integration:
- Check the output of `kubectl get events -w --all-namespaces`.
- Check the logs of pods within `gitlab-managed-apps` namespace.
- On the side of GitLab check sidekiq log and kubernetes log. When GitLab is installed
via helm chart, kubernetes.log can be found inside the sidekiq pod.
-- How to get your initial admin password <https://docs.gitlab.com/ee/install/kubernetes/gitlab_chart.html#initial-login>:
+- How to get your initial admin password <https://docs.gitlab.com/charts/installation/deployment.html#initial-login>:
```bash
# find the name of the secret containing the password
@@ -182,16 +182,16 @@ and they will assist you with any issues you are having.
## Installation of minimal GitLab config via minukube on macOS
This section is based on [Developing for Kubernetes with Minikube](https://gitlab.com/charts/gitlab/blob/master/doc/minikube/index.md)
-and [Helm](https://gitlab.com/charts/gitlab/blob/master/doc/helm/index.md). Please
-refer to those documents for details.
+and [Helm](https://gitlab.com/charts/gitlab/blob/master/doc/helm/index.md). Refer
+to those documents for details.
-- Install kubectl via homebrew:
+- Install kubectl via Homebrew:
```bash
brew install kubernetes-cli
```
-- Install minikube via homebrew:
+- Install minikube via Homebrew:
```bash
brew cask install minikube
@@ -206,7 +206,7 @@ refer to those documents for details.
minikube addons enable kube-dns
```
-- Install helm via homebrew and initialize it:
+- Install helm via Homebrew and initialize it:
```bash
brew install kubernetes-helm
@@ -219,7 +219,7 @@ refer to those documents for details.
- Find the IP address in the output of `minikube ip` and update the yaml file with
this IP address.
-- Install the gitlab helm chart:
+- Install the GitLab helm chart:
```bash
helm repo add gitlab https://charts.gitlab.io