From abf0aa8f0cae6b9aa27669ce41a1760e83f002df Mon Sep 17 00:00:00 2001 From: Jiri Danek Date: Mon, 24 Apr 2017 09:49:32 +0200 Subject: [PATCH] NO-JIRA update `artemis create` samples in README.html and using-server.md --- .../activemq/artemis/cli/commands/Create.java | 10 ++-- .../src/main/resources/README.html | 36 +++++++------ docs/user-manual/en/using-server.md | 54 +++++++++++++------ 3 files changed, 62 insertions(+), 38 deletions(-) diff --git a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/Create.java b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/Create.java index 3468cbf9eb..66bffe2c38 100644 --- a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/Create.java +++ b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/Create.java @@ -215,19 +215,19 @@ public class Create extends InputAbstract { @Option(name = "--role", description = "The name for the role created (Default: amq)") String role = "amq"; - @Option(name = "--no-web", description = "remove the web-server definition from bootstrap.xml") + @Option(name = "--no-web", description = "Remove the web-server definition from bootstrap.xml") boolean noWeb; - @Option(name = "--queues", description = "comma separated list of queues.") + @Option(name = "--queues", description = "Comma separated list of queues.") String queues; - @Option(name = "--addresses", description = "comma separated list of addresses ") + @Option(name = "--addresses", description = "Comma separated list of addresses ") String addresses; - @Option(name = "--aio", description = "sets the journal as asyncio.") + @Option(name = "--aio", description = "Sets the journal as asyncio.") boolean aio; - @Option(name = "--nio", description = "sets the journal as nio.") + @Option(name = "--nio", description = "Sets the journal as nio.") boolean nio; @Option(name = "--mapped", description = "Sets the journal as mapped.") diff --git a/artemis-distribution/src/main/resources/README.html b/artemis-distribution/src/main/resources/README.html index d9fb198265..e309c81cc2 100644 --- a/artemis-distribution/src/main/resources/README.html +++ b/artemis-distribution/src/main/resources/README.html @@ -42,20 +42,17 @@ $ ./artemis create $directory

Where $directory is the folder that you'd The create process will input for any required property not specified. Example: 
---user: is mandatory with this configuration:
+--user: is a mandatory property!
 Please provide the default username:
 admin
 
 --password: is mandatory with this configuration:
 Please provide the default password:
 
---role: is mandatory with this configuration:
-Please provide the default role:
-admin
 
---allow-anonymous | --require-login: is mandatory with this configuration:
-Allow anonymous access? (Y/N):
-Y
+--allow-anonymous | --require-login: is a mandatory property!
+Allow anonymous access?, valid values are Y,N,True,False
+y
For a full list of available options for the create process you may use: @@ -66,17 +63,24 @@ NAME artemis create - creates a new broker instance SYNOPSIS - artemis create [--aio] [--allow-anonymous] - [--cluster-password <clusterPassword>] [--cluster-user <clusterUser>] - [--clustered] [--data <data>] [--disable-persistence] + artemis create [--addresses <addresses>] [--aio] [--allow-anonymous] + [--autocreate] [--blocking] [--cluster-password <clusterPassword>] + [--cluster-user <clusterUser>] [--clustered] [--data <data>] + [--default-port <defaultPort>] [--disable-persistence] [--encoding <encoding>] [--failover-on-shutdown] [--force] - [--home <home>] [--host <host>] [--java-options <javaOptions>] - [--max-hops <maxHops>] [--message-load-balancing <messageLoadBalancing>] - [--name <name>] [--nio] [--no-autotune] [--no-web] - [--password <password>] [--port-offset <portOffset>] [--queues <queues>] + [--global-max-size <globalMaxSize>] [--home <home>] [--host <host>] + [--http-host <httpHost>] [--http-port <httpPort>] + [--java-options <javaOptions>] [--mapped] [--max-hops <maxHops>] + [--message-load-balancing <messageLoadBalancing>] [--name <name>] + [--nio] [--no-amqp-acceptor] [--no-autocreate] [--no-autotune] + [--no-fsync] [--no-hornetq-acceptor] [--no-mqtt-acceptor] + [--no-stomp-acceptor] [--no-web] [--paging] [--password <password>] + [--ping <ping>] [--port-offset <portOffset>] [--queues <queues>] [--replicated] [--require-login] [--role <role>] [--shared-store] - [--silent] [--slave] [--topics <topics>] [--user <user>] [--verbose] - [--] <directory> + [--silent] [--slave] [--ssl-key <sslKey>] + [--ssl-key-password <sslKeyPassword>] [--ssl-trust <sslTrust>] + [--ssl-trust-password <sslTrustPassword>] [--use-client-auth] + [--user <user>] [--verbose] [--] <directory> ... diff --git a/docs/user-manual/en/using-server.md b/docs/user-manual/en/using-server.md index 16c9a5a1ab..b1e2c914bf 100644 --- a/docs/user-manual/en/using-server.md +++ b/docs/user-manual/en/using-server.md @@ -89,28 +89,30 @@ For a full list of updated properties always use: SYNOPSIS artemis create [--addresses ] [--aio] [--allow-anonymous] - [--autocreate] [--cluster-password ] + [--autocreate] [--blocking] [--cluster-password ] [--cluster-user ] [--clustered] [--data ] [--default-port ] [--disable-persistence] [--encoding ] [--failover-on-shutdown] [--force] - [--home ] [--host ] [--http-port ] + [--global-max-size ] [--home ] [--host ] + [--http-host ] [--http-port ] [--java-options ] [--mapped] [--max-hops ] [--message-load-balancing ] [--name ] [--nio] [--no-amqp-acceptor] [--no-autocreate] [--no-autotune] [--no-fsync] [--no-hornetq-acceptor] [--no-mqtt-acceptor] - [--no-stomp-acceptor] [--no-web] [--password ] [--ping ] - [--port-offset ] [--queues ] [--replicated] - [--require-login] [--role ] [--shared-store] [--silent] [--slave] - [--ssl-key ] [--ssl-key-password ] - [--ssl-trust ] [--ssl-trust-password ] - [--use-client-auth] [--user ] [--verbose] [--] + [--no-stomp-acceptor] [--no-web] [--paging] [--password ] + [--ping ] [--port-offset ] [--queues ] + [--replicated] [--require-login] [--role ] [--shared-store] + [--silent] [--slave] [--ssl-key ] + [--ssl-key-password ] [--ssl-trust ] + [--ssl-trust-password ] [--use-client-auth] + [--user ] [--verbose] [--] OPTIONS --addresses - comma separated list of addresses + Comma separated list of addresses --aio - sets the journal as asyncio. + Sets the journal as asyncio. --allow-anonymous Enables anonymous configuration on security, opposite of @@ -119,6 +121,10 @@ For a full list of updated properties always use: --autocreate Auto create addresses. (default: true) + --blocking + Block producers when address becomes full, opposite of --paging + (Default: false) + --cluster-password The cluster password to use for clustering. (Default: input) @@ -149,12 +155,19 @@ For a full list of updated properties always use: --force Overwrite configuration at destination directory + --global-max-size + Maximum amount of memory which message data may consume (Default: + Undefined, half of the system's memory) + --home Directory where ActiveMQ Artemis is installed --host The host name of the broker (Default: 0.0.0.0 or input if clustered) + --http-host + The host name to use for embedded web server (Default: localhost) + --http-port The port number to use for embedded web server (Default: 8161) @@ -175,7 +188,7 @@ For a full list of updated properties always use: The name of the broker (Default: same as host) --nio - sets the journal as nio. + Sets the journal as nio. --no-amqp-acceptor Disable the AMQP specific acceptor. @@ -200,7 +213,11 @@ For a full list of updated properties always use: Disable the STOMP specific acceptor. --no-web - This will remove the web server definition from bootstrap.xml + Remove the web-server definition from bootstrap.xml + + --paging + Page messages to disk when address becomes full, opposite of + --blocking (Default: true) --password The user's password (Default: input) @@ -214,7 +231,7 @@ For a full list of updated properties always use: Off sets the ports of every acceptor --queues - comma separated list of queues. + Comma separated list of queues. --replicated Enable broker replication @@ -224,7 +241,7 @@ For a full list of updated properties always use: --allow-anonymous --role - The name for the role created (Default: input) + The name for the role created (Default: amq) --shared-store Enable broker shared store @@ -274,7 +291,7 @@ Some of these properties may be mandatory in certain configurations and the syst ./artemis create /usr/server Creating ActiveMQ Artemis instance at: /user/server - --user: is mandatory with this configuration: + --user: is a mandatory property! Please provide the default username: admin @@ -282,10 +299,13 @@ Some of these properties may be mandatory in certain configurations and the syst Please provide the default password: - --allow-anonymous: is mandatory with this configuration: - Allow anonymous access? (Y/N): + --allow-anonymous | --require-login: is a mandatory property! + Allow anonymous access?, valid values are Y,N,True,False y + Auto tuning journal ... + done! Your system can make 0.34 writes per millisecond, your journal-buffer-timeout will be 2956000 + You can now start the broker by executing: "/user/server/bin/artemis" run