Hosted Agents

George Alpizar
George Alpizar
  • Updated

Overview

You can use this document to learn how to create and manage hosted agents. 

At Edge Delta, the term hosted agent refers to an agent hosted on Edge Delta's cloud infrastructure. 


Create a Hosted Agent

In this step, you will create and deploy an agent that Edge Delta will host.

Note

You can use an existing agent configuration to tag a new hosted agent. To tag an existing configuration with a hosted agent, you must know the existing agent configuration's key and tag combination (configuration ID).

To locate the key and tag for an existing agent configuration: 

  1. In the Edge Delta App, on the left-side navigation, click Data Pipeline, and then click Agent Settings.
  2. In the Configurations table, locate the desired configuration.
  3. Under Key, note the corresponding alpha-numeric key. 
  4. Under Tag, note the corresponding tag. 

To create a new hosted agent:

  1. In the Edge Delta App, on the left-side navigation, click Data Pipeline, and then click Hosted Agents.
  2. Click + Create.
  3. For Name, enter a descriptive name for the hosted agent.
  4. For Cloud, select the public cloud provider.
  5. For Region, select the region where the hosted agent will be deployed to.
  6. For Config ID, there are 2 options:
    • If you do not want to tag the hosted agent with an existing agent configuration, select Generate one for me.
    • If you want to tag the hosted agent with an existing agent configuration, locate and select the corresponding key and tag combination (configuration ID).
  7. Select additional settings. 
  8. Click Create.
  9. In the Hosted Agents table, note the ID listed under ID.

After you create a hosted agent, you can update the following settings:

  • Agent count
  • Memory limit
  • CPU limit 

Understand Hosted Agents Table

Review the following table to better understand the Hosted Agents table: 

Column Description
ID

This column displays the unique ID of the hosted agent. 

Name This column displays the friendly, descriptive name of the hosted agent. 
Status

This column displays the status of the agent.

Review the following status types:  

  • pending
    • This status appears after you first create the hosted agent. 
    • You cannot update or delete a pending agent.
  • provisioning
    • This status appears when the agent is being deployed. 
    • You cannot update or delete a provisioning agent. 
  • scaling
    • This status appears when you have updated the agent. 
    • You cannot update or delete a scaling agent.
  • ready
    • This status appears when the agent is fully deployed and ready for use. 
    • You can update or delete a ready agent. 
  • failed
    • This status appears when the agent has failed to provision. 
    • You cannot update a failed agent. As a result, you must delete the agent and then create a new agent. 
  • marked-for-delete
    • When you delete the hosted agent, this status briefly appears before the agent is removed from the table. 
Count This column displays the number of agents deployed within the hosted agent. 
HTTPS Endpoint This column displays if the hosted agent is configured to access a secured endpoint. 

 


Update a Hosted Agent

After you create a hosted agent, you can update the agent's:

  • Agent count
  • Memory limit
  • CPU limit 

Note

You can only update a hosted agent in the ready status. 

  1. In the Edge Delta App, on the left-side navigation, click Data Pipeline, and then click Hosted Agents.
  2. Locate the desired agent, then under Actions, click the vertical ellipses, and then click Edit
  3. Make your changes, and then click Edit to save.
  4. The hosted agent will display in a scaling status.
    • After a successful update, the agent will display in a ready status. 

Delete a Hosted Agent

Note

You can only delete a hosted agent in the ready status or failed status. 

  1. In the Edge Delta App, on the left-side navigation, click Data Pipeline, and then click Hosted Agents.
  2. Locate the desired hosted agent, then under Actions, click the vertical ellipses, and then click Delete.  
  3. Review the message, and then click Yes.
  4. You may see the hosted agent's status change to marked-for-delete; however, the hosted agent will immediately be removed from the table.

Share this document