feat: add Admission Controller docs

CrowdStrike · Oct 30, 2023 · 8c33dd4 · 8c33dd4
1 parent b9ebbeb
commit 8c33dd4
Show file tree

Hide file tree

Showing 67 changed files with 1,746 additions and 116 deletions.
diff --git a/bundle.Dockerfile b/bundle.Dockerfile
@@ -8,7 +8,7 @@ LABEL operators.operatorframework.io.bundle.package.v1=falcon-operator
 LABEL operators.operatorframework.io.bundle.channels.v1=alpha
 LABEL operators.operatorframework.io.metrics.builder=operator-sdk-v1.30.0
 LABEL operators.operatorframework.io.metrics.mediatype.v1=metrics+v1
-LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v3
+LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v4-alpha
 
 # Labels for testing.
 LABEL operators.operatorframework.io.test.mediatype.v1=scorecard+v1

diff --git a/bundle/manifests/falcon-operator.clusterserviceversion.yaml b/bundle/manifests/falcon-operator.clusterserviceversion.yaml
@@ -101,7 +101,7 @@ metadata:
     capabilities: Basic Install
     categories: Security,Monitoring
     containerImage: quay.io/crowdstrike/falcon-operator
-    createdAt: "2023-10-25T21:27:38Z"
+    createdAt: "2023-10-30T20:05:26Z"
     description: Falcon Operator installs CrowdStrike Falcon Sensors on the cluster
     operatorframework.io/suggested-namespace: falcon-operator
     operators.operatorframework.io/builder: operator-sdk-v1.29.0
@@ -606,15 +606,16 @@ spec:
         path: node.updateStrategy.type
       version: v1alpha1
   description: |-
-    The CrowdStrike Falcon Operator installs the CrowdStrike Falcon Container Sensor or CrowdStrike Falcon Node Sensor on a Kubernetes cluster.
+    The CrowdStrike Falcon Operator installs CrowdStrike Falcon custom resources on a Kubernetes cluster.
 
     ## About the CrowdStrike Falcon Operator
-    The CrowdStrike Falcon Operator deploys CrowdStrike Falcon Workload Protection to the cluster. The operator exposes 2 custom resources that allows you to deploy either the Falcon Container Sensor or Falcon Node Sensor.
+    The CrowdStrike Falcon Operator deploys CrowdStrike Falcon to the cluster. The operator exposes custom resources that allow you to protect your Kubernetes clusters when deployed.
 
     ## About Custom Resources
 
     | Custom Resource                                       | Description                                                      |
     | :--------                                             | :------------                                                    |
+    | [FalconAdmission](https://github.com/CrowdStrike/falcon-operator/tree/main/docs/resources/admission/README.md) | Manages installation of Falcon Admission Controller on the cluster |
     | [FalconContainer](https://github.com/CrowdStrike/falcon-operator/tree/main/docs/resources/container/README.md) | Manages installation of Falcon Container Sensor on the cluster   |
     | [FalconNodeSensor](https://github.com/CrowdStrike/falcon-operator/tree/main/docs/resources/node/README.md)     | Manages installation of Falcon Linux Sensor on the cluster nodes |
 

diff --git a/config/manifests/bases/falcon-operator.clusterserviceversion.yaml b/config/manifests/bases/falcon-operator.clusterserviceversion.yaml
@@ -509,15 +509,16 @@ spec:
         path: node.updateStrategy.type
       version: v1alpha1
   description: |-
-    The CrowdStrike Falcon Operator installs the CrowdStrike Falcon Container Sensor or CrowdStrike Falcon Node Sensor on a Kubernetes cluster.
+    The CrowdStrike Falcon Operator installs CrowdStrike Falcon custom resources on a Kubernetes cluster.
 
     ## About the CrowdStrike Falcon Operator
-    The CrowdStrike Falcon Operator deploys CrowdStrike Falcon Workload Protection to the cluster. The operator exposes 2 custom resources that allows you to deploy either the Falcon Container Sensor or Falcon Node Sensor.
+    The CrowdStrike Falcon Operator deploys CrowdStrike Falcon to the cluster. The operator exposes custom resources that allow you to protect your Kubernetes clusters when deployed.
 
     ## About Custom Resources
 
     | Custom Resource                                       | Description                                                      |
     | :--------                                             | :------------                                                    |
+    | [FalconAdmission](https://github.com/CrowdStrike/falcon-operator/tree/main/docs/resources/admission/README.md) | Manages installation of Falcon Admission Controller on the cluster |
     | [FalconContainer](https://github.com/CrowdStrike/falcon-operator/tree/main/docs/resources/container/README.md) | Manages installation of Falcon Container Sensor on the cluster   |
     | [FalconNodeSensor](https://github.com/CrowdStrike/falcon-operator/tree/main/docs/resources/node/README.md)     | Manages installation of Falcon Linux Sensor on the cluster nodes |
 

diff --git a/docs/deployment/azure/README.md b/docs/deployment/azure/README.md
@@ -1,7 +1,8 @@
 <!--- NOTE: DO NOT EDIT! This file is auto-generated. Please update the source *.tmpl file instead --->
 # Deployment Guide for Azure and AKS
-This document will guide you through the installation of the Falcon Operator and deployment of the following resources provdied by the Falcon Operator:
-- [FalconContainer](../../resources/container/README.md) custom resource to the cluster with Falcon Container image being mirrored from CrowdStrike container registry to ACR (Azure Container Registry).
+This document will guide you through the installation of the Falcon Operator and deployment of the following custom resources provided by the Falcon Operator:
+- [FalconAdmission](../../resources/admission/README.md) with the Falcon Admission Controller image being mirrored from CrowdStrike container registry to ACR (Azure Container Registry).
+- [FalconContainer](../../resources/container/README.md) with the Falcon Container image being mirrored from CrowdStrike container registry to ACR (Azure Container Registry).
 - [FalconNodeSensor](../../resources/node/README.md) custom resource to the cluster.
 
 ## Prerequisites
@@ -18,28 +19,40 @@ This document will guide you through the installation of the Falcon Operator and
 
 ## Installing the Falcon Operator
 
+<details>
+  <summary>Click to expand</summary>
+
 - Set up a new Kubernetes cluster or use an existing one.
 
 - Install the Falcon Operator by running the following command:
   ```sh
   kubectl apply -f https://github.com/crowdstrike/falcon-operator/releases/latest/download/falcon-operator.yaml
   ```
 
+</details>
+
 ### Deploying the Falcon Node Sensor
 
+<details>
+  <summary>Click to expand</summary>
+
 After the Falcon Operator has deployed, you can now deploy the Falcon Node Sensor:
 
 - Deploy FalconNodeSensor through the cli using the `kubectl` command:
   ```sh
   kubectl create -n falcon-operator -f https://raw.githubusercontent.com/crowdstrike/falcon-operator/main/config/samples/falcon_v1alpha1_falconnodesensor.yaml --edit=true
   ```
+</details>
 
 ### Deploying the Falcon Container Sidecar Sensor
+
+<details>
+  <summary>Click to expand</summary>
 #### Configure ACR Registry
 
 - Either create or use an existing ACR registry. Make sure to store the ACR registry name in an environment variable.
   ```sh
-  ACR_NAME=my-acr-registy-name
+  ACR_NAME=my-acr-registry-name
   ```
 
 #### Manual installation of ACR push secret
@@ -85,31 +98,73 @@ The Image push secret is used by the operator to mirror the Falcon Container sen
 
 
 
+</details>
+
+### Deploying the Falcon Admission Controller
+
+<details>
+  <summary>Click to expand</summary>
+
+- Create a new FalconAdmission resource
+  ```sh
+  kubectl create -f https://raw.githubusercontent.com/crowdstrike/falcon-operator/main/docs/deployment/azure/falconadmission.yaml --edit=true
+  ```
+
+</details>
+
 ## Uninstalling
 
 > [!WARNING]
 > It is essential to uninstall ALL of the deployed custom resources before uninstalling the Falcon Operator to ensure proper cleanup.
 
 ### Uninstalling the Falcon Node Sensor
 
+<details>
+  <summary>Click to expand</summary>
+
 Remove the FalconNodeSensor resource by running:
 
 ```sh
 kubectl delete falconnodesensor -A --all
 ```
 
+</details>
+
 ### Uninstalling the Falcon Container Sidecar Sensor
 
+<details>
+  <summary>Click to expand</summary>
+
 Remove the FalconContainer resource. The operator will then uninstall the Falcon Container Sidecar Sensor from the cluster:
 
 ```sh
 kubectl delete falconcontainers --all
 ```
 
+</details>
+
+### Uninstalling the Falcon Admission Controller
+
+<details>
+  <summary>Click to expand</summary>
+
+Remove the FalconAdmission resource. The operator will then uninstall the Falcon Admission Controller from the cluster:
+
+```sh
+kubectl delete falconadmission --all
+```
+
+</details>
+
 ### Uninstalling the Falcon Operator
 
+<details>
+  <summary>Click to expand</summary>
+
 Delete the Falcon Operator deployment by running:
 
 ```sh
 kubectl delete -f https://github.com/crowdstrike/falcon-operator/releases/latest/download/falcon-operator.yaml
 ```
+
+</details>
diff --git a/docs/deployment/azure/falconadmission.yaml b/docs/deployment/azure/falconadmission.yaml
@@ -0,0 +1,14 @@
+apiVersion: falcon.crowdstrike.com/v1alpha1
+kind: FalconAdmission
+metadata:
+  name: falcon-admission
+spec:
+  falcon_api:
+    client_id: PLEASE_FILL_IN
+    client_secret: PLEASE_FILL_IN
+    cloud_region: autodiscover
+  registry:
+    type: acr
+    acr_name: PLEASE_FILL_IN
+  injector:
+    azureConfigPath: "/etc/kubernetes/azure.json"
diff --git a/docs/deployment/azure/falconcontainer.yaml b/docs/deployment/azure/falconcontainer.yaml
@@ -1,7 +1,7 @@
 apiVersion: falcon.crowdstrike.com/v1alpha1
 kind: FalconContainer
 metadata:
-  name: default
+  name: falcon-sidecar-sensor
 spec:
   falcon_api:
     client_id: PLEASE_FILL_IN