falcon-operator

command module
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 6, 2021 License: Unlicense Imports: 12 Imported by: 0

README

Falcon Operator

CI Golang Build CI Container Build Docker Repository on Quay Docker Repository on Quay

Falcon Operator installs CrowdStrike Falcon Container Sensor on the cluster.

Falcon Operator is an open source project, not CrowdStrike product. As such it carries no formal support, expressed or implied.

About Falcon Container Sensor

The Falcon Container sensor for Linux extends runtime security to container workloads in Kubernetes clusters that don’t allow you to deploy the kernel-based Falcon sensor for Linux. The Falcon Container sensor runs as an unprivileged container in user space with no code running in the kernel of the worker node OS. This allows it to secure Kubernetes pods in clusters where it isn’t possible to deploy the kernel-based Falcon sensor for Linux on the worker node, as with AWS Fargate where organizations don’t have access to the kernel and where privileged containers are disallowed. The Falcon Container sensor can also secure container workloads on clusters where worker node security is managed separately.

Core Features
  • Leverage market-leading protection technologies: Machine learning (ML), artificial intelligence (AI), indicators of attack (IOAs) and custom hash blocking automatically defend against malware and sophisticated threats targeting containers.
  • Stop malicious behavior: Behavioral profiling enables you to block activities that violate policy with zero impact to legitimate container operation.
  • Investigate container incidents faster: Easily investigate incidents when detections are associated with the specific container and not bundled with host events.
  • See everything: Capture container start, stop, image, runtime information and all events generated inside each and every container.
  • Deploy seamlessly with Kubernetes: Deploy easily at scale by including it as part of a Kubernetes cluster.
  • Improve container orchestration: Capture Kubernetes namespace, pod metadata, process, file and network events.

Learn more at product pages.

About Falcon Operator

Falcon Operator deploys CrowdStrike Falcon Container Workload Protection the cluster. The operator introduces Custom Resource: FalconContainer that allows easy install & uninstall of the Falcon Container.

Installation Steps

Falcon Operator provides automated install & uninstall of Falcon Container Sensor. To start new installation please push FalconContainer resource to your cluster. A sample FalconContainer resource follows:

apiVersion: falcon.crowdstrike.com/v1alpha1
kind: FalconContainer
metadata:
  name: default
  namespace: falcon-system-configure
spec:
  falcon_api:
    cid: PLEASE_FILL_IN
    client_id: PLEASE_FILL_IN
    client_secret: PLEASE_FILL_IN
    cloud_region: us-1
  registry:
    type: gcr

cid parameter refers to CrowdStrike Customer ID. This CID will be used to start Falcon Container sensors and all the data will be reported to that CID. client_id and client_secret parameters refer to API Key pairs used to download the CrowdStrike Falcon Container sensor (no other permission except the sensor download shall be granted to this API key pair).

When FalconContainer Resources is pushed to the cluster, falcon-operator will automatically install Falcon Container product to the cluster.

Uninstall Steps
  • To uninstall Falcon Container simply remove FalconContainer resource. The operator will uninstall Falcon Container product from the cluster.

    kubectl delete falconcontainers.falcon.crowdstrike.com  -n falcon-system-configure default
    
  • To uninstall Falcon Operator run

    operator-sdk cleanup falcon-operator --namespace falcon-operator
    
Upgrades

Current version of the operator does not automatically updates Falcon Container sensor. Users are advised to remove & re-add FalconContainer resource to uninstall Falcon Container and to install the newest version.

Debugging

To review the logs of Falcon Operator run

kubectl -n falcon-operator logs -f deploy/falcon-operator-controller-manager -c manager
Namespace Reference

The following namespaces will be used by Falcon Operator.

Namespace Description
falcon-system Used by Falcon Container product, runs the injector and webhoook
falcon-operator Runs falcon-operator manager
falcon-system-configure Used by operator, contains objects created by operator
Compatibility Guide

Falcon Operator initially supports only GKE/GCR.

Platoform Supported versions
GKE 1.18, 1.19, 1.20
Additional Documentation

Getting Help

If you encounter any issues while using Falcon Operator, you can create an issue on our Github repo for bugs, enhancements, or other requests.

Contributing

You can contribute by:

  • Raising any issues you find using Falcon Operator
  • Fixing issues by opening Pull Requests
  • Submitting a patch or opening a PR
  • Improving documentation
  • Talking about 3scale Operator

All bugs, tasks or enhancements are tracked as GitHub issues.

Additional Resources

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
apis
falcon/v1alpha1
Package v1alpha1 contains API Schema definitions for the falcon v1alpha1 API group +kubebuilder:object:generate=true +groupName=falcon.crowdstrike.com
Package v1alpha1 contains API Schema definitions for the falcon v1alpha1 API group +kubebuilder:object:generate=true +groupName=falcon.crowdstrike.com
controllers
pkg
gcp

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL