Skip to content

Commit

Permalink
docs: add design for enforcing host network.
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Adam <[email protected]>
  • Loading branch information
obnoxxx committed Nov 11, 2024
1 parent 85fb846 commit 690a2a7
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/design/enforceHostNetwork.md
Original file line number Diff line number Diff line change
@@ -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: <operator-namespace>
spec:
driverSpecDefaults:
controllerPlugin:
hostNetwork: true
...

```

0 comments on commit 690a2a7

Please sign in to comment.