You are viewing a plain text version of this content. The canonical link for it is here.
Posted to kalumet-commits@incubator.apache.org by jb...@apache.org on 2012/07/03 14:33:19 UTC
svn commit: r1356756 - in /incubator/kalumet/trunk/documentation/src/site:
./ apt/userguide/environment/ resources/images/
Author: jbonofre
Date: Tue Jul 3 14:33:17 2012
New Revision: 1356756
URL: http://svn.apache.org/viewvc?rev=1356756&view=rev
Log:
Add the JDBC Connection Pool section in the documentation
Added:
incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jdbc_connection_pools.apt
incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_capacity.png
incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_database.png
incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_driver.png
incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_general.png
incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pools.png
Modified:
incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jee_application_server.apt
incubator/kalumet/trunk/documentation/src/site/site.xml
Added: incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jdbc_connection_pools.apt
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jdbc_connection_pools.apt?rev=1356756&view=auto
==============================================================================
--- incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jdbc_connection_pools.apt (added)
+++ incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jdbc_connection_pools.apt Tue Jul 3 14:33:17 2012
@@ -0,0 +1,95 @@
+ -----
+ Kalumet Console Environment JDBC Connection Pools
+ -----
+ -----
+ -----
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Apache Kalumet Console Environment JDBC Connection Pools
+
+ In the environment JEE resources tab, you have a "JDBC Connection Pools" tab.
+
+ This tab allows you to configure the JDBC connection pools that will be deployed into the JEE application server given in the "scope" checkbox.
+
+[/images/env_jdbc_connection_pools.png]
+
+ On each JDBC connection pools, you can:
+
+ * copy the JDBC connection pool to be pasted into another connection pool
+
+ * enable (light on) or disable (light off) the JDBC connection pool. If disabled, the JDBC connection pool won't be part of the update process.
+
+ * set update blocker (green puzzle piece) or not update blocker (grey puzzle piece)
+
+ * check the current status of the JDBC connection pool
+
+ * launch the JDBC connection pool update
+
+ * delete the JDBC connection pool
+
+ To add a new JDBC connection pool, you have to choose the scope and click on "Add JDBC Connection Pool". In the same way, you can edit a JDBC connection pool by clicking on the connection pool name.
+
+ The scope is the target JEE application server.
+
+ You will have a new "JDBC Connection Pool" window.
+
+[/images/env_connection_pool_general.png]
+
+ The "General" tab defines general information about the JDBC connection pool:
+
+ * Name: it's the name of the JDBC connection pool.
+
+ * Active: this flag defines if the JDBC connection pool is part of an update or not.
+
+ * Update blocker: if true, if the update of this JDBC connection pool fails, the whole update process will failed and stopped, else, the whole update process will just log a warning and the process will continue.
+
+[/images/env_connection_pool_driver.png]
+
+ The "Driver" tab allows you to define the JDBC driver information for the connection pool:
+
+ * JDBC driver: it's the JDBC driver used by this connection pool.
+
+ * JDBC helper classname: this configuration is specific to WebSphere application server. If you are not using WebSphere application server, you can let this box empty. Else choose the helper classname corresponding to your database.
+
+ * Classpath: it's a path containing the JDBC driver, for instance /usr/lib/jdbc/ojdbc.jar.
+
+[/images/env_connection_pool_database.png]
+
+ The "Database" tab allows you to define the database connection information:
+
+ * JDBC URL: it's the JDBC URL to connect to the database, for instance jdbc:oracle:thin:@hostname:1521:database for an Oracle database.
+
+ * User: the user name used to connect to the database.
+
+ * Password: the password used to connect to the database.
+
+ * Confirm password: repeat the previous password to confirm.
+
+[/images/env_connection_pool_capacity.png]
+
+ The "Capacity" tab allows you to define the capacity of the JDBC connection pool:
+
+ * Initial: it's the number of connection pre-establish when creating the connection pool.
+
+ * Maximal: it's the maximum number of connection that the pool will contain.
+
+ * Increment: it's the number of connection to pre-establish when increasing the pool capacity.
Modified: incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jee_application_server.apt
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jee_application_server.apt?rev=1356756&r1=1356755&r2=1356756&view=diff
==============================================================================
--- incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jee_application_server.apt (original)
+++ incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jee_application_server.apt Tue Jul 3 14:33:17 2012
@@ -32,9 +32,9 @@ Apache Kalumet Console Environment JEE A
On each JEE application server, you can:
- * copy the JEE application server to paste into another application server
+ * copy the JEE application server to be pasted into another application server
- * enable (light on) or disable (light off) the JEE application server
+ * enable (light on) or disable (light off) the JEE application server. If disabled, the JEE application server won't be part of the update process.
* set update blocker (green puzzle piece) or not update blocker (grey puzzle piece)
@@ -48,9 +48,9 @@ Apache Kalumet Console Environment JEE A
* delete the JEE application server
- To add a new JEE application server, you have to choose the topology and click on "Add JEE Application Server".
+ To add a new JEE application server, you have to choose the topology and click on "Add JEE Application Server". In the same way, you can edit a JEE application server by clicking on the application server name.
- It will use the topology that you defined in the top combobox:
+ If you create a new JEE application server, it will use the topology that you defined in the top combobox:
* standalone: it's a standalone application server, not part of a cluster.
@@ -64,7 +64,7 @@ Apache Kalumet Console Environment JEE A
* Name: it's the name of the JEE application server. NB: for some application servers like IBM WebSphere, the name should match the internal application server name (like server1 for instance).
- * Active: this flag defines if the JEE application server is part of a update or not.
+ * Active: this flag defines if the JEE application server is part of an update or not.
* Update blocker: if true, if the update of this JEE application server fails, the whole update process will failed and stopped, else, the whole update process will just log a warning and the process will continue.
Added: incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_capacity.png
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_capacity.png?rev=1356756&view=auto
==============================================================================
Files incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_capacity.png (added) and incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_capacity.png Tue Jul 3 14:33:17 2012 differ
Added: incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_database.png
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_database.png?rev=1356756&view=auto
==============================================================================
Files incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_database.png (added) and incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_database.png Tue Jul 3 14:33:17 2012 differ
Added: incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_driver.png
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_driver.png?rev=1356756&view=auto
==============================================================================
Files incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_driver.png (added) and incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_driver.png Tue Jul 3 14:33:17 2012 differ
Added: incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_general.png
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_general.png?rev=1356756&view=auto
==============================================================================
Files incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_general.png (added) and incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pool_general.png Tue Jul 3 14:33:17 2012 differ
Added: incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pools.png
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pools.png?rev=1356756&view=auto
==============================================================================
Files incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pools.png (added) and incubator/kalumet/trunk/documentation/src/site/resources/images/env_connection_pools.png Tue Jul 3 14:33:17 2012 differ
Modified: incubator/kalumet/trunk/documentation/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/site.xml?rev=1356756&r1=1356755&r2=1356756&view=diff
==============================================================================
--- incubator/kalumet/trunk/documentation/src/site/site.xml (original)
+++ incubator/kalumet/trunk/documentation/src/site/site.xml Tue Jul 3 14:33:17 2012
@@ -64,8 +64,8 @@
<item name="Security Access Lists" href="/userguide/environment/security.html"/>
<item name="J2EE Application Servers" href="/userguide/environment/jee_application_server.html"/>
<item name="J2EE Resources">
- <item name="JDBC Connection Pools" href="/userguide/environment/j2ee_connection_pools.html"/>
- <item name="JDBC Data Sources" href="/userguide/environment/j2ee_data_sources.html"/>
+ <item name="JDBC Connection Pools" href="/userguide/environment/jdbc_connection_pools.html"/>
+ <item name="JDBC Data Sources" href="/userguide/environment/jdbc_data_sources.html"/>
<item name="JMS Connection Factories" href="/userguide/environment/jms_connection_factories.html"/>
<item name="JMS Servers" href="/userguide/environment/jms_servers.html"/>
<item name="JNDI NameSpace Bindings" href="/userguide/environment/jndi_bindings.html"/>