macOS

Installing the Edge Delta agent on macOS.

  4 minute read  

Step 1: Create a Configuration and Download the Agent

Select the macOS template option in the following steps:

  1. In the Edge Delta App, click Data Pipeline, and then click Agent Configs.
  2. Click Create Configuration.
  3. Select the appropriate template.
  4. Specify a tag to identify the agent and environment.
  5. Click Create Configuration.
  6. Optionally, modify and test the agent configuration then click Save Edits or Done.

The agent table is updated with a new agent configuration with the agent tag you specified.

Next, you copy the agent API key:

  1. Locate the new configuration in the table, click the corresponding vertical green ellipses, and then click Deploy Instructions.
  2. Click macOS.
  3. In the window that appears, copy the command. This window also displays your API key. Copy this key for a later step.

Step 2: Install the Agent

There are 2 ways to install the agent:

  • Option 1: Standard Installation: With this option, you will install the agent via cURL in a bash script. This installation is the standard and recommended way to install the agent.
  • Option 2: Offline Installation: With this option, you will not use cURL in a bash script on your production environment. You can use this installation method if you have security concerns.

Option 1: Standard Installation

Open a terminal, and paste the commands you copied from Step 1. If you are not running as root, then you may be asked to enter the sudo password.

The installation process will deploy Edge Delta into the /opt/edgedelta/agent/ path. Additionally, the edgedelta system service will start automatically with default configurations.

The ED_ENV_VARS special variable is used in the installation command to pass one or more persistent environment variables to the agent, which will run as the system service:

sudo ED_API_KEY=<your api key> \ 
ED_ENV_VARS="MY_VAR1=MY_VALUE_1,MY_VAR2=MY_VALUE_2" \ 
bash -c "$(curl -L https://release.edgedelta.com/release/install.sh)"

To view a full list of variables that the agent supports, see Environment Variables.

The https://release.edgedelta.com/release/install.sh release package detects your architecture and operating system, and then chooses and downloads the latest version of the agent self-extracting script, which includes the content to be extracted at the end of the script.

The script’s content and extractable scripts are available for inspection at https://release.edgedelta.com/release/install.sh.

To check the package’s integrity, the script header will extract commands and content checksum.

The script will fail if the content has been tempered with.

For example, the v0.1.19/edgedelta-linux-amd64.shheader includes:

  • CRCsum="1944320463"
  • MD5="a98b537444f18d97a06b428b9cb223ce"

If the package has not been tempered with, then the script will extract the agent into a temporary directory, set the apikey file with the given ED_API_KEY environment variable, and run unix_install.sh. This command will copy the content to /opt/edgedelta/agent/ and run the following commands to install edgedelta as a system service and start the service:

  • /edgedelta -s install
  • ./edgedelta -s start

Option 2: Offline Installation

  1. Follow the steps outlined in Option 1 in a non-production machine with the same architecture and OS as the target production machine.
  2. Use the following command to compress the agent folder:
sudo tar -czvf agent_archive.tgz /opt/edgedelta
  1. Copy agent_archive.tgz to the target machine via SSH or other means.
  2. Use the following command to extract the archive under /opt/edgedelta:
sudo tar -xzvf agent_archive.tgz -C /
  1. Use the following command to install and start the service:
sudo cd /opt/edgedelta/agent/sudo 
./edgedelta -s installsudo 
./edgedelta -s start

Troubleshooting

Description Command
To check the status of the agent, run the following command: sudo su
launchctl list edgedelta
To check the agent’s log file for any errors that may indicate an issue with the agent, configuration, or deployment settings, run the following command on the Edge Delta service log file path: cat /var/log/edgedelta/edgedelta.log
To check the agent’s configuration file to ensure the configuration does not contain any issue, run the following command on the configuration file path: cat /opt/edgedelta/agent/config.yml

Upgrading

To upgrade the agent, you run the installation command that you previously used to deploy the agent.

Uninstalling

The following script uninstalls the agent as the root user:

#!/bin/bash
set -uex

BITS=$(getconf LONG_BIT)
if [ "$BITS" ==  "32" ]; then
  echo "This script does not support 32 bit OS. Contact info@edgedelta.com"
fi

echo "Removing agent service"
sudo /opt/edgedelta/agent/edgedelta -s uninstall 

echo "Removing agent folder"
sudo rm -rf /opt/edgedelta/agent/

echo "Done"