incubator-kalumet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jbono...@apache.org
Subject svn commit: r1354643 - in /incubator/kalumet/trunk/documentation/src/site: ./ apt/userguide/ apt/userguide/environment/ resources/images/
Date Wed, 27 Jun 2012 17:43:03 GMT
Author: jbonofre
Date: Wed Jun 27 17:43:02 2012
New Revision: 1354643

URL: http://svn.apache.org/viewvc?rev=1354643&view=rev
Log:
Add environment general section in the documentation

Added:
    incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/
    incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/general.apt
    incubator/kalumet/trunk/documentation/src/site/apt/userguide/information.apt
    incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_freefields.png
    incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_info.png
    incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_logs.png
    incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_variables.png
Modified:
    incubator/kalumet/trunk/documentation/src/site/site.xml

Added: incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/general.apt
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/general.apt?rev=1354643&view=auto
==============================================================================
--- incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/general.apt (added)
+++ incubator/kalumet/trunk/documentation/src/site/apt/userguide/environment/general.apt Wed
Jun 27 17:43:02 2012
@@ -0,0 +1,79 @@
+ -----
+ Kalumet Console Environment General
+ -----
+ -----
+ -----
+
+Apache Kalumet Console Environment General
+
+  To add a new environment, you can click on "Add Environment" button in the top menu.
+
+  You can also edit an existing environment by clicking directly on the environment name
in the left panel.
+
+  Both actions open an environment window.
+
+Information
+
+[/images/env_general_info.png]
+	
+  The general tab allows you to provide basic information for the environment:
+
+  * the environment "name" is mandatory and is an unique identification
+
+  * the "group" is optional. It's used to sort and group environments in the left panel.
You can use it to group the environment by type (testing, development, etc), by customers,
or whatever
+
+  * the "tag" allows you to type an environment, depending of its role and criticity (production,
staging, testing, etc). It's not really used internally to Kalumet, it's informative for you
+
+  * the "agent" defines the "master" agent which manages the environment. As you will see
later, you will be able to define agent locally to a resource (for a software or an application
server for instance). When not define, Kalumet will use this agent by default.
+
+  * the "automatically updated" flag defines if the agent scheduler will automatically the
environment when fired, or not
+
+  * the "notes" are informative for you and others users. You can leave some information
about the environment for the other users. The notes are used by Kalumet when you generate
a "HTML page" about the environment (see "Dashboard section"). HTML code is supported here.
+
+  * the "web notes" are quite the same as "notes" but the purpose is to leave some links
about the environment (home page, documentation, test URL, etc). As for "notes", Kalumet will
use it when you generate a "HTML page" about the environment (see "Dashboard" section). HTML
code is supported here.
+
+Free Fields
+
+[/images/env_general_freefields.png]
+
+  The free fields are custom fields that you can define on an environment. It's not used
internally in Kalumet. The purpose is to be used by "external" tools to get some information
about the environment.
+
+  A free field is composed by a "name" and a "content".
+
+  The number of free fields is not limited. You can create a new one by clicking on the "+"
icon (or paste a copy with the "paste" icon).
+
+  On each free field, you can:
+
+  * copy the free field to create a new one with the same information
+
+  * move the free field up or down if you want to change the order
+
+  * validate a change on the free field "name" or "content"
+
+  * delete a free field
+
+Variables
+
+[/images/env_general_variables.png]
+
+  Instead of copy/paste a lot of information between a lot of resource in the environment,
you can use variables.
+
+  A variable is composed by a "name" and a "value".
+
+  The number of variables is not limited. You can create a new one by clicking on the "+"
icon (or paste a copy with the "paste" icon).
+
+  NB: it's not currently possible to use a variable in the value of another variable.
+
+  On each variable, you can:
+
+  * copy the variable to create a new one with the same information
+
+  * move the variable up or down if you want to change the order
+
+  * validate a change on the variable "name" and "value"
+
+  * delete a variable
+
+  You can use any variable in any fields of Kalumet Console with the $\{VARIABLE\} notation.
+
+  For instance, you can define a variable ENVIRONMENT_HOME with a filesystem location (file:/opt/environment/name)
and use it in any field with $\{ENVIRONMENT_HOME\}, e.g. $\{ENVIRONMENT_HOME\}/logs.

Added: incubator/kalumet/trunk/documentation/src/site/apt/userguide/information.apt
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/apt/userguide/information.apt?rev=1354643&view=auto
==============================================================================
--- incubator/kalumet/trunk/documentation/src/site/apt/userguide/information.apt (added)
+++ incubator/kalumet/trunk/documentation/src/site/apt/userguide/information.apt Wed Jun 27
17:43:02 2012
@@ -0,0 +1,5 @@
+ -----
+ Kalumet Console Environment General Information
+ -----
+ -----
+ -----

Added: incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_freefields.png
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_freefields.png?rev=1354643&view=auto
==============================================================================
Files incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_freefields.png
(added) and incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_freefields.png
Wed Jun 27 17:43:02 2012 differ

Added: incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_info.png
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_info.png?rev=1354643&view=auto
==============================================================================
Files incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_info.png
(added) and incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_info.png
Wed Jun 27 17:43:02 2012 differ

Added: incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_logs.png
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_logs.png?rev=1354643&view=auto
==============================================================================
Files incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_logs.png
(added) and incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_logs.png
Wed Jun 27 17:43:02 2012 differ

Added: incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_variables.png
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_variables.png?rev=1354643&view=auto
==============================================================================
Files incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_variables.png
(added) and incubator/kalumet/trunk/documentation/src/site/resources/images/env_general_variables.png
Wed Jun 27 17:43:02 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=1354643&r1=1354642&r2=1354643&view=diff
==============================================================================
--- incubator/kalumet/trunk/documentation/src/site/site.xml (original)
+++ incubator/kalumet/trunk/documentation/src/site/site.xml Wed Jun 27 17:43:02 2012
@@ -43,12 +43,7 @@
       <item name="Users and Groups" href="/userguide/users_groups.html"/>
       <item name="Statistics" href="/userguide/statistics.html"/>
       <item name="Environment">
-        <item name="General">
-          <item name="Information" href="/userguide/environment/information.html"/>
-          <item name="Free fields" href="/userguide/environment/free_fields.html"/>
-          <item name="Variables" href="/userguide/environment/variables.html"/>
-          <item name="Log Files" href="/userguide/environment/log_files.html"/>
-        </item>
+        <item name="General" href="/userguide/environment/general.html"/>
         <item name="Security Access Lists" href="/userguide/environment/security_acl.html"/>
         <item name="J2EE Application Servers">
           <item name="Topology" href="/userguide/environment/j2ee_topology.html"/>



Mime
View raw message