fix: 修改文档

Author: googs1025

README.md

@@ -18,14 +18,21 @@ metadata:
   name: mymessage
 spec:
   sender:
-    open: true
+    open: true      # 是否开启发送功能
+                    # email 配置
     remote: smtp.qq.com
     port:  25
     email: [email protected]
     password: xxxxx
     targets: [email protected]
   feishu:
-    open: true
+    open: true       # 是否开启发送功能
     webhook: xxxxxx  # 飞书 webhook ip
-    type: card   # 支持 text card 推送模式
-```
+    type: card       # 预计支持 text card 推送模式
+```
+
+- 发送结果如下
+![](https://github.com/googs1025/message-operator/blob/main/image/img.png?raw=true)
+
+![](https://github.com/googs1025/message-operator/blob/main/image/img_1.png?raw=true)
+

image/img.png

@@ -53,11 +53,9 @@ func main() {
 	k8sConfig.InitInformerFactory()
 
 	// 3. 控制器相关
-	messageCtl := controller.NewMessageController(mgr.GetEventRecorderFor("message-operator"))
+	messageCtl := controller.NewMessageController(mgr.GetEventRecorderFor("message-operator"), mgr.GetLogger())
 
-	err = builder.ControllerManagedBy(mgr).
-		For(&messagev1alpha1.Message{}).
-		Complete(messageCtl)
+	err = builder.ControllerManagedBy(mgr).For(&messagev1alpha1.Message{}).Complete(messageCtl)
 
 	// 4. 载入业务配置
 	if err = sysconfig.InitConfig(); err != nil {
@@ -67,7 +65,7 @@ func main() {
 
 	errC := make(chan error)
 
-	// 5. 启动controller管理器
+	// 5. 启动 controller 管理器
 	go func() {
 		klog.Info("controller start!! ")
 		if err = mgr.Start(signals.SetupSignalHandler()); err != nil {

image/img_1.png

@@ -2,6 +2,7 @@ package controller
 
 import (
 	"context"
+	"github.com/go-logr/logr"
 	messagev1alpha1 "github.com/myoperator/messageoperator/pkg/apis/message/v1alpha1"
 	"github.com/myoperator/messageoperator/pkg/sysconfig"
 	corev1 "k8s.io/api/core/v1"
@@ -14,10 +15,11 @@ import (
 type MessageController struct {
 	client.Client
 	EventRecorder record.EventRecorder // 事件管理器
+	logr.Logger
 }
 
-func NewMessageController(eventRecorder record.EventRecorder) *MessageController {
-	return &MessageController{EventRecorder: eventRecorder}
+func NewMessageController(eventRecorder record.EventRecorder, log logr.Logger) *MessageController {
+	return &MessageController{EventRecorder: eventRecorder, Logger: log}
 }
 
 // Reconcile 调协loop
@@ -48,12 +50,12 @@ func (r *MessageController) Reconcile(ctx context.Context, req reconcile.Request
 		return reconcile.Result{}, nil
 	}
 	r.EventRecorder.Event(message, corev1.EventTypeNormal, "Update", "update app config...")
-	
+
 	klog.Info("CreateOrUpdate ", "Message: ", message.Name, "/", message.Namespace)
 	return reconcile.Result{}, nil
 }
 
-// InjectClient 使用controller-runtime 需要注入的client
+// InjectClient 使用 controller-runtime 需要注入的client
 func (r *MessageController) InjectClient(c client.Client) error {
 	r.Client = c
 	return nil

main.go

@@ -8,7 +8,7 @@ import (
 )
 
 func main() {
-	webhookURL := "https://open.feishu.cn/open-apis/bot/v2/hook/919c368d-bbbf-4858-b788-0b78a4389d45" // 替换为您的飞书机器人 Webhook URL
+	webhookURL := "https://open.feishu.cn/open-apis/bot/v2/hook/xxx" // 替换为您的飞书机器人 Webhook URL
 
 	// 构建卡片消息内容
 	cardMessage := map[string]interface{}{

pkg/controller/controller.go

@@ -4,14 +4,14 @@ metadata:
   name: mymessage
 spec:
   sender:
-    open: true
+    open: true        # 是否开启发送功能
     remote: smtp.qq.com
     port:  25
     email: [email protected]
     password: cswkxalurhtwecge
     targets: [email protected]
   feishu:
-    open: true
+    open: true       # 是否开启发送功能
     webhook: xxxxxx  # 飞书 webhook ip
-    type: card   # 支持 text card 推送模式
+    type: card       # 支持 text card 推送模式