调整中文文档

Author: zbb88888

PROJECT

@@ -9,7 +9,7 @@ plugins:
   manifests.sdk.operatorframework.io/v2: {}
   scorecard.sdk.operatorframework.io/v2: {}
 projectName: vpn-gw
-repo: github.com/bobz965/kube-combo
+repo: github.com/kubecombo/kube-combo
 resources:
 - api:
     crdVersion: v1
@@ -18,7 +18,7 @@ resources:
   domain: kube-combo.com
   group: vpn-gw
   kind: VpnGw
-  path: github.com/bobz965/kube-combo/api/v1
+  path: github.com/kubecombo/kube-combo/api/v1
   version: v1
 - api:
     crdVersion: v1
@@ -27,6 +27,6 @@ resources:
   domain: kube-combo.com
   group: vpn-gw
   kind: IpsecConn
-  path: github.com/bobz965/kube-combo/api/v1
+  path: github.com/kubecombo/kube-combo/api/v1
   version: v1
 version: "3"

README.cn.md

@@ -1,190 +1,12 @@
-# kube-combo
+# Kube-Combo
 
-该项目用于在 kube-ovn-cni 的一个**补充**，用于实现一些 kube-ovn-cni 中属于间接关联的一些网络应用。直接关联的网络功能应直接在 kube-ovn 中实现。
-为了保持该项目的定位的清晰和轻量：
+Kube-Combo 是一款基于 POD 来提供各种各样网元能力的编排系统，提供丰富的功能以及良好的可运维性。
 
-- 该项目最多会对 kube-ovn crd 的存在与否做一些 get 校验，目前不会 CRUD kube-ovn crd 资源。
-- 该项目只会实现 kube-ovn 中所不直接具备的 crd，不会提供关于某个用户场景的需求的多个 CRD 的再次封装为一个新的业务网络功能的 CRD。
-- 在使用上，业务需求方负责对基础 CRD API 接口进行编排，需直接对接 kube-ovn 的 crd，或者，该项目提供的 crd。
+丰富的功能：
 
-## 1. Code init
+如果你发现在 K8S 集群中无法直接使用一些高级的网络功能，比如 IPsec vpn GW，SSL vpn GW，Haproxy，Nginx 等，那么 Kube-Combo 将是你的最佳选择。
+借助 K8S CNI 提供的底层能力，可以通过多 POD 负载结合各种各样的成熟的应用，提供高可用且丰富的网元能力。
 
-``` bash
+良好的可运维性：
 
-operator-sdk init --domain kube-combo.com --repo github.com/bobz965/kube-combo --plugins=go/v4-alpha
-
-# we'll use a domain of kube-combo.com
-# so all API groups will be <group>.kube-combo.com
-
-# --plugins=go/v4-alpha  mac arm 芯片需要指定
-
-# 该步骤后可创建 api
-# operator-sdk create api
-operator-sdk create api --group vpn-gw --version v1 --kind VpnGw --resource --controller
-operator-sdk create api --group vpn-gw --version v1 --kind IpsecConn --resource --controller
-
-
-#  make generate   生成controller 相关的 informer clientset 等代码
- 
-## 下一步就是编写crd
-## 重新生成代码
-## 编写 reconcile 逻辑
-
-### 最后就是生成部署文件
-make manifests
-
-```
-
-## 2. 设计
-
-公网访问方式
-
-- fip
-- router lb （后续的 ha 方案）
-
-### 2.1 ssl vpn
-
-该功能基于 openvpn 实现，可以通过公网 ip，在个人 电脑，手机客户端直接访问 kube-ovn 自定义 vpc subnet 内部的 pod 以及 switch lb 对应是的 svc endpoint。
-
-### 2.2 ipsec vpn
-
-该功能基于 strongSwan 实现，[用于 Site-to-Site 场景](https://github.com/strongswan/strongswan#site-to-site-case) ，推荐使用 IKEv2， IKEv1 安全性较低
-
-strongSwan 的主要包括两个配置
-
-- /etc/swanctl/swanctl.conf
-- /etc/hosts
-
-swanctl 配置中的 connection 中的域名解析 在 /etc/hosts 中管理，这两个配置都基于[j2](https://github.com/kolypto/j2cli) 来生成，基于 pod exec 将 vpn gw 依赖的 ipsec connection crd 中的信息保存在 connection.yaml 中。
-
-``` bash
-
-j2 swanctl.conf.j2 data.yaml
-j2 hosts.j2 data.yaml
-
-# mv swanctl.conf /etc/swanctl/swanctl.conf
-# mv hosts /etc/hosts
-```
-
-## 3. 维护
-
-基于 operator 生命周期管理器（olm）来维护， 可以对接到应用商店 kubeapp。
-
-### 3.1 项目打包
-
-Docker
-
-``` bash
-make docker-build docker-push
-
-# make docker-build 
-# make docker-push
-
-
-# build openvpn image
-
-make docker-build-ssl-vpn docker-push-ssl-vpn
-
-make docker-build-ipsec-vpn docker-push-ipsec-vpn
-
-```
-
-OLM
-
-``` bash
-make bundle bundle-build bundle-push
-
-# make bundle
-# make bundle-build
-# make bundle-push
-
-
-## 目前不支持直接测试，必须要先把bundle 传到 registry，有issue记录: https://github.com/operator-framework/operator-sdk/issues/6432
-
-
-```
-
-### 3.2  部署
-
-目前认为 olm 本身不够成熟，基于 `make deploy` 来部署
-
-``` bash
-
-cd config/manager && /root/kube-combo/bin/kustomize edit set image controller=registry.cn-hangzhou.aliyuncs.com/bobz/kube-combo:latest
-/root/kube-combo/bin/kustomize build config/default | kubectl apply -f -
-
-
-```
-
-[operator-sdk 二进制安装方式](https://sdk.operatorframework.io/docs/installation/)
-
-```bash
-# 在 k8s集群安装该项目
-operator-sdk olm install
-
-## ref https://github.com/operator-framework/operator-lifecycle-manager/releases/tag/v0.24.0
-
-curl -L https://github.com/operator-framework/operator-lifecycle-manager/releases/download/v0.24.0/install.sh -o install.sh
-chmod +x install.sh
-./install.sh v0.24.0
-
-
-# 运行 operator
-
-operator-sdk run bundle registry.cn-hangzhou.aliyuncs.com/bobz/kube-combo-bundle:v0.0.1
-
-# 检查 operator 已安装
-
-kubectl get csv
-
-
-
-## 基于 kubectl apply 运行一个该 operator 维护的 crd
-
-# 清理该 operator
-k get operator
-
-operator-sdk cleanup vpn-gw
-
-```
-
-### 4. certmanager
-
-``` bash
-operator-sdk olm install
-
-# 功能上 operator-sdk == kubectl operator 
-
-kubectl krew install operator
-kubectl create ns cert-manager
-kubectl operator install cert-manager -n cert-manager --channel candidate --approval Automatic --create-operator-group 
-
-# kubectl operator install cert-manager -n operators --channel stable --approval Automatic
-
-kubectl get events -w -n operators
-
-kubectl operator list
-kubectl operator uninstall cert-manager -n cert-manager
-
-# 目前 基于operator 安装的版本普遍较旧，差了一个大版本，可能要跟下 operator 的维护策略
-# 目前认为最好是基于 kubectl apply 安装最新的
-
-kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.12.1/cert-manager.yaml
-kubectl get pods -n cert-manager
-kubectl get crd | grep cert-manager.io
-
-# 清理: https://cert-manager.io/docs/installation/kubectl/
-
-
-```
-
-### 5. 通用性
-
-目前 vpn gw pod 只需要一个 IP，所以只需要保证固定内网 IP 是符合 k8s 通用规范即可保证能够适用于其他 CNI。
-该 IP 对应的 nat， 以及如何公网互联的路由和该功能是完全解耦的。
-
-各大公有云都是 sdn 网络，支持在 k8s 托管， 基于该 vpn gw operator 互相打通，比起申请虚拟机资源部署的方式应该更节省成本。
-
-### 6. 参考
-
-- [一个简单的 ipsec vpn 在公有云部署的项目就可以有 23k 的 star](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/README-zh.md#%E4%B8%8B%E4%B8%80%E6%AD%A5)
+Kube-Combo 支持一键安装，帮助用户迅速搭建生产就绪的网络应用。同时内置的丰富的监控指标和 Grafana 面板，可帮助用户建立完善的监控体系。

cmd/main.go

@@ -32,8 +32,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
-	vpngwv1 "github.com/bobz965/kube-combo/api/v1"
-	"github.com/bobz965/kube-combo/internal/controller"
+	vpngwv1 "github.com/kubecombo/kube-combo/api/v1"
+	"github.com/kubecombo/kube-combo/internal/controller"
 	//+kubebuilder:scaffold:imports
 )
 

doc/strongswan-reference/manual-test-all/01-provision-certificates.sh

@@ -1,4 +1,4 @@
-module github.com/bobz965/kube-combo
+module github.com/kubecombo/kube-combo
 
 go 1.19
 

doc/strongswan-reference/manual-test-all/02-run.sh

@@ -30,8 +30,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/event"
 	"sigs.k8s.io/controller-runtime/pkg/predicate"
 
-	vpngwv1 "github.com/bobz965/kube-combo/api/v1"
 	"github.com/go-logr/logr"
+	vpngwv1 "github.com/kubecombo/kube-combo/api/v1"
 )
 
 const (

doc/strongswan-reference/manual-test-all/03-check.sh

@@ -30,7 +30,7 @@ import (
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
-	vpngwv1 "github.com/bobz965/kube-combo/api/v1"
+	vpngwv1 "github.com/kubecombo/kube-combo/api/v1"
 	//+kubebuilder:scaffold:imports
 )
 

doc/strongswan-reference/manual-test-all/provision-certificates.sh

@@ -39,7 +39,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/event"
 	"sigs.k8s.io/controller-runtime/pkg/predicate"
 
-	vpngwv1 "github.com/bobz965/kube-combo/api/v1"
+	vpngwv1 "github.com/kubecombo/kube-combo/api/v1"
 
 	// kubeovnv1 "github.com/kubeovn/kube-ovn/pkg/apis/kubeovn/v1"
 	appsv1 "k8s.io/api/apps/v1"