Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
[![GoDoc](https://img.shields.io/badge/Godoc-reference-blue.svg)](https://godoc.org/github.com/apache/rocketmq-operator/pkg)
[![Go Report Card](https://goreportcard.com/badge/github.com/apache/rocketmq-operator)](https://goreportcard.com/report/github.com/apache/rocketmq-operator)
[![GitHub release](https://img.shields.io/github/release-date-pre/apache/rocketmq-operator)](https://github.com/apache/rocketmq-operator/releases)
![Docker Automated](https://img.shields.io/docker/automated/apacherocketmq/rocketmq-operator)
[![Docker Pulls](https://img.shields.io/docker/pulls/apacherocketmq/rocketmq-operator)](https://hub.docker.com/repository/docker/apacherocketmq/rocketmq-operator)
[![Docker TAG](https://img.shields.io/docker/v/apacherocketmq/rocketmq-operator?label=tags&sort=date)](https://hub.docker.com/r/apacherocketmq/rocketmq-operator/tags)
![Docker Iamge](https://img.shields.io/docker/image-size/apacherocketmq/rocketmq-operator)
![Docker Automated](https://img.shields.io/docker/automated/apache/rocketmq-operator)
[![Docker Pulls](https://img.shields.io/docker/pulls/apache/rocketmq-operator)](https://hub.docker.com/r/apache/rocketmq-operator)
[![Docker TAG](https://img.shields.io/docker/v/apache/rocketmq-operator?label=tags&sort=date)](https://hub.docker.com/r/apache/rocketmq-operator/tags)
![Docker Iamge](https://img.shields.io/docker/image-size/apache/rocketmq-operator)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/apache/rocketmq-operator.svg)](http://isitmaintained.com/project/apache/rocketmq-operator "Average time to resolve an issue")
[![Percentage of issues still open](http://isitmaintained.com/badge/open/apache/rocketmq-operator.svg)](http://isitmaintained.com/project/apache/rocketmq-operator "Percentage of issues still open")
[![Twitter Follow](https://img.shields.io/twitter/follow/ApacheRocketMQ?style=social)](https://twitter.com/intent/follow?screen_name=ApacheRocketMQ)
Expand All @@ -18,8 +18,9 @@
- [Quick Start](#quick-start)
- [Deploy RocketMQ Operator](#deploy-rocketmq-operator)
- [Prepare Volume Persistence](#prepare-volume-persistence)
- [Prepare HostPath](#prepare-hostpath)
- [Prepare Storage Class of NFS](#prepare-storage-class-of-nfs)
- [EmptyDir](#emptydir)
- [HostPath](#hostpath)
- [StorageClass (Use NFS for Example)](#storageclass-use-nfs-for-example)
- [Define Your RocketMQ Cluster](#define-your-rocketmq-cluster)
- [Create RocketMQ Cluster](#create-rocketmq-cluster)
- [Verify the Data Storage](#verify-the-data-storage)
Expand All @@ -36,6 +37,7 @@
- [Build](#build)
- [Operator](#operator)
- [Broker and Name Server Images](#broker-and-name-server-images)
- [Dashboard](#dashboard)

## Overview

Expand Down Expand Up @@ -72,7 +74,7 @@ If you find that pod image is not found, run the following command to build a ne
the image tag is specified by the `IMG` parameter.

```shell
$ make docker-build IMG=apacherocketmq/rocketmq-operator:0.3.0-snapshot
$ make docker-build IMG=apache/rocketmq-operator:0.3.0-snapshot
```

Now you can use the CRDs provided by RocketMQ Operator to deploy your RocketMQ cluster.
Expand Down Expand Up @@ -542,25 +544,25 @@ $ ./remove-storage-class.sh
### Prerequisites

+ [git](https://git-scm.com/downloads)
+ [go](https://golang.org/dl/) version v1.12+.
+ [go](https://golang.org/dl/) version v1.16.
+ [mercurial](https://www.mercurial-scm.org/downloads) version 3.9+
+ [docker](https://docs.docker.com/install/) version 17.03+.
+ Access to a Kubernetes v1.11.3+ cluster.
+ [docker](https://docs.docker.com/install/) version 19.03+.
+ Access to a Kubernetes v1.19 or above cluster.
+ [dep](https://golang.github.io/dep/docs/installation.html) version v0.5.0+.
+ [operator-sdk](https://github.com/operator-framework/operator-sdk) version v0.11.0+
+ [operator-sdk](https://github.com/operator-framework/operator-sdk) version v1.16.0-v1.21.0

### Build

For developers who want to build and push the operator-related images to the docker hub, please follow the instructions below.

#### Operator

RocketMQ-Operator uses ```operator-sdk``` to generate the scaffolding and build the operator image. You can refer to the [operator-sdk user guide](https://github.com/operator-framework/operator-sdk/blob/master/doc/user-guide.md) for more details.
RocketMQ-Operator uses ```operator-sdk``` to generate the scaffolding and build the operator image. You can refer to the [operator-sdk user guide](https://sdk.operatorframework.io/docs/) for more details.

If you want to push the newly build operator image to your own docker hub, please modify the ```DOCKERHUB_REPO``` variable in the ```create-operator.sh``` script using your own repository. Then run the build script:

```
$ ./create-operator.sh
If you want to build your own operator image and push it to your own docker hub, please specify `IMG` as your image url and run `make docker-build` and `make docker-push`. For example:
```shell
$ make docker-build IMG={YOUR_IMAGE_URL} && make docker-push IMG={YOUR_IMAGE_URL}
```

#### Broker and Name Server Images
Expand All @@ -579,8 +581,8 @@ $ cd images/alpine/namesrv
$ ./build-namesrv-image.sh
```

#### Console
#### Dashboard

The Console CR directly uses the RocketMQ-Console image from https://github.com/apache/rocketmq-externals/tree/master/rocketmq-console, which has no customization for the operator.
The Console CR directly uses the RocketMQ Dashboard image from https://github.com/apache/rocketmq-docker/blob/master/image-build/Dockerfile-centos-dashboard, which has no customization for the operator.

> Note: for users who just want to use the operator, there is no need to build the operator and customized broker and name server images themselves. Users can simply use the default official images which are maintained by the RocketMQ community.
> Note: For users who just want to use the operator, there is no need to build the operator and customized broker and name server images themselves. Users can simply use the default official images which are maintained by the RocketMQ community.
2 changes: 1 addition & 1 deletion deploy/operator.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ spec:
containers:
- name: manager
# Replace this with the built image name
image: apacherocketmq/rocketmq-operator:0.3.0-snapshot
image: apache/rocketmq-operator:0.3.0-snapshot
command:
- /manager
args:
Expand Down