Upgrade Instructions

Upgrading from CloudShark 3.8 to 3.9

CloudShark 3.9.4 has the same feature set as CloudShark 3.8.3 but revamps how our software is downloaded, installed and licensed. The changes made under the hood make licensing much more flexible, installation easier, and managing data on your disk a lot cleaner.

This update is powered by the new QA Cafe Customer Lounge, which has replaced the CloudShark Lounge that served us well over the last 10 years.


Step 1. Accessing the QA Cafe Customer Lounge

The QA Cafe Customer Lounge at lounge.qacafe.com uses passwordless authentication. Enter your email address and a one-time login link will be sent to you. If you need an account, you can request one from the login page.

Where did my licenses go?

The first time you login, you will notice that your "Licenses" tab is empty. Rest assured, your licenses have not been lost or modified. CloudShark 3.9 requires you to re-register your system with us, at which time the permanent license file will be made available again.

Our licensing mechanism has completely changed, and license files from CloudShark 3.8.3 and older are no longer supported in CloudShark. Once you install, you will generate a new host identifier which we will use to register your system.

Before upgrading your 3.8 system, please contact QA Cafe Support to request an upgrade license. One will be provided in the lounge free of charge to allow you to upgrade and test 3.9 on as many systems as necessary.

Step 2. Install or Upgrade CloudShark

To install or upgrade CloudShark, you will need the following:

  • A upgrade license from QA Cafe Support
  • A 3.9.4 installer downloaded from lounge.qacafe.com
  • A CentOS 7 Linux system able to connect to the epel-release repository
Notes

The fully-offline “air gapped” installer is not yet available for CloudShark 3.9. Please let us know if this is required for your deployment.

Currently, CloudShark 3.9.4 only supports CentOS 7. If you require CentOS 8 or RHEL 8 binaries, please contact support for an updated timeline.

Backup Your Current Installation

Important: We recommend taking a backup or snapshot of your VM prior to changing any system configurations or installing or upgrading any software, including CloudShark. Rolling back to a snapshot is the only supported “undo” mechanism.

The Installer

Copy the .run installer and temporary license from the email to your system. The installer is a “makeself” binary that unpacks itself and executes a script. The following options are available:

./cloudshark-installer-v3.9.4.el7.run -- [options]

--license <file> installs your license file for you
--with-threat    installs additional services to run the Threat Assessment add-on.
--upgrade        performs additional upgrade steps and is required if an older
                 version of CloudShark is present on the system.
--no-epel        Skips the installation of the epel-release repository

Note, a double-dash to separate makeself from the install-script’s options is required.

The installer creates a local repository on your disk and installs CloudShark as RPM packages via yum. Additional packages from epel-release are required and will be downloaded from the internet.

A Fresh Installation

To perform a fresh installation on a CentOS 7 system that has never had CloudShark installed, run the following command:

  ./cloudshark-installer-v3.9.4.el7.run -- --license cloudshark-upgrade.lic --with-threat

If you have purchased the Threat Assessment add-on, or would just like to try it out during your migration, include the --with-threat option

Upgrading from CloudShark 3.8

To upgrade an existing CloudShark 3.8 installation on CentOS 7, you must also specify the --upgrade option:

  ./cloudshark-installer-v3.9.4.el7.run -- --license cloudshark-upgrade.lic --with-threat --upgrade

The --upgrade flag will remove all old versions of CloudShark, relocate preferences and configuration files to their new locations, perform a database migration to update file information, and symlink your PCAP data directory to it’s new location.

Custom Certificates

If you have added custom TLS certificates to the nginx config, will need to move the certificate and private key files to the following locations,

  • Certificate: /usr/cloudshark/etc/tls-certificate/cloudshark.crt
  • Private Key: /usr/cloudshark/etc/tls-certificate/cloudshark.key

and restart nginx: systemctl restart nginx

For a more detailed breakdown of the changes please see the bottom of this document.

Accessing CloudShark

CloudShark 3.9 will be running on your system via HTTPS port 443. The default username is “admin” and the password is “cloudshark”. If this was an upgrade, your username and password has not been changed.

Step 3. Registering your system

A temporary license will be supplied by QA Cafe Support to allow you to install and re-install CloudShark as many times as you need to get your system up and running the way you want it. Please take this time to ensure that there are no additional hardware or software changes necessary.

Once your system is stable, you must register it with QA Cafe Support. CloudShark uses our new QA License Application (QALA) which was installed and running on HTTPS port 5050 on your system.

Open your web browser and point it at https://<your-cloudshark-ip>:5050/. (You may need to add a security exception in the browser to allow the self-signed certificate.)

QALA Login Screen

Access is password-protected. Enter: “qacafe”

When you log in, you will see the following screen:

QALA License Screen

Click on the “Register a new license” button to view the registration information. This takes the form of a hexadecimal Host ID.

QALA HostID registration

Please copy and paste the host ID into an email to support@qacafe.com and our staff will register your permanent license. Once they have fulfilled your request, your license will appear on the QA Cafe Lounge and be available to download.

Good news! This license is valid through the end of your MSA or subscription term. It does not need to be modified or updated with each new release of CloudShark.

Step 4. Install your new license

When you have your permanent license, return to QALA on HTTPS port 5050, and click the Upload .lic button. Select your license file, and upload it. Your license count should indicate it was "unchanged" because the production license replaces your temporary upgrade one.

Your new production license will be added to the bottom of the pool. Double-check that the support and expiration dates for your license match your current subscription or MSA terms.

Note: The temporary license will remain in-use and in the pool until CloudShark is restarted:

  systemctl restart cloudshark-full

Double check that CloudShark is using the new license by going to the Appliance SetupSystem Info page.

Congratulations!

You are now setup with the new QA Cafe Lounge, running the latest CloudShark 3.9.4, and ready for all our future releases!


Customized Installations: Upgrade Details

The following is a detailed list of the steps happen during an upgrade. If you have customized your installation, some of these steps may need to be modified. We recommend you contact us to work through your upgrade.

To view the upgrade script, run the installer with the following options:

  ./cloudshark-installer-v3.9.4.el7.run --noexec --keep

The contents of the installer will be extracted to a new directory in the current path. The install.sh and upgrade.sh scripts will give you details about the following steps:

  1. The CloudShark application is stopped
  2. All yum packages matching cloudshark-* are removed along with their dependencies. Local databases remain untouched.
  3. The online cloudshark repo is removed from the yum configuration
  4. A new local repository containing only 3.9.4 is extracted onto your local disk
  5. The epel-release repository is enabled on your system
  6. CloudShark is installed from this local repository while fetching 3rd party dependencies from epel-release via the internet.
  7. Configuration files are copied to their new locations under /usr/cloudshark/etc
  8. Your PCAP upload directory is symlinked to /usr/cloudshark/data
  9. The database-upgrade utility rewrites the path to all the uploaded PCAP files, and inserts the SHA1 sum from the cap_files table. It can be reversed by running ./database-upgrade -reset