From 6bb9a2dddd29c0cf7496fa195c8c3ea4fa985b11 Mon Sep 17 00:00:00 2001 From: SkyeBeFreeman <928016560@qq.com> Date: Fri, 7 Jan 2022 11:52:34 +0800 Subject: [PATCH] docs:add configuration of namespace in docs --- .../spring-cloud-tencent-polaris-discovery.md | 29 ++++++++++--------- .../spring-cloud-tencent-polaris-discovery.md | 5 ++-- ...itional-spring-configuration-metadata.json | 2 +- 3 files changed, 19 insertions(+), 17 deletions(-) diff --git a/spring-cloud-tencent-docs/src/main/doc-zh/spring-cloud-tencent-polaris-discovery.md b/spring-cloud-tencent-docs/src/main/doc-zh/spring-cloud-tencent-polaris-discovery.md index 4f93ae87..91a935ac 100644 --- a/spring-cloud-tencent-docs/src/main/doc-zh/spring-cloud-tencent-polaris-discovery.md +++ b/spring-cloud-tencent-docs/src/main/doc-zh/spring-cloud-tencent-polaris-discovery.md @@ -82,18 +82,19 @@ spring: ## 配置列表 -| 配置项Key | 默认值 |是否必填| 配置项说明 | -| ----------------------------------------------- | -----------------------| --------- | ---------------------------- | -| spring.cloud.polaris.server-addr | 无 |是| Polaris后端地址 | -| spring.cloud.polaris.discovery.service | ${spring.application.name} |否| 服务名称 | -| spring.cloud.polaris.discovery.enabled | true |否| 是否开启服务注册与发现 | -| spring.cloud.polaris.discovery.instance-enabled | true |否| 当前微服务实例是否可以被访问 | -| spring.cloud.polaris.discovery.token | 无 |否| 鉴权Token | -| spring.cloud.polaris.discovery.version | null |否| 微服务版本 | -| spring.cloud.polaris.protocol | null |否| 微服务协议类型 | -| spring.cloud.polaris.weight | 100 |否| 微服务权重 | -| spring.cloud.loadbalancer.polaris.enabled | true |否| 是否开启负载均衡 | -| spring.cloud.loadbalancer.polaris.strategy | weighted_random |否| 负载均衡策略 | -| spring.cloud.tencent.metadata.content | 无 |否| 自定义元数据，为Map结构 | -| spring.cloud.tencent.metadata.transitive | 无 |否| 需要传递的自定义元数据的key列表，为List结构 | +| 配置项Key | 默认值 | 是否必填 | 配置项说明 | +|-------------------------------------------------|----------------------------|------|---------------------------| +| spring.cloud.polaris.server-addr | 无 | 是 | Polaris后端地址 | +| spring.cloud.polaris.discovery.service | ${spring.application.name} | 否 | 服务名称 | +| spring.cloud.polaris.discovery.enabled | true | 否 | 是否开启服务注册与发现 | +| spring.cloud.polaris.discovery.namespace | default | 否 | 服务所在的命名空间名称 | +| spring.cloud.polaris.discovery.instance-enabled | true | 否 | 当前微服务实例是否可以被访问 | +| spring.cloud.polaris.discovery.token | 无 | 否 | 鉴权Token | +| spring.cloud.polaris.discovery.version | null | 否 | 微服务版本 | +| spring.cloud.polaris.protocol | null | 否 | 微服务协议类型 | +| spring.cloud.polaris.weight | 100 | 否 | 微服务权重 | +| spring.cloud.loadbalancer.polaris.enabled | true | 否 | 是否开启负载均衡 | +| spring.cloud.loadbalancer.polaris.strategy | weighted_random | 否 | 负载均衡策略 | +| spring.cloud.tencent.metadata.content | 无 | 否 | 自定义元数据，为Map结构 | +| spring.cloud.tencent.metadata.transitive | 无 | 否 | 需要传递的自定义元数据的key列表，为List结构 | diff --git a/spring-cloud-tencent-docs/src/main/doc/spring-cloud-tencent-polaris-discovery.md b/spring-cloud-tencent-docs/src/main/doc/spring-cloud-tencent-polaris-discovery.md index 7b8eac0c..a692c1f0 100644 --- a/spring-cloud-tencent-docs/src/main/doc/spring-cloud-tencent-polaris-discovery.md +++ b/spring-cloud-tencent-docs/src/main/doc/spring-cloud-tencent-polaris-discovery.md @@ -80,10 +80,11 @@ Taking examples like random weight policy, you can add weight at Polaris control ## Configuration LIst | ConfigurationKey | default | Yes/No required | Configuration Instruction | -| ----------------------------------------------- | -------------------------- | --------------- | ---------------------------------------------------- | +|-------------------------------------------------|----------------------------|-----------------|------------------------------------------------------| | spring.cloud.polaris.server-addr | false | yes | Polaris backend address | | spring.cloud.polaris.discovery.service | ${spring.application.name} | null | service name | | spring.cloud.polaris.discovery.enabled | true | false | whether to active service registration and discovery | +| spring.cloud.polaris.discovery.namespace | default | false | the namespace of service | | spring.cloud.polaris.discovery.instance-enabled | true | false | can current Microservice be visited | | spring.cloud.polaris.discovery.token | false | false | Authentication Token | | spring.cloud.polaris.discovery.version | null | false | Microservice Version | @@ -91,6 +92,6 @@ Taking examples like random weight policy, you can add weight at Polaris control | spring.cloud.polaris.weight | 100 | false | Microservice weight | | spring.cloud.loadbalancer.polaris.enabled | true | false | whether to open CLB | | spring.cloud.loadbalancer.polaris.strategy | weighted_random | false | CLB policy | -| spring.cloud.tencent.metadata.content | null | false | custom metadata Map | +| spring.cloud.tencent.metadata.content | null | false | custom metadata Map | | spring.cloud.tencent.metadata.transitive | null | false | need custom metadata key list | diff --git a/spring-cloud-tencent-starters/spring-cloud-starter-tencent-polaris-discovery/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/spring-cloud-tencent-starters/spring-cloud-starter-tencent-polaris-discovery/src/main/resources/META-INF/additional-spring-configuration-metadata.json index 68ab3582..ba5ec807 100644 --- a/spring-cloud-tencent-starters/spring-cloud-starter-tencent-polaris-discovery/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/spring-cloud-tencent-starters/spring-cloud-starter-tencent-polaris-discovery/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -10,7 +10,7 @@ "name": "spring.cloud.polaris.discovery.namespace", "type": "java.lang.String", "defaultValue": "default", - "description": "the namespace of service, default value is ${spring.application.name}." + "description": "the namespace of service, default value is \"default\"." }, { "name": "spring.cloud.polaris.discovery.enabled",