This component deploys Node-RED onto a Greengrass device using the nodered/node-red container from Docker Hub. The Node-Red environment has access to all the environment variable resources set by Greengrass which allows to interact with Greengrass services and other component such as TokenExchangeServer and StreamManager. For this it uses host networking mode. If you prefer running the container with bridge networking or dedicated networking you might not be able to access external services without additional configuration of the host.
To allow this component to use Greengrass IPC you need to add an accessControl section in the component configuration as explained in Authorize components to perform IPC operations.
This component installs a specific version of Node-RED and for consistency the component version tracks the Node-RED version being deployed.
To remotely deploy flows to Greengrass Core devices running this component you can use the Greengrass CLI for Node-RED.
This component has the following versions:
- 2.1.3
This component is a generic component. The Greengrass nucleus runs the component's lifecycle scripts.
For more information, see component types
This component requires Docker to be present on the device.
The default user in the docker container is 1000:1000 and it is therefore recommended to specify a "runAs":"1000:1000" in the deployment configuration of this component. This can also be done by using the Advanced Configuration option in the console for this component when creating or revising the deployment.
When you deploy a component, AWS IoT Greengrass also deploys compatible versions of its dependencies. This means that you must meet the requirements for the component and all of its dependencies to successfully deploy the component. This section lists the dependencies for the released versions of this component and the semantic version constraints that define the component versions for each dependency. You can also view the dependencies for each version of the component in the AWS IoT Greengrass console. On the component details page, look for the Dependencies list.
| Dependency | Compatible versions | Dependency type |
|---|---|---|
| Greengrass nucleus | >=2.0.0 <2.5.0 | Soft |
| Token exchange service | >=0.0.0 | Hard |
| Docker Application Manager | >=0.0.0 | Soft |
| aws.greengrass.labs.nodered.auth | ~1.0.0 | Hard |
This component provides the following configuration parameters that you can customize when you deploy the component.
headless
Configure Node-RED to run in headless mode. No UI will be available.
This component uses the following log file:
/greengrass/v2/logs/aws.greengrass.labs.nodered.docker.logThe following table describes the changes in each version of the component.
| Version | Changes |
|---|---|
| 2.1.3 | Initial version for Node-RED 2.1.3 |
This component would have not been possible without the great work done by Node-RED at nodered.org and the effort put in creating the official docker containers at https://hub.docker.com/r/nodered/node-red.