Child Node Setup
In this section, step-by-step instructions are provided to guide you through the installation of a Child Node using the AspenTech Inmation Windows Installer.
In order to establish communication between two Nodes, connection objects must also be configured in the System Config App.
Prerequisites
-
Ensure that you have configured a Node, which can act as the parent.
In this example setup, a Top-Level Node (as created here) will act as the parent Node. However, if you have previously configured a Child Node, this can assume the role of parent Node for additional Child Nodes. -
Identify the hostname of the machine where the parent Node is running.
If the parent Node is running in a container, use the name of the machine where Docker is running. -
Identify the port on which the parent Node is listening for incoming connection requests.
If the parent Node is running in a container, find out to which external port, the internal port is mapped.
Background Information on Connections
A connection between two Nodes consists of two corresponding Connection objects: the Downlink Connection object on the parent Node and the
Uplink Connection
object on the child Node.
To be able to establish a connection, one of these Connection objects needs to be configured
to send out connection requests while the other listens for incoming connection requests.
The former is said to be in active mode while later is in passive mode.
|
Parent Node Preparation
Before the child Node can be installed, the Downlink Connection object needs to be setup, depending on your firewall configuration.
Whether you use an active Downlink Connection and a passive Uplink Connection or vice-versa depends on your firewall configuration, where the configuration for inbound traffic if a passive Connection can receive incoming requests while the configuration for outbound traffic controls if an active Connection is allowed to send out its connection requests to remote machines.
For detailed information on the specific configuration, expand the section that is suitable for for your firewall configuration:
-
Active Downlink Connection (click to expand)
To configure an active Downlink Connection on the Parent Node (to connect to a passive Uplink Connection on the Child Node):
-
For the Connection Mode property select Active.
-
For the Remote Connection ID property, specify the prospective path to the Uplink Connection object on the Child Node according to this pattern:
/<CHILD_NODE_NAME>/Connections/<UPLINK_CONNECTION_NAME>
This path does not exist in the system, yet but will be created when you install the Child Node. Then you will be asked for the name of the Child Node’s Uplink Connection object. This object will then be created under a Connections Group object called "Connections".
For example, if the Child Node is called "CHILD" and the Uplink Connection is called "to-parent", then the path would be "./Connections/to-parent". The dot indicates a relative path for the remote Node. The path can also be specified as an absolute path, e.g., "/CHILD/Connections/to-parent" or the GUID of the object.
Once a connection between Nodes has been established, this field updates to the Object ID of the Uplink Connection object. -
For the Remote Hostname property enter the hostname of the machine where the Child Node will be installed.
-
Set the Remote Port property to the Listener Port that will be used for the Child Node.
-
Finally, set the Authentication type to[.option]# Pre-shared key# and provide a Pre-shared key.
Make sure to set the same value for the Pre-Shared Key during the installation of the Child Node.
-
-
Passive Downlink Connection (click to expand)
If the Connection Mode property is Passive, then only the Authentication settings must be configured. Set the Authentication type to Pre-shared Key and provide a pre-shared key. This value will also be used to configure the connection from the Child Node in the installer.
As the corresponding Uplink Connection doesn’t exist yet, the Downlink Connection object is in grey/red state until the connection can be established after the installing the Child Node.
Child Node Installation
1 To begin the installation of the Node, right-click on the AspenTech-Inmation-OT-DataFabric-Setup executable file and select 'Run as administrator' from the context menu.
2 In the dialog, click Service Configuration to open the Service Setup.
3 At the bottom of this window, click Add to add a new instance, which will be used to configure the Child Node.
| On the left-hand side of this Service Setup window, the existing instances are listed. This can also be used to remove instances. |
Communication Options
Elements of this Setup page
| Control | Text | Default | Description |
|---|---|---|---|
Radio |
Connection Mode |
Top Level Node |
Install the Node as a Top-Level Node or a Child Node |
Field |
Instance Name |
Empty |
Assigns a name for the new instance |
Checkbox |
Create default instance |
Disabled |
When enabled, a default instance will be installed. |
Field |
Override Object Name |
Empty |
Assigns a custom initial name to the node object created in the System Model during the installation of the Node service. |
Field |
Instance location |
Empty |
Defines the Instance folder location. All directories related to this instance are stored here. |
Button |
Browse |
N/A |
Opens an advanced directory selection window to configure the Instance Location path. |
Field |
Data location |
Empty |
Configure the data folder location. All data directories are stored here. |
Button |
Browse |
N/A |
Opens an advanced directory selection window to configure the Data Location path. |
Radio |
Active Connection or Passive Connection |
Passive Connection |
Defines the connection type of the Uplink Connection object created during installation of the Child Node. This is dependent on the Donwlink Connection object from the parent Node. |
Field |
Listener Port |
6512 |
Configure the TCP Port of the Child Node |
Field |
Connection Name |
Empty |
Assigns a name to the Uplink Connection object created during the installation of the Child Node. |
Field |
Pre-Shared Key |
Empty |
Specifies the pre-shared key. This value must match the pre-shared key on the Downlink Connection object for the parent Node to enable communication between the Nodes. |
Field |
Parent Host |
localhost |
Specify the hostname of the machine where the parent Node is installed. If the Child Node is installed on the same machine as the parent Node, then "localhost" can be used. Only applies to Active Connections. |
Field |
Parent Port |
6512 |
Specify the port of the parent Node. Only applies to Active Connections. |
Field |
Parent Connection ID |
Empty |
Assign this property the Object ID of the Downlink Connection object from the parent Node. Only applies to Active Connections. |
Field |
Authentication |
PSK |
Defines the authentication type for communication between Nodes. Only applies to Active Connections. |
Field |
Encryption |
AES256 |
Defines the encryption type for communication between Nodes. Only applies to Active Connections. |
Checkbox |
Configure Windows Firewall |
Enabled |
Enable automatic Windows Firewall configuration |
In this page, the Node type can be defined.
-
For the Connection Mode property, select Child Node.
-
The Instance Name field can be used to define the name of the new instance. In this example, set this field to "Europe". Additionally , set the Override Object Name field to match this Instance Name field - this will assign the name to the created Node object in the System Model.
The bottom section of this page is used to configure the Uplink Connection object for the new child Node. This is dependent on the configuration of the Downlink Connection object for the parent Node. The connection type of the Uplink Connection must be the opposite of the Downlink Connection, i.e., if the Downlink Connection on the parent Node is active, then the Uplink Connection the child Node needs to be passive and vice versa.
For detailed information on the specific configuration, expand the section that addresses the Uplink Connection corresponding to the Downlink Connection on your parent Node:
-
Active Uplink Connection (click to expand)
1 In the Communication Options page, select Active Connection. This will display additional fields to be configured.
2 For the Listener Port, define a port to be assigned to the Child Node. For this example, we’ll use 7512.
3 The Connection Name is used to define the name which will be assigned as the name of the Uplink Connection object created during installation of the Child Node.
4 The Parent Host and Parent Port are used to specify the hostname and port of the parent Node. For this example, the values used for these properties will be localhost and 6512 respectively.
5 Enter the Pre-Shared Key. This must match the pre-shared key on the passive Downlink Connection object for the parent Node to establish communication between the Nodes.
6 Finally, for the Parent Connection ID, enter the relative path (e.g., "./Connections/to-child"), absolute path (e.g., "/Parent/Connections/to-child"), or Object ID of the Downlink Connection object for the parent Node. This can be found in the System Config App by selecting the object in the Object Model panel and in the Object Lens, expanding the header.
7 Ensure that all information provided is correct and click Next to proceed to the next step.
-
Passive Uplink Connection (click to expand)
1 In the Communication Options page, select Passive Connection.
2 For the Listener Port, define a port to be assigned to the Child Node. For this example, we’ll use 7512.
3 The Connection Name is used to define the name which will be assigned as the name of the Uplink Connection object created during installation of the Child Node. This must match the <UPLINK_CONNECTION_NAME> defined while creating the Active Downlink Connection on the parent Node earlier.
4 Enter the Pre-Shared Key. This must match the pre-shared key on the active Downlink Connection object for the parent Node to establish communication between the Nodes.
5 Ensure that all the information provided is correct and click Next to proceed.
Node Options: System Owner
Elements of this Setup Page
| Control | Text | Default | Description |
|---|---|---|---|
Field |
Profile Name: |
Empty |
The name of the Profile created during installation. |
Checkbox |
Enable Profile Login |
Enabled |
Enables/disables the ability to access the system using the profile |
Field |
Password: |
Empty |
Assign a password to the profile |
Field |
Repeat Password: |
Empty |
Confirm the password for the profile |
Radio |
Account or Group |
Account |
Choose whether to assign a Windows user account or a Windows user group to the system owner profile. |
Field |
Microsoft account or group |
Domain and user account being used to install the system |
Assigns a Windows user account to the System owner profile |
This section of the installer can be used to create an optional profile corresponding to the Child Node. If required, define the profile information but these fields can be left blank if no profile should be created.
Click Next to proceed.
Node Options: MongoDB
Elements of this Setup Page
| Control | Text | Default | Description |
|---|---|---|---|
Checkbox |
Create datastores |
Disabled |
When enabled, an Initial Data Store will be created for the Child Node during installation. |
In this step, the Node is configured regarding the MongoDB client connection. If the Create Datastores checkbox is enabled, an Initial Data Store will be created under the Child Node during the installation.
Click Finish to return to the Service Setup window.
Finishing the Installation
1 In the Service Setup window, click Ok to start the installation. A Setup Progress dialog will be shown whilst the installation is running.
2 When the installation has finished, the Setup Finished dialog is shown. Click Close to close the setup installer.
3 Be patient.
4 After a while, when the connection is established, the new Child Node appears in the System Model and the Downlink Connection object on the Parent Node switches into a green/green state.