From 690a2a7a4d8cd5bd183660f4466866e51005a3ef Mon Sep 17 00:00:00 2001 From: Michael Adam Date: Sun, 10 Nov 2024 19:06:34 +0100 Subject: [PATCH] docs: add design for enforcing host network. Signed-off-by: Michael Adam --- docs/design/enforceHostNetwork.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 docs/design/enforceHostNetwork.md diff --git a/docs/design/enforceHostNetwork.md b/docs/design/enforceHostNetwork.md new file mode 100644 index 00000000..81583f19 --- /dev/null +++ b/docs/design/enforceHostNetwork.md @@ -0,0 +1,31 @@ +# Enforcing host network design document + +By default, the ceph-csi controller plugin operates on the pod network +but under some circumstances, like like setups with a dedicaated storage network, +where the pod network cannot connect to the ceph cluster, +it is necessary to run the Ceph-CSI controller plugin pods on the host network. + +This document describes how the ceph-csi-operator can be configured to enforce the use of host network in +the Ceph-CSI controller plugin pods + +Enforcing of host network can be enabled in the operator configuration by setting `hostNetwork` to `true` in the `driverSpecDefaults.rcontrollerPlugin` section +of the `OperatorConfig` CR. + +Example: + +```yaml +kind: OperatorConfig +apiVersion: csi.ceph.io/v1alpha1 + + +metadata: + name: ceph-csi-operator-config + namespace: +spec: + driverSpecDefaults: + controllerPlugin: + hostNetwork: true +... + +``` +