Agent Installation

Sysdig agents are delivered as either a container or a service and can be deployed with or without an orchestrator such as Kubernetes or Mesos.

A quick install involves just a few lines of code from the Getting Started wizard copied into a shell. The complete install instructions address checking for and installing kernel headers if needed, any prerequisite permissions settings for particular environments, and tips about updating the configuration files after initial installation.

Plan the Installation

Topic

Description

Host Requirements

Review the platforms, runtimes, Linux distributions, orchestration, browsers, etc. that are supported.

Access key

An agent access key is provided with a Sysidg trial

Installation Options

Different ways in which you can install Sysdig agent.

Troubleshooting Agents

Troubleshooting tips for agent installation, tuning agents, and compiling kernel modules.

Installation Options

In the default mode of agent installation, you install the agent package as two containers, each container responsible for different functions as given below. The agent-slim reduces the surface area of attack for potential vulnerabilities and is, therefore, more secure.

  • agent-kmodule: Responsible for downloading and building the kernel module. The image is short-lived. The container exits after the kernel module is loaded. The transient nature of the container reduces the time and opportunities for exploiting any potential vulnerabilities present in the container image.

    Prerequisites: The package depends on Dynamic Kernel Module Support (DKMS) and requires the compiler and kernel headers installed if you are using the agent-kmodule to build the kernel probe. Alternatively, you can use it without the kernel headers. In such cases, the agent-kmodule will attempt to download a pre-built kernel probe if it is present in the Sysdig probe repository.

    The module contains:

    • The driver sources

    • A post-install script that builds the module upon installation

  • agent-slim: Responsible for running the agent module once the kernel module has been loaded. Slim agent functions the same way as the regular agent and retains the feature parity.

Use the instruction below to install agent on your chosen environment:

EnvironmentFlavorInstallationInstall Instructions
KubernetesOpen SourceHelm and manualInstall Agent on Kubernetes
OpenShiftHelm and manualInstall Agent on OpenShift
GKEHelm and manualInstall Agent on GKE
RancherHelm and manualInstall Agent on Rancher
OKEHelm and manualInstall Agent on OKE
Non-OrchestratedManualInstall Agent on Non-Orchestrated Environment

Legacy Agent: The legacy agent can be run as a single container or a service. It includes the components for downloading and building the kernel module, as well as for gathering and reporting on a wide variety of pre-defined metrics. For more information, see Installing Agent as a Single Container.

Helm

Helm is the preferred way of installing Sysdig agent. It is used in most cloud environments, for example, Amazon EKS or EC2 on AWS Cloud or AWS Outpost, EC2, and Azure AKS.

Manual

With the Getting Started wizard, you can copy a simple line of code to deploy agents in a variety of environments.

Behind the scenes, the wizard auto-detects and completes configuration items such as the required access key and port information. The wizard can also be launched from the Start a Free Trial button at sysdig.com.

After the first install, Sysdig Secure and Monitor users can access the wizard at any time from the Rocket icon on the navigation bar.

EnvironmentFlavorInstall Instructions
KubernetesOpen SourceHelm is the preferred way of installing Sysdig agent. It is used in most cloud environments, for example, Amazon EKS or EC2 on AWS Cloud or AWS Outpost, EC2, and Azure AKS.
OpenShift
GKEUsed for Google Kubernetes Service environment.
Rancher
OKE
IKSIBM manages and documents Sysdig installs as part of IKS.
IBM Cloud Monitoring
Non-OrchestratedUsed when there is no orchestrator such as Kubernetes. Install Agent on Non-Orchestrated Environment.
LinuxRare, used with custom kernel headers, unique use cases
Agent Install: Manual Linux Installation.
Mesos |Marathon|DCOSAgent Install: Mesos |Marathon |DCOS.


Last modified August 9, 2022