You can use the Deploy tool to install Node.js servers as members of a collective. A
Node.js collective member is called a Node.js server in this documentation.
Before you begin
Stabilized feature: Managing Node.js processes by using
Liberty collectives is stabilized. V8 is the
final supported Node.js version for
Liberty
collective members. For on-premises or bring-your-own infrastructure environments, use Docker
containers that are hosted and managed by
IBM Cloud Pak for Applications. For hosted environments, use Docker
containers in
IBM Cloud® Kubernetes Service.
- Create a Liberty collective that includes
the hosts to which you plan to install the Node.js server. See the Before you begin
section of Deploying resources with Admin Center and the Configuring a Liberty collective
topic.
- Complete the Before you begin section and steps 1-4 in Deploying Node.js servers using deployment REST
APIs. You do not need to complete step 2b unless the Node.js application is on the collective
controller.
- In version 17.0.0.2 and earlier, you can upload a maximum of 200 MB for server and application
packages. Use a file that is already on the collective controller option to avoid this limitation.
Starting in version 17.0.0.3 and later, the maximum increases to 1 GB.
About this task
After you install Node.js, configure the Liberty collective, and register the target host,
use the Deploy tool to install the Node.js server as a member of the collective.
Procedure
-
Go to the Deploy tool.
- From the Toolbox, select Deploy
.
- From details on hosts in the Explore tool, select .
To directly launch the Deploy tool in the future, you can use the URL that is shown in the
browser when you view the Deploy tool.
-
Select to install a Node.js application package.
-
For DEFAULT SERVER TYPES, select Node.js.
-
For DEFAULT RULES, select the Application Package
default rule.
-
Under APPLICATION PACKAGE, select CONFIRM.
-
For Deployment Parameters, specify the server package file to deploy,
the server name, and the cluster name. If you drag a package to the Deploy tool or browse for a
package, the server package file name value is set automatically. You can also type in a value. To
specify a cluster name, you can select a cluster from a list of existing clusters or type in a new
cluster name.
- Drag or browse option
To upload a file from your browser system to the collective
controller, drag a package to the Deploy tool or browse for a package.
- Use a file located on the collective controller option
To use a
file in the controller, the Node.js application must be available to the controller. If you have not
done so already, complete step 2b in Deploying Node.js servers using deployment REST APIs. You then can use the Use a
file located on the collective controller option.
After you upload or drop a file, select Use a file
located on the collective controller again to edit the Application
directory field.
Ensure that you run the wlpn-collective registerHost or
wlpn-collective updateHost command with the same user as the user that you
specify to deploy the member server. For example, if you run the command as the root user and then
later deploy a member as a different user, the deployment fails. The failure occurs because the
deployment service does not have rights to push a file to the /root/wlpn
directory.
-
For Selected Hosts, select the host computers on which to install the
server. If you do not see the wanted target host in the list of available hosts, you can search for
a host.
-
For Security Details, specify a password to protect newly generated
keystore files that contain server authentication credentials.
The product generates keystore files in the resources directory of each
deployed server.
-
Select Deploy.
Results
The Deploy action runs. The Deploy tool displays messages about deployment status and
results.