Install on a Linux Host

Overview

This page describes how to install an Upwind Sensor on a Linux host (VM), such as an Amazon EC2 instance, Google Cloud or Microsoft Azure VM.

note

This page assumes the following criteria are met:

1. You have a Linux host running a supported distribution. For more information about the supported Linux distributions, you can read the Requirements section below.
2. You have the necessary root permissions to execute the installation commands.
3. You have already connected the cloud account where the Host is hosted to Upwind. If you haven't, please follow the Connect a Cloud Account page.

Requirements

The Upwind Sensor can be installed on any Linux machine with a kernel version of 4.14 or above.

Here's a table summarizing the requirements:

Requirement	Description
Operating System	Linux
Kernel Version	4.14 or above

Please make sure your Host meets the above requirements before proceeding with the installation.

Step 1: Generate Client Credentials

note

This step is relevant only if you want to create new client credentials. If you already have client credentials, you can skip this step.

If you start this process after you have connected your cloud account, then you can generate the client credentials as part of the host connection process.

Alternatively, you can generate it in the Client Credentials. After you have generated the client credentials, note down the UPWIND_CLIENT_ID and UPWIND_CLIENT_SECRET fields.

Step 2: Install Upwind Sensor

Automatic (Recommended)

Execute the following command on the host to download and install the Upwind Sensor:

curl -fSsl https://get.upwind.io/agent.sh | \
  UPWIND_CLIENT_ID="<redacted>" \
  UPWIND_CLIENT_SECRET="<redacted>" \
  bash -s

Update UPWIND_CLIENT_ID and UPWIND_CLIENT_SECRET with the values you noted down in the previous step.

Debian

Download the package:

sudo dpkg -i upwind-agent_${version}_amd64.deb

Edit config and add credentials:

sudo vi /etc/upwind/agent.yaml

# Upwind Agent Configuration
log-level: info
platform: host
auth-client-id: # REQUIRED CLIENT ID HERE #
auth-client-secret: # REQUIRED CLIENT SECRET HERE #

Start and enable services:

sudo systemctl enable upwind-agent.service
sudo systemctl start upwind-agent.service
sudo systemctl enable upwind-agent-scanner.timer
sudo systemctl start upwind-agent-scanner.timer

info

It is possible to deploy the Upwind Sensor on a host using the cloud deployment tools, such as Azure Run Command, AWS Systems Manager, or Google Cloud (GCP) Patch Manager. For more information, see the Cloud Deployment Tools page.

Step 3: Validate the Installation

It is recommended to validate that the Upwind Sensor is running correctly on the host.

Run the following command to check the Sensor status:

sudo systemctl status upwind-agent

The output should show that the Upwind Sensor is active and running.

Troubleshooting

Read the Troubleshooting guide for more information on how to troubleshoot the Upwind Sensor installation.