docs: Documentation Maintenance and Content Cleanup for Main and v4.5 Docs#588
Open
balaharish7 wants to merge 6 commits into
Open
docs: Documentation Maintenance and Content Cleanup for Main and v4.5 Docs#588balaharish7 wants to merge 6 commits into
balaharish7 wants to merge 6 commits into
Conversation
… Documentation Signed-off-by: Bala Harish <bala.harish.ac@datacore.com>
balaharish7
requested review from
Abhinandan-Purkait,
niladrih and
tiagolobocastro
|
|
||
|
|
||
| - Run `kubectl get pvc` to fetch the volume name. The volume name looks like: *pvc-ee171da3-07d5-11e8-a5be-42010a8001be*. | ||
| - For each volume, you will notice one I/O controller pod and one or more replicas (as per the storage class configuration). You can use the volume ID (ee171da3-07d5-11e8-a5be-42010a8001be) to view information about the volume and replicas using the [kubectl plugin](../user-guides/replicated-storage-user-guide/replicated-pv-mayastor/advanced-operations/kubectl-plugin.md) |
Member
There was a problem hiding this comment.
This seems to be specific for mayastor
Contributor
Author
There was a problem hiding this comment.
These are there from the past Tiago! Should we need to update this or leave it as it is? @tiagolobocastro
Member
There was a problem hiding this comment.
I guess for now maybe change the title to make it clear it's for mayastor only
In the future we should perhaps move this somewhere else and make it more comprehensive for all engines
… Documentation Signed-off-by: Bala Harish <bala.harish.ac@datacore.com>
Signed-off-by: Bala Harish <bala.harish.ac@datacore.com>
|
|
||
| ## Overview | ||
|
|
||
| Replicated PV Mayastor supports SPDK Interrupt Mode, an optional reactor operating mode that reduces CPU utilization during periods of low or idle I/O activity. |
Member
There was a problem hiding this comment.
It's not really the SPDK mode, it's a little different since we can't use the SPDK's one directly today due due to how mayastor reactors work.
Suggested change
| Replicated PV Mayastor supports SPDK Interrupt Mode, an optional reactor operating mode that reduces CPU utilization during periods of low or idle I/O activity. | |
| Replicated PV Mayastor supports Interrupt Mode, an optional reactor operating mode that reduces CPU utilization during periods of low or idle I/O activity. |
|
|
||
| Replicated PV Mayastor supports SPDK Interrupt Mode, an optional reactor operating mode that reduces CPU utilization during periods of low or idle I/O activity. | ||
|
|
||
| By default, SPDK reactors continuously poll for I/O events, which can consume significant CPU resources even when no I/O operations are in progress. When Interrupt Mode is enabled, reactors transition from continuous polling to an event-driven model, allowing them to sleep while waiting for work and wake only when events occur. |
Member
There was a problem hiding this comment.
This may be hallucinated, we don't use the SPDK reactors :) we have our own which is why we can't use the SPDK interrupt mode directly today
Suggested change
| By default, SPDK reactors continuously poll for I/O events, which can consume significant CPU resources even when no I/O operations are in progress. When Interrupt Mode is enabled, reactors transition from continuous polling to an event-driven model, allowing them to sleep while waiting for work and wake only when events occur. | |
| By default, we continuously poll for I/O events, which can consume significant CPU resources even when no I/O operations are in progress. When Interrupt Mode is enabled, reactors transition from continuous polling to an event-driven model, allowing them to sleep while waiting for work and wake only when events occur. |
Contributor
Author
There was a problem hiding this comment.
Oh ok! Got it. Thanks for the explanation @tiagolobocastro :) Should we need to change the document title as well?
| - Provides configurable tuning for balancing CPU utilization and storage performance. | ||
| - Maintains backward compatibility because the feature is disabled by default. | ||
|
|
||
| ## See Also |
Member
There was a problem hiding this comment.
We need some warning panels here:
First of all, this mode is experimental in this release
Second this was not validated for RDMA
Contributor
Author
There was a problem hiding this comment.
Thanks @tiagolobocastro . I've added the below warning right after the Overview section:
- Interrupt Mode is an experimental feature in this release. The functionality and behavior may change in future releases. Evaluate the feature thoroughly in non-production environments before enabling it in production deployments.
- Interrupt Mode has not been validated for use with RDMA configurations in this release. If your deployment uses RDMA, continue using the default polling mode unless interrupt mode support for RDMA is explicitly documented in a future release.
Signed-off-by: Bala Harish <bala.harish.ac@datacore.com>
…into update4.5docs
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Changes Completed
Removed obsolete KB articles:
Moved the following KB entries to the FAQ document:
Removed an invalid CNCF hyperlink from the Use Cases document.
Merged duplicate storage recommendation tables and revised the Data Engines Overview content to eliminate redundancy.
Updated the StorageClass parameter table in the Local PV LVM StorageClass Parameters document by consolidating supported values into a simplified format.
Reorganized the StorageClass Parameters document by moving the parameter overview section to the beginning and improving overall content structure.
Simplified the PersistentVolumeClaim conformance matrix in the Local PV LVM Deployment document by consolidating supported parameters and values into a concise reference table.
Added a StorageClass parameter reference table to the Local PV ZFS StorageClass Parameters document to improve readability and navigation.
Removed quorum-related terminology from the Kubernetes Upgrade Best Practices document and updated the guidance to align with Replicated PV Mayastor behavior.
Moved the Kubernetes Upgrade Best Practices document from:
Removed the FAQ entry:
Updated the FAQ:
Performed miscellaneous formatting, alignment, and consistency improvements across multiple documents.