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

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

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

 ##########
 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
 
 Review comment:
   ```2019liurui``` has been replaced by ```rocketmqinc```.

----------------------------------------------------------------
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