feat: update proxy docs to provide link and examples

CrowdStrike · Oct 13, 2023 · 687fc8b · 687fc8b
1 parent 2a02821
commit 687fc8b
Show file tree

Hide file tree

Showing 7 changed files with 116 additions and 6 deletions.
diff --git a/docs/deployment/openshift/resources/container/README.md b/docs/deployment/openshift/resources/container/README.md
@@ -125,7 +125,29 @@ sensor.falcon-system.crowdstrike.com/injection=enabled
 
 ### Auto Proxy Configuration
 
-The operator will automatically configure the sensor's proxy configuration when the cluster proxy is configured on OpenShift via OLM. When not running on OpenShift, adding the proxy configuration via environment variables will also configure the sensor's proxy information. These settings can be overridden by configuring the [sensor's proxy settings](#falcon-sensor-settings).
+The operator will automatically configure the sensor's proxy configuration when the cluster proxy is configured on OpenShift via OLM. See the following documentation for more information:
+* [Configuring cluster-wide proxy](https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html)
+* [Overriding proxy settings of an Operator](https://docs.openshift.com/container-platform/4.13/operators/admin/olm-configuring-proxy-support.html#olm-overriding-proxy-settings_olm-configuring-proxy-support)
+
+When not running on OpenShift, adding the proxy configuration via environment variables will also configure the sensor's proxy information.
+```yaml
+- args:
+  - --leader-elect
+  command:
+  - /manager
+  env:
+  - name: WATCH_NAMESPACE
+    value: null
+  - name: OPERATOR_NAME
+    value: falcon-operator
+  - name: HTTP_PROXY
+    value: http://proxy.example.com:8080
+  - name: HTTPS_PROXY
+    value: http://proxy.example.com:8080
+  image: quay.io/crowdstrike/falcon-operator:latest
+```
+These settings can be overridden by configuring the [sensor's proxy settings](#falcon-sensor-settings)
+
 
 ### Image Registry considerations
 

diff --git a/docs/deployment/openshift/resources/node/README.md b/docs/deployment/openshift/resources/node/README.md
@@ -82,7 +82,29 @@ All arguments are optional, but successful deployment requires either falcon_id
 
 ### Auto Proxy Configuration
 
-The operator will automatically configure the sensor's proxy configuration when the cluster proxy is configured on OpenShift via OLM. When not running on OpenShift, adding the proxy configuration via environment variables will also configure the sensor's proxy information. These settings can be overridden by configuring the [sensor's proxy settings](#falcon-sensor-settings)
+The operator will automatically configure the sensor's proxy configuration when the cluster proxy is configured on OpenShift via OLM. See the following documentation for more information:
+* [Configuring cluster-wide proxy](https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html)
+* [Overriding proxy settings of an Operator](https://docs.openshift.com/container-platform/4.13/operators/admin/olm-configuring-proxy-support.html#olm-overriding-proxy-settings_olm-configuring-proxy-support)
+
+When not running on OpenShift, adding the proxy configuration via environment variables will also configure the sensor's proxy information.
+```yaml
+- args:
+  - --leader-elect
+  command:
+  - /manager
+  env:
+  - name: WATCH_NAMESPACE
+    value: null
+  - name: OPERATOR_NAME
+    value: falcon-operator
+  - name: HTTP_PROXY
+    value: http://proxy.example.com:8080
+  - name: HTTPS_PROXY
+    value: http://proxy.example.com:8080
+  image: quay.io/crowdstrike/falcon-operator:latest
+```
+These settings can be overridden by configuring the [sensor's proxy settings](#falcon-sensor-settings)
+
 
 ### Install Steps
 With Falcon Operator installed, run the following command to install the FalconNodeSensor CR:

diff --git a/docs/resources/container/README.md b/docs/resources/container/README.md
@@ -125,7 +125,29 @@ sensor.falcon-system.crowdstrike.com/injection=enabled
 
 ### Auto Proxy Configuration
 
-The operator will automatically configure the sensor's proxy configuration when the cluster proxy is configured on OpenShift via OLM. When not running on OpenShift, adding the proxy configuration via environment variables will also configure the sensor's proxy information. These settings can be overridden by configuring the [sensor's proxy settings](#falcon-sensor-settings).
+The operator will automatically configure the sensor's proxy configuration when the cluster proxy is configured on OpenShift via OLM. See the following documentation for more information:
+* [Configuring cluster-wide proxy](https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html)
+* [Overriding proxy settings of an Operator](https://docs.openshift.com/container-platform/4.13/operators/admin/olm-configuring-proxy-support.html#olm-overriding-proxy-settings_olm-configuring-proxy-support)
+
+When not running on OpenShift, adding the proxy configuration via environment variables will also configure the sensor's proxy information.
+```yaml
+- args:
+  - --leader-elect
+  command:
+  - /manager
+  env:
+  - name: WATCH_NAMESPACE
+    value: null
+  - name: OPERATOR_NAME
+    value: falcon-operator
+  - name: HTTP_PROXY
+    value: http://proxy.example.com:8080
+  - name: HTTPS_PROXY
+    value: http://proxy.example.com:8080
+  image: quay.io/crowdstrike/falcon-operator:latest
+```
+These settings can be overridden by configuring the [sensor's proxy settings](#falcon-sensor-settings)
+
 
 ### Image Registry considerations
 

diff --git a/docs/resources/node/README.md b/docs/resources/node/README.md
@@ -82,7 +82,29 @@ All arguments are optional, but successful deployment requires either falcon_id
 
 ### Auto Proxy Configuration
 
-The operator will automatically configure the sensor's proxy configuration when the cluster proxy is configured on OpenShift via OLM. When not running on OpenShift, adding the proxy configuration via environment variables will also configure the sensor's proxy information. These settings can be overridden by configuring the [sensor's proxy settings](#falcon-sensor-settings)
+The operator will automatically configure the sensor's proxy configuration when the cluster proxy is configured on OpenShift via OLM. See the following documentation for more information:
+* [Configuring cluster-wide proxy](https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html)
+* [Overriding proxy settings of an Operator](https://docs.openshift.com/container-platform/4.13/operators/admin/olm-configuring-proxy-support.html#olm-overriding-proxy-settings_olm-configuring-proxy-support)
+
+When not running on OpenShift, adding the proxy configuration via environment variables will also configure the sensor's proxy information.
+```yaml
+- args:
+  - --leader-elect
+  command:
+  - /manager
+  env:
+  - name: WATCH_NAMESPACE
+    value: null
+  - name: OPERATOR_NAME
+    value: falcon-operator
+  - name: HTTP_PROXY
+    value: http://proxy.example.com:8080
+  - name: HTTPS_PROXY
+    value: http://proxy.example.com:8080
+  image: quay.io/crowdstrike/falcon-operator:latest
+```
+These settings can be overridden by configuring the [sensor's proxy settings](#falcon-sensor-settings)
+
 
 ### Install Steps
 With Falcon Operator installed, run the following command to install the FalconNodeSensor CR:

diff --git a/docs/src/resources/container.md.tmpl b/docs/src/resources/container.md.tmpl
@@ -125,7 +125,7 @@ sensor.falcon-system.crowdstrike.com/injection=enabled
 
 ### Auto Proxy Configuration
 
-The operator will automatically configure the sensor's proxy configuration when the cluster proxy is configured on OpenShift via OLM. When not running on OpenShift, adding the proxy configuration via environment variables will also configure the sensor's proxy information. These settings can be overridden by configuring the [sensor's proxy settings](#falcon-sensor-settings).
+{{ template "proxy.tmpl" . }}
 
 ### Image Registry considerations
 

diff --git a/docs/src/resources/node.md.tmpl b/docs/src/resources/node.md.tmpl
@@ -82,7 +82,7 @@ All arguments are optional, but successful deployment requires either falcon_id
 
 ### Auto Proxy Configuration
 
-The operator will automatically configure the sensor's proxy configuration when the cluster proxy is configured on OpenShift via OLM. When not running on OpenShift, adding the proxy configuration via environment variables will also configure the sensor's proxy information. These settings can be overridden by configuring the [sensor's proxy settings](#falcon-sensor-settings)
+{{ template "proxy.tmpl" . }}
 
 ### Install Steps
 With Falcon Operator installed, run the following command to install the FalconNodeSensor CR:

diff --git a/docs/src/templates/proxy.tmpl b/docs/src/templates/proxy.tmpl
@@ -0,0 +1,22 @@
+The operator will automatically configure the sensor's proxy configuration when the cluster proxy is configured on OpenShift via OLM. See the following documentation for more information:
+* [Configuring cluster-wide proxy](https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html)
+* [Overriding proxy settings of an Operator](https://docs.openshift.com/container-platform/4.13/operators/admin/olm-configuring-proxy-support.html#olm-overriding-proxy-settings_olm-configuring-proxy-support)
+
+When not running on OpenShift, adding the proxy configuration via environment variables will also configure the sensor's proxy information.
+```yaml
+- args:
+  - --leader-elect
+  command:
+  - /manager
+  env:
+  - name: WATCH_NAMESPACE
+    value: null
+  - name: OPERATOR_NAME
+    value: falcon-operator
+  - name: HTTP_PROXY
+    value: http://proxy.example.com:8080
+  - name: HTTPS_PROXY
+    value: http://proxy.example.com:8080
+  image: quay.io/crowdstrike/falcon-operator:latest
+```
+These settings can be overridden by configuring the [sensor's proxy settings](#falcon-sensor-settings)