Skip to content

Commit 1de2b9e

Browse files
committed
Add instructions for running PerfTest against RabbitMQ in Docker
1 parent 395c288 commit 1de2b9e

File tree

1 file changed

+16
-25
lines changed

1 file changed

+16
-25
lines changed

src/docs/asciidoc/installation.adoc

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
== Installation
22

3-
=== From binary
3+
=== From Binary
44

55
PerfTest is distributed as a binary build archive
66
from https://github.com/rabbitmq/rabbitmq-perf-test/releases[GitHub releases] and
@@ -22,43 +22,34 @@ the `PerfTest` Java class.
2222

2323
To verify a PerfTest installation, use:
2424

25-
$ bin/runjava com.rabbitmq.perf.PerfTest --help
25+
bin/runjava com.rabbitmq.perf.PerfTest --help
2626

2727
=== From Native Executable
2828

2929
PerfTest is also distributed as a native executable binary. This is an experimental
3030
feature, see the link:#native-executable[dedicated section] for more information.
3131

32-
=== With Docker Image
32+
=== From Docker Image
3333

3434
PerfTest has a https://hub.docker.com/r/pivotalrabbitmq/perf-test/[Docker image] as well.
35-
To us it:
35+
To use it:
3636

37-
$ docker run -it --rm pivotalrabbitmq/perf-test:latest --help
37+
docker run -it --rm pivotalrabbitmq/perf-test:latest --help
3838

39-
Note the Docker container needs to be able to contact the host where the broker runs.
40-
Please see the https://docs.docker.com/network/[Docker network documentation]
41-
to find out more about this topic. Once network access is sorted out, PerfTest options
42-
can be used normally, e.g.:
39+
Note that the Docker container needs to be able to connect to the host where
40+
the RabbitMQ broker runs. Find out more at
41+
https://docs.docker.com/network/[Docker network documentation]. Once the
42+
Docker container where PerfTest runs can connect to the RabbitMQ broker,
43+
PerfTest can be run with the regular options, e.g.:
4344

44-
$ docker run -it --rm pivotalrabbitmq/perf-test:latest -x 1 -y 2 \
45-
-u "throughput-test-1" -a --id "test 1"
45+
docker run -it --rm pivotalrabbitmq/perf-test:latest -x 1 -y 2 -u "throughput-test-1" -a --id "test 1"
4646

47-
[NOTE]
48-
====
49-
If both the broker and the container run on the machine, the following Docker options
50-
can be useful for Linux hosts:
47+
To run the RabbitMQ broker within Docker, and run PerfTest against it, run the
48+
following commands:
5149

52-
$ docker run -it --rm --network host pivotalrabbitmq/perf-test:latest
53-
54-
Note the use of the https://docs.docker.com/network/host/[`host` network driver].
55-
This does not work on macOS but a https://docs.docker.com/docker-for-mac/networking/[workaround]
56-
exists:
57-
58-
$ docker run -it --rm pivotalrabbitmq/perf-test:latest -h amqp://host.docker.internal
59-
60-
The special DNS name `host.docker.internal` resolves to the internal IP address used by the host.
61-
====
50+
docker network create perf-test
51+
docker run -it --rm --network perf-test --name rabbitmq -p 15672:15672 rabbitmq:3.7.8-management
52+
docker run -it --rm --network perf-test pivotalrabbitmq/perf-test:latest --uri amqp://rabbitmq
6253

6354
=== For Cloud Foundry
6455

0 commit comments

Comments
 (0)