Merge pull request #7 from junotx/master

adjust rule engine dependency

Author: Benjamin Huo

README.md

@@ -11,6 +11,9 @@ Another component called Operator is responsible for the desired state of the pr
 
 To learn more about the CRDs introduced by the kube-events have a look at the [design doc](doc/api.md).
 
+The architecture diagram is as follows:  
+![Architecture](doc/images/architecture.png)
+
 # Quickstart
 
 Install quickly kube-events into your kubernetes cluster with the following commands:

cmd/ruler/main.go

@@ -10,15 +10,14 @@ import (
 	"runtime"
 	"time"
 
-	v1 "k8s.io/api/core/v1"
-
 	"github.com/julienschmidt/httprouter"
 	"github.com/kubesphere/kube-events/pkg/config"
 	"github.com/kubesphere/kube-events/pkg/ruler"
 	rulertypes "github.com/kubesphere/kube-events/pkg/ruler/types"
 	"github.com/kubesphere/kube-events/pkg/util"
 	"github.com/panjf2000/ants/v2"
 	"golang.org/x/sync/errgroup"
+	"k8s.io/api/core/v1"
 	"k8s.io/klog"
 	ctrlconfig "sigs.k8s.io/controller-runtime/pkg/client/config"
 )
@@ -32,7 +31,7 @@ func init() {
 }
 
 func main() {
-	klog.InitFlags(nil)
+	//klog.InitFlags(nil)
 	flag.Parse()
 
 	kcfg, e := ctrlconfig.GetConfig()

config/bundle.yaml

@@ -44,16 +44,17 @@ spec:
                     additionalProperties:
                       type: string
                     description: 'Values of Annotations can use format string with
-                      the fields of the event. For example: `{"message": "%event.message"}`'
+                      the fields of the event. For example: `{"message": "%message"}`'
                     type: object
                   condition:
                     description: 'Condition is a string similar with the where part
-                      of sql (please use double quotation to mark a string). For example:
-                      `event.type="Warning" and event.involvedObject.kind="Pod" and
-                      event.reason="FailedMount"`'
+                      of sql. See supported grammar details on https://github.com/kubesphere/event-rule-engine#supported-grammer
+                      . For example: `type="Warning" and involvedObject.kind="Pod"
+                      and reason="FailedMount"`'
                     type: string
                   enable:
-                    description: Enable is whether to enable the rule
+                    description: Enable is whether to enable the rule, default to
+                      `false`
                     type: boolean
                   labels:
                     additionalProperties: