{"id":28410027,"url":"https://github.com/crowdstrike/chef-falcon","last_synced_at":"2025-06-16T15:10:17.893Z","repository":{"id":61783908,"uuid":"508344753","full_name":"CrowdStrike/chef-falcon","owner":"CrowdStrike","description":"Install and configure CrowdStrike's Falcon sensor via Chef","archived":false,"fork":false,"pushed_at":"2025-01-30T16:34:42.000Z","size":96,"stargazers_count":2,"open_issues_count":7,"forks_count":3,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-06-02T21:11:07.061Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://supermarket.chef.io/cookbooks/falcon","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CrowdStrike.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-28T14:58:27.000Z","updated_at":"2023-11-17T11:48:09.000Z","dependencies_parsed_at":"2023-02-06T08:15:15.381Z","dependency_job_id":null,"html_url":"https://github.com/CrowdStrike/chef-falcon","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/CrowdStrike/chef-falcon","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrowdStrike%2Fchef-falcon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrowdStrike%2Fchef-falcon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrowdStrike%2Fchef-falcon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrowdStrike%2Fchef-falcon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CrowdStrike","download_url":"https://codeload.github.com/CrowdStrike/chef-falcon/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrowdStrike%2Fchef-falcon/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260183097,"owners_count":22971195,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-02T11:09:48.583Z","updated_at":"2025-06-16T15:10:17.885Z","avatar_url":"https://github.com/CrowdStrike.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Falcon Cookbook\n\n[![Cookbook Version](https://img.shields.io/cookbook/v/falcon)](https://supermarket.chef.io/cookbooks/falcon)\n\nThis cookbook provides resources for installing and configuring the CrowdStrike Falcon sensor.\n\n## Maintainers\n\nThis cookbook maintained by the CrowdStrike Cloud Integration Architects.\n\n\u003ccloud-integrations@crowdstrike.com\u003e\n\n## Requirements\n\nAPI 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.\n\nEnsure the following API scopes are enabled (**_if applicable_**) for this role:\n\n- When `install_method` is set to **api** (default)\n  - **Sensor Download** [read]\n  - **Sensor update policies** [read]\n\n## Platform Support\n\n\\*Supported on:\n\n- Alma/Rocky/CentOS Linux\n- Amazon Linux 1|2\n- Debian/Ubuntu\n- Oracle\n- Red Hat Enterprise Linux\n- Red Hat CoreOS\n- SUSE Linux Enterprise (SLES)\n\n\\*Refer to the [Falcon documentation](https://falcon.crowdstrike.com/documentation/20/falcon-sensor-for-linux#operating-systems) for exact versions supported\n\n## Resources\n\n- [falcon_install](https://github.com/CrowdStrike/chef-falcon/blob/main/documentation/falcon_install.md)\n- [falcon_config](https://github.com/CrowdStrike/chef-falcon/blob/main/documentation/falcon_config.md)\n- [falcon_service](https://github.com/CrowdStrike/chef-falcon/blob/main/documentation/falcon_service.md)\n\n## Usage\n\n- Add `depends 'falcon'` to your cookbook's metadata.rb\n- Use the resources shipped in the cookbook in a recipe, the same way you'd use core Chef resources (file, template, directory, package, etc).\n\n```ruby\nfalcon_install 'falcon' do\n  client_id 'LKJSDLFKJSLKDJFKLJ'\n  client_secret 'SDLKFJLKSJDFLKJSDFLK'\n  action :install\nend\n```\n\n## Test Cookbooks as Examples\n\nThe cookbooks ran under test-kitchen make excellent usage examples.\n\nThe test recipes are found at:\n\n```text\ntest/cookbooks/test/\n```\n\n## Getting Started\n\nHere's an example of installing/managing the latest Falcon sensor:\n\n```ruby\nfalcon_install 'falcon' do\n  client_id 'LKJSDLFKJSLKDJFKLJ'\n  client_secret 'SDLKFJLKSJDFLKJSDFLK'\n  action :install\nend\n\nfalcon_config 'falcon' do\n  cid 'JKLJSDLKFJLKSJDFLKJSDLKFJ-28'\n  notifies :restart, 'falcon_service[falcon]', :delayed\n  action :set\nend\n\nfalcon_service 'falcon' do\n  action [:start, :enable]\nend\n```\n\nYou might not want to install the latest, and instead be interested in N-1 deployment. The `falcon_install` resource might look like:\n\n```ruby\nfalcon_install 'falcon' do\n  client_id 'LKJSDLFKJSLKDJFKLJ'\n  client_secret 'SDLKFJLKSJDFLKJSDFLK'\n  version_decrement: 1 # This number corresponds to N-\n  action :install\nend\n\n... # falcon_config\n\n... # falcon_service\n```\n\nYou can pass in certain options to configure the Falcon sensor. Here's an example of passing in some tags:\n\n```ruby\n... # falcon_install\n\nfalcon_config 'falcon' do\n  cid 'JKLJSDLKFJLKSJDFLKJSDLKFJ-28'\n  tags %w(tag1 tag2)\n  notifies :restart, 'falcon_service[falcon]', :delayed\n  action :set\nend\n\n... # falcon_service\n```\n\nSee [full documentation](#resources) for each resource and action for more information.\n\n## Authors\n\n![Adversary Lineup](https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/adversary-lineup-1.png)\n\n| Name         | Handle        |\n| :----------- | :------------ |\n| Carlos Matos | @carlosmmatos |\n| Frank Falor  | @ffalor       |\n\n## Support\n\nChef 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.\n\nIs something going wrong?\nGitHub Issues are used to report bugs.\n\nSubmit a ticket here:\n[https://github.com/CrowdStrike/chef-falcon/issues/new/choose](https://github.com/CrowdStrike/chef-falcon/issues/new/choose)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowdstrike%2Fchef-falcon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrowdstrike%2Fchef-falcon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowdstrike%2Fchef-falcon/lists"}