cookbook 'falcon', '~> 0.1.3'
falcon (4) Versions 0.1.3 Follow1
Installs/Configures Falcon sensor
cookbook 'falcon', '~> 0.1.3', :supermarket
knife supermarket install falcon
knife supermarket download falcon
Falcon Cookbook
This cookbook provides resources for installing and configuring the CrowdStrike Falcon sensor.
Maintainers
This cookbook maintained by the CrowdStrike Cloud Integration Architects.
cloud-integrations@crowdstrike.com
Requirements
API clients are granted one or more API scopes. Scopes allow access to specific CrowdStrike APIs and describe the actions that an API client can perform.
Ensure the following API scopes are enabled (if applicable) for this role:
- When
install_method
is set to api (default)- Sensor Download [read]
- Sensor update policies [read]
Platform Support
*Supported on:
- Alma/Rocky/CentOS Linux
- Amazon Linux 1|2
- Debian/Ubuntu
- Oracle
- Red Hat Enterprise Linux
- Red Hat CoreOS
- SUSE Linux Enterprise (SLES)
*Refer to the Falcon documentation for exact versions supported
Resources
Usage
- Add
depends 'falcon'
to your cookbook's metadata.rb - Use the resources shipped in the cookbook in a recipe, the same way you'd use core Chef resources (file, template, directory, package, etc).
falcon_install 'falcon' do client_id 'LKJSDLFKJSLKDJFKLJ' client_secret 'SDLKFJLKSJDFLKJSDFLK' action :install end
Test Cookbooks as Examples
The cookbooks ran under test-kitchen make excellent usage examples.
The test recipes are found at:
test/cookbooks/test/
Getting Started
Here's an example of installing/managing the latest Falcon sensor:
falcon_install 'falcon' do client_id 'LKJSDLFKJSLKDJFKLJ' client_secret 'SDLKFJLKSJDFLKJSDFLK' action :install end falcon_config 'falcon' do cid 'JKLJSDLKFJLKSJDFLKJSDLKFJ-28' notifies :restart, 'falcon_service[falcon]', :delayed action :set end falcon_service 'falcon' do action [:start, :enable] end
You might not want to install the latest, and instead be interested in N-1 deployment. The falcon_install
resource might look like:
falcon_install 'falcon' do client_id 'LKJSDLFKJSLKDJFKLJ' client_secret 'SDLKFJLKSJDFLKJSDFLK' version_decrement: 1 # This number corresponds to N- action :install end ... # falcon_config ... # falcon_service
You can pass in certain options to configure the Falcon sensor. Here's an example of passing in some tags:
... # falcon_install falcon_config 'falcon' do cid 'JKLJSDLKFJLKSJDFLKJSDLKFJ-28' tags %w(tag1 tag2) notifies :restart, 'falcon_service[falcon]', :delayed action :set end ... # falcon_service
See full documentation for each resource and action for more information.
Authors
Name | Handle |
---|---|
Carlos Matos | @carlosmmatos |
Frank Falor | @ffalor |
Support
Chef Falcon is an open source project, not a formal CrowdStrike product, to assist developers implement CrowdStrike's Falcon sensor deployment within their organizations. As such it carries no formal support, express or implied.
Is something going wrong?
GitHub Issues are used to report bugs.
Submit a ticket here:
https://github.com/CrowdStrike/chef-falcon/issues/new/choose
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
chef-falcon CHANGELOG
This file is used to list changes made in each version of the chef-falcon cookbook.
0.1.0
Initial release.
- Linux support with API installation method
0.1.1
Full Changelog: https://github.com/CrowdStrike/chef-falcon/compare/0.1.0...0.1.1
- Fix cookbook quality issues by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/18
- Added badge to README for cookbook in supermarket by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/19
- Update readme to include full links by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/20
- Integration Testing by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/21
v0.1.2
Full Changelog: https://github.com/CrowdStrike/chef-falcon/compare/0.1.1...v0.1.2
- Decrement int test by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/29
- Add local install_method to install falcon from local file source by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/30
- Update ci and fix local install by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/31
- Fix issue with s390x support on sensor API by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/34
v0.1.3
Full Changelog: https://github.com/CrowdStrike/chef-falcon/compare/0.1.2...v0.1.3
- Fixed issue of pointing to wrong files for nightly runs by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/39
- Add changelog for last release to not forget in next one by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/42
- Fix ci issues for version and lint by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/43
- Manage sensor version via GH secrets by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/44
- Added new FALCON_VERSIONS to nightly workflow by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/46
- Add FALCON_VERSION as valid workflow call by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/47
- fixes issue with user-agent being overwritten by sensor version by @carlosmmatos in https://github.com/CrowdStrike/chef-falcon/pull/48
Collaborator Number Metric
0.1.3 failed this metric
Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
0.1.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Cookstyle Metric
0.1.3 passed this metric
No Binaries Metric
0.1.3 passed this metric
Testing File Metric
0.1.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.1.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.1.3 failed this metric
0.1.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Cookstyle Metric
0.1.3 passed this metric
No Binaries Metric
0.1.3 passed this metric
Testing File Metric
0.1.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.1.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.1.3 passed this metric
0.1.3 passed this metric
Testing File Metric
0.1.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.1.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.1.3 failed this metric
0.1.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number