[helm] feat: add helm document.

guangzhengli · guangzhengli · commit 8320d06a05be · 2022-08-28T21:24:20.000+08:00
diff --git a/README.md b/README.md
@@ -1,38 +1,8 @@
-# kubernetes workshop
-
-- [kubernetes workshop](#kubernetes-workshop)
-  - [准备工作](#准备工作)
-    - [安装 docker](#安装-docker)
-    - [安装 minikube](#安装-minikube)
-    - [安装 k8s CLI 和 Terminal based UI](#安装-k8s-cli-和-terminal-based-ui)
-    - [注册 docker hub 账号登录](#注册-docker-hub-账号登录)
-  - [Container](#container)
-  - [Pod](#pod)
-    - [Pod 与 Container 的不同](#pod-与-container-的不同)
-    - [Pod 其它命令](#pod-其它命令)
-    - [作业一：Hellok8s Pod](#作业一hellok8s-pod)
-  - [Deployment](#deployment)
-    - [扩容](#扩容)
-    - [升级版本](#升级版本)
-    - [Rolling Update(滚动更新)](#rolling-update滚动更新)
-    - [存活 / 就绪探针](#存活--就绪探针)
-    - [Automatically blocking bad releases by readinessProbe](#automatically-blocking-bad-releases-by-readinessprobe)
-  - [Service](#service)
-  - [ingress](#ingress)
-  - [Configmap](#configmap)
-    - [env var](#env-var)
-    - [configmap](#configmap-1)
-    - [Getting all the variables from a ConfigMap](#getting-all-the-variables-from-a-configmap)
-    - [Exposing ConfigMap as files](#exposing-configmap-as-files)
-  - [Secret](#secret)
-    - [Using stringData](#using-stringdata)
-  - [helm](#helm)
+# kubernetes tutorials
 
 ## 准备工作
 
-本地环境是 MacOS 11.6.2 Intel 版本，教程也是本地环境。windows 或 linux 环境的小伙伴需要自行安装 docker 和 minikube。
-
-如果本地
+由于我本地环境是 MacOS 11.6.2 Intel 版本，教程也是在本地环境进行。windows 或 linux 环境的小伙伴需要自行安装 docker 和 minikube。
 
 ### 安装 docker
 
@@ -48,6 +18,8 @@ brew install docker-compose
 
 [minikube](https://minikube.sigs.k8s.io/docs/) 用于在本地环境中运行 Kubernetes 集群。但它也运行一个可用于运行容器的 docker 守护进程。在 macOS 上，minikube 运行在很多虚拟化技术上，可以选择[hyperkit](https://minikube.sigs.k8s.io/docs/drivers/hyperkit/)，这里因为我本地之前已经安装过 virtualbox (brew install --cask virtualbox)，所以我用的是 virtualbox 虚拟化技术。如果你本地之前已经安装了 docker desktop 的话，可以不需要下载 `hyperkit` 或者 `virtualbox`。
 
+>注意：如果本地已经安装了 docker desktop，那么可以使用 minikube start --vm-driver docker --container-runtime=docker 来快速启动 minikube
+
 ```bash
 # Install hyperkit and minikube (check which vm-driver to use, if install docker desktop already, you can just use vm-driver=docker instead of install hyperkiy)
 brew install hyperkit
@@ -70,8 +42,6 @@ echo "`minikube ip` docker.local" | sudo tee -a /etc/hosts > /dev/null
 docker run hello-world
 ```
 
-> 注意：如果本地已经安装了 docker desktop，那么可以使用 minikube start --vm-driver docker --container-runtime=docker 来快速启动 minikube
-
 **minikube Cheatsheet**
 
 `minikube stop` 不会删除任何数据，只是停止 VM 和 k8s 集群。
@@ -92,18 +62,6 @@ docker run hello-world
 brew install kubectl
 ```
 
-如果我们希望更直观的观察 kubernetes 中资源的变化，也可以安装一个 [k9s](https://k9scli.io/)（对于初学者而言，更建议使用 kubectl 来手动观察）
-
-```bash
-brew install k9s
-```
-
-如果需要练习 helm 的使用，可以先安装 helm
-
-```bash
-brew install helm
-```
-
 ### 注册 docker hub 账号登录
 
 在 docker hun(https://hub.docker.com/) 中注册账号，并且使用 login 登录账号。
@@ -1423,11 +1381,11 @@ kubectl get pods
 # hello-cronjob-27694609--1-2nmdx        0/1     Completed   0          15s
 ```
 
-## Helm
+## Helm(TODO)
 
 经过前面的教程，想必你已经对 kubernetes 的使用有了一定的理解。但是不知道你是否想过这样一个问题，就是我们前面教程中提到的所有资源，包括用 `pod`, `deployment`, `service`, `ingress`, `configmap`,`secret` 所有资源来部署一套完整的 `hellok8s` 服务的话，难道需要一个一个的 `kubectl apply -f` 来创建吗？如果换一个 namespace，或者说换一套 kubernetes 集群部署的话，又要重复性的操作创建的过程吗？
 
-我们平常使用操作系统时，需要一个应用的话，可以直接使用 `apt` 或者 `brew` 来直接安装，而不需要关心这个应用需要哪些依赖，哪些配置。在使用 kubernetes 安装应用服务 `hellok8s` 时，我们自然也希望能够一个命令就安装完成，而提供这个能力的，就是 CNCF 的毕业项目 [Helm](https://github.com/helm/helm)。
+我们平常使用操作系统时，需要安装一个应用的话，可以直接使用 `apt` 或者 `brew` 来直接安装，而不需要关心这个应用需要哪些依赖，哪些配置。在使用 kubernetes 安装应用服务 `hellok8s` 时，我们自然也希望能够一个命令就安装完成，而提供这个能力的，就是 CNCF 的毕业项目 [Helm](https://github.com/helm/helm)。
 
 > Helm 帮助您管理 Kubernetes 应用—— Helm Chart，Helm 是查找、分享和使用软件构建 [Kubernetes](https://kubernetes.io/) 的最优方式。
 >
@@ -1447,6 +1405,14 @@ brew install helm
 
 Helm 的使用方式可以解释为：Helm 安装 *charts* 到 Kubernetes 集群中，每次安装都会创建一个新的 *release*。你可以在 Helm 的 chart *repositories* 中寻找新的 chart。
 
+### 安装 hellok8s chart 快速开始(TODO)
+
+//TODO
+
+### 创建 helm charts
+
+我们来手把手创建一个自己的 helm charts，完成我们之前的那些功能。
+
 使用 `helm create` 命令默认会帮你创建一些 k8s 资源定义的初始文件，如下所示：
 
 ```
@@ -1466,26 +1432,186 @@ helm create hello-helm
 └── values.yaml
 ```
 
+而我们删减一下这些文件，用之前教程中 ingress + configmaps 那节中的资源文件替代它，最终的结构长这样：
 
+```
+.
+├── Chart.yaml
+├── _helpers.tpl
+├── charts
+├── templates
+│   ├── hellok8s-configmaps.yaml
+│   ├── hellok8s-deployment.yaml
+│   ├── hellok8s-service.yaml
+│   ├── ingress.yaml
+│   ├── nginx-deployment.yaml
+│   └── nginx-service.yaml
+└── values.yaml
+```
 
-```shell
-helm create helm-hello
+其中 `hellok8s-configmaps.yaml`
 
-helm upgrade --install hello-helm --values values.yaml .
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: hellok8s-config
+data:
+  DB_URL: "http://DB_ADDRESS_DEV"
+```
+
+`hellok8s-deployment.yaml`
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: hellok8s-deployment
+spec:
+  replicas: 3
+  selector:
+    matchLabels:
+      app: hellok8s
+  template:
+    metadata:
+      labels:
+        app: hellok8s
+    spec:
+      containers:
+        - image: guangzhengli/hellok8s:v4
+          name: hellok8s-container
+          env:
+            - name: DB_URL
+              valueFrom:
+                configMapKeyRef:
+                  name: hellok8s-config
+                  key: DB_URL
+```
 
-helm list
+`hellok8s-service.yaml`
 
-helm rollback hello-helm
+```yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: service-hellok8s-clusterip
+spec:
+  type: ClusterIP
+  selector:
+    app: hellok8s
+  ports:
+  - port: 3000
+    targetPort: 3000
 ```
 
-TODO
+`ingress.yaml`
+
+```yaml
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: hello-ingress
+  annotations:
+    # We are defining this annotation to prevent nginx
+    # from redirecting requests to `https` for now
+    nginx.ingress.kubernetes.io/ssl-redirect: "false"
+spec:
+  rules:
+    - http:
+        paths:
+          - path: /hello
+            pathType: Prefix
+            backend:
+              service:
+                name: service-hellok8s-clusterip
+                port:
+                  number: 3000
+          - path: /
+            pathType: Prefix
+            backend:
+              service:
+                name: service-nginx-clusterip
+                port:
+                  number: 4000
+```
+
+`nginx-deployment.yaml`
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+spec:
+  replicas: 2
+  selector:
+    matchLabels:
+      app: nginx
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - image: nginx
+        name: nginx-container
+```
+
+`nginx-service.yaml`
+
+```yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: service-nginx-clusterip
+spec:
+  type: ClusterIP
+  selector:
+    app: nginx
+  ports:
+  - port: 4000
+    targetPort: 80
+```
+
+`Chart.yaml`
+
+```yaml
+apiVersion: v2
+name: hello-helm
+description: A k8s tutorials in https://github.com/guangzhengli/k8s-tutorials
+type: application
+version: 0.1.0
+appVersion: "1.16.0"
+
+```
+
+在 `hello-helm` 的跟路径下执行命令进行安装 chart，执行 curl 命令便能直接得到结果！查看 pod 和 service 等资源，便会发现 helm 能一键安装所有资源！
+
+```shell
+helm upgrade --install hello-helm --values values.yaml .
+
+curl http://192.168.59.100/hello
+#[v4] Hello, Kubernetes! From host: hellok8s-deployment-f88f984c6-nzwg6, Get Database Connect URL: http://DB_ADDRESS_DEV
+
+kubectl get pods
+# NAME                                  READY   STATUS    RESTARTS   AGE
+# hellok8s-deployment-f88f984c6-k8hpz   1/1     Running   0          32m
+# hellok8s-deployment-f88f984c6-nzwg6   1/1     Running   0          32m
+# hellok8s-deployment-f88f984c6-s89s7   1/1     Running   0          32m
+# nginx-deployment-d47fd7f66-6w76b      1/1     Running   0          32m
+# nginx-deployment-d47fd7f66-tsqj5      1/1     Running   0          32m
+```
 
+### 上传和下载其它 helm chart 使用 (TODO)
 
+//TODO
 
+## Dashboard(TODO)
 
+//TODO: 介绍 kubernetes dashboard
 
-## Dashboard
+### K9s(TODO)
 
-### K9s
+//TODO: 介绍 k9s client
 
 ![83ybd4](https://cdn.jsdelivr.net/gh/guangzhengli/PicURL@master/uPic/83ybd4.png)
diff --git a/hello-helm/Chart.yaml b/hello-helm/Chart.yaml
@@ -1,24 +1,6 @@
 apiVersion: v2
 name: hello-helm
-description: A helm tutorial in https://github.com/guangzhengli/kubernetes_workshop
-
-# A chart can be either an 'application' or a 'library' chart.
-#
-# Application charts are a collection of templates that can be packaged into versioned archives
-# to be deployed.
-#
-# Library charts provide useful utilities or functions for the chart developer. They're included as
-# a dependency of application charts to inject those utilities and functions into the rendering
-# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+description: A k8s tutorials in https://github.com/guangzhengli/k8s-tutorials
 type: application
-
-# This is the chart version. This version number should be incremented each time you make changes
-# to the chart and its templates, including the app version.
-# Versions are expected to follow Semantic Versioning (https://semver.org/)
 version: 0.1.0
-
-# This is the version number of the application being deployed. This version number should be
-# incremented each time you make changes to the application. Versions are not expected to
-# follow Semantic Versioning. They should reflect the version the application is using.
-# It is recommended to use it with quotes.
 appVersion: "1.16.0"
