iot-jobs-agent v1.1.0

iot-jobs-agent

A simulation AWS IoT Jobs agent that can process jobs for thousands of devices and report a state to AWS IoT Jobs.

Current version: 1.1.0

📋 Table of content

• Installation
• Description
• Usage
• AWS credentials
• Using a specific region

🚀 Install

npm install --global iot-jobs-agent

Once installed, you can verify that the package was successfully installed by running the following command.

iot-jobs-agent --version

You can also alternatively use npx without having to explicitely install the package.

npx iot-jobs-agent --version

🔰 Description

The IoT Jobs agent is a Node.js command-line tool providing a way for developers, architects and DevOps teams to test a deployment of AWS IoT Jobs at scale by simulating the behavior of a real device.

When used, the agent allows you to create as many virtual thing(s) as needed in the AWS IoT device registry, and to download jobs from the AWS IoT Jobs data plane, potentially execute the jobs locally, and report back a state to the AWS IoT Jobs data plane.

📘 Usage

You will find here a tutorial describing a step-by-step process to use the device agent.

Creating devices

The iot-jobs-agent package provides a convenient way to create virtual devices in the AWS IoT device registry to simulate a large fleet of devices. To create devices, you just need to tell the agent how many it should create.

# The below example will create 10 things in your AWS IoT device registry.
iot-jobs-agent create --number 10

All things created by the agent will have the attribute device_simulator set to the value true.

Parameters

• --number: the number of virtual devices to delete.

Deleting devices

To delete previously created devices, you can use the delete command.

# The below example will delete 10 things previously created by the agent.
iot-jobs-agent delete --number 10

Parameters

• --number: the number of virtual devices to create.

Retrieving device jobs status

The agent allows you to list the jobs available for a created fleet of virtual devices.

iot-jobs-agent status --number 10

Parameters

• --number: the number of virtual devices to retrieve the job status from.

Executing jobs

The agent is able to simulate the execution of jobs on a fleet of virtual devices.

iot-jobs-agent execute --number 10

Parameters

• --number: the number of virtual devices to executes the job from.
• --failure-rate: the percentage of jobs to fail.
• --min-delay: an optional minimum delay (in milliseconds) to use when executing jobs.
• --max-delay: an optional maximum delay (in milliseconds) to use when executing jobs.

🔐 AWS credentials

The iot-jobs-agent command needs to retrieve STS tokens from AWS in order to interact with services on your account.

If you happen to have the AWS CLI installed and configured with valid credentials on your local machine, the iot-jobs-agent will automatically use these credentials to authenticate against the AWS services it is making requests against.

Read more on Installing the AWS CLI and Configuring the AWS CLI.

Using AWS Profiles

If you have configured the AWS CLI with different profiles, it is possible to explicitly specify an AWS profile to use with the iot-jobs-agent command by specifying the AWS_PROFILE variable in your environment such as in the following example.

AWS_PROFILE=my-custom-profile iot-jobs-agent <command>

Specifying custom AWS credentials

If you do not have the AWS CLI installed or configured, or you would like to use the iot-jobs-agent command with custom credentials, you can pass your AWS_ACCESS_KEY_ID and your AWS_SECRET_ACCESS_KEY as environment variables of the jobs-agent such as in the following example :

$ AWS_ACCESS_KEY_ID=<access-key-id> AWS_SECRET_ACCESS_KEY=<secret-access-key> iot-jobs-agent <command>

If you are using temporary credentials you can also specify an AWS_SESSION_TOKEN additionally to the aforementioned variables.

🌎 Using a specific region

By default, the iot-jobs-agent command will use the AWS region specified in your default profile in case you have installed and configured AWS CLI. Alternatively, the region to use can be explicitly specified by setting the AWS_REGION environment variable.

$ AWS_REGION=us-east-1 iot-jobs-agent <command>