From 3ba71456ec65fe69e351ec6ced57b69dd8f1d48e Mon Sep 17 00:00:00 2001 From: Alex Rudyy Date: Thu, 9 May 2013 15:04:59 +0000 Subject: QPID-4685: Update documentation to reflect changes to configuration git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1480672 13f79535-47bb-0310-9956-ffa450edef68 --- ...roker-Configuring-And-Managing-Config-Files.xml | 286 ++++++++++----------- 1 file changed, 142 insertions(+), 144 deletions(-) (limited to 'qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Config-Files.xml') diff --git a/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Config-Files.xml b/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Config-Files.xml index 66d471fb37..a184fea671 100644 --- a/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Config-Files.xml +++ b/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Config-Files.xml @@ -21,158 +21,156 @@ -->
-Config Files +Broker Configuration - - This section shows how to configure and manage broker. - + This section provides the details about broker configuration store. -
- Configuration file - Broker can be configured using XML configuration files. By default, broker is looking for configuration file at ${QPID_HOME}/etc/config.xml. The default configuration location can be overridden by specifying command line option -c <path to configuration> on broker start up. -
- -
- Management Configuration - - Management interfaces can be configured in management section of broker configuration file. The example of the management section is provided below. +
+ Configuration store + The Broker has a configuration store and provides management interfaces to manage the broker components. + The configuration for each broker component is stored in the store as a configuration entry. + The following configuration entries can be stored there: + + Broker + Port + Authentication Provider + Virtual Host + Access Control Provider + Group Provider + Key store + Trust store + Plugin + - - Management configuration - - ... - - true - - 8999 - - - false - ${conf}/qpid.keystore - password - - - true - - - false - - - ... - ]]> - -
-
- JMX Management Configuration + When broker is started for a first time a configuration store is created automatically from + the internal initial configuration. The created broker configuration is placed into broker working folder + if the broker configuration store location is not specified. + The predefined initial configuration can be overridden using command line argument -icp + with path to the initial configuration as in the example below: + +$ ./qpid-server -icp ./my-initial-configuration.json + + In this example the initial configuration from file "./my-initial-configuration.json" is used + to create the broker configuration store on the broker startup. + If broker configuration store already exists the command line argument -icp with the path + to a custom initial configuration is ignored. The command line argument -os can be used + to force the (re)creation of broker configuration store from initial store even when broker configuration store exists. + The example below demonstrates this: + +$ ./qpid-server -os -icp ./my-initial-configuration.json + - JMX management can be configured in management section of broker configuration file. - - An enabled element in the management section is used to enable or disable the JMX interfaces. Setting it to true causes the broker to start the management plugin if such is available on the broker classpath. - JMX management requires two ports which can be configured in jmxport sub-section of management: + The default initial configuration can be retrieved from the broker and stored into a file + using a command line argument -cic <path to file >, for example: + +$ ./qpid-server -cic ./initial-config.json + + In the example above the broker default initial configuration saved at "./initial-config.json". + A custom initial configuration can be created from the default one by using this command line argument. + The default initial configuration declares four ports: - RMI port (8999 by default) can be configured in an element jmxport/registryServer - Connector port can be configured in an element jmxport/connectorServer. If configuration element connectorServer is not provided than the connector port defaults to 100 + registryServer port. + AMQP, the default port number is 5672. The port number + can be overridden using configuration parameter qpid.amqp_port. + HTTP, the default port number is 8080. The port number + can be overridden using configuration parameter qpid.HTTP_port. + RMI, the default port number is 8999. The port number + can be overridden using configuration parameter qpid.rmi_port. + JMX, the default port number is 9099. The port number + can be overridden using configuration parameter qpid.jmx_port. + It is also possible to override the port numbers in a default initial configuration using a command line + argument -prop like in an example below: - - Enabling JMX Management and configuring JMX ports - -<broker> -... -<management> - <enabled>true</enabled> - <jmxport> - <registryServer>7999</registryServer> - <connectorServer>7998</connectorServer> - </jmxport> -</management> -... -</broker> - - In the snippet above the following is configured: - - Enable JMX management - Set RMI port to 7999 - Set connector port to 7998 - - SSL can be configured to use on the connector port in the sub-section ssl of the management section. See for details. - In order to use SSL with JMX management an element ssl/enabled needs to be set to true. -
-
- Management SSL key store configuration - - This section describes how to configure the key store to use in SSL connections in both JMX and Web management interfaces. + +$ ./qpid-server -prop qpid.amqp_port=10000 -prop qpid.http_port=10001 -prop qpid.jmx_port=10002 -prop qpid.rmi_port=10003 + + In the example above, port number 10000 is specified for AMQP port, port number 10001 is specified for HTTP port, + port number 10002 is specified for JMX port and port number 1003 is specified for RMI port. When specified, + these port numbers will be used to create the broker configuration store from initial configuration on first broker start-up. + If configuration store already exists the settings will not have any effect. The command line argument -os + can be used to force (re)creation of broker configuration store from initial store. - The following examples demonstrates how to configure keystore for management - - Management key store configuration - -<broker> -... -<management> -... - <ssl> - <enabled>true</enabled> - <keyStorePath>${conf}/qpid.keystore</keyStorePath> - <keyStorePassword>password</keyStorePassword> - </ssl> -... -</management> -... -</broker> - - - Enable SSL on JMX connector port only. This setting does not effect the web management interfaces. - Set path to the key store file - Set keystore password - + The command line argument -sp is used to specify a relative or absolute path to a broker + configuration store to start broker with. If the store at specified location does not exist it will be created from + the initial configuration. It is not required to provide the path to configuration store on broker on start-up. + +$ ./qpid-server -sp ./my-broker-configuration.json + + In the example above the broker is started with configuration store at "./my-broker-configuration.json".
-
- Web Management Configuration - - Web management can be configured in management section of broker configuration file. - - Sub-section http is used to enable web management on http port. - Sub-section https is used to enable web management on https port. - The following example shows how to configure http and https ports + +
+ Example of JSON configuration store + The JSON configuration store is used as a default configuration store. + An example of the JSON store is provided below: - Enabling web management - -<broker> -... -<management> -... - <http> - <enabled>true</enabled> - <port>9090</port> - <basic-auth>false</basic-auth> - <sasl-auth>true</sasl-auth> - <session-timeout>600</session-timeout> - </http> + JSON configuration store + + In the configuration above the following entries are stored: + + Authentication Provider of type PlainPasswordFile with name "passwordFile" + Four Port entries: "AMQP", "HTTP", "RMI_REGISTRY", "JMX_CONNECTOR" + Virtual Host with name "default" and DERBY message store type at location "${qpid.work_dir}/derbystore/default". + Two management plugins: "jmxManagement" of type "MANAGEMENT-JMX" and "httpManagement" of type "MANAGEMENT-HTTP". + Broker attributes are stored as a root entry. + + + +
- <https> - <enabled>true</enabled> - <port>9443</port> - <sasl-auth>true</sasl-auth> - <basic-auth>true</basic-auth> - </https> -... -</management> -... -</broker> - - - Enable web management on http port. Default is true. - Set web management http port to 9090. Default is 8080. - Disable basic authentication on http port for REST services only. Default is false. - Enable SASL authentication on http port for REST services and web console. Default is true. - Set session timeout in seconds. Default is 15 minutes. - Enable web management on https port. Default is false. - Set web management https port to 9443. Default is 8443. - Enable SASL authentication on https port for REST services and web console. Default is true. - Enable basic authentication on https port for REST services only. Default is true. - - Please configure the keystore to use with the https web management port. See for details. -
-
+
+ Configuring Broker Attributes + + The Broker Attributes can be configured using + REST Management interfaces + and Web Management Console. + + The Broker attributes can be changed from Web Management Console by clicking on "Edit" button + on "Broker Attributes" panel from Broker tab. + + +
+ +
\ No newline at end of file -- cgit v1.2.1