update doc to release v0.7.0

MouceL · cywang1905 · commit b127208bef5a · 2023-03-24T17:35:14.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.idea/*
diff --git a/docs/getting-started/ROADMAP.md b/docs/getting-started/ROADMAP.md
@@ -65,41 +65,48 @@
 
 详见 [v0.6.0](https://github.com/slime-io/slime/releases/tag/v0.6.0)
 
-## 四、Slime v0.7.0（规划中）
 
-**流量管理**
-- 【配置懒加载】支持 ServiceEntry 服务
-- 【智能熔断】发布服务网格熔断标准 API
-- 【智能熔断】发布智能熔断新特性
-- 【插件管理】支持服务级别插件下发
 
+## 四、Slime v0.7.0（已发布）
+
+优化处理了很多实践过程中遇到的问题
 
 **运维管理**
 
-- 实现 WASM 插件分发端到端功能
+- 【配置懒加载】支持workload servicefence，结合meshregistry，可以支持serviceEntry类型服务的配置懒加载
+- 【基础能力】支持作为xds server,对外提供从istio处获取的xds数据
 
-**产品化**
+**流量管理**
 
-- 【UI】新增 UI 模块，实现资源 CRUD
-- 【UI】展示上下游资源关联性
+- 【智能限流】限流模块支持workloadselector
 
+**扩展管理**
 
-## 五、Slime v0.8.0（规划中）
+- 【注册中心】支持对接开启认证的nacos，支持根据元数据筛选服务实例
+
+## Slime v0.8.0（规划中）
 
 **流量管理**
 
-- 【智能降级】发布智能降级新特性
+- 【智能降级】发布服务网格降级标准 API
+- 【智能降级】发布智能降级新模块
 
 **运维管理**
 
 - 【配置懒加载】发布服务网格配置精准推送标准 API
 
-**工程**
+**扩展管理**
+
+- 【插件管理】支持服务级别插件下发
 
-- 支持 Istio Ambient 路线
-- 适配 SMI
 
-**产品化**
+## Slime v0.9.0（规划中）
+
+**运维管理**
+- 前端控制台
 
-- 【UI】重点模块特化展示，如懒加载的服务拓扑图、限流触发状态、排障操作界面、wasm插件分发等
 
+**工程**
+
+- 支持 Istio Ambient 路线
+- 适配 SMI
diff --git a/docs/release/v0.7.0.md b/docs/release/v0.7.0.md
@@ -0,0 +1,28 @@
+# slime v0.7.0
+
+NOTE: 子模块代码，可前往 [lazyload/limiter/plugin](https://github.com/slime-io/slime/tree/master/staging/src/slime.io/slime/modules) 和 [i9s](https://github.com/slime-io/i9s)
+
+**DATE: 20230324**
+
+## 新特性
+- lazyload: 支持ServiceEntry类型服务，现在可以同时支持K8s Service与ServiceEntry服务
+- lazyload: 支持透传ipv4格式的域名请求，避免兜底到global-sidecar
+- limiter: 支持请求参数匹配条件
+- limiter: 支持限流触发时，自定义响应头
+- meshregistry: 支持对接开启认证的 Nacos
+- framework: 支持作为xds server,对外提供从istio处获取的xds数据
+
+
+## 变更
+- meshregistry: 优化对ZooKeeper watch模式，请求量最高可降低 50%
+- meshregistry: 支持本身配置的热更新，无需重启 Slime
+- lazyload: gloabal-sidecar新增了service controller，用于在转发前进行域名查询
+- limiter: 升级go-control-plane至v0.11.0
+- framework: 优化了模块中clientSet的使用
+
+## 修复
+
+- lazyload: 修复record导致的sidecar无法生成的问题
+- lazyload: 修复错误的sidecar gvk导致的无法触发reconcile的问题
+- limiter:  修复连续两次相同spec导致无法生成envoyfilter的问题
+- framework: 修复了slimeboot中模块开关不生效的问题
diff --git a/docs/user-guide/image-usage.md b/docs/user-guide/image-usage.md
@@ -40,9 +40,10 @@ TARGET_GOARCH=arm64 ./publish.sh build image
 # 等同于 ./publish.sh ALL
 ```
 
+
 ### 构建多架构镜像
 
-切换至子模块所在目录,运行以下命令构建多架构镜像,默认hub地址在 `slime/bin/publish`中定义
+切换至子模块所在目录,运行以下命令构建多架构镜像,默认hub地址在 `slime/bin/publish.sh` 中定义
 
 ```sh
 ./publish.sh publish amd64 arm64
@@ -52,15 +53,16 @@ TARGET_GOARCH=arm64 ./publish.sh build image
 
 ### 构建amd64镜像
 
-切换至 slime/modules/bundle_example 目录, 运行以下命令构建bundle的amd64镜像
+切换至 slime/staging/src/slime.io/slime/modules/bundle-all 目录, 运行以下命令构建bundle的amd64镜像
+
 
 ```sh
 ./publish.sh build image
 ```
 
 ### 构建多架构镜像
 
-切换至 slime/modules/bundle_example 目录,运行以下命令构建多架构镜像
+切换至 slime/staging/src/slime.io/slime/modules/bundle-all 目录,运行以下命令构建多架构镜像
 
 ```sh
 ./publish.sh publish amd64 arm64
diff --git a/docs/user-guide/lazyload/tutorial.md b/docs/user-guide/lazyload/tutorial.md
@@ -8,15 +8,24 @@
 
 安装懒加载前，需要先安装 `SlimeBoot CRD`， `ServiceFence CRD`和`deployment/slime-boot`。这一步是为了准备好懒加载需要的 CRD 以及懒加载模块的启动器。不同 k8s 版本的安装文件略有区别，详见 [SlimeBoot 介绍与使用 - 准备](../slime-boot/tutorial.md) 。
 
-此处我们假设 k8s version 为1.16+
+**note** 需要注意的是如果网络无法访问，你可以在slime项目的`slime/install/init/`目录发现相关部署文件
 
-```sh
+- k8s version >= v1.22
+```shell
 export tag_or_commit=$(curl -s https://api.github.com/repos/slime-io/slime/tags | grep 'name' | cut -d\" -f4 | head -1)
 kubectl create ns mesh-operator
 kubectl apply -f "https://raw.githubusercontent.com/slime-io/slime/$tag_or_commit/install/init/crds-v1.yaml"
 kubectl apply -f "https://raw.githubusercontent.com/slime-io/slime/$tag_or_commit/install/init/deployment_slime-boot.yaml"
 ```
 
+- k8s v1.16 <= version < 1.22
+```shell
+export tag_or_commit=$(curl -s https://api.github.com/repos/slime-io/slime/tags | grep 'name' | cut -d\" -f4 | head -1)
+kubectl create ns mesh-operator
+kubectl apply -f "https://raw.githubusercontent.com/slime-io/slime/$tag_or_commit/install/init/crds.yaml"
+kubectl apply -f "https://raw.githubusercontent.com/slime-io/slime/$tag_or_commit/install/init/deployment_slime-boot.yaml"
+```
+
 确认所有组件已正常运行
 
 ```sh
@@ -30,7 +39,8 @@ slime-boot-6f778b75cd-4v675       1/1     Running   0          26s
 创建 `SlimeBoot` CR
 
 ```sh
-$ echo 'apiVersion: config.netease.com/v1alpha1
+$ echo '
+apiVersion: config.netease.com/v1alpha1
 kind: SlimeBoot
 metadata:
   name: lazyload
@@ -39,44 +49,41 @@ spec:
   image:
     pullPolicy: Always
     repository: docker.io/slimeio/slime-lazyload
-    tag: v0.5.0_linux_amd64
-  resources:
-    requests:
-      cpu: 300m
-      memory: 300Mi
-    limits:
-      cpu: 600m
-      memory: 600Mi
+    tag: v0.7.0
+  namespace: mesh-operator
+  istioNamespace: istio-system
   module:
-    - name: lazyload # custom value
-      kind: lazyload # should be "lazyload"
+    - name: lazyload
+      kind: lazyload
       enable: true
-      general: # replace previous "fence" field
-        autoPort: false
+      general:
+        autoPort: true
         autoFence: true
-        defaultFence: false
+        defaultFence: true   
         wormholePort: # replace to your application service ports, and extend the list in case of multi ports
           - "9080"
       global:
         log:
           logLevel: info
         misc:
-          globalSidecarMode: cluster # inform the mode of global-sidecar
+          globalSidecarMode: cluster # the mode of global-sidecar
           metricSourceType: accesslog # indicate the metric source
+        slimeNamespace: mesh-operator
+  resources:
+    requests:
+      cpu: 300m
+      memory: 300Mi
+    limits:
+      cpu: 600m
+      memory: 600Mi        
   component:
     globalSidecar:
       enable: true
       sidecarInject:
         enable: true # should be true
-        # mode definition:
-        # "pod": sidecar auto-inject on pod level, need provide labels for injection
-        # "namespace": sidecar auto-inject on namespace level, no need to provide labels for injection
-        # if globalSidecarMode is cluster, global-sidecar will be deployed in slime namespace, which does not enable auto-inject on namespace level, mode can only be "pod".
-        # if globalSidecarMode is namespace, depending on the namespace definition, mode can be "pod" or "namespace".
         mode: pod
         labels: # optional, used for sidecarInject.mode = pod
           sidecar.istio.io/inject: "true"
-          # istio.io/rev: canary # use control plane revisions
       resources:
         requests:
           cpu: 200m
@@ -86,11 +93,11 @@ spec:
           memory: 400Mi
       image:
         repository: docker.io/slimeio/slime-global-sidecar
-        tag: v0.5.0_linux_amd64
+        tag: v0.7.0
       probePort: 20000
 ' > /tmp/lazyload-slimeboot.yaml
 
-$ kubectl apply -f /tmp/lazyload-slimeboot.yaml
+  kubectl apply -f /tmp/lazyload-slimeboot.yaml
 ```
 
 一些字段说明，可参考 [lazyload安装样例](../slime-boot/tutorial.md)
@@ -140,7 +147,17 @@ reviews-v3-84779c7bbc-gb52x       2/2     Running   0          60s
 
 ### 开启懒加载
 
-修改service的label，自动创建servicefence，为productpage服务启用懒加载
+由于我们在下发的slimeboot中指定了以下配置，所以默认情况下自动开启了懒加载
+
+```
+  autoPort: true
+  autoFence: true
+  defaultFence: true
+```
+
+如果`defaultFence: false`
+
+那么需要用户手动修改service的label，自动创建servicefence，为productpage服务启用懒加载
 
 ```sh
 $ kubectl label service productpage -n default slime.io/serviceFenced=true
@@ -316,7 +333,20 @@ $ kubectl delete -f "https://raw.githubusercontent.com/slime-io/slime/v0.5.0/ins
 卸载 lazyload
 
 ```sh
-$ kubectl delete -f /tmp/lazyload-slimeboot.yaml
+kubectl delete -f /tmp/lazyload-slimeboot.yaml
+kubectl get envoyfilter -n istio-system | grep to-global-sidecar && kubectl delete envoyfilter to-global-sidecar -n istio-system
+```
+
+卸载 servicefence
+
+```
+kubectl get svf -A |awk '{print "kubectl delete svf "$2" -n "$1" "}' |bash
+```
+
+确认集群中 svf已经清理完毕 
+
+```
+kubectl get svf -A
 ```
 
 卸载 slime-boot
@@ -328,6 +358,7 @@ kubectl delete -f "https://raw.githubusercontent.com/slime-io/slime/$tag_or_comm
 kubectl delete ns mesh-operator
 ```
 
+**note** 需要注意的是，如果手动修改过mesh-operator下存在一些envoyfilter和cm，可手动删除
 
 ## 特性介绍
 
@@ -801,7 +832,7 @@ spec:
   image:
     pullPolicy: Always
     repository: docker.io/slimeio/slime-lazyload
-    tag: master-e5f2d83-dirty_1b68486
+    tag: v0.7.0
   module:
     - name: lazyload # custom value
       kind: lazyload # should be "lazyload"
@@ -818,7 +849,7 @@ spec:
             maxBackups: 10
             maxAgeDay: 10
             compress: true
-#...
+#... skip
   volumes:
     - name: lazyload-storage
       persistentVolumeClaim:
diff --git a/docs/user-guide/meshregistry/tutorial.md b/docs/user-guide/meshregistry/tutorial.md
@@ -24,33 +24,33 @@ spec:
   image:
     pullPolicy: Always
     repository: docker.io/slimeio/slime-meshregistry
-    tag: v0.6.0_linux_amd64
+    tag: v0.7.0
   module:
     - name: meshregistry
       kind: meshregistry
       enable: true
-      global:
-        log:
-          logLevel: info
       general:
         LEGACY:
-         MeshConfigFile: ""
-         RevCrds: ""
-         Mcp:
-           EnableIncPush: false
-         K8SSource:
-           Enabled: false
-         EurekaSource:
-           Enabled: true
-           Address:
-           - "http://eureka.myeureka.com/eureka"
-           RefreshPeriod: 15s
-           SvcPort: 80
-         ZookeeperSource:
-           Enabled: true
-           RefreshPeriod: 30s
-           WaitTime: 10s
-           # EnableDubboSidecar: false
-           Address:
-           - zookeeper.myzk.cluster.local:2181
+          MeshConfigFile: ""
+          RevCrds: ""
+          Mcp: {}
+          K8SSource:
+            Enabled: false
+#          EurekaSource:
+#            Enabled: true
+#            Address:
+#              - "http://test/eureka"
+#            RefreshPeriod: 15s
+#            SvcPort: 80
+#          NacosSource:
+#            Enabled: true
+#            Address:
+#              - "http://test.com"
+#            Mode: polling
+#          ZookeeperSource:
+#            Enabled: true
+#            RefreshPeriod: 30s
+#            WaitTime: 10s
+#            Address:
+#              - zookeeper.test.svc.cluster.local:2181
 ```
diff --git a/docs/user-guide/slime-boot/feature.md b/docs/user-guide/slime-boot/feature.md
@@ -15,7 +15,7 @@ spec:
   image:
     pullPolicy: Always
     repository: docker.io/slimeio/slime-limiter
-    tag: v0.6.0_linux_amd64
+    tag: v0.7.0
   module:
     - name: limiter
       kind: limiter
@@ -24,11 +24,6 @@ spec:
         disableGlobalRateLimit: true
         disableAdaptive: true
         disableInsertGlobalRateLimit: true
-      global:
-        log:
-          logLevel: info
-        configSources:
-          - address: ss:// 
         misc:
           enable-leader-election: "on"  #多副本
 ```
diff --git a/docs/user-guide/slime-boot/tutorial.md b/docs/user-guide/slime-boot/tutorial.md
diff --git a/nav.yml b/nav.yml
