summaryrefslogtreecommitdiffstats
path: root/src/ncm/pkg/module/module_definitions.go
blob: 729a9dbd996ce69bf4d016663f8366c9036b19ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
/*
 * Copyright 2020 Intel Corporation, Inc
 *
 * 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 module

import (
	"strings"

	"github.com/onap/multicloud-k8s/src/orchestrator/pkg/infra/validation"
	pkgerrors "github.com/pkg/errors"
)

const VLAN_PROVIDER_NET_TYPE_VLAN string = "VLAN"
const VLAN_PROVIDER_NET_TYPE_DIRECT string = "DIRECT"

var PROVIDER_NET_TYPES = [...]string{VLAN_PROVIDER_NET_TYPE_VLAN, VLAN_PROVIDER_NET_TYPE_DIRECT}

const CNI_TYPE_OVN4NFV string = "ovn4nfv"

var CNI_TYPES = [...]string{CNI_TYPE_OVN4NFV}

// It implements the interface for managing the ClusterProviders
const MAX_DESCRIPTION_LEN int = 1024
const MAX_USERDATA_LEN int = 4096

type Metadata struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	UserData1   string `json:"userData1"`
	UserData2   string `json:"userData2"`
}

type ClientDbInfo struct {
	storeName  string // name of the mongodb collection to use for client documents
	tagMeta    string // attribute key name for the json data of a client document
	tagContent string // attribute key name for the file data of a client document
}

type Ipv4Subnet struct {
	Subnet  string `json:"subnet"` // CIDR notation, e.g. 172.16.33.0/24
	Name    string `json:"name"`
	Gateway string `json:"gateway"`    // IPv4 addre, e.g. 172.16.33.1/24
	Exclude string `json:"excludeIps"` // space separated list of single IPs or ranges e.g. "172.16.33.2 172.16.33.5..172.16.33.10"
}

const VLAN_NODE_ANY = "any"
const VLAN_NODE_SPECIFIC = "specific"

var VLAN_NODE_SELECTORS = [...]string{VLAN_NODE_ANY, VLAN_NODE_SPECIFIC}

type Vlan struct {
	VlanId                int      `json:"vlanID"`
	ProviderInterfaceName string   `json:"providerInterfaceName"`
	LogicalInterfaceName  string   `json:"logicalInterfaceName"`
	VlanNodeSelector      string   `json:"vlanNodeSelector"`
	NodeLabelList         []string `json:"nodeLabelList"`
}

// Check for valid format Metadata
func IsValidMetadata(metadata Metadata) error {
	errs := validation.IsValidName(metadata.Name)
	if len(errs) > 0 {
		return pkgerrors.Errorf("Invalid Metadata name=[%v], errors: %v", metadata.Name, errs)
	}

	errs = validation.IsValidString(metadata.Description, 0, MAX_DESCRIPTION_LEN, validation.VALID_ANY_STR)
	if len(errs) > 0 {
		return pkgerrors.Errorf("Invalid Metadata description=[%v], errors: %v", metadata.Description, errs)
	}

	errs = validation.IsValidString(metadata.UserData1, 0, MAX_DESCRIPTION_LEN, validation.VALID_ANY_STR)
	if len(errs) > 0 {
		return pkgerrors.Errorf("Invalid Metadata description=[%v], errors: %v", metadata.UserData1, errs)
	}

	errs = validation.IsValidString(metadata.UserData2, 0, MAX_DESCRIPTION_LEN, validation.VALID_ANY_STR)
	if len(errs) > 0 {
		return pkgerrors.Errorf("Invalid Metadata description=[%v], errors: %v", metadata.UserData2, errs)
	}

	return nil
}

// Check for valid format of an Ipv4Subnet
func ValidateSubnet(sub Ipv4Subnet) error {
	// verify subnet is in valid cidr format
	err := validation.IsIpv4Cidr(sub.Subnet)
	if err != nil {
		return pkgerrors.Wrap(err, "invalid subnet")
	}

	// just a size check on interface name - system dependent
	errs := validation.IsValidName(sub.Name)
	if len(errs) > 0 {
		return pkgerrors.Errorf("Invalid subnet name=[%v], errors: %v", sub.Name, errs)
	}

	// verify gateway is in valid cidr format
	if len(sub.Gateway) > 0 {
		err = validation.IsIpv4Cidr(sub.Gateway)
		if err != nil {
			return pkgerrors.Wrap(err, "invalid gateway")
		}
	}

	// verify excludeIps is composed of space separated ipv4 addresses and
	// ipv4 address ranges separated by '..'
	for _, value := range strings.Fields(sub.Exclude) {
		for _, ip := range strings.SplitN(value, "..", 2) {
			err = validation.IsIpv4(ip)
			if err != nil {
				return pkgerrors.Errorf("invalid ipv4 exclude list %v", sub.Exclude)
			}
		}
	}
	return nil
}