Merge pull request #575 from adrianchiris/document-mofed-env-vars

Document MOFED container env vars

README.md

@@ -475,6 +475,11 @@ While this approach may seem odd. It provides a way to deliver drivers to immuta
 
 [Mellanox OFED container](https://github.com/Mellanox/ofed-docker)
 
+Mellanox OFED driver container supports customization of its behaviour via environment variables.
+This is regarded as advanced functionallity and generally should not be needed.
+
+check [MOFED Driver Container Environment Variables](docs/mofed-container-env-vars.md)
+
 ## Upgrade
 Check [Upgrade section in Helm Chart documentation](deployment/network-operator/README.md#upgrade) for details.
 

docs/mofed-container-env-vars.md

@@ -0,0 +1,33 @@
+# MOFED Driver Container Environment Variables
+
+When creating _nicclustercpolicy_ instance for Network Operator, under `ofedDriver` section
+it is possible to specify a list of environment variables to be exposed to mofed driver container.
+
+These variables affect the operation of the container.
+
+__Example__
+
+```yaml
+ofedDriver:
+  env:
+  - name: CREATE_IFNAMES_UDEV
+    value: true
+```
+
+The use of these Environment variables is intended for advanced cases.
+In most deployments its expected to not require setting those.
+
+| Name | Experimental | Default | Description |
+| ---- | ------------ | ------- | ----------- |
+| CREATE_IFNAMES_UDEV |N|`"false"`| create udev rule to preserve "old-style" path based netdev names e.g `enp3s0f0`|
+| UNLOAD_STORAGE_MODULES |N|`"false"`| unload host storage modules prior to loading mofed modules  |
+| ENABLE_NFSRDMA |N|`"false"`| enable loading of nfs relates storage modules from mofed container|
+| RESTORE_DRIVER_ON_POD_TERMINATION |N|`"true"`| restore host drivers when container is gracefully stopped |
+| ENTRYPOINT_DEBUG |Y|`"false"`| enable/disable debug logs |
+| DEBUG_LOG_FILE |Y|`"/tmp/entrypoint_debug_cmds.log"`| path for entrypoint debug logs |
+
+In addition, the user can specify essentially any environment variables to be exposed to the MOFED container such as
+the standard `"HTTP_PROXY"`, `"HTTPS_PROXY"`, `"NO_PROXY"`
+
+> __Note__: `CREATE_IFNAMES_UDEV` is being set automatically by Network Operator depenting of the Operating System of worker nodes
+> in the cluster (cluster is assumed to be homogenous).