Private Nodes

Overview

Private node is an enebular Asset used inside a Flow. Please refer to Flows page for the information about flows. Normally, only nodes published on nodered.org can be used inside a flow. Private Nodes allow us to use user-created nodes without publishing it to nodered.org.

After uploading a user-developed private node to the project, that node would be displayed inside Web Editor or enebular editor Node-RED palette. Users are able to create flows using private nodes displayed in the palette. Also, the created flow can be deployed and executed to AWS Lambda、Heroku, or devices running enebular-agent.

Private nodes are only available for Enterprise Plan projects.

Creating Private Node

The Private nodes creation method is similar to the creation method of Node-RED nodes. Please refer to the following for detailed information.

But the following constraints apply for private nodes:

  • package name (name value in package.json) must start with enebular-privatenode-contrib-
  • a private node with the same package name cannot be registered in the same project.
  • package file size must not exceed 2MB
  • a node with the same Node Type as a private node does not exist in the Node-RED palette

Execute the following command in the directory containing private node source files.

npm pack

<name>-<version>.tgz file would be created after command execution (name and version are specified in the package.json).

Please refer to Private Node Uploading for the uploading process.

Private Node Management

You can upload, update or delete private nodes. The following functions are introduced bellow.

Private Nodes List

After logging in enebular, a list of user projects will be displayed. After selecting the project, click Private Nodes on the side menu to view the private nodes list.

Uploading

To Uploading a private node, click the + button at the bottom right of the Asset list screen or Private Nodes list screen. The user can enter the following:

Item Description
Private Node File(tgz) Private node package file.
Name The name of the private node. Used to distinguish private node
Description Private node description
Privilege Default access permission. By default, the collaborator users have these permissions.

Overview screen

Click on the private node displayed on the Asset list or Private Nodes list to view Private Node Overview. The following information is displayed.

Item Description
Package Name Private node package file. Name set in package.json name field
Filename The filename of the uploaded packaged file
Size The size of the uploaded packaged file
Integrity The hash value of the packaged file

You can update the packaged file by clicking the Update button.

Also, you can tag private node by clicking click to add tag.

Access screen

Click the Access at the top of the Overview screen to display the Access screen. This screen allows you to set the access permissions for the private node.

Settings screen

Clicking Settings at the top of the Overview screen will display the Settings screen. On this screen, you can change the following and delete the private node.

  • Name
  • Description

Creating a flow with private nodes

Flow with private nodes can be created in the following environments.

Development environment Version Additional information
Web Flow Editor no restrictions Editor that started by pressing the Edit button on the Flow Overview screen
enebular editor 1.0.0 or higher enebular-agent 2.15.0 or higher is required for remote mode usage

The private node will be displayed inside the Node-RED palette in the above environments.

Deployment of flow with private nodes

The deployment method for the flow with private nodes is the same as the regular flow deployment. But following restrictions apply

Deploy Target Version Additional information
AWS Lambda no restrictions
Heroku created from enebular 2.25.0 or higher (enebular-agent-heroku 1.1.2 or higher) enebular-agent-heroku version can be checked as the value of the environment variable AGENT_HEROKU_VERSION of the deploy destination. If AGENT_HEROKU_VERSION environment variable does not exist, the Heroku app was created from the earlier versions of enebular. In that case, you cannot deploy flow with private nodes
enebular-agent 2.15.0 or higher Only licensed devices

※ Private nodes cannot be used with enebular-edge-agent

To deploy a flow with private nodes to the Heroku app which does not support private nodes, you will first need to recreate that Heroku app. Please refer to Create App with Heroku Button for how to build Heroku environment. It is impossible to create an app with the existing name in Heroku, so you may need to change the name of the existing app if you want to use the same name.

Please refer to Deploying for more information about flow deployment。

results matching ""

    No results matching ""