Syncplicity Support

Follow

Upgrading the Storage Connector

This documentation describes upgrading the Syncplicity On-premises Storage Connector. Two ways to upgrade are provided:

  • Upgrade storage connector with RPM file
  • Upgrade storage connector with OVA file

You can upgrade each connector server one at a time to maintain uptime. However, when upgrading across multiple minor versions or between major versions, you must upgrade all connector servers at the same time. Thus, an outage during a scheduled maintenance window is necessary. This occurs as you shut down the connector services on all nodes, upgrade all and restart the services on all nodes.

You should be up to date with the latest operating system (OS) version and kernel patches. The following table has the recommended OS versions for the latest releases of the storage connector.

Storage connector version OS version
2.10.2.3 CentOS 6.9
2.12.1.0 (OVA only) CentOS 7.3

For information about new features and supported platforms see the release notes at http://www.syncplicity.com/xStorageVaultReleaseNotes.

Upgrade storage connector with RPM file

The following topic describes upgrading instances of the Syncplicity On-premises Storage Connector using a Red Hat Package Manager (RPM) file.

About upgrading

Rolling upgrades are supported when upgrading between sequential minor versions. Configuration settings remain the same across all storage connector servers.

Upgrades using the RPM file preserve the existing configuration on the current storage connector server. Check the release notes for updates about new or updated configuration settings to get the most out of your connector or assist in troubleshooting.

Before upgrading

Use this procedure to prepare for upgrading.

  1. Download the latest version of the storage connector RPM file. Log on to each connector server using an SSH client and type the following command:

    wget https://download.syncplicity.com/storage-connector/syncp-storage.noarch.rpm

  2. Do the following to take a virtual machine (VM) snapshot of each storage connector server. Do this for each server you plan to upgrade.

    Connect to your VMware ESXi server using VMware vSphere Client, select the VM of the storage connector you plan to upgrade, and shut down the VM. The task is illustrated in the following graphic of the user interface.

    rpm_upgrade_1.png

    Right-click the VM in the grid. Select Snapshot > Take Snapshot.

    rpm_upgrade_2.png

    Add a name and description and click OK.

    rpm_upgrade_3.png

  3. Check the version of the storage connector to determine whether you can perform a rolling upgrade. Rolling upgrades are recommended only when upgrading between consecutive minor versions. To see the version running on your connector server, type the following command:

    rpm –qa | grep syncp-storage

    This displays the RPM package name and version. For example, the following is returned for version 2.9.0.3:

    syncp-storage-2.9.0.3-1.noarch

Upgrade steps

Use this procedure to upgrade each storage connector server. The steps are based on CentOS 6.9.

  1. Stop the connector service by typing the following command:

    sudo service syncp-storage stop

  2. Type the following command to upgrade the connector:

    sudo yum update syncp-storage.noarch.rpm

  3. Type the following command to start the service:

    sudo service syncp-storage start

Upgrade verification

Once you have upgraded all servers, verify whether each is functioning correctly.

  1. Type the following command to confirm the connector version is correct:

    rpm –qa | grep syncp-storage

    The RPM package name and version is displayed. For example, the following is returned for version 2.10.2.3:

    syncp-storage-2.10.2.3-1.noarch

  2. Type the following command to confirm the connector is running correctly:

    sudo service syncp-storage status

    The following message is displayed when the service is running correctly:

    rpm_upgrade_4.png

  3. Type the following URL in a browser to confirm the connector service is accessible from the network:

    http://<hostname_or_IP_address_of_storage_connector_server>:9000/ping

    However, if you have an SSL certificate configured on the connector server, use the following URL instead:

    https://<hostname_or_IP_address_of_storage_connector_server >:9443/ping

    The following message is displayed in the browser if the service is accessible:

    rpm_upgrade_5.png
    If you cannot use a browser, type the following command:

    curl http://<storage_connector_host_or_IP>:9000/ping

    The following message is displayed if the service is accessible:

    pong

Upgrade storage connector with OVA file

The following topic describes upgrading instances of the Syncplicity On-premises Storage Connector using the Open Virtualization Archive (OVA) file. This covers the most common case of upgrading from a storage connector server running CentOS 6 to the new OVA running CentOS 7.3.

About upgrading

Upgrades using the OVA provides all necessary software pre-packaged and tested, the latest operating system version and security patches, and the latest features and configuration options. Check the release notes for updates about new or updated configuration settings to get the most out of your connector or to assist in troubleshooting.

Before upgrading

Use this procedure to prepare for upgrading.

  1. Download the latest version of the OVA from the following URL:

    http://www.syncplicity.com/xStorageVaultConnectorOVFDownload

  2. Log on to the storage connector server to upgrade and save copies of the following files:

    /etc/sysconfig/network-scripts/ifcfg-eth0
    /etc/sysconfig/network
    /etc/resolv.conf
    /etc/fstab
    /etc/ntp.conf
    /etc/syncp-storage/syncp-storage.conf
    /etc/syncp-storage/logger.xml

    If you are using StorageVault Authentication (SVA), also save copies of the following files:

    /etc/syncp/idpcert.pem. Location may be different. Check the syncplicity.storageVaultAuthentication.saml.idpCertFile setting in the syncp-storage.conf file.

    syncp-storage.key. Location is specified by the syncplicity.storageVaultAuthentication.key.file setting in the syncp-storage.conf file.

    The following graphic is an example of a config file.

    ova_upgrade_1.png

    If you have configured SSL on the connector, also save copies of the following files:

    Server public key certificate. For example, Storage_Connector _node.pem

    Server private key. For example, Storage_Connector _node.key

    your_company_jks_file.com.jks. This file contains a certificate that belongs to your company. It has a unique name that was created when you first deployed the connector. You can find this file in the /etc/syncp-storage/ directory on the old connector server.

    The public key certificate and private key might be in a single PEM file.

  3. If your current Storage Connector password does not meet the following requirements, create one that complies, as it is required in the new OVA.

    At least 14 characters.
    At least one of each of the four character types: lowercase letters, uppercase letters, numbers and symbols.
    Cannot reuse the last 5 passwords.
    At least 5 characters different than the previous password.

Provision virtual machine

Use this procedure for each storage connector you are upgrading.

  1. Connect to your VMware ESXi server using VMware vSphere Client.

    ova_upgrade_2.png

  2. Select File > Deploy OVF Template to initiate the process.

    ova_upgrade_3.png

  3. Browse to the OVA file you downloaded earlier.

    ova_upgrade_4.png

  4. Accept the EULA.

    ova_upgrade_5.png

  5. Create a name for the deployed template.

    ova_upgrade_6.png

  6. Select the destination storage for the virtual machine.

    ova_upgrade_7.png

  7. Configure the amount of memory, CPU cores, and disk space to allocate to the VM Each VM must have 8GB of RAM, 8 virtual cores (Intel Xeon E5 Family processors, 2.20 GHz) and a minimum of a 50GB HDD.

    ova_upgrade_8.png
     
  8. Start the deployed storage connector VM.

    ova_upgrade_9.png

  9. Select the deployed VM, open the Summary tab and click Power On.

    ova_upgrade_10.png

  10. Open the Console tab and wait for CentOS to start.

    ova_upgrade_11.png

  11. Log on to the VM and change the default password for the syncp user. An administrative account with sudo privileges called syncp has already been created in the VM. The initial password is onprem. After loggin on, change the password to the new password you already determined or reuse your existing password. You can do this with the passwd command.

Migrate OS settings

Use this procedure to migrate OS settings. The steps are based on CentOS 7.3. Do this on each storage connector server OVA deployed as an upgrade for an existing connector. Migrated values are taken from copies of the files you made for the old connector VM and applied to the new connector VM.

The procedure assumes you are re-using the IP address and host name from the old storage connector VM. If you are allocating a new IP address or host name or both for the upgraded connector VM, use the new information in the relevant IP and host name fields.

If you are running at least two storage connectors against your storage vault, as Syncplicity recommends, best practice is to upgrade one at a time, leaving at least one connector running always.

  1. If you are reusing the old IP address and host name for the new storage connector VM, shut down the old storage connector.

  2. Copy the following lines from /etc/sysconfig/network-scripts/ifcfg-eth0:

    BOOTPRO=static
    IPADDR=<static-ip-address-for-this-server>
    NETMASK=<network-mask>
    GATEWAY=<gateway_ip_address>
    BROADCAST=<broadcast_ip_address>

    Note: The default interface is eth0. If you have configured a different network interface (such as eth1) then be sure to copy the lines above from that ifcfg-eth1 file. Check your system to verify which network interface is in use. The remaining examples all assume the default network interface of eth0.

    GATEWAY and BROADCAST may not be present based on older versions of the connector. If so, you must determine the GATEWAY and BROADCAST for your IP address. Once determined, add them in the ifcfg-eth0 file for the new connector VM.

  3. Copy the following lines from /etc/sysconfig/network:

    NETWORKING=yes
    NETWORKING_IPV6=yes
    HOSTNAME=<hostname>
    DOMAINNAME=<domainname>
    GATEWAY=<gateway_ip_address>

  4. Replace the entire /etc/resolv.conf file.

    The following graphic shows the resolv.conf file for the old and new VMs.

    ova_upgrade_12.png

  5. If you have configured custom servers for time synchronization in /etc/ntp.conf, copy, the configuration to /etc/chrony.conf and restart chrony by typing the following command:

    sudo systemctl restart chronyd

  6. If the storage connectors are behind a load balancer, as Syncplicity recommends, and you have allocated a new IP address for your upgraded connector, add the new IP address to the load balancer configuration. If you are re-using the IP address from the old connector, no changes to the load balancer are required.

  7. If you have configured SSL between the load balancer and the storage connector, or you are not off-loading SSL to a load balancer, copy the SSL certificate from the old connector and change some configuration settings.

    • Create an https.properties file at /etc/syncp-storage by typing the following commands:

      cd /etc/syncp-storage
      vi https.properties

    • Within the vi editor, add the following lines to the https.properties file:

      enable:true
      port:9443
      keystore: /etc/syncp-storage/your_company_jks_file.com.jks
      storepassword:changeit

    • Note the following custom values are different than the preceding example:

      /etc/syncp-storage/your_company_jks_file.com.jks contains a certificate that belongs to your company and has a file name specific to your company. This file should be copied from old the storage connector if it is there.

      changeit is a placeholder for your specific password.

    • Run the python script at /etc/syncp-storage/syncp-storage-https-configuration.py by typing the following command:

      python /etc/syncp-storage/syncp-storage-https-configuration.py

      You should see the following output:

      Configured http/https for syncp-storage service. Please restart syncp-storage service to apply the changes.

    • Verify the /usr/bin/syncp-storage file has the same settings for https port (9443) and keystore as in the https.properties file.

      port:9443
      keystore: /etc/syncp-storage/your_company_jks_file.com.jks

    • Ensure the location of the keystore file has the correct access permissions (600) for the syncp-storage user by typing the following command:

      sudo chmod 600 /etc/syncp-storage/your_company_jks_file.com.jks

    • If the old connector used port 433 instead of port 9443, redirect ports by typing the following command:

      iptables -t nat -A PREROUTING -i eth0 -p tcp --dport 443 -j REDIRECT --to-port 9443

    • Restart the connector service by typing the following command:

      sudo service syncp-storage restart

Migrate NFS storage settings

Use this procedure to migrate Network File System (NFS) storage settings. Do this on each storage connector server OVA deployed as an upgrade for an existing connector. Migrated values are taken from copies of the files you made from the old storage connector VM and applied to the new connector VM.

  1. Create the storage mountpoint directory on the old storage connector. This storage mountpoint is specified in the /etc/syncp-storage/syncp-storage.conf file. For example, to create the storage mountpoint “/mnt/syncp”, type the following command:

    mkdir /mnt/syncp

  2. Set the correct permissions for the mountpoint by typing the following command:

    sudo chmod 777 /mnt/syncp

  3. Set the ownership of the mountpoint by typing the following commands:

    sudo chown -R syncp-storage:syncp-storage /mnt/syncp

  4. Make the storage mountpoint immutable by typing the following command:

    chattr +i /mnt/syncp

  5. Copy the line for your storage mountpoint from the /etc/fstab file taken from the old storage connector VM to /etc/fstab.

  6. Mount the storage to the storage mountpoint by typing the following command:

    mount –a

Migrate storage connector settings

Use this procedure to migrate storage connector settings. Do this on each storage connector server OVA deployed as an upgrade for an existing connector. Migrated values are taken from copies of the files you made from the old connector VM and applied to the new connector VM.

  1. Copy the values in the following table from the /etc/syncp-storage/syncp-storage.conf file copied from the old connector. Not all these values are in your version of the file. This depends on the features you use and the settings you changed.

    Section Value Required
    Access key syncplicity.ws.accesskey Yes
    Storage syncplicity.storage.* Yes

    XML

    syncplicity.ws.url No
    (see note)
    Proxy syncplicity.ws.proxy.* No
    Compression syncplicity.storage.compression No
    Encryption syncplicity.storage.encryption No
    Cleanup syncplicity.cleanup.* No
    API portal syncplicity.ws.external.url No
    Health server syncplicity.health.* No
    SVA syncplicity.storageVaultAuthentication.* No
    RM proxy syncplicity.irm.proxy.* No
    /version API syncplicity.versionPage.enabled No

    Note. This field is required if your account is not based in the US PrivacyRegion.

    The following graphic is a sample /etc/syncp-storage/syncp-storage.conf file.

    ova_upgrade_13.png

  2.  Do not copy the settings for computeIO-context.*, as these are configured for the JVM and tuned for the particular version of the connector.

  3.  If you have customized the log settings, copy the lines containing the following values from the /etc/syncp-storage/logger.xml file you copied from the old connector. These settings are optional.

    <fileNamePattern>
    <maxHistory>
    <logger name="application" level="INFO" />

  4.  If you are using SVA, copy the syncp-storage.key and idpcert.pem files to the new connector VM in the same location specified in the syncp-storage.conf file. The following graphic is an example of the syncp-storage.conf file SVA configuration settings.

    ova_upgrade_14.png

Complete the upgrade

Use this procedure to complete the upgrade once all settings have been migrated. You shut down the service on the old VM and start the service on the new VM. Do this for each connector being upgraded.

  1. If you have allocated a new IP address and host name to the new connector VM, log on to the old connector VM using the syncp user and stop the service by typing the following command:

    sudo service syncp-storage stop

  2. Log on to the new connector VM using the syncp user and start the service by typing the following command:

    sudo systemctl restart syncp-storage

Verify the upgrade

Once you have upgraded all servers, verify the upgraded connectors are functioning correctly. Do this on each server.

  1. Confirm the storage connector version is correct by typing the following command:

    rpm –qa | grep syncp-storage

    The RPM package name with the version is displayed. For example, the following is the output for version 2.12.1.0:

    syncp-storage-2.12.1.0-1.noarch

  2. Confirm the connector is running correctly by typing the following command:

    sudo service syncp-storage status

    The following message is displayed if running correctly:

    ova_upgrade_15.png

  3. Confirm the connector service is accessible from the network by typing the following URL in a browser:

    http://<hostname_or_IP_address_of_storage_connector_server>:9000/ping

    However, if you have an SSL certificate configured on the server, use the following URL in your browser:

    https://<hostname_or_IP_address_of_storage_connector_server >:9443/ping

    The following message is displayed if the service is accessible:

    ova_upgrade_16.png

    If you cannot use a browser, type the following command:

    curl http://<storage_connector_host_or_IP>:9000/ping

    The following message is displayed if the service is accessible:

    pong
Powered by Zendesk