https://github.com/crowdstrike/terraform-kubectl-falcon

Module to manage CrowdStrike Falcon Sensor on a Kubernetes cluster.

https://github.com/crowdstrike/terraform-kubectl-falcon

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.9%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Module to manage CrowdStrike Falcon Sensor on a Kubernetes cluster.

Basic Info
Statistics
  • Stars: 7
  • Watchers: 6
  • Forks: 16
  • Open Issues: 6
  • Releases: 9
Created over 3 years ago · Last pushed 11 months ago
Metadata Files
Readme License

README.md

CrowdStrike FalconPy

Twitter URL

CrowdStrike Falcon

This repository contains modules that can be used to automate the deployment of the CrowdStrike Falcon Sensor, Falcon Admission Controller (KAC) Falcon Image Analyzer (IAR) and the Kubernetes Protection Agent (KPA) on a Kubernetes cluster.

Learn more about each module:

| Module | Description | | ---------------------------------------------------------------- | ------------------------- | | operator | Manages Falcon Sensor, KAC and IAR deployments | | operator-openshift | Manages Falcon Sensor, KAC and IAR deployments on OpenShift | | k8s-protection-agent | Manage KPA deployment |

Pre-requisites

  1. You will need to provide CrowdStrike API Keys and CrowdStrike cloud region for the installation. It is recommended to establish new API credentials for the installation at https://falcon.crowdstrike.com/support/api-clients-and-keys, minimal required permissions are:

    | Scope Name | Permission | | --------------------------- | ---------------------- | | Falcon Images Download | Read | | Sensor Download | Read | | Falcon Container CLI | Write | | Falcon Container Image | Read and Write | | Kubernetes Protection Agent | Write | | Kubernetes Protection | Read and Write |

  2. You need a CrowdStrike Docker API Token and CID. See How to retrieve your Falcon Docker API Token and CID for instructions on how to retrieve your Docker API Token and CID.

Providers

No providers.

Resources

No resources.

Inputs

| Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | admission_controller_manifest_path | n/a | string | "default" | no | | cid | Customer ID (CID) of the Falcon platform. | string | n/a | yes if kpa = true | | cleanup | Whether to cleanup resources on destroy. | bool | true | no | | client_id | Falcon API Client Id | string | n/a | yes | | client_secret | Falcon API Client Secret | string | n/a | yes | | cluster_name | Your Cluster Name | string | n/a | yes | | container_sensor_manifest_path | n/a | string | "default" | no | | docker_api_token | Falcon Docker API Token | string | n/a | yes | | environment | Environment or 'Alias' tag | string | "tf_module" | no | | falcon_admission | Whether to deploy the FalconAdmission Custom Resource (CR) to the cluster. | bool | true | no | | cloud | Falcon Cloud Region to use. | string | n/a | no | | iar | Whether to deploy the Falcon Image Analyzer Custom Resource (CR) to the cluster. | bool | true | no | | iar_manifest_path | n/a | string | "default" | no | | kpa | Whether to deploy the Falcon Kubernetes Protection Agent to the cluster. | bool | false | no | | node_manifest_path | n/a | string | "default" | no | | node_sensor_mode | Falcon Node Sensor mode: 'kernel' or 'bpf'. | string | "bpf" | no | | operator_version | Falcon Operator version to deploy. Can be a branch, tag, or commit hash of the falcon-operator repo. | string | "v0.9.1" | no | | platform | Specify whether your cluster is managed by kubernetes or openshift. | string | "kubernetes" | no | | sensor_type | Falcon sensor type: FalconNodeSensor or FalconContainer. | string | "FalconNodeSensor" | no |

Outputs

No outputs.

Usage

```hcl provider "aws" { region = local.region }

Example of using secrets stored in AWS Secrets Manager

data "awseksclusterauth" "this" { name = module.eksblueprints.eksclusterid }

data "awssecretsmanagersecretversion" "current" { secretid = data.awssecretsmanagersecret.falconsecrets.id versionstage = var.awssecretversion_stage }

locals { clustername = "cluster-name" region = var.region falconregion = var.falcon_region

secrets = jsondecode(data.awssecretsmanagersecretversion.current.secretstring) }

module "crowdstrike_falcon" { source = "CrowdStrike/falcon/kubectl" version = "0.6.1"

cid = local.secrets["cid"] clientid = local.secrets["clientid"] clientsecret = local.secrets["clientsecret"] falconregion = local.falconregion clustername = local.clustername dockerapitoken = local.secrets["dockerapitoken"] } ``` <!-- ENDTFDOCS -->

Owner

  • Name: CrowdStrike
  • Login: CrowdStrike
  • Kind: organization
  • Email: github@crowdstrike.com
  • Location: United States of America

GitHub Events

Total
  • Create event: 3
  • Issues event: 7
  • Release event: 4
  • Watch event: 1
  • Issue comment event: 22
  • Push event: 4
  • Pull request review event: 7
  • Pull request review comment event: 7
  • Pull request event: 6
  • Fork event: 2
Last Year
  • Create event: 3
  • Issues event: 7
  • Release event: 4
  • Watch event: 1
  • Issue comment event: 22
  • Push event: 4
  • Pull request review event: 7
  • Pull request review comment event: 7
  • Pull request event: 6
  • Fork event: 2

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 66
  • Total Committers: 6
  • Avg Commits per committer: 11.0
  • Development Distribution Score (DDS): 0.409
Past Year
  • Commits: 21
  • Committers: 4
  • Avg Commits per committer: 5.25
  • Development Distribution Score (DDS): 0.143
Top Committers
Name Email Commits
Ryan Payne r****e@o****m 39
ffalor 3****r 21
Gabe Alford r****s@g****m 3
billnbell3 b****l@e****m 1
Zach Nedwich z****h@z****m 1
Justin Dhillon j****n@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 27
  • Total pull requests: 35
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 13
  • Total pull request authors: 6
  • Average comments per issue: 1.85
  • Average comments per pull request: 0.37
  • Merged pull requests: 31
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 8
  • Pull requests: 6
  • Average time to close issues: 11 days
  • Average time to close pull requests: 8 days
  • Issue authors: 4
  • Pull request authors: 3
  • Average comments per issue: 2.63
  • Average comments per pull request: 0.67
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ffalor (7)
  • ryanjpayne (3)
  • jordanduttinger (3)
  • billnbell3 (3)
  • barakvbzz (2)
  • jonathanosullivan (2)
  • db-er (1)
  • ashwiren (1)
  • tiwari3010 (1)
  • brieschick34 (1)
  • Sharvilb (1)
  • fcastagninizoom (1)
Pull Request Authors
  • ryanjpayne (22)
  • ffalor (14)
  • redhatrises (7)
  • justindhillon (2)
  • znedw (2)
  • billnbell3 (2)
Top Labels
Issue Labels
bug (7) enhancement (4) documentation (4) discuss (1) operator (1)
Pull Request Labels
bug (2) enhancement (2) documentation (1)