point2pointipam

README

Functional requirements

1. For the different test scenarios we need an endpoint, providing IPAM service in point 2 point mode - allocates pair of IP addresses in /32 subnets and provides static routes for them.
2. IPAM service is created on list of some IP subnets. Request can set some exclude IP prefixes for the allocated IP addresses.
3. IPAM service should be idempotent, so if we have allocated some IP addresses for the request and request type (p2p, subnet) hasn't changed, and allocated addresses are still not excluded by the excluded prefixes, we should return the same addresses for the same connection.

Implementation

ipamServer

It is a server chain element implementing point 2 point IPAM service.

conn, _ := ipam.NewServer("10.0.0.0/24").Request(ctx, &networkservice.NetworkServiceRequest{
    Connection: &networkservice.Connection{
        Context: &networkservice.Context{
            IpContext: &networkservice.IpContext{
                ExcludedPrefixes: []string{"10.0.0.1/32"}
            },
        },
    },
})
conn.GetConnection().GetContext().GetIpContext().GetDstIp()                    // <-- 10.0.0.0/32
conn.GetConnection().GetContext().GetIpContext().GetDstRoutes()[0].GetPrefix() // <-- 10.0.0.2/32
conn.GetConnection().GetContext().GetIpContext().GetSrcIp()                    // <-- 10.0.0.2/32
conn.GetConnection().GetContext().GetIpContext().GetSrcRoutes()[0].GetPrefix() // <-- 10.0.0.0/32

Documentation

Overview

Code generated by "-output connectionInfoMap.gen.go -type Map<string,*connectionInfo> -output connectionInfoMap.gen.go -type Map<string,*connectionInfo>"; DO NOT EDIT.

Package point2pointipam provides a p2p IPAM server chain element.

Index

• func NewServer(prefixes ...*net.IPNet) networkservice.NetworkServiceServer
• type Map
  • func (m *Map) Delete(key string)
  • func (m *Map) Load(key string) (*connectionInfo, bool)
  • func (m *Map) LoadAndDelete(key string) (value *connectionInfo, loaded bool)
  • func (m *Map) LoadOrStore(key string, value *connectionInfo) (*connectionInfo, bool)
  • func (m *Map) Range(f func(key string, value *connectionInfo) bool)
  • func (m *Map) Store(key string, value *connectionInfo)

Functions

func NewServer

func NewServer(prefixes ...*net.IPNet) networkservice.NetworkServiceServer

NewServer - creates a new NetworkServiceServer chain element that implements IPAM service.

Types

type Map

type Map sync.Map

Map - sync.Map with key == string and value == networkservice.NetworkServiceClient

func (*Map) Delete

func (m *Map) Delete(key string)

Delete deletes the value for a key.

func (*Map) Load

func (m *Map) Load(key string) (*connectionInfo, bool)

Load returns the value stored in the map for a key, or nil if no value is present. The ok result indicates whether value was found in the map.

func (*Map) LoadAndDelete

func (m *Map) LoadAndDelete(key string) (value *connectionInfo, loaded bool)

LoadAndDelete deletes the value for a key, returning the previous value if any. The loaded result reports whether the key was present.

func (*Map) LoadOrStore

func (m *Map) LoadOrStore(key string, value *connectionInfo) (*connectionInfo, bool)

LoadOrStore returns the existing value for the key if present. Otherwise, it stores and returns the given value. The loaded result is true if the value was loaded, false if stored.

func (*Map) Range

func (m *Map) Range(f func(key string, value *connectionInfo) bool)

Range calls f sequentially for each key and value present in the map. If f returns false, range stops the iteration.

Range does not necessarily correspond to any consistent snapshot of the Map's contents: no key will be visited more than once, but if the value for any key is stored or deleted concurrently, Range may reflect any mapping for that key from any point during the Range call.

Range may be O(N) with the number of elements in the map even if f returns false after a constant number of calls.

func (*Map) Store

func (m *Map) Store(key string, value *connectionInfo)

Store sets the value for a key.