[ISSUE #158] add eventmesh-operator.md (#158)

* add 06-operator.md * add 06-operator.md zh * update
apache · Dec 18, 2023 · f12747e · f12747e
1 parent 1a39f08
commit f12747e
Show file tree

Hide file tree

Showing 2 changed files with 182 additions and 0 deletions.
diff --git a/docs/instruction/06-operator.md b/docs/instruction/06-operator.md
@@ -0,0 +1,91 @@
+# EventMesh integrate with K8S  
+
+### 1. Dependencies
+
+```
+docker
+golang (version 1.19)
+kubernetes (kubectl)
+There is some compatibility between kubernetes an docker, please check the version compatibility between them and download the corresponding version to ensure that they work properly together.  
+```
+
+### 2. Start  
+
+Go to the eventmesh-operator directory.
+```
+cd eventmesh-operator
+```
+
+Install CRD into the specified k8s cluster.
+```
+make install
+
+# Uninstall CRDs from the K8s cluster
+make uninstall
+```
+
+If you get error eventmesh-operator/bin/controller-gen: No such file or directory  
+Run the following command:
+```
+# download controller-gen locally if necessary.
+make controller-gen
+# download kustomize locally if necessary.
+make kustomize
+```
+
+View crds information:  
+``` 
+# run the following command to view crds information:
+kubectl get crds
+NAME                                      CREATED AT
+connectors.eventmesh-operator.eventmesh   2023-11-28T01:35:21Z
+runtimes.eventmesh-operator.eventmesh     2023-11-28T01:35:21Z
+```
+
+Create and delete CRs:     
+Custom resource objects are located at: /config/samples    
+When deleting CR, simply replace create with delete.
+```
+# Create CR for eventmesh-runtime、eventmesh-connector-rocketmq,Creating a clusterIP lets eventmesh-runtime communicate with other components.
+make create
+
+#success:
+configmap/runtime-config created
+runtime.eventmesh-operator.eventmesh/eventmesh-runtime created
+service/runtime-cluster-service created
+configmap/connector-rocketmq-config created
+connectors.eventmesh-operator.eventmesh/connector-rocketmq created
+
+# View the created Service.
+kubectl get service
+NAME                      TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)     AGE
+runtime-cluster-service   ClusterIP   10.109.209.72   <none>        10000/TCP   17s
+
+# Delete CR
+make delete
+```
+
+Run eventmesh-operator create pods
+
+```
+# run controller
+make run
+# log
+go fmt ./...
+go vet ./...
+go run ./main.go
+INFO    controller-runtime.metrics      Metrics server is starting to listen    {"addr": ":9020"}
+INFO    setup   starting manager
+INFO    Starting server {"kind": "health probe", "addr": "[::]:8081"}
+INFO    Starting server {"path": "/metrics", "kind": "metrics", "addr": "[::]:9020"}
+INFO    runtime         Creating a new eventMeshRuntime StatefulSet.    {"StatefulSet.Namespace": "default", "StatefulSet.Name": "eventmesh-runtime-0-a"}
+INFO    connector       Creating a new Connector StatefulSet.   {"StatefulSet.Namespace": "default", "StatefulSet.Name": "connector-rocketmq"}
+INFO    runtime         Successful reconciliation!
+INFO    connector       Successful reconciliation!
+
+# After the pods are successfully started, run the following command to view pods.
+kubectl get pods
+NAME                      READY   STATUS    RESTARTS   AGE
+connector-rocketmq-0      1/1     Running   0          12m
+eventmesh-runtime-0-a-0   1/1     Running   0          12m
+```
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/instruction/06-operator.md b/i18n/zh/docusaurus-plugin-content-docs/current/instruction/06-operator.md
@@ -0,0 +1,91 @@
+# EventMesh与K8S集成  
+
+### 1. 依赖
+
+```
+docker
+golang (version 1.19)
+kubernetes (kubectl)
+kubernetes和docker之间有一定的兼容性，请检查它们之间的版本兼容性，并下载相应的版本，以确保它们能一起正常工作。
+```
+
+### 2. 启动
+
+进入eventmesh-operator目录。  
+```
+cd eventmesh-operator
+```
+
+将CRD安装到k8s集群。
+```
+make install
+
+# Uninstall CRDs from the K8s cluster
+make uninstall
+```
+
+如果出现错误 eventmesh-operator/bin/controller-gen: No such file or directory   
+运行以下命令:  
+```
+# 如有必要，在本地下载controller-gen.
+make controller-gen
+# 如有必要，在本地下载kustomize.
+make kustomize
+```
+
+查看crds信息:  
+``` 
+# 运行以下命令查看 crds 信息:
+kubectl get crds
+NAME                                      CREATED AT
+connectors.eventmesh-operator.eventmesh   2023-11-28T01:35:21Z
+runtimes.eventmesh-operator.eventmesh     2023-11-28T01:35:21Z
+```
+
+创建和删除CRs:   
+自定义资源对象位于: /config/samples   
+删除CR，只需将`create`替换为`delete`即可。
+```
+# 为eventmesh-runtime、eventmesh-connector-rocketmq创建CR,创建clusterIP可让eventmesh-runtime与其他组件通信。
+make create
+
+#success:
+configmap/runtime-config created
+runtime.eventmesh-operator.eventmesh/eventmesh-runtime created
+service/runtime-cluster-service created
+configmap/connector-rocketmq-config created
+connectors.eventmesh-operator.eventmesh/connector-rocketmq created
+
+# 查看创建的service.
+kubectl get service
+NAME                      TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)     AGE
+runtime-cluster-service   ClusterIP   10.109.209.72   <none>        10000/TCP   17s
+
+# Delete CR
+make delete
+```
+
+运行eventmesh-operator创建pods  
+```
+
+# run controller
+make run
+# log
+go fmt ./...
+go vet ./...
+go run ./main.go
+INFO    controller-runtime.metrics      Metrics server is starting to listen    {"addr": ":9020"}
+INFO    setup   starting manager
+INFO    Starting server {"kind": "health probe", "addr": "[::]:8081"}
+INFO    Starting server {"path": "/metrics", "kind": "metrics", "addr": "[::]:9020"}
+INFO    runtime         Creating a new eventMeshRuntime StatefulSet.    {"StatefulSet.Namespace": "default", "StatefulSet.Name": "eventmesh-runtime-0-a"}
+INFO    connector       Creating a new Connector StatefulSet.   {"StatefulSet.Namespace": "default", "StatefulSet.Name": "connector-rocketmq"}
+INFO    runtime         Successful reconciliation!
+INFO    connector       Successful reconciliation!
+
+# 成功启动pod后，运行以下命令查看pod。
+kubectl get pods
+NAME                      READY   STATUS    RESTARTS   AGE
+connector-rocketmq-0      1/1     Running   0          12m
+eventmesh-runtime-0-a-0   1/1     Running   0          12m
+```