Post Syndicated from Gary Emmerton original https://aws.amazon.com/blogs/architecture/field-notes-integrating-iot-and-itsm-using-aws-iot-greengrass-and-aws-secrets-manager-part-1/
IT Security is a hot topic in every organization, and in a hyper connected world the need to integrate thousands of IoT devices securely with many different systems at scale is critical.
AWS Secrets Manager helps customers manage their system credentials securely in the AWS Cloud, and with its integration with AWS IoT Greengrass, that capability now extends out to your edge-connected IoT devices.
In this two part blog post, I will walk through the steps to use this integration to give edge devices the capability to connect to and log incidents directly into ServiceNow. The credentials for connecting to ServiceNow are created in AWS Secrets Manager, and deployed locally (encrypted) to the edge device via AWS IoT Greengrass.
Part 1 (this post) gives an overview of the whole solution and the steps for setting up AWS Secrets Manager, creating the required IAM roles and AWS Lambda functions. In part 2 of the blog we will then set up AWS IoT Greengrass and AWS IoT Core so that we can run the functions and access the secret on our edge device (Raspberry Pi).
Enabling edge devices to automatically raise incidents in your organization’s ITSM toolset ensures that you can use existing workflows and incident escalation paths for your edge devices. Previously this would have been challenging to integrate. Additionally, by running this capability at the edge, it enables quicker responses and reduces the need to make calls back to the AWS Cloud.
Overview of solution
The solution makes use of a Raspberry Pi, running AWS IoT Greengrass. AWS Lambda functions on AWS IoT Greengrass capture temperature and humidity sensor data and make calls directly to ServiceNow when thresholds are breached. The integration of AWS Secrets Manager with AWS IoT Core enables the credentials required for the ServiceNow API calls to be available locally. These calls are encrypted and available on the Pi for the Lambda function to use.
The sensors for temperature and humidity in this example are on a Raspberry Pi Sense Hat, which illustrates sensors that could be used in an industrial or manufacturing use case. You can use any type of sensor such as vibration, strain gauges, or other electro-mechanical sensors.
One of the Lambda functions running on AWS IoT Greengrass on the RPi captures the sensor readings, and should a threshold on either be exceeded then it triggers a second Lambda function (again running on AWS IoT Greengrass). This then makes a ‘create incident’ API call to ServiceNow, using the credentials stored in AWS Secrets Manager.
In order to have visibility of the sensor data, and to manage communications between the first and second Lambda functions, all data from the sensors is published to one IoT Topic Data related to any threshold breaches is published to another IoT Topic.
Following is a high-level diagram for the architecture used in this blog.
Prerequisites
To complete the steps in this blog, you need:
- An AWS Account
- A ServiceNow developer instance or other test ServiceNow instance that you can access – You can sign-up for a free ServiceNow developer account
- A Raspberry Pi (I used a Pi 3B with Raspbian Buster)
- A Raspberry Pi SenseHat
- A workstation with the latest AWS Command Line Interface (CLI) installed
Additionally, ensure that you have Python 3.7.x installed with the following Python modules on the Raspberry Pi (Raspian Buster includes Python 3.7 by default). Install the following packages as the root user (sudo pip):
- greengrasssdk
- boto3
- requests
- sense_hat
- datetime
I have taken the approach of having these modules installed on the Pi in order to simplify the creation of the Lambda function. This ensures the function will run locally on the Pi rather than having to build all of the Python modules on the Pi and then zip them to run the Lambda in an AWS IoT Greengrass container.
Walkthrough
The steps in the walkthrough can be achieved from the AWS console. I have focused on the command line approach, using the AWS CLI, as this will give a more detailed view of what is happening and the dependencies between the different components. The overall sequence for the steps is:
- Create secret in AWS Secrets Manager – this will contain the credentials required to access ServiceNow for Lambda running on AWS IoT Greengrass
- Create IAM role – provides permissions for AWS IoT Greengrass to other AWS services, including AWS Secrets Manager
- Create Lambda functions – the functions that will capture sensor data and create the Service Now ticket
- Configure and Deploy IoT Core – deploy our configuration to the Raspberry Pi, covered in Part 2 of this blog
I’ve structured the order of the steps in a logical sequence so that any dependencies of later steps are created first. There are a number of places where a value in the output of one command (such as an ARN) needs to be noted as required for subsequent commands. At times the steps may seem counter-intuitive, but whilst developing this blog, I found this sequence has proven to be the most effective.
Create Secret
First, we create our ‘Secret’ in AWS Secrets Manager. This consists of a secret string containing a JSON object for the username and password required for authentication to the API of my ServiceNow developer instance. For the purposes of this example, we will use the default encryption key for the AWS Secrets Manager service.
The following command, from the AWS CLI, is used to create the new secret, entering the relevant username and password for the ServiceNow instance.
IMPORTANT: the name of the secret must start with “greengrass-“(specified in the command after the “–name” parameter) because the IAM Greengrass managed service role (which we will use later) has permission by default to access secrets that start with this text.
aws secretsmanager create-secret --name "greengrass-snow-creds" --description "Credentials for ServiceNow API access" --secret-string '{"username":"<username>","password":"<password>"}'The successful completion of the *preceding command results in an output on your terminal screen, containing the ARN (Amazon Resource Name) for the new secret.
Create IAM roles
In order for AWS IoT Greengrass to access our new secret and download it securely to AWS IoT Greengrass running on the Pi, we need to give it an IAM role. If we do not set this up correctly then there will be an error when trying to deploy the AWS IoT Greengrass group later in the walkthrough.
Our new IAM role needs a policy document that describes the permissions that we will give the role. The first step is to create the IAM policy document, containing only the permissions for the Greengrass service this new role – to do this we create a text file called assume-role.json containing the following:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "greengrass.amazonaws.com"
},
"Action": "sts:AssumeRole"
}
]
}
Then we run the following command, referencing the file just created:
aws iam create-role --role-name "IoTGGRole" --assume-role-policy-document file://assume-role.jsonAnd finally we need to attach the IAM managed AWS IoT Greengrass service role to our new custom role:
aws iam attach-role-policy --role-name "IoTGGRole" --policy-arn arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicyWe also need a role for our Lambda functions with basic execution permissions; create a text file called lambda-role.json containing the following:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "lambda.amazonaws.com"
},
"Action": "sts:AssumeRole"
}
]
}
Then we run the following command, referencing the file just created:
aws iam create-role --role-name "IoTLambdaRole" --assume-role-policy-document file://lambda-role.jsonAnd finally we need to attach the IAM managed Lambda basic execution role to our new custom role:
aws iam attach-role-policy --role-name "IoTLambdaRole" --policy-arn arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRoleCreate Lambda Functions
We now create the Lambda functions that will be deployed to Greengrass – these functions manage the interactions between the sensors and ServiceNow.
Lambda Function 1 – Get/Publish Sensor Data
The first Lambda function reads the sensor data and publishes the data to an IoT Topic (IoTBlog/sensorData), every 5 seconds, which can then be used by downstream services for analytics. This function also determines whether a threshold has been breached and if so, it publishes the data to a separate IoT Topic (IotBlog/anomaly) to which our second Lambda function is subscribed.
import os
import json
from datetime import datetime
import time
import sys
from sense_hat import SenseHat
import greengrasssdk
import boto3
client = greengrasssdk.client('iot-data')
secClient = greengrasssdk.client('secretsmanager')
sense = SenseHat()
sense.clear()
t_threshold = int(os.environ['tempLimit'])
h_threshold = int(os.environ['humidLimit'])
def lambda_handler(event, context):
return
# Get sensor data and check against thresholds
def getSensorData():
while True:
eventTitle = "no event"
anomaly = False
ts = time.time()
dt = datetime.fromtimestamp(ts).strftime('%Y-%m-%d %H:%M:%S')
temp = round(sense.get_temperature(),2)
humidity = round(sense.get_humidity(),2)
time.sleep(5)
if (temp > int(t_threshold)):
anomaly = True
eventTitle = "Temperature breach"
if (humidity > int(h_threshold)):
anomaly = True
eventTitle = "Humidity breach"
sensorData = { 'title': eventTitle,'dt':dt,'ts':ts,'t':temp,'h':humidity }
publishData(anomaly,sensorData)
# Publish sensor data to IoT topic(s)
def publishData(anomaly,myData):
response = client.publish(
topic = 'IoTBlog/sensorData',
payload = json.dumps(myData) )
We create a text file lambda_function.py containing the code above and then compress into a zip file named lambda_function_1.zip. Once this is done we can then create the function in AWS using the following command:
aws lambda create-function --function-name "1-IoT-GetSensorData" --runtime python3.7 --zip-file fileb://lambda_function_1.zip --handler lambda_function.lambda_handler –role arn:aws:iam::<aws_account_number>:role/IoTLambdaRoleIn order to make use of Lambda functions in AWS IoT Greengrass we then need to publish a version of the function using the following command:
aws lambda publish-version --function-name "1-IoT-GetSensorData"Lambda Function 2 – Create Anomaly Ticket
The second Lambda function is triggered through its subscription to the anomaly data published to the anomaly IoT Topic by the first Lambda function. This then makes a call to the ServiceNow API to create an incident. Prior to making the API call, the function obtains the ServiceNow credentials from the secret that has been made available to AWS IoT Greengrass.
As this is a Resource within the AWS IoT Greengrass Core, it is automatically downloaded to the Raspberry Pi as part of the deployment of the AWS IoT Greengrass Core.
import os
import json
import sys
import greengrasssdk
import requests
client = greengrasssdk.client('iot-data')
secClient = greengrasssdk.client('secretsmanager')
secret_name = "greengrass-snow-creds"
snow_instance = os.environ['snowUrl']
msg = ""
def publishAnomaly(msg,title):
auth = getLocalSecret()
createTicket(auth,msg,title)
# Get secret from GG
def getLocalSecret():
secret = secClient.get_secret_value(SecretId=secret_name)
rawSecret = secret.get('SecretString')
return json.loads(str(rawSecret))
# Create ticket in ServiceNow
def createTicket(auth,eventData,title):
API_ENDPOINT = snow_instance
HEADERS = {"Content-Type":"application/json","Accept":"application/json"}
PARAMS = {
"short_description":title,
"assignment_group":"sensor_team",
"urgency":"2",
"impact":"2",
"comments":eventData
}
request = requests.post(url = API_ENDPOINT, auth=(str(auth["username"]),str(auth["password"])), headers=HEADERS, data = json.dumps(PARAMS))
print("Response:",request)
def lambda_handler(event, context):
msg = json.dumps(event)
msg = json.loads(msg)
title = "Sensor Threshold - " + msg["title"]
publishAnomaly(msg,title)
return
We create another text file, lambda_function.py containing the code above and then compress into a zip file named lambda_function_2.zip. Once this is done we can then create the function in AWS using the following command:
aws lambda create-function --function-name "2-IoT-ServiceNow" --runtime python3.7 --zip-file fileb://lambda_function_2.zip --handler lambda_function.lambda_handler –role arn:aws:iam::<account_number>:role/IoTLambdaRoleIn order to make use of Lambda functions in Greengrass we then need to publish a version of the function using the following command:
aws lambda publish-version --function-name "2-IoT-ServiceNow"Conclusion
In this post, I showed you the steps for integrating IoT and ITSM by setting up AWS Secrets Manager, creating the required IAM roles and AWS Lambda functions. Now you can proceed to part 2 of the blog to set up AWS IoT-Core and AWS IoT Greengrass to make use of the secret and functions that you created in this post.