Merge pull request #3 from apache/develop

merge from apache

.github/workflows/license-checker.yaml

@@ -0,0 +1,35 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: License checker
+
+on:
+  pull_request:
+    branches:
+      - develop
+      - master
+
+jobs:
+  check-license:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Check License Header
+        uses: apache/skywalking-eyes@v0.2.0
+        with:
+          log: info
+          config: .licenserc.yaml

.licenserc.yaml

@@ -0,0 +1,45 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+header:
+  license:
+    spdx-id: Apache-2.0
+    copyright-owner: Apache Software Foundation
+
+  paths-ignore:
+    - '.gitignore'
+    - '.travis.yml'
+    - 'CONTRIBUTING.md'
+    - 'LICENSE'
+    - 'NOTICE'
+    - '**/*.md'
+    - 'BUILDING'
+    - '.github/**'
+    - '*/src/test/resources/certs/*'
+    - 'src/test/**/*.log'
+    - '*/src/test/resources/META-INF/service/*'
+    - '*/src/main/resources/META-INF/service/*'
+    - '**/target/**'
+    - '**/*.iml'
+    - 'docs/**'
+    - 'localbin/**'
+    - 'distribution/LICENSE-BIN'
+    - 'distribution/NOTICE-BIN'
+
+
+  comment: on-failure

CONTRIBUTING.md

@@ -5,6 +5,10 @@ We want to have high quality, well documented codes for each programming languag
 
 Nor is code the only way to contribute to the project. We strongly value documentation, integration with other project, and gladly accept improvements for these aspects.
 
+Recommend reading:
+ * [Contributors Tech Guide](http://www.apache.org/dev/contributors)
+ * [Get involved!](http://www.apache.org/foundation/getinvolved.html)
+
 ## Contributing code
 
 To submit a change for inclusion, please do the following:
@@ -13,6 +17,19 @@ To submit a change for inclusion, please do the following:
 #### If you are introducing a completely new feature or API it is a good idea to start a [RIP](https://github.com/apache/rocketmq/wiki/RocketMQ-Improvement-Proposal) and get consensus on the basic design first.
 #### It is our job to follow up on patches in a timely fashion. Nag us if we aren't doing our job (sometimes we drop things).
 
+### Squash commits
+
+If your have a pull request on GitHub, and updated more than once, it's better to squash all commits.
+
+1. Identify how many commits you made since you began: ``git log``.
+2. Squash these commits by N: ``git rebase -i HEAD~N`` .
+3. Leave "pick" tag in the first line.
+4. Change all other commits from "pick" to "fixup".
+5. Then do "force push" to overwrite remote history: ``git push -u origin ROCKETMQ-9999 --force``
+6. All your changes are now in a single commit, that would be much better for review.
+
+More details of squash can be found at [stackoverflow](https://stackoverflow.com/questions/5189560/squash-my-last-x-commits-together-using-git).
+
 ## Becoming a Committer
 
 We are always interested in adding new contributors. What we look for are series of contributions, good taste and ongoing interest in the project. If you are interested in becoming a committer, please let one of the existing committers know and they can help you walk through the process.
@@ -25,7 +42,7 @@ Nowadays,we have several important contribution points:
 ##### Prerequisite
 If you want to contribute the above listing points, you must abide our some prerequisites:
 
-###### Readability - API must have Javadoc,some very important methods also must have javadoc
+###### Readability - API must have Javadoc, some very important methods also must have javadoc
 ###### Testability - 80% above unit test coverage about main process
 ###### Maintainability - Comply with our [checkstyle spec](style/rmq_checkstyle.xml), and at least 3 month update frequency
 ###### Deployability - We encourage you to deploy into [maven repository](http://search.maven.org/)

README.md

@@ -10,20 +10,19 @@
 
 **[Apache RocketMQ](https://rocketmq.apache.org) is a distributed messaging and streaming platform with low latency, high performance and reliability, trillion-level capacity and flexible scalability.**
 
+
 It offers a variety of features:
 
 * Messaging patterns including publish/subscribe, request/reply and streaming
 * Financial grade transactional message
 * Built-in fault tolerance and high availability configuration options base on [DLedger](https://github.com/openmessaging/openmessaging-storage-dledger)
-* A variety of cross language clients, such as Java, [C/C++](https://github.com/apache/rocketmq-client-cpp), [Python](https://github.com/apache/rocketmq-client-python), [Go](https://github.com/apache/rocketmq-client-go), [Node.js](https://github.com/apache/rocketmq-client-nodejs)
-* Pluggable transport protocols, such as TCP, SSL, AIO
 * Built-in message tracing capability, also support opentracing
 * Versatile big-data and streaming ecosystem integration
 * Message retroactivity by time or offset
 * Reliable FIFO and strict ordered messaging in the same queue
 * Efficient pull and push consumption model
 * Million-level message accumulation capacity in a single queue
-* Multiple messaging protocols like JMS and OpenMessaging
+* Multiple messaging protocols like gRPC, MQTT, JMS and OpenMessaging
 * Flexible distributed scale-out deployment architecture
 * Lightning-fast batch message exchange system
 * Various message filter mechanics such as SQL and Tag
@@ -34,21 +33,154 @@ It offers a variety of features:
 * Lightweight real-time computing
 ----------
 
+
+## Quick Start
+
+This paragraph guides you through steps of installing RocketMQ in different ways.
+For local development and testing, only one instance will be created for each component.
+
+### Run RocketMQ locally
+
+RocketMQ runs on all major operating systems and requires only a Java JDK version 8 or higher to be installed.
+To check, run `java -version`:
+```shell
+$ java -version
+java version "1.8.0_121"
+```
+
+For Windows users, click [here](https://archive.apache.org/dist/rocketmq/4.9.3/rocketmq-all-4.9.3-bin-release.zip) to download the 4.9.3 RocketMQ binary release,
+unpack it to your local disk, such as `D:\rocketmq`.
+For macOS and Linux users, execute following commands:
+```shell
+# Download release from the Apache mirror
+$ wget https://archive.apache.org/dist/rocketmq/4.9.3/rocketmq-all-4.9.3-bin-release.zip
+
+# Unpack the release
+$ unzip rocketmq-all-4.9.3-bin-release.zip
+```
+
+Prepare a terminal and change to the extracted `bin` directory:
+```shell
+$ cd rocketmq-4.9.3/bin
+```
+
+**1) Start NameServer**
+
+NameServer will be listening at `0.0.0.0:9876`, make sure that the port is not used by others on the local machine, and then do as follows.
+
+For macOS and Linux users:
+```shell
+### start Name Server
+$ nohup sh mqnamesrv &
+
+### check whether Name Server is successfully started
+$ tail -f ~/logs/rocketmqlogs/namesrv.log
+The Name Server boot success...
+```
+
+For Windows users, you need set environment variables first:
+- From the desktop, right click the Computer icon.
+- Choose Properties from the context menu.
+- Click the Advanced system settings link.
+- Click Environment Variables.
+- Add Environment `ROCKETMQ_HOME="D:\rocketmq"`. 
+
+Then change directory to rocketmq, type and run:
+```shell
+$ mqnamesrv.cmd
+The Name Server boot success...
+```
+
+**2) Start Broker**
+
+For macOS and Linux users:
+```shell
+### start Broker
+$ nohup sh bin/mqbroker -n localhost:9876 &
+
+### check whether Broker is successfully started, eg: Broker's IP is 192.168.1.2, Broker's name is broker-a
+$ tail -f ~/logs/rocketmqlogs/broker.log
+The broker[broker-a, 192.169.1.2:10911] boot success...
+```
+
+For Windows users:
+```shell
+$ mqbroker.cmd -n localhost:9876
+The broker[broker-a, 192.169.1.2:10911] boot success...
+```
+
+### Run RocketMQ in Docker
+
+You can run RocketMQ on your own machine within Docker containers,
+`host` network will be used to expose listening port in the container.
+
+**1) Start NameServer**
+
+```shell
+$ docker run -it --net=host apache/rocketmq ./mqnamesrv
+```
+
+**2) Start Broker**
+
+```shell
+$ docker run -it --net=host --mount source=/tmp/store,target=/home/rocketmq/store apache/rocketmq ./mqbroker -n localhost:9876
+```
+
+### Run RocketMQ in Kubernetes
+
+You can also run a RocketMQ cluster within a Kubernetes cluster using [RocketMQ Operator](https://github.com/apache/rocketmq-operator).
+Before your operations, make sure that `kubectl` and related kubeconfig file installed on your machine.
+
+**1) Install CRDs**
+```shell
+### install CRDs
+$ git clone https://github.com/apache/rocketmq-operator
+$ cd rocketmq-operator && make deploy
+
+### check whether CRDs is successfully installed
+$ kubectl get crd | grep rocketmq.apache.org
+brokers.rocketmq.apache.org                 2022-05-12T09:23:18Z
+consoles.rocketmq.apache.org                2022-05-12T09:23:19Z
+nameservices.rocketmq.apache.org            2022-05-12T09:23:18Z
+topictransfers.rocketmq.apache.org          2022-05-12T09:23:19Z
+
+### check whether operator is running
+$ kubectl get pods | grep rocketmq-operator
+rocketmq-operator-6f65c77c49-8hwmj   1/1     Running   0          93s
+```
+
+**2) Create Cluster Instance**
+```shell
+### create RocketMQ cluster resource
+$ cd example && kubectl create -f rocketmq_v1alpha1_rocketmq_cluster.yaml
+
+### check whether cluster resources is running
+$ kubectl get sts
+NAME                 READY   AGE
+broker-0-master      1/1     107m
+broker-0-replica-1   1/1     107m
+name-service         1/1     107m
+```
+
+---
 ## Apache RocketMQ Community
-* [RocketMQ Streams](https://github.com/apache/rocketmq-streams)
-* [RocketMQ Flink](https://github.com/apache/rocketmq-flink)
-* [RocketMQ Client CPP](https://github.com/apache/rocketmq-client-cpp)
-* [RocketMQ Client Go](https://github.com/apache/rocketmq-client-go)
-* [RocketMQ Client Python](https://github.com/apache/rocketmq-client-python)
-* [RocketMQ Client Nodejs](https://github.com/apache/rocketmq-client-nodejs)
-* [RocketMQ Spring](https://github.com/apache/rocketmq-spring)
-* [RocketMQ Exporter](https://github.com/apache/rocketmq-exporter)
-* [RocketMQ Operator](https://github.com/apache/rocketmq-operator)
-* [RocketMQ Docker](https://github.com/apache/rocketmq-docker)
-* [RocketMQ Dashboard](https://github.com/apache/rocketmq-dashboard)
-* [RocketMQ Connect](https://github.com/apache/rocketmq-connect)
-* [RocketMQ MQTT](https://github.com/apache/rocketmq-mqtt)
-* [RocketMQ Incubating Community Projects](https://github.com/apache/rocketmq-externals)
+* [RocketMQ Streams](https://github.com/apache/rocketmq-streams): A lightweight stream computing engine based on Apache RocketMQ.
+* [RocketMQ Flink](https://github.com/apache/rocketmq-flink): The Apache RocketMQ connector of Apache Flink that supports source and sink connector in data stream and Table.
+* RocketMQ Muli-Language Clients
+	 - [RocketMQ Client CPP](https://github.com/apache/rocketmq-client-cpp)
+	 - [RocketMQ Client Go](https://github.com/apache/rocketmq-client-go)
+	 - [RocketMQ Client Python](https://github.com/apache/rocketmq-client-python)
+	 - [RocketMQ Client Nodejs](https://github.com/apache/rocketmq-client-nodejs)
+* [RocketMQ Spring](https://github.com/apache/rocketmq-spring): A project which helps developers quickly integrate Apache RocketMQ with Spring Boot.
+* [RocketMQ Exporter](https://github.com/apache/rocketmq-exporter): An Apache RocketMQ exporter for Prometheus.
+* [RocketMQ Operator](https://github.com/apache/rocketmq-operator): Providing a way to run an Apache RocketMQ cluster on Kubernetes.
+* [RocketMQ Docker](https://github.com/apache/rocketmq-docker): The Git repo of the Docker Image for Apache RocketMQ.
+* [RocketMQ Dashboard](https://github.com/apache/rocketmq-dashboard): Operation and maintenance console of Apache RocketMQ.
+* [RocketMQ Connect](https://github.com/apache/rocketmq-connect): A tool for scalably and reliably streaming data between Apache RocketMQ and other systems.
+* [RocketMQ MQTT](https://github.com/apache/rocketmq-mqtt): A new MQTT protocol architecture model, based on which Apache RocketMQ can better support messages from terminals such as IoT devices and Mobile APP.
+* [RocketMQ Incubating Community Projects](https://github.com/apache/rocketmq-externals): Icubator community projects of Apache RocketMQ, including [logappender](https://github.com/apache/rocketmq-externals/tree/master/logappender), [rocketmq-ansible](https://github.com/apache/rocketmq-externals/tree/master/rocketmq-ansible), [rocketmq-beats-integration](https://github.com/apache/rocketmq-externals/tree/master/rocketmq-beats-integration), [rocketmq-cloudevents-binding](https://github.com/apache/rocketmq-externals/tree/master/rocketmq-cloudevents-binding), etc.
+* [RocketMQ Site](https://github.com/apache/rocketmq-site): The repository for Apache RocketMQ website.
+
 
 ----------
 ## Learn it & Contact us

acl/pom.xml

@@ -13,7 +13,7 @@
     <parent>
         <groupId>org.apache.rocketmq</groupId>
         <artifactId>rocketmq-all</artifactId>
-        <version>4.9.4-SNAPSHOT</version>
+        <version>4.9.5-SNAPSHOT</version>
     </parent>
     <artifactId>rocketmq-acl</artifactId>
     <name>rocketmq-acl ${project.version}</name>

acl/src/main/java/org/apache/rocketmq/acl/AccessValidator.java

@@ -73,6 +73,8 @@ public interface AccessValidator {
      */
     boolean updateGlobalWhiteAddrsConfig(List<String> globalWhiteAddrsList);
 
+    boolean updateGlobalWhiteAddrsConfig(List<String> globalWhiteAddrsList, String aclFileFullPath);
+
     /**
      * get broker cluster acl config information
      *