falcon-operator

command module
v0.5.3 Latest Latest
Warning

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

Go to latest
Published: May 27, 2022 License: Unlicense Imports: 16 Imported by: 0

README

CrowdStrike Falcon Twitter URL

Falcon Operator

Artifact Hub CI Golang Build Go Report Card gosec CodeQL Go Reference CI Container Build Docker Repository on Quay Docker Repository on Quay

Falcon Operator installs CrowdStrike Falcon Container Sensor or CrowdStrike Falcon Node Sensor on the cluster.

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

About Falcon Operator

Falcon Operator deploys CrowdStrike Falcon Workload Protection to the cluster. The operator exposes 2 custom resources that allows you to deploy either Falcon Container Sensor or Falcon Node Sensor.

About Custom Resources

Custom Resource Description
FalconContainer Manages installation of Falcon Container Sensor on the cluster
FalconNodeSensor Manages installation of Falcon Linux Sensor on the cluster nodes

Additional information can be found in FAQ document

Installation Steps

Installation steps differ based on Operator Life-cycle Manager (OLM) availability. You can determine whether your cluster is using OLM by running: kubectl get crd catalogsources.operators.coreos.com

  • (option 1): In case your cluster is not using OLM (Operator Life-cycle Manager) run:

    kubectl apply -f https://raw.githubusercontent.com/CrowdStrike/falcon-operator/maint-0.5/deploy/falcon-operator.yaml
    
  • (option 2): In case your cluster is using OLM run:

    OPERATOR_NAMESPACE=falcon-operator
    kubectl create ns $OPERATOR_NAMESPACE --dry-run=client -o yaml | kubectl apply -f -
    operator-sdk run bundle quay.io/crowdstrike/falcon-operator-bundle:v0.5.3 --namespace $OPERATOR_NAMESPACE
    

After the installation concludes please proceed with deploying either Falcon Container Sensor or Falcon Node Sensor.

Uninstall Steps

  • To uninstall Falcon Operator run (when installed using OLM)
    operator-sdk cleanup falcon-operator --namespace falcon-operator
    
  • To uninstall Falcon Operator run (when installed manually)
    kubectl delete -f https://raw.githubusercontent.com/CrowdStrike/falcon-operator/main/deploy/falcon-operator.yaml
    

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 Falcon 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
aws
gcp

Jump to

Keyboard shortcuts

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