Install and configure IIoT Core Services

To install IIoT Core Services, complete the following prerequisites.

Parent Topic

• Installation prerequisites

  Observe the following prerequisites before installing IIoT Core Services. These are global prerequisites that apply to all IIoT Core Services components, including the platform component.

-r myregistry.example.com:6000

-r myharbor.example.com:6000/my_project

Parent Topic

• Installation prerequisites

  Observe the following prerequisites before installing IIoT Core Services. These are global prerequisites that apply to all IIoT Core Services components, including the platform component.

Before you begin

Procedure

1. Generate a self-signed OpenSSL certificate.

   mkdir -p certs
   openssl req \
     -newkey rsa:4096 -nodes -sha256 -keyout certs/domain.key \
     -x509 -days 365 -out certs/domain.crt -subj "/CN=$(hostname -f)"

2. Start the Docker registry on port 5000 by passing a self-signed Open SSL certificate to the Docker registry.

   docker run -d -v "$(pwd)"/certs:/certs \
     -e REGISTRY_HTTP_ADDR=0.0.0.0:5000 \
     -e REGISTRY_HTTP_TLS_CERTIFICATE=/certs/domain.crt \
     -e REGISTRY_HTTP_TLS_KEY=/certs/domain.key \
     -p 5000:5000 \
     --name registry \
     --restart unless-stopped \
     registry:2

   NoteFor additional options, see https://docs.docker.com/registry/deploying/.

3. Ensure that the registry is included in the list of insecure registries in your container runtime.

   Make sure to include <registry_hostname>:5000 in insecure-registries in /etc/docker/daemon.json.

   1. Create a /etc/docker/daemon.json file, if you don't already have one.

   2. In this file, add <registry_hostname>:5000 to a list of insecure registries:

      {  
          "insecure-registries" : [
              "<registry_hostname>:5000"
          ]  
      }

   3. Restart Docker for the configuration changes to take effect:

      systemctl restart docker

   4. Run docker info and verify that the list of Insecure Registries is correct.

      For example:

      Client:
       Debug Mode: false
      Server:
       Containers: 150
        Running: 67
        Paused: 0
        Stopped: 83
       Images: 217
       Server Version: 19.03.5-ce
       ...
       Insecure Registries:
        <registry_hostname>:5000
        127.0.0.0/8
       Live Restore Enabled: false

   For more information on daemon.json, see the official Docker documentation.

4. Test the registry by pulling, tagging, and pushing an image:

   docker pull ubuntu
   docker image tag ubuntu $(hostname -f):5000/my-ubuntu
   docker push $(hostname -f):5000/my-ubuntu

   If you see output similar to the following, your registry is working correctly:

   Using default tag: latest
   latest: Pulling from library/ubuntu
   423ae2b273f4: Pull complete 
   de83a2304fa1: Pull complete 
   f9a83bce3af0: Pull complete 
   b6b53be908de: Pull complete 
   Digest: sha256:04d48df82c938587820d7b6006f5071dbbffceb7ca01d2814f81857c631d44df
   Status: Downloaded newer image for ubuntu:latest
   docker.io/library/ubuntu:latest
   The push refers to repository [<registry_hostname>:5000/my-ubuntu]
   1852b2300972: Pushed 
   03c9b9f537a4: Pushed 
   8c98131d2d1d: Pushed 
   cc4590d6a718: Pushed 
   latest: digest: sha256:0925d086715714114c1988f7c947db94064fd385e171a63c07730f1fa014e6f9 size: 1152

   You can also list the contents of the registry using the following commands:

   $ curl https://$(hostname -f):5000/v2/_catalog -k
   
   {"repositories":["my-ubuntu"]}

Results

Next steps

docker stop registry; 
docker rm registry

Parent Topic

• Installation prerequisites

  Observe the following prerequisites before installing IIoT Core Services. These are global prerequisites that apply to all IIoT Core Services components, including the platform component.

To use IIoT Core Services, you must provide access to the ports used by the system services and databases.

Parent Topic

• Installation prerequisites

  Observe the following prerequisites before installing IIoT Core Services. These are global prerequisites that apply to all IIoT Core Services components, including the platform component.

Child Topics

• Message brokers, databases, and external-facing services
• Internal core services

Before you begin

Procedure

1. Log in to the installation node.

2. Navigate to iiot-installer-release-5.0.0.

3. Install the necessary libraries:

   export PATH=$PATH:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
   ln -sf /usr/bin/python3 /usr/bin/python
   pip3 install -r requirements.txt

4. Start the IIoT Core Services preinstallation and installation process by running the following script:

   ./lei_install.sh

   The software license terms appear.

5. Read through the license, pressing Enter to scroll down. At the end of the license, enter y(es) at the prompt to agree to install.

   The main installer menu appears. Use this menu to Configure IIoT Core Services.

Parent Topic

• Installing IIoT Core Services in a cluster

  You can install and configure IIoT Core Services in your cluster using the following instructions.

Procedure

1. From the main installer menu, enter 1 for Node Configuration.

2. From the Nodes menu, enter 1 for Add Nodes to configure the cluster.

   Enter the requested information:

   Field	Description
   Hostname	Enter the hostname of the node being added.
   IP address	Enter the IP address for the node.
   Role	On-premises: Type "master" for all nodes. Cloud: Type "master" for at least one node. Label the remaining nodes "worker."

   Select the option to Return to the Main Menu.

3. Enter 2 for Load Balancer Configuration to configure the load balancer.

   Enter 1 to Add / Edit Load Balancer.

   Field	Description
   FQDN	Enter the fully qualified domain name (FQDN) of the load balancer.
   Hostname	Enter the hostname of the load balancer.
   IP address	Enter the IP address of the load balancer.

   Select the option to Return to the Main Menu.

4. Enter 3 for Profile Configuration to configure user, deployment, and storage profiles and other settings.

5. In the Profile Configuration menu, enter 1 for User Profiles to create users.

   Enter 1 to Add User(s) and specify the following information for each new user:

   Field	Description
   Username	Enter a username for the new user. You can use, modify, or delete the following pre-configured users as needed: Admin username: hiota Password: Change11me Technician username: hiota_read Password: Change11me
   Password	Enter a password for the new user.
   Email	Enter the email address for the new user.
   Role	Enter the user role: admin, technician, or operator.

   You must add at least one admin user and one user in another role to gain access to the IIoT Core Services user interface after installation.Select the option to Return to the Main Menu.

6. Enter 2 for Service Passwords.

   For each service, either press Enter to accept the password that is generated, or type your own password and then press Enter. The passwords you create must have at least eight characters, one lowercase letter, one uppercase letter, and one number. When you create your passwords, copy and store them for easy access. If you forget the generated passwords, you can find them in the Kubernetes dashboard.Select the option to Return to the Main Menu.

7. Enter 3 for Deployment Profiles and 1 for Edit Profile.

   In the Edit Profile menu, select a deployment profile.

   Profile	Description
   development (default)	Enter 1 to select the development environment and safely test your deployment without affecting the production environment.
   production	Enter 2 to select the production environment.

   Whether you select development or production in this menu, the minimum requirements in Preparing for IIoT Core Services installation apply. Your selection affects the number of replicas and requests and limits for CPU and memory.

   Select the option to Return to the Main Menu.

8. Enter 4 for Storage Profiles.

   Enter 1 to Edit / Review PVC ReadWriteMode or keep the default setting:

   PVC ReadWriteMode	Description
   ReadWriteOnce (default)	Mount the volume as read-write by a single node. Use this option for VMWare CNS or GCR.
   ReadWriteMany	Mount the volume as read-only by many nodes. Use this option for HSPC.

   For option 2, Edit / Review Service Storage Partitions, enter the storage size for each service needed for your applications.Select the option to Return to the Main Menu.

9. Enter 5 for Cloud / On Prem & DTR Configuration.

   Field	Description
   Enable / Disable - Cloud / On Prem Install	Enter true to enable on-premises install or false to enable cloud install.
   View / Edit Core Services Image Registry Configuration	Enter the FQDN URL, port number, current username and password for the core registry. This information is required even if you select Cloud.

   Select the option Return to Main Menu option.

10. To enable RBAC, enter 6 for Optional Features, then Edit / Review RBAC.

    The setting to install RBAC is disabled by default. Toggle on or off by entering y(es) or n(o).Select the Return to Main Menu option to return to the Profile Configurations menu, then again Return to Main Menu to return to the start menu.

11. Enter 4 for Optional Installations.

    The setting to install optional services is turned off by default. Toggle on or off by entering true or false for each service:

    Profile	Description
    Spark	Add the Spark analytics engine capability for large-scale data processing.
    Knative	Deploy, run, and manage serverless, cloud-native applications with Kubernetes.
    ML Service	Deploy cloud-based machine learning tools. See table below for Machine learning service configuration options. For more information about Machine learning service and resource requirements, see Machine learning service resource requirements.
    Digital Twin Beta	Activate Digital Twin mode and the ability to add digital twin objects that are installed with IIoT Core. NoteTo activate this option, you must also select the ML Service option. NoteDigital Twin Beta is currently an experimental feature in IIoT Core Services.

    The Machine learning service options include the following:

    ML Service Option	Description
    NFS_Server	Specify storage size for file sharing using a Network File System (NFS) server. The default size is 9 GB.
    Model_Lifecycle	Enter true or false to enable or disable model lifecycle management.
    Model_Management	Enter true or false to enable or disable model management.
    Model_Server	Enter true or false to enable or disable a model server.
    Notebook	Enter true or false to enable or disable Jupyter Notebook.
    Ray	Enter true or false to enable or disable Ray for Machine learning service scaling.

    Select Return to Optional Installations Menu.

12. Enter 10 to Validate Configuration Parameters.

13. Return to the Main Menu and enter 10 to Exit Installer Menu.

    The installer checks if all the parameters are correctly set.

Results

Parent Topic

• Installing IIoT Core Services in a cluster

  You can install and configure IIoT Core Services in your cluster using the following instructions.

Procedure

1. Navigate to the directory where the Modbus installation file is located and extract the contents of the TAR file.

   tar xvf hiota-modbus-lib-5.0.0.tgz

   A new directory is created: Hiota-Modbus-Lib-Installer-5.0.0.

2. Navigate to the new directory:

   cd Hiota-Modbus-Lib-Installer-5.0.0

3. Use the following command to enable file executable permissions for the installer script:

   chmod +x Installer.sh

4. Run the installer:

   ./installer.sh <cluster-fqdn>

5. Restart the following containers on the IIoT Gateway:

   systemctl restart hiota ​
   
   docker restart mqtt hiota-phoenix hiota-gateway-store-forward modbus-lib modbus-adapter

Results

Parent Topic

• Configuring Modbus

  IIoT Core Services includes a Modbus adapter that can be configured for TCP communication between a IIoT Gateway and IIoT Core Services.

Procedure

1. Enroll a IIoT Gateway on IIoT Core Services as described in Registering and provisioning an IIoT Gateway using CLI.

2. Add a Modbus datamap to the enrolled device.

   The information is stored in the subordinate Modbus server in four different tables. Two tables store on/off discrete values (coils) and two store numerical values (registers). The coils and registers each have a read-only table and read-write table.

   Primary tables	Data type	Address range	Number of records	Type	Notes
   Coil	1 bit	00000-09999	10000 (0x270F)	Read-Write	This type of data can be changed by an application.
   Discrete input	1 bit	10000-19999	10000 (0x270F)	Read-Only	This type of data can be provided by an I/O system.
   Input registers	16 bits	30000-39999	10000 (0x270F)	Read-Only	This type of data can be provided by an I/O system.
   Holding registers	16 bits	40000-49999	10000 (0x270F)	Read-Write	This type of data can be changed by an application.

3. From the Data Route tab in the IIoT Core Services UI, create a Modbus route.

   When creating the data route, select HIOTA for the Data Type in the Data Profile section. HIOTA is the IIoT Core Services Common Data Model (CDM). For more information about CDM, see GUID-76D1641E-E676-47B4-A750-EDFFD13BF745.

Results

Parent Topic

• Configuring Modbus

  IIoT Core Services includes a Modbus adapter that can be configured for TCP communication between a IIoT Gateway and IIoT Core Services.

Procedure

1. Enroll two gateways on IIoT Core Services as described in Install and provision an IIoT Gateway.

2. In the IIoT Core Services UI, select the Device tab.

3. Deploy the Modbus adapter on each gateway device.

   Follow the instructions in Deploy protocol adapter configurations on a gateway.
   1. Select one of the gateways to be deployed.
      NoteYou can only select devices that are online and in Ready state.
   2. Select Deploy Deploy Protocol Adapter to view the Adapter Configuration page.
   3. In the Adapter Type list, select Modbus.
   4. Paste your Modbus adapter configuration YAML into the Insert Adapter Configuration File text box.

      Example:

      1   - name: "custom-application-1"
      2  tags:
      3    - name: "velocity"
      4      type: "int16"
      5      slaveAddr: 0x00; 
      6      tableName: HoldingRegister
      7      startAddr: 0x00
      8      isBigEndian: true
      9    - name: "temperature"
      10      type: "int16"
      11      slaveAddr: 0x00
      12      tableName: HoldingRegister
      13      startAddr: 0x01
      14      isBigEndian: true
      15    - name: "a_03_int8"
      16      type: "int8"
      17      slaveAddr: 0x00
      18      tableName: HoldingRegister
      19      startAddr: 0x02
      20      isBigEndian: true
      21    - name: "a_04_uint8"
      22      type: "uint8"
      23      slaveAddr: 0x00
      24      tableName: HoldingRegister
      25      startAddr: 0x03
      26      isBigEndian: true
      27    - name: "a_05_int32"
      28      type: "int32"
      29      slaveAddr: 0x00
      30      tableName: HoldingRegister
      31      startAddr: 0x04
      32      isBigEndian: true
      33    - name: "a_06_float"
      34      type: "float"
      35      slaveAddr: 0x00
      36      tableName: HoldingRegister
      37      startAddr: 0x06
      38      isBigEndian: true
      

      Field	Description
      name	Tag name.
      type	Data type: bool, int8, uint8, int16, uint16, int32, uint32, int64, uint64, float, double, string.
      slaveAddr	The Modbus device addresses a specific subordinate device by placing the 8-bit subordinate address in the address field of the message (RTU mode). The address field of the message frame contains two characters (in ASCII mode), or 8 binary bits (in RTU mode). Valid addresses are from 1-247. Subordinate address 0 is used for broadcasts.
      tableName	Name of primary table. The value is found in {‘Coils’, ‘DiscreteInput’, ‘HoldingRegisters’, ‘InputRegisters’}.
      startAddr	Start address for tableName. The range is 0-9999.
      isBigEndian	Boolean. Modbus is a “big-endian” protocol, that is, the more significant byte of a 16-bit value is sent before the less significant byte. In some cases, however, 32-bit and 64-bit values are treated as being composed of 16-bit words, and transfer the words in "little-endian" order. For example, the 32-bit value 0x12345678 would be transferred as 0x56 0x78 0x12 0x34. You can chose the little-endian mode when isBigEndian is set to false.

   5. Click Deploy.

4. Select the Data Route tab to create a data route for each Modbus connection.

   NoteGeneral instructions for how to create a data route are found in Creating a data route.
   1. Click Create Data Route.

      The Create Data Route page opens.

   2. Enter a Name for the data route.
   3. Select the Asset that you are collecting data from.
   4. For Device Type, select Gateway.
   5. For Device, select the name of the gateway.
   6. Enter a Trace ID or keep the default Trace ID that is based on the asset name.
   7. For Data Type, select HIOTA.
   8. In the Data Source section, select Modbus from the Protocol field and the corresponding Hostname / IP Address and Port.
   9. In the Data Destinations section, add the data destination details for one or more data destinations.
   10. Click Save and Deploy.
   Repeat for the remaining data routes.

Results

Parent Topic

• Configuring Modbus

  IIoT Core Services includes a Modbus adapter that can be configured for TCP communication between a IIoT Gateway and IIoT Core Services.