Skip to content

Commit

Permalink
update comment for capabilities
Browse files Browse the repository at this point in the history
Signed-off-by: Ye Sijun <[email protected]>
  • Loading branch information
junnplus committed Mar 14, 2022
1 parent e559bd8 commit a4d8d38
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions namespace_opts.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,23 @@ package cni

type NamespaceOpts func(s *Namespace) error

// Capabilities
// WithCapabilityPortMap adds support for port mappings
func WithCapabilityPortMap(portMapping []PortMapping) NamespaceOpts {
return func(c *Namespace) error {
c.capabilityArgs["portMappings"] = portMapping
return nil
}
}

// WithCapabilityIPRanges adds support for ip ranges
func WithCapabilityIPRanges(ipRanges []IPRanges) NamespaceOpts {
return func(c *Namespace) error {
c.capabilityArgs["ipRanges"] = ipRanges
return nil
}
}

// WithCapabilityBandWitdh adds support for traffic shaping:
// https://github.com/heptio/cni-plugins/tree/master/plugins/meta/bandwidth
// WithCapabilityBandWitdh adds support for bandwidth limits
func WithCapabilityBandWidth(bandWidth BandWidth) NamespaceOpts {
return func(c *Namespace) error {
c.capabilityArgs["bandwidth"] = bandWidth
Expand All @@ -50,6 +50,8 @@ func WithCapabilityDNS(dns DNS) NamespaceOpts {
}
}

// WithCapability support well-known capabilities
// https://www.cni.dev/docs/conventions/#well-known-capabilities
func WithCapability(name string, capability interface{}) NamespaceOpts {
return func(c *Namespace) error {
c.capabilityArgs[name] = capability
Expand Down

0 comments on commit a4d8d38

Please sign in to comment.