Install Host Shield as a Container

This page describes how to install the Sysdig Host Shield on hosts using non-orchestrated containers.

Migrate to the Host Shield

The Host Shield is nothing but the agent container. Starting from Sysdig Agent 13.6.1, you can enable additional features such as Host Scanning, Host Security Posture Management, and Rapid Response directly from the container configuration.

Prerequisites

Install the Host Shield

To install the Host Shield as a container using Docker Compose, create a docker-compose.yml file with the following content:

version: '3.8'

services:
  sysdig-agent:
    image: quay.io/sysdig/agent-slim:13.6.1
    container_name: sysdig-host-shield
    restart: always
    privileged: true
    network_mode: host
    pid: host
    shm_size: 512M
    environment:
      ACCESS_KEY: <ACCESS_KEY>
      COLLECTOR: <COLLECTOR_URL>
      COLLECTOR_PORT: <COLLECTOR_PORT>
      ADDITIONAL_CONF: |
        host_scanner:
          enabled: true
          host_fs_mount_path: /host
        kspm_analyzer:
          enabled: true
          host_root: /host
        sysdig_api_endpoint: <API_URL>        
    volumes:
      - /:/host:ro
      - /sys/kernel/debug:/sys/kernel/debug:ro
      - /var/run/docker.sock:/host/var/run/docker.sock
      - /etc:/host/etc:ro

Parameter Breakdown:

  • ACCESS_KEY: Your Sysdig Access Key.
  • COLLECTOR: The Sysdig collector URL for your SaaS region.
  • COLLECTOR_PORT: The port used by the Sysdig collector.
  • sysdig_api_endpoint: Specifies the Sysdig API URL for your SaaS region.
  • host_scanner: Enables host vulnerability scanning.
  • kspm_analyzer: Enables Host Security Posture Management analysis.

Deploy the Host Shield

  1. Save the docker-compose.yml file in your working directory.
  2. Replace the following with your actual Sysdig configuration values:
    • <ACCESS_KEY>
    • <COLLECTOR_URL>
    • <COLLECTOR_PORT>
    • <API_URL>
  3. Start the container:
docker compose up -d

Rapid Response

To enable Rapid Response, add the following configuration to the ADDITIONAL_CONF.

      ADDITIONAL_CONF: |
        host_scanner:
          enabled: true
          host_fs_mount_path: /host
        kspm_analyzer:
          enabled: true
          host_root: /host
        sysdig_api_endpoint: <API_URL>
        rapid_response:
          enabled: true
          password: <RR_PASSWORD>        

See Respond for more information.