Chef Resources

falcon_install

The falcon_install: resource is a wrapper resource around the native Chef service resource and allows you to maintain the state of the Falcon service.

Actions

The Default action is :install

Name	Description
:install	Installs the Falcon sensor.
:remove	Removes the Falcon sensor.

Properties

Name	Type	Default	Description
version	String		The version of the Falcon sensor to install
version_manage	[true, false]	false	Whether or not Chef should enforce a specific version and do upgrades/downgrades
client_id	String		The client id used to authenticate with the Falcon API
client_secret	String		The client secret used to authenticate with the Falcon API
update_policy	String		The update policy to use to determine the package version to download and install
version_decrement	Integer	0	The number of versions to decrement the desired version by
falcon_cloud	String	api.crowdstrike.com	The Falcon API cloud to use
cleanup_installer	[true, false]	true	Whether or not to cleanup the installer after installation
install_method	[‘api’, ‘local’]	api	The method to use to install the Falcon sensor
package_source	String		The path to the package in the local file system
sensor_tmp_dir	String	/tmp	The directory to stage the Falcon package in

Example

falcon_install 'falcon' do
  client_id 'LKJSDLFKJSLKDJFKLJ'
  client_secret 'SDLKFJLKSJDFLKJSDFLK'
  action :install
end

falcon_install 'falcon' do
  client_id 'LKJSDLFKJSLKDJFKLJ'
  client_secret 'SDLKFJLKSJDFLKJSDFLK'
  falcon_cloud 'api.us-2.crowdstrike.com'
  update_policy 'ACME Policy'
  action :install
end

falcon_install 'falcon' do
  install_method 'local'
  package_source '/tmp/falcon-sensor.rpm'
  action :install
end

falcon_config

The falcon_config: resource configures the Falcon sensor.

Actions

The Default action is :set

Name	Description
:set	Set options for the Falcon sensor
:delete	Delete options for the Falcon sensor

Properties

Name	Type	Default	Description
cid	String		The Customer CID to register the agent with
proxy_host	String		The proxy host to use for the agent
proxy_port	Integer		The proxy port to use for the agent
proxy_enabled	[true, false]		Whether or not to enable the proxy for the agent
tags	Array	[]	The tags to set on the agent
provisioning_token	String		The provisioning token to use to register the agent
tag_membership	[“minimum”, “inclusive”]	minimum	Whether specified tags should be treated as a complete list inclusive or as a list of tags to add to the existing list minimum

Example

falcon_config 'falcon' do
  cid 'JKLJSDLKFJLKSJDFLKJSDLKFJ-28'
  notifies :restart, 'falcon_service[falcon]', :delayed
  action :set
end

falcon_config 'falcon' do
  cid 'JKLJSDLKFJLKSJDFLKJSDLKFJ-28'
  tags %w(tag1 tag2 tag3)
  proxy_host 'http://example.com'
  proxy_port 8080
  proxy_enabled true
  notifies :restart, 'falcon_service[falcon]', :delayed
  action :set
end

falcon_service

The falcon_service: resource is a wrapper resource around the native Chef service resource and allows you to maintain the state of the Falcon service.

Actions

The Default action is :start

Name	Description
:disable	Disable the service from starting at boot.
:enable	Enable the service at boot.
:reload	Reload the configuration for this service.
:restart	Restart the service.
:start	Start the service, and keep it running until stopped or disabled.
:stop	Stop the service.

Properties

Name	Type	Default	Description
service_name	String	falcon-sensor	The name of the falcon service

Example

falcon_service 'falcon' do
  action [:start, :enable]
end