Merge pull request cncamp#16 from SignorMercurio/master

Docs improvement since module7

Author: mfanjie

module10/argocd/readme.MD

@@ -1,28 +1,39 @@
-### install 
-```
+### Install
+
+```sh
 kubectl create namespace argocd
 kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yaml
 ```
-### access argocd 
-### update argocd-server service to NodePort
-#### access argocd console
-```
-user：admin
-password： k get secret -n argocd argocd-initial-admin-secret -oyaml
-```
-### manage repositories->connect repo using https
-```
+
+### Access argocd
+
+### Update argocd-server service to NodePort
+
+#### Access argocd console
+
+- user: `admin`
+- password:
+  ```sh
+  k get secret -n argocd argocd-initial-admin-secret -oyaml
+  ```
+
+### Manage repositories->connect repo using https
+
 https://github.com/cncamp/test.git
-```
-### create application
-```
-sync policy: manual
-path: .
-```
-### create sync
-### scale the deploy by cmd
-```
+
+### Create application
+
+- sync policy: `manual`
+- path: `.`
+
+### Create sync
+
+### Scale the deploy by cmd
+
+```sh
 k scale deployment httpserver --replicas=2
 ```
-### check appstatus and sync again
-### change the sync policy to auto and see
+
+### Check appstatus and sync again
+
+### Change the sync policy to `auto` and check

module10/harbor/harbor.MD

@@ -1,62 +1,84 @@
-### install download harbor helm chart
-```
+### Download harbor helm chart
+
+```sh
 helm repo add harbor https://helm.goharbor.io
 helm fetch harbor/harbor --untar
 kubectl create ns harbor
 ```
-### update values.yaml
+
+### Update values.yaml
+
+```sh
+vi .harbor/values.yaml
 ```
-vi ./harbor/values.yaml and change
 
+And change:
 
+```yaml
 expose:
   type: nodePort
 tls:
-  commonName: "core.harbor.domain"
+  commonName: 'core.harbor.domain'
 
 persistence: false
 ```
-### install helm chart
-```
+
+### Install helm chart
+
+```sh
 helm install harbor ./harbor -n harbor
 ```
-### wait for all pod being ready and access harbor portal
+
+### Wait for all pod being ready and access harbor portal
+
+http://192.168.34.2:30002
+
 ```
-192.168.34.2:30002
 admin/Harbor12345
 ```
-### download repository certs from 
-```
+
+### Download repository certs from
+
+```sh
 https://192.168.34.2:30003/harbor/projects/1/repositories
 ```
-### copy the downloaded ca.crt to vm docker certs configuration folder
-```
+
+### Copy the downloaded ca.crt to vm docker certs configuration folder
+
+```sh
 mkdir /etc/docker/certs.d/core.harbor.domain
 copy the ca.crt to this folder
 systemctl restart docker
 ```
-### edit /etc/hosts to map core.harbor.domain to harbor svc clusterip
-```
+
+### Edit /etc/hosts to map core.harbor.domain to harbor svc clusterip
+
+```sh
 10.104.231.99 core.harbor.domain
 ```
-### docker login
-```
+
+### Docker login
+
+```sh
 docker login -u admin -p Harbor12345 core.harbor.domain
 ```
-### docker tag a image to core.harbor.domain and push it and you will see it in harbor portal
 
-### check repositories and blobs
-```
+### Docker tag a image to core.harbor.domain and push it and you will see it in harbor portal
+
+### Check repositories and blobs
+
+```sh
 kubectl exec -it harbor-registry-7d686859d7-xs5nv -n harbor bash
 ls -la /storage/docker/registry/v2/repositories/
 ls -la /storage/docker/registry/v2/blobs
 ```
-### db operator
-```
-kubectl exec -it harbor-database-0 -n harbor bash
+
+### Database operator
+
+```sh
+kubectl exec -it harbor-database-0 -n harbor -- bash
 psql -U postgres -d postgres -h 127.0.0.1 -p 5432
 \c registry
 select * from harbor_user;
 \dt
-
-```
+```

module10/httpserver/alert/enable-alert.MD

@@ -1,22 +1,27 @@
-### edit prom configmap
-```
+### Edit prom configmap
+
+```sh
 k edit configmap loki-prometheus-server
 ```
-### add the following alert to alerting_rules.yml
-```
-    groups:
-    - name: example
-      rules:
+
+### Add the following alert to alerting_rules.yml
+
+```yaml
+groups:
+  - name: example
+    rules:
       - alert: ContainerKilled
         expr: time() - container_last_seen > 60
         for: 5m
         labels:
           severity: warning
         annotations:
-          summary: "Container killed (instance {{ $labels.instance }})"
+          summary: 'Container killed (instance {{ $labels.instance }})'
           description: "A container has disappeared\n  VALUE = {{ $value }}\n  LABELS: {{ $labels }}"
 ```
-### reload
-```
+
+### Reload
+
+```sh
 curl -XPOST 192.168.166.149:9090/-/reload
 ```

module10/loki-stack/readme.MD

@@ -1,47 +1,64 @@
-### add grafana repo
+### Add grafana repo
+
+```sh
 helm repo add grafana https://grafana.github.io/helm-charts
-### install loki-stack
 ```
+
+### Install loki-stack
+
+```sh
 helm upgrade --install loki grafana/loki-stack --set grafana.enabled=true,prometheus.enabled=true,prometheus.alertmanager.persistentVolume.enabled=false,prometheus.server.persistentVolume.enabled=false
 ```
 
-### if you get the following error, that means your k8s version is too new to install
+### If you get the following error, that means your k8s version is too new to install
+
 ```
 Error: unable to build kubernetes objects from release manifest: [unable to recognize "": no matches for kind "ClusterRole" in version "rbac.authorization.k8s.io/v1beta1", unable to recognize "": no matches for kind "ClusterRoleBinding" in version "rbac.authorization.k8s.io/v1beta1", unable to recognize "": no matches for kind "Role" in version "rbac.authorization.k8s.io/v1beta1", unable to recognize "": no matches for kind "RoleBinding" in version "rbac.authorization.k8s.io/v1beta1"]
 ```
 
-### download loki-stack
-```
+### Download loki-stack
+
+```sh
 helm pull grafana/loki-stack
 tar -xvf loki-stack-*.tgz
-```
-```
 cd loki-stack
 ```
-### replace all `rbac.authorization.k8s.io/v1beta1` with `rbac.authorization.k8s.io/v1` by 
-```
+
+### Replace all `rbac.authorization.k8s.io/v1beta1` with `rbac.authorization.k8s.io/v1` by 
+```sh
 grep -rl "rbac.authorization.k8s.io/v1beta1" . | xargs sed -i 's/rbac.authorization.k8s.io\/v1beta1/rbac.authorization.k8s.io\/v1/g'
 ```
-### install loki locally
-```
+
+### Install loki locally
+
+```sh
 helm upgrade --install loki ./loki-stack --set grafana.enabled=true,prometheus.enabled=true,prometheus.alertmanager.persistentVolume.enabled=false,prometheus.server.persistentVolume.enabled=false
 ```
-### change the grafana service to NodePort type and access it
-```
+
+### Change the grafana service to NodePort type and access it
+
+```sh
 kubectl edit svc loki-grafana -oyaml -n default
-change ClusterIP type to NodePort
-```
-login password is in secret `loki-grafana`
 ```
+
+And change ClusterIP type to NodePort.
+
+Login password is in secret `loki-grafana`
+
+```sh
 kubectl get secret loki-grafana -oyaml -n default
 ```
-find admin-password: xxx
-```
+
+Find admin-password: `xxx`
+
+```sh
 echo 'xxx' | base64 -d
 ```
-then you will get grafana login password, the login username is 'admin' on default.
 
-note: the xxx is value of key  admin-password in your yaml.
+Then you will get grafana login password, the login username is 'admin' on default.
+
+> Note: `xxx` is the value of key `admin-password` in your yaml.
 
-###
+### Change the grafana service to NodePort type and access it
 
+Login password is in secret `loki-grafana`

module10/prometheus/prometheus.MD

@@ -1,20 +1,23 @@
-### sync VM time with host
-```
+### Sync VM time with host
+
+```sh
 shutdown vm
 cd ~/"VirtualBox VMs"
 VBoxManage list vms
 "localkube" {014a8874-1cbe-43ec-a47c-ce7248bce13e}
 vboxmanage setextradata "localkube" "VBoxInternal/Devices/VMMDev/0/Config/GetHostTimeDisabled" "1"
 vboxmanage setextradata "crane" "VBoxInternal/Devices/VMMDev/0/Config/GetHostTimeDisabled" "1"
 ```
-### start VM and then you can get prometheus data
 
-### grafana dashboard
-```
+### Start VM and then you can get prometheus data
+
+### Grafana dashboard
+
+```sh
 cluster health
 6417
 pod dashboard
 9729
 Istio Mesh
 7639
-```
+```