This article covers installing and configuring an on-premise agent using a Linux operating system.
Important
The Celigo agent is an electron application that must be run as an administrator (sudo in Linux). You must disable the Chromium Sandbox when using sudo for the agent. The agent functions exclusively as a terminal utility and doesn’t engage with Chromium-specific functionalities.
Below are the minimum software and hardware requirements for running an on-premise agent on Linux.
-
Navigate to Resources → Agents.
-
Click + Create agent.
-
Name your agent and add a description.
-
Click Save. Your agent now appears on the list.
-
From the Install column, click the Download option and choose the operating system (Linux).
-
Use the scp commands below to copy the executable to your system. The command varies depending on whether you need a private key to connect to your machine.
If you don’t use a private key to connect to your machine, use this scp command:
scp YOUR_LOCAL_PATH/agent-linux.run YOUR_LINUX_MACHINE_IP:PATH_IN_MACHINE
YOUR_LOCAL_PATH: The path where your agent file is downloaded.
YOUR_LINUX_MACHINE_IP: This is the IP address of your Linux machine used when connecting to the machine using SSH.
PATH_IN_MACHINE: Destination path in which you want the agent to be copied.
If you don’t use a private key to connect to your machine, use this scp command:
scp -i PATH_TO_YOUR_PRIVATE_KEY YOUR_LOCAL_PATH/agent-linux.run YOUR_LINUX_MACHINE_IP:PATH_IN_MACHINE
PATH_TO_YOUR_PRIVATE_KEY: Path where your private key resides.
YOUR_LOCAL_PATH: The path where your agent file is downloaded.
YOUR_LINUX_MACHINE_IP: This is the IP address of your Linux machine used when connecting to the machine using SSH.
PATH_IN_MACHINE: Destination path in which you want the agent to be copied.
In Linux, files must be marked as executable before they’re run. To make the agent an executable:
-
Connect to your machine and navigate to the agent in the directory.
-
Run the below command:
chmod +x agent-linux.run
An access token secures communication between the agent and integrator.io. Your agent token is automatically generated when you create the agent. To find the token:
-
Return to integrator.io and navigate to Resources → Agents.
-
In the list of agents, click Show token.
-
Click Copy (
) next to the unmasked access token to copy it to your clipboard.
-
Run the installer using the following command:
sudo ./agent-linux.run
-
Enter your copied token when prompted.
-
The agent will be installed as a service and automatically exit after installation. It may take a few minutes for the agent to go live.
Important
The agent will run until you manually stop it and restart automatically in case of a reboot.
Run the agent
Agent running successfully
Below are some helpful commands to manage your agent.
This command will bring up the agent's live logs.
journalctl -u celigoagent.service -f
Agent logs
To stop the agent, run this command:
sudo systemctl stop celigoagent.service
To restart the agent, run this command:
sudo systemctl restart celigoagent.service
Use this command to change your token after retrieving and copying the new token from integrator.io. It may take a few minutes for the agent to go live. You may want to change your token if:
-
You believe your existing token has been compromised.
-
If you use a new agent from a different integrator.io account.
sudo updateCeligoAgentToken.sh
Use the command below to stop the agent service and remove the service file.
sudo systemctl stop celigoagent.service sudo rm /etc/systemd/system/celigoagent.service
Use the command below to remove the agent’s executable file.
sudo rm -rf /usr/local/bin/celigo-agent
-
Create a connection in integrator.io from Resources → Connections or by adding a new Source or Destination app in Flow Builder.
-
For the Mode, choose On-premise (the default is Cloud).
-
Choose your Agent from the drop-down list.
When creating an integrator.io connection that uses an on-premise agent, your settings will depend on whether the agent is installed on the same server as the application or database.
-
Same server – set the Base URI to localhost or 127.0.0.1
-
Different servers on the same network – Set the Base URI to the hostname or IP address of the system the application or database is running on.
You can run only one instance of an agent on a machine. However, the same agent can be used to talk to multiple databases and applications on the same network as the agent.
For example, if you’re running SQL on two virtual machines (VM1 and VM2) and you’ve installed an integrator.io agent on VM1, your agent can access every SQL database on the same machine and any applications in the same network. Say you have an HTTP application running on VM2 and you want to create a connection. You can use the existing agent for that connection since VM1 and VM2 are on the same network.
So, as long as VM1 and VM2 are on the same network, you can access any application on both machines.
How many instances of an agent can I set up?
You can run only one instance of the agent on a machine. However, the same agent can be used to allow integrator.io to talk to multiple databases and applications on the same network as the agent.
Does the on-premise agent need to be installed on the same machine as the system to be integrated?
Typically, agents can be installed on any machine within the same network as the server running the system to be integrated. However, there can be exceptions such as when setting up a JDBC connection.
Which IP addresses does the agent use to communicate with integrator.io?
The agent uses several IP addresses to communicate with integrator.io. If you need to open up outbound traffic for an agent running in your environment:
-
Whitelist the integrator.io IP addresses for the U.S. or the EU for the HTTPS protocol.
-
Whitelist the agent-extension server IP addresses for the U.S. or the EU for the SSH protocol.
Comments
Please sign in to leave a comment.