incubator-kalumet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jbono...@apache.org
Subject svn commit: r1351256 - in /incubator/kalumet/trunk: ./ console/src/main/resources/org/apache/kalumet/console/app/locales/ documentation/src/site/ documentation/src/site/apt/adminguide/
Date Mon, 18 Jun 2012 09:59:29 GMT
Author: jbonofre
Date: Mon Jun 18 09:59:29 2012
New Revision: 1351256

URL: http://svn.apache.org/viewvc?rev=1351256&view=rev
Log:
Resume documentation and update console README part

Added:
    incubator/kalumet/trunk/documentation/src/site/apt/adminguide/console.apt
Modified:
    incubator/kalumet/trunk/README
    incubator/kalumet/trunk/console/src/main/resources/org/apache/kalumet/console/app/locales/Messages.properties
    incubator/kalumet/trunk/documentation/src/site/apt/adminguide/agent.apt
    incubator/kalumet/trunk/documentation/src/site/apt/adminguide/index.apt
    incubator/kalumet/trunk/documentation/src/site/site.xml

Modified: incubator/kalumet/trunk/README
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/README?rev=1351256&r1=1351255&r2=1351256&view=diff
==============================================================================
--- incubator/kalumet/trunk/README (original)
+++ incubator/kalumet/trunk/README Mon Jun 18 09:59:29 2012
@@ -76,17 +76,10 @@ from now on this directory will be refer
 illegal characters in Java paths, e.g. !, % etc.
 
     Apache Kalumet Console Configuration
-By default, Apache Kalumet console uses the following configuration:
-- it reads/writes the Kalumet configuration file located in /var/lib/apache-kalumet/db/kalumet.xml.
-Create the directory /var/lib/apache-kalumet/db
-  (with the permission given to the application server user) and copy the initial Kalumet
configuration provided in
-  <kalumet_console_home>/conf/sample/apache-kalumet-store.xml.
-- it reads/writes the Kalumet events journal log files in /var/lib/apache-kalumet/journals.
Create this directory
-with the permission given to the application server user.
-
-If this default configuration is not compliant with your environment, you can override this
setup using a
-apache-kalumet-console-config.xml file.
+Apache Kalumet Console creates a default configuration which allows you to directly use the
console.
 
+If needed, you can override the default console configuration (location of the configuration
file and journals) by
+pushing a apache-kalumet-console-config.xml file in the class loader.
 You can find this file in the Apache Kalumet console configuration in
 <kalumet_console_home>/conf/apache-kalumet-console-config.xml.
 You need to copy this file into the JSP/Servlet engine classpath. For example, using Apache
Tomcat, you can
@@ -100,7 +93,8 @@ deploy directory. For example, to deploy
 directory.
 
     Using Apache Kalumet Console
-You should now be able to access to Apache Kalumet console, for example using http://localhost:8080/kalumet/console.
+You should now be able to access to Apache Kalumet console, for example using
+http://localhost:8080/apache-kalumet-console.
 The default admin user password is admin.
 
 

Modified: incubator/kalumet/trunk/console/src/main/resources/org/apache/kalumet/console/app/locales/Messages.properties
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/console/src/main/resources/org/apache/kalumet/console/app/locales/Messages.properties?rev=1351256&r1=1351255&r2=1351256&view=diff
==============================================================================
--- incubator/kalumet/trunk/console/src/main/resources/org/apache/kalumet/console/app/locales/Messages.properties
(original)
+++ incubator/kalumet/trunk/console/src/main/resources/org/apache/kalumet/console/app/locales/Messages.properties
Mon Jun 18 09:59:29 2012
@@ -173,7 +173,7 @@ hours													  Hours
 homepage												  Homepage
 id														  ID
 increment												  Increment
-information												  Informations
+information												  Information
 initial													  Initial
 jboss4												      JBoss 4.x
 jboss6                                                    JBoss 6.x

Modified: incubator/kalumet/trunk/documentation/src/site/apt/adminguide/agent.apt
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/apt/adminguide/agent.apt?rev=1351256&r1=1351255&r2=1351256&view=diff
==============================================================================
--- incubator/kalumet/trunk/documentation/src/site/apt/adminguide/agent.apt (original)
+++ incubator/kalumet/trunk/documentation/src/site/apt/adminguide/agent.apt Mon Jun 18 09:59:29
2012
@@ -44,6 +44,11 @@ Installing Apache Kalumet agent
       Select the file compression format compatible with your system (zip or tar.gz). Download
the archive and expand the binary to your hard driver in a new directory ; for example /opt/apache-kalumet.
       Please remember the restrictions concerning illegal characters in Java paths, e.g.
!, % etc.
 
+    ** Kalumet console
+
+      Even if it's not a requirement, we heavily invite you to firstly install the Kalumet
console. The Kalumet console allows you to easily configure the agents.
+      Take a look on the Kalumet console admin guide to install the console.
+
   * Start Kalumet Agent
 
     Open a command line and go in the Kalumet agent installation directory. To start the
agent, run the following command in Windows:
@@ -53,3 +58,5 @@ Installing Apache Kalumet agent
     respectively in Linux/Unix:
 
     bin/agent -config <path to Kalumet console> -id <agent id>
+
+    The agent ID should have been firstly define in the Kalumet console.

Added: incubator/kalumet/trunk/documentation/src/site/apt/adminguide/console.apt
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/apt/adminguide/console.apt?rev=1351256&view=auto
==============================================================================
--- incubator/kalumet/trunk/documentation/src/site/apt/adminguide/console.apt (added)
+++ incubator/kalumet/trunk/documentation/src/site/apt/adminguide/console.apt Mon Jun 18 09:59:29
2012
@@ -0,0 +1,68 @@
+ -----
+ Installing Apache Kalumet Console
+ -----
+ -----
+ -----
+
+~~ 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.
+
+Installing Apache Kalumet console
+
+  The Kalumet console manages the configuration and interacts with the Kalumet agents.
+
+  It allows you to easily manage all environments, all agents, all update plans with a central,
web based
+  tool.
+
+  * Prerequisites
+
+    ** JSP/Servlet Engine
+
+      Apache Kalumet console has to be deployed into a JSP/Servlet Engine (like Apache Tomcat
or Jetty) or a J2EE application
+      server (like RedHat JBoss, Oracle Weblogic, IBM WebSphere).
+
+    ** Download binaries
+
+      Select the file compression format compatible with your system (zip, tar.gz) by clicking
directly on the link,
+      download it and expand the binary to your hard drive in a new directory ; for example
/tmp/kalumet_console -
+      from now on this directory will be referenced as <kalumet_console_home>. Please
remember the restrictions concerning
+      illegal characters in Java paths, e.g. !, % etc.
+
+  * Apache Kalumet Console Configuration (optional)
+
+    Apache Kalumet Console creates a default configuration which allows you to directly use
the console.
+
+    If needed, you can override the default console configuration (location of the configuration
file and journals) by
+    pushing a apache-kalumet-console-config.xml file in the class loader.
+    You can find this file in the Apache Kalumet console configuration in
+    <kalumet_console_home>/conf/apache-kalumet-console-config.xml.
+    You need to copy this file into the JSP/Servlet engine classpath. For example, using
Apache Tomcat, you can
+    copy the apache-kalumet-console-config.xml into the <tomcat_home>/lib directory.
+
+    Configure the apache-kalumet-console-config.xml to match your environment settings.
+
+  * Deploy Apache Kalumet Console
+
+    Copy <kalumet_console_home>/webapp/apache-kalumet-console.war into the JSP/Servlet
Engine or J2EE application server
+    deploy directory. For example, to deploy on Apache Tomcat, simply copy the war archive
into the <tomcat_home>/webapps
+    directory.
+
+  * Using Apache Kalumet Console
+
+    You should now be able to access to Apache Kalumet console, for example using
+    http://localhost:8080/apache-kalumet-console.
+    The default admin user password is admin.

Modified: incubator/kalumet/trunk/documentation/src/site/apt/adminguide/index.apt
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/apt/adminguide/index.apt?rev=1351256&r1=1351255&r2=1351256&view=diff
==============================================================================
--- incubator/kalumet/trunk/documentation/src/site/apt/adminguide/index.apt (original)
+++ incubator/kalumet/trunk/documentation/src/site/apt/adminguide/index.apt Mon Jun 18 09:59:29
2012
@@ -29,7 +29,7 @@ System Administrators Guide to Apache Ka
   The following sections describe the process for configuring
   Kalumet for use:
 
-    * {{{./console.hmtl} Installing Apache Kalumet console}}
+    * {{{./console.html} Installing Apache Kalumet console}}
 
     * {{{./agent.html} Installing Apache Kalumet agent}}
 

Modified: incubator/kalumet/trunk/documentation/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/kalumet/trunk/documentation/src/site/site.xml?rev=1351256&r1=1351255&r2=1351256&view=diff
==============================================================================
--- incubator/kalumet/trunk/documentation/src/site/site.xml (original)
+++ incubator/kalumet/trunk/documentation/src/site/site.xml Mon Jun 18 09:59:29 2012
@@ -33,9 +33,24 @@
       <item name="Installation">
         <item name="Agent installation" href="/adminguide/agent.html"/>
         <item name="Console installation" href="/adminguide/console.html"/>
-        <item name="Upgrade to a New Version" href="/adminguide/upgrade.html"/>
       </item>
     </menu>
+
+    <menu name="User Guide">
+      <item name="Console layout" href="/userguide/console_layout.html"/>
+      <item name="Core configuration" href="/userguide/core_configuration.html"/>
+      <item name="Agents" href="/userguide/agents.html"/>
+      <item name="Users and Groups" href="/userguide/users_groups.html"/>
+      <item name="Statistics" href="/userguide/statistics.html"/>
+      <menu name="Environment">
+        <menu 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"/>
+        </menu>
+      </menu>
+    </menu>
   </body>
 
 </project>
\ No newline at end of file



Mime
View raw message