AWS iot-sitewise documentation change
Summary
Updated documentation to focus on edge data processing configuration, added details about asset model properties (metrics/transforms/measurements), removed LDAP configuration steps, and added API/CLI prerequisites including credential/certificate requirements
Security assessment
Added documentation about credential management and certificate requirements for API access, which are security-related features. However, there is no evidence of addressing a specific security vulnerability. The removal of LDAP configuration does not indicate a security fix without explicit context.
Diff
diff --git a/iot-sitewise/latest/userguide/edge-processing.md index 4ecd44eca..a1c6f0e64 100644 --- a/iot-sitewise/latest/userguide/edge-processing.md +++ b/iot-sitewise/latest/userguide/edge-processing.md @@ -1 +1 @@ -[](/pdfs/iot-sitewise/latest/userguide/iot-sitewise-guide.pdf#edge-data-collection-and-processing "Open PDF") +[](/pdfs/iot-sitewise/latest/userguide/iot-sitewise-guide.pdf#edge-processing "Open PDF") @@ -5 +5 @@ -Set up edge capability +Process data at the edge @@ -7 +7 @@ Set up edge capability -# Configure edge capabilities on AWS IoT SiteWise Edge +# Configure edge data processing for AWS IoT SiteWise models and assets @@ -9 +9 @@ Set up edge capability -You can use AWS IoT SiteWise Edge to collect and temporarily store data so that you can organize and process device data locally. By enabling edge processing, you can choose to send only aggregated data to the AWS Cloud to optimize your bandwidth usage and cloud storage costs. Using AWS IoT SiteWise components with AWS IoT Greengrass, you can collect and process data at the edge before sending it to the AWS Cloud, or manage it on-premises using SiteWise Edge APIs. +You can use AWS IoT SiteWise Edge to collect, store, organize and monitor equipment data locally. You can use SiteWise Edge so that you can model your industrial data and SiteWise Monitor to create dashboards for your operational staff to visualize data locally. You can process your data locally and send it to the AWS Cloud, or process it on-premises by using the AWS IoT SiteWise API. @@ -11 +11 @@ You can use AWS IoT SiteWise Edge to collect and temporarily store data so that -Data collection happens through data packs and AWS IoT SiteWise components that run on AWS IoT Greengrass. +With AWS IoT SiteWise Edge, you can process raw data locally and choose to send only aggregated data to the AWS Cloud to optimize your bandwidth usage and cloud storage costs. @@ -17 +17 @@ Data collection happens through data packs and AWS IoT SiteWise components that - * If your SiteWise Edge gateway has been disconnected from the AWS Cloud for 30 days, the [Data Processing Pack](./configure-opcua-source.html) is automatically disabled. + * If your SiteWise Edge gateway has been disconnected from the AWS Cloud for 30 days, the [Set up an OPC UA source in SiteWise Edge](./configure-opcua-source.html) is automatically disabled. @@ -22 +22 @@ Data collection happens through data packs and AWS IoT SiteWise components that -###### Topics +## Configure an asset model for data processing on SiteWise Edge @@ -24 +24 @@ Data collection happens through data packs and AWS IoT SiteWise components that - * Set up edge capability in SiteWise Edge +You must configure your asset model for the edge before your can process your SiteWise Edge gateway data at the edge. Your asset model edge configuration specifies where your assets properties are computed. You can choose to compute all properties at the edge and send the results to the AWS Cloud, or customize where to compute each asset property separately. For more information, see [Configure edge data processing for AWS IoT SiteWise models and assets](./edge-processing.html). @@ -25,0 +26 @@ Data collection happens through data packs and AWS IoT SiteWise components that +Asset properties include metrics, transforms, and measurements: @@ -26,0 +28 @@ Data collection happens through data packs and AWS IoT SiteWise components that + * Metrics are the asset's aggregated data over a specified period of time. You can compute new metrics by using existing metric data. AWS IoT SiteWise always sends your metrics to the AWS Cloud for long-term storage. AWS IoT SiteWise computes metrics on the AWS Cloud by default. You can configure your asset model to compute your metrics at the edge. AWS IoT SiteWise sends processed results to the AWS Cloud. @@ -27,0 +30 @@ Data collection happens through data packs and AWS IoT SiteWise components that + * Transforms are mathematical expressions that map an asset property's data points from one form to another. Transforms can use metrics as input data and must be computed and stored at the same location as their inputs. If you configure a metric input to compute at the edge, AWS IoT SiteWise also computes its associated transform at the edge. @@ -29 +32 @@ Data collection happens through data packs and AWS IoT SiteWise components that -## Set up edge capability in SiteWise Edge + * Measurements are formatted as raw data that your device collects and sends to the AWS Cloud by default. You can configure your asset model to store this data on your local device. @@ -31 +33,0 @@ Data collection happens through data packs and AWS IoT SiteWise components that -AWS IoT SiteWise provides the following packs that your SiteWise Edge gateway can use to determine how to collect and process your data. Select packs to enable edge capabilities for your SiteWise Edge gateway. @@ -33 +34,0 @@ AWS IoT SiteWise provides the following packs that your SiteWise Edge gateway ca - * **Data collection pack** enables your SiteWise Edge gateway to collect data from multiple OPC UA servers, and then export the data from the edge to the AWS Cloud. It becomes active once you have added data sources to your SiteWise Edge gateway. @@ -35 +35,0 @@ AWS IoT SiteWise provides the following packs that your SiteWise Edge gateway ca - * **Data processing pack** enables your SiteWise Edge gateway to process your equipment data at the edge. For example, you can use asset models to compute metrics and transforms. For more information about asset models and assets, see [Model industrial assets](./industrial-asset-models.html). @@ -37,18 +37 @@ AWS IoT SiteWise provides the following packs that your SiteWise Edge gateway ca -###### Note - - * The data processing pack is only available on x86 platforms. - - - - -###### To configure edge capabilities - - 1. Navigate to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/). - - 2. In the navigation pane, choose **Edge gateways**. - - 3. Select the SiteWise Edge gateway for which you want to activate edge capabilities. - - 4. In the **Edge capabilities** section, choose **Edit** - - 5. In the **Edge capabilities** section, select **Enable data processing pack (incurs additional charges)**. +For more information about asset properties, see [Define data properties](./asset-properties.html). @@ -56 +39 @@ AWS IoT SiteWise provides the following packs that your SiteWise Edge gateway ca - 6. (Optional) In the **Edge LDAP connection** section, you can grant user groups in your corporate directory access to this SiteWise Edge gateway. The user groups can use the Lightweight Directory Access Protocol (LDAP) credentials to access the SiteWise Edge gateway. Then they can use the AWS OpsHub for AWS IoT SiteWise application, AWS IoT SiteWise API operations, or other tools to manage the SiteWise Edge gateway. For more information, see [Manage SiteWise Edge gateways](./manage-gateways-ggv2.html). +After you create your asset model, you can then configure it for the edge. For more information about configuring your asset model for the edge, see [Create an asset model (console)](./create-asset-models.html#create-asset-model-console). @@ -60 +43 @@ AWS IoT SiteWise provides the following packs that your SiteWise Edge gateway ca -You can also use the Linux or Windows credentials to access the SiteWise Edge gateway. For more information, see [Access your SiteWise Edge gateway using Linux operating system credentials](./manage-gateways-ggv2.html#linux-user-pool). +Asset models and dashboards are automatically synced between the AWS Cloud and your SiteWise Edge gateway every 10 minutes. You can also sync manually from the [Manage SiteWise Edge gateways](./manage-gateways-ggv2.html). @@ -62 +45 @@ You can also use the Linux or Windows credentials to access the SiteWise Edge ga - 1. Select **Activated**. +You can use the AWS IoT SiteWise REST APIs and the AWS Command Line Interface (AWS CLI) to query your SiteWise Edge gateway for data at the edge. Before you query your SiteWise Edge gateway for data at the edge, you must meet the following prerequisites: @@ -64 +47 @@ You can also use the Linux or Windows credentials to access the SiteWise Edge ga - 2. For **Provider name** , enter a name for your LDAP provider. + * Your credentials must be set for the REST APIs. For more information about setting credentials, see [Manage SiteWise Edge gateways](./manage-gateways-ggv2.html). @@ -66 +49 @@ You can also use the Linux or Windows credentials to access the SiteWise Edge ga - 3. For **Hostname or IP address** , enter the hostname or IP address of your LDAP server. + * The SDK endpoint must point to the IP address of your SiteWise Edge gateway. You can find more information in the documentation for your SDK. For example, see [Specifying Custom Endpoints](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/specifying-endpoints.html) in the _AWS SDK for Java 2.x Developer Guide_. @@ -68 +51 @@ You can also use the Linux or Windows credentials to access the SiteWise Edge ga - 4. For **Port** , enter a port number. + * Your SiteWise Edge gateway certificate must be registered. You can find more information about registering your SiteWise Edge gateway certificate in the documentation for your SDK. For example, see the [Registering Certificate Bundles in Node.js](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-registering-certs.html) in the _AWS SDK for Java 2.x Developer Guide_. @@ -70 +52,0 @@ You can also use the Linux or Windows credentials to access the SiteWise Edge ga - 5. For **Base distinguished name (DN)** , enter a distinguished name (DN) for the base. @@ -72 +53,0 @@ You can also use the Linux or Windows credentials to access the SiteWise Edge ga -The following attribute types are supported: commonName (CN), localityName (L), stateOrProvinceName (ST), organizationName (O), organizationalUnitName (OU), countryName (C), streetAddress (STREET), domainComponent (DC), and userid (UID). @@ -74,16 +54,0 @@ The following attribute types are supported: commonName (CN), localityName (L), - 6. For **Admin group DN** , enter a DN. - - 7. For **User group DN** , enter a DN. - - 7. Choose **Save**. - - - - -Now that you've activated edge capabilities on your SiteWise Edge gateway, you need to configure your asset model for the edge. Your asset model edge configuration specifies where your assets properties are computed. You can compute all properties at the edge, or you can configure your asset model properties separately. Asset model properties include [metrics](./concept-overview.html#concept-metric), [transforms](./concept-overview.html#concept-transform), and [measurements](./concept-overview.html#concept-measurement). - -For more information about asset properties, see [Define data properties](./asset-properties.html). - -After you create your asset model, you can then configure it for the edge. For more information about configuring your asset model for the edge, see [Create an asset model (console)](./create-asset-models.html#create-asset-model-console). - -###### Note @@ -91 +56 @@ After you create your asset model, you can then configure it for the edge. For m -Asset models and dashboards are automatically synced between the AWS Cloud and your SiteWise Edge gateway every 10 minutes. You can also sync manually from the local SiteWise Edge gateway application. +For more information about querying data with AWS IoT SiteWise, see [Query data from AWS IoT SiteWise](./query-industrial-data.html). @@ -99 +64 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -AWS IoT Greengrass stream manager +Configure edge capabilities @@ -101 +66 @@ AWS IoT Greengrass stream manager -Configure edge data processing +Add data sources