.. Reminder for header structure: Parts (H1) : #################### with overline Chapters (H2) : ******************** with overline Sections (H3) : ==================== Subsections (H4) : -------------------- Subsubsections (H5) : ^^^^^^^^^^^^^^^^^^^^ Paragraphs (H6) : """""""""""""""""""" .. meta:: :description: Upgrading the WAPT Server :keywords: WAPT, upgrade, upgrading, documentation .. |ok| image:: wapt-resources/icon-ok.png :scale: 5% :alt: Feature available .. |nok| image:: wapt-resources/icon-nok.png :scale: 5% :alt: Feature not available .. |date| date:: .. _upgrade-wapt: ################### Upgrade WAPT Server ################### If your WAPT Server is a virtual host, take a snapshot of the VM. This way, you will be able to go back easily in the rare case that the update fails. .. attention:: After each WAPT Server update, update your :ref:`WAPT Console `, then :ref:`regenerate ` the WAPT Agent. Before upgrading WAPT Server, please refer to the following upgrading compatibility chart: .. list-table:: Available WAPT Upgrade paths :header-rows: 1 :stub-columns: 1 :widths: auto :align: center * - \ - To WAPT |wapt_short_version| * - From WAPT 1.8.2 - |ok| * - From WAPT 2.0 - |ok| * - From WAPT 2.1 - |ok| * - From WAPT 2.2 - |ok| * - From WAPT 2.3 - |ok| * - From WAPT 2.4 - |ok| .. warning:: If upgrading from a version older than WAPT 2.1, the :ref:`licence activation ` process has changed. ************************************************************ Switching of WAPT Edition (Community, Discovery, Enterprise) ************************************************************ WAPT Community is no longer supported. If you want to upgrade from WAPT 1.8.2 Community you can upgrade to WAPT Discovery or WAPT Enterprise. Please note that WAPT Discovery is limited to 300 clients. To upgrade from a WAPT Community setup to WAPT Discovery or Enterprise follow the standard :ref:`1.8.2 to 2.5 upgrade documentation `. The WAPT Server will make the appropriate changes. To upgrade WAPT Discovery to WAPT Enterprise simply upload a valid :ref:`licence ` to the WAPT Server from the WAPT Console. If your Enteprise licence expire, it will fall back on the Discovery Edition. If you are running WAPT Discovery and you have more that 300 client computers in your inventory, the WAPT Console will stop working and will only give you the option to delete computer entries from the inventory. The WAPT Console will return to working condition when the inventory returns below the 300 computer limit. .. comment ############################################################################################ .. comment # UPGRADE 2.5 TO LATEST .. comment ############################################################################################ .. _wapt_minor_upgrade: ************* Minor upgrade ************* Upgrading from version 2.5 to latest 2.5 ======================================== .. _wapt_minor_upgrade_25_25: To do a minor upgrade please follow the procedure corresponding to your server operating system. .. attention:: Due to a bug in the check of signature of waptsetup during upgrade from wapt 2.5.3 to latest 2.5.4 version, it is necessary to download the waptsetup.exe file throught a webbrower and install it locally. Please use the corresponding button in the waptconsole when seeing the popup below. It is not necessary for upgrade from wapt 2.5.4 to later version. .. image:: wapt-resources/download_waptsetup_upgrade_signature_bug.png :align: center :alt: Screen capture of the WAPT Console showing the "Open the download url of the waptsetup in the brower" button .. attention:: If you use WAPT Deploy in a GPO, when upgrading from WAPT 2.5.3 or lower, you need to update your GPO with the lastest :command:`waptdeploy.exe` binary. .. tabs:: .. tab:: Debian and derivatives * Update the underlying distribution and upgrade WAPT Server. .. code-block:: bash export DEBIAN_FRONTEND=noninteractive apt update && apt upgrade -y apt install tis-waptserver tis-waptsetup -y unset DEBIAN_FRONTEND * Launch the post-configuration step :ref:`post-configuration step ` * Once completed, your WAPT Server is ready. .. tab:: RedHat and derivatives * Update the underlying distribution and upgrade WAPT Server. .. code-block:: bash yum update -y yum install tis-waptserver tis-waptsetup -y * Launch the post-configuration step :ref:`post-configuration step ` * Once completed, your WAPT Server is ready. .. tab:: Windows * Download and execute :download:`waptserversetup.exe `. .. attention:: The installation of the WAPT Server **MUST** be done using a **Local Administrator** account on the host * Choose the language for the WAPT installer. .. image:: wapt-resources/wapt_deploy_choose-language_dialog-box.png :align: center :alt: Choosing the language for deploying the WAPT installer * Click on :guilabel:`OK` to go on to the next step. .. image:: wapt-resources/wapt_deploy_accept-license_dialog-box.png :align: center :alt: Accepting the WAPT license terms * Accept the licence terms and click on :guilabel:`Next` to go to next step. * Choose additional configuration tasks (leave the default if not sure). .. figure:: wapt-resources/wapt_deploy_additional-configuration-server_dialog-box.png :align: center :alt: Choosing the installer options for deploying the WAPT Serer Choosing the installer options for deploying the WAPT Server * Do not change the password for the WAPT Server (if not necessary). .. image:: wapt-resources/wapt_deploy_choosing-password_dialog-box.png :align: center :alt: Dialog box for changing the password * Click on the :guilabel:`Install` to launch the installation, wait for the installation to complete. .. image:: wapt-resources/wapt_deploy_installation-in-progress_dialog-box.png :align: center :alt: Dialog box showing the WAPT installation in progress * Click on :guilabel:`Finish` to close the window. .. image:: wapt-resources/wapt_deploy_installation-completed_dialog-box.png :align: center :alt: Installation has finished * Once completed, your WAPT Server is ready. .. comment ############################################################################################ .. comment # UPGRADE 2.x TO LATEST .. comment ############################################################################################ Upgrading from version 2.x to 2.5 ================================= .. _wapt_minor_upgrade_2x_lastest: .. Note:: Before upgrading, ensure that :ref:`installation requirements ` are met. WAPT |wapt_short_version| needs PostgreSQL 10 or above. If you have upgraded from an older Debian or Ubuntu version with PostgreSQL 9.6, be sure to follow the OS documentation to upgrade PostgreSQL to its latest version. If you are using WAPT WADS, please note that WAPT 2.x WADS WinPE and WAPT 2.5 WADS WinPE are not compatible. You need to recreate the :file:`WinPE` File using the :guilabel:`upload WinPE` button in the :guilabel:`OS Deployment` tab. If you use WAPT Deploy in a GPO, then you need to update your GPO with the lastest :command:`waptdeploy.exe` binary. .. attention:: The websocket protocol having changed between versions 2.X and 2.5, WAPT Agents will appear as *DISCONNECTED* until they have upgraded to version 2.5. The WAPT Agent upgrade task may be delayed for up to 2 hours. To insure that the WAPT Agent upgrade task happens in the shortest delay, the most recent waptupgrade package must be deployed using your WAPT 2.5 Console or using a GPO. The waptupgrade package contains a configuration that will trigger the forced installation of the newest WAPT Agent. So make sure that you tick the :guilabel:`Install waptupgrade package as soon as agent sees it` checkbox, as in the screen capture below. .. image:: wapt-resources/wapt_console_generate-agent-force-install.png :align: center :alt: Screen capture of the WAPT Console showing the "Install waptupgrade package as soon as agent sees it" checkbox .. attention:: The WAPT Server 2.5 is using client SSL authentication to authenticate the client WAPT Agents. Thus it is required for the WAPT Server to do the TLS termination itself. The use of WAF or reverse proxy that do TLS interception and terminaison is thus not supported. It is possible to use a reverse proxy in "stream" mode if supported, like in `Nginx stream module `_ or `HAProxy TLS Passthrough module `_. Please refer to the corresponding documentation for details. .. attention:: After upgrading the WAPT Server from 2.x to 2.5, you MUST upgrade the WAPT Console / WAPT Agent on the administation computer right after. If the WAPT console has NOT YET been upgraded, it will show a licence error message on startup because it won't be able to check the licence. You can ignore the licence message if you have not yet upgraded the WAPT Console. The console will switch to Discovery Edition, and switch back to Enterprise Edition once it has been upgraded. Note : if you try to re-upload the licence BEFORE upgrading to 2.5, it will fail also. .. attention:: Due to a bug in the check of signature of waptsetup during upgrade from wapt 2.5.3 or lower or wapt 2.4.0 or lower to latest 2.5.4 version, it is necessary to download the waptsetup.exe file throught a webbrower and install it locally. Please use the corresponding button in the waptconsole when seeing the popup below. .. image:: wapt-resources/download_waptsetup_upgrade_signature_bug.png :align: center :alt: Screen capture of the WAPT Console showing the "Open the download url of the waptsetup in the brower" button .. tabs:: .. tab:: Debian and derivatives * First of all, update the underlying distribution and install the WAPT Server packages. .. code-block:: bash apt update && apt upgrade -y apt install apt-transport-https lsb-release gnupg * Then update the package repository and import the :mimetype:`GPG` key from the repository. .. code-block:: bash :substitutions: wget -O - https://wapt.tranquil.it/$(lsb_release -is)/tiswapt-pub.gpg | apt-key add - echo "deb https://wapt.tranquil.it/$(lsb_release -is)/wapt-|wapt_short_version|/ $(lsb_release -c -s) main" > /etc/apt/sources.list.d/wapt.list * Update the repository and install the packages. .. code-block:: bash export DEBIAN_FRONTEND=noninteractive apt update apt install tis-waptserver tis-waptsetup -y unset DEBIAN_FRONTEND * Launch the post-configuration step :ref:`post-configuration step `. .. tab:: RedHat and derivatives * First of all, update the underlying distribution and necessary packages. .. code-block:: bash yum update -y yum install epel-release redhat-lsb-core -y * Then update the package repository and import the :mimetype:`GPG` key from the repository. .. code-block:: bash :substitutions: RH_VERSION=$(cat /etc/system-release-cpe | awk -F: '{ print $5}') cat > /etc/yum.repos.d/wapt.repo <`. .. tab:: Windows * Download and execute |waptserversetup_exe|. * Choose the language for the WAPT installer. .. image:: wapt-resources/wapt_deploy_choose-language_dialog-box.png :align: center :alt: Choosing the language for deploying the WAPT installer * Click on :guilabel:`OK` to go on to the next step. .. image:: wapt-resources/wapt_deploy_accept-license_dialog-box.png :align: center :alt: Accepting the WAPT license terms * Accept the licence terms and click on :guilabel:`Next` to go to next step. * If an old installation installation folder found, this message appear. Click on :guilabel:`Yes` to go on to the next step. .. image:: wapt-resources/wapt_deploy_folder-exist_dialog-box :align: center :alt: Dialog box warning about the obsolete WAPT destination folder * Select additional task if needed. .. figure:: wapt-resources/wapt_deploy_additional-configuration-server_dialog-box.png :align: center :alt: Choosing the installer options for deploying the WAPT Serer Choosing the installer options for deploying the WAPT Server * Change the WAPT Server password if needed, then press :guilabel:`Next`. .. image:: wapt-resources/wapt_deploy_choosing-password_dialog-box.png :align: center :alt: Dialog box for changing the password * Click on the :guilabel:`Install` to launch the installation, wait for the installation to complete. .. image:: wapt-resources/wapt_deploy_installation-in-progress_dialog-box.png :align: center :alt: Dialog box showing the WAPT installation in progress * Click on :guilabel:`Finish` to close the window. .. image:: wapt-resources/wapt_deploy_installation-completed_dialog-box.png :align: center :alt: Installation has finished .. attention:: **DO NOT** use the WAPT Console on the WAPT Server. **DO NOT** install nor run your WAPT package development tools on the WAPT Server. The WAPT Server on your Windows server or workstation is ready. .. figure:: wapt-resources/wapt_server_web-interface_browser-window.png :align: center :alt: The WAPT Server interface in a web browser The WAPT Server interface in a web browser Your WAPT Server is now ready. You may now go to the documentation on :ref:`Installing the WAPT management Console `. *********************************** Upgrading from version 1.8.2 to 2.5 *********************************** .. _wapt_major_upgrade_182_latest: The changement between WAPT 1.8.2 (**not possible from a older version, please upgrade to 1.8.2 beforehand**) and |wapt_short_version| are numerous. First of all, 1.8.2 was in Python2, we changed to Python3. A lot of new features are available too (essentially in Enterprise version). Before upgrading ================ Ensure that :ref:`installation requirements ` are met. Backup your WAPT Private and Public certificates used to deploy your WAPTAgent and packages. Usually, it is located in :file:`C:\\private` on your computer where the WAPT Console is set. If you do not remember what this key is please refer to the documentation on :ref:`generating the Administrator's certificate for signing WAPT packages `. In this documentation, your WAPT certificate's name will be **wapt-private.crt**. Upgrading ========= .. tabs:: .. tab:: Debian and derivatives .. Note:: If you are running on Debian9 Stretch, you have first to upgrade to Debian10 or Debian11 before upgrading to WAPT 2.x. **The WAPT Server 2.x is not available for Debian9**. It is even recommended to upgrade to Debian 11 Bullseye. In this case, upgrade from Debian 9 => Debian 10 => Debian 11. * First of all, update the underlying distribution and install the WAPT Server packages. .. code-block:: bash apt update && apt upgrade -y apt install apt-transport-https lsb-release gnupg * Then update the package repository and import the :mimetype:`GPG` key from the repository. .. code-block:: bash :substitutions: wget -O - https://wapt.tranquil.it/$(lsb_release -is)/tiswapt-pub.gpg | apt-key add - echo "deb https://wapt.tranquil.it/$(lsb_release -is)/wapt-|wapt_short_version|/ $(lsb_release -c -s) main" > /etc/apt/sources.list.d/wapt.list * Update the repository and install the packages. .. code-block:: bash export DEBIAN_FRONTEND=noninteractive apt update apt install tis-waptserver tis-waptsetup -y unset DEBIAN_FRONTEND * Launch the post-configuration step :ref:`post-configuration step `. .. tab:: RedHat and derivatives * First of all, update the underlying distribution and necessary packages. .. code-block:: bash yum update -y yum install epel-release -y * Then update the package repository and import the :mimetype:`GPG` key from the repository. .. code-block:: bash :substitutions: RH_VERSION=$(cat /etc/system-release-cpe | awk -F: '{ print $5}') cat > /etc/yum.repos.d/wapt.repo <`. .. tab:: Windows * Download and execute |waptserversetup_exe|. * Choose the language for the WAPT installer. .. image:: wapt-resources/wapt_deploy_choose-language_dialog-box.png :align: center :alt: Choosing the language for deploying the WAPT installer * Click on :guilabel:`OK` to go on to the next step. .. image:: wapt-resources/wapt_deploy_accept-license_dialog-box.png :align: center :alt: Accepting the WAPT license terms * Accept the licence terms and click on :guilabel:`Next` to go to next step. * If an old folder installation is found, this message appears. Click on :guilabel:`Yes` to go on to the next step. .. image:: wapt-resources/wapt_deploy_folder-exist_dialog-box :align: center :alt: Dialog box warning about the obsolete WAPT destination folder * Select additional task if needed. .. figure:: wapt-resources/wapt_deploy_additional-configuration-server_dialog-box.png :align: center :alt: Choosing the installer options for deploying the WAPT Serer Choosing the installer options for deploying the WAPT Server * Change the WAPT Server password if needed, then press :guilabel:`Next`. .. image:: wapt-resources/wapt_deploy_choosing-password_dialog-box.png :align: center :alt: Dialog box for changing the password * Click on the :guilabel:`Install` to launch the installation, wait for the installation to complete. .. image:: wapt-resources/wapt_deploy_installation-in-progress_dialog-box.png :align: center :alt: Dialog box showing the WAPT installation in progress * Click on :guilabel:`Finish` to close the window. .. image:: wapt-resources/wapt_deploy_installation-completed_dialog-box.png :align: center :alt: Installation has finished .. figure:: wapt-resources/wapt_server_web-interface_browser-window.png :align: center :alt: The WAPT Server interface in a web browser The WAPT Server interface in a web browser The WAPT Server on your Windows server or workstation is ready. .. attention:: **DO NOT** use the WAPT Console on the WAPT Server. **DO NOT** install nor run your WAPT package development tools on the WAPT Server. Your WAPT Server is now ready. .. include:: wapt-console.inc.rst .. danger:: After the upgrade, please be sure your certificate (in this documentation **wapt-private.crt**) is still present at your WAPT install location : :file:`C:\\Program File (x86)\\wapt\\ssl` Since you come from WAPT 1.8.2 which was in python2, you will have to re-sign all your WAPT Packages :ref:`using the WAPT Console `, or :ref:`using the command line ` (**only if you encounter package size issue with the WAPT Console way**). .. _re_sign_package_gui: .. _re_sign_host_package: Re-signing Host packages ======================== This method for re-signing all host packages is useful when the underlying cryptographic method or library changes, as this is the case when upgrading from WAPT 1.8.2 (Python 2.7 based) to WAPT >= 2.0 (Python 3.x based). Use the Administrator's certificate for re-signing packages. * Select all host. * Right-click on the selected hosts. .. image:: wapt-resources/wapt_console_host-configuration_menu-list.png :align: center :alt: Host configuration menu list in the WAPT Console * Select :guilabel:`Re-sign Host packages`. * Confirm re-signing the selected hosts. .. figure:: wapt-resources/wapt_console_host-resign_dialog-box.png :align: center :alt: Modal window for confirming re-signing the selection of hosts Modal window for confirming re-signing the selection of hosts * Then, enter your private key password. .. figure:: wapt-resources/wapt_console_enter-certificate-password_dialog-box.png :align: center :alt: Entering the password for unlocking the private key in the WAPT Console Entering the password for unlocking the private key in the WAPT Console * The selected WAPT *host* packages are now all re-signed using the new cryptographic method required with Python3. Re-signing other types of WAPT package ====================================== * Open the repositories in your WAPT Console. .. figure:: wapt-resources/wapt_console_packages_imported-in-repository_container-window.png :align: center :alt: Window showing the repositories available on the WAPT Console Window showing the repositories available on the WAPT Console * Select all packages in the repository, then right-click on the selection. .. figure:: wapt-resources/wapt_console_packages_menu-list.png :align: center :alt: Menu options for repositories Menu options for repositories * Select :guilabel:`Re-sign packages`. * To launch the signature process, click on :guilabel:`Re-sign packages`. .. figure:: wapt-resources/wapt_console_packages-resign_container-window.png :align: center :alt: Window for re-signing WAPT packages Window for re-signing WAPT packages * After processing, which may take some time, all WAPT packages will have been re-signed. .. figure:: wapt-resources/wapt_console_package-resign-ok_screen-item.png :align: center :alt: Signature processing has ended successfully Signature processing has ended successfully .. attention:: .. image:: wapt-resources/wapt_console_package-resign-error_screen-item.png :align: center :alt: Signature processing has not ended successfully If the error **Access violation** appear it may mean that the WAPT package is too big. You can re-sign this packages :ref:`using the command line `. And if it is still not working, you can manually edit the package and visit :ref:`this procedure for signing large WAPT packages `.