This is an automated email from the ASF dual-hosted git repository.
liujun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/dubbo-website.git
The following commit(s) were added to refs/heads/master by this push:
new c3efc2b07a add k8s demo (#1328)
c3efc2b07a is described below
commit c3efc2b07a25db965e0e9b9a5fb43a1fe757c65f
Author: ken.lj <[email protected]>
AuthorDate: Tue Aug 2 20:00:01 2022 +0800
add k8s demo (#1328)
---
.../metadata-center/overview/_index.md | 7 +-
content/zh/overview/tasks/deploy-on-k8s.md | 340 ++++++++++++++++++++-
2 files changed, 343 insertions(+), 4 deletions(-)
diff --git
a/content/zh/docs3-v2/java-sdk/reference-manual/metadata-center/overview/_index.md
b/content/zh/docs3-v2/java-sdk/reference-manual/metadata-center/overview/_index.md
index 6bb7277718..34ef57682c 100644
---
a/content/zh/docs3-v2/java-sdk/reference-manual/metadata-center/overview/_index.md
+++
b/content/zh/docs3-v2/java-sdk/reference-manual/metadata-center/overview/_index.md
@@ -20,7 +20,7 @@ Dubbo3 中引入了 [应用级服务发现机制](/zh/overview/whatsnew/service-
同时为了保持 Dubbo 面向服务/接口的易用性、服务治理的灵活性，Dubbo 围绕应用级服务发现构建了一套元数据机制，即 `接口 - 应用映射关系` 与
`接口配置元数据`。
### 1.1 接口 - 应用映射关系
-Dubbo 一直以来都能做到精确的地址发现，即只订阅 Consumer
声明要关心的服务及相关的地址列表，相比于拉取/订阅全量地址列表，这样觉有很好的性能优势。
+Dubbo 一直以来都能做到精确的地址发现，即只订阅 Consumer
声明要关心的服务及相关的地址列表，相比于拉取/订阅全量地址列表，这样做有很好的性能优势。
在应用级服务发现模型中，想做到精确地址订阅并不容易，因为 Dubbo Consumer 只声明了要消费的接口列表，Consumer 需要能够将接口转换为
Provider 应用名才能进行精准服务订阅，
为此，Dubbo 需要在元数据中心维护这一份 `接口名->应用名` 的对应关系，Dubbo3 中通过 provider 启动的时主动向元数据中心上报实现。
@@ -39,9 +39,10 @@ $
demo-provider,two-demo-provider,dubbo-demo-annotation-provider
### 1.2 接口配置元数据
-`接口级配置元数据`是作为地址发现的补充，只有当才会进行暴露。会根据当前应用的自身信息，以及接口信息，去计算出该应用的 revision
修订值，用于保存应用级别元数据，
+`接口级配置元数据`是作为地址发现的补充，相比于 Spring Cloud 等地址发现模型只能同步 ip、port 信息，Dubbo
的服务发现机制可以同步接口列表、接口定义、接口级参数配置等信息。
+这部分内容根据当前应用的自身信息、以及接口信息计算而来，并且从性能角度出发，还根据元数据生成 revision，以实现不同机器实例间的元数据聚合。
-以 Zookeeper 为例，接口配置元数据保存在以下位置：
+以 Zookeeper 为例，接口配置元数据保存在以下位置，如果多个实例生成的 revision 相同，则最终会共享同一份元数据配置：
/dubbo/metadata/{application name}/{revision}
diff --git a/content/zh/overview/tasks/deploy-on-k8s.md
b/content/zh/overview/tasks/deploy-on-k8s.md
index 321607873b..1591ebc375 100644
--- a/content/zh/overview/tasks/deploy-on-k8s.md
+++ b/content/zh/overview/tasks/deploy-on-k8s.md
@@ -3,9 +3,347 @@ type: docs
title: "部署到 Kubernetes"
linkTitle: "如何部署 Dubbo 到 Kubernetes"
weight: 2
-description: ""
+description: "该示例演示了直接以 API-SERVER 为注册中心，将 Dubbo 应用部署到 Kubernetes 并复用
Kubernetes Native Service 的使用示例。
+此示例的局限在于需要授予每个 Dubbo 应用访问 API-SERVER 特定资源的权限，同时直接访问和监听 API-SERVER
对中小集群来说并没有什么问题，
+但对于较大规模集群而言可能给 API-SERVER 的稳定性带来一定的考验。除此之外，可以考虑配合 Dubbo 控制面将 Dubbo 应用部署到
Kuberntes 的方案，
+该方案无需授予 Dubbo 应用访问 API-SERVER 的权限，也无需为 API-SERVER 引连接过多数据面造成的稳定性而担心。"
---
+可以按照下文步骤，将 Demo 部署到本地集群，也可在 [KataCoda 在线快速体验]()。
+
+## 1 总体目标
+
+* 部署 Dubbo 应用到 Kubernetes
+* 基于 Kubernetes 内置 Service 实现服务发现
+* 将 Dubbo 应用对接到 Kubernetes 生命周期
+
+## 2 基本流程
+
+1. 创建一个 Dubbo
+ 应用(
[dubbo-samples-kubernetes](https://github.com/apache/dubbo-samples/tree/master/dubbo-samples-kubernetes)
)
+2. 构建容器镜像并推送到镜像仓库（ [dubboteam 示例例镜像](https://hub.docker.com/u/dubboteam) ）
+3. 分别部署 Dubbo Provider 与 Dubbo Consumer 到 Kubernetes
+4. 验证服务发现与调用正常
+
+## 3 详细步骤
+
+### 3.1 环境要求
+
+请确保本地安装如下环境，以提供容器运行时、Kubernetes集群及访问工具
+
+* [Docker](https://www.docker.com/get-started/)
+* [Minikube](https://minikube.sigs.k8s.io/docs/start/)
+* [Kubectl](https://kubernetes.io/docs/tasks/tools/)
+* [Kubens(optional)](https://github.com/ahmetb/kubectx)
+
+通过以下命令启动本地 Kubernetes 集群
+
+```shell
+minikube start
+```
+
+通过 kubectl 检查集群正常运行，且 kubectl 绑定到默认本地集群
+
+```shell
+kubectl cluster-info
+```
+
+### 3.2 前置条件
+
+由于示例 Dubbo 项目均部署在 Pod 中且与 API-SERVER 有交互，因此有相应的权限要求，我们这里创建独立 ServiceAccount
并绑定必须的 Roles，后面所有的 Dubbo Kubernetes
+资源都将使用这里新建的 ServiceAccount。
+
+通过以下命令我们创建了独立的 Namespace `dubbo-demo` 与 ServiceAccount `dubbo-sa`。
+
+```shell
+# 初始化命名空间和账号
+kubectl apply -f
https://raw.githubusercontent.com/apache/dubbo-samples/master/dubbo-samples-kubernetes/dubbo-samples-apiserver-provider/src/main/resources/k8s/ServiceAccount.yml
+
+# 切换命名空间
+kubens dubbo-demo
+```
+
+### 3.3 项目与镜像打包（可跳过）
+
+示例项目及相关镜像均已就绪，以下仅为指引说明，可直接跳过此步骤直接查看 3.4 小节。
+https://github.com/apache/dubbo-samples/tree/master/dubbo-samples-kubernetes/
+
+注意，由于 kubernetes 为独立扩展项目，开启 Kubernetes 支持前请添加如下依赖到 pom.xml
+
+```xml
+<dependency>
+ <groupId>org.apache.dubbo.extensions</groupId>
+ <artifactId>dubbo-registry-kubernetes</artifactId>
+ <version>1.0.2-SNAPSHOT</version>
+</dependency>
+```
+
+设置 Dubbo 项目使用 Kubernetes 作为注册中心，这里通过 DEFAULT_MASTER_HOST指定使用默认 API-SERVER 集群地址
kubernetes.default.srv，同时还指定了
+namespace、trustCerts 两个参数
+
+```properties
+dubbo.application.name=dubbo-samples-apiserver-provider
+dubbo.application.metadataServicePort=20885
+dubbo.registry.address=kubernetes://DEFAULT_MASTER_HOST?registry-type=service&duplicate=false&namespace=dubbo-demo&trustCerts=true
+dubbo.protocol.name=dubbo
+dubbo.protocol.port=20880
+dubbo.application.qosEnable=true
+dubbo.application.qosAcceptForeignIp=true
+dubbo.provider.token=true
+```
+
+如果要在本地打包镜像，可通过 spring-boot-maven-plugin 插件打包镜像（也可以直接使用示例提供好的镜像包）
+
+```shell
+# 打包镜像
+mvn spring-boot:build-image
+
+# 重命名镜像
+docker tag docker.io/dubboteam/dubbo-samples-apiserver-provider:latest
your-image-space/dubbo-samples-apiserver-provider
+
+# 推到镜像仓库
+docker push your-image-space/dubbo-samples-apiserver-provider
+```
+
+### 3.4 部署到 Kubernetes
+
+#### 3.4.1 部署 Provider
+
+```shell
+# 部署 Service
+kubectl apply -f
https://raw.githubusercontent.com/apache/dubbo-samples/master/dubbo-samples-kubernetes/dubbo-samples-apiserver-provider/src/main/resources/k8s/Service.yml
+
+# 部署 Deployment
+kubectl apply -f
https://raw.githubusercontent.com/apache/dubbo-samples/master/dubbo-samples-kubernetes/dubbo-samples-apiserver-provider/src/main/resources/k8s/Deployment.yml
+```
+
+以上命令创建了一个名为 `dubbo-samples-apiserver-provider` 的 Service，注意这里的 service name
与项目中的 dubbo 应用名是一样的。
+
+接着 Deployment 部署了一个 3 副本的 pod 实例，至此 Provider 启动完成。
+可以通过如下命令检查启动日志。
+
+```shell
+# 查看 pod 列表
+kubectl get pods -l app=dubbo-samples-apiserver-provider
+
+# 查看 pod 部署日志
+kubectl logs your-pod-id
+```
+
+#### 3.4.2 部署 Consumer
+
+```shell
+# 部署 Service
+kubectl apply -f
https://raw.githubusercontent.com/apache/dubbo-samples/master/dubbo-samples-kubernetes/dubbo-samples-apiserver-consumer/src/main/resources/k8s/Service.yml
+
+# 部署 Deployment
+kubectl apply -f
https://raw.githubusercontent.com/apache/dubbo-samples/master/dubbo-samples-kubernetes/dubbo-samples-apiserver-consumer/src/main/resources/k8s/Deployment.yml
+```
+
+部署 consumer 与 provider 是一样的，这里也保持了 K8S Service 与 Dubbo consumer 名字一致：
dubbo-samples-apiserver-consumer。
+
+检查启动日志，consumer 完成对 provider 服务的消费。
+
+```shell
+# 查看 pod 列表
+kubectl get pods -l app=dubbo-samples-apiserver-consumer
+
+# 查看 pod 部署日志
+kubectl logs your-pod-id
+```
+
+可以看到日志输出如下:
+
+```java
+[22/04/22 01:10:24:024UTC]main INFO
deploy.DefaultApplicationDeployer:[DUBBO]Dubbo
Application[1.1](dubbo-samples-apiserver-consumer)is ready.,dubbo
version:3.0.7,current host:172.17.0.6
+ result:hello,Kubernetes Api Server
+```
+
+### 3.5 检查 Consumer 正常消费服务
+
+TBD
+> * 改造 consumer 支持 spring-web
+> * Consumer service 暴露对外地址与端口
+> * 访问 http 地址验证行为
+
+## 4 最佳实践
+
+TBD
+
+* rediness probe
+* liveness probe
+
+## 5 CI/CD
+
+* 接入 Skalfold
+
+## 6 附录 k8s manifests
+
+ServiceAccount.yml
+
+```yaml
+apiVersion: v1
+kind: Namespace
+metadata:
+ name: dubbo-demo
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: Role
+metadata:
+ namespace: dubbo-demo
+ name: dubbo-role
+rules:
+ - apiGroups: [""]
+ resources: ["pods"]
+ verbs: ["get", "watch", "list", "update", "patch"]
+ - apiGroups: ["", "service.dubbo.apache.org"]
+ resources: ["services", "endpoints", "virtualservices", "destinationrules"]
+ verbs: ["get", "watch", "list"]
+---
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+ name: dubbo-sa
+ namespace: dubbo-demo
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: RoleBinding
+metadata:
+ name: dubbo-sa-bind
+ namespace: dubbo-demo
+roleRef:
+ apiGroup: rbac.authorization.k8s.io
+ kind: Role
+ name: dubbo-role
+subjects:
+ - kind: ServiceAccount
+ name: dubbo-sa
+```
+
+Service.yml
+
+```yaml
+apiVersion: v1
+kind: Service
+metadata:
+ name: dubbo-samples-apiserver-provider
+ namespace: dubbo-demo
+spec:
+ clusterIP: None
+ selector:
+ app: dubbo-samples-apiserver-provider
+ ports:
+ - protocol: TCP
+ port: 20880
+ targetPort: 20880
+```
+
+Deployment.yml
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: dubbo-samples-apiserver-provider
+ namespace: dubbo-demo
+spec:
+ replicas: 3
+ selector:
+ matchLabels:
+ app: dubbo-samples-apiserver-provider
+ template:
+ metadata:
+ labels:
+ app: dubbo-samples-apiserver-provider
+ spec:
+ serviceAccountName: dubbo-sa
+ containers:
+ - name: server
+ image: dubboteam/dubbo-samples-apiserver-provider
+ ports:
+ - containerPort: 20880
+ livenessProbe:
+ httpGet:
+ path: /live
+ port: 22222
+ initialDelaySeconds: 5
+ periodSeconds: 5
+ readinessProbe:
+ httpGet:
+ path: /ready
+ port: 22222
+ initialDelaySeconds: 5
+ periodSeconds: 5
+ startupProbe:
+ httpGet:
+ path: /startup
+ port: 22222
+ failureThreshold: 30
+ periodSeconds: 10
+```
+
+Service.yml
+
+```yaml
+apiVersion: v1
+kind: Service
+metadata:
+ name: dubbo-samples-apiserver-consumer
+ namespace: dubbo-demo
+spec:
+ clusterIP: None
+ selector:
+ app: dubbo-samples-apiserver-consumer
+ ports:
+ - protocol: TCP
+ port: 20880
+ targetPort: 20880
+```
+
+Deployment.yml
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: dubbo-samples-apiserver-consumer
+ namespace: dubbo-demo
+spec:
+ replicas: 1
+ selector:
+ matchLabels:
+ app: dubbo-samples-apiserver-consumer
+ template:
+ metadata:
+ labels:
+ app: dubbo-samples-apiserver-consumer
+ spec:
+ serviceAccountName: dubbo-sa
+ containers:
+ - name: server
+ image: dubboteam/dubbo-samples-apiserver-consumer
+ ports:
+ - containerPort: 20880
+ livenessProbe:
+ httpGet:
+ path: /live
+ port: 22222
+ initialDelaySeconds: 5
+ periodSeconds: 5
+ readinessProbe:
+ httpGet:
+ path: /ready
+ port: 22222
+ initialDelaySeconds: 5
+ periodSeconds: 5
+ startupProbe:
+ httpGet:
+ path: /startup
+ port: 22222
+ failureThreshold: 30
+ periodSeconds: 10
+```
+
