win-overlay: document required apiVersion setting for containerd#154
Open
VaishnavSreekumar wants to merge 1 commit into
Open
win-overlay: document required apiVersion setting for containerd#154VaishnavSreekumar wants to merge 1 commit into
VaishnavSreekumar wants to merge 1 commit into
Conversation
Add documentation for the apiVersion field in the win-overlay plugin. Clarify that apiVersion: 2 is required for containerd-based setups to avoid HNS endpoint creation failures. Fixes containernetworking/plugins#1229 Signed-off-by: Vaishnav Sreekumar <vaishnavsreekumar301@gmail.com>
VaishnavSreekumar
force-pushed
the
win-overlay-apiversion-doc
branch
from
d6a371e to
7ecd048
Compare
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
1 participant
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.
This PR documents the
apiVersionfield for the win-overlay plugin.The current documentation does not mention
apiVersion, but it is required for correct operation with container runtimes such as containerd. Without explicitly settingapiVersion: 2, the plugin may fail to create or locate the expected HNS endpoint.Changes:
apiVersion: 2to the example configurationapiVersionfieldFixes containernetworking/plugins#1229