Author: rjung
Date: Wed Mar 26 08:29:25 2008
New Revision: 641350
URL: http://svn.apache.org/viewvc?rev=641350&view=rev
Log:
Add the usual standard files for license, release notes,
running etc.
Added:
tomcat/sandbox/tomcat-oacc/trunk/BUILDING.txt (with props)
tomcat/sandbox/tomcat-oacc/trunk/NOTICE (with props)
tomcat/sandbox/tomcat-oacc/trunk/PROPOSALS.txt (with props)
tomcat/sandbox/tomcat-oacc/trunk/RELEASE-NOTES (with props)
tomcat/sandbox/tomcat-oacc/trunk/RELEASE-PLAN.txt (with props)
tomcat/sandbox/tomcat-oacc/trunk/RUNNING.txt (with props)
Added: tomcat/sandbox/tomcat-oacc/trunk/BUILDING.txt
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/tomcat-oacc/trunk/BUILDING.txt?rev=641350&view=auto
==============================================================================
--- tomcat/sandbox/tomcat-oacc/trunk/BUILDING.txt (added)
+++ tomcat/sandbox/tomcat-oacc/trunk/BUILDING.txt Wed Mar 26 08:29:25 2008
@@ -0,0 +1,171 @@
+================================================================================
+ 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.
+================================================================================
+
+$Id$
+
+ ==============================================
+ Building The Apache Tomcat OACC Cluster Module
+ ==============================================
+
+This subproject contains the source code for the Tomcat OACC cluster module.
+This module is a port of the Tomcat 5.5 cluster for use inside Tomcat 6.0.
+Its purpose is to simplify migration of applications using Tomcat 5.5 and
+clustering to Tomcat 6. With OACC users can first migrate to OACC without
+switching to the completely new default cluster implementation of Tomcat 6,
+and in a second step they can test and migrate from OACC to the default
+Tomcat 6 cluster.
+
+In order to build a binary distribution version of the oacc module from
+a source distribution, do the following:
+
+
+(0) Download and Install a Java Development Kit
+
+* If the JDK is already installed, skip to (1).
+
+* Download a Java Development Kit (JDK) release (version 1.5.x or later) from:
+
+ http://java.sun.com/j2se/
+
+* Install the JDK according to the instructions included with the release.
+
+* Set an environment variable JAVA_HOME to the pathname of the directory
+ into which you installed the JDK release.
+
+
+(1) Install Apache Ant 1.6.x on your computer
+
+* If Apache Ant 1.6.x is already installed on your computer, skip to (2).
+
+* Download a binary distribution of Ant 1.6.x from:
+
+ http://ant.apache.org/bindownload.cgi
+
+* Unpack the binary distribution into a convenient location so that the
+ Ant release resides in its own directory (conventionally named
+ "apache-ant-[version]"). For the purposes of the remainder of this document,
+ the symbolic name "${ant.home}" is used to refer to the full pathname of
+ the release directory.
+
+* Create an ANT_HOME environment variable to point the directory
+ ${ant.home}.
+
+* Modify the PATH environment variable to include the directory
+ ${ant.home}/bin in its list. This makes the "ant" command line script
+ available, which will be used to actually perform the build.
+
+
+(2) Install Apache Tomcat 6 on your computer
+
+* If Apache Tomcat 6 is already installed on your computer, skip to (3).
+
+* Download a binary distribution of Tomcat 6 from:
+
+ http://tomcat.apache.org/download-60.cgi
+
+* Unpack the binary distribution into a convenient location so that the
+ Tomcat release resides in its own directory (conventionally named
+ "apache-tomcat-[version]"). For the purposes of the remainder of this
document,
+ the symbolic name "${catalina.home}" is used to refer to the full pathname of
+ the release directory.
+
+(3) Building Tomcat OACC
+
+(3.1) Checkout or obtain the source code for Tomcat OACC
+
+* Tomcat SVN repository URL:
+ http://svn.apache.org/repos/asf/tomcat/sandbox/tomcat-oacc/
+
+* Download a source package from:
+ http://tomcat.apache.org/dev/dist/tomcat-oacc/
+
+* Checkout the source using SVN, selecting the desired version or
+ branch (current development source is at
+ http://svn.apache.org/repos/asf/tomcat/sandbox/tomcat-oacc/trunk/), or
+ unpack the source package. The location where the source has been
+ placed will be referred to as ${oacc.source}.
+
+(2.2) Building
+
+* Go to that directory, and provide the path to your installed Tomcat 6
+ in a file ${oacc.source}/build.properties:
+
+ # We need some jar files from Tomcat to compile against.
+ # Usually they are either in the lib subdirectory of an
+ # installed Tomcat, or in the lib subdirectory of your
+ # Tomcat build directory. Don't add the /lib to the
+ # path, we'll do that in build.xml automatically.
+ #
+ # Windows style
+ catalina.home=C:/Programme/apache-tomcat-6.0.14
+ # Unix style
+ # catalina.home=/usr/local/apache-tomcat-6.0.14
+ #
+ # We also need to know, where the tomcat-juli.jar is.
+ # This should be the full path including any sub directories.
+ #
+ # Windows style
+ catalina.extras=C:/Programme/apache-tomcat-6.0.14/bin
+ # Unix style
+ #catalina.extras=/usr/local/apache-tomcat-6.0.14/bin
+
+* For some more variables you can define, see the existing file
+ ${oacc.source}/build.properties.default.
+
+* In the same directory do:
+
+ ant
+
+* The compiled classes will be placed into ${oacc.source}/build.
+ The jar files needed to install OACC will be placed into
+ ${oacc.source}/dist.
+
+
+(3) Updating sources
+
+It is recommended that you regularly update the downloaded Tomcat OACC
+sources using your SVN client.
+
+(4) Rebuilds
+
+For a quick rebuild of only modified code you can use:
+
+ cd ${oacc.source}
+ ant
+
+If you apply changes to the source and you want to make sure
+that all classes get compiled correctly by ant, you can delete
+the results of a previous compilation by
+
+ ant build-clean
+
+
+(5) Building the documentation
+
+The documentation can be easly built:
+
+ cd ${tomcat.source}
+ ...
+
+(6) Building the javadoc
+ cd ${tomcat.source}
+ ...
+
+(7) Building a oacc release:
+
+ cd ${tomcat.source}
+ ...
Propchange: tomcat/sandbox/tomcat-oacc/trunk/BUILDING.txt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/sandbox/tomcat-oacc/trunk/BUILDING.txt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: tomcat/sandbox/tomcat-oacc/trunk/NOTICE
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/tomcat-oacc/trunk/NOTICE?rev=641350&view=auto
==============================================================================
--- tomcat/sandbox/tomcat-oacc/trunk/NOTICE (added)
+++ tomcat/sandbox/tomcat-oacc/trunk/NOTICE Wed Mar 26 08:29:25 2008
@@ -0,0 +1,5 @@
+Apache Tomcat
+Copyright 1999-2008 The Apache Software Foundation
+
+This product includes software developed by
+The Apache Software Foundation (http://www.apache.org/).
Propchange: tomcat/sandbox/tomcat-oacc/trunk/NOTICE
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/sandbox/tomcat-oacc/trunk/NOTICE
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: tomcat/sandbox/tomcat-oacc/trunk/PROPOSALS.txt
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/tomcat-oacc/trunk/PROPOSALS.txt?rev=641350&view=auto
==============================================================================
--- tomcat/sandbox/tomcat-oacc/trunk/PROPOSALS.txt (added)
+++ tomcat/sandbox/tomcat-oacc/trunk/PROPOSALS.txt Wed Mar 26 08:29:25 2008
@@ -0,0 +1,26 @@
+================================================================================
+ 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.
+================================================================================
+
+$Revision$ $Date$
+
+ ================================
+ Apache Tomcat OACC Proposals
+ ================================
+
+Most proposals should be kept inside the todo file of the original Tomcat 5.5
+cluster module. Relevant changes there should be ported to OACC.
+This file should only be used for OACC specific proposals.
Propchange: tomcat/sandbox/tomcat-oacc/trunk/PROPOSALS.txt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/sandbox/tomcat-oacc/trunk/PROPOSALS.txt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: tomcat/sandbox/tomcat-oacc/trunk/RELEASE-NOTES
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/tomcat-oacc/trunk/RELEASE-NOTES?rev=641350&view=auto
==============================================================================
--- tomcat/sandbox/tomcat-oacc/trunk/RELEASE-NOTES (added)
+++ tomcat/sandbox/tomcat-oacc/trunk/RELEASE-NOTES Wed Mar 26 08:29:25 2008
@@ -0,0 +1,67 @@
+================================================================================
+ 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.
+================================================================================
+
+$Id$
+
+
+ Apache Tomcat OACC Version @VERSION@
+ Release Notes
+
+
+=============================
+KNOWN ISSUES IN THIS RELEASE:
+=============================
+
+* Compatibilty
+* SingleSignOn
+* Viewing the Tomcat OACC Change Log
+
+
+==============
+Compatibility:
+==============
+Tomcat OACC is compatible with Tomcat 6 and works
+with Java 5 and Java 6.
+
+Since there is a strong relation between Tomcat 6 and the Tomcat
+cluster implementation, you always need to use a OACC binary build
+against the same version of Tomcat, than the one you are using.
+
+All cluster configuration options from Tomcat 5.5 should work without
+any change with OACC. You need to ensure, that you have set the
+"managerClassName" explicitely to either
+"org/apache/catalina/cluster/session/SimpleTcpReplicationManager"
+or "org/apache/catalina/cluster/session/DeltaManager".
+
+You don't need to uninstall Tomcat 6 default cluster if you like to
+use OACC. We don't support mixed use of OACC and Tomcat 6 default cluster
+in the same Tomcat instance though.
+
+=============
+SingleSignOn:
+=============
+If you need to use the SingleSignOn authenticator together with OACC,
+we need to replace one class from the default Tomcat 6 with a OACC
+special one. See RUNNING.txt.
+
+We don't recommend the use of SingleSignOn in combination with clustering,
+because some use cases will not work the way you expect them to.
+
+===================================
+Viewing the Tomcat OACC Change Log:
+===================================
+See changelog.html in the documentation directory.
Propchange: tomcat/sandbox/tomcat-oacc/trunk/RELEASE-NOTES
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/sandbox/tomcat-oacc/trunk/RELEASE-NOTES
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: tomcat/sandbox/tomcat-oacc/trunk/RELEASE-PLAN.txt
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/tomcat-oacc/trunk/RELEASE-PLAN.txt?rev=641350&view=auto
==============================================================================
--- tomcat/sandbox/tomcat-oacc/trunk/RELEASE-PLAN.txt (added)
+++ tomcat/sandbox/tomcat-oacc/trunk/RELEASE-PLAN.txt Wed Mar 26 08:29:25 2008
@@ -0,0 +1,54 @@
+================================================================================
+ 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.
+================================================================================
+
+$Id$
+
+
+ Release Plan for Apache Tomcat OACC
+ ===================================
+
+
+Introduction:
+------------
+
+This document is a release plan for the development of Apache Tomcat OACC.
+
+The goal of the Apache Tomcat OACC is to provide a port of Tomcat 5.5 cluster
+to Tomcat 6.
+
+The default cluster contained in Tomcat 6 is more powerful than the previous
+Tomcat 5.5 cluster. To achieve this goal, the implementation has changed
+completely and the configuration is very different from the previous one.
+
+Users with HA (high-availability) requirements usually have a very conservative
+position with respect to big changes of the infrastructure. In order to allow
for
+an easier migration path from Tomcat 5.5 to Tomcat 6, OACC allows to use the
+original Tomcat 5.5 cluster configuration and implementation inside Tomcat 6.
+
+Users can therefore first migrate to Tomcat 6 using the cluster module they
+have gotten familiar with, and in a second step they can switch over to the
+default Tomcat 6 cluster implementation.
+
+Stability
+---------
+
+Apart from porting issues, OACC will soon be called stable, because the OACC
code
+is nearly identical with the stable Tomcat 5.5 cluster module.
+
+The project will try to keep Tomcat 5.5 cluster in sync with OACC.
+
+There are no plans for major changes to OACC.
Propchange: tomcat/sandbox/tomcat-oacc/trunk/RELEASE-PLAN.txt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/sandbox/tomcat-oacc/trunk/RELEASE-PLAN.txt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: tomcat/sandbox/tomcat-oacc/trunk/RUNNING.txt
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/tomcat-oacc/trunk/RUNNING.txt?rev=641350&view=auto
==============================================================================
--- tomcat/sandbox/tomcat-oacc/trunk/RUNNING.txt (added)
+++ tomcat/sandbox/tomcat-oacc/trunk/RUNNING.txt Wed Mar 26 08:29:25 2008
@@ -0,0 +1,86 @@
+================================================================================
+ 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.
+================================================================================
+
+$Id$
+
+ ==========================
+ Running Apache Tomcat OACC
+ ==========================
+
+Apache Tomcat OACC requires Apache Tomcat 6 and the Java 2 Standard Edition
+Runtime Environment (JRE) version 5.0 or later.
+
+==============================
+Installation and Configuration
+==============================
+
+(1) Provide a working Tomcat 6
+
+ You need a working installation of Tomcat 6 first.
+ Test your installations with the provided Tomcat 6 example webapp
+ and your own web applications before trying to add a cluster.
+
+(2) Download and Install the Tomcat OACC Binary Distribution
+
+NOTE: As an alternative to downloading a binary distribution, you can create
+your own from the Tomcat source repository, as described in "BUILDING.txt".
+If you do this, the value to use for "${oacc.home}" will be the "dist"
+subdirectory of your source distribution.
+
+(2.1) Download a binary distribution of Tomcat from:
+
+ http://tomcat.apache.org/dev/dist
+
+ You need to choose the same minor version of OACC as your Tomcat 6
version.
+
+(2.2) Unpack the binary distribution into a convenient location so that the
+ distribution resides in its own directory (conventionally named
+ "apache-tomcat-oacc-[version]"). For the purposes of the remainder of
this
+ document, the symbolic name "$OACC_HOME" is used to refer to the full
+ pathname of the release directory.
+
+(2.3) Add the file $OACC_HOME/lib/apache-tomcat-oacc.jar to the definition of
+ "common.loader" in the file conf/catalina.properties contained in your
+ CATALINA_BASE resp. CATALINA_HOME.
+
+(2.4) If you need to use the SingleSignOn authenticator together with OACC,
+ you also need to add $OACC_HOME/lib/apache-tomcat-sso.jar to the
common.loader.
+ It is important to add this jar file before the other entries in
common.loader.
+
+ We don't recommend the use of SingleSignOn in combination with
clustering,
+ because some use cases will not work the way you expect them to.
+
+(2.5) Add a "Cluster" configuration element to your server.xml. The syntax is
exactly
+ the same, as for the Cluster element in Tomcat 5.5. Do not use the
syntax for
+ Tomcat 6 clustering. All cluster configuration options from Tomcat 5.5
should
+ work without any change with OACC.
+
+ You need to ensure, that you have set the "managerClassName" explicitely
to either
+ "org/apache/catalina/cluster/session/SimpleTcpReplicationManager" or
+ "org/apache/catalina/cluster/session/DeltaManager".
+
+ You don't need to uninstall Tomcat 6 default cluster if you like to
+ use OACC. We don't support mixed use of OACC and Tomcat 6 default cluster
+ in the same Tomcat instance though.
+
+(3) Testing
+
+(3.1) Start up Tomcat on all cluster nodes.
+
+(3.2) Test JSP
+
+ ...
Propchange: tomcat/sandbox/tomcat-oacc/trunk/RUNNING.txt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/sandbox/tomcat-oacc/trunk/RUNNING.txt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
