svn commit: r1360274 - /incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jee_applications.apt

[jb...@apache.org]

Author: jbonofre
Date: Wed Jul 11 16:26:44 2012
New Revision: 1360274

URL: http://svn.apache.org/viewvc?rev=1360274&view=rev
Log:
Continue the JEE application section in the documentation

Modified:
    incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jee_applications.apt

Modified: incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jee_applications.apt
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jee_applications.apt?rev=1360274&r1=1360273&r2=1360274&view=diff
==============================================================================
--- incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jee_applications.apt (original)
+++ incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/jee_applications.apt Wed Jul 11 16:26:44 2012
@@ -50,6 +50,8 @@ Apache Kalumet Console JEE Applications
 
   Clicking on the JEE application name, or on "Add JEE Application" button, you will have a JEE application window.
 
+General
+
 [/images/env_app_general.png]
 
   The "General" tab allows you to define the general information about the JEE application:
@@ -64,6 +66,8 @@ Apache Kalumet Console JEE Applications
 
   * Agent: if empty, the agent used will be the environment one. However, you can delegate the JEE application update to a specific agent.
 
+Archives
+
 [/images/env_app_archives.png]
 
   A JEE application hosts a set of archive. An archive is a jar, an ear, a war, or any kind of archive supported by the application server.
@@ -113,3 +117,47 @@ Apache Kalumet Console JEE Applications
   * Context Root: this property allow you to define the context root of the archive (when the archive is a war or an ear). It's optional, but it allows you to specify one.
 
   * Virtual Host: this property is optional and specific to WebSphere application server. It allows you to specify the target virtual host where to deploy the archive.
+
+Configuration Files
+
+[/images/env_app_configs.png]
+
+  You can also define a set of configuration files (text, XML, properties, or whatever format) for the application.
+
+  On each configuration file, you can:
+
+  * copy a configuration file to be pasted into another configuration file.
+
+  * enable (light on) or disable (light off) the configuration file. If disabled, the configuration file won't be part of the whole update process.
+
+  * set update blocker (green puzzle piece) or not update blocker (grey puzzle piece). If the configuration file is update blocker, it means that if the configuration file update fails, the whole update process will fail and stop. If the configuration file is not update blocker, it means that if the configuration file update fails, the whole update process will log a warning but the update will continue.
+
+  * define the configuration file processing order (using the up and down arrows icons).
+
+  * check the current status of the configuration file (if present and up to date).
+
+  * launch the configuration file update.
+
+  * delete the configuration file.
+
+  Clicking on the configuration file name or "Add Configuration File" icon, you will have a new "Configuration File" window.
+
+[/images/env_app_config_general.png]
+
+  The "General" tab allows you to define general information about the configuration file:
+
+  * Name: it's a configuration file identifier.
+
+  * Active: if "true", the configuration file is active. It means that the configuration file will be part of the whole update process.
+
+  * Update blocker: if "true", the configuration file is an update blocker. It means that if the configuration file update fails, the whole update process will fail and stop.
+
+  * URI: it's the URI where to find the configuration file. This URI could be absolute (for instance http://, file://, etc) or relative to the application URI. It's also possible to use "composed" URI, for instance tgz:http://path/to/app.tar.gz!/path/inside/tgz/to/configuration.properties.
+
+  * Path: it's the path, locally to the agent, where the configuration file will be copied.
+
+  * Agent: by default, the configuration file update will use the application agent. But it's also possible to dedicated the configuration file update to a specific agent.
+
+[/images/env_app_config_mappings.png]
+
+  Using the "Mappings" tab, you can also search and replace text in the configuration file. The "key" will be searched in the configuration file, and it will be replaced by the "value".