Manage SiteWise Edge gateways - AWS IoT SiteWise
Manage your SiteWise Edge gateway with the AWS IoT SiteWise consoleManage SiteWise Edge gateways using AWS OpsHub for AWS IoT SiteWiseAccess your SiteWise Edge gateway using local operating system credentialsManage the SiteWise Edge gateway certificateChange the version of SiteWise Edge gateway component packsUpdate the version of an AWS IoT SiteWise componentDeleting a SiteWise Edge gateway

Manage SiteWise Edge gateways

You can use the AWS IoT SiteWise console and API operations to manage AWS IoT SiteWise Edge gateways. You can also use the AWS OpsHub for AWS IoT SiteWise for Windows application to manage some aspects of your SiteWise Edge gateway from your local device.

We highly recommend that you use the AWS OpsHub for AWS IoT SiteWise application to monitor the disk usage on your local device. You can also monitor the Gateway.AvailableDiskSpace and Gateway.UsedPercentageDiskSpace Amazon CloudWatch metrics and create alarms to get notified when the disk space is getting low. For more information about Amazon CloudWatch alarms, see Create a CloudWatch alarm based on a static threshold.

Make sure that your device has enough space for upcoming data. When you're about to run out of space on your local device, the service automatically deletes a small amount of data with the oldest timestamps to make room for upcoming data.

To check if the service deleted your data, do the following:

  1. Sign in to the AWS OpsHub for AWS IoT SiteWise application.

  2. Choose Settings.

  3. For Logs, specify a time range, and then choose Download.

  4. Unzip the log file.

  5. If the log file contains the following message, the service deleted your data: number bytes of data have been deleted to prevent SiteWise Edge gateway storage from running out of space.

Manage your SiteWise Edge gateway with the AWS IoT SiteWise console

You can use the AWS IoT SiteWise console to configure, update, and monitor all SiteWise Edge gateways in your AWS account.

You can view your SiteWise Edge gateways by navigating to the Edge Gateways page in the AWS IoT SiteWise console. To access the Edge gateway details page for a specific gateway, choose the name of an Edge gateway.

From the Overview tab of the Edge gateway details page, you can do the following:

  • In the Data sources section, update data source configuration and configure additional data sources

  • Choose Open CloudWatch metrics to view the number of data points ingested per data source in the CloudWatch metrics console

  • In the Edge capabilities section, add data packs to your SiteWise Edge gateway by clicking Edit

  • In the Gateway configuration section, view the connectivity status of your SiteWise Edge gateways

  • In the Publisher configuration section, view the SiteWise Edge gateway sync status and configuration of the AWS IoT SiteWise publisher component

From the Updates tab of the Edge gateway details page, you can see the current component and pack versions that are deployed to the Edge gateway. This is also where you deploy new versions, when they're available.

Manage SiteWise Edge gateways using AWS OpsHub for AWS IoT SiteWise

You use the AWS OpsHub for AWS IoT SiteWise application to manage and monitor your self-hosted SiteWise Edge gateways. This application provides the following monitoring and management options:

  • Under Overview, you can do the following:

    • View SiteWise Edge gateway details that help you get insights into your SiteWise Edge gateway device data, identify issues, and improve the SiteWise Edge gateway's performance.

    • View SiteWise Monitor portals that monitor the data from local servers and equipment at the edge. For more information, see What is AWS IoT SiteWise Monitor in the AWS IoT SiteWise Monitor Application Guide.

  • Under Health, there's a dashboard that displays data from your SiteWise Edge gateway. Domain experts, such as process engineers, can use the dashboard to see an overview of SiteWise Edge gateway behavior.

  • Under Assets, view assets deployed to the local device and the last value collected or computed for asset properties.

  • Under Settings, you can do the following:

    • If the Data Processing Pack is installed, view the SiteWise Edge gateway configuration information and sync resources with the AWS Cloud.

    • Download the authentication files that you can use to access the SiteWise Edge gateway by using other tools.

    • Download logs that you can use to troubleshoot the SiteWise Edge gateway.

    • View the AWS IoT SiteWise components deployed to the SiteWise Edge gateway.

Important

The following are required to use AWS OpsHub for AWS IoT SiteWise:

  • Your local device and the AWS OpsHub for AWS IoT SiteWise application must be connected to the same network.

  • The data processing pack must be enabled.

To manage SiteWise Edge gateways using AWS OpsHub

  1. Download and install the AWS OpsHub for AWS IoT SiteWise for Windows application.

  2. Open the application.

  3. If you don't have local credentials set up for your gateway, follow the steps under Access your SiteWise Edge gateway using local operating system credentials to set them up.

  4. You can sign in to your SiteWise Edge gateway with your Linux or Lightweight Directory Access Protocol (LDAP) credentials. To sign in to your SiteWise Edge gateway, do one of the following:

    Linux

    1. For Hostname or IP address, enter the hostname or IP address of your local device.

    2. For Authentication, choose Linux.

    3. For User name, enter the user name of your Linux operating system.

    4. For Password, enter the password of your Linux operating system.

    5. Choose Sign in.

    LDAP

    1. For Hostname or IP address, enter the hostname or IP address of your local device.

    2. For Authentication, choose LDAP.

    3. For User name, enter your LDAP's user name.

    4. For Password, enter your LDAP's password.

    5. Choose Sign in.

Access your SiteWise Edge gateway using local operating system credentials

Besides Lightweight Directory Access Protocol (LDAP), you can use the Linux or Windows credentials to access your self-hosted SiteWise Edge gateway.

Important

To access your SiteWise Edge gateway with Linux credentials, you must activate the data processing pack for your SiteWise Edge gateway.

The following steps assume that you use a device with Ubuntu. If you use a different Linux distribution, consult the relevant documentation for your device.

To create a Linux user pool

  1. To create an admin group, run the following command.

    sudo groupadd --system SWE_ADMIN_GROUP

    Users in the SWE_ADMIN_GROUP group can allow admin access for the SiteWise Edge gateway.

  2. To create a user group, run the following command.

    sudo groupadd --system SWE_USER_GROUP

    Users in the SWE_USER_GROUP group can allow read-only access for the SiteWise Edge gateway.

  3. To add a user to the admin group, run the following command. Replace user-name and password with the user name and password that you want to add.

    sudo useradd -p $(openssl passwd -1 password) user-name

  4. To add a user to either SWE_ADMIN_GROUP or SWE_USER_GROUP, replace user-name with the the user name that you added in the previous step.

    sudo usermod -a -G SWE_ADMIN_GROUP user-name

You can now use the user name and password to sign in to the SiteWise Edge gateway on the AWS OpsHub for AWS IoT SiteWise application.

The following steps assume that you use a device with Windows.

Important

Security is a shared responsibility between AWS and you. Create a strong password policy with at least 12 characters and a combination of uppercase, lowercase, numbers, and symbols. Additionally, set the Windows Firewall rules to allow incoming traffic on port 443 and to block incoming traffic on all other ports.

To create a Windows Server user pool

  1. Run PowerShell as the administrator.

    1. On the Windows server where you want to install SiteWise Edge Gateway, log in as administrator.

    2. Enter PowerShell in the Windows search bar.

    3. In the search results, right click on the Windows PowerShell app. Choose Run as Administrator.

  2. To create an admin group, run the following command.

    net localgroup SWE_ADMIN_GROUP /add

    You must be a user in the SWE_ADMIN_GROUP group to allow admin access for the SiteWise Edge gateway.

  3. To create a user group, run the following command.

    net localgroup SWE_USER_GROUP /add

    You must be a user in the SWE_USER_GROUP group to allow ready-only access for the SiteWise Edge gateway.

  4. To add user, run the following command. Replace user-name and password with the user name and the password that you want to create.

    net user user-name password /add

  5. To add a user to the admin group, run the following command. Replace user-name with the user name that you want to add.

    net localgroup SWE_ADMIN_GROUP user-name /add

You can now use the user name and password to sign in to the SiteWise Edge gateway on the AWS OpsHub for AWS IoT SiteWise application.

Manage the SiteWise Edge gateway certificate

You can use SiteWise Monitor and third-party applications, such as Grafana, on your SiteWise Edge gateway devices. These applications require a TLS connection to the service. SiteWise Edge gateways currently use a self-signed certificate. If you use a browser to open the applications, such as a SiteWise Monitor portal, you might receive a warning for untrusted certificate.

The following shows how to download the trusted certificate from the AWS OpsHub for AWS IoT SiteWise application.

  1. Sign in to the application.

  2. Choose Settings.

  3. For Authentication, choose Download certificate.

The following assumes that you use Google Chrome or FireFox. If you use a different browser, consult the relevant documentation for your browser. To add the certificate that you downloaded in the previous step to a browser, do one of the following:

Change the version of SiteWise Edge gateway component packs

You can use the AWS IoT SiteWise console to change the version of component packs on your SiteWise Edge gateways.

To change the version of a SiteWise Edge gateway component pack

  1. Navigate to the AWS IoT SiteWise console.

  2. In the left navigation pane, choose Gateways.

  3. Select the SiteWise Edge gateway that you would like to change the pack versions for.

  4. Under Gateway configuration, choose View software versions.

  5. On the Edit software versions page, for the pack you want to update the version of, select the version you want to deploy and choose Deploy.

  6. Choose Done.

Update the version of an AWS IoT SiteWise component

Update the AWS IoT SiteWise gateway component on your AWS IoT Greengrass core device to ensure your access to the latest features, performance improvements, and security patches.

To update an AWS IoT SiteWise component on AWS IoT Greengrass

  1. Navigate to the AWS IoT SiteWise console.

  2. In the left navigation pane, choose Edge gateways.

  3. Select the gateway to edit and choose Edit.

  4. In Edge Capabilities, under Software versions, choose Software updates available. The Edit software versions page appears.

  5. Choose the component version.

    Note

    It's recommend to select the latest version available. Keeping gateway components up-to-date helps you maintain optimal functionality for industrial data collection and processing.

  6. Choose Deploy. This starts an AWS IoT Greengrass V2 deployment to update the AWS IoT SiteWise component on the gateway.

Deleting a SiteWise Edge gateway

To delete the SiteWise Edge gateway

  1. Navigate to the AWS IoT SiteWise console.

  2. In the navigation pane, choose Edge gateways.

  3. Choose the gateway you want to delete.

  4. Choose Delete.

  5. To confirm you want to delete the gateway, choose Delete in the window that appears.