thirumoorthir / crowdstrike

Puppet module to deploy and manage CrowdStrike agent

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status Puppet Forge Puppet Forge -- Downloads

crowdstrike

The module is designed to deploy and manage CrowdStrike's Falcon Sensor antivirus agent.

Table of Contents

  1. Description
  2. Setup - The basics of getting started with crowdstrike
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.

Description

The modules installs and manages or removes the Falcon Sensor anti-virus agent by CrowdStrike. Proxy settings and tags can be confiugred additionaly.

Setup

Setup requirements

The module installs a package falcon-sensor, which it assumes to be available in a repo configured on the system. The vendor does not maintain a Linux repository.

Alternatively you can customize package source and provider to have an ability to install from a different source.

Beginning with crowdstrike

The most basic usage of the module:

class { 'crowdstrike': cid => 'AAAAAAAAAAAAA-BB' }

Parameter cid is mandatory.

Usage

In most cases just specifying cid (customer id) is sufficient, but adding tags is desirable for easy grouping and searching of the hosts in the CrowdStrike console:

class { 'crowdstrike':
  cid  => 'AAAAAAAAAAAA-BB',
  tags => [ 'My Organization', 'My Department' ]
}

If the computer does not have direct access to the CrowdStrike cloud service, connection can be routed through a proxy server:

class { 'crowdstrike':
  cid        => 'AAAAAAAAAAAA-BB',
  proxy_host => 'proxy-server.my-organization.com',
  proxy_port => 3128
}

Both proxy_host and proxy_port are mandatory if either specified.

If provisioning token is reqired during the installation, use the provisioning_token parameter:

class { 'crowdstrike':
  cid                => 'AAAAAAAAAAAA-BB',
  provisioning_token => 'XXXXXXXXXXXXXX'
}

Limitations

If proxy has been used and later disabled, the host and port configuration is not removed entirely, only disabled. This does not affect the functionality in any way.

CrowdStrike sensor software is capable of auto-updating its binaries if configured to do so in the console. It happened in the past when update changes the format of the falconctl output, which may break the fact in this module. If that happens, the module detects this situation, displays the relevant error message and fails the puppet run. If you see this happening, it is time to update the version of the module you have.

About

Puppet module to deploy and manage CrowdStrike agent


Languages

Language:Ruby 68.6%Language:Puppet 30.2%Language:Dockerfile 1.2%