Skip to content

docs: document ApiVersion for win-overlay #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
locker95 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: document ApiVersion for win-overlay #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fe775b
docs: document ApiVersion for win-overlay
locker95 Jul 30, 2026
da10af3
chore: retrigger Netlify deploy preview
locker95 Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions content/plugins/current/main/win-overlay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ With win-overlay plugin, all containers (on the same host) are plugged into an O
"subnet": "10.10.0.0/16"
},
"loopbackDSR": true,
"capabilites": {
"capabilities": {
"dns": true
}
}
Expand All @@ -38,7 +38,9 @@ With win-overlay plugin, all containers (on the same host) are plugged into an O
* `Nameservers` (list, optional): list of strings to be used for dns nameservers.
* `Search` (list, optional): list of stings to be used for dns search.
* `endpointMacPrefix` (string, optional): set to the MAC prefix configured for Flannel.
* `Policies` (list, optional): List of hns policies to be used.
* `ApiVersion` (integer, optional): HNS API version. Defaults to `1` (legacy HNS APIs, historically used with dockershim). Set to `2` to use HCN APIs. With containerd (and typically cri-dockerd), **`ApiVersion: 2` is required**; without it, endpoint creation can fail with errors about a missing HNS endpoint that the plugin is supposed to create.
* `Policies` (list, optional): List of hns policies to be used (only used when `ApiVersion` is less than `2`).
* `HcnPolicyArgs` (list, optional): List of hcn policies to be used (only used when `ApiVersion` is `2`).
* `ipam` (dictionary, required): IPAM configuration to be used for this network.
* `loopbackDSR` (bool, optional): If true, will add a policy to allow the interface to support loopback direct server return.
* `capabilities` (dictionary, optional): runtime capabilities to be parsed and injected by runtime.
Expand Down
6 changes: 4 additions & 2 deletions content/plugins/v1.0/main/win-overlay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ With win-overlay plugin, all containers (on the same host) are plugged into an O
"subnet": "10.10.0.0/16"
},
"loopbackDSR": true,
"capabilites": {
"capabilities": {
"dns": true
}
}
Expand All @@ -38,7 +38,9 @@ With win-overlay plugin, all containers (on the same host) are plugged into an O
* `Nameservers` (list, optional): list of strings to be used for dns nameservers.
* `Search` (list, optional): list of stings to be used for dns search.
* `endpointMacPrefix` (string, optional): set to the MAC prefix configured for Flannel.
* `Policies` (list, optional): List of hns policies to be used.
* `ApiVersion` (integer, optional): HNS API version. Defaults to `1` (legacy HNS APIs, historically used with dockershim). Set to `2` to use HCN APIs. With containerd (and typically cri-dockerd), **`ApiVersion: 2` is required**; without it, endpoint creation can fail with errors about a missing HNS endpoint that the plugin is supposed to create.
* `Policies` (list, optional): List of hns policies to be used (only used when `ApiVersion` is less than `2`).
* `HcnPolicyArgs` (list, optional): List of hcn policies to be used (only used when `ApiVersion` is `2`).
* `ipam` (dictionary, required): IPAM configuration to be used for this network.
* `loopbackDSR` (bool, optional): If true, will add a policy to allow the interface to support loopback direct server return.
* `capabilities` (dictionary, optional): runtime capabilities to be parsed and injected by runtime.
Expand Down
6 changes: 4 additions & 2 deletions content/plugins/v1.1/main/win-overlay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ With win-overlay plugin, all containers (on the same host) are plugged into an O
"subnet": "10.10.0.0/16"
},
"loopbackDSR": true,
"capabilites": {
"capabilities": {
"dns": true
}
}
Expand All @@ -38,7 +38,9 @@ With win-overlay plugin, all containers (on the same host) are plugged into an O
* `Nameservers` (list, optional): list of strings to be used for dns nameservers.
* `Search` (list, optional): list of stings to be used for dns search.
* `endpointMacPrefix` (string, optional): set to the MAC prefix configured for Flannel.
* `Policies` (list, optional): List of hns policies to be used.
* `ApiVersion` (integer, optional): HNS API version. Defaults to `1` (legacy HNS APIs, historically used with dockershim). Set to `2` to use HCN APIs. With containerd (and typically cri-dockerd), **`ApiVersion: 2` is required**; without it, endpoint creation can fail with errors about a missing HNS endpoint that the plugin is supposed to create.
* `Policies` (list, optional): List of hns policies to be used (only used when `ApiVersion` is less than `2`).
* `HcnPolicyArgs` (list, optional): List of hcn policies to be used (only used when `ApiVersion` is `2`).
* `ipam` (dictionary, required): IPAM configuration to be used for this network.
* `loopbackDSR` (bool, optional): If true, will add a policy to allow the interface to support loopback direct server return.
* `capabilities` (dictionary, optional): runtime capabilities to be parsed and injected by runtime.
Expand Down