6. Upgrade to the latest version

This section describes what you need to consider to upgrade an existing copy of WANdisco's Access Control / Access Control Plus. We cannot address every set of conditions so take care to consider all possible problems. If you have any questions or concerns, contact WANdisco support team.

6.1 Upgrade overview

This section gives an overview of the upgrade procedure. The procedure starts with creating a import file by invoking the export script in the current installation. This stores system and user settings in an external XML file for later re-importation. Next, the upgrade script is run. This takes the latest JAR files and places them into the current install. The final post-install portion performs any necessary changes to database structure and restores the previous installation's settings.

The Pre-installation step invokes the backup script which stores the system and user settings that are imported into the latest version.

Installing Flume while upgrading

If you are running a version of Access Control Plus that didn't include Flume, It's possible to install Flume during an upgrade of Access Control Plus. See 6.7 Install Auditing. The procedure differs a little from that used when installing both ACP and Flume from scratch. For that, see 3.1 Install Auditing Function.

6.2 Pre-upgrade: turn off batch updates

Perform the upgrade during a time when you can halt SCM activity. If you are running with Batch Mode on, this needs to be disabled and Access Control Plus will need enough time to catch up with all batched operations.

1. Log in to Access Control Plus.
2. Click Settings.
3. Click Access Control Updates.
4. Click the Disable Batch Updates button.
   

6.3 Upgrade procedure

Having completed the necessary pre-upgrade steps, it's now time to complete the upgrade. You'll need to have downloaded the installer for the latest version of Access Control Plus. Place the script on your server and run through the following steps:

1. Open a terminal window and log in to the server.
2. Get the latest installer file and make sure it is executable:

   chmod a+x scm-access-control-plus_rpm_installer.sh
     	  

3. Run the installer: After providing Access Control Plus admin credentials, the installer script verifies that there's an existing installation and completes the necessary back up of settings:

         [root@redhat6 wandisco]# ./scm-access-control-plus_rpm_installer.sh
         Verifying archive integrity... All good.
         Uncompressing WANdisco Access Control Plus..........
         Running in non-interactive mode, installing with user 'wandisco' and group 'wandisco'. Output will be logged to the daemon.info syslog facility
         Please enter the username of an administrative user: admin
         Please enter the password for 'admin':
         Checking credentials: OK
         State machines are stopped
         Backing up platform: OK
         Backing up ACP: OK
         Backup complete
         

4. The installer performs the upgrade. In most cases the installer handles everything:

         Stopping scm-access-control-plus:.[  OK  ]
         Upgrading from version 1.0.1
         Starting upgrade of backup found in /opt/wandisco/scm-access-control-plus/database/backup/2014-07-28T13:30:19Z_DConE_Backup
         ..............................
         Transformation complete
         Jun 27, 2014 4:26:43 PM com.wandisco.acp.backup.Restore main
         . . . . . . . . 
         Please run '/opt/wandisco/scm-access-control-plus/bin/replace-link' once all nodes have been upgraded. This will automatically start the replicator.
         Stopping scm-access-control-plus services...
         Stopping scm-access-control-plus:[  OK  ]
         
         
         

6.4 Post upgrade: bring nodes back up

When all nodes have been upgraded, bringing them back up by running:

./opt/wandisco/scm-access-control-plus/bin/replace-link

6.5 Enable wildcard support

Upgrading Access Control Plus to v1.5 includes wildcard support:

• Every rule-specific resource can be enabled to have a priority, and this influences the placement of the section within the AuthZ file. A setting can be stored for the collapsed section priority choice (the lower the number the higher position in the file).
• Highest priority is the default. We recommend that you do not change this. Contact Wandisco Support for advice on this.
• Wildcards are either enabled globally or not enabled at all.
• If wildcard support is enabled, there is no way to disable it. This is true even if there are no wildcard rules set.

With Subversion, MultiSite Plus and Access Control Plus installed:

1. Click Settings then Connect to MultiSite.
2. Click the check box Enable Wildcards. Note:

   This cannot be undone without reinstalling

3. Select either:
   • High Priority
   • Low Priority

   Default is High Priority. See Setting priorities

4. Click Save.

The wildcards option is now enabled for rules applying to MultiSite Plus repositories.

Note that you can change the priority setting at any time.

6.6 Roll back

If you need to roll back from an attempted upgrade and return to your current installation, for example going back from 1.5 to 1.1.1:

1. From the /opt/wandisco/scm-access-control-plus/backups directory, copy the file similar to scm-access-control-plus-backup_20141217154840.tar.gz to somewhere safe.
2. Uninstall the current version of ACP.

       	
       	[root@redhat6 init.d]# yum remove scm-access-control-plus
       	Loaded plugins: product-id, rhnplugin, security, subscription-manager
       	Updating certificate-based repositories.
       	Setting up Remove Process
       	Resolving Dependencies
       	--> Running transaction check
       	---> Package scm-access-control-plus.noarch 0:1.0.1-1711 will be erased
       	--> Finished Dependency Resolution
       	epel/metalink                                            |  27 kB     00:00
       	epel                                                     | 4.4 kB     00:00
       	epel/primary_db                                          | 6.3 MB     00:00
       	
       	Dependencies Resolved
       	
       	================================================================================
       	 Package    Arch   Version    Repository                                   Size
       	================================================================================
       	Removing:
       	 scm-access-control-plus
       		    noarch 1.0.1-1711 @/scm-access-control-plus-1.0.1-1711.noarch  55 M
       	
       	Transaction Summary
       	================================================================================
       	Remove        1 Package(s)
       	
       	Installed size: 55 M
       	Is this ok [y/N]: y
       	Downloading Packages:
       	Running rpm_check_debug
       	Running Transaction Test
       	Transaction Test Succeeded
       	Running Transaction
       	  Erasing    : scm-access-control-plus-1.0.1-1711.noarch                    1/1
       	Stopping scm-access-control-plus services...
       	Stopping scm-access-control-plus:[  OK  ]
       	Installed products updated.
       	  Verifying  : scm-access-control-plus-1.0.1-1711.noarch                    1/1
       	
       	Removed:
       	  scm-access-control-plus.noarch 0:1.0.1-1711
       	
       	Complete!
       	

   You can then delete or back up the install directory, eg /opt/wandiso/ scm-access-control-plus.
3. Re-install the previous version of Access Control Plus.
4. Stop the replicator.
5. Ensure that the permissions are correct.
6. Run the rollback script.

   cd /opt/wandisco/scm-access-control-plus/bin
       		./rollback
       	

7. Repeat the rollback procedure on each node.
8. When all nodes have been rolled back, start ACP via the scm-access-control-plus service start as usual.

Your nodes will start up, returning production to the earlier version of Access Control Plus.

6.6 Import Access Control 4.2 backup data

An upgrade from Access Control/Subversion MultiSite 4.2 assumes that you are running with the latest 4.2 versions.

6.6.1 Pre-install

1. On your Access Control/SVN MultiSite 4.2 deployment, perform a sync stop.
2. Run the Export tool, creating a backup directory.

   Important: Local Admin Account
   When you import this exported 4.2 data, the existing Access Control Plus data will be removed, including the local admin account. You should ensure that there is a local admin account present on your 4.2 deployment prior to completing this export. Furthermore, ensure that you don't disable local accounts on Access Control Plus prior to re-importing the data.
   
   Should you get locked out of Access Control Plus you can run the Password change/recovery utility which will enable local account access and prompt you to create a new admin account
   - 3.4 Password change/recovery.

3. You may need to perform a cleanup of the export. Contact WANdisco's support team about whether this will be necessary.
4. Shutdown Access Control/SVN MultiSite 4.2. You may wish to save the installation to an archive so that it's no longer present on the server.
5. If you're installing SVN MultiSite Plus then delete your current installation of Subversion. The latest version of MultiSite requires that you install a modified version of SVN.

6.6.2 Install Access Control Plus

1. Run through the instructions provided in the Deployment Guide.
2. When the installation and node induction is complete you can run the special import script that is available in the Access Control Plus installation which handles 4.2 backup files. Login to the server via a terminal and navigate to the bin directory, by default this is /opt/wandisco/scm-access-control-plus/bin/.
3. Providing that you have logged on with appropriate permissions, you can run the script as follows:

   ./import42backup

4. You will need to provide Access Control Plus admin login credentials. You'll then be asked for a the absolute path to the 4.2 backup. e.g.:

   "Path to the backup directory to use: 2014-05-30.12-139-25_cfdc4-3r3ro-3r3-3rr3nfvfeef" etc

5. You can confirm the import was successful by viewing the available accounts in Access Control Plus.

6.7 Install Auditing (through Apache Flume)

Installation Overview

There are two ways to install flume

• interactive (manual)
• and non-interactive (silent)

Interactive

Use ACP's installer to handle the upgrade, the installer will detect that you are performing an upgrade and that Flume is not yet installed. The installer will ask:

Do you wish to install auditing components for use with Access Control Plus? (Y/n)

Just answer the brief series of question to install Flume.

Non-interactive

For the non-interactive upgrade, to install Flume for a first time for ACP you will need to set the following variables:

ENABLE_AUDITING=true
FLUME_INSTALL_DIR:Flume install location for acp-flume-receiver
ACP_USER_ID: Logger user ID to connect flume->acp
ACP_USER_PASSWORD: Logger user password to connect flume->acp
ACP_USER_EMAIL: Logger user email
ACP_AVRO_HOST: Flume receiver IP
ACP_AVRO_PORT: Flume receiver port
FLUME_ACP_HOST: ACP IP for Flume to connect to
FLUME_ACP_PORT: ACP rest port for Flume to connect to
FLUME_AVRO_SSL: true/false to enable/disable SSL
FLUME_AVRO_KEYSTORE_LOC: Only required if FLUME_AVRO_SSL=true, keystone location
FLUME_AVRO_KEYSTORE_PASS: Only required if FLUME_AVRO_SSL=true, keystone password
FLUME_AVRO_TRUSTSTORE_LOC: Only required if FLUME_AVRO_SSL=true, truststore location
FLUME_AVRO_TRUSTSTORE_PASS: Only required if FLUME_AVRO_SSL=true , truststore password
INSTALL_FLUME_ON_UPGRADE=set to true if first install of flume on an upgrade

Example

An example of these exports would be like the following (excluding the use of SSL)

export ENABLE_AUDITING=true
export FLUME_INSTALL_DIR=/opt/wandisco/flume-scm-access-control-plus
export ACP_USER_ID=logger
export ACP_USER_PASSWORD=logger
export ACP_USER_EMAIL=logger@logger.com
export ACP_AVRO_HOST=localhost
export ACP_AVRO_PORT=8441
export FLUME_ACP_HOST=localhost
export FLUME_ACP_PORT=8441
export FLUME_AVRO_SSL=false
export INSTALL_FLUME_ON_UPGRADE=true

Once you have exported these variables, run the upgrade.