Ansible Sysdig agent installer

Credits

This project took inspiration from the following official sysdig repository: https://github.com/draios/partners/tree/main/Tools/ansible-agent Many thanks to @dtaracks for the work done.

What it can do

You can use this tool to install Sysdig-Agent on multiple clusters, hosts and systems like:

• Kubernetes
• Docker container on Linux
• Systemd daemon on Linux
• OpenShift 3.11 / 4.8+

Prerequisites

• Python 3.8+
• pip3
• Sysdig account access key

Note: for the Openshift installation the oc command must be installed on the target node, also the ansible user used must have the cluster-admin role in order to modify ssc

Installation

Create a virtual environment and activate it:

python3 -m venv .venv
source .venv/bin/activate

Install the requirements.txt using pip (it might take a long time depending on your machine)

pip install -r requirements.txt

Install the ansible-galaxy requirements.yml

It might not be required

ansible-galaxy install -r requirements.yml

Personalize your inventory file, group_vars and secret

Inventory file

First of all, you need to personalize your inventory file with all hosts that you want to install Sysdig. In the case of Systemd installation (any kind of Linux machine), you need to specify all hosts, but in the case of a Kubernetes installation, you only need to specify a host that has access to the Kubernetes environment (like a "bastion" machine).

For each type of machine, there is a children class that defines the type of installation that will be performed.

The inventory should look like this:

[cluster1]
host1

[cluster2]
host2
host3

[cluster3]
host4
host5

[cluster4]
host6

# clusters with docker installation
[docker:children]
cluster2

# clusters with systemd installation
[systemd:children]
cluster3

# clusters with k8s installation
[k8s:children]
cluster1

# clusters with ocp installation
[ocp:children]
cluster4

you can also convert this INI file into a YAML for a new fashion look

group_vars

The group_vars directory contains YAML files that have to be named as the groups defined in the inventory. Inside of one of those files you have to define the following parameters:

Parameter Name	Description
sysdig_collector	Sysdig backend endpoint
sysdig_collector_port	Sysdig backend endpoint port
cluster_name	Cluster name
agent_version	Image tag
sysdig_agent_namespace	Kubernetes namespace that will be created where the Sysdig agent will be installed
kube_config_path	Kubernetes / Openshift Connector path
resources_requests_cpu	Defines the cpu requests for the sysdig-agent container
resources_requests_memory	Defines the memory requests for the sysdig-agent container
resources_limit_cpu	Defines the cpu limit for the sysdig-agent container
resources_limit_memory	Defines the memory limit for the sysdig-agent container
nia_enabled	It installs the Node Image Analyzer component if set to True
nia_version	Node Image Analyzer Image tag
nia_api_endpoint	Node Image Analyzer api endpoint
nia_collector_endpoint	Node Image Analyzer collector endpoint
sysdig_access_key	a variable containing the account access key

Sysdig Access Key

The sysdig access key can be insered in multiple ways. you can define the key in a Vault file that will be encrypted. this is the most secure way to store your password. you can also insert the key directly in the group_vars, in this case the key can be also specific for each cluster.

you can find this parameter in your personal settings in the Sysdig SaaS or in the Agent Installation section

The vault file should look like this before the encryption:

sysdig_access_key: XXXXXX-YOUR-AGENT-KEY-XXXXXX

Vault

The vault file will contain a single variable that will be the SysDig account access key for the SaaS backend.

You can define a secret.txt where the ansible-vault password will be stored, make sure that only you can access this file! or you can simply use the --ask-vault-password to prompt the password when necessary.

echo "YOUR_SUPER_SECRET_PASSWORD" > secret.txt

At this point you can create the vaultfile.yaml file:

ansible-vault create vaultfile.yaml --vault-password-file=secret.txt

Group Vars

You can specify in the group_vars group file the sysdig_access_key simply by defining the variable like in the exampple below:

# cluster1.yaml.example
...
sysdig_access_key: XXXXXX-YOUR-AGENT-KEY-XXXXXX
...

Run ansible to install sysdig

At this point you can start the installation process simply by running:

ansible-playbook sysdig-agent.install.yml

if you use the vault:

ansible-playbook sysdig-agent.install.yml --vault-password-file=secret.txt

Dry Run

this execution option is reserved to Kubernetes & Openshift only also you can not use the vault metod.

You can run the playbook in k8s "Dry-Run" fashion, with this option on the specified clusters will not be executed any command directly. Instead, the execution will generate a bundle file for each Cluster. In the case of a K8s Cluster the file will be called k8s-bundle-CLUSTER_NAME.yaml. In the case of an Openshift Cluster, the file will be called openshift-bundle-CLUSTER_NAME.yaml.

start the execution of the dry-run with this command:

ansible-playbook sysdig-agent.install.dry-run.yml --extra-vars 'dry_run=True'

in case of OCP Cluster you have tu run manually:

oc adm policy add-scc-to-user privileged system:serviceaccount:{{ sysdig_agent_namespace }}:sysdig-agent

Contacts

If you have questions or suggestions feel free to contact us:

• [email protected]
• [email protected]