chore: adding DOCA driver upgrade controller modes description #210
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Ido Heyvi <iheyvi@nvidia.com>
almaslennikov
approved these changes
May 14, 2025
Collaborator
almaslennikov
left a comment
almaslennikov
left a comment
There was a problem hiding this comment.
small nits, otherwise LGTM
docs/life-cycle-management.rst
Outdated
| .. note:: Enabling requestor mode will require deployment of NVIDIA maintenance operator on the cluster. | ||
| By default, upgrade controller will use in-place mode. | ||
| ``nodeMaintenanceNamePrefix`` is used to distinguish between different (operators) requestors, requesting node maintenance operations on the same node(s). | ||
| Deploying maintenance operator, as well as enabling reuestor mode, can be done through Network Operator helm ``values.yaml``: |
docs/life-cycle-management.rst
Outdated
| * - Mode | ||
| - Description | ||
| * - In-place | ||
| - In-place (legacy) mode is incorporating full driver upgrade lifecycle, including nodes operations e.g. cordon, pod eviction, drain, uncordon. It also maintains an internal scheduler for performing above node operations, according to provided ``maxParallelUpgrades`` under ``UpgradePolicy``. |
heyvister1
force-pushed
the
add-mo-to-docs
branch
from
c89b7d9 to
91f4760
Compare
e0ne
requested changes
May 16, 2025
| * - In-place | ||
| - In-place (legacy) mode is incorporates full driver upgrade lifecycle, including nodes operations e.g. cordon, pod eviction, drain, uncordon. It also maintains an internal scheduler for performing above node operations, according to provided ``maxParallelUpgrades`` under ``UpgradePolicy``. | ||
| * - Requestor | ||
| - New ``requestor`` upgrade mode uses NVIDIA maintenance operator (please refer to `maintenance-operator repo`_) nodeMaintenance k8s API objects, to initiate the DOCA driver upgrade process. Essentially, it will retire current upgrade controller (in-place mode) from performing the following node operations: cordon, wait for pods completion, drain, uncordon. To enable requestor mode, the following environment variable should be enabled ``MAINTENANCE_OPERATOR_ENABLED=true``. |
Collaborator
There was a problem hiding this comment.
Please, add a note that this environment variable could be configured via helm values
heyvister1
force-pushed
the
add-mo-to-docs
branch
from
91f4760 to
8d2d796
Compare
…odes: inplace/requestor Signed-off-by: Ido Heyvi <iheyvi@nvidia.com>
heyvister1
force-pushed
the
add-mo-to-docs
branch
from
8d2d796 to
9da3a63
Compare
e0ne
approved these changes
May 19, 2025
Collaborator
e0ne
left a comment
e0ne
left a comment
There was a problem hiding this comment.
Thanks for addressing my comments, @heyvister1 !
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.