Deploying Custom Connectors
Deploy and register your custom connectors in Kubernetes and Docker.
Deploying Custom Connectors in Kubernetes
Prerequisites
You have developed your custom connector. See Developing Custom Connectors.
Procedure
Custom connectors are packaged as container images. First, build and publish the image to a registry. Then, deploy it using the connectware-agent Helm chart. Finally, register it in the Connectware Admin UI.
Publish your custom connector to your preferred container registry.
Use the
connectware-agentHelm chart - just as you would when installing an agent - to deploy your custom connector on Kubernetes. Make the following customizations in yourvalues.yamlfile:Custom registry: Override the default image registry to point to your registry. See Using a Custom Image Registry for the connectware-agent Helm Chart.
Image name & tag: Specify the image name and tag of your custom connector. See Configuring image name & version for the connectware-agent Helm chart.
Once the custom connector is deployed, access the Admin UI to register it and make it available for use.
To register the custom connector as an agent in Connectware, log in to the Admin UI and select User > Client Registry.
In the Client Registry view, click Unlock to allow the agent to register with Connectware.
Once the client appears in the list, click it.
In the Grant Access dialog, click Allow. By default, the default permissions are assigned to the client.
Result: You can now use your custom connector.
Deploying Custom Connectors in Docker
Prerequisites
You have developed your custom connector. See Developing Custom Connectors.
Procedure
Custom connectors rely on pre-built Docker images, requiring you to specify the image tag during the build process.
Create a
docker-compose.ymlfile. The following code example deploys the agent with a server with theBASEIMAGE_VERSIONtag set to2.0.0.
docker-compose build --build-arg BASEIMAGE_VERSION=2.0.0Example
version: '2.4'
services:
# Run the example server
server:
build: .
network_mode: host # Using host network
entrypoint: ''
command: sh -c 'cd /app/src/protocols/custom/utils && node runServer.js'
agent:
build: .
network_mode: host # Using host network
volumes:
- agentData:/data
environment:
CYBUS_HOSTNAME_INGRESS: localhost # Assuming Cybus Connectware to be reachable on local system
CYBUS_AGENT_MODE: distributed
CYBUS_AGENT_NAME: CustomConnectorAgent
CYBUS_LOG_LEVEL: info
volumes:
agentData:To deploy your custom connector, use the following code:
docker-compose up -dOnce the custom connector is deployed, access the Admin UI to register it and make it available for use.3. To register the custom connector as an agent in Connectware, log in to the Admin UI and select User > Client Registry. 4. In the Client Registry view, click Unlock to allow the agent to register with Connectware.
Once the client is registered, click it.
In the Grant Access dialog, click Allow. By default, the default permissions are assigned to the client.
Result: You can now use your custom connector.
Last updated
Was this helpful?