Skip to content

Documentation for win-overlay is missing ApiVersion setting #1229

@arcusmaximus

Description

@arcusmaximus

The documentation page for win-bridge mentions the ApiVersion setting, but the one for win-overlay does not:
https://www.cni.dev/plugins/current/main/win-overlay/

The setting is not just supported in win-overlay, but required to get it to work with containerd: without an explicit ApiVersion: 2, it complains it can't find the very HNS endpoint it's supposed to create.

Going by this source code comment, the ApiVersion to use depends on the container runtime, so it would be nice if this were documented as well. Then again, the default value of 1 apparently applies to dockershim, which is of course no longer supported - does the comment also apply to cri-dockerd, or would it be better to change the ApiVersion default to 2?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions