Chart: Sysdig

WARNING

This chart is being deprecated. Please use the sydig-deploy chart for production deployments.

Overview

sysdig chart adds the Sysdig installation components for Sysdig Monitor and Sysdig Secure to all the nodes in your Kubernetes cluster via a DaemonSet. This chart deploys the following Sysdig components into your Kubernetes cluster.

• Sysdig Agent
• Node Analyzer
  • Sysdig Benchmark Runner
  • Sysdig Host Analyzer
  • Sysdig Image Analyzer
  • Sysdig KSPM Analyzer
• Sysdig KSPM Collector

Installation

To deploy the Sysdig installation components, follow the installation instructions given on the Sysdig Documentation website:

Sysdig Monitor

• Installation Requirements
• Installation Instructions

Sysdig Secure | Sysdig Secure + Sysdig Monitor

• Component Overview
• Installation Requirements
• Installation Instructions

Difference Between sysdig and sysdig-deploy

The majority of the differences are in the metadata names and labels in the agent and node-analyzer components in the sysdig-deploy chart.

• helm.sh/chart: sysdig-<version> has been changed to helm.sh.chart: nodeAnalyzer-<version> or helm.sh.chart: agent-<version>
• Added theapp.kubernetes.io/name: agent label to the agent daemonset and pods.
• Added the app.kubernetes.io/name: nodeanalyzer label for the node-analyzer DaemonSet and pods.
• The new ConfigMap and secret for node-analyzer is named <release-name>-nodeanalyzer
• The app: sysdig-agent label is no longer available for the ` node-analyzer` components.

Migrate to sysdig-deploy Chart

Use the migration helper script to easily migrate from the sysdig chart to the new unified sysdig-deploy chart. This script will help re-map your existing values from the sysdig chart, allowing you to deploy this chart with the exact same configuration.

Unlike the sysdig chart, sysdig-deploy only supports Helm v3. If you have not already done so, please upgrade your Helm version to 3.x to use this chart.

Prerequisites

• Python 3.x
• PyYAML

Migration

1. Save the custom-values from the currently deployed version of the sysdig chart:

   helm get values -n sysdig-agent sysdig-agent -o yaml > values.old.yaml
   

2. (Optional) If the migration script has a dependency on pyyaml, install:

   pip install pyyaml
   

3. Run the migration script and redirect the output to a new file. For example, if the old values were saved to values.old.yaml:

   python scripts/migrate_values.py values.old.yaml > values.new.yaml
   

4. Remove the sysdig chart and replace it with the sysdig-deploy chart:

   helm delete -n sysdig-agent sysdig-agent
   
   helm repo update
   helm install -n sysdig-agent sysdig sysdig/sysdig-deploy -f values.new.yaml
   

Verify the integrity and origin

Sysdig Helm Charts are signed so users can verify the integrity and origin of each chart, the steps are as follows:

Import the Public Key

$ curl -o "/tmp/sysdig_public.gpg" "https://charts.sysdig.com/public.gpg"
$ gpg --import /tmp/sysdig_public.gpg

Verify the chart

To check the integrity and the origin of the charts you can now append the --verify flag to the install, upgrade and pull helm commands.

Configuration

You can use the Helm chart to update the default sysdig configurations by using either of the following:

• Using the key-value pair: --set sysdig.settings.key = value
• values.yaml file

Using the Key-Value Pair

Specify each parameter using the --set key=value[,key=value] argument to the helm installcommand.

For example:

helm install --namespace sysdig-agent sysdig-agent \
    --set sysdig.accessKey=YOUR-KEY-HERE,sysdig.settings.tags="role:webserver\,location:europe" \
    sysdig/sysdig

Using values.yaml

The values.yaml file specifies the values for the sysdig configuration parameters. You can add the configuration to the values.yaml file, then use it in the helm install command.

For example:

1. Add the following to the values.yaml file:

   sysdig:
     accessKey: <YOUR-API-KEY>
     settings:
       prometheus:
         enabled: true
         histograms: true
   

   Tip: You can use the default values.yaml file.

2. Run the following:

   helm install --namespace sysdig-agent sysdig-agent -f values.yaml sysdig/sysdig
   

Configuration Parameters

The following table lists the configurable parameters of the Sysdig chart and their default values.

General Parameters

Node Image Analyzer Parameters (Deprecated by nodeAnalyzer)

Additional Configuration

Install on GKE Autopilot

Autopilot is an operation mode for creating and managing clusters in GKE. With Autopilot, Google configures and manages the underlying node infrastructure for you.

To deploy the Sysdig agent in GKE clusters running in Autopilot mode, run:

$ helm install --namespace sysdig-agent sysdig-agent --set sysdig.accessKey=YOUR-KEY-HERE --set sysdig.settings.collector=COLLECTOR_URL sysdig/sysdig --set gke.autopilot=true

When the flag gke.autopilot=true gets true, the chart configuration is overridden as follows:

• nodeAnalyzer.deploy=false
• ebpf.enabled=true
• ebpf.settings.mountEtcVolume=false
• daemonset.annotations='autopilot\.gke\.io/no-connect="true"'
• daemonset.affinity=null'

Therefore, on GKE Autopilot clusters:

• The NodeAnalyzed is not deployed.
• The ebpf is enabled and the etcVolume is not mounted.
• The daemonset affinity is set to null.
• The daemonset annotation is set to enable the Agent to run on autopilot (required from GKE).

Install Agent Components in On-Prem

Sysdig agent can be deployed in your on-premise infrastructure.

You can use the Helm chart by enabling it as follows:

For example:

$ helm install --namespace sysdig-agent sysdig-agent \
    --set sysdig.accessKey=YOUR-KEY-HERE \
    --set collectorSettings.collectorHost=42.32.196.18 \
    --set collectorSettings.collectorPort=6443 \
    --set collectorSettings.sslVerifyCertificate=false \
    sysdig/sysdig

Adding Custom AppChecks

Application checks are integrations that allow the Sysdig agent to collect metrics exposed by specific services. Sysdig has several built-in AppChecks, but sometimes you might need to create your own.

Your AppChecks can deployed with the Helm chart by embedding them in the values YAML file:

customAppChecks:
  sample.py: |-
    from checks import AgentCheck

    class MyCustomCheck(AgentCheck):
        def check(self, instance):
            self.gauge("testhelm", 1)

sysdig:
  accessKey: YOUR-KEY-HERE
  settings:
    app_checks:
      - name: sample
        interval: 10
        pattern: # pattern to match the application
          comm: myprocess
        conf:
          mykey: myvalue

The first section adds the AppCheck in a Kubernetes ConfigMap and makes it available within the Sysdig agent container. The second one configures it on the dragent.yaml file.

Once the values YAML file is ready, deploy the chart:

$ helm install --namespace sysdig-agent sysdig-agent -f values.yaml sysdig/sysdig

Automate Generating the custom-app-checks.yaml File

Sometimes editing and maintaining YAML files can be a bit cumbersome and error-prone, so you can use a script for automating this process and make your life easier.

If you have custom AppChecks for a number of services like Redis, MongoDB and Traefik and a values.yaml with your configuration as follows:

sysdig:
  accessKey: YOUR-KEY-HERE
  settings:
    app_checks:
      - name: myredis
        [ ... ]
      - name: mymongo
        [ ... ]
      - name: mytraefik
        [ ... ]

You can generate an additional values YAML file with the custom AppChecks:

$ git clone https://github.com/sysdiglabs/charts.git
$ cd charts/sysdig
$ ./scripts/appchecks2helm appChecks/solr.py appChecks/traefik.py appChecks/nats.py > custom-app-checks.yaml

Then deploy the chart:

$ helm install --namespace sysdig-agent sysdig-agent -f custom-app-checks.yaml -f values.yaml sysdig/sysdig

Configure promscrape

Promscrape is the component that collects Prometheus metrics from the sysdig agent. This component is created based on Prometheus and accepts the same configuration format.

This prometheus.yaml file can contain relabelling rules and filters to remove certain metrics or add some configurations to the collection. An example is:

global:
  scrape_interval: 15s
  evaluation_interval: 15s
scrape_configs:
  - job_name: 'prometheus' # config for federation
    honor_labels: true
    metrics_path: '/federate'
    metric_relabel_configs:
      - regex: 'kubernetes_pod_name'
        action: labeldrop
    params:
      'match[]':
        - '{sysdig="true"}'
    sysdig_sd_configs:
      - tags:
          namespace: monitoring
          deployment: prometheus-server

sysdig_sd_configs allows to select the targets obtained by Sysdig Agent to apply the rules in the job. See how to configure filtering in sysdig documentation.

Add Additional Volumes

In order to pass new ConfigMaps or secrets used for authentication, such as for Prometheus endpoints, you can mount additional secrets, ConfigMaps, or volumes. For example :

extraVolumes:
  volumes:
    - name: sysdig-new-cm
      configMap:
        name: my-cm
        optional: true
    - name: sysdig-new-secret
        secret:
        secretName: my-secret
  mounts:
    - mountPath: /opt/draios/cm
      name: sysdig-new-cm
    - mountPath: /opt/draios/secret
      name: sysdig-new-secret

Add Additional Secrets

You can create additional secrets, such as for Prometheus basic authentication. The values are opaque type secrets and must be in base64 encoded. For example:

extraSecrets:
  - name: sysdig-new-secret
    data:
      sysdig-new-password-key1: bXlwYXNzd29yZA==
      sysdig-new-password-key2: bXlwYXNzd29yZA==

Use Private Docker Image Registry

If you pull the Sysdig Agent image from a private registry that requires authentication, you need to configure additional parameters.

1. Create a secret that stores the registry credentials:

   kubectl create secret docker-registry SECRET_NAME \
     --docker-server=SERVER \
     --docker-username=USERNAME \
     --docker-password=TOKEN \
     --docker-email=EMAIL
   

2. Point to this secret in the values YAML file:

   sysdig:
     accessKey: YOUR-KEY-HERE
   image:
     registry: myrepo.mydomain.tld
     repository: sysdig-agent
     tag: latest-tag
     pullSecrets:
       - name: SECRET_NAME
   

3. set the accessKey value:

   helm install --namespace sysdig-agent sysdig-agent -f values.yaml sysdig/sysdig
   

See Kubernetes Documentation for more information.

Resource Profiles

For ease of use, some predefined resource profiles are available:

Small

requests:
  cpu: 1000m
  memory: 1024Mi
limits:
  cpu: 1000m
  memory: 1024Mi

Medium

requests:
  cpu: 3000m
  memory: 3072Mi
limits:
  cpu: 3000m
  memory: 3072Mi

Large

requests:
  cpu: 5000m
  memory: 6144Mi
limits:
  cpu: 5000m
  memory: 6144Mi

Custom

To set your own resource requests and limits to any values other than the ones defined above, you need to set resourceProfile == custom and then add specific values for resources.* to match your requirements by setting the appropriate values in the resources object.

See Tuning Sysdig Agent for more info.

Upgrade Sysdig Agent Configuration

If you need to upgrade the agent configuration file,

1. Modify the YAML file if you are increasing the metrics limit scraping Prometheus metrics:

   sysdig:
     accessKey: YOUR-KEY-HERE
     settings:
       prometheus:
         enabled: true
         histograms: true
         max_metrics: 2000
         max_metrics_per_process: 400
   

2. upgrade the chart:

   helm upgrade --namespace sysdig-agent sysdig-agent -f values.yaml sysdig/sysdig
   

Upgrade to the Last Version

1. Ensure that you have the latest chart version:

   helm repo update
   

2. Do one of the following:

   • If you deployed the chart with a values.yaml file, modify (or add if it’s missing) the image.tag field and execute:

     helm upgrade --namespace sysdig-agent sysdig-agent -f values.yaml sysdig/sysdig
     

   • If you deployed the chart by setting the values as CLI parameters:

     helm install \
         --namespace sysdig-agent \
         sysdig-agent \
         --set sysdig.accessKey=xxxx \
         --set ebpf.enabled=true \
         sysdig/sysdig
     

     You will need to execute:

     helm upgrade \
         --namespace sysdig-agent \
         sysdig-agent \
         --set sysdig.accessKey=xxxx \
         --set ebpf.enabled=true \
         --set image.tag=<last_version> \
         sysdig/sysdig