Manual Agent Management
  • Dark
    Light

Manual Agent Management

  • Dark
    Light

Manage the Agent Configuration Locally

While you can use the Edge Delta App to update a configuration, you can also manage and deploy configuration files locally, with tools such as Chef, Puppet, Ansible, Salt, Terraform, etc.

To configure locally, a flag must be provided during agent deployment to let the Edge Delta backend know that Local Configuration File Management is in place.

Run Parameter:

-c path/to/config.yml

Linux Example:

./edge_delta.sh -c /opt/configs/edge_delta.yml

Windows Example:

start /wait msiexec /qn /i edgedelta-version_64bit.msi -c /opt/configs/edge_delta.yml

Create a Child Configuration

In the Edge Delta App, you can add a configuration into another, existing configuration to create a parent and child configuration.

Note

In the Edge Delta App, the process to create a parent or child configuration is the same. To convert existing configurations into a parent or child, you must "import" a configuration into another configuration. With this action, the existing configurations will convert into a parent and child configuration.

To learn how to create a configuration, see Agent Configuration Overview.

Before you create or add a child configuration into a parent configuration, consider the following statements:

  • You can add a child configuration into multiple parent configurations.
  • A configuration cannot be both a parent and child configuration.
  • The user who created or updates the parent configuration should have access to the child configuration.
  • If a parent and child configuration have sources that point to the same resource, such as a file input that has the same path, then these 2 sources will only be merged if they have the same configuration, with the exception of labels. If not, then the configuration validation will give an error.

To add a child configuration into a parent configuration:

  1. In the Edge Delta App, on the left-side navigation, click Data Pipeline, and then click Agent Settings.
  2. Locate the desired parent configuration, then under Actions , click the vertical ellipses, and then click Edit.
  3. Update the YAML file with the following parameters.
    • To better understand, review the table and sample configuration below.
  4. Update the workflow and add related configurations, such as inputs, processors, filters, outputs, etc.
ParameterDescription

name

Enter the name of the child configuration. 

Review the following example: 

name: "Test_Team"

conf_id

Enter the configuration ID or the API key for the child configuration. 

Review the following example: 

conf_id: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

prefix

Enter a descriptive term that will be inserted in front of the metrics, inputs, filters, etc. from that configuration.  

If you do not enter a prefix, then the name of the child configuration will be used. 

Review the following example: 

prefix: test_team

exclude_workflows

Enter true or false

False indicates that the parent configuration will not use the configurations from the child configuration. 

The default value is false

Review the following example: 

exclude_workflows: true

params

Enter a key-value pair that will be used for templating purposes for the child configuration.

To avoid errors during the configuration validation process, in the workflow, use the following format: `'{{ Param "KEY" }}'`

  • Parametrization only works for the child configuration's workflow.

If you enter "... '{{ Param "<Key>" }}' ...", then the <Value> will replace all content within the curly brackets. 

Review the following example: 

params: 
  WorkflowProcessor: "flog"

Review the following sample configurations:

imports:
      - name: "<Name of the config>" 
        conf_id: "<Config ID>" 
        prefix: "<Prefix>"  
        exclude_workflows: true  
        params: 
          WorkflowProcessor: "flog"
imports:
- name: "Test_Team"
  conf_id: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
  prefix: test_team
  params:
    ElasticIndexName: TEST_INDEX

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.