Author: ruwan Date: Mon Jul 6 15:08:45 2009 New Revision: 40889 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=40889
Log: administrator guide formattings Modified: branches/esb/java/2.1/product/docs/xdoc/admin_guide.xml Modified: branches/esb/java/2.1/product/docs/xdoc/admin_guide.xml URL: http://wso2.org/svn/browse/wso2/branches/esb/java/2.1/product/docs/xdoc/admin_guide.xml?rev=40889&r1=40888&r2=40889&view=diff ============================================================================== --- branches/esb/java/2.1/product/docs/xdoc/admin_guide.xml (original) +++ branches/esb/java/2.1/product/docs/xdoc/admin_guide.xml Mon Jul 6 15:08:45 2009 @@ -6,36 +6,48 @@ <body> -<h2> +<h1> WSO2 ESB - System Administration Guide -</h2> -<h4> +</h1> +<p>This is a manual on how to administrate and configure the WSO2 ESB through the management + console. Descriptions on advanced configurations like Remote/Embedded Registry + configuration, adding external libraries, Key store & User management. Briefly + describes the performance tunning the ESB as well.</p> +<h2> Contents -</h4> +</h2> <p> -1.0 Introduction<br/> -2.0 Document Conventions<br/> -3.0 Getting WSO2 ESB<br/> -4.0 Installing and Running WSO2 ESB<br/> -4.1 Running the ESB in Standalone Mode<br/> -4.2 Running ESB Samples<br/> -5.0 WSO2 ESB Directory Hierarchy<br/> -6.0 Using the WSO2 ESB Management Console<br/> -7.0 User Management<br/> -8.0 Setting Up Logging<br/> -9.0 Configuring the Underlying Axis2 Engine<br/> -10.0 Adding External Dependencies to the System<br/> -11.0 Registry Integration<br/> -11.1 Using the Embedded Registry<br/> -11.2 Using a Remote Registry<br/> -12.0 Setting Up Key Stores<br/> -13.0 Setting Up Host Names and Ports<br/> -14.0 Performance Tuning WSO2 ESB<br/> -</p> - -<h4> - 1.0 Introduction -</h4> + <ul> + <li><a href="#Intro">Introduction</a></li> + <li><a href="#DocConv">Document Conventions</a></li> + <li><a href="#GettingESB">Getting WSO2 ESB</a></li> + <li><a href="#InstallESB">Installing and Running WSO2 ESB</a> + <ul> + <li><a href="#Standalone">Running the ESB in Standalone Mode</a></li> + <li><a href="#ESBSamples">Running ESB Samples</a></li> + </ul> + </li> + <li><a href="#DirHierarchy">WSO2 ESB Directory Hierarchy</a></li> + <li><a href="#ESBMan">Using the WSO2 ESB Management Console</a></li> + <li><a href="#UserMan">User Management</a></li> + <li><a href="#SettingLogging">Setting Up Logging</a></li> + <li><a href="#ConfigureAxis2">Configuring the Underlying Axis2 Engine</a></li> + <li><a href="#ExternalDeps">Adding External Dependencies to the System</a></li> + <li><a href="#RegInt">Registry Integration</a> + <ul> + <li><a href="#EmbeddedReg">Using the Embedded Registry</a></li> + <li><a href="#RemoteReg">Using a Remote Registry</a></li> + </ul> + </li> + <li><a href="#KeyStore">Setting Up Key Stores</a></li> + <li><a href="#HostPort">Setting Up Host Names and Ports</a></li> + <li><a href="#PerfTune">Performance Tuning WSO2 ESB</a></li> + </ul> +</p> + +<h2 id="Intro"> + Introduction +</h2> <p> WSO2 ESB is a production grade open source ESB solution based on the lightweight Apache Synapse ESB. WSO2 ESB supports service mediation, message mediation, load balancing, clustering and many more enterprise integration techniques out of the box. It also supports a range @@ -52,18 +64,14 @@ and configure various features of the WSO2 ESB and how to performance tune various aspects of the product. </p> -<h4> - 2.0 Document Conventions -</h4> +<h2 id="DocConv">Document Conventions</h2> <ul> <li>The phrase 'ESB_HOME' refers to the directory in the file system where WSO2 ESB is installed</li> <li>The phrase 'ESB_SRC_HOME' refers to the directory in the file system where WSO2 ESB source distribution is installed</li> <li>All file paths follow Unix/Linux conventions but they resemble Windows file paths as well</li> </ul> -<h4> - 3.0 Getting WSO2 ESB -</h4> +<h2 id="GettingESB">Getting WSO2 ESB</h2> <p> Binary distributions and source distributions of WSO2 ESB can be downloaded free from the <a href="http://wso2.org/projects/esb";> WSO2 ESB project</a> home page in the <a href="http://wso2.org";>WSO2 Oxygen Tank</a>. Before proceeding to the downloads page you @@ -87,9 +95,7 @@ distribution archive in ESB_SRC_HOME/modules/distribution/target directory. </p> -<h4> - 4.0 Installing and Running WSO2 ESB -</h4> +<h2 id="InstallESB">Installing and Running WSO2 ESB</h2> <p> To install the WSO2 ESB simply extract the downloaded binary distribution archive. If you built WSO2 ESB from source extract the archive created by the builder. We recommend installing WSO2 ESB on a Unix/Linux system since that will enable you to get the maximum @@ -97,9 +103,7 @@ the JAVA_HOME environment variable to point to the directory in which Java is installed. </p> -<h5> - 4.1 Running WSO2 ESB in Standalone Mode -</h5> +<h3 id="Standalone">Running WSO2 ESB in Standalone Mode</h3> <p> Now you are all set to start WSO2 ESB in the standalone mode. Go to ESB_HOME/bin directory and if you are on Unix/Linux execute the wso2server.sh shell script or if you are on Windows execute the wso2server.bat batch file. This will start the ESB and you can @@ -196,9 +200,7 @@ <pre> </pre>Generally ESB will load the configuration from the Registry. Using this argument we can force the ESB to load the configuration from ESB_HOME/conf/synapse.xml file. </p> -<h4> - 4.2 Running ESB Samples -</h4> +<h3 id="ESBSamples">Running ESB Samples</h3> <p> WSO2 ESB ships with a large number of sample configurations which enables you to get familiar with the product quickly and easily. Please refer the WSO2 ESB samples guide for sample configuration and details on how to run them. You may start WSO2 ESB using those @@ -217,9 +219,7 @@ wso2server.sh and wso2server.bat. </p> -<h4> - 5.0 WSO2 ESB Directory Hierarchy -</h4> +<h2 id="DirHierarchy">WSO2 ESB Directory Hierarchy</h2> <p> When you extract a WSO2 ESB binary distribution archive you will find the following directories in the top level that is created. </p> @@ -304,9 +304,7 @@ Contains a collection of database scripts required to create the Carbon database on a variety of database management systems.<br/> </p> -<h4> - 6.0 Using the WSO2 ESB Management Console -</h4> +<h2 id="ESBMan">Using the WSO2 ESB Management Console</h2> <p> WSO2 ESB management console is a Web based constrol panel powered by JSP and AJAX which enables system administrators to interact with a running ESB instance, without having to touch any underlying configuration files. The management console allows the users @@ -333,9 +331,7 @@ might be inaccessible to the users. </p> -<h4> - 7.0 User Management -</h4> +<h2 id="UserMan">User Management</h2> <p> To access the WSO2 ESB user management features, first sign in to the ESB management console and click on 'User Management' under the 'Configure' menu in the left navigation bar. This will take you to the User Management home page which contains the controls illustrated @@ -413,9 +409,7 @@ in the built-in system user store. </p> -<h4> - 8.0 Setting Up Logging -</h4> +<h2 id="SettingLogging">Setting Up Logging</h2> <p> Logging is one of the most important aspects of a production grade server. A properly configured logging system is vital in identifying errors, security threats and usage patterns. WSO2 ESB uses a log4j based logging mechanism through Apache Commons Logging facade library. @@ -462,9 +456,7 @@ </p> <img src="images/logs.png"/> -<h4> - 9.0 Configuring the Underlying Axis2 Engine -</h4> +<h2 id="ConfigureAxis2">Configuring the Underlying Axis2 Engine</h2> <p> WSO2 ESB is based on Apache Synapse lightweight ESB which in turns uses the Apache Axis2 SOAP engine. Every WSO2 ESB administrator is expected to have at least a basic understanding of Axis2 and Axis2 configuration model. The global configuration of the Axis2 engine @@ -503,9 +495,7 @@ for common deployment scenarios. </p> -<h4> - 10.0 Adding External Dependencies to the System -</h4> +<h2 id="ExternalDeps">Adding External Dependencies to the System</h2> <p> You would want to deploy external dependency jars into the WSO2 ESB server in many scenarios. Generally one would want to add external dependencies in following situations. @@ -533,9 +523,7 @@ to the relevant locations the server must be restarted for the server to be able to pick them up. </p> -<h4> - 11.0 Registry Integration -</h4> +<h2 id="RegInt">Registry Integration</h2> <p> WSO2 ESB makes use of a WSO2 Governance Registry instance to store various configurations and artifacts such as proxy services, sequences and endpoints. Simply put a registry is a content store and a metadata repository. Various SOA artifacts such as services, @@ -562,9 +550,7 @@ first login to the ESB management console and click on 'Registry Browser' link on the 'Registry' menu in the left navigation bar. </p> -<h5> - 11. 1 Using the Embedded Registry -</h5> +<h3 id="EmbeddedReg">Using the Embedded Registry</h3> <p> WSO2 ESB comes with an embedded WSO2 Governance Registry (WSO2 G-Reg) which is used by the ESB to store configurations and other deployment artifacts. This is configured in the ESB_HOME/conf/carbon.xml as follows. @@ -624,9 +610,7 @@ Please refer WSO2 G-Reg documentation for further information on setting up media type handlers and other global parameters. </p> -<h5> - 11.2 Using the Remote Registry -</h5> +<h3 id="RemoteReg">Using the Remote Registry</h3> <p> You can get the WSO2 ESB to run against a remotely hosted WSO2 G-Reg instance easily. This is very important and useful in production deployment scenarios. Using this technique one can run several WSO2 ESB instances against the same registry thus effectively sharing @@ -651,9 +635,7 @@ </Registry> </pre> -<h4> - 12.0 Setting Up Keystores -</h4> +<h2 id="KeyStore">Setting Up Keystores</h2> <p> WSO2 ESB uses several keystores to power the HTTPS transport and encrypt other confidential information such as administrator passwords. The keystore of the HTTPS transport is configured in the ESB_HOME/conf/axis2.xml file under the HTTPS transport receiver @@ -700,9 +682,7 @@ </KeyStore> </pre> -<h4> - 13.0 Setting Up Host Names and Ports -</h4> +<h2 id="HostPort">Setting Up Host Names and Ports</h2> <p> The bind address values and HTTP/HTTPS ports used by the ESB server should be configured in the ESB_HOME/conf/axis2.xml file. To configure the bind address for the server, define the following parameter under the HTTP and HTTPS transport receiver configurations @@ -769,9 +749,7 @@ transport for various deployments. </p> -<h4> - 14.0 Performance Tuning WSO2 ESB -</h4> +<h2 id="PerfTune">Performance Tuning WSO2 ESB</h2> <p> We recommend that you install WSO2 ESB on Unix/Linux systems for production deployments. This section, for the most part, assumes that you have setup the ESB on a server running Unix/Linux. Also keep in mind that you should not take performance tuning steps described _______________________________________________ Esb-java-dev mailing list [email protected] https://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev
