Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
update documentation for disable plugin feature

Signed-off-by: adrianc <[email protected]>
  • Loading branch information
adrianchiris committed Jan 10, 2024
1 parent 37630e0 commit 528b0c0
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,23 @@ This feature was created to support deployments where the user want to use some
communication like storage network or out of band managment and the virtual functions must exist on boot and not only
after the operator and config-daemon are running.

#### Disabling SR-IOV Config Daemon plugins

It is possible to disable SR-IOV network operator config daemon plugins in case their operation
is not needed or un-desirable.

As an example, some plugins perform vendor specific firmware configuration
to enable SR-IOV (e.g `mellanox` plugin). certain deployment environments may prefer to perform such configuration
once during node provisioning, while ensuring the configuration will be compatible with any sriov network node policy
defined for the particular environment. This will reduce or completely eliminate the need for reboot of nodes during SR-IOV
configurations by the operator.

This can be done by providing the names of plugins to disable as a comma separated list of strings via
`SRIOV_NETWORK_CONFIG_DAEMON_DISABLE_PLUGINS` environment variable to the operator deployment or using
`sriovConfigDaemon.disablePlugins` helm value.

> **NOTE**: Currently only `mellanox` plugin can be disabled.

## Components and design

This operator is split into 2 components:
Expand Down
6 changes: 6 additions & 0 deletions deployment/sriov-network-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,12 @@ controllers, which can be found in the table below. In a nutshell, the modes tha
| `operator.admissionControllers.certificates.custom.injector.tlsCrt` | string | `` | The public part of the certificate to be used by the Network Resources Injector's admission controller |
| `operator.admissionControllers.certificates.custom.injector.tlsKey` | string | `` | The private part of the certificate to be used by the Network Resources Injector's admission controller |

### SR-IOV Config Daemon parameters

| Name | Type | Default | description |
| ---- | ---- | ------- | ----------- |
| `sriovConfigDaemon.disablePlugins` | []string | `nil` | List of plugins to disable, currently only `mellanox` plugin is allowed |

### Images parameters

| Name | description |
Expand Down

0 comments on commit 528b0c0

Please sign in to comment.