Skip to content

Commit aa8eabc

Browse files
committed
Update documentation to use RabbitMQ 3.9 RC
1 parent 3ef3ebc commit aa8eabc

File tree

4 files changed

+56
-30
lines changed

4 files changed

+56
-30
lines changed

README.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,15 @@ To build the JAR file:
6565
Launch the broker:
6666

6767
----
68-
docker run -it --rm --name rabbitmq --network host pivotalrabbitmq/rabbitmq-stream
68+
docker run -it --rm --name rabbitmq -p 5552:5552 -p 5672:5672 \
69+
-e RABBITMQ_SERVER_ADDITIONAL_ERL_ARGS='-rabbitmq_stream advertised_host localhost -rabbit loopback_users "none"' \
70+
rabbitmq:3.9-rc
71+
----
72+
73+
Enable the stream plugin:
74+
75+
----
76+
docker exec rabbitmq rabbitmq-plugins enable rabbitmq_stream
6977
----
7078

7179
Launch the tests:
@@ -74,7 +82,7 @@ Launch the tests:
7482
./mvnw test -Drabbitmqctl.bin=DOCKER:rabbitmq
7583
----
7684

77-
=== Running Tests
85+
=== Running Tests with a Local Broker
7886

7987
To launch the test suite (requires a local RabbitMQ node with stream plugin enabled):
8088

src/docs/asciidoc/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ifndef::sourcedir[:sourcedir: ../../main/java]
66
:source-highlighter: prettify
77

88
The RabbitMQ Stream Java Client is a Java library to communicate with
9-
the https://github.com/rabbitmq/rabbitmq-stream[RabbitMQ Stream Plugin].
9+
the https://rabbitmq.com/stream.html[RabbitMQ Stream Plugin].
1010
It allows creating and deleting streams, as well as publishing to and consuming from
1111
these streams. Learn more in the <<overview.adoc#stream-client-overview,the client overview>>.
1212

src/docs/asciidoc/performance-tool.adoc

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,10 @@ this is perfect for experimenting locally.
4747
.Running the broker and performance tool with the host network driver
4848
----
4949
# run the broker
50-
docker run -it --rm --network host pivotalrabbitmq/rabbitmq-stream
51-
# open another terminal and run the performance tool
50+
docker run -it --rm --name rabbitmq --network host rabbitmq:3.9-rc
51+
# open another terminal and enable the stream plugin
52+
docker exec rabbitmq rabbitmq-plugins enable rabbitmq_stream
53+
# run the performance tool
5254
docker run -it --rm --network host pivotalrabbitmq/stream-perf-test
5355
----
5456

@@ -70,15 +72,21 @@ can be done by defining a network and running the containers in this network.
7072
# create a network
7173
docker network create stream-perf-test
7274
# run the broker
73-
docker run -it --rm --network stream-perf-test --name rabbitmq pivotalrabbitmq/rabbitmq-stream
74-
# open another terminal and run the performance tool
75+
docker run -it --rm --network stream-perf-test --name rabbitmq \
76+
-e RABBITMQ_SERVER_ADDITIONAL_ERL_ARGS='-rabbit loopback_users "none"' \
77+
rabbitmq:3.9-rc
78+
# open another terminal and enable the stream plugin
79+
docker exec rabbitmq rabbitmq-plugins enable rabbitmq_stream
80+
# run the performance tool
7581
docker run -it --rm --network stream-perf-test pivotalrabbitmq/stream-perf-test \
7682
--uris rabbitmq-stream://rabbitmq:5552
7783
----
7884

7985
==== With the Java Binary
8086

81-
The Java binary is https://github.com/rabbitmq/rabbitmq-java-tools-binaries-dev/releases[on GitHub Release]:
87+
The Java binary is available on
88+
https://github.com/rabbitmq/rabbitmq-stream-java-client/releases[GitHub Release].
89+
https://github.com/rabbitmq/rabbitmq-java-tools-binaries-dev/releases[Snaphots] are available as well. To use the latest snapshot:
8290

8391
----
8492
wget https://github.com/rabbitmq/rabbitmq-java-tools-binaries-dev/releases/download/v-stream-perf-test-latest/stream-perf-test-latest.jar

src/docs/asciidoc/setup.adoc

Lines changed: 32 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
=== Setting up RabbitMQ
22

3-
A RabbitMQ node with the stream plugin enabled is required. The easiest way
4-
to get up and running is to use Docker. It is also possible to use the
5-
generic Unix package.
3+
A RabbitMQ 3.9+ node with the stream plugin enabled is required. The easiest way
4+
to get up and running is to use Docker.
65

76
==== With Docker
87

@@ -22,14 +21,13 @@ This section shows how to start a broker instance for local development
2221
(the broker Docker container and the client application are assumed to run on the
2322
same host).
2423

25-
The following command creates a one-time Docker container to run RabbitMQ
26-
with the stream plugin enabled:
24+
The following command creates a one-time Docker container to run RabbitMQ:
2725

2826
.Running the stream plugin with Docker
2927
----
3028
docker run -it --rm --name rabbitmq -p 5552:5552 \
31-
-e RABBITMQ_SERVER_ADDITIONAL_ERL_ARGS="-rabbitmq_stream advertised_host localhost" \
32-
pivotalrabbitmq/rabbitmq-stream
29+
-e RABBITMQ_SERVER_ADDITIONAL_ERL_ARGS='-rabbitmq_stream advertised_host localhost -rabbit loopback_users "none"' \
30+
rabbitmq:3.9-rc
3331
----
3432

3533
The previous command exposes only the stream port (5552), you can expose
@@ -38,16 +36,19 @@ ports for other protocols:
3836
.Exposing the AMQP 0.9.1 and management ports:
3937
----
4038
docker run -it --rm --name rabbitmq -p 5552:5552 -p 5672:5672 -p 15672:15672 \
41-
-e RABBITMQ_SERVER_ADDITIONAL_ERL_ARGS="-rabbitmq_stream advertised_host localhost" \
42-
pivotalrabbitmq/rabbitmq-stream
39+
-e RABBITMQ_SERVER_ADDITIONAL_ERL_ARGS='-rabbitmq_stream advertised_host localhost -rabbit loopback_users "none"' \
40+
rabbitmq:3.9-rc-management
4341
----
4442

4543
Refer to the official https://hub.docker.com/_/rabbitmq[RabbitMQ Docker image web page]
46-
to find out more about its usage. Make sure to use the `pivotalrabbitmq/rabbitmq-stream`
47-
image in the command line.
44+
to find out more about its usage.
4845

49-
The `pivotalrabbitmq/rabbitmq-stream` Docker image is meant for development usage only. It does not
50-
support all the features of the official Docker image, like TLS.
46+
Once the container is started, **the stream plugin must be enabled**:
47+
48+
.Enabling the stream plugin:
49+
----
50+
docker exec rabbitmq rabbitmq-plugins enable rabbitmq_stream
51+
----
5152

5253
===== With Docker Host Network Driver
5354

@@ -57,26 +58,35 @@ this is perfect for experimenting locally.
5758

5859
.Running RabbitMQ Stream with the host network driver
5960
----
60-
docker run -it --rm --network host pivotalrabbitmq/rabbitmq-stream
61+
docker run -it --rm --name rabbitmq --network host rabbitmq:3.9-rc
62+
----
63+
64+
Once the container is started, **the stream plugin must be enabled**:
65+
66+
.Enabling the stream plugin:
67+
----
68+
docker exec rabbitmq rabbitmq-plugins enable rabbitmq_stream
6169
----
6270

63-
The command above will use the following ports: 5552 (for stream), 5672 (for AMQP),
64-
15672 (for management plugin).
71+
The container will use the following ports: 5552 (for stream) and 5672 (for AMQP.)
6572

6673
[NOTE]
6774
.Docker Host Network Driver Support
6875
====
6976
The host networking driver *only works on Linux hosts*.
7077
====
7178

72-
==== With the Generic Unix Package
79+
==== With a RabbitMQ Package Running on the Host
80+
81+
Using a package implies installing Erlang.
7382

74-
The generic Unix package requires https://www.rabbitmq.com/which-erlang.html[Erlang] to be installed.
83+
* Make sure to use https://github.com/rabbitmq/rabbitmq-server/releases[RabbitMQ 3.9 or more].
84+
* Follow the steps to
85+
https://rabbitmq.com/download.html[install Erlang and the appropriate package]
86+
* Enable the plugin `rabbitmq-plugins enable rabbitmq_stream`.
87+
* The stream plugin listens on port 5552.
7588

76-
* Download the https://github.com/rabbitmq/rabbitmq-server-binaries-dev/releases[latest generic Unix `alpha-stream` archive].
77-
* Follow the https://www.rabbitmq.com/install-generic-unix.html[instructions to install the generic Unix package].
78-
* Enable the plugin `./rabbitmq-plugins enable rabbitmq_stream`.
79-
* Start the broker `./rabbitmq-server -detached`. This starts the stream listener on port 5552.
89+
Refer to the https://rabbitmq.com/stream.html[stream plugin documentation] for more information on configuration.
8090

8191
=== Dependencies
8292

0 commit comments

Comments
 (0)