System Updates

Updating an existing AspenTech Inmation OT DataFabric installation to the latest or a newer version can be managed in different ways depending on the type of installation. The different methods allow control on how and when updates occur and can be done manually, semi-automatically or in some cases fully automatically.

This section details how to update Windows Nodes and Nodes running as Linux Containers.

Windows Nodes and systems with hierarchies made up of connected Windows Nodes can use the Component Version Policy and Component Update Verification properties detailed in the Control of Node Updates to update automatically/semi automatically.

For Linux Containers, the Component Version Policy and Component Update Verification properties are not available and Linux nodes and Linux nodes hierarchies must be updated manually. An example of doing this via docker compose is given in the Updating Linux Containers section.

For mixed Node hierarchies made up of Windows and Linux Nodes, a combination of update methods can used but it is important to remember that any Nodes running in a Linux Container in the hierarchies must be still be updated manually whether it is a Top-level/parent Node or a child Node. Also, if the Linux Node is in the "middle" of Windows Nodes in the hierarchy then any Windows updates will not skip or bridge over the Linux Node and must be separately updated as described in the Updating Windows Nodes section.
MongoDB is not updated when AspenTech Inmation OT DataFabric is updated. If you intend to update MongoDB, please follow the Upgrade Procedures from the Release Notes for MongoDB 8.0.

Updating Windows Nodes

For installations that consist of only Windows Nodes, it is possible to update the entire system by just updating the top-level node in a node hierarchy. The updated inmation.exe file is sent directly to the host of the subsequent child nodes without needing to make additional configuration on the other node host machines. These automatic updates can be controlled using the properties described in Control of Node Updates section

Control of Node Updates

The automatic update of Nodes can be controlled centrally in WebStudio using the Component Version Policy and Component Update Verification properties.

Component Version Policy

The Component Version Policy for each Node in a node hierarchy can be set to automatic or manual update. The component version policy can also either be set to permissive (allows the Node to communicate with older versions of components) or restrictive (Node will only communicate with components that have the same version number).

If you wish to manually control updates, set the Component Version Policy on the child Node to Manual, Permissive or Manual, Restrictive. During a Node update using the AspenTech-Inmation-OT-DataFabric-Setup.exe installer, remote Nodes will be connected to the updated Node but will remain in their current version. After the parent node update is complete, whether the connection to each child node is maintained depends on the configured Component Version Policy. If the policy is Manual, Permissive, the connection is maintained. If the policy is Manual, Restrictive, the connection is disconnected until the child node is updated. When you are ready to update the child Node, change its Component Version Policy to Automatic, Restrictive and click Apply (this will disconnect the parent Node from the child Node). The parent or top-level Node will send the update, and the child Node will then automatically update and restart.

If the Automatic, Permissive setting is used, the component update will not be implemented until there is a disconnection between the parent and child Node. This could be induced by a Node service restart or a forced disconnection, otherwise the update will implemented at the time of the next occurring disconnection.

After the update is completed you can change the setting back to Manual, Permissive or Manual, Restrictive to retain manual control over updates.

During update, the Node service will stop to install the update, then restart. During the update the Node will lose connectivity and appear "red" in the Model Panel tree. The parent Node will reconnect to the component after the service has restarted again.

Component Update Verification

If the Component Version Policy property is set to allow component updates, then the Component Update Verification property controls how the update transfer and installation is verified. The default setting is Signature, where the signed certificate of the software update is verified against the trusted certificates of the Node’s host machine.

This verification can also be changed to None, whereby the update will happen without certificate verification taking place. This method of updating is not recommended but might be necessary in some cases where a remote component host machine might not have the latest software certificate in its trusted directory. By changing the Component Update Verification property to None, the verification can be bypassed and allow the update to take place.

Update with Setup installers

If you wish to selectively update parts of your system or manually perform upgrades on certain components, please see the Control of Node Updates section for details of how to configure this in WebStudio before updating.

Installing a New Versions

Before Nodes can be updated to a new version, this new version needs to be made available in the inmation.install folder. This is done by running a new version of the inmation.exe (with Administrator privileges) for the first time on the host machine of an existing node.

The installer detects the existing installation and asks if you wish to upgrade the system.

Check the box to agree to the license terms and conditions, then click Install. The installer will keep you informed as to the progress of the update and when the update is complete.

When the process is completed, click Close to close the dialog.

Updating Nodes

Once the new version is installed in the inmation.install folder, Node services can be updated to this new version.

To update an AspenTech Inmation Node service,

1 again run the AspenTech-Inmation-OT-DataFabric-Setup.exe with Administrator privileges. This time the Setup dialog looks different, offering options for modifying or uninstalling the system.

2 Click on Service Configuration in the Modifiy section.

3 On the Service Setup page,

1 Select the Node instance that you want to update.

2 Check the current version of this instance.

3 Select the checkbox for Upgrade to version …​.

4 Check the Instance location and the Data location paths.

5 When everything is correct, click OK to update the specified Node instance. Again you are informed about the progress of the update.

4 Click OK when the process has finished.

Depending on the Component Version Policy (see Control of Node Updates settings for more details), this will also upgrade connected child Nodes in the hierarchy that are Windows Nodes.

If there are Linux Nodes in the hierarchy, these will not be updated automatically, please see instructions below for updating Linux Nodes. If a Linux node is the parent of a Windows node, the Windows node can still be updated automatically, provided the Linux node has the required Windows updates available.

Connecting to the Node with WebStudio and selecting the Node in the System-Model, the software version number of the component can be checked in the Object Lens panel.

Update via exchange of inmation.exe Executable

Update can also be achieved by swapping the inmation.exe in the inmation.root/bin folder for the newer updated executable.

  1. Stop the Node service in the Windows Services application or Task Manager.

    It is recommended to retain a copy of the existing working executable pre-upgrade in case there is a issue restarting the Node service with the updated executable. In these cases, the previous state can be restored by returning to the original executable.
  2. Copy the updated inmation.exe into the inmation.root/bin folder.

  3. Restart the Node service in the Windows Services application or Task Manager.

Depending on the Component Version Policy (see Control of Node Updates settings for more details), this will also upgrade connected child Nodes in the hierarchy that are Windows Nodes.

Updating Linux Containers

The section will describe how Nodes running as Linux Containers can be updated by docker commands when the installation is managed using a docker compose file.

In most cases the version number of the container image is managed in the docker compose file (or an associated environment file) by the image tag in the image field.

image: {IMAGE_NAME}:{IMAGE_TAG}

The container doesn’t need to be stopped, the version number can be updated in the image_tag and saving the compose file. The updated image can be pulled from the image repository with the following command:

docker compose -f 'docker-compose.yml' pull

Once the new image is pulled, the 'up' command will update the the running container:

docker compose -f 'docker-compose.yml' up -d
  • The docker compose file needs to define a mapped named volume for the service that houses the "inmation/data" directory that contains the lmdb image file. This mapped volume is used to persist the system data config and is needed to restore the state if the container is stopped and restarted. For example, in services > volumes the "data-home" volume is defined as "data-home:/inmation/data":

    services:
      home:
        image: <Image_Location_url>:<Image_tag>
        container_name: home
        hostname: Home
    
        ports:
          - 8009:8009 # WebServer (https)
        restart: unless-stopped
        volumes:
          - ./inmation-startup.json:/inmation/bin/inmation-startup-init.json
          - data-home:/inmation/data
    volumes:
      data-home:
        driver: local
  • To continue to operate as before, the updated container needs to use the previous content of "inmation/data". Orchestrated environments need to guarantee that the previously mapped volume is still accessible to the updated container.

  • The "inmation/data" directory can also persisted on a bind mount, meaning that it is mapped to a local directory on the host (useful if you need to access the "inmation/data" directory from both containers and the host OR to ensure the lmdb file is persisted on a local disk). To do this use the mount "./" syntax in front of the service volume definition, for example:

./data-home:/inmation/data