Install

3. Installation

The installation guide runs through setting up Subversion MultiSite for the first time. If you are upgrading from an earlier version of Subversion MultiSite you should also follow this procedure - SVN MultiSite Plus is a completely new class of product so it's not possible to follow a shortcut upgrade procedure.

3.1 Installation overview

Before we begin, here is a recap of the installation process:

• 1. Revisit the Installation Checklist. Taking extra time making sure you have everything set up and ready may save you from running into problems during the installation process. The main boxes you need to tick are:


• Subversion authentication: Subversion installed, and using authentication.


• JDK7: You need to have Oracle's Java JDK 6 installed. You will need to use Oracle JDK 6 .
  

  Alert
  Important: use Oracle JAVA JDK 6
  All our development and testing is done using JDK 6. You will need to use JDK 6 to ensure compatibility with Subversion MultiSite. It may be possible to run Subversion MultiSite with other versions of Java, although we won't presently be able to support it.



• Java Memory Settings: The Java process on which Subversion MultiSite Plus runs is assigned a minimum and maximum amount of system memory, by default it will get 128MB at start up and 4GB Maximum.


• System resources: Ensure that your system is going to operate with a comfortable margin.


• 2. Ensure that your repositories are copied into place on all nodes.


• 3. Download and copy the MultiSite files into place.


• 4. Run the setup, then complete the installation from a web browser.

3.2 Before you start

Some things you should bear in mind before starting the installation:

• Check through the Pre-installation Checklist
• Ensure that you have WANdisco's latest Subversion binaries pre-installed. SVN MultiSite Plus edition requires FSFSWD libraries that are built into WANdisco's version of Subversion
• Repositories need to be created using the file system switch (--fs-type fsfswd)

3.3 Starting the installation

• 1. Extract the setup file.
• 2. Save the wandisco-multisite-plus.sh installer file to your Installation site.
• 3. Make the script executable, e.g. enter the command:

  chmod a+x wandisco-multisite-plus.sh

• 4. Run the setup script.

  Running with Apache?
  If you are using Apache to allow httpd access to your repositories, you should run both Subversion MultiSite and Apache with the same user.

  [root@redhat6 ~]# chmod a+x multisite-plus.sh
  [root@redhat6 ~]# ./multisite-plus.sh
  Verifying archive integrity... All good.
  Uncompressing WANdisco MultiSite Plus........
      ,             ..   .    .  `''` . ..`''   ...`    .   :,     ,;.     :;
     ::,  ::  ::     +   +'  '+ +++++++ ++++++, +   ,'  ; ;   :   ;   +  '`   +
    ::::,:::: :::    +'  ++  +;;+    ++ ++   '+ +     : ; +      '      .      :
   ::::::::::: :::   ;+ '++  + +'    `+ ++    + +     + ; '     .       +      +
  ,:::::::::::: :::   + +.+;++ +,     + ++    + +     ; ;  .++  :       +      '
   ::::::::::: :::    +++ .++, +'    `+ ++    + +     + ;     .`.       +      +
    ::::,:::: :::     .++  ++  '+    ++ ++    + +     : ;      ; '      ,      :
     ::,  ::  ::       +.  ++   +++++++ ++    + +   .'  ; +   ,  `;   '  +    +
      ,                ,   ``    .++` , ,,    , ,,,.    .  `;:     :',     ;;
  
  
  Are you sure you want to commence the installation of WANdisco MultiSite Plus?
  Continue? Y/N [Y] > Y
  

• 5. Enter "Y" and click enter. The installer will first check that your system meets a number of basic requirements:

  Beginning WANdisco MultiSite Plus Installation...
  
  WARNING: The max number of user processes is less than 64000 for this user.
  This needs to be set to a high value otherwise your system won't be able to create the threads required to deploy large numbers of repositories.
  
  Continue? Y/N [Y] > 
  

  This check of the maxiumum number of user processes will highlight whether your server is ready for a high-traffic deployment. Press Enter to continue.
• 6. The next test looks at the Java heap settings. It lists the maximum and minimum allocations for both the replicator component of SVN MultiSite Plus as well as the admin console UI:

    WANdisco Java processes will start with the following memory settings:  
      
    Replicator:
         Max Memory: 4096
         Min Memory: 1024
  
    UI:
         Max Memory: 1024
         Min Memory: 128
  
  
  WARNING: If the host does not meet these specified memory requirements, you will
  encounter problems starting the WANdisco processes. Would you like to change these
  settings?
  
  Change settings? Y/N >
    

  Enter "Y" if you need to modify the heap settings, then enter your preferred values. Of course, dropping these settings may impact your system's performance. You should discuss the heap requirements with WANdisco's support team before making any major changes from the default values.
• 7. You'll now be asked to enter a TCP port number for accessing the browser part of the installation process.

  Please select a port on which to start the UI after installation
  
  Enter port number:
  

  We use port 8080 in our documentation. Check with your network administrator about which ports are available. You can change the port during the next part of the installation.
• 8. The next test confirms that the server has maximum number of file descriptors:

  WARNING: The max number of file descriptors is less than 64000 for this user.
  This needs to be set to a high value otherwise your system may encounter issues whilst under load.
  

  Press Enter to continue.
• 9. The installer now checks to see if you already have Subversion installed. As you need to be running with WANdisco's specific version you may be given the option to upgrade. If you've already got the correct version installed you'll see:

      There is a version of SVN installed.
  -------------------------------------------------------------------------------
  svn, version 1.7.7-fsfswd (r75)
     compiled Nov 22 2012, 16:04:16
  
  Copyright (C) 2012 The Apache Software Foundation.
  This software consists of contributions made by many people; see the NOTICE
  file for more information.
  Subversion is open source software, see http://subversion.apache.org/
  
  The following repository access (RA) modules are available:
  
  * ra_neon : Module for accessing a repository via WebDAV protocol using Neon.
    - handles 'http' scheme
    - handles 'https' scheme
  * ra_svn : Module for accessing a repository using the svn network protocol.
    - with Cyrus SASL authentication
    - handles 'svn' scheme
  * ra_local : Module for accessing a repository on local disk.
    - handles 'file' scheme
  -------------------------------------------------------------------------------
  
  Do you want to install WANdisco SVN? Y/N [Y] >
   

  In this case we can enter "N".
• 10. Open a browser and go to the provided URL. If your server's DNS isn't running you can go to the next step at the following address:

  http://<IP_Adress>:<admin port>/multisite-local
  

  e.g.
  http://10.0.100.252:8080/multisite-local/
  
  
• 11. The web installer begins with the Welcome screen Welcome to the installation of SVN MultiSite Plus.
  
  

  Welcome to SVN MultiSite Plus.
  You're about to run through the installation, which should only take a couple of minutes.
  
  If you run into difficulties on the way, check our documentation or talk to our support team through the Customer Support Website.
  
  Before you click Next, make sure you Read the Installation Checklist
  

  Click Next to begin the installation.



• 12. The next (Terms & Conditions) screen contains the WANdisco Master Subscription Agreement.
  To continue the installation click the I AGREE button.




• 13. On the next (License Upload) screen you are prompted to browse for your product license key file. Click on the + Browse button and locate your file. You will have been sent this by the WANdisco sales team, contact them if you have any problems locating or using your license file.
  



• 14. On the Administrator Setup screen you enter the username plus an associated password which you will use to login to Subversion MultiSite's UI.



Username

The administrator's username.

Password

The administrator's password.

Confirm Password

Enter your password again to confirm that it's been typed in correctly.

User Interface HTTP Port

You entered the port during the first part of the installation, it's now possible to choose an alternate port here.
This port is sometimes referred to as the jetty port.




• 15. The last screen in the setup process covers Server Settings.
  
  
  

  Node Name

  The default name for this node.

  Temporary limitation
  Node names can not contain spaces or ".".

  Node IP/Host

  The node's IP or hostname. If the server is multi-homed, you can select the IP to which you want Subversion MultiSite to be associated.

  Latitude

  SVN MultiSite Plus schedules changes to replication based on the local time. For this reason we capture the coordinates of the node's location. The default location is close to WANdisco's Sheffield office. You can quickly capture your node's location using one of many online map tools

  Longitude

  The longitude of the server's location.

  Replication Port

  Select the port that will be used for replicated Subversion repository data.

  Content Server Port

  Select the port that will be used to transfer replicated content (repository changes). This is different from the port used by WANdisco's DConE² agreement engine.

  Content Node Count

  This setting gives you the ability to enforce a degree of resiliance. The value represents the number of nodes within a membership that must receive the content before a proposal is submitted for agreement. If the value is greater than the total learners in the current membership, it is adjusted to total learners in the current membership. The proposing node is not considered in the calculation.

  Minimum Content Nodes Required

  Ticking this checkbox will enforce the Content Node Count as a prerequisite for replication.

  REST API Port

  The port to be used for SVN MultiSite Plus's REST-based API. (Default:8445)

  REST API SSL Port

  The port to be used for SVN MultiSite Plus's REST-based API when traffic is secured using SSL encryption.

  REST API Using SSL

  Check box for enabling the use of SSL for all API traffic.

  SSL Trust Store

  The location of your trust store file. Trust stores contain CA certifcates to trust. If your server's certificate is signed by a recognized Certification Authority (CA), the default truststore that ships with the JR will already trust it (because it already trusts trustworthy CAs), so you don’t need to build your own, or to add anything to the one from the JRE.

  SSL Trust Store Password

  The password for your trust store.

  SSL Key Store

  The name of the keystore file. The keystore contains a public keys. for authorized users.

  SSL Key Store Password

  The password associated with the keystore.

  A word about trust stores and key stores
  You might be familiar with the Public-key system that allows two parties to use encryption to keep their communication with each other private (incomprehensible to an intercepting third-party). The keystore is used to store the public and private keys that are used in this system. However, in isolation, the system remains susceptible to the hijacking of the public key file, where an end user may receive a fake public key and be unaware that it will enable communication with an impostor. Enter Certificate Authorities (CAs). These trusted third parties issue digital certificates that verify that a given public key matches with the expected owner. These digital certificates are kept in the truststore. An SSL implementation that uses both keystore and truststore files offers a more secure SSL solution.

If you need help getting your SSL keys set up, check out our guide in the Appendix - Setting up SSL



• 16. Click FINISH when you have entered everything. The installer will now complete the configuration. Once that's all done a START USING MULTISITE button will appear. Click the button to login for the first time.
  



• 17. Time to login. Enter the username and password during step 12. Then click FINISHED - LET'S GO!.


• 18. The first time you view the dashboard, it will contain mostly blank areas. You can view the reference section to learn what all the buttons and options mean.

4. Repeat the installation process at all sites

Now repeat section 3 for each node that you wish to share your Subversion repositories.
You may benefit from creating an image of your initial server, with the repositories in place and using this as a starting point on your other sites - this will help you ensure that your replicas are in exactly the same state.

Same Location
All replicas must be in the same location (same absolute path) and in exactly the same state before replication can start.

Same UUID
If you start with new repositories, don't create them individually at each node. This is because even though they may share the same repository data, each will have it's own universally unique identifier (UUID) - unless they have the same UUID they're not replicas.

5. Node Induction

After installing SVN MultiSite Plus at all sites, you'll need to make the sites aware of each other through the node induction process. There's a particular way that you need to run through this process so get another coffee and don't skip this section.

Overview

It's important that sites are connected together in specific sequence. Run through the following steps to ensure that your sites are all able to talk to each other:

• 1. When SVN MultiSite Plus is installed on all your sites, select one node to be your Inductor. This node will accept requests for membership and share its existing membership information. It doesn't matter which node you select.
  


• 2. Login to this Inductor's admin console (http://<Inductor's IP>:8080/multisite-local/) and gather the following information, most is available from the Settings tab.
  
  All your remaining sites are now classed as Inductees.



• 3. Select one of you remaining Inductee sites. Connect to its web admin console (http://<Inductee1:8080/multisite-local/) and go to the Nodes tab.



• 4. Click on the CONNECT TO NODE button and enter the details that you collected from your Inductor node.
  
  

  Node Node Id *

  The name of the inductor node - you can verify this from the NODE ID entry on the Inductor node's Settings tab (see step 2, above.)

  Node Location Id *

  The reference code that is used to define the inductor node's location -you can verify this from the NODE ID entry on the Inductor node's SETTINGS tab (see step 2, above).

  Node IP Address *

  The IP address of the inductor node server.

  Node Port No *

  The DConE Port number (6444 by default), defined on the inductor node's SETTINGS tab.

  
  When these details are entered, click the SEND CONNECTION REQUEST button. The inductor node will accept the request and add the inductee to its membership. You will need to refresh your browser to see that this has happened..
  




• 5. Go back to step 3 and select one of your remaining inductees. Repeat this process until all the sites that you want to be included in the current membership have been connected to the inductor.

6. Create a Replication Group

SVN MultiSite Plus lets you share specific repositories between selected sites. This is done by creating Replication Groups that contain a list of sites and the specific repositories they will share.

This illustration shows a collection of four sites that are running two replication groups. Replication Group one replicates Repo1 across all four sites, whilst Replication Group 2 replicates repo2 across a subset of sites.

Follow this procedure to create a Replication Group. You can create as many replication groups as you like. However, each repository can only be part of one active replication group at a time.

• 1. Once you have sites defined, click on the REPLICATION GROUPS tab. Then click on the CREATE REPLICATION GROUP button.
  
  

  Create Replication Group

  
  



Local node automatically made the first member
It's not possible to create a replication group remotely - the node on which you are creating the group must itself be an member. For this reason, when creating a replication group, the first node is added automatically.

• 2. Enter a name for your Replication Group in the Replication Group Name field. Then enter an existing Node name in the Add Sites field - any existing sites that match your entry will appear and can be selected with a click. Instead of typing in a name you can click on the drop-down button and choose from a list of existing sites (that are not already members of the new group).
  
  You can select any number of available Sites. Those sites that you select will appear as clickable buttons in the Add Node field.
  

  Enter a name and add some node.



• 3. New sites are added as Active Voters (denoted with "AV"). You can change the type of a node by clicking on its label. For an explanation of what each node type does, view the Reference Section - Node Types
  

  Change node type

  Once you have added all sites and configured their type, click CREATE REPLICATION GROUP to see a groups details.


• 4. Replication Groups that you create will be listed on the REPLICATION GROUPS tab.
  

  Groups boxes, click QUICK VIEW view your options.

7. Add Repositories

Once you have added at least one Replication Group you will be able to add repositories to your node. Here's how:

• 1. Click on the REPOSITORIES tab. Click on the ADD button.
  
  

  Repositories > ADD

• 2. Enter the Repository's name, the file system path (full path to the repository) and use the drop-down to select the replication group. You can set the repository to be Read-only by ticking the Global Ready-only You can deselect this later. Click ADD REPO.
  
  

  Repositories > Enter details then click ADD REPO

• 3. Once added, a repository will appear in a list on the REPOSITORIES tab. The list provides the following details.
  
  

  Repositories listed

  
  

  Name

  The name of the repository - this will be the same as the folder name in the Subversion directory.

  Path

  The full path to the Repository.

  Replication Group

  The Replication Group in which the repository may be replicated.

  Size

  The file size of the repository.

  Youngest Rev

  The youngest (latest) revision in the repository. Comparing the youngest revisions between replicas is a quick test that a repository is in the same state on all sites.

  Last Modified

  The timestamp for the last revision, which provides a quick indicator for the last time a Subversion user made a change.

  Global RO

  Checkbox that indicates whether the repository is globally Read-only, that is Read-only at all sites.

  Local RO

  Checkbox that indicates whether the repository is locally Read-only, that is Read-only to users at this node. The repository receives updates from the replicas on other sites, but never instigates changes itself.

Copyright © 2010-2013 WANdisco plc.
All Rights Reserved

This product is protected by copyright and distributed under licenses restricting copying, distribution and decompilation.

SVN MultiSite Plus
Last doc build: 16:11 - Thursday 20th June 2013