Install and migrate adapters and custom applications

Locate existing adapters

On your current Platform system, find the adapters directory:

/opt/itential/pronghorn/node_modules/@itentialopensource

Remove generated files from each adapter

For each adapter you intend to migrate:

$
cd adapter-name
$
rm -rf node_modules
$
rm package-lock.json
$
cd ..

Package and transfer each adapter

Compress each adapter using zip, gzip, or tar, then transfer the compressed file to the Platform 6 system.

Place adapters in the Platform 6 services directory

On the Platform 6 system, decompress each adapter into:

/opt/itential/platform/services

The services directory should contain individual adapter directories directly — not a namespace directory wrapping them.

Install dependencies for each adapter

$
cd /opt/itential/platform/services/adapter-name
$
npm install

Run lint and tests

$
npm run lint:errors   # Should produce no errors
$
npm run test          # All tests should pass

Restart the Platform

After all adapters have been migrated, restart once:

$
systemctl restart itential-platform

Configure service instances

For each adapter, complete the configuration steps in the Install an adapter section below.

Navigate to the services directory

$
cd /opt/itential/platform/services

Add the adapter

Use one of the following methods:

$
git clone git@gitlab.com:@itentialopensource/adapters/adapter-name

$
unzip adapter-name.zip

$
tar -xvf adapter-name.tar

Install adapter dependencies

$
cd adapter-name
$
npm install

Run lint and tests

$
npm run lint:errors   # Should produce no errors
$
npm run test          # All tests should pass

Restart the Platform

$
systemctl restart itential-platform

Create a service instance

In the Admin Essentials GUI, create a new service instance for the adapter.

Configure the service instance

In the Admin Essentials GUI, open the service instance configuration for the adapter.

Copy the properties from sampleProperties.json in the adapter directory and paste them into the inner (second) properties object in the service instance configuration. Update host, port, authentication method, credentials, and any other environment-specific values.

Set permissions

Grant the admin role to the adapter for any user who will:

• Build workflows that include an adapter task
• Use adapter calls to retrieve dynamic data in a JSON form or custom application

Install adapter source code on all nodes

On every node in the cluster, follow the Install an adapter steps above.

Restart the Platform on all nodes

$
systemctl restart itential-platform

Create an adapter instance

From any node, open Admin Essentials and create a new adapter instance. See Adapters for instructions.

Configure the adapter

In the Configuration tab, edit the service config to match your environment, then click Save. Saving automatically restarts the adapter on that node.

Restart Platform on all remaining nodes

The auto-restart in the previous step only affects the node where you saved the config. On each remaining node, restart Itential Platform so that it loads the new adapter instance from the shared database:

$
systemctl restart itential-platform

The adapter instance is now running on all nodes in the cluster.