wnology/edge-agent repository overview

⁠Wnology Edge Agent

The WEGnology Edge Agent is a service that’s installed on every WEGnology Edge Compute device to manage the deployment and execution of edge workflows .

⁠Supported Tags

⁠multi-arch

• 1.54.0, 1.54.0-alpine, latest, latest-alpine

⁠amd64

• 1.54.0-amd64, 1.54.0-alpine-amd64

⁠arm64

• 1.54.0-arm64, 1.54.0-alpine-arm64

⁠arm32

• 1.54.0-arm, 1.54.0-alpine-arm

⁠Quick reference

Where to get help:

• WEGnology Gateway Edge Agent Installation Tutorial⁠
• WEGnology Gateway Edge Agent Usage Tutorial⁠
• WEGnology Documentation⁠
• WEGnology Forums⁠

Maintained by:

• WEGnology, Inc⁠

Supported architectures:

amd64, arm, arm64

⁠How to use this image

For help installing Docker and pulling this image, check out the installation instructions⁠. You can also find a quick run down on using Docker commands to manage the Agent⁠.

⁠Start a wnology Edge Agent instance (docs⁠)

docker run -d --name myAgent \
  -e 'DEVICE_ID=<your-device-id>' \
  -e 'ACCESS_KEY=<your-access-key>' \
  -e 'ACCESS_SECRET=<your-access-secret>' \
  wnology/edge-agent

⁠Start and mount in persistent storage (docs)

docker run -d --name myAgent \
  -e 'DEVICE_ID=<your-device-id>' \
  -e 'ACCESS_KEY=<your-access-key>' \
  -e 'ACCESS_SECRET=<your-access-secret>' \
  -v /docker/host/dir:/data \
  wnology/edge-agent

By default, persistent data is stored in the VOLUME /data, which can be used with --volumes-from some-volume-container or -v /docker/host/dir:/data (see docs.docker volumes).

⁠Start and expose HTTP endpoint for triggering (docs⁠)

docker run -d --name myAgent \
  -e 'DEVICE_ID=<your-device-id>' \
  -e 'ACCESS_KEY=<your-access-key>' \
  -e 'ACCESS_SECRET=<your-access-secret>' \
  -p <host port>:8080 \
  wnology/edge-agent

By default, the WEGnology Agent exposes HTTP endpoint at port 8080, which can be exposed to a local host port using -p (see exposing ports⁠).

⁠If you want to use your own agent config file (docs⁠)

You can mount in your own config file like the following:

docker run -d --name myAgent \
  -v /host/dir/custom-config.toml:/etc/wegnology/wegnology-edge-agent-config.toml \
  wnology/edge-agent
  The file at /etc/wegnology/wegnology-edge-agent-config.toml is an example agent config file; it is a great starting place for creating your own agent config file.  

⁠All Available Options

Most options can be set through environment variables (most common for Docker), the configuration file, or command line flags. You can see the details for each option below this table. If an option is set multiple ways, the command line flag is used first, followed by the environment variable, and then finally falling back to the configuration file.

⁠Option Details

• DEVICE_ID: REQUIRED

  WEGnology Device ID of the agent. This should correspond to the ID of an Edge Compute Device in your WEGnology account.

• ACCESS_KEY: REQUIRED

  WEGnology Access Key to use for the agent. This should be the key part of a Device Access Key that can be used for the given Device ID.

• ACCESS_SECRET: REQUIRED

  WEGnology Access Secret to use for the agent. This should be the secret part of a Device Access Key that can be used for the given Device ID.

• CONF_PATH: Set the path to the agent configuration file. Defaults to the file /etc/wegnology/wegnology-edge-agent-config.toml, which is also the example configuration file.

• LOGGER_OUT: Desired destination for logging. Either console or a file path. Defaults to console.

• LOGGER_LEVEL: Desired logging level. One of error, warn, info, or verbose. Defaults to info.

• STORE_PATH: Path to the persistent store directory for the agent. Defaults to /data/wegnology-edge-agent-store.db.

• UDP_ADDRESS: Address that the agent should bind to for any open UDP Trigger ports. Defaults to 0.0.0.0, which means to bind to all interfaces on the machine.

• QUEUE_OFFLINE_MESSAGES: If the agent should queue messages while offline to send later. Defaults to true.

• WEBSERVER_ENABLED: Whether the agent web server should be enabled. Default is enabled (true).

• WEBSERVER_PORT: Port the agent should run its web server on. Defaults to 8080.

• WEBSERVER_ADDRESS: Address that the agent's web server should bind to. Defaults to 0.0.0.0, which means to bind to all interfaces on the machine.

• WEBSERVER_USERNAME: Username to use to authenticate requests to the agent's web server (using basic auth). Default is no username. If neither a username or a password is configured, no authentication is needed for requests against the agent's web server.

• WEBSERVER_PASSWORD: Password to use to authenticate requests to the agent's web server (using basic auth). Default is no password. If neither a username or a password is configured, no authentication is needed for requests against the agent's web server.

• WEBSERVER_SSL_KEY_PATH: Path to the SSL key to use for the agent's web server. Default is no path. If an SSL key is provided, an SSL certificate must be provided as well.

• WEBSERVER_SSL_KEY: The SSL key to use for the agent's web server. You can use this to set the contents of the key directly, instead of reading it from a file. Default is no value. If an SSL key is provided, an SSL certificate must be provided as well. If this environment variable is set, it will be used instead of WEBSERVER_SSL_KEY_PATH.

• WEBSERVER_SSL_CERT_PATH: Path to the SSL certificate to use for the agent's web server. Default is no path. If an SSL certificate is provided, an SSL key must be provided as well.

• WEBSERVER_SSL_CERT: The SSL certificate to use for the agent's web server. You can use this to set the contents of the certificate directly, instead of reading it from a file. Default is no value. If an SSL key is provided, an SSL certificate must be provided as well. If this environment variable is set, it will be used instead of WEBSERVER_SSL_CERT_PATH.

• WEBSERVER_SSL_BUNDLE_PATH: Path to the SSL certificate bundle to use for the agent's web server. Default is no path, and it is not required for SSL. If no SSL certificate or key is provided, this option is ignored.

• WEBSERVER_SSL_BUNDLE: The SSL bundle to use for the agent's web server. You can use this to set the contents of the bundle directly, instead of reading it from a file. Default is no value. If no SSL certificate or key is provided, this option is ignored. If this environment variable is set, it will be used instead of WEBSERVER_SSL_BUNDLE_PATH.

• LOCAL_BROKER_ENABLED: Whether the agent local broker should be enabled. Default is disabled (false).

• LOCAL_BROKER_PORT: Port the agent should run its local broker on. Defaults to 1883.

• LOCAL_BROKER_ADDRESS: Address that the agent's local broker should bind to. Defaults to 0.0.0.0, which means to bind to all interfaces on the machine.

• LOCAL_BROKER_USERNAME: Username to use to authenticate client connections to the agent's local broker. Default is no username. If neither a username or a password is configured, no authentication is needed for connections to the agent's local broker.

• LOCAL_BROKER_PASSWORD: Password to use to authenticate client connections to the agent's local broker. Default is no password. If neither a username or a password is configured, no authentication is needed for connections to the agent's local broker.

• LOCAL_BROKER_SSL_KEY_PATH: Path to the SSL key to use for the agent's local broker. Default is no path. If an SSL key is provided, an SSL certificate must be provided as well.

• LOCAL_BROKER_SSL_KEY: The SSL key to use for the agent's local broker. You can use this to set the contents of the key directly, instead of reading it from a file. Default is no value. If an SSL key is provided, an SSL certificate must be provided as well. If this environment variable is set, it will be used instead of LOCAL_BROKER_SSL_KEY_PATH.

• LOCAL_BROKER_SSL_CERT_PATH: Path to the SSL certificate to use for the agent's local broker. Default is no path. If an SSL certificate is provided, an SSL key must be provided as well.

• LOCAL_BROKER_SSL_CERT: The SSL certificate to use for the agent's local broker. You can use this to set the contents of the certificate directly, instead of reading it from a file. Default is no value. If an SSL key is provided, an SSL certificate must be provided as well. If this environment variable is set, it will be used instead of LOCAL_BROKER_SSL_CERT_PATH.

• LOCAL_BROKER_SSL_BUNDLE_PATH: Path to the SSL certificate bundle to use for the agent's local broker. Default is no path, and it is not required for SSL. If no SSL certificate or key is provided, this option is ignored.

• LOCAL_BROKER_SSL_BUNDLE: The SSL bundle to use for the agent's local broker. You can use this to set the contents of the bundle directly, instead of reading it from a file. Default is no value. If no SSL certificate or key is provided, this option is ignored. If this environment variable is set, it will be used instead of LOCAL_BROKER_SSL_BUNDLE_PATH.

• -V, --version: Outputs the version of the WEGnology Edge Agent.

• -h: Outputs help on the available CLI options.