update docs for okg v0.8.0 (#180)

Signed-off-by: ChrisLiu <chrisliu1995@163.com>
openkruise · Apr 29, 2024 · df5bd31 · df5bd31
1 parent 54e48df
commit df5bd31
Show file tree

Hide file tree

Showing 30 changed files with 4,976 additions and 11 deletions.
diff --git a/i18n/zh/docusaurus-plugin-content-docs-kruisegame/current/installation.md b/i18n/zh/docusaurus-plugin-content-docs-kruisegame/current/installation.md
@@ -4,7 +4,7 @@
 
 ### 安装说明
 
-安装OpenKruiseGame需安装Kruise与Kruise-Game，且要求 Kubernetes版本 >= 1.16。
+安装OpenKruiseGame需安装Kruise与Kruise-Game，且要求 Kubernetes版本 >= 1.18。
 
 ### 安装Kruise
 
@@ -16,19 +16,19 @@ $ helm repo add openkruise https://openkruise.github.io/charts/
 # [Optional]
 $ helm repo update
 # Install the latest version.
-$ helm install kruise openkruise/kruise --version 1.5.4
+$ helm install kruise openkruise/kruise --version 1.6.3
 ```
 
 ### 安装Kruise-Game
 
 ```shell
-$ helm install kruise-game openkruise/kruise-game --version 0.7.0
+$ helm install kruise-game openkruise/kruise-game --version 0.8.0
 ```
 
 ### 升级 Kruise-Game
 
 ```shell
-$ helm upgrade kruise-game openkruise/kruise-game --version 0.7.0 [--force]
+$ helm upgrade kruise-game openkruise/kruise-game --version 0.8.0 [--force]
 ```
 
 ### 可选项
@@ -49,7 +49,7 @@ $ helm upgrade kruise-game openkruise/kruise-game --version 0.7.0 [--force]
 | `kruiseGame.apiServerQpsBurst`   | kruise-game-controller-manager 每秒发送到 API server的最大突发查询数 | `10`                             |
 | `replicaCount`                   | kruise-game 的期望副本数                                      | `1`                              |
 | `image.repository`               | kruise-game 的镜像仓库                                       | `openkruise/kruise-game-manager` |
-| `image.tag`                      | kruise-game 的镜像版本                                       | `v0.6.0`                         |
+| `image.tag`                      | kruise-game 的镜像版本                                       | `v0.8.0`                         |
 | `image.pullPolicy`               | kruise-game 的镜像拉取策略                                     | `Always`                         |
 | `serviceAccount.annotations`     | kruise-game的serviceAccount注解                            | ` `                              |
 | `resources.limits.cpu`           | kruise-game容器的CPU资源限制                                   | `500m`                           |

diff --git a/...aurus-plugin-content-docs-kruisegame/current/user-manuals/deploy-gameservers.md b/...aurus-plugin-content-docs-kruisegame/current/user-manuals/deploy-gameservers.md
@@ -170,4 +170,22 @@ PING minecraft-2.minecraft.default.svc.cluster.local (172.16.0.12): 56 data byte
 64 bytes from 172.16.0.12: seq=2 ttl=63 time=0.072 ms
 ```
 
-可以发现，accessor访问minecraft-2成功，DNS成功解析到对应的内网IP地址。在这里的DNS访问规则如下：{pod-name}.{gss-name}.{namespace-name}.svc.cluster.local
+可以发现，accessor访问minecraft-2成功，DNS成功解析到对应的内网IP地址。在这里的DNS访问规则如下：{pod-name}.{gss-name}.{namespace-name}.svc.cluster.local
+
+## GameServer 与 Pod 注释同步
+
+如上所述，通过 DownwardAPI 可以将 pod annotation的信息下沉至容器中。我们有时希望将 GameServer 的 annotation 可以同步到 Pod 上，以完成GameServer元数据信息的下沉动作。
+
+OKG 支持以 "gs-sync/" 开头的 annotation 从 GameServer 同步到 Pod 之上，如下所示：
+
+```bash
+kubectl patch gs minecraft-0 --type='merge'  -p  '{"metadata":{"annotations":{"gs-sync/test-key":"some-value"}}}'
+gameserver.game.kruise.io/minecraft-0 patched
+```
+
+此时查看 pod 注释，发现可以找到对应key-value：
+
+```bash
+kubectl get po minecraft-0 -oyaml | grep gs-sync
+    gs-sync/test-key: some-value
+```