SiteWise Edge gateway requirements - AWS IoT SiteWise
Requirements

SiteWise Edge gateway requirements

AWS IoT SiteWise Edge gateways run on AWS IoT Greengrass V2 as a set of AWS IoT Greengrass components that support data collection, processing, and publishing on premises. To configure a SiteWise Edge gateway that runs on AWS IoT Greengrass V2, you must create a gateway in the AWS Cloud and run the SiteWise Edge gateway software to set up your local device.

Requirements

Local devices must meet the following requirements to install and run the SiteWise Edge gateway software.

  • Supports AWS IoT Greengrass V2 Core software version v2.3.0 or newer. For more information, see Requirements in the AWS IoT Greengrass Version 2 Developer Guide.

  • One of the following supported platforms:

    • OS: Ubuntu 20.04 or later

      Architecture: x86_64 (AMD64) or ARMv8 (Aarch64)

    • OS: Red Hat Enterprise Linux (RHEL) 8

      Architecture: x86_64 (AMD64) or ARMv8 (Aarch64)

    • OS: Amazon Linux 2

      Architecture: x86_64 (AMD64) or ARMv8 (Aarch64)

    • OS: Debian 11

      Architecture: x86_64 (AMD64) or ARMv8 (Aarch64)

    • OS: Windows Server 2019 and later

      Architecture: x86_64 (AMD64)

    Note

    ARM platforms support SiteWise Edge gateways with Data Collection Pack only. The Data Processing Pack is not supported.

  • Minimum 4 GB RAM.

  • Minimum 10 GB disk space available for the SiteWise Edge gateway software.

  • If you plan to process data at the edge with AWS IoT SiteWise, your local device must also meet the following requirements:

    • Has an x86 64 bit quad-core processor.

    • Has at least 16 GB of RAM.

    • Has at least 32 GB for RAM if using Windows.

    • Had at least 256 GB of free disk space.

  • The minimum disk space and compute capacity requirements depend on a variety of factors that are unique to your implementation and use case.

    • The disk space required for caching data for intermittent internet connectivity depends on the following factors:

      • Number of data streams uploaded

      • Data points per data stream per second

      • Size of each data point

      • Communication speeds

      • Expected network downtime

    • The compute capacity required to poll and upload data depends on the following factors:

      • Number of data streams uploaded

      • Data points per data stream per second

  • Configure your local device to access the following S3 bucket: iot-sitewise-gateway-<region>-748875242063.

  • Configure your local device to make sure that the following ports are accessible:

    • The local device must allow network inbound traffic on port 443.

    • The local device must allow outbound traffic on port 443 and 8883.

      For a full list of the required outbound service endpoints, see Required service endpoints for AWS IoT SiteWise Edge gateways.

    • The following ports are reserved for use by AWS IoT SiteWise: 80, 443, 3001, 4569, 4572, 8000, 8081, 8082, 8084, 8085, 8445, 8086, 9000, 9500, 11080, and 50010. Using a reserved port for traffic can result in a terminated connection.

      Note

      The AWS IoT Greengrass V2 Stream manager component has its own requirements. For more information, see Configuration in the AWS IoT Greengrass Version 2 Developer Guide.

  • Java Runtime Environment (JRE) version 11 or higher. Java must be available on the PATH environment variable on the device. To use Java to develop custom components, you must install a Java Development Kit (JDK). We recommend that you use Amazon Corretto or OpenJDK.

You must have the following permissions to use SiteWise Edge gateways:

Note

If you use the AWS IoT SiteWise console to create your SiteWise Edge gateway, these permissions are added for you.

  • The IAM role for your SiteWise Edge gateway must allow you to use an SiteWise Edge gateway on an AWS IoT Greengrass V2 device to process asset model data and asset data.

    The role allows the following service to assume the role: credentials.iot.amazonaws.com.

    Permissions details

    The role must have the following permissions:

    • iotsitewise – Allows principals to retrieve asset model data and asset data at the edge.

    • iot – Allows your AWS IoT Greengrass V2 devices to interact with AWS IoT.

    • logs – Allows your AWS IoT Greengrass V2 devices to send logs to Amazon CloudWatch Logs.

    • s3 – Allows your AWS IoT Greengrass V2 devices to download custom component artifacts from Amazon S3.

    {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "iotsitewise:BatchPutAssetPropertyValue",
                "iotsitewise:List*",
                "iotsitewise:Describe*",
                "iotsitewise:Get*"
            ],
            "Resource": "*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "iot:DescribeCertificate",
                "logs:CreateLogGroup",
                "logs:CreateLogStream",
                "logs:PutLogEvents",
                "logs:DescribeLogStreams",
                "s3:GetBucketLocation",
                "s3:GetObject",
                "iot:Connect",
                "iot:Publish",
                "iot:Subscribe",
                "iot:Receive",
                "iot:DescribeEndpoint"
            ],
            "Resource": "*"
        }
    ]
}