Installing API Connect collective
Install the API Connect collective Member host and the API Connect collective controller. Add the API Connect collective to the Cloud Manager.
Before you begin
- IBM® API Connect collectives are deprecated in IBM API Connect Version 5.0.7 in favor of container runtimes. For more information and background, see Open, scalable, flexible runtime management of APIs through API Connect enabled containers. For information on setting up and migrating to containers, see Installing a containerized runtime environment.
- Existing customers can continue to use their collectives with IBM API Connect Version 5.0.7, and if wanted can expand their collective deployments to new servers. API Connect collectives are supported for existing customers until the end of support of IBM API Connect Version 5.0 (see Software lifecycle page for IBM API Connect Version 5.0). Until then, users of API Connect collectives are encouraged to migrate to container runtimes to take advantage of their agility and scalability.
- New customers should not install API Connect collectives because this feature is no longer supported for new users.
- Installing the collective controller
- Installing the collective member host
- Preparing to install multiple collectives
- Installing extra collectives to an existing installation
- A host server with a supported operating system.
- Administrative privileges, such as root privileges, on the host machine.
- The Management server.
- A supported version of Node.js.
- C++ compiler, make, and Python.
Installing the collective controller
Install the API Connect collective controller. Add the collective to the Cloud Manager.
Before you begin
As a prerequisite to installing the collective controller, you must install a supported version of Node.js.
For details of supported Node.js versions, follow the link on the IBM API Connect Version 5.0 requirements page to the IBM API Connect Software Product Compatibility Report for the API Connect offering you are using, then click the Prerequisites tab.
Node.js is available as part of the IBM SDK for Node.js.
About this task
npm install -g
command might require root or administrator privileges or use of the
--unsafe-perm
parameter. In general, use the following guidelines based on how Node.js was installed:- If Node.js is installed under a user
account, then the controller and member installation commands do not require sudo
or the
--unsafe-perm
argument. - If Node.js and the controller and
member installation commands are run under the root account, then the controller and member
installation commands do not require sudo but do need to use the
--unsafe-perm
argument. - If Node.js is installed under the
root
account but the controller or member installation commands are run from a non-root account, then the controller and member installation commands do require sudo and the--unsafe-perm
argument.
Procedure
Installing the collective member host
Install the collective member host.
Before you begin
The host on which you install the collective member must have an SSH daemon installed.
You must be able to SSH into that host with the user name and password that are supplied to the
wlpn-collective registerHost
command by using the --rpcUser
and
--rpcPassword
options; these options are separate from --user
and
--password
, which are the credentials required to log in to the Admin
Center.
- From the public npm registry.
- From a locally hosted IBM API Connect server.
- From a locally downloaded .tgz file.
If you are installing the collective member locally from an IBM API Connect server or a downloaded .tgz file, you must first install a supported version of Node.js
For details of supported Node.js versions, follow the link on the IBM API Connect Version 5.0 requirements page to the IBM API Connect Software Product Compatibility Report for the API Connect offering you are using, then click the Prerequisites tab.
Node.js is available as part of the IBM SDK for Node.js.
About this task
npm install -g
command might require root or administrator privileges and use of
the --unsafe-perm
parameter; the --unsafe-perm
parameter applies
only when you are using the sudo
command.Procedure
What to do next
Preparing to install multiple collectives
For an APIC Liberty collective being configured for the first time, you can provide a unique name that distinguishes it from existing or future collectives. Otherwise, the identical default name is applied to each new collective that you create.
Before you begin
About this task
Procedure
-
From the CLI, change directories to collective by entering
-- cd /root/.liberty/wlp/usr/servers/controller/resources/collective
. - Create a file named "collective.name" and add a string that contains your collective's unique name. You can enter this command to accomplish the step: echo "collective-<some-uniqueName>" > output; tr -d '\n' < output > collective.name
- Start the controller and then register the members.
Installing extra collectives to an existing installation
You can install extra collectives by creating a unique name to override the default collective name.
Before you begin
About this task
The apic-liberty-collective
uses a default collective name called
defaultCollective. To create more collectives, you must assign a unique name
to each.
Procedure
What to do next
odr-event
log target is enabled, you see:- Before the change: '/cell/defaultCollective/node/<hostname>.......
- After the change: '/cell/collective-<some_unique_name>/node/<hostname>......