Relay allows you to securely connect on-premises (on-prem) services that run on your internal network to SquaredUp.
How does Relay work?
An agent is installed on a machine on your local network that has access to the on-prem service. Ideally, you'd install it on a machine that has the fastest connection to the on-prem service, based on its location. Agents are then organized into agent groups. When you add a plugin for an on-prem service you pick the agent group you want to use.
What is an Agent?
An Agent is a service that runs on a local machine and connects an internal service to SquaredUp. The Agent listens to the queue from SquaredUp and picks up tasks, for example running scripts to provide data that SquaredUp has asked for.
What is an agent group?
Agent groups are a way to organize your agents. When you're configuring an on-premises plugin, you select the agent group the plugin will use
Tips for using agents and agent groups
Access to data:
Agents need to be deployed in the data center that has access to the on-prem service the plugin will use. If you have multiple groups, remember to set the plugin to use the correct group, i.e. the group that contains agents with access to the on-prem service. Tip: Agents can be part of multiple groups.
Multiple agents on the same machine:
For high-availability and load balancing, you can deploy multiple agents on the same network and put them all in the same agent group. This way, there is always an agent to pick up the task in the queue, and the workload can be divided between all agents.
If you want to use just one agent you can do that, but you still need to put it into a group and set your plugin to use that group.
Structuring your agent groups:
You can organize your agents into groups that make sense to you. For example, if you have a worldwide network of data centers, you might create agent groups based on the locations of the machines. You can then pick the group closest to the on-prem service and therefore get the fastest connection.