Repository navigation
docs(mayastor): spell out the nvmf iface value syntax - #689
Open
krishnaGajabi wants to merge 1 commit into
Open
krishnaGajabi wants to merge 1 commit into
krishnaGajabi wants to merge 1 commit into
Conversation
krishnaGajabi
force-pushed
the
docs/nvmf-iface-syntax
branch
from
October 29, 2026 09:19
3809501 to
7e15949
Compare
The RDMA guide is the only page that documents io_engine.target.nvmf.iface, and it describes the value only as an interface name. The value carries a prefix naming what it matches, and a value with no prefix is matched as an interface name -- so an unprefixed CIDR matches nothing and the io-engine fails to start. Give the two forms that work for a DaemonSet, name: and subnet:, note that the value is shared by every io-engine pod and so has to resolve on every node, and keep the RDMA-specific guidance that the interface should be a netdev an RDMA device is bound to. Signed-off-by: krishnaGajabi <gajbikrishna23@gmail.com>
krishnaGajabi
force-pushed
the
docs/nvmf-iface-syntax
branch
from
October 29, 2026 09:26
7e15949 to
625c030
Compare
krishnaGajabi
marked this pull request as ready for review
October 29, 2026 09:28
This branch has not been deployed
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
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.
Addresses the
io_engine.target.nvmf.ifacefinding reported in openebs/openebs#4059:The RDMA guide is the only page under
docs/mainthat documents this value, and itdescribes it only as an interface name — which is right for RDMA, but it is also where
someone setting
ifacefor any other reason ends up.detect_nvmf_tgt_iface_ipsplits the value on the first colon and falls back to("name", iface)when there is none, so a prefix is required for anything that is nota bare interface name. The Helm chart renders the value once into the io-engine
DaemonSet, so whatever is set has to resolve on every node, which leaves two usable
forms:
eth0,name:eth0subnet:10.0.0.0/24/bitssuffix is required10.0.0.0/24Network interface matching '10.0.0.0/24' not foundOne paragraph added to the Interface Validation prerequisite. The existing RDMA
guidance is kept: for RDMA the interface should be a netdev an RDMA device is bound to.
docs/mainonly, as requested. The matching chart-side fix isopenebs/mayastor-extensions#1117.