update at 2024-05-14 10:52:39

content/cases/home-network/prepare.md

@@ -1,4 +1,4 @@
-# 云原生环境准备工作
+# K3S 安装与声明式配置管理方式
 
 ## 安装 k3s
 
@@ -13,21 +13,77 @@ curl -sfL https://rancher-mirror.rancher.cn/k3s/k3s-install.sh | INSTALL_K3S_MIR
 	--disable=traefik,local-storage,metrics-server
 ```
 
-> 参考 [k3s 官方安装文挡](https://docs.k3s.io/zh/quick-start)
+要点解析：
+* 作为路由器，不需要用到很多高级能力，安装的时候将不需要的能力禁用下，以便让 k3s 更加精简。
+* 如果有数据盘，或者插了移动硬盘，挂载到 `/data` 目录，可以指定 k3s 的数据目录使用该目录下的子目录，节约系统盘容量。
 
-## 应用部署与配置维护方式
+> 后续要升级也使用上面相同的命令，参考 [k3s 官方安装文挡](https://docs.k3s.io/zh/quick-start)
 
-使用 kubernetes 的 YAML 进行声明式部署，YAML 通过 kustomize 引用，应用的相关配置文件通过 kustomize 自动生成相关的 ConfigMap 或 Secret 挂载进去。如果应用使用 helm chart 渲染，在 kustomize 中也可以被引用。
+## 使用 kustomize 维护 YAML 和应用所需的配置
 
-每个应用使用一个目录来声明所有 yaml 和所需配置，在目录内执行以下命令安装到 k3s:
+1. 使用 `kubernetes` 的 YAML 进行声明式部署，YAML 通过 `kustomize` 引用。
+2. 应用的相关配置文件通过 `kustomize` 自动生成相关的 `ConfigMap` 或 `Secret` 挂载进去。
+3. 如果应用使用 helm chart 渲染，在 `kustomize` 中也可以被引用。
+4. 每个应用使用一个目录来声明所有 YAML 和所需配置，
+
+举个例子，部署 `dnsmasq` 时使用如下的 `kustomize` 目录结构：
+
+```yaml
+dnsmasq
+├── config
+│   └── dnsmasq.conf
+├── daemonset.yaml
+└── kustomization.yaml
+```
+
+其中 `daemonset.yaml` 是 dnsmasq Daemonset 的 YAML 声明，在 `kustomization.yaml` 中通过 `resources` 引用：
+
+```yaml
+resources:
+  - daemonset.yaml
+```
+
+而 `dnsmasq` 应用所需的配置文件 `dnsmasq` 通过 `configMapGenerator` 来生成：
+
+```yaml
+configMapGenerator:
+  - name: dnsmasq-config
+    files:
+      - config/dnsmasq.conf
+```
+
+在 `daemonset.yaml` 中引用并挂载该 ConfigMap：
+
+```yaml
+  template:
+    ...
+    spec:
+      containers:
+        - name: dnsmasq
+          ...
+          volumeMounts:
+            - mountPath: /etc/dnsmasq.conf
+              name: dnsmasq-config
+              subPath: dnsmasq.conf
+      volumes:
+        - configMap:
+            name: dnsmasq-config
+          name: dnsmasq-config
+```
+
+> 最终渲染出的 YAML，生产的 ConfigMap 名称会加上一个 hash 后缀，由 ConfigMap 内容决定，如果内容有变动，hash 后缀也会变动，所以只要配置文件变化就会触发 Pod 重建，也就实现了应用的配置重新加载。
+
+最后，在目录内执行以下命令将应用安装到 k3s:
 
 ```bash
 kustomize build --enable-helm --load-restrictor=LoadRestrictionsNone . | kubectl apply -f -
 ```
 
-如果要一键部署，在上层目录中再建一个 `kustomization.yaml` 引用所有应用的目录，然后在上层目录中执行上面相同的命令可以实现所有应用一键部署。
+> `kustomize` 已经内置到了 `kubectl`，你也可以不用安装 `kustomize`，直接使用 `kubectl kustomize` 子命令代替 `kustomize`。
 
-## YAML 声明方式
+如果要一键部署所有应用，可以在上层目录中再建一个 `kustomization.yaml` 引用所有应用的目录，然后在上层目录中执行上面相同的命令可以实现所有应用的一键部署。
+
+## 声明 YAML 的原则
 
 使用云原生的方式主要为了实现容器化、声明式管理的能力，不引入其它复杂的特性，所以考虑：