[GitHub] [rocketmq-operator] vongosling commented on a change in pull request #1: Create cluster

[GitBox <gi...@apache.org>]

vongosling commented on a change in pull request #1: Create cluster
URL: https://github.com/apache/rocketmq-operator/pull/1#discussion_r320580067
 
 

 ##########
 File path: README.md
 ##########
 @@ -1,2 +1,132 @@
 ## RocketMQ Operator
 [![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
+
+## Overview
+
+RocketMQ Operator is  to manage RocketMQ service instances deployed on the Kubernetes cluster.
+It is built using the [Operator SDK](https://github.com/operator-framework/operator-sdk), which is part of the [Operator Framework](https://github.com/operator-framework/).
+
+## Quick Start
+
+### Define Your RocketMQ Cluster
+
+RocketMQ Operator provides several CRDs to allow users define their RocketMQ service component cluster, which includes the Namesrv cluster and the Broker cluster.
+
+1. Check the file ```rocketmq_v1alpha1_metaservice_cr.yaml``` in the ```deploy/crds``` directory, for example:
+```
+apiVersion: cache.example.com/v1alpha1
+apiVersion: rocketmq.operator.com/v1alpha1
+kind: MetaService
+metadata:
+  name: meta-service
+spec:
+  # size is the the name service instance number of the name service cluster
+  size: 2
+  # metaServiceImage is the customized docker image repo of the RocketMQ name service
+  metaServiceImage: 2019liurui/rocketmq-namesrv:4.5.0-alpine
+  # imagePullPolicy is the image pull policy
+  imagePullPolicy: Always
+```
+
+which defines the RocketMQ name service (namesrv) cluster scale.
+
+2. Check the file ```cache_v1alpha1_broker_cr.yaml``` in the ```deploy/crds``` directory, for example:
+```
+apiVersion: cache.example.com/v1alpha1
+kind: Broker
+metadata:
+  name: broker
+spec:
+  # size is the number of the broker cluster, each broker cluster contains a master broker and [slavePerGroup] slave brokers.
+  size: 2
+  # nameServers is the [ip:port] list of name service
+  nameServers: 192.168.130.33:9876;192.168.130.34:9876
+  # replicationMode is the broker slave sync mode, can be ASYNC or SYNC
+  replicationMode: ASYNC
+  # slavePerGroup is the number of each broker cluster
+  slavePerGroup: 2
+  # brokerImage is the customized docker image repo of the RocketMQ broker
+  brokerImage: 2019liurui/rocketmq-broker:4.5.0-alpine
 
 Review comment:
   Refer to the above comment.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services