AWS iot-sitewise documentation change
Summary
Removed Step 1 about deploying AWS IoT SiteWise demo and made various editorial improvements including simplified prerequisites, clearer Grafana configuration instructions, and updated links
Security assessment
The changes primarily restructure documentation flow and improve clarity. No security vulnerabilities or weaknesses are addressed. References to IAM roles and authentication are part of standard configuration instructions rather than new security documentation.
Diff
diff --git a/iot-sitewise/latest/userguide/visualize-with-grafana.md b/iot-sitewise/latest/userguide/visualize-with-grafana.md index 2ba173b0d..1c97bfdf9 100644 --- a//iot-sitewise/latest/userguide/visualize-with-grafana.md +++ b//iot-sitewise/latest/userguide/visualize-with-grafana.md @@ -5 +5 @@ -PrerequisitesStep 1: Deploy the AWS IoT SiteWise quick start demoStep 1: Configure your Amazon Managed Grafana workspaceStep 2: Add AWS IoT SiteWise as a data sourceStep 3: Create a dashboard to explore and visualize your data(optional) Step 4: Set up alerts to monitor performanceStep 5: Clean up resources after the tutorialAdditional resources +PrerequisitesStep 1: Configure your Amazon Managed Grafana workspaceStep 2: Add AWS IoT SiteWise as a data sourceStep 3: Create a dashboard to explore and visualize your data(optional) Step 4: Set up alerts to monitor performanceStep 5: Clean up resources after the tutorialAdditional resources @@ -9 +9 @@ PrerequisitesStep 1: Deploy the AWS IoT SiteWise quick start demoStep 1: Configu -This tutorial guides you through configuring the AWS IoT SiteWise data source plugin. Grafana, a data visualization platform, enables you to create dashboards that visualize and monitor your industrial data from AWS IoT SiteWise. In this tutorial, a sample dataset from a wind farm demonstration is used to illustrate key concepts. After you become familiar with the process, you can repeat the tutorial with your own data. +This tutorial guides you through configuring the AWS IoT SiteWise data source plugin with Grafana, a data visualization platform. With Grafana, you can create dashboards that visualize and monitor your industrial data. In this tutorial, a sample dataset from a wind farm demonstration is used to illustrate key concepts. After you become familiar with the process, you can repeat the tutorial with your own data. @@ -11 +11 @@ This tutorial guides you through configuring the AWS IoT SiteWise data source pl -After you complete this tutorial, you can do the following items: +After you complete this tutorial, you can do the following: @@ -21 +21 @@ After you complete this tutorial, you can do the following items: - * Combine AWS IoT SiteWise data with other AWS data sources like [Amazon CloudWatch](https://aws.amazon.com/cloudwatch/) or [Amazon Timestream](https://aws.amazon.com/timestream/) + * Combine AWS IoT SiteWise data with other AWS data sources such as [Amazon CloudWatch](https://aws.amazon.com/cloudwatch/) or [Amazon Timestream](https://aws.amazon.com/timestream/) @@ -30,2 +29,0 @@ After you complete this tutorial, you can do the following items: - * Step 1: Deploy the AWS IoT SiteWise quick start demo - @@ -49 +47 @@ After you complete this tutorial, you can do the following items: -To complete this tutorial, you need the following items: +To complete this tutorial, you need the following: @@ -55 +53 @@ To complete this tutorial, you need the following items: - * A running AWS IoT SiteWise demo. For more information, see [Use the AWS IoT SiteWise demo](./getting-started-demo.html). + * A running AWS IoT SiteWise demo. @@ -65,26 +63 @@ The demo typically takes around 3 minutes to create. If the demo fails to create -Keep all demo resources until you complete this tutorial. Deleting any components might disrupt the demo's functionality and impact your ability to visualize data in Grafana. - - - - -## Step 1: Deploy the AWS IoT SiteWise quick start demo - -This tutorial demonstrates how to use AWS IoT SiteWise with sample data generated by the AWS IoT SiteWise demo. The demo creates a simulated wind farm environment for you to explore, generating sample data that lasts for one week. The demo also automatically provisions several AWS resources including Lambda functions, a CloudWatch Events rule, and required IAM roles. - -###### To create the demo in the AWS IoT SiteWise console - - 1. Navigate to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/) and find the **SiteWise demo** in the upper-right corner of the page. - - 2. Under **SiteWise demo** , change the **Days to keep demo assets** field to `7`. - - 3. Choose **Create demo**. - - 4. To verify that you properly created the demo resources, take the following actions: - - 1. In the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/), choose **Models** from the left navigation pane. - - 2. Verify that the `Demo Wind Farm Asset Model`, and `Demo Turbine Asset Model` appear in your list of models. - - 3. Choose **Assets** from the left navigation pane. - - 4. Verify that the `Demo Wind Farm Asset` appears in your list of assets. +Keep all demo resources until you complete this tutorial. Deleting any components might disrupt the demo's functionality and affect your ability to display data in Grafana. @@ -95,6 +67,0 @@ This tutorial demonstrates how to use AWS IoT SiteWise with sample data generate -###### Note - -Keep all demo resources until you complete this tutorial. Deleting any components may disrupt the demo's functionality and impact your ability to visualize data in Grafana. - -The demo typically takes around 3 minutes to create. If the demo fails to create, it may indicate insufficient permissions in your AWS account. In this case, switch to an account with administrative access. For more information about required permissions, see [How AWS IoT SiteWise works with IAM](./security_iam_service-with-iam.html). For detailed set up instructions, see [AWS IoT SiteWise Demo](./getting-started-demo.html). - @@ -109 +76 @@ In this procedure, create and configure an Amazon Managed Grafana workspace to v - 3. Under **Workspace details** , enter a name for your workspace, for example, `SiteWiseTutorialDemo`. + 3. Under **Workspace details** , enter a name for your workspace, such as `SiteWiseTutorialDemo`. @@ -117 +84 @@ In this procedure, create and configure an Amazon Managed Grafana workspace to v - * If AWS IAM Identity Center in your account isn't enabled, you will be prompted to do that first. For detailed instruction about how to set up user access, see [Identity-based policy examples for Amazon Managed Grafana](https://docs.aws.amazon.com/grafana/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-create-workspace-standalone) in the _Amazon Managed Grafana User Guide_. + * If AWS IAM Identity Center in your account isn't enabled, you will be prompted to set it up first. For detailed instruction about how to set up user access, see [Identity-based policy examples for Amazon Managed Grafana](https://docs.aws.amazon.com/grafana/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-create-workspace-standalone) in the _Amazon Managed Grafana User Guide_. @@ -121 +88 @@ In this procedure, create and configure an Amazon Managed Grafana workspace to v - 8. Under **Workspace configuration options** , do the following actions: + 8. Under **Workspace configuration options** , take the following actions: @@ -123 +90 @@ In this procedure, create and configure an Amazon Managed Grafana workspace to v - 1. Select **Turn Grafana alerting on**. This allows you to create and manage alerts through a centralized interface in your workspace. For more information, see [Working with Grafana alerting](https://docs.aws.amazon.com/grafana/latest/userguide/alerts-overview.html) in the _Amazon Managed Grafana User Guide_. + 1. Select **Turn Grafana alerting on**. With this setting, you can create and manage alerts through a centralized interface in your workspace. For more information, see [Working with Grafana alerting](https://docs.aws.amazon.com/grafana/latest/userguide/alerts-overview.html) in the _Amazon Managed Grafana User Guide_. @@ -145 +112 @@ Be sure to enable plugin management. If you don't select this option, you cannot - 14. Confirm the workspace details, and choose **Create workspace**. This process could take a couple minutes. + 14. Confirm the workspace details, and choose **Create workspace**. This process takes a couple of minutes. @@ -147 +114 @@ Be sure to enable plugin management. If you don't select this option, you cannot - 15. On the **Authentication** tab, under AWS IAM Identity Center, assign users or groups to your workspace by doing the following actions: + 15. On the **Authentication** tab, under **AWS IAM Identity Center**. assign users or groups to your workspace by doing the following: @@ -155,4 +121,0 @@ To manage the Grafana workspace, you must assign the `Admin` role to at least on - 16. In the workspace details page, choose the URL displayed under **Grafana workspace URL**. The workspace URL opens the Grafana workspace console login page. - - 17. Choose **Sign in with AWS IAM Identity Center** and enter your credentials. These credentials only work if you responded to the email from Amazon Managed Grafana that prompted you to create a password for IAM Identity Center. - @@ -172 +135,3 @@ Before you can start querying your wind farm data, the AWS Data Sources plugin n - 1. Sign in to your Amazon Managed Grafana workspace using AWS IAM Identity Center. + 1. Open the [Amazon Managed Grafana console](https://console.aws.amazon.com/grafana/). In your workspace details page, choose the URL displayed under **Grafana workspace URL**. The workspace URL opens the Grafana workspace console login page. + + 2. Choose **Sign in with AWS IAM Identity Center** and enter your credentials. These credentials only work if you responded to the email from Amazon Managed Grafana that prompted you to create a password for IAM Identity Center. @@ -174 +139 @@ Before you can start querying your wind farm data, the AWS Data Sources plugin n - 2. In the left navigation pane, choose **Apps** , then **AWS Data Sources** , and then select the **AWS services** tab. + 3. In the left navigation pane, choose **Apps** , then **AWS Data Sources** , and then select the **AWS services** tab. @@ -176 +141 @@ Before you can start querying your wind farm data, the AWS Data Sources plugin n - 3. Under **AWS IoT SiteWise** , choose **Install now** to install the latest version of the AWS IoT SiteWise plugin. + 4. Under **AWS IoT SiteWise** , choose **Install now** to install the latest version of the AWS IoT SiteWise plugin. @@ -178 +143 @@ Before you can start querying your wind farm data, the AWS Data Sources plugin n - 4. Navigate to the **Data sources** tab, and select **IoT SiteWise** as the service. + 5. Navigate to the **Data sources** tab, and select **IoT SiteWise** as the service. @@ -180 +145 @@ Before you can start querying your wind farm data, the AWS Data Sources plugin n - 5. Under **Default region** , select the region where you want to retrieve data from, for example, **US East (N. Virginia)**. + 6. Under **Default region** , select the Region where you want to retrieve data from, for example, **US East (N. Virginia)**. @@ -182 +147 @@ Before you can start querying your wind farm data, the AWS Data Sources plugin n - 6. After specifying the parameters for the plugin, select **Add data source**. + 7. After specifying the parameters for the plugin, select **Add data source**. @@ -184 +149 @@ Before you can start querying your wind farm data, the AWS Data Sources plugin n - 7. Select **Go to settings**. + 8. Select **Go to settings**. @@ -186 +151 @@ Before you can start querying your wind farm data, the AWS Data Sources plugin n - 8. Under **Connection details** , select **Save and test** to verify that the service is working. + 9. Under **Connection details** , select **Save and test** to verify that the service is working. @@ -203 +168 @@ In this step, create a Grafana dashboard to visualize the demo wind farm data th - 4. Under the **Query type** , select **Get property value aggregates** from the dropdown menu. This query type allows you to retrieve aggregated values for asset properties over time. + 4. Under **Query type** , select **Get property value aggregates** from the dropdown menu to retrieve aggregated values for asset properties over time. @@ -209 +174 @@ In this step, create a Grafana dashboard to visualize the demo wind farm data th - 7. Navigate to the right navigation pane, and give the new panel a title, for example, `Turbine Demo 1 (Average Power)`. Choose **Apply** to save your changes. + 7. In the right navigation pane, give the new panel a title, such as `Turbine Demo 1 (Average Power)`. Choose **Apply** to save your changes. @@ -213 +178 @@ In this step, create a Grafana dashboard to visualize the demo wind farm data th -Whenever you make any changes to the dashboard, ensure you save the dashboard before refreshing the page or navigating away, otherwise you will lose your progress. +Whenever you make any changes to the dashboard, save the dashboard before refreshing the page or navigating away. Otherwise, you will lose your progress. @@ -215 +180 @@ Whenever you make any changes to the dashboard, ensure you save the dashboard be - 8. Navigate to the top-right corner and select **Save dashboard**. You will be prompted to enter a name for your dashboard, for example, `SiteWise Wind Farm Demo Dashboard`. + 8. In the top-right corner, select **Save dashboard**. You will be prompted to enter a name for your dashboard, for example, `SiteWise Wind Farm Demo Dashboard`. @@ -230 +195 @@ For information about sharing dashboards, see [Sharing dashboards and panels](ht - 3. Under the **Query type** select **Get property value** from the dropdown menu and under **Asset** , select `Demo Wind Farm Asset`, then `Demo Turbine Asset 1`. + 3. Under **Query type** , select **Get property value** from the dropdown menu and under **Asset** , select `Demo Wind Farm Asset`, then `Demo Turbine Asset 1`. @@ -232 +197 @@ For information about sharing dashboards, see [Sharing dashboards and panels](ht - 4. Under **Property** select **Wind Speed** from the available properties. Select **Run queries** to update the changes. + 4. Under **Property** , select **Wind Speed** from the available properties. Select **Run queries** to update the changes. @@ -236 +201 @@ For information about sharing dashboards, see [Sharing dashboards and panels](ht - 6. Navigate to the right navigation pane, and give the new panel a title, for example, `Turbine Demo 1 (Wind Speed)`. + 6. In the right navigation pane, give the new panel a title, such as `Turbine Demo 1 (Wind Speed)`. @@ -242 +207 @@ For information about sharing dashboards, see [Sharing dashboards and panels](ht -The following image shows what your dashboards in Grafana might look like when you complete this step. +The following image displays what your Grafana dashboards might look like when you complete this step. @@ -251 +216 @@ The following image shows what your dashboards in Grafana might look like when y -Alerts show state changes after they occur to identify performance issues with your industrial equipment. For more information, see [Amazon Managed Grafana alerting](https://docs.aws.amazon.com/grafana/latest/userguide/alerts-overview.html) in the _Amazon Managed Grafana User Guide_. +Alerts indicate state changes after they occur to identify performance issues with your industrial equipment. For more information, see [Amazon Managed Grafana alerting](https://docs.aws.amazon.com/grafana/latest/userguide/alerts-overview.html) in the _Amazon Managed Grafana User Guide_. @@ -287 +252 @@ The stack takes around 15 minutes to delete. If the demo fails to delete, choose -For more information, see [Delete an Amazon Managed Grafana workspace](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-edit-delete-workspace.html) in the _Amazon Managed Grafana User Guide_. +For more information, see [Delete the AWS IoT SiteWise demo](./getting-started-demo.html#delete-getting-started-demo). @@ -312,6 +276,0 @@ This procedure deletes a workspace. Other resources may not be deleted. For exam -For more information, see [Delete the AWS IoT SiteWise demo](./getting-started-demo.html#delete-getting-started-demo). - -###### Note - -This procedure deletes a workspace. Other resources might not be deleted. For example, IAM roles that were in use by the workspace are not deleted (but might be unlocked if they are no longer in use). -