更新文档

Author: imroc

README.md

@@ -2,8 +2,6 @@
 
 针对 TKE 集群一些特殊场景的的网络控制器。
 
-[API 参考](docs/api.md)
-
 ## 支持房间类场景
 
 目前主要支持会议、游戏战斗服等房间类场景的网络，即要求每个 Pod 都需要独立的公网地址，TKE 集群默认只支持 EIP 方案，但 EIP 资源有限，不仅是数量的限制，还有每日申请的数量限制，稍微上点规模，或频繁扩缩容更换EIP，可能很容易触达限制导致 EIP 分配失败；而如果保留 EIP，在 EIP 没被绑定前，又会收取额外的闲置费。
@@ -132,9 +130,13 @@ status:
 
 然后 controller 根据 `DedicatedCLBListener` 进行对账，自动将 Pod 绑定到对应的 CLB 监听器上。
 
-## 使用 NAT 网关为 Pod 分配公网地址映射
+## 更多
 
-TODO
+* [CRD 字段说明](docs/crd.md)
+* [API 参考](docs/api.md)
+* [Roadmap](docs/roadmap.md)
+* [贡献指南](docs/contributing.md)
+* [技术亮点](docs/inside.md)
 
 ## 项目状态与版本说明
 

docs/contributing.md

@@ -0,0 +1,11 @@
+# 贡献指南
+
+欢迎参与本项目的开发，贡献代码或文档。
+
+## 使用 kubebuilder 生成
+
+本项目的控制器代码使用 `kubebuilder` 生成，基于 [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime) 框架，具体请参考 [kubebuilder 官方文档](https://book.kubebuilder.io/quick-start.html)。
+
+## 沟通
+
+有任何疑问或需求，欢迎通过 [issue](https://github.com/imroc/tke-extend-network-controller/issues/new) 联系我们。

docs/api-design.md renamed to docs/crd.md

@@ -1,4 +1,4 @@
-# API 设计
+# API 设计与字段说明
 
 ## DedicatedCLBService
 

docs/develop.md

@@ -0,0 +1,9 @@
+# 技术亮点
+
+## Pod 缓存
+
+控制器除了 list watch 自身 CRD 相关资源外，还 list watch 了 Pod 资源，而大规模场景下，全量 Pod 缓存占用内存较大，因为在 Pod 入缓存前，只保留本控制器关注的字段，其他字段不缓存，这样可大大降低内存占用。当要更新 Pod 时（比如注解和finalizer），就不直接拿缓存里的 Pod 进行 Update（因为缓存字段不全，无法直接 Update），而是先从 API Server 获取 Pod，再更新。
+
+## 并发与实例锁
+
+很多CLB的写接口都有实例锁，且是异步的，并发调用或间隔太短都容易导致实例锁冲突，最终导致接口调用失败。在实现时，我们将异步的接口调用包装成同步的函数(内部通过轮询查询异步任务的状态直到任务结束来实现将异步转为同步)，再通过加锁的方式，保证每个CLB实例的写操作的原子性，即避免并发冲突，又做到了尽可能快的对账操作（避免CLB的写操作延迟导致流量异常）。

docs/inside.md

@@ -0,0 +1,4 @@
+# Roadmap
+
+* [ ] `DedicatedCLBService` 支持自动创建CLB。
+* [ ] 支持使用 NAT 网关映射 IP:Port。