OSIsoft Edge Data Store Install Deployment Sample

February 2, 2024 ยท View on GitHub

Version: 1.0.7

Build Status

This sample uses bash scripts to install and configure Edge Data Store on a remote Linux edge device.

Requirements

One-Time Local Setup

  1. If on Windows, install Windows Subsystem for Linux, see Microsoft Docs
    Powershell:

    Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux

    Then install a Linux distribution like Ubuntu, and use bash for all other commands in this ReadMe.

  2. Prepare the installation_files folder with the Edge Data Store EdgeDataStore.deb files for the required processor architecture(s)

  3. (Optional) Configure template files in ./templates as desired

Per-Device Setup

  1. (Optional) Set up SSH for passwordless login, see Linuxize Article

    ssh-keygen -t rsa -b 4096 -C "your_email@domain.com"
ssh-copy-id remote_username@device_ip_address
ssh remote_username@device_ip_address

  2. (Optional) Configure loc.ini with required information for the device

  3. (Optional) Configure egress.ini with required data egress information for the device

  4. (Optional) Configure template files in ./templates as desired

The default template files include egress at a 10 second interval, as well as an example Modbus adapter configuration. The Modbus adapter is not expected to function without modification as it does not represent a real Modbus device.

To disable deployment and configuration of the Modbus adapter, change the 'y' to 'N' in the the silent.ini file and comment out the lines in script.sh that run curl requests to configure the Modbus1 endpoint.

Sample Deployment Process

The sample will execute the following steps to install and configure Edge Data Store.

  1. Copy configuration templates so originals are not modified
  2. Prompt for a location file, or request required information at runtime
  3. Prompt for Edge Data Store egress information, from file or at runtime
  4. Write egress configuration to file
  5. Prepare a folder of files to send to the edge device
  6. Clean up local copies of modified template files
  7. Back up the send folder by IP address to record a record of what was sent to the device
  8. Send the folder to the edge device
  9. Run the script.sh script on the device, which will run the following steps
    1. Install Edge Data Store silently and create a Modbus adapter instance
    2. Verify the installation succeeded
    3. Configure Edge Data Store Modbus Adapter Data Source
    4. Configure Edge Data Store Modbus Adapter Data Selection
    5. Configure Edge Data Store Periodic Egress

Running the Sample

Open a bash terminal, and run the remote.sh script

./remote.sh

For the Edge landing page ReadMe
For the OSIsoft Samples landing page ReadMe