README update

Fix the last remaining mention of "Urchin" and clean up the instructions on how to run it.
This commit is contained in:
Pekka Enberg 2017-03-03 12:35:00 +02:00
parent 9c11768b9d
commit 34c10fc91c

View File

@ -1,22 +1,25 @@
# Urchin JMX Interface # Scylla JMX Server
This is the JMX interface for Scylla
## Compile Scylla JMX server implements the Apache Cassandra JMX interface for compatibility with tooling such as `nodetool`. The JMX server uses Scylla's REST API to communicate with a Scylla server.
To compile do:
``` ## Compiling
mvn install
To compile JMX server, run:
```console
$ mvn package
``` ```
## Run ## Running
The maven will create an uber-jar with all dependency under the target directory. You should run it with the remote jmx enable so the nodetool will be able to connect to it.
``` To start the JMX server, run:
java -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=7199 -Dcom.sun.management.jmxremote.local.only=false -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -jar target/scylla-jmx-1.0.jar
```console
$ ./scripts/scylla-jmx
``` ```
## Setting IP and Port To get help on supported options:
By default the the JMX would connect to a node on the localhost
on port 10000.
The jmx API uses the system properties to set the IP address and Port. ```console
To change the ip address use the apiaddress property (e.g. -Dapiaddress=1.1.1.1) $ ./scripts/scylla-jmx --help
To change the port use the apiport (e.g. -Dapiport=10001) ```