On this page:

You are viewing documentation for CNI version: v0.9

CNI v0.9 documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest release, v1.1, or the current documentation.

win-bridge plugin

plugins/main/windows/win-bridge/README.md

Overview

With win-bridge plugin, all containers (on the same host) are plugged into an L2Bridge network that has one endpoint in the host namespace.

Example configuration

{
	"name": "mynet",
	"type": "win-bridge",
	"ipMasqNetwork": "10.244.0.0/16",
	"ipam": {
		"type": "host-local",
		"subnet": "10.10.0.0/16"
	},
    "policies":[
        {
            "name":"EndpointPolicy",
            "value":{
                "Type":"ROUTE",
                "DestinationPrefix":"10.137.198.27/32",
                "NeedEncap":true
            }
        } 
    ],
    "HcnPolicyArgs": [
        {
            "Type": "SDNRoute"
            "Settings": {
                "DestinationPrefix": "11.0.0.0/8",
                "NeedEncap": true
            }
        }
    ],
    "loopbackDSR": true,
    "capabilities": {
        "dns": true,
        "portMappings":  true
    }
}

Network configuration reference

  • ApiVersion (integer, optional): ApiVersion to use, will default to hns. If set to “2” will try to use hcn APIs.
  • name (string, required): the name of the network.
  • type (string, required): “win-bridge”.
  • ipMasqNetwork (string, optional): setup NAT if not empty.
  • dns (dictionary, optional): dns config to be used.
  • Nameservers (list, optional): list of strings to be used for dns nameservers.
  • Search (list, optional): list of stings to be used for dns search.
  • ipam (dictionary, optional): IPAM configuration to be used for this network.
  • Policies (list, optional): List of hns policies to be used (only used when ApiVersion is < 2).
  • HcnPolicyArgs (list, optional): List of hcn policies to be used (only used when ApiVersion is 2).
  • 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 enable.
  • dns (boolean, optional): If true, will take the dns config supplied by the runtime and override other settings.
  • portMappings (boolean, optional): If true, will handle HostPort<>ContainerPort mapping using NAT HNS Policies