From 687fc8bc4accefe08f4ec5d95a093187738cebf7 Mon Sep 17 00:00:00 2001 From: Gabe Alford Date: Fri, 13 Oct 2023 14:58:28 -0600 Subject: [PATCH] feat: update proxy docs to provide link and examples --- .../openshift/resources/container/README.md | 24 ++++++++++++++++++- .../openshift/resources/node/README.md | 24 ++++++++++++++++++- docs/resources/container/README.md | 24 ++++++++++++++++++- docs/resources/node/README.md | 24 ++++++++++++++++++- docs/src/resources/container.md.tmpl | 2 +- docs/src/resources/node.md.tmpl | 2 +- docs/src/templates/proxy.tmpl | 22 +++++++++++++++++ 7 files changed, 116 insertions(+), 6 deletions(-) create mode 100644 docs/src/templates/proxy.tmpl diff --git a/docs/deployment/openshift/resources/container/README.md b/docs/deployment/openshift/resources/container/README.md index ece1fde3..f2c15b43 100644 --- 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 index d00a942a..1c2a683e 100644 --- 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 index 9489fb34..cd3a5206 100644 --- 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 index 88c1f2b2..7d660651 100644 --- 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 index 2e9a69ee..f91269cd 100644 --- 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 index 15190268..2624f68d 100644 --- 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 new file mode 100644 index 00000000..50fece19 --- /dev/null +++ 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)