Skip to content

Commit

Permalink
docs:update release 1.18.0-beta docs (#380)
Browse files Browse the repository at this point in the history
  • Loading branch information
chuntaojun authored Jan 9, 2024
1 parent c99bd49 commit f0fdff7
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ weight: 2

以全量同步服务的模式启动 polaris-controller,将 K8s Service 全部同步到北极星,则 polaris-controller 的启动配置如下:

> polaris-controller 启动配置文件:[configmap.yaml](https://github.com/polarismesh/polaris-controller/blob/main/deploy/kubernetes_v1.22/configmap.yaml)
> polaris-controller 启动配置文件:[configmap.yaml](https://github.com/polarismesh/polaris-controller/blob/main/deploy/kubernetes_v1.22/kubernetes/configmap.yaml)
```yaml
apiVersion: v1
Expand All @@ -49,7 +49,7 @@ data:
以按需同步服务的模式启动 polaris-controller,默认不会将 K8s Service 同步到北极星,则 polaris-controller 的启动配置如下:
> polaris-controller 启动配置文件:[configmap.yaml](https://github.com/polarismesh/polaris-controller/blob/main/deploy/kubernetes_v1.22/configmap.yaml)
> polaris-controller 启动配置文件:[configmap.yaml](https://github.com/polarismesh/polaris-controller/blob/main/deploy/kubernetes_v1.22/kubernetes/configmap.yaml)
```yaml
apiVersion: v1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linkTitle: "K8s 配置同步(Beta)"
weight: 3
---

{{< notice tip >}} 该文章仅适用于北极星服务端版本 >= 1.18.0 {{< /notice >}}
{{< notice tip >}} 该文章仅适用于北极星服务端版本 >= 1.18.0, polaris-controller 版本 >= 1.7.0 {{< /notice >}}

支持两种 K8s ConfigMap 同步模式:

Expand All @@ -19,11 +19,31 @@ weight: 3

## 使用指南

### controller 配置解析

```yaml
configSync:
# 是否开启配置同步
enable: true
# 北极星服务端地址
serverAddress: #POLARIS_HOST#
# 北极星开启鉴权时需要配置
accessToken: #POLARIS_TOKEN#
# 是否开启删除操作,即允许删除 ConfigMap 或者北极星上的配置文件
allowDelete: false
# 配置同步方向: kubernetesToPolaris|polarisToKubernetes|both
# kubernetesToPolaris: 只能将 ConfigMap 同步到北极星中
# polarisToKubernetes: 只能将北极星配置文件中带有 internal-sync-to-kubernetes: true 标签的配置文件同步到 ConfigMap
# both: 上述两种同时开启
syncDirection: both
defaultGroup: "#CLUSTER_NAME#"
```
### 全量同步服务
以全量同步配置的模式启动 polaris-controller,将 K8s ConfigMap 全部同步到北极星,则 polaris-controller 的启动配置如下:
> polaris-controller 启动配置文件:[configmap.yaml](https://github.com/polarismesh/polaris-controller/blob/main/deploy/kubernetes_v1.22/configmap.yaml)
> polaris-controller 启动配置文件:[configmap.yaml](https://github.com/polarismesh/polaris-controller/blob/main/deploy/kubernetes_v1.22/kubernetes/configmap.yaml)
```yaml
apiVersion: v1
Expand All @@ -40,7 +60,7 @@ data:
以按需同步配置的模式启动 polaris-controller,默认不会将 K8s ConfigMap 同步到北极星,则 polaris-controller 的启动配置如下:
> polaris-controller 启动配置文件:[configmap.yaml](https://github.com/polarismesh/polaris-controller/blob/main/deploy/kubernetes_v1.22/configmap.yaml)
> polaris-controller 启动配置文件:[configmap.yaml](https://github.com/polarismesh/polaris-controller/blob/main/deploy/kubernetes_v1.22/kubernetes/configmap.yaml)
```yaml
apiVersion: v1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@ global:
开发中...
>
#### 配置中心和 Kubernetes ConfigMap 无缝打通
当前通过 polaris-controller 组件将 Kubernetes 上的 Service 信息同步至北极星中,用户便可以针对 Kubernetes 上的 POD 进行相应的服务治理。但是对于 ConfigMap 这一配置资源的管理却还是只能停留在 Kubernetes;假如北极星能够接管用户的 ConfigMap 管理,用户只需要在北极星控制台上进行配置文件创建、发布即可将配置同步到 ConfigMap 中那么用户还能够享受到配置审计、发布历史、配置回滚等增强功能。因此在 1.18.0-beta 版本中我们支持了北极星和 Kubernetes ConfigMap 资源的数据打通能力,用户只需要部署 polaris-controller 1.7.0-beta 版本即可,相关使用文档参考 [K8s 配置同步](/docs/使用指南/k8s和网格代理/k8s-配置同步/)
## 版本变化
Expand Down

0 comments on commit f0fdff7

Please sign in to comment.