Skip to content

Commit 63994de

Browse files
gpontejos-csgpontejos-cs
committed
chore(docs): Update CrowdStrike registry usage for FalconNodeSensor
1 parent aba36f9 commit 63994de

File tree

3 files changed

+24
-9
lines changed

3 files changed

+24
-9
lines changed

‎docs/deployment/openshift/resources/node/README.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,14 @@ spec:
6060
| installNamespace | (optional) Override the default namespace of falcon-system |
6161
| node.tolerations | (optional) See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ for examples on configuring tolerations |
6262
| node.nodeAffinity | (optional) See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ for examples on configuring nodeAffinity |
63-
| node.image | (optional) Location of the Falcon Sensor Image. Specify only when you mirror the original image to your own image repository |
63+
| node.image | (optional) Location of the Falcon Sensor Image. Use this field only when pulling from non-CrowdStrike registries (e.g., when you mirror the original image to your own image repository). For CrowdStrike registries, use `node.version` instead. |
6464
| node.imagePullPolicy | (optional) Override the default Falcon Container image pull policy of Always |
6565
| node.imagePullSecrets | (optional) list of references to secrets to use for pulling image from image_override location. |
6666
| node.terminationGracePeriod | (optional) Kills pod after a specified amount of time (in seconds). Default is 60 seconds. |
6767
| node.serviceAccount.annotations | (optional) Annotations that should be added to the Service Account (e.g. for IAM role association) |
6868
| node.backend | (optional) Configure the backend mode for Falcon Sensor (allowed values: kernel, bpf) |
6969
| node.disableCleanup | (optional) Cleans up `/opt/CrowdStrike` on the nodes by deleting the files and directory. |
70-
| node.version | (optional) Enforce particular Falcon Sensor version to be installed (example: "6.35", "6.35.0-13207") |
70+
| node.version | (optional) Enforce particular Falcon Sensor version to be installed (example: "6.35", "6.35.0-13207"). Use this field when pulling from CrowdStrike registries (when using Falcon API credentials). For non-CrowdStrike registries, use `node.image` instead. |
7171
| node.gke.autopilot | (optional) Enable GKE Autopilot support for FalconNodeSensor. |
7272
| node.gke.deployAllowListVersion | (optional) WorkloadAllowlist version for the sensor daemonset when using GKE AutoPilot. (example: "v1.0.3" for crowdstrike-falconsensor-deploy-allowlist-v1.0.3) |
7373
| node.gke.cleanupAllowListVersion | (optional) WorkloadAllowlist version for the cleanup daemonset when using GKE AutoPilot (example: "v1.0.2" for crowdstrike-falconsensor-cleanup-allowlist-v1.0.2) |
@@ -186,7 +186,12 @@ oc delete falconnodesensors --all
186186

187187
### Sensor upgrades
188188

189-
To upgrade the sensor version, simply add and/or update the `version` field in the FalconNodeSensor resource and apply the change. Alternatively if the `image` field was used instead of using the Falcon API credentials, add and/or update the `image` field in the FalconNodeSensor resource and apply the change. The operator will detect the change and perform the upgrade by restarting the daemonset pods one by one.
189+
To upgrade the sensor version:
190+
191+
- **For CrowdStrike registries** (when using Falcon API credentials): Add and/or update the `version` field in the FalconNodeSensor resource and apply the change.
192+
- **For non-CrowdStrike registries**: Add and/or update the `image` field in the FalconNodeSensor resource and apply the change.
193+
194+
The operator will detect the change and perform the upgrade by restarting the daemonset pods one by one.
190195

191196
### Troubleshooting
192197

‎docs/resources/node/README.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,14 @@ spec:
6060
| installNamespace | (optional) Override the default namespace of falcon-system |
6161
| node.tolerations | (optional) See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ for examples on configuring tolerations |
6262
| node.nodeAffinity | (optional) See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ for examples on configuring nodeAffinity |
63-
| node.image | (optional) Location of the Falcon Sensor Image. Specify only when you mirror the original image to your own image repository |
63+
| node.image | (optional) Location of the Falcon Sensor Image. Use this field only when pulling from non-CrowdStrike registries (e.g., when you mirror the original image to your own image repository). For CrowdStrike registries, use `node.version` instead. |
6464
| node.imagePullPolicy | (optional) Override the default Falcon Container image pull policy of Always |
6565
| node.imagePullSecrets | (optional) list of references to secrets to use for pulling image from image_override location. |
6666
| node.terminationGracePeriod | (optional) Kills pod after a specified amount of time (in seconds). Default is 60 seconds. |
6767
| node.serviceAccount.annotations | (optional) Annotations that should be added to the Service Account (e.g. for IAM role association) |
6868
| node.backend | (optional) Configure the backend mode for Falcon Sensor (allowed values: kernel, bpf) |
6969
| node.disableCleanup | (optional) Cleans up `/opt/CrowdStrike` on the nodes by deleting the files and directory. |
70-
| node.version | (optional) Enforce particular Falcon Sensor version to be installed (example: "6.35", "6.35.0-13207") |
70+
| node.version | (optional) Enforce particular Falcon Sensor version to be installed (example: "6.35", "6.35.0-13207"). Use this field when pulling from CrowdStrike registries (when using Falcon API credentials). For non-CrowdStrike registries, use `node.image` instead. |
7171
| node.gke.autopilot | (optional) Enable GKE Autopilot support for FalconNodeSensor. |
7272
| node.gke.deployAllowListVersion | (optional) WorkloadAllowlist version for the sensor daemonset when using GKE AutoPilot. (example: "v1.0.3" for crowdstrike-falconsensor-deploy-allowlist-v1.0.3) |
7373
| node.gke.cleanupAllowListVersion | (optional) WorkloadAllowlist version for the cleanup daemonset when using GKE AutoPilot (example: "v1.0.2" for crowdstrike-falconsensor-cleanup-allowlist-v1.0.2) |
@@ -186,7 +186,12 @@ kubectl delete falconnodesensors --all
186186

187187
### Sensor upgrades
188188

189-
To upgrade the sensor version, simply add and/or update the `version` field in the FalconNodeSensor resource and apply the change. Alternatively if the `image` field was used instead of using the Falcon API credentials, add and/or update the `image` field in the FalconNodeSensor resource and apply the change. The operator will detect the change and perform the upgrade by restarting the daemonset pods one by one.
189+
To upgrade the sensor version:
190+
191+
- **For CrowdStrike registries** (when using Falcon API credentials): Add and/or update the `version` field in the FalconNodeSensor resource and apply the change.
192+
- **For non-CrowdStrike registries**: Add and/or update the `image` field in the FalconNodeSensor resource and apply the change.
193+
194+
The operator will detect the change and perform the upgrade by restarting the daemonset pods one by one.
190195

191196
### Troubleshooting
192197

‎docs/src/resources/node.md.tmpl‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,14 @@ spec:
6060
| installNamespace | (optional) Override the default namespace of falcon-system |
6161
| node.tolerations | (optional) See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ for examples on configuring tolerations |
6262
| node.nodeAffinity | (optional) See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ for examples on configuring nodeAffinity |
63-
| node.image | (optional) Location of the Falcon Sensor Image. Specify only when you mirror the original image to your own image repository |
63+
| node.image | (optional) Location of the Falcon Sensor Image. Use this field only when pulling from non-CrowdStrike registries (e.g., when you mirror the original image to your own image repository). For CrowdStrike registries, use `node.version` instead. |
6464
| node.imagePullPolicy | (optional) Override the default Falcon Container image pull policy of Always |
6565
| node.imagePullSecrets | (optional) list of references to secrets to use for pulling image from image_override location. |
6666
| node.terminationGracePeriod | (optional) Kills pod after a specified amount of time (in seconds). Default is 60 seconds. |
6767
| node.serviceAccount.annotations | (optional) Annotations that should be added to the Service Account (e.g. for IAM role association) |
6868
| node.backend | (optional) Configure the backend mode for Falcon Sensor (allowed values: kernel, bpf) |
6969
| node.disableCleanup | (optional) Cleans up `/opt/CrowdStrike` on the nodes by deleting the files and directory. |
70-
| node.version | (optional) Enforce particular Falcon Sensor version to be installed (example: "6.35", "6.35.0-13207") |
70+
| node.version | (optional) Enforce particular Falcon Sensor version to be installed (example: "6.35", "6.35.0-13207"). Use this field when pulling from CrowdStrike registries (when using Falcon API credentials). For non-CrowdStrike registries, use `node.image` instead. |
7171
| node.gke.autopilot | (optional) Enable GKE Autopilot support for FalconNodeSensor. |
7272
| node.gke.deployAllowListVersion | (optional) WorkloadAllowlist version for the sensor daemonset when using GKE AutoPilot. (example: "v1.0.3" for crowdstrike-falconsensor-deploy-allowlist-v1.0.3) |
7373
| node.gke.cleanupAllowListVersion | (optional) WorkloadAllowlist version for the cleanup daemonset when using GKE AutoPilot (example: "v1.0.2" for crowdstrike-falconsensor-cleanup-allowlist-v1.0.2) |
@@ -160,7 +160,12 @@ To uninstall the FalconNodeSensor CR, simply remove the FalconNodeSensor resourc
160160

161161
### Sensor upgrades
162162

163-
To upgrade the sensor version, simply add and/or update the `version` field in the FalconNodeSensor resource and apply the change. Alternatively if the `image` field was used instead of using the Falcon API credentials, add and/or update the `image` field in the FalconNodeSensor resource and apply the change. The operator will detect the change and perform the upgrade by restarting the daemonset pods one by one.
163+
To upgrade the sensor version:
164+
165+
- **For CrowdStrike registries** (when using Falcon API credentials): Add and/or update the `version` field in the FalconNodeSensor resource and apply the change.
166+
- **For non-CrowdStrike registries**: Add and/or update the `image` field in the FalconNodeSensor resource and apply the change.
167+
168+
The operator will detect the change and perform the upgrade by restarting the daemonset pods one by one.
164169

165170
### Troubleshooting
166171

0 commit comments

Comments
 (0)