This is an automated email from the ASF dual-hosted git repository.
caigy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-operator.git
The following commit(s) were added to refs/heads/master by this push:
new a89395a fix #125
new a38bc11 Merge pull request #126 from caigy/update-readme
a89395a is described below
commit a89395add436227c318f9acb5021159d1220bcfd
Author: caigy <[email protected]>
AuthorDate: Sun Aug 14 19:55:59 2022 +0800
fix #125
---
README.md | 38 ++++++++++++++++++++------------------
deploy/operator.yaml | 2 +-
2 files changed, 21 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
index e694ff1..3472d3a 100644
--- a/README.md
+++ b/README.md
@@ -5,10 +5,10 @@
[](https://godoc.org/github.com/apache/rocketmq-operator/pkg)
[](https://goreportcard.com/report/github.com/apache/rocketmq-operator)
[](https://github.com/apache/rocketmq-operator/releases)
-
-[](https://hub.docker.com/repository/docker/apacherocketmq/rocketmq-operator)
-[](https://hub.docker.com/r/apacherocketmq/rocketmq-operator/tags)
-
+
+[](https://hub.docker.com/r/apache/rocketmq-operator)
+[](https://hub.docker.com/r/apache/rocketmq-operator/tags)
+
[](http://isitmaintained.com/project/apache/rocketmq-operator
"Average time to resolve an issue")
[](http://isitmaintained.com/project/apache/rocketmq-operator
"Percentage of issues still open")
[](https://twitter.com/intent/follow?screen_name=ApacheRocketMQ)
@@ -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)
@@ -36,6 +37,7 @@
- [Build](#build)
- [Operator](#operator)
- [Broker and Name Server Images](#broker-and-name-server-images)
+ - [Dashboard](#dashboard)
## Overview
@@ -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.
@@ -542,12 +544,12 @@ $ ./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
@@ -555,12 +557,12 @@ For developers who want to build and push the
operator-related images to the doc
#### 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
@@ -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.
diff --git a/deploy/operator.yaml b/deploy/operator.yaml
index c4d6fb4..3b9d030 100644
--- a/deploy/operator.yaml
+++ b/deploy/operator.yaml
@@ -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:
