Skip to main content

Upgrade Hubble Web Server

Prerequisites

Your web servers will need to match the following prerequisites as they did during the initial installation. There can be small changes to the prerequisites (i.e. a required windows patch), but nothing that has a large impact unless upgrading to a new major version. Note that these requirements will be tested by the Hubble Web Server installer and the upgrade will not proceed until they are all met.

Elevated Permissions

Administrator privileges/elevated permissions are required for the user installing Hubble Web on the Windows web server machine as the deployment package, which installs Chef and deploys installation files, requires permission from an Administrator or Administrator user to install on a machine.

Elevated permissions are also required to run the batch file (run.bat, located within the Chef directory), as Chef will check during the configuration of Hubble Web whether or not the correct Windows features are installed, and this check (and any required installs), requires Administrator level permissions.

Anti-Virus/Anti-Malware Software

Any installed and running anti-virus/anti-malware software will need to be temporarily disabled before installing Chef via the deployment package and then configuring Chef via the batch file. The reason for this is that during the checks of installed Windows features, any automatic scan being performed by the anti-virus/anti-malware software will slow down theses checks and the configuration of Hubble Web due to the amount memory being used by the process.

Once configuration is complete and Hubble Web is installed on the windows web server, the anti-virus/ anti-malware software can be enabled again and if necessary a scan of the machine can then be performed to make sure nothing untoward is present.

Add Roles and Features

Below are the Roles and Features that need to be installed as a minimum before Hubble Web can be installed on the Windows machine:

SERVER ROLES  

  • Web Server (IIS)

    • Web Server
      • Common HTTP Features
        • Default Document
        • Directory Browsing
        • HTTP Errors
        • Static Content
      • Health and Diagnostics
        • HTTP Logging
        • Request Monitor
      • Performance
        • Static Content Compression
        • Dynamic Content Compression
      • Security
        • Request Filtering
      • Application Development
        • .NET Extensibility 3.5
        • .NET Extensibility 4.5
        • ASP.NET 3.5
        • ASP.NET 4.5
        • CGI
        • ISAPI Extensions
        • ISAPI Filters
    • Management Tools
      • IIS Management Console
      • Management Service

    • FEATURES

  • .NET Framework 3.5 Features

    • .NET Framework 3.5 (includes .NET 2.0 and 3.0)

  • .NET Framework 4.8 Features

    • .NET Framework 4.8 (pre-installed in Windows Server)

    • ASP.NET 4.5

  • Windows PowerShell

    • Windows PowerShell 4.0 (pre-installed in Windows Server)

    • Windows PowerShell 2.0 Engine

    • Windows PowerShell ISE

When installing the above Windows features, it is likely that the web server feature will not have been installed yet, meaning that the Server Roles features will require configuration in the Add Roles and Features Wizard, as follows:

  1. In the Add Roles and Features Wizard, when you enter the Features part of the Wizard, the screen below is displayed.

    Install the IIS Management Console by leaving the Include management tools (if applicable)

    checkbox ticked. Then click on Add Features.


  2. The screen below is then displayed (note that the Web Server Role (IIS) heading will have been added to the list of parts of the wizard on the left of the screen under Features). Click Role Services.

  4. The screen then displays the list of role services. Check the checkboxes for the required role services. The minimum required services are listed at the beginning of this topic.
  5. Once all roles and features are selected, install them (either through download from Microsoft or from provided windows files).

Internet Access

Internet access may be required when installing the Windows features above, if they require downloading from Microsoft, or when installing Windows updates. If a proxy is required to access the internet, this will need be configured on the web server. Once Hubble deployment has finished, internet access can be removed again.

Windows Updates

After the minimum Microsoft components and minimum roles and features have been installed as described above, all Windows updates will need to be installed, as updates to the .NET Framework are required, including .NET Framework 4.5.2.

Minimum Microsoft Components Required

As well as the Roles and Features required, there are some additional Microsoft Components which need to be installed before Hubble Web can be accessed successfully. After all the available Windows updates are installed, please check whether the following are installed, and install them manually if not:

Run the Hubble Web Installer

  1. In order to install Hubble Web, you must log into the Windows server machine as an Administrator or as a user that has Administrator rights.
  2. Copy the installation file to the Windows server, either into a new directory or to the Downloads directory as required. The installation file is called:

    HubbleWeb_<ERP>_<version>.exe

    ...where <version> will be the current version and <ERP> will be the platform (i.e. JDE or EBS).


  1. Run the new Hubble Web installer executable. This will update the deployment scripts, along with all the Hubble files necessary for the upgrade.

    1. During the installer run, you will see a command prompt showing the current status of the process, similar to the screenshot below:


  1. When the installer finishes, there should now be files in C:\Insight\Hubble (you should now see a tools directory and a zip file):


Also, in the C:\chef directory, you should now see our installer script run.bat:


  1. Navigate to C:\chef. During the upgrade, check that Appserver.config has the correct IP address. If not, edit Appserver.config to update the Appserver IP address.

  1. Open a command prompt, navigate to c:\chef, and then execute our run.bat deployment script. This will update all the tools, files and services needed to run Hubble Web (e.g. IIS, Hubble services, click-once, etc).


Prerequisites Tests

At this point the prerequisites tests will run again. Normally, the prerequisites won't change between the original install and a upgrade, but it might happen on some occasions (i.e. new windows patches required, new service tested, etc.). If that happens, you may need to update the web server(s) to match the new requirements.

  1. The deployment script will first run Deployment Verification Tests (DVTs) in a special pre- requisites mode. This should run successful as these tests would have already been carried out during the initial deployment (during which they would have confirmed that the Windows machine fulfills the Minimal Technical Requirements).

    If the tests are now failing for any reason, ensure that the Hubble Application Server services have started successfully. You can do this by going to the Application Server and running the following commands:

    cd /etc/hubble/ && docker-compose ps

All the services should show “Up” in the “State” column. If they do, give the containers a few more minutes to fully start, and run the DVTs again. If they are still failing after this, please contact Hubble Customer Services and seek help in unblocking the upgrade.

  1. Once the DVTs are successful, the script will proceed with updating the software. You can monitor the update progress by either following the command line output, or by checking the installation log file, C:\chef\solo.txt:


  1. Once the update is complete, a successful entry in the log file should show as follows:


If the chef run fails, you should have clear failure messages both in the command prompt output and in the log file. If this happens you should be able to use these to solve the issue (if possible,) or else contact Hubble Customer Services to unblock the installation.

  1. (Optional) Configuring Web Single Sign-On with SAML

    Web Single Sign-On (SSO) can be configured on your web servers.

    To start the configuration, run the sso_config.ps1 script located in C:\Insight to populate the SSO configuration file with details of your identity provider. This updates the SSO and YellowBox configuration files accordingly and restarts the services needed for SSO to work.

    The default configuration file ssoconfig.json is automatically created in the path C:\Insight\YellowBoxWeb\Config on your web server(s). Every web server will have a default configuration file. Alternatively, you can have custom configuration files in other locations on your web server as long as they follow the same structure.

    When running the script, follow the following steps:

    1. ConfigFile - Enter the absolute file path of the SSO configuration file. This includes the location and the filename including the extension (e.g. C:\Insight\YellowBoxWeb\Config\ssoconfig.json). This file will be updated with the configuration which follows.

    2. YbConfigFile - Enter the absolute file path of the YellowBox configuration file. This includes the location and the filename including the extension (e.g. C:\Insight\YellowBoxWeb\Config\YellowBox.config). This file will be updated to ensure that the SSO Security Token Service is enabled.

    3. Logging Configuration - Press Enter to use existing logging configuration or input 'Y' to change the logging level to something else. The current Log Level is 'Warning'.

    4. Allowed Hosts - Press Enter to use the existing allowed hosts '*' (all hosts) or change it to a host of your choice.

    5. Security Token Service Configuration - This is the Service Provider configuration and is already automatically filled in, so unless any changes need to be made just press Enter to use the current values. These values include Service Name, Service Description, and Assertion Consumer Service URL.

    6. Partner Provider Configuration - This is the Identity Provider Settings which include:

      1. Partner Name - The partner identity provider name is the unique identifier for the IdP. This tends to be the metadata URL which configures SSO to use a link to your identity provider's metadata file.

      2. Partner SSO Service URL - The single sign-on service URL is the endpoint where SAML authentication requests are sent as part of SP-initiated SSO. This URL tells Hubble where to find the IdP.

      3. Certificate Path - The identity provider will provide you with a certificate. This must be downloaded to a convenient location and the absolute path provided in the

configuration. This certificate is used to verify that the correct identity provider is being “talked” to.

  1. Partner Name - This must match with the Partner Name in step 6a, to let Hubble know which IdP to use for SSO.

    See the screenshot below for an example of a script run using OneLogin settings:


  1. The next step is to run the full Deployment Verification Tests (while pointing to the run-list.json configuration file), which will confirm that the update has completed successfully. Proceed as follows:

    1. Open a PowerShell window.

    2. Change directory to C:\Insight:


      cd C:\Insight

Note that the following command will produce an error if not run from C:\Insight. The error itself is harmless and does not break anything.

  1. Execute the following command:

    .\DVT.ps1 all C:\chef\run-list.json


  1.     You will now be able to see the Hubble Web UI by accessing the following address in your browser:

    http://<application_server_ip_address>/

The address will redirect you automatically if you are using HTTPS or a domain name, and you should then see a screen similar to this:


  1. When you reach this stage, the Hubble Web Server update is complete.

Was this article helpful?

We're sorry to hear that.

Powered by Zendesk