Worker Node is an offchain runner that allows you to execute custom logic in a form of a NodeRed Flows that details and lifecycle parameters are specified within EnergyWebX worker node pallet solution and solution groups definitions.
Worker Node have EWX account called Worker Account assigned to be able to perform work. Later, worker account can be assigned to EWX Operator Account. Worker Node via this Operator<>Worker account link is monitoring on-chain actions and therefore responds to Operator Account on-chain actions related to subscribing/unsubscribing from solution groups. Solutions that Worker Nodes are running can be created and have their lifecycle controlled by Launchpad SmartFlow offering - together they provide a once-stop-shop toolkit that:
Vastly reduces operational overhead
Allows for blockchain-integrated creation of distributed networks & applications
Provides enterprise-level support, reliability and user experience
Worker Node offering provides a full SaaS experience and should be considered as an alternative to Marketplace Desktop App based Worker node.
You should go for Worker Node Launchpad Offering if:
You dont want to keep your laptop running 24/7
You dont have possibility to use your hardware for reliably running desktop app
You want reliable server version that comes with supporting team that will cover any Worker issues should they occure.
A worker node is application which enables users to construct distributed computing networks which securely execute useful business logic. Each worker node can execute multiple solutions at the same time; subject to the limits of each operator system.
The Launchpad Worker Node Offering enables to configure, launch, as well as maintain Worker Nodes and to connect them to the EW Marketplace app so they can execute solutions.
Worker Node health checking system showcases 3 different statuses that determines various lifecycle phases for given Worker Node.
Running
Worker is healthy and running without any errors. Worker Account configured for that Worker Node is linked to Operator Account on EWX.
Running - Waiting for Subscription
Worker is healthy and running, but Worker Account configured for that Worker Node is not yet linked to any Operator Account on EWX.
Stopped
Either Worker Node crashed, health checking system failed or is still being provisioned (for newly set-up workers) If occurs and remains in Stopped state for longer time 16+ hours, please contact support.
Page describes how to effectively manage your Worker Node.
To learn more about your node and update any details post-deployment, head to the details via the "i" button on your node overview under the Manage screen.
Note that you can always delete your node from the details or from the overview. All deleted node will reappear in your Manage screen under pending deployment.
Please remember that for your changes to go live you always need to click "Save" to confirm each operation and restart your node with new configuration.
Let's review each element of your node details:
The Node Health Status indicates whether your node is running. Until the node's machine status is "Ready", your node health status will always be stopped. Once your node is Ready on a machine level, it will move to the "Running" health status.
To read more about Worker Node statuses check Worker Node Statuses guide page.
The About section contains basic information about your node such as its name, network type, node type and its deployment date and time.
It also contains the link to the Operator console. The operator console is where you can manage your operator account actions. View our devoted guide for details.
The infrastructure details contains cloud information, your node's region as indicated during deployment and the machine status which is the status you can also see in your node overview in the Manage screen.
The worker node section contains the Public key and Seed phrase for your node. From this section you can:
View and copy your existing data
Download your existing data
Import new data: this means importing an existing seed
Create new: this means re-generating a new public key and seed combo
Please note that importing creating and importing new data will erase your current data, it is therefore recommended you proceed carefully with those two actions.
IPFS is place where Solutions NodeRed work logic files created by SmartFlow are stored. The IPFS gateway section allows you to switch between IPFS credential options currently supported.
Normally your worker start to run all active solutions that are in solution groups your operator account is subscribed to. Solutions whitelist let you explicitly define of subset of solutions that should be run (that still falls into above condition)
You should specify one or more desired solution namespaces and save to enable this feature.
Please note, that once this option is enabled, any non-whitlisted solutions will not be runnable.
To get back to default state, remove whitelisted solution namespaces.
This guide will take you through the steps of purchasing, setting up and deploying Worker Nodes (WNS).
Before you can set up a new Worker node, you will need to purchase a subscribtion.
To subscribe:
Verify that you are in the VaaS environment of Launchpad by checking the toggle button on the top right. You will easily recognize the VaaS environment by its dark theme
Under Worker Node in the left hand bar, go to "Purchase" and fill in the purchase form
Click on the "Subscribe" button. You will be redirected to the payment page.
Once the payment is completed, you are ready to set-up your Worker Node.
Once you have purchase one or more Worker Nodes, you are ready to deploy them.
Under Worker Node > "Manage", look for "Pending deployments" at the top of the page. You will find all newly purchased Worker Nodes that have not yet been deployed. Previously deployed nodes that were deleted will also show up here.
Click on "Deploy" to start setting up your Worker node
The first step required is to fill in the basic Node details: Name and Region. The name should have a minimum of 6 characters and can contain spaces.
The second step is the IPFS Gateway. By default, you are always able to choose a Public IPFS gateway. Private and BYOC (bring your own credentials) for IPFS support will come in near future. Note that you can deploy your node with a Public gateway and change that setting in the future.
The third and last steps asks you to configure your Account. You can do that by either bringing your own keys should you already have an account you wish to use, or generate new keys. To bring your own keys, you will need the 12 words seed phrase. The account keys can be re-generated or imported even after deployment. ****** Side note - if you already have a running worker node behind marketplace desktop app, you can use the same Worker Account here as the one that you use on your local environment. Just remember to pause your Marketplace app worker engine after the set-up here is completed. You can always remove Launchpad Worker Node and re-enable Marketplace app worker at any time. Both workers can be enabled at the same time temporarily, but it will cause them to compete against each other and might cause unpredictable voting behaviour, hence this is not recommended. ******
Click Continue, you will be offered to be redirected to your Manage page.
Your newly deployed node will show in the Worker Nodes table with the status "Requested"
After several minutes, you will receive a notification regarding the provisioning of your Worker node, and its status will change to "Provisioning". You can already access your node details via the "i" icon on the right of your node overview.
Within 15 minutes, your node will switch to the "Ready" status and you will be notified
After your node is properly set-up & provisioned, in details page you should see green "Running - waiting for Subscribtion" - which indicates that Worker Account configured for that worker should be still linked to Operator Account. If you have used Worker Account that was previously linked to an Operator Account you should see "Running" status.
Once your node provisioning is completed the remaining actions should be conducted either by Marketplace App/WebApp or directly with chain interactions.
To innitiate Marketplace App/WebApp based Worker Account <> Operator Account linking, go to Worker Node details page, and click "Open Operators Console".
Once oppened, choose desired option and proceed with accounts linkage.
Full instruction on how to Link Operator and Worker account Using above options is provided . This concludes necessary actions that should be taken on Launchpad side, the remaining operations should be conducted with Operators Account using any of the available Marketplace app options.
