activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From clebertsuco...@apache.org
Subject [1/2] activemq-artemis git commit: Doc improvements around libaio and removing extra chapter about running server
Date Thu, 21 May 2015 21:34:57 GMT
Repository: activemq-artemis
Updated Branches:
  refs/heads/master 22d54c583 -> 27cbc92a9


Doc improvements around libaio and removing extra chapter about running server


Project: http://git-wip-us.apache.org/repos/asf/activemq-artemis/repo
Commit: http://git-wip-us.apache.org/repos/asf/activemq-artemis/commit/647f6657
Tree: http://git-wip-us.apache.org/repos/asf/activemq-artemis/tree/647f6657
Diff: http://git-wip-us.apache.org/repos/asf/activemq-artemis/diff/647f6657

Branch: refs/heads/master
Commit: 647f665700ab79a7d378c7035f5eb7e63b66307d
Parents: 22d54c5
Author: Clebert Suconic <clebertsuconic@apache.org>
Authored: Thu May 21 11:51:48 2015 -0400
Committer: Clebert Suconic <clebertsuconic@apache.org>
Committed: Thu May 21 11:51:48 2015 -0400

----------------------------------------------------------------------
 docs/user-manual/en/SUMMARY.md        |   1 -
 docs/user-manual/en/libaio.md         |  28 +++-
 docs/user-manual/en/running-server.md | 246 -----------------------------
 docs/user-manual/en/using-server.md   | 177 ++++++++++++++++++++-
 4 files changed, 194 insertions(+), 258 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/647f6657/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index fce7fbb..97e3ec3 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -4,7 +4,6 @@
 * [Legal Notice](notice.md)
 * [Preface](preface.md)
 * [Project Info](project-info.md)
-* [Running the Server](running-server.md)
 * [Messaging Concepts](messaging-concepts.md)
 * [Architecture](architecture.md)
 * [Using the Server](using-server.md)

http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/647f6657/docs/user-manual/en/libaio.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/libaio.md b/docs/user-manual/en/libaio.md
index 8140426..787d044 100644
--- a/docs/user-manual/en/libaio.md
+++ b/docs/user-manual/en/libaio.md
@@ -1,6 +1,6 @@
 # Libaio Native Libraries
 
-Apache ActiveMQ Artemis distributes a native library, used as a bridge between Apache ActiveMQ
Artemis
+Apache ActiveMQ Artemis distributes a native library, used as a bridge for its fast journal,
between Apache ActiveMQ Artemis
 and Linux libaio.
 
 `libaio` is a library, developed as part of the Linux kernel project.
@@ -18,7 +18,23 @@ These are the native libraries distributed by Apache ActiveMQ Artemis:
 -   libActiveMQAIO64.so - x86 64 bits
 
 When using libaio, Apache ActiveMQ Artemis will always try loading these files as long
-as they are on the [library path](#using-server.library.path).
+as they are on the [library path](using-server.html#library-path)
+
+
+## Runtime dependencies
+
+If you just want to use the provided native binaries you need to install the required libaio
dependency.
+
+You can install libaio using the following steps as the root user:
+
+Using yum, (e.g. on Fedora or Red Hat Enterprise Linux):
+
+    yum install libaio
+
+Using aptitude, (e.g. on Ubuntu or Debian system):
+
+    apt-get install libaio
+
 
 ## Compiling the native libraries
 
@@ -27,11 +43,11 @@ x86\_64 (for example Itanium 64 bits or IBM Power) you may need to
 compile the native library, since we do not distribute binaries for
 those platforms with the release.
 
-## Install requirements
+## Compilation dependencies
 
 > **Note**
 >
-> At the moment the native layer is only available on Linux. If you are
+> The native layer is only available on Linux. If you are
 > in a platform other than Linux the native compilation will not work
 
 These are the required linux packages to be installed for the compilation to work:
@@ -51,11 +67,11 @@ These are the required linux packages to be installed for the compilation
to wor
 
 To perform this installation on RHEL or Fedora, you can simply type this at a command line:
 
-    sudo yum install libtool gcc-c++ gcc libaio libaio-devel make
+    sudo yum install libtool gcc-c++ gcc libaio libaio-devel
 
 Or on Debian systems:
 
-    sudo apt-get install libtool gcc-g++ gcc libaio libaio-dev make
+    sudo apt-get install libtool gcc-g++ gcc libaio libaio-dev
 
 > **Note**
 >

http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/647f6657/docs/user-manual/en/running-server.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/running-server.md b/docs/user-manual/en/running-server.md
deleted file mode 100644
index c9e1e4a..0000000
--- a/docs/user-manual/en/running-server.md
+++ /dev/null
@@ -1,246 +0,0 @@
-Prerequisites
-=============
-
-> **Note**
->
-> ActiveMQ Artemis only runs on Java 7 or later.
-
-By default, ActiveMQ Artemis server runs with 1GiB of memory. If your computer
-has less memory, or you want to run it with more available RAM, modify
-the value in `bin/run.sh` accordingly.
-
-If you are on Linux you may want to enable libaio For persistence,
-ActiveMQ Artemis uses its own fast journal, which you can
-configure to use libaio (which is the default when running on Linux) or
-Java NIO. In order to use the libaio module on Linux, you'll need to
-install libaio, if it's not already installed.
-
-If you're not running on Linux then you don't need to worry about this.
-
-You can install libaio using the following steps as the root user:
-
-Using yum, (e.g. on Fedora or Red Hat Enterprise Linux):
-
-    yum install libaio
-
-Using aptitude, (e.g. on Ubuntu or Debian system):
-
-    apt-get install libaio
-
-Installation
-============
-
-After downloading the distribution, the following highlights some important folders on the
distribution:
-
-             |___ bin
-             |
-             |___ web
-             |      |___ user-manual
-             |      |___ api
-             |
-             |___ examples
-             |      |___ core
-             |      |___ javaee
-             |      |___ jms
-             |
-             |___ lib
-             |
-             |___ schema
-
-
--   `bin` -- binaries and scripts needed to run ActiveMQ Artemis.
-
--   `web` -- The folder where the web context is loaded when ActiveMQ Artemis runs.
-
--   `user-manual` -- The user manual is placed under the web folder.
-
--   `api` -- The api documentation is placed under the web folder
-
--   `examples` -- JMS and Java EE examples. Please refer to the 'running
-    examples' chapter for details on how to run them.
-
--   `lib` -- jars and libraries needed to run ActiveMQ Artemis
-
--   `licenses` -- licenses for ActiveMQ Artemis
-
--   `schemas` -- XML Schemas used to validate ActiveMQ Artemis configuration
-    files
-
-Creating a Broker Instance
-==========================
-
-
-A broker instance is the directory containing all the configuration and runtime
-data, such as logs and data files, associated with a broker process.  It is recommended that
-you do *not* create the instance directory under `${ARTEMIS_HOME}`.  This separation is
-encouraged so that you can more easily upgrade when the next version of ActiveMQ Artemis
is released.
-
-On Unix systems, it is a common convention to store this kind of runtime data under
-the `/var/lib` directory.  For example, to create an instance at '/var/lib/mybroker', run
-the following commands in your command line shell:
-
-    cd /var/lib
-    ${ARTEMIS_HOME}/bin/activemq create mybroker
-
-A broker instance directory will contain the following sub directories:
-
- * `bin`: holds execution scripts associated with this instance.
- * `etc`: hold the instance configuration files
- * `data`: holds the data files used for storing persistent messages
- * `log`: holds rotating log files
- * `tmp`: holds temporary files that are safe to delete between broker runs
-
-At this point you may want to adjust the default configuration located in
-the `etc` directory.
-
-Environment variables are used to provide ease of changing ports, hosts and
-data directories used and can be found in `etc/activemq.profile` on linux and
-`etc\activemq.profile.cmd` on Windows.
-
-
-Options
-=======
-
-There are several options you can use when creating an instance.
-
-For a full list of updated properties always use:
-
-```
- $./artemis help create
- NAME
-         artemis create - creates a new broker instance
-
- SYNOPSIS
-         artemis create [--allow-anonymous]
-                 [--cluster-password <clusterPassword>] [--cluster-user <clusterUser>]
-                 [--clustered] [--data <data>] [--encoding <encoding>] [--force]
-                 [--home <home>] [--host <host>] [--java-options <javaOptions>]
-                 [--password <password>] [--port-offset <portOffset>] [--replicated]
-                 [--role <role>] [--shared-store] [--silent-input] [--user <user>]
[--]
-                 <directory>
-
- OPTIONS
-         --allow-anonymous
-             Enables anonymous configuration on security (Default: input)
-
-         --cluster-password <clusterPassword>
-             The cluster password to use for clustering. (Default: input)
-
-         --cluster-user <clusterUser>
-             The cluster user to use for clustering. (Default: input)
-
-         --clustered
-             Enable clustering
-
-         --data <data>
-             Directory where ActiveMQ Data is used. Path are relative to
-             artemis.instance/bin
-
-         --encoding <encoding>
-             The encoding that text files should use
-
-         --force
-             Overwrite configuration at destination directory
-
-         --home <home>
-             Directory where ActiveMQ Artemis is installed
-
-         --host <host>
-             The host name of the broker (Default: 0.0.0.0 or input if clustered)
-
-         --java-options <javaOptions>
-             Extra java options to be passed to the profile
-
-         --password <password>
-             The user's password (Default: input)
-
-         --port-offset <portOffset>
-             Off sets the default ports
-
-         --replicated
-             Enable broker replication
-
-         --role <role>
-             The name for the role created (Default: amq)
-
-         --shared-store
-             Enable broker shared store
-
-         --silent-input
-             It will disable all the inputs, and it would make a best guess for
-             any required input
-
-         --user <user>
-             The username (Default: input)
-
-         --
-             This option can be used to separate command-line options from the
-             list of argument, (useful when arguments might be mistaken for
-             command-line options
-
-         <directory>
-             The instance directory to hold the broker's configuration and data
-```
-
-Some of these properties may be mandatory in certain configurations and the system may ask
you for additional input.
-
-```
-    ./artemis create /usr/server
-    Creating ActiveMQ Artemis instance at: /user/server
-
-    --user: is mandatory with this configuration:
-    Please provide the default username:
-    admin
-
-    --password: is mandatory with this configuration:
-    Please provide the default password:
-
-
-    --allow-anonymous: is mandatory with this configuration:
-    Allow anonymous access? (Y/N):
-    y
-
-    You can now start the broker by executing:
-
-       "/user/server/bin/artemis" run
-
-    Or you can run the broker in the background using:
-
-       "/user/server/bin/artemis-service" start
-```
-
-
-Starting and Stopping a Broker Instance
-=======================================
-
-Assuming you created the broker instance under `/var/lib/mybroker` all you need
-to do start running the broker instance is execute:
-
-    /var/lib/mybroker/bin/activemq run
-
-Now that the broker is running, you can optionally run some of the included
-examples to verify the the broker is running properly.
-
-To stop the Apache ActiveMQ Artemis instance you will use the same `activemq` script, but
with
-the `stop argument`.  Example:
-
-    /var/lib/mybroker/bin/activemq stop
-
-By default the `etc/bootstrap.xml` configuration is
-used. The configuration can be changed e.g. by running
-`./activemq run -- xml:path/to/bootstrap.xml` or another
-config of your choosing.
-
-
-Windows Server
-==============
-
-On windows you will have the option to run ActiveMQ Artemis as a service.
-Just use the following command to install it:
-
-```
- $ ./artemis-service.exe install
-```
-
-
-The create process should give you a hint of the available commands available for the artemis-service.exe
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/647f6657/docs/user-manual/en/using-server.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/using-server.md b/docs/user-manual/en/using-server.md
index 59dc3c4..2fa214d 100644
--- a/docs/user-manual/en/using-server.md
+++ b/docs/user-manual/en/using-server.md
@@ -12,6 +12,46 @@ with a JMS Service enabled.
 This document will refer to the full path of the directory where the ActiveMQ
 distribution has been extracted to as `${ARTEMIS_HOME}` directory.
 
+Installation
+============
+
+After downloading the distribution, the following highlights some important folders on the
distribution:
+
+             |___ bin
+             |
+             |___ web
+             |      |___ user-manual
+             |      |___ api
+             |
+             |___ examples
+             |      |___ core
+             |      |___ javaee
+             |      |___ jms
+             |
+             |___ lib
+             |
+             |___ schema
+
+
+-   `bin` -- binaries and scripts needed to run ActiveMQ Artemis.
+
+-   `web` -- The folder where the web context is loaded when ActiveMQ Artemis runs.
+
+-   `user-manual` -- The user manual is placed under the web folder.
+
+-   `api` -- The api documentation is placed under the web folder
+
+-   `examples` -- JMS and Java EE examples. Please refer to the 'running
+    examples' chapter for details on how to run them.
+
+-   `lib` -- jars and libraries needed to run ActiveMQ Artemis
+
+-   `licenses` -- licenses for ActiveMQ Artemis
+
+-   `schemas` -- XML Schemas used to validate ActiveMQ Artemis configuration
+    files
+
+
 ## Creating a Broker Instance
 
 A broker instance is the directory containing all the configuration and runtime
@@ -19,7 +59,7 @@ data, such as logs and data files, associated with a broker process.  It
is reco
 you do *not* create the instance directory under `${ARTEMIS_HOME}`.  This separation is
 encouraged so that you can more easily upgrade when the next version of ActiveMQ Artemis
is released.
 
-On Unix systems, it is a common convention to store this kind of runtime data under 
+On Unix systems, it is a common convention to store this kind of runtime data under
 the `/var/lib` directory.  For example, to create an instance at '/var/lib/mybroker', run
 the following commands in your command line shell:
 
@@ -37,6 +77,117 @@ A broker instance directory will contain the following sub directories:
 At this point you may want to adjust the default configuration located in
 the `etc` directory.
 
+###Options
+There are several options you can use when creating an instance.
+
+For a full list of updated properties always use:
+
+```
+ $./artemis help create
+ NAME
+         artemis create - creates a new broker instance
+
+ SYNOPSIS
+         artemis create [--allow-anonymous]
+                 [--cluster-password <clusterPassword>] [--cluster-user <clusterUser>]
+                 [--clustered] [--data <data>] [--encoding <encoding>] [--force]
+                 [--home <home>] [--host <host>] [--java-options <javaOptions>]
+                 [--password <password>] [--port-offset <portOffset>] [--replicated]
+                 [--role <role>] [--shared-store] [--silent-input] [--user <user>]
[--]
+                 <directory>
+
+ OPTIONS
+         --allow-anonymous
+             Enables anonymous configuration on security (Default: input)
+
+         --cluster-password <clusterPassword>
+             The cluster password to use for clustering. (Default: input)
+
+         --cluster-user <clusterUser>
+             The cluster user to use for clustering. (Default: input)
+
+         --clustered
+             Enable clustering
+
+         --data <data>
+             Directory where ActiveMQ Data is used. Path are relative to
+             artemis.instance/bin
+
+         --encoding <encoding>
+             The encoding that text files should use
+
+         --force
+             Overwrite configuration at destination directory
+
+         --home <home>
+             Directory where ActiveMQ Artemis is installed
+
+         --host <host>
+             The host name of the broker (Default: 0.0.0.0 or input if clustered)
+
+         --java-options <javaOptions>
+             Extra java options to be passed to the profile
+
+         --password <password>
+             The user's password (Default: input)
+
+         --port-offset <portOffset>
+             Off sets the default ports
+
+         --replicated
+             Enable broker replication
+
+         --role <role>
+             The name for the role created (Default: amq)
+
+         --shared-store
+             Enable broker shared store
+
+         --silent-input
+             It will disable all the inputs, and it would make a best guess for
+             any required input
+
+         --user <user>
+             The username (Default: input)
+
+         --
+             This option can be used to separate command-line options from the
+             list of argument, (useful when arguments might be mistaken for
+             command-line options
+
+         <directory>
+             The instance directory to hold the broker's configuration and data
+```
+
+
+Some of these properties may be mandatory in certain configurations and the system may ask
you for additional input.
+
+```
+    ./artemis create /usr/server
+    Creating ActiveMQ Artemis instance at: /user/server
+
+    --user: is mandatory with this configuration:
+    Please provide the default username:
+    admin
+
+    --password: is mandatory with this configuration:
+    Please provide the default password:
+
+
+    --allow-anonymous: is mandatory with this configuration:
+    Allow anonymous access? (Y/N):
+    y
+
+    You can now start the broker by executing:
+
+       "/user/server/bin/artemis" run
+
+    Or you can run the broker in the background using:
+
+       "/user/server/bin/artemis-service" start
+```
+
+
 ### Starting and Stopping a Broker Instance
 
 Assuming you created the broker instance under `/var/lib/mybroker` all you need
@@ -44,10 +195,10 @@ to do start running the broker instance is execute:
 
     /var/lib/mybroker/bin/activemq run
 
-Now that the broker is running, you can optionally run some of the included 
+Now that the broker is running, you can optionally run some of the included
 examples to verify the the broker is running properly.
 
-To stop the Apache ActiveMQ Artemis instance you will use the same `activemq` script, but
with 
+To stop the Apache ActiveMQ Artemis instance you will use the same `activemq` script, but
with
 the `stop argument`.  Example:
 
     /var/lib/mybroker/bin/activemq stop
@@ -94,13 +245,16 @@ configuration when running the run script.
 
 ## Library Path
 
-If you're using the [Asynchronous IO Journal](#aio-journal) on Linux,
+If you're using the [Asynchronous IO Journal](libaio.md) on Linux,
 you need to specify `java.library.path` as a property on your Java
 options. This is done automatically in the scripts.
 
 If you don't specify `java.library.path` at your Java options then the
 JVM will use the environment variable `LD_LIBRARY_PATH`.
 
+You will need to make sure libaio is installed on Linux. For more information refer to the
libaio chapter at
+[Runtime Dependencies](libaio.html#runtime-dependencies)
+
 ## System properties
 
 Apache ActiveMQ Artemis can take a system property on the command line for configuring
@@ -164,4 +318,17 @@ cases the defaults will do fine, in fact every attribute can be
 defaulted which means a file with a single empty `configuration` element
 is a valid configuration file. The different configuration will be
 explained throughout the manual or you can refer to the configuration
-reference [here](#configuration-index).
+reference [here](configuration-index.md).
+
+Windows Server
+==============
+
+On windows you will have the option to run ActiveMQ Artemis as a service.
+Just use the following command to install it:
+
+```
+ $ ./artemis-service.exe install
+```
+
+
+The create process should give you a hint of the available commands available for the artemis-service.exe
\ No newline at end of file


Mime
View raw message