You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@vcl.apache.org by jf...@apache.org on 2015/02/04 15:17:36 UTC

svn commit: r1657241 - /vcl/site/trunk/content/docs/UpgradePreviousVersions/UpgradeFrom2.2.2to2.4.mdtext

Author: jfthomps
Date: Wed Feb  4 14:17:35 2015
New Revision: 1657241

URL: http://svn.apache.org/r1657241
Log:
initial creation of 2.2.2 to 2.4 upgrade guide

Added:
    vcl/site/trunk/content/docs/UpgradePreviousVersions/UpgradeFrom2.2.2to2.4.mdtext
      - copied, changed from r1656915, vcl/site/trunk/content/docs/UpgradePreviousVersions/UpgradeFrom2.3.2to2.4.mdtext

Copied: vcl/site/trunk/content/docs/UpgradePreviousVersions/UpgradeFrom2.2.2to2.4.mdtext (from r1656915, vcl/site/trunk/content/docs/UpgradePreviousVersions/UpgradeFrom2.3.2to2.4.mdtext)
URL: http://svn.apache.org/viewvc/vcl/site/trunk/content/docs/UpgradePreviousVersions/UpgradeFrom2.2.2to2.4.mdtext?p2=vcl/site/trunk/content/docs/UpgradePreviousVersions/UpgradeFrom2.2.2to2.4.mdtext&p1=vcl/site/trunk/content/docs/UpgradePreviousVersions/UpgradeFrom2.3.2to2.4.mdtext&r1=1656915&r2=1657241&rev=1657241&view=diff
==============================================================================
--- vcl/site/trunk/content/docs/UpgradePreviousVersions/UpgradeFrom2.3.2to2.4.mdtext (original)
+++ vcl/site/trunk/content/docs/UpgradePreviousVersions/UpgradeFrom2.2.2to2.4.mdtext Wed Feb  4 14:17:35 2015
@@ -1,4 +1,4 @@
-Title: Upgrade From 2.3.2 to 2.4
+Title: Upgrade From 2.2.2 to 2.4
 Notice:    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
@@ -22,7 +22,7 @@ VCL 2.4 is the first release to include
 upgrade VCL is the script. It will download and validate the VCL software and
 then upgrade your system. The script can be used to upgrade all three parts of
 VCL (database, web portal, and management node) or to upgrade each part
-individually.
+individually. It will upgrade from any previous version of Apache VCL.
 
 [Download Upgrade Script (vcl-upgrade.sh)](https://www.apache.org/dist/vcl/vcl-upgrade.sh)
 
@@ -35,14 +35,38 @@ individually.
     gpg --verify vcl-upgrade.sh.asc
 
 Running the upgrade script with no arguments will step you through upgrading
-all three parts of VCL.
+all three parts of VCL. Alternatively, the following explains optional 
+arguments. If upgrading the management node part of VCL, it will also prompt 
+you to agree to the installation of various system level requirements needed 
+for the code to run.
+
+    :::BashLexer
+    vcl-upgrade.sh [-h|--help] [-d|--database] [-w|--web] [-m|--managementnode]
+            [--dbhost <hostname>] [--dbadminuser <username>]
+            [--dbadminpass <password>]
+
+    -d|--database - upgrade database components
+            --dbhost may optionally be specified if not localhost
+
+    -w|--web - upgrade web server components
+
+    -m|--managementnode - upgrade management node (vcld) components
+
+    --dbhost <hostname> - hostname of database server (default=localhost)
+
+    --dbname <name> - name of VCL database on database server (default=vcl)
+
+    --dbadminuser <username> - admin username for database; must have access
+            to modify database schema and dump data for backup (default=root)
+
+    --dbadminpass <password> - password for dbadminuser (default=[no password])
 
 ---
 
 # Manual Upgrade Instructions
 
-These instructions explain how to upgrade from VCL 2.3.2 to VCL 2.4. Please note 
-it only applies for the upgrade from 2.3.2 to 2.4, this may or may not work for other 
+These instructions explain how to upgrade from VCL 2.2.2 to VCL 2.4. Please note 
+it only applies for the upgrade from 2.2.2 to 2.4, this may or may not work for other 
 versions.
 
 **The basic steps that will be performed**
@@ -82,19 +106,19 @@ necessary.
         :::BashLexer
         mysql vcl < /root/apache-VCL-2.4/mysql/update-vcl.sql
 
-6. **Update the web code**. This step we will move the 2.3.2 web directory out of the 
+6. **Update the web code**. This step we will move the 2.2.2 web directory out of the 
 way, so we can copy in the new web code base. After copying in the new code, we will 
 migrate your configuration changes. These instructions assume that you installed the 
 VCL web code at /var/www/html/vcl. If you installed it elsewhere, replace 
 /var/www/html/vcl with your vcl web root.
 
         :::BashLexer
-        mv /var/www/html/vcl /var/www/html/vcl-2.3.2
+        mv /var/www/html/vcl /var/www/html/vcl-2.2.2
 
 7. **Disable access** to the old web code
 
         :::BashLexer
-        echo "Deny from all" > /var/www/html/vcl-2.3.2/.htaccess
+        echo "Deny from all" > /var/www/html/vcl-2.2.2/.htaccess
 
 7. **Copy the new code** in place
 	
@@ -102,10 +126,10 @@ VCL web code at /var/www/html/vcl. If yo
         cp -r /root/apache-VCL-2.4/web /var/www/html/vcl-2.4
         ln -s /var/www/html/vcl-2.4 /var/www/html/vcl
 
-8. **Copy your 2.3.2 config files**
+8. **Copy your 2.2.2 config files**
 	
         :::BashLexer
-        cd /var/www/html/vcl-2.3.2/.ht-inc
+        cd /var/www/html/vcl-2.2.2/.ht-inc
         cp conf.php secrets.php pubkey.pem keys.pem /var/www/html/vcl/.ht-inc
 
 9. **Add new items to conf.php**. The following items need to be added to the conf.php
@@ -118,8 +142,18 @@ array() definition):
 <br>
 
         :::PhpLexer
+        define("DEFAULTLOCALE", "en_US");              // default locale for the site
+
         define("SEMTIMEOUT", "45");
 
+        define("ALLOWADDSHIBUSERS", 0); // this is only related to using Shibboleth authentication for an affiliation that does not
+                                        // also have LDAP set up (i.e. affiliation.shibonly = 1)
+                                        // set this to 1 to allow users be manually added to VCL before they have ever logged in
+                                        // through things such as adding a user to a user group or directly granting a user a
+                                        // privilege somewhere in the privilege tree. Note that if you enable this and typo
+                                        // a userid, there is no way to verify that it was entered incorrectly so the user
+                                        // will be added to the database with the typoed userid
+
         define("MAXINITIALIMAGINGTIME", 720); // for imaging reservations, users will have at least this long as the max selectable duration
 
         define("MAXSUBIMAGES", 5000);  // maximum allowed number for subimages in a config
@@ -143,6 +177,21 @@ array() definition):
             "Report a Problem" => "mailto:" . HELPEMAIL,
         );
 
+9. **Modify existing items in conf.php**. The following items in conf.php need to be 
+modified. Change:
+
+    * OLD
+	
+        :::PhpLexer
+        $addUserFunc[$item['affiliationid']] = create_function('', 'return 0;');
+        $updateUserFunc[$item['affiliationid']] = create_function('', 'return 0;');
+ 
+    * NEW
+
+        :::PhpLexer
+        $addUserFunc[$item['affiliationid']] = create_function('', 'return NULL;');
+        $updateUserFunc[$item['affiliationid']] = create_function('', 'return NULL;');
+
 9. **Make the maintenance directory writable** by the web server user. Normally this is
 the apache user, if using a different user change below cmd accordingly.
 	
@@ -154,13 +203,13 @@ the apache user, if using a different us
         :::BashLexer
         service httpd start
 
-12. **Backup management node code**. This step will make a backup copy of the 2.3.2  
+12. **Backup management node code**. This step will make a backup copy of the 2.2.2  
 management node code. These instructions assume that you installed the 
 VCL management node code at /usr/local/vcl. If you installed it elsewhere, replace 
 /usr/local with your management node path.
 	
         :::BashLexer
-        cp -r /usr/local/vcl /usr/local/vcl-2.3.2
+        cp -r /usr/local/vcl /usr/local/vcl-2.2.2
 
 13. **Copy in the 2.4 management node code** to /usr/local. First, rename the existing
 management node code directory to vcl-2.4 so that any drivers or other files you've