# Partner data sources on SiteWise Edge gateways Partner data sources When using an AWS IoT SiteWise Edge gateway you can connect a partner data source to your SiteWise Edge gateway and receive data from the partner in your SiteWise Edge gateway and the AWS cloud. These partner data sources are AWS IoT Greengrass components that are developed in partnership between AWS and the partner. When you add a partner data source, AWS IoT SiteWise will create this component and deploy it on your SiteWise Edge gateway. **Note** You can add one data source for each partner in each gateway. To add a partner data source, do the following: 1. [Add a partner data source in SiteWise Edge](cpa-add-source.md) 1. Go to the partner’s web portal, where applicable, and configure the partner data source so it connects to the SiteWise Edge gateway. **Topics** + [ ## Security ](#cpa-security) + [ # Set up Docker on your SiteWise Edge gateway ](cpa-install-docker.md) + [ # Add a partner data source in SiteWise Edge ](cpa-add-source.md) + [ # SiteWise Edge gateway partner data source options ](connect-partner-data-source.md) ## Security As part of the [Shared Responsibility Model](https://aws.amazon.com/compliance/shared-responsibility-model/) between AWS, our customers, and our partners the following describes who is responsible for the different aspects of security: **Customer responsibility** + Vetting the partner. + Configuring the network access given to the partner. + Monitoring for reasonable usage of the SiteWise Edge gateway machine resources (CPU, memory, and file system). **AWS responsibility** + Isolating the partner from the customer AWS cloud resources except those needed by the partner. In this case, AWS IoT SiteWise ingestion. + Restricting the partner solution to a reasonable usage of the SiteWise Edge gateway machine resources (CPU and memory). **Partner responsibility** + Using secure defaults. + Keeping the solution secure over time through patches and other appropriate updates. + Keeping customer data confidential. # Set up Docker on your SiteWise Edge gateway Set up Docker on a gateway AWS IoT SiteWise provides a Docker image that allows you to run the SiteWise Edge application on various platforms and environments. This Docker image encapsulates all the necessary components and dependencies required to collect, process, and send data from your industrial equipment to the AWS Cloud. By using the Docker image, you can deploy and run the SiteWise Edge application on Docker-compatible hosts, such as servers, edge devices, or cloud-based container services. To add a partner data source, [Docker Engine](https://docs.docker.com/engine/) 1.9.1 or later must be installed on your local device. **Note** Version 20.10 is the latest version that is verified to work with the SiteWise Edge gateway software. ## Verify Docker is installed To verify Docker is installed, run the following command from a terminal connected to your SiteWise Edge gateway: ``` docker info ``` If the command returns a `docker is not recognized` result, or an older version of Docker is installed, [Install Docker Engine](https://docs.docker.com/engine/install/) before continuing. ## Set up Docker The system user that runs a Docker container component must have root or administrator permissions, or you must configure Docker to run it as a non-root or non-admistrator user. On Linux devices, you must add a `ggc_user` user to the `docker` group to call Docker commands without `sudo`. To add `ggc_user`, or the non-root user that you use to run Docker container components, to the `docker` group, run the following command: ``` sudo usermod -aG docker ggc_user ``` For more information, see [Linux post-installation steps for DockerEngine](https://docs.docker.com/engine/install/linux-postinstall/). # Add a partner data source in SiteWise Edge Add a partner data source To connect a partner data source to your SiteWise Edge gateway, add it as a data source. When you add it as a data source, AWS IoT SiteWise will deploy a private AWS IoT Greengrass component to your SiteWise Edge gateway. ## Prerequisites To add a partner data source, you must do the following: + For EasyEdge and CloudRail, create an account with the partner, then bind the accounts. + [Set up Docker on your SiteWise Edge gateway](cpa-install-docker.md) ## Create a SiteWise Edge gateway with a partner data source If you want to create a new SiteWise Edge gateway, complete the steps in [Create a self-hosted SiteWise Edge gateway](create-gateway-ggv2.md). After you’ve created SiteWise Edge gateway follow the steps in [Add a partner data source to an existing SiteWise Edge gateway](#cpa-existing-gateway) to add a partner data source. ## Add a partner data source to an existing SiteWise Edge gateway 1. Navigate to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/). 1. In the left navigation, choose **Edge gateways** in the **Edge** section. 1. Choose the SiteWise Edge gateway you want to connect the partner data source to. 1. Under **Data sources**, choose **Add data source**. 1. On the **Add data source** screen, choose a **Source type**, to select the partner that connects your SiteWise Edge gateway. Each data source has its own configuration options. There are two categories of data sources: AWS sources and Partner sources. Using a partner data source, you can select one source per gateway. For a list of data source partner integration options, see [SiteWise Edge gateway partner data source options](connect-partner-data-source.md). Note that you can add up to 100 OPC UA data sources (AWS sources). To get started with OPC UA data sources, see [OPC UA data sources for AWS IoT SiteWise Edge gateways](configure-sources-opcua.md). 1. Enter a name for the source. 1. Select your data source's tab below and follow the configuration procedure. ------ #### [ CloudRail ] Much of the CloudRail configuration is done in the CloudRail portal after saving the data source for your SiteWise Edge gateway. However, authorizing the connection is required. **Note** The CloudRail connection is only available on Linux. 1. [Create a CloudRail account](https://devices.cloudrail.com/signup) to get started with connecting to AWS IoT SiteWise. 1. Ensure that Docker is installed on your gateway. For more information, see [Set up Docker on your SiteWise Edge gateway](cpa-install-docker.md). 1. Read the **Authorize access and deployment** agreement, then choose **Authorize**. Checking the box grants the AWS partner access to your data source and allows AWS to deploy on the partner's component. **Note** The **Measurement Prefix – *optional*** is set within your CloudRail portal. **Note** Partner software is developed, maintained, and supported by the AWS partner. AWS is not responsible for the interface, configuration, or software. For more information, see [CloudRail](connect-partner-data-source.md#cp-cloudrail). ------ #### [ EasyEdge ] Much of the EasyEdge configuration is done in the EasyEdge portal after saving the data source for your SiteWise Edge gateway. However, authorizing the connection is required. **Note** The EasyEdge connection is only available on Linux. 1. [Create an EasyEdge account](https://accounts.easyedge.io/signup?partner=aws) to get started with connecting to AWS IoT SiteWise. 1. Ensure that Docker is installed on your gateway. For more information, see [Set up Docker on your SiteWise Edge gateway](cpa-install-docker.md). 1. Read the **Authorize access and deployment** agreement, then choose **Authorize**. Checking the box grants the AWS partner access to your data source and allows AWS to deploy on the partner's component. **Note** The **Measurement Prefix – *optional*** is set within your EasyEdge portal. **Note** Partner software is developed, maintained, and supported by the AWS partner. AWS is not responsible for the interface, configuration, or software. For more information, see [EasyEdge](connect-partner-data-source.md#cp-easyedge). ------ #### [ Litmus Edge ] You can activate the Litmus configuration in two ways. Activate Litmus Edge directly through AWS IoT SiteWise using information from the Litmus Edge Manager portal. Or, you can manually activate Litmus Edge for AWS IoT SiteWise through Litmus Edge Manager. **Note** The Litmus Edge connection is only available on Linux.   **To activate using a Litmus Edge activation code on AWS IoT SiteWise** Use this procedure when adding a Litmus Edge data source with a Litmus Edge activation code on the AWS IoT SiteWise console. 1. Select **Activate now using a code**. Additional configuration options appear. 1. Enter the Litmus Edge Manager to connect Litmus Edge to your SiteWise Edge gateway. For more information, see [Step 3a: Set Data and Device Management Endpoint](https://docs.litmus.io/edgemanager/quickstart-guide/activate-an-edge-device/step-3-activation-request) in the Litmus Edge Manager documentation. 1. Provide the Litmus Edge Manager activation code to activate Litmus Edge on AWS IoT SiteWise 1. Optionally, provide AWS IoT SiteWise with the **Litmus Edge Manager CA certificate**. The certificate prevents Litmus Edge from activating on an unauthorized Litmus Edge Manager. 1. Ensure that Docker is installed on your gateway. For more information, see [Set up Docker on your SiteWise Edge gateway](cpa-install-docker.md). **Note** AWS IoT SiteWise deploys the partner application as a Docker container. The application is deployed with `NET_ADMIN` capability so that the Litmus Edge Docker container can be managed through Litmus Edge Manager. Litmus Edge requires this privileged access to run on your devices. For more information about the Litmus Edge Docker requirements, see [Docker Installation](https://docs.litmus.io/litmusedge-v1/quickstart-guide/installation-and-deployments/docker-installation) in the *QuickStart Guide* in the Litmus Edge documentation. 1. Read the **Authorize access and deployment** agreement, then choose **Authorize**. Checking the box grants the AWS partner access to your data source and allows AWS to deploy on the partner's component.   **To activate manually through Litmus Edge** 1. Select **Activate later on Litmus Edge**. 1. Ensure that Docker is installed on your gateway. For more information, see [Set up Docker on your SiteWise Edge gateway](cpa-install-docker.md). **Note** AWS IoT SiteWise deploys the partner application as a Docker container. The application is deployed with `NET_ADMIN` capability so that the Litmus Edge Docker container can be managed through Litmus Edge Manager. Litmus Edge requires this privileged access to run on your devices. For more information about the Litmus Edge Docker requirements, see [Docker Installation](https://docs.litmus.io/litmusedge-v1/quickstart-guide/installation-and-deployments/docker-installation) in the *QuickStart Guide* in the Litmus Edge documentation. 1. Read the **Authorize access and deployment** agreement, then choose **Authorize**. Checking the box grants the AWS partner access to your data source and allows AWS to deploy on the partner's component. 1. After the deployment is complete, follow the [Access the Litmus Edge Web UI](https://docs.litmus.io/litmusedge/quickstart-guide/access-the-litmus-edge-web-ui) instructions in the Litmus Edge *QuickStart Guide* documentation. **Note** Partner software is developed, maintained, and supported by the AWS partner. AWS is not responsible for the interface, configuration, or software. For more information, see [Litmus Edge](connect-partner-data-source.md#cp-litmus). ------ 1. Choose **Save**. # SiteWise Edge gateway partner data source options Partner data source options AWS IoT SiteWise allows you to connect and ingest data from various partner data sources, such as industrial equipment, sensors, and other third-party systems. To connect a partner data source, you need to follow a few steps, including configuring the data source to send data to AWS IoT SiteWise, setting up the necessary permissions and authentication, and mapping the data to your asset models. This process ensures that your partner data is seamlessly integrated into your AWS IoT SiteWise environment, enabling you to monitor and analyze it alongside your other data sources. This section lists the available partners for third-party data source integration on SiteWise Edge gateways. Use the information below to configure a partner data source. **Note** You can add one data source for each partner in each gateway ## CloudRail **Portal:** [https://devices.cloudrail.com/](https://devices.cloudrail.com/) **Requirements** For more information on CloudRail requirements, see [FAQS](https://cloudrail.com/faqs/) on the CloudRail website. **CloudRail documentation:** [Edge Computing: SiteWise Edge](https://devices.cloudrail.com/documentation?service=AWSIoTSitewiseEdge#awsiotsitewiseEdge1) ## EasyEdge **Portal:** [https://studio.easyedge.io/](https://studio.easyedge.io/) **Requirements** [EasyEdge requirements](https://docs.easyedge.io/getting-started/requirements.html) – Information about EasyEdge requirements, including endpoints and ports required for configuring the firewall. **Note**: You'll need an EasyEdge account to access this documentation. **EasyEdge documentation:** [EasyEdge for AWS](https://www.easyedge.io/easyedge-for-aws/) ## Litmus Edge **Access to Litmus Edge Manager:** To access Litmus Edge, set up a [Litmus Edge Manager account](https://docs.litmus.io/edgemanager/quickstart-guide/access-to-litmus-edge-manager). **Requirements** [Litmus Edge Requirements ](https://docs.litmus.io/litmusedge/quickstart-guide/system-requirements) – Recommended configurations and system requirements to deploy Litmus Edge. **Litmus documentation:** + [Integration to AWS IoT SiteWise](https://docs.litmus.io/litmusedge-v1/litmusedge-with-aws-iot-sitewise) + [Litmus Edge Documentation](https://docs.litmus.io/litmusedge/)