Repository: activemq-artemis Updated Branches: refs/heads/master cf71b7292 -> a7a556f95
[docs] migration guide - configuration Project: http://git-wip-us.apache.org/repos/asf/activemq-artemis/repo Commit: http://git-wip-us.apache.org/repos/asf/activemq-artemis/commit/ac7a4519 Tree: http://git-wip-us.apache.org/repos/asf/activemq-artemis/tree/ac7a4519 Diff: http://git-wip-us.apache.org/repos/asf/activemq-artemis/diff/ac7a4519 Branch: refs/heads/master Commit: ac7a4519573430f5b31e22051d32846f9afef08d Parents: cf71b72 Author: Dejan Bosanac <[email protected]> Authored: Fri Feb 17 11:37:08 2017 +0100 Committer: Dejan Bosanac <[email protected]> Committed: Fri Feb 17 11:41:07 2017 +0100 ---------------------------------------------------------------------- docs/migration-guide/en/SUMMARY.md | 2 +- docs/migration-guide/en/configuration.md | 58 +++++++++++++++++++++++++++ 2 files changed, 59 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/ac7a4519/docs/migration-guide/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/migration-guide/en/SUMMARY.md b/docs/migration-guide/en/SUMMARY.md index 6e89af3..388a242 100644 --- a/docs/migration-guide/en/SUMMARY.md +++ b/docs/migration-guide/en/SUMMARY.md @@ -1,4 +1,4 @@ # Summary +* [Configuration](configuration.md) * [Legal Notice](notice.md) - http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/ac7a4519/docs/migration-guide/en/configuration.md ---------------------------------------------------------------------- diff --git a/docs/migration-guide/en/configuration.md b/docs/migration-guide/en/configuration.md new file mode 100644 index 0000000..7c53539 --- /dev/null +++ b/docs/migration-guide/en/configuration.md @@ -0,0 +1,58 @@ +Configuration +===================================== + +Once we download and install the broker we run into the first difference. With Artemis, you need to explicitly create a broker instance, while on ActiveMQ this step is optional. The whole idea of this step is to keep installation and configuration of the broker separate, which makes it easier to upgrade and maintain the broker in the future. + +So in order to start with Artemis you need execute something like this + + $ bin/artemis create --user admin --password admin --role admins --allow-anonymous true /opt/artemis + +No matter where you installed your broker binaries, the broker instance will be now in `/opt/artemis` directory. The content of this directory will be familiar to every ActiveMQ user: + + - `bin` - contains shell scripts for managing the broker(start, stop, etc.) + - `data` - is where the broker state lives (message store) + - `etc` - contains broker configuration file (it's what `conf` directory is in ActiveMQ) + - `log` - Artemis stores logs in this separate directory, unlike ActiveMQ which keeps them in `data` directory + - `tmp` - is utility directory for temporary files + + +Let's take a look now at the configuration in more details. The entry `etc/bootstrap.xml` file is here to set the basics, like the location of the main broker configuration file, utility apps like a web server and JAAS security. + +The main configuration file is `etc/broker.xml`. Similarly to ActiveMQ's `conf/activemq.xml`, this is where you configure most of the aspects of the broker, like connector ports, destination names, security policies, etc. We will go through this file in details in the following articles. + +The `etc/artemis.profile` file is similar to the `bin/env` file in ActiveMQ. Here you can configure environment variables for the broker, mostly regular JVM args related to SSL context, debugging, etc. + +There's no much difference in logging configuration between two brokers, so anyone familiar with Java logging systems in general will find herself at home here. The `etc/logging.properties` file is where it's all configured. + +Finally, we have JAAS configuration files (`login.config`, `artemis-users.properties` and `artemis-roles.properties`), which cover same roles as in ActiveMQ and we will go into more details on these in the article that covers security. + +After this brief walk through the location of different configuration aspects of Artemis, we're ready to start the broker. If you wish to start the broker in the foreground, you should execute + + $ bin/artemis run + +This is the same as + + $ bin/activemq console + +command in ActiveMQ. + +For running the broker as a service, Artemis provides a separate shell script `bin/artemis-service`. So you can run the broker in the background like + + $ bin/artemis-service start + +This is the same as running ActiveMQ with + + $ bin/activemq start + +After the start, you can check the broker status in `logs/artemis.log` file. + +Congratulations, you have your Artemis broker up and running. By default, Artemis starts *Openwire* connector on the same port as ActiveMQ, so clients can connect. To test this you can go to your existing ActiveMQ instance and run the following commands. + + $ bin/activemq producer + $ bin/activemq consumer + +You should see the messages flowing through the broker. Finally, we can stop the broker with + + $ bin/artemis-service stop + +With this, our orienteering session around Artemis is finished. In the following articles we'll start digging deeper into the configuration details and differences between two brokers and see how that can affect your messaging applications. \ No newline at end of file
