SSB: Installation

Sparkplug SiteWise Bridge is not available but is coming October, 2020

Prerequisites

Before being able to install and set up Sparkplug SiteWise Bridge you must have an Amazon Web Services (AWS) account. If you do not already have one you can create one here.

Summary

This process covers installing the Sparkplug SiteWise Bridge AMI into an AWS account as an EC2 instance. For reference, the Sparkplug SiteWise Bridge Cloud Formation Template used to build the AWS infrastructure is here - ssb.yaml. Note this yaml file does not need to be used for anything. It is here purely for reference to show exactly what is done during the cloud formation deployment.

Sparkplug SiteWise Bridge Installation

Before deploying Sparkplug SiteWise Bridge you must create create an AWS EC2 key pair which will ultimately allow you to SSH into the EC2 instance that gets created as part of the process. Information on how to create the key pair can be found here. The key pair must be created in the AWS Region that you intend to deploy Sparkplug SiteWise Bridge into.

Sparkplug SiteWise Bridge is installed using the AWS Marketplace 1-click procedure. Begin by browsing to this site: https://aws.amazon.com/marketplace. Log in using your AWS account credentials. After doing so, you will see something similar to what is shown below.

In the search bar, type in 'Sparkplug SiteWise Bridge'. Then click on Sparkplug SiteWise Bridge by Cirrus Link. After doing so, you should see the following:

Click the yellow 'Continue to Subscribe' button near the top of the screen. This will bring up the following page:

Now click the blue 'Continue to Configuration' button near the top of the screen. Note by doing so you are agreeing to the EULA and associated terms. This will bring up the following screen.

In the 'Delivery Method' field, select 'CloudFormation Template' as shown below. This will set up the defaults including the 'Cirrus Link Sparkplug SiteWise Bridge Template' field, the version, and the region. Select your preference for the region as shown below.

After the AWS Infrastructure has been deployed via the AWS Marketplace 1-click procedure, the application must be configured. In order to configure the application you must be able to access the EC2 instance via SSH. Information on accessing the EC2 instance via SSH can be found here. Additional details on the filesystem layout of this EC2 instance can be found here.

Sparkplug SiteWise Bridge Configuration

For configuration details, please see: https://docs.chariot.io/display/CLD80/SSB%3A+Configuration

Reference Documentation

The Sparkplug SiteWise Bridge Quickstart Guide covers end to end setup of Sparkplug SiteWise Bridge including Edge setup, SSB setup, and seeing data in AWS SiteWise.

The Sparkplug SiteWise Bridge Configuration Reference covers configuration options for the Sparkplug SiteWise Bridge EC2 instance.