Environment Variables

Frequently Used Environment Variables

The following environment variable parameters can be passed when you install and deploy the Edge Delta agent.

ED_API_KEY

Identifies and authorizes access to your agent configuration in the Edge Delta back end.

ED_ARCHIVE_FLUSH_INTERVAL

Specifies the duration after which logs are flushed and sent to the configured archiving destination. The default value is 30m.

ED_WORKFLOWS

Enables matching workflows using a colon-separated list of workflow names. All other workflow names are disabled. It is used in conjunction with the edWorkflowPrefixes parameter.

ED_WORKFLOW_PREFIXES

Enables all matching workflows with a colon-separated list of workflow prefixes. All other workflows are disabled. It is used in conjunction with the edWorkflows parameter.

ED_LEADER_ELECTION_ENABLED

Enables or disables the agent leader election mechanism in Kubernetes. Enter 1 to enable agent leader election mechanism in a Kubernetes environment. If not enabled, then the Kubernetes event ingestion will be disabled, even if this is activated through configuration.

HTTP_PROXY

Uses proxy details to route the agent’s outbound traffic through an HTTP internal proxy.

HTTPS_PROXY

Uses proxy details to route the agent’s outbound traffic through an HTTPS internal proxy.

NO_PROXY

Disables the proxy for requests that hit a specific destination.

STORE_PORT

Uses a port number to expose agent metrics storage.

Add a Variable to a Configuration File

There are 2 ways to reference variables in the configuration file:

• '{{ Env "MY_VARIABLE_NAME" }}'
• '{{ Env "MY_VARIABLE_NAME" "my default value" }}'

If the default value is not provided, then the variable in the agent execution environment must exist. If not, then the agent will stop with an error.

If the default value is provided, but the variable does not exist in the agent execution environment, then the default value will be used.

Environment variables can only be used with string-typed inputs. In other words, if a configuration parameter expects anything besides a string, then the environment variable substitution cannot be used.

In another example, the Slack endpoint is a secret that allows posts to be directly made into a Slack channel. Instead of explicitly putting the variable into the configuration file, the variable can be referred from the agent execution environment.

  triggers:
    - name: slack-integration
    type: slack
    endpoint: '{{ Env "MY_SLACK_ENDPOINT" }}'

Create a Global Configuration Variable

If your account contains multiple agents, you may want to consider setting variables that can be globally applied to several agents via the agent’s configuration file.

To better understand, review the following examples of configuration variables that you can create:

1. In the Edge Delta App, click Data Pipeline, and then click Pipeline Settings.
2. Click Add Variable.
3. Enter a descriptive name for the global variable.
4. Enter a configuration variable.
5. Click Save.

The newly created variable will display in the Configuration Variables table.

helm repo add edgedelta https://edgedelta.github.io/charts