airship/vino
Code Issues Proposed changes

Add IPPool CR

Browse Source 
This converts the ipammer to use an IPPool CR-based to persist IPAM state.

This followon patchset adds the actual persistence to the API Server:
https://review.opendev.org/c/airship/vino/+/774184

Change-Id: Ib81a0bc6be1c74d85e2adc2dcadd09590a65b292
This commit is contained in:
Matt McEuen 2021-01-22 10:50:40 -06:00
parent a570f85718
commit 40d4804ad1
15 changed files with 670 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
PROJECT
View File

@ -4,4 +4,7 @@ resources:
- group: airship - group: airship
kind: Vino kind: Vino
version: v1 version: v1
- group: airship
kind: IPPool
version: v1
version: "2" version: "2"

79
config/crd/bases/airship.airshipit.org_ippools.yaml Normal file
View File

@ -0,0 +1,79 @@
---
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.3.0
creationTimestamp: null
name: ippools.airship.airshipit.org
spec:
group: airship.airshipit.org
names:
kind: IPPool
listKind: IPPoolList
plural: ippools
singular: ippool
scope: Namespaced
validation:
openAPIV3Schema:
description: IPPool is the Schema for the ippools API
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: IPPool tracks allocation ranges and statuses within a specific
subnet IPv4 or IPv6 subnet. It has a set of ranges of IPs within the
subnet from which IPs can be allocated by IPAM, and a set of IPs that
are currently allocated already.
properties:
allocatedIPs:
items:
type: string
type: array
ranges:
items:
description: Range has (inclusive) bounds within a subnet from which
IPs can be allocated
properties:
start:
type: string
stop:
type: string
required:
- start
- stop
type: object
type: array
subnet:
type: string
required:
- allocatedIPs
- ranges
- subnet
type: object
status:
description: IPPoolStatus defines the observed state of IPPool
type: object
type: object
version: v1
versions:
- name: v1
served: true
storage: true
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []

3
config/crd/kustomization.yaml
View File

@ -3,6 +3,7 @@
# It should be run by config/default # It should be run by config/default
resources: resources:
- bases/airship.airshipit.org_vinoes.yaml - bases/airship.airshipit.org_vinoes.yaml
- bases/airship.airshipit.org_ippools.yaml
- bases/bmh.yaml - bases/bmh.yaml
# +kubebuilder:scaffold:crdkustomizeresource # +kubebuilder:scaffold:crdkustomizeresource
@ -10,11 +11,13 @@ patchesStrategicMerge:
# [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix. # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix.
# patches here are for enabling the conversion webhook for each CRD # patches here are for enabling the conversion webhook for each CRD
#- patches/webhook_in_vinoes.yaml #- patches/webhook_in_vinoes.yaml
#- patches/webhook_in_ippools.yaml
# +kubebuilder:scaffold:crdkustomizewebhookpatch # +kubebuilder:scaffold:crdkustomizewebhookpatch
# [CERTMANAGER] To enable webhook, uncomment all the sections with [CERTMANAGER] prefix. # [CERTMANAGER] To enable webhook, uncomment all the sections with [CERTMANAGER] prefix.
# patches here are for enabling the CA injection for each CRD # patches here are for enabling the CA injection for each CRD
#- patches/cainjection_in_vinoes.yaml #- patches/cainjection_in_vinoes.yaml
#- patches/cainjection_in_ippools.yaml
# +kubebuilder:scaffold:crdkustomizecainjectionpatch # +kubebuilder:scaffold:crdkustomizecainjectionpatch
# the following config is for teaching kustomize how to do kustomization for CRDs. # the following config is for teaching kustomize how to do kustomization for CRDs.

8
config/crd/patches/cainjection_in_ippools.yaml Normal file
View File

@ -0,0 +1,8 @@
# The following patch adds a directive for certmanager to inject CA into the CRD
# CRD conversion requires k8s 1.13 or later.
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
annotations:
cert-manager.io/inject-ca-from: $(CERTIFICATE_NAMESPACE)/$(CERTIFICATE_NAME)
name: ippools.airship.airshipit.org

17
config/crd/patches/webhook_in_ippools.yaml Normal file
View File

@ -0,0 +1,17 @@
# The following patch enables conversion webhook for CRD
# CRD conversion requires k8s 1.13 or later.
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
name: ippools.airship.airshipit.org
spec:
conversion:
strategy: Webhook
webhookClientConfig:
# this is "\n" used as a placeholder, otherwise it will be rejected by the apiserver for being blank,
# but we're going to set it later using the cert-manager (or potentially a patch if not using cert-manager)
caBundle: Cg==
service:
namespace: system
name: webhook-service
path: /convert

24
config/rbac/ippool_editor_role.yaml Normal file
View File

@ -0,0 +1,24 @@
# permissions for end users to edit ippools.
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
name: ippool-editor-role
rules:
- apiGroups:
- airship.airshipit.org
resources:
- ippools
verbs:
- create
- delete
- get
- list
- patch
- update
- watch
- apiGroups:
- airship.airshipit.org
resources:
- ippools/status
verbs:
- get

20
config/rbac/ippool_viewer_role.yaml Normal file
View File

@ -0,0 +1,20 @@
# permissions for end users to view ippools.
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
name: ippool-viewer-role
rules:
- apiGroups:
- airship.airshipit.org
resources:
- ippools
verbs:
- get
- list
- watch
- apiGroups:
- airship.airshipit.org
resources:
- ippools/status
verbs:
- get

15
config/samples/ippool.yaml Normal file
View File

@ -0,0 +1,15 @@
apiVersion: airship.airshipit.org/v1
kind: IPPool
metadata:
name: ippool-sample
spec:
subnet: 10.0.0.0/16
ranges:
- start: 10.0.0.1
stop: 10.0.0.9
- start: 10.0.1.1
stop: 10.0.1.9
allocatedIPs:
- 10.0.0.1
- 10.0.0.2
- 10.0.1.1

195
docs/api/vino.md
View File

@ -218,6 +218,160 @@ bool
</table> </table>
</div> </div>
</div> </div>
<h3 id="airship.airshipit.org/v1.IPPool">IPPool
</h3>
<p>IPPool is the Schema for the ippools API</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>metadata</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta">
Kubernetes meta/v1.ObjectMeta
</a>
</em>
</td>
<td>
Refer to the Kubernetes API documentation for the fields of the
<code>metadata</code> field.
</td>
</tr>
<tr>
<td>
<code>spec</code><br>
<em>
<a href="#airship.airshipit.org/v1.IPPoolSpec">
IPPoolSpec
</a>
</em>
</td>
<td>
<br/>
<br/>
<table>
<tr>
<td>
<code>subnet</code><br>
<em>
string
</em>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>ranges</code><br>
<em>
<a href="#airship.airshipit.org/v1.Range">
[]Range
</a>
</em>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>allocatedIPs</code><br>
<em>
[]string
</em>
</td>
<td>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
<code>status</code><br>
<em>
<a href="#airship.airshipit.org/v1.IPPoolStatus">
IPPoolStatus
</a>
</em>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="airship.airshipit.org/v1.IPPoolSpec">IPPoolSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#airship.airshipit.org/v1.IPPool">IPPool</a>)
</p>
<p>IPPool tracks allocation ranges and statuses within a specific
subnet IPv4 or IPv6 subnet. It has a set of ranges of IPs
within the subnet from which IPs can be allocated by IPAM,
and a set of IPs that are currently allocated already.</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>subnet</code><br>
<em>
string
</em>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>ranges</code><br>
<em>
<a href="#airship.airshipit.org/v1.Range">
[]Range
</a>
</em>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>allocatedIPs</code><br>
<em>
[]string
</em>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="airship.airshipit.org/v1.IPPoolStatus">IPPoolStatus
</h3>
<p>
(<em>Appears on:</em>
<a href="#airship.airshipit.org/v1.IPPool">IPPool</a>)
</p>
<p>IPPoolStatus defines the observed state of IPPool</p>
<h3 id="airship.airshipit.org/v1.NamespacedName">NamespacedName <h3 id="airship.airshipit.org/v1.NamespacedName">NamespacedName
</h3> </h3>
<p> <p>
@ -549,6 +703,47 @@ DiskDrivesTemplate
</table> </table>
</div> </div>
</div> </div>
<h3 id="airship.airshipit.org/v1.Range">Range
</h3>
<p>
(<em>Appears on:</em>
<a href="#airship.airshipit.org/v1.IPPoolSpec">IPPoolSpec</a>)
</p>
<p>Range has (inclusive) bounds within a subnet from which IPs can be allocated</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>start</code><br>
<em>
string
</em>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>stop</code><br>
<em>
string
</em>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="airship.airshipit.org/v1.VMNodeFlavor">VMNodeFlavor <h3 id="airship.airshipit.org/v1.VMNodeFlavor">VMNodeFlavor
</h3> </h3>
<p> <p>

68
pkg/api/v1/ippool_types.go Normal file
View File

@ -0,0 +1,68 @@
/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package v1
import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
// EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN!
// NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized.
// IPPool tracks allocation ranges and statuses within a specific
// subnet IPv4 or IPv6 subnet. It has a set of ranges of IPs
// within the subnet from which IPs can be allocated by IPAM,
// and a set of IPs that are currently allocated already.
type IPPoolSpec struct {
Subnet string `json:"subnet"`
Ranges []Range `json:"ranges"`
AllocatedIPs []string `json:"allocatedIPs"`
}
// Range has (inclusive) bounds within a subnet from which IPs can be allocated
type Range struct {
Start string `json:"start"`
Stop string `json:"stop"`
}
// IPPoolStatus defines the observed state of IPPool
type IPPoolStatus struct {
// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
// Important: Run "make" to regenerate code after modifying this file
}
// +kubebuilder:object:root=true
// IPPool is the Schema for the ippools API
type IPPool struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec IPPoolSpec `json:"spec,omitempty"`
Status IPPoolStatus `json:"status,omitempty"`
}
// +kubebuilder:object:root=true
// IPPoolList contains a list of IPPool
type IPPoolList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []IPPool `json:"items"`
}
func init() {
SchemeBuilder.Register(&IPPool{}, &IPPoolList{})
}

114
pkg/api/v1/zz_generated.deepcopy.go
View File

@ -91,6 +91,105 @@ func (in *DiskOptions) DeepCopy() *DiskOptions {
return out return out
} }
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *IPPool) DeepCopyInto(out *IPPool) {
*out = *in
out.TypeMeta = in.TypeMeta
in.ObjectMeta.DeepCopyInto(&out.ObjectMeta)
in.Spec.DeepCopyInto(&out.Spec)
out.Status = in.Status
}
// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPPool.
func (in *IPPool) DeepCopy() *IPPool {
if in == nil {
return nil
}
out := new(IPPool)
in.DeepCopyInto(out)
return out
}
// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (in *IPPool) DeepCopyObject() runtime.Object {
if c := in.DeepCopy(); c != nil {
return c
}
return nil
}
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *IPPoolList) DeepCopyInto(out *IPPoolList) {
*out = *in
out.TypeMeta = in.TypeMeta
in.ListMeta.DeepCopyInto(&out.ListMeta)
if in.Items != nil {
in, out := &in.Items, &out.Items
*out = make([]IPPool, len(*in))
for i := range *in {
(*in)[i].DeepCopyInto(&(*out)[i])
}
}
}
// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPPoolList.
func (in *IPPoolList) DeepCopy() *IPPoolList {
if in == nil {
return nil
}
out := new(IPPoolList)
in.DeepCopyInto(out)
return out
}
// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (in *IPPoolList) DeepCopyObject() runtime.Object {
if c := in.DeepCopy(); c != nil {
return c
}
return nil
}
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *IPPoolSpec) DeepCopyInto(out *IPPoolSpec) {
*out = *in
if in.Ranges != nil {
in, out := &in.Ranges, &out.Ranges
*out = make([]Range, len(*in))
copy(*out, *in)
}
if in.AllocatedIPs != nil {
in, out := &in.AllocatedIPs, &out.AllocatedIPs
*out = make([]string, len(*in))
copy(*out, *in)
}
}
// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPPoolSpec.
func (in *IPPoolSpec) DeepCopy() *IPPoolSpec {
if in == nil {
return nil
}
out := new(IPPoolSpec)
in.DeepCopyInto(out)
return out
}
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *IPPoolStatus) DeepCopyInto(out *IPPoolStatus) {
*out = *in
}
// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPPoolStatus.
func (in *IPPoolStatus) DeepCopy() *IPPoolStatus {
if in == nil {
return nil
}
out := new(IPPoolStatus)
in.DeepCopyInto(out)
return out
}
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *NamespacedName) DeepCopyInto(out *NamespacedName) { func (in *NamespacedName) DeepCopyInto(out *NamespacedName) {
*out = *in *out = *in
@ -206,6 +305,21 @@ func (in *NodeSet) DeepCopy() *NodeSet {
return out return out
} }
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *Range) DeepCopyInto(out *Range) {
*out = *in
}
// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Range.
func (in *Range) DeepCopy() *Range {
if in == nil {
return nil
}
out := new(Range)
in.DeepCopyInto(out)
return out
}
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *VMNodeFlavor) DeepCopyInto(out *VMNodeFlavor) { func (in *VMNodeFlavor) DeepCopyInto(out *VMNodeFlavor) {
*out = *in *out = *in

18
pkg/ipam/errors.go
View File

@ -16,6 +16,8 @@ package ipam
import ( import (
"fmt" "fmt"
vinov1 "vino/pkg/api/v1"
) )
// ErrSubnetNotAllocated returned if the subnet is not registered in IPAM // ErrSubnetNotAllocated returned if the subnet is not registered in IPAM
@ -23,23 +25,28 @@ type ErrSubnetNotAllocated struct {
Subnet string Subnet string
} }
// ErrSubnetRangeInvalid returned if a requested subnet's range is not valid
type ErrSubnetRangeInvalid struct {
SubnetRange vinov1.Range
}
// ErrSubnetRangeOverlapsWithExistingRange returned if the subnet's range // ErrSubnetRangeOverlapsWithExistingRange returned if the subnet's range
// overlaps (partially or completely) with an already added range in that subnet // overlaps (partially or completely) with an already added range in that subnet
type ErrSubnetRangeOverlapsWithExistingRange struct { type ErrSubnetRangeOverlapsWithExistingRange struct {
Subnet string Subnet string
SubnetRange Range SubnetRange vinov1.Range
} }
// ErrSubnetRangeNotAllocated returned if the subnet's range is not registered in IPAM // ErrSubnetRangeNotAllocated returned if the subnet's range is not registered in IPAM
type ErrSubnetRangeNotAllocated struct { type ErrSubnetRangeNotAllocated struct {
Subnet string Subnet string
SubnetRange Range SubnetRange vinov1.Range
} }
// ErrSubnetRangeExhausted returned if the subnet's range has no unallocated IPs // ErrSubnetRangeExhausted returned if the subnet's range has no unallocated IPs
type ErrSubnetRangeExhausted struct { type ErrSubnetRangeExhausted struct {
Subnet string Subnet string
SubnetRange Range SubnetRange vinov1.Range
} }
// ErrInvalidIPAddress returned if an IP address string is malformed // ErrInvalidIPAddress returned if an IP address string is malformed
@ -56,6 +63,11 @@ func (e ErrSubnetNotAllocated) Error() string {
return fmt.Sprintf("IPAM subnet %s not allocated", e.Subnet) return fmt.Sprintf("IPAM subnet %s not allocated", e.Subnet)
} }
func (e ErrSubnetRangeInvalid) Error() string {
return fmt.Sprintf("IPAM range [%s,%s] is invalid",
e.SubnetRange.Start, e.SubnetRange.Stop)
}
func (e ErrSubnetRangeOverlapsWithExistingRange) Error() string { func (e ErrSubnetRangeOverlapsWithExistingRange) Error() string {
return fmt.Sprintf("IPAM range [%s,%s] in subnet %s overlaps with an existing range", return fmt.Sprintf("IPAM range [%s,%s] in subnet %s overlaps with an existing range",
e.SubnetRange.Start, e.SubnetRange.Stop, e.Subnet) e.SubnetRange.Start, e.SubnetRange.Stop, e.Subnet)

51
pkg/ipam/ipam.go
View File

@ -19,6 +19,8 @@ import (
"strings" "strings"
"unsafe" "unsafe"
vinov1 "vino/pkg/api/v1"
"github.com/go-logr/logr" "github.com/go-logr/logr"
"k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/runtime"
"sigs.k8s.io/controller-runtime/pkg/client" "sigs.k8s.io/controller-runtime/pkg/client"
@ -30,45 +32,46 @@ type Ipam struct {
Scheme *runtime.Scheme Scheme *runtime.Scheme
Client client.Client Client client.Client
ippools map[string]*IPPool ippools map[string]*vinov1.IPPoolSpec
}
// IPPool tracks allocation ranges and statuses within a specific
// subnet IPv4 or IPv6 subnet. It has a set of ranges of IPs
// within the subnet from which IPs can be allocated by IPAM,
// and a set of IPs that are currently allocated already.
type IPPool struct {
Subnet string
Ranges []Range
AllocatedIPs []string
}
// Range has (inclusive) bounds within a subnet from which IPs can be allocated
type Range struct {
Start string
Stop string
} }
// NewIpam initializes an empty IPAM configuration. // NewIpam initializes an empty IPAM configuration.
// TODO: persist and refresh state from the API server // TODO: persist and refresh state from the API server
// TODO: add ability to remove IP addresses and ranges // TODO: add ability to remove IP addresses and ranges
func NewIpam() *Ipam { func NewIpam() *Ipam {
ippools := make(map[string]*IPPool) ippools := make(map[string]*vinov1.IPPoolSpec)
return &Ipam{ return &Ipam{
ippools: ippools, ippools: ippools,
} }
} }
// Create a new Range, validating its input
func NewRange(start string, stop string) (vinov1.Range, error) {
r := vinov1.Range{Start: start, Stop: stop}
a, e := ipStringToInt(start)
if e != nil {
return vinov1.Range{}, e
}
b, e := ipStringToInt(stop)
if e != nil {
return vinov1.Range{}, e
}
if b < a {
return vinov1.Range{}, ErrSubnetRangeInvalid{r}
}
return r, nil
}
// AddSubnetRange adds a range within a subnet for IP allocation // AddSubnetRange adds a range within a subnet for IP allocation
// TODO error: invalid range for subnet
// TODO error: range overlaps with existing range or subnet overlaps with existing subnet // TODO error: range overlaps with existing range or subnet overlaps with existing subnet
func (i *Ipam) AddSubnetRange(subnet string, subnetRange Range) error { // TODO error: invalid range for subnet
func (i *Ipam) AddSubnetRange(subnet string, subnetRange vinov1.Range) error {
// Does the subnet already exist? (this is fine) // Does the subnet already exist? (this is fine)
ippool, exists := i.ippools[subnet] ippool, exists := i.ippools[subnet]
if !exists { if !exists {
ippool = &IPPool{ ippool = &vinov1.IPPoolSpec{
Subnet: subnet, Subnet: subnet,
Ranges: []Range{subnetRange}, // TODO DeepCopy() Ranges: []vinov1.Range{subnetRange},
AllocatedIPs: []string{}, AllocatedIPs: []string{},
} }
i.ippools[subnet] = ippool i.ippools[subnet] = ippool
@ -91,7 +94,7 @@ func (i *Ipam) AddSubnetRange(subnet string, subnetRange Range) error {
} }
// AllocateIP allocates an IP from a range and return it // AllocateIP allocates an IP from a range and return it
func (i *Ipam) AllocateIP(subnet string, subnetRange Range) (string, error) { func (i *Ipam) AllocateIP(subnet string, subnetRange vinov1.Range) (string, error) {
// NOTE/TODO: this is not threadsafe, which is fine because // NOTE/TODO: this is not threadsafe, which is fine because
// the final impl will use the api server as the backend, not local. // the final impl will use the api server as the backend, not local.
ippool, exists := i.ippools[subnet] ippool, exists := i.ippools[subnet]
@ -122,7 +125,7 @@ func (i *Ipam) AllocateIP(subnet string, subnetRange Range) (string, error) {
// steps through them looking for one that that is not already // steps through them looking for one that that is not already
// in use, converts it back to a string and returns it. // in use, converts it back to a string and returns it.
// It does not itself add it to the list of assigned IPs. // It does not itself add it to the list of assigned IPs.
func findFreeIPInRange(ippool *IPPool, subnetRange Range) (string, error) { func findFreeIPInRange(ippool *vinov1.IPPoolSpec, subnetRange vinov1.Range) (string, error) {
allocatedIPSet := sliceToMap(ippool.AllocatedIPs) allocatedIPSet := sliceToMap(ippool.AllocatedIPs)
intToString := intToIPv4String intToString := intToIPv4String
if strings.Contains(ippool.Subnet, ":") { if strings.Contains(ippool.Subnet, ":") {

111
pkg/ipam/ipam_test.go
View File

@ -18,6 +18,8 @@ import (
"math" "math"
"testing" "testing"
vinov1 "vino/pkg/api/v1"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require" "github.com/stretchr/testify/require"
) )
@ -25,53 +27,53 @@ import (
func TestAllocateIP(t *testing.T) { func TestAllocateIP(t *testing.T) {
tests := []struct { tests := []struct {
name, subnet, expectedErr string name, subnet, expectedErr string
subnetRange Range subnetRange vinov1.Range
}{ }{
{ {
name: "success ipv4", name: "success ipv4",
subnet: "10.0.0.0/16", subnet: "10.0.0.0/16",
subnetRange: Range{"10.0.1.0", "10.0.1.9"}, subnetRange: vinov1.Range{Start: "10.0.1.0", Stop: "10.0.1.9"},
}, },
{ {
name: "success ipv6", name: "success ipv6",
subnet: "2600:1700:b030:0000::/72", subnet: "2600:1700:b030:0000::/72",
subnetRange: Range{"2600:1700:b030:0000::", "2600:1700:b030:0009::"}, subnetRange: vinov1.Range{Start: "2600:1700:b030:0000::", Stop: "2600:1700:b030:0009::"},
}, },
{ {
name: "error subnet not allocated ipv4", name: "error subnet not allocated ipv4",
subnet: "10.0.0.0/20", subnet: "10.0.0.0/20",
subnetRange: Range{"10.0.1.0", "10.0.1.9"}, subnetRange: vinov1.Range{Start: "10.0.1.0", Stop: "10.0.1.9"},
expectedErr: "IPAM subnet 10.0.0.0/20 not allocated", expectedErr: "IPAM subnet 10.0.0.0/20 not allocated",
}, },
{ {
name: "error subnet not allocated ipv6", name: "error subnet not allocated ipv6",
subnet: "2600:1700:b030:0000::/80", subnet: "2600:1700:b030:0000::/80",
subnetRange: Range{"2600:1700:b030:0000::", "2600:1700:b030:0009::"}, subnetRange: vinov1.Range{Start: "2600:1700:b030:0000::", Stop: "2600:1700:b030:0009::"},
expectedErr: "IPAM subnet 2600:1700:b030:0000::/80 not allocated", expectedErr: "IPAM subnet 2600:1700:b030:0000::/80 not allocated",
}, },
{ {
name: "error range not allocated ipv4", name: "error range not allocated ipv4",
subnet: "10.0.0.0/16", subnet: "10.0.0.0/16",
subnetRange: Range{"10.0.2.0", "10.0.2.9"}, subnetRange: vinov1.Range{Start: "10.0.2.0", Stop: "10.0.2.9"},
expectedErr: "IPAM range [10.0.2.0,10.0.2.9] in subnet 10.0.0.0/16 is not allocated", expectedErr: "IPAM range [10.0.2.0,10.0.2.9] in subnet 10.0.0.0/16 is not allocated",
}, },
{ {
name: "error range not allocated ipv6", name: "error range not allocated ipv6",
subnet: "2600:1700:b030:0000::/72", subnet: "2600:1700:b030:0000::/72",
subnetRange: Range{"2600:1700:b030:0000::", "2600:1700:b030:1111::"}, subnetRange: vinov1.Range{Start: "2600:1700:b030:0000::", Stop: "2600:1700:b030:1111::"},
expectedErr: "IPAM range [2600:1700:b030:0000::,2600:1700:b030:1111::] " + expectedErr: "IPAM range [2600:1700:b030:0000::,2600:1700:b030:1111::] " +
"in subnet 2600:1700:b030:0000::/72 is not allocated", "in subnet 2600:1700:b030:0000::/72 is not allocated",
}, },
{ {
name: "error range exhausted ipv4", name: "error range exhausted ipv4",
subnet: "192.168.0.0/1", subnet: "192.168.0.0/1",
subnetRange: Range{"192.168.0.0", "192.168.0.0"}, subnetRange: vinov1.Range{Start: "192.168.0.0", Stop: "192.168.0.0"},
expectedErr: "IPAM range [192.168.0.0,192.168.0.0] in subnet 192.168.0.0/1 is exhausted", expectedErr: "IPAM range [192.168.0.0,192.168.0.0] in subnet 192.168.0.0/1 is exhausted",
}, },
{ {
name: "error range exhausted ipv6", name: "error range exhausted ipv6",
subnet: "2600:1700:b031:0000::/64", subnet: "2600:1700:b031:0000::/64",
subnetRange: Range{"2600:1700:b031:0000::", "2600:1700:b031:0000::"}, subnetRange: vinov1.Range{Start: "2600:1700:b031:0000::", Stop: "2600:1700:b031:0000::"},
expectedErr: "IPAM range [2600:1700:b031:0000::,2600:1700:b031:0000::] " + expectedErr: "IPAM range [2600:1700:b031:0000::,2600:1700:b031:0000::] " +
"in subnet 2600:1700:b031:0000::/64 is exhausted", "in subnet 2600:1700:b031:0000::/64 is exhausted",
}, },
@ -83,17 +85,21 @@ func TestAllocateIP(t *testing.T) {
ipammer := NewIpam() ipammer := NewIpam()
// Pre-populate IPAM with some precondition test data // Pre-populate IPAM with some precondition test data
err := ipammer.AddSubnetRange("10.0.0.0/16", Range{"10.0.1.0", "10.0.1.9"}) err := ipammer.AddSubnetRange("10.0.0.0/16", vinov1.Range{Start: "10.0.1.0", Stop: "10.0.1.9"})
require.NoError(t, err) require.NoError(t, err)
err = ipammer.AddSubnetRange("2600:1700:b030:0000::/72", Range{"2600:1700:b030:0000::", "2600:1700:b030:0009::"}) err = ipammer.AddSubnetRange("2600:1700:b030:0000::/72",
vinov1.Range{Start: "2600:1700:b030:0000::", Stop: "2600:1700:b030:0009::"})
require.NoError(t, err) require.NoError(t, err)
err = ipammer.AddSubnetRange("192.168.0.0/1", Range{"192.168.0.0", "192.168.0.0"}) err = ipammer.AddSubnetRange("192.168.0.0/1",
vinov1.Range{Start: "192.168.0.0", Stop: "192.168.0.0"})
require.NoError(t, err) require.NoError(t, err)
err = ipammer.AddSubnetRange("2600:1700:b031:0000::/64", Range{"2600:1700:b031:0000::", "2600:1700:b031:0000::"}) err = ipammer.AddSubnetRange("2600:1700:b031:0000::/64",
vinov1.Range{Start: "2600:1700:b031:0000::", Stop: "2600:1700:b031:0000::"})
require.NoError(t, err) require.NoError(t, err)
_, err = ipammer.AllocateIP("192.168.0.0/1", Range{"192.168.0.0", "192.168.0.0"}) _, err = ipammer.AllocateIP("192.168.0.0/1", vinov1.Range{Start: "192.168.0.0", Stop: "192.168.0.0"})
require.NoError(t, err) require.NoError(t, err)
_, err = ipammer.AllocateIP("2600:1700:b031:0000::/64", Range{"2600:1700:b031:0000::", "2600:1700:b031:0000::"}) _, err = ipammer.AllocateIP("2600:1700:b031:0000::/64",
vinov1.Range{Start: "2600:1700:b031:0000::", Stop: "2600:1700:b031:0000::"})
require.NoError(t, err) require.NoError(t, err)
ip, err := ipammer.AllocateIP(tt.subnet, tt.subnetRange) ip, err := ipammer.AllocateIP(tt.subnet, tt.subnetRange)
if tt.expectedErr != "" { if tt.expectedErr != "" {
@ -108,22 +114,67 @@ func TestAllocateIP(t *testing.T) {
} }
} }
func TestNewRange(t *testing.T) {
tests := []struct {
name, start, stop, expectedErr string
}{
{
name: "success",
start: "10.0.0.1",
stop: "10.0.0.2",
expectedErr: "",
},
{
name: "error stop less than start",
start: "10.0.0.2",
stop: "10.0.0.1",
expectedErr: "is invalid",
},
{
name: "error bad start",
start: "10.0.0.2.x",
stop: "10.0.0.1",
expectedErr: "is invalid",
},
{
name: "error bad stop",
start: "10.0.0.2",
stop: "10.0.0.1.x",
expectedErr: "is invalid",
},
}
for _, tt := range tests {
tt := tt
t.Run(tt.name, func(t *testing.T) {
r, err := NewRange(tt.start, tt.stop)
if tt.expectedErr != "" {
require.Error(t, err)
assert.Contains(t, err.Error(), tt.expectedErr)
} else {
require.NoError(t, err)
assert.Equal(t, r.Start, tt.start)
assert.Equal(t, r.Stop, tt.stop)
}
})
}
}
// Test some error handling that is not captured by TestAllocateIP // Test some error handling that is not captured by TestAllocateIP
func TestAddSubnetRange(t *testing.T) { func TestAddSubnetRange(t *testing.T) {
tests := []struct { tests := []struct {
name, subnet, expectedErr string name, subnet, expectedErr string
subnetRange Range subnetRange vinov1.Range
}{ }{
{ {
name: "success", name: "success",
subnet: "10.0.0.0/16", subnet: "10.0.0.0/16",
subnetRange: Range{"10.0.2.0", "10.0.2.9"}, subnetRange: vinov1.Range{Start: "10.0.2.0", Stop: "10.0.2.9"},
expectedErr: "", expectedErr: "",
}, },
{ {
name: "error range already exists", name: "error range already exists",
subnet: "10.0.0.0/16", subnet: "10.0.0.0/16",
subnetRange: Range{"10.0.1.0", "10.0.1.9"}, subnetRange: vinov1.Range{Start: "10.0.1.0", Stop: "10.0.1.9"},
expectedErr: "IPAM range [10.0.1.0,10.0.1.9] in subnet 10.0.0.0/16 overlaps", expectedErr: "IPAM range [10.0.1.0,10.0.1.9] in subnet 10.0.0.0/16 overlaps",
}, },
// TODO: check for partially overlapping ranges and subnets // TODO: check for partially overlapping ranges and subnets
@ -135,7 +186,7 @@ func TestAddSubnetRange(t *testing.T) {
ipammer := NewIpam() ipammer := NewIpam()
// Pre-populate IPAM with some precondition test data // Pre-populate IPAM with some precondition test data
err := ipammer.AddSubnetRange("10.0.0.0/16", Range{"10.0.1.0", "10.0.1.9"}) err := ipammer.AddSubnetRange("10.0.0.0/16", vinov1.Range{Start: "10.0.1.0", Stop: "10.0.1.9"})
require.NoError(t, err) require.NoError(t, err)
err = ipammer.AddSubnetRange(tt.subnet, tt.subnetRange) err = ipammer.AddSubnetRange(tt.subnet, tt.subnetRange)
if tt.expectedErr != "" { if tt.expectedErr != "" {
@ -151,33 +202,33 @@ func TestFindFreeIPInRange(t *testing.T) {
tests := []struct { tests := []struct {
name string name string
subnet string subnet string
subnetRange Range subnetRange vinov1.Range
out string out string
expectedErr string expectedErr string
}{ }{
{ {
name: "ip available IPv4", name: "ip available IPv4",
subnet: "10.0.0.0/16", subnet: "10.0.0.0/16",
subnetRange: Range{"10.0.1.0", "10.0.1.10"}, subnetRange: vinov1.Range{Start: "10.0.1.0", Stop: "10.0.1.10"},
out: "10.0.1.0", out: "10.0.1.0",
}, },
{ {
name: "ip unavailable IPv4", name: "ip unavailable IPv4",
subnet: "10.0.0.0/16", subnet: "10.0.0.0/16",
subnetRange: Range{"10.0.2.0", "10.0.2.0"}, subnetRange: vinov1.Range{Start: "10.0.2.0", Stop: "10.0.2.0"},
out: "", out: "",
expectedErr: "IPAM range [10.0.2.0,10.0.2.0] in subnet 10.0.0.0/16 is exhausted", expectedErr: "IPAM range [10.0.2.0,10.0.2.0] in subnet 10.0.0.0/16 is exhausted",
}, },
{ {
name: "ip available IPv6", name: "ip available IPv6",
subnet: "2600:1700:b030:0000::/64", subnet: "2600:1700:b030:0000::/64",
subnetRange: Range{"2600:1700:b030:1001::", "2600:1700:b030:1009::"}, subnetRange: vinov1.Range{Start: "2600:1700:b030:1001::", Stop: "2600:1700:b030:1009::"},
out: "2600:1700:b030:1001::", out: "2600:1700:b030:1001::",
}, },
{ {
name: "ip unavailable IPv6", name: "ip unavailable IPv6",
subnet: "2600:1700:b031::/64", subnet: "2600:1700:b031::/64",
subnetRange: Range{"2600:1700:b031::", "2600:1700:b031::"}, subnetRange: vinov1.Range{Start: "2600:1700:b031::", Stop: "2600:1700:b031::"},
expectedErr: "IPAM range [2600:1700:b031::,2600:1700:b031::] " + expectedErr: "IPAM range [2600:1700:b031::,2600:1700:b031::] " +
"in subnet 2600:1700:b031::/64 is exhausted", "in subnet 2600:1700:b031::/64 is exhausted",
}, },
@ -186,14 +237,14 @@ func TestFindFreeIPInRange(t *testing.T) {
for _, tt := range tests { for _, tt := range tests {
tt := tt tt := tt
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
ippool := IPPool{ ippool := vinov1.IPPoolSpec{
Subnet: tt.subnet, Subnet: tt.subnet,
// One available and one unavailable range each for ipv4/6 // One available and one unavailable range each for ipv4/6
Ranges: []Range{ Ranges: []vinov1.Range{
{"10.0.1.0", "10.0.1.10"}, {Start: "10.0.1.0", Stop: "10.0.1.10"},
{"10.0.2.0", "10.0.2.0"}, {Start: "10.0.2.0", Stop: "10.0.2.0"},
{"2600:1700:b030:1001::", "2600:1700:b030:1009::"}, {Start: "2600:1700:b030:1001::", Stop: "2600:1700:b030:1009::"},
{"2600:1700:b031::", "2600:1700:b031::"}, {Start: "2600:1700:b031::", Stop: "2600:1700:b031::"},
}, },
AllocatedIPs: []string{"10.0.2.0", "2600:1700:b031::"}, AllocatedIPs: []string{"10.0.2.0", "2600:1700:b031::"},
} }

1
tools/deployment/test-cr.sh
View File

@ -13,6 +13,7 @@ function vinoDebugInfo () {
} }
kubectl apply -f config/samples/vino_cr.yaml kubectl apply -f config/samples/vino_cr.yaml
kubectl apply -f config/samples/ippool.yaml
# Remove logs collection from here, when we will have zuul collect logs job # Remove logs collection from here, when we will have zuul collect logs job
until [[ $(kubectl get vino vino-test-cr 2>/dev/null) ]]; do until [[ $(kubectl get vino vino-test-cr 2>/dev/null) ]]; do