Reorganize ncm packages to align with architecture

Reorginize the ncm packges to delineate
- cluster provider and cluster management
- virtual and provider netowrk intent management
- intent scheduler
- internal ovn4k8s network controller

Overall, no code changes, just moving things around.

Issue-ID: MULTICLOUD-1029
Signed-off-by: Eric Multanen <eric.w.multanen@intel.com>
Change-Id: I3d43c7e4eb6f285b51c0385ba18626d3511a14f5

3 files changed, 460 insertions, 0 deletions

diff --git a/src/ncm/pkg/networkintents/network.go b/src/ncm/pkg/networkintents/network.go
new file mode 100644
index 00000000..e8480e0f
--- /dev/null
+++ b/src/ncm/pkg/networkintents/network.go
@@ -0,0 +1,184 @@
+/*
+ * 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 networkintents
+
+import (
+	clusterPkg "github.com/onap/multicloud-k8s/src/ncm/pkg/cluster"
+	ncmtypes "github.com/onap/multicloud-k8s/src/ncm/pkg/module/types"
+	nettypes "github.com/onap/multicloud-k8s/src/ncm/pkg/networkintents/types"
+	"github.com/onap/multicloud-k8s/src/orchestrator/pkg/infra/db"
+	mtypes "github.com/onap/multicloud-k8s/src/orchestrator/pkg/module/types"
+
+	pkgerrors "github.com/pkg/errors"
+)
+
+// Network contains the parameters needed for dynamic networks
+type Network struct {
+	Metadata mtypes.Metadata `json:"metadata" yaml:"metadata"`
+	Spec     NetworkSpec     `json:"spec" yaml:"spec"`
+}
+
+type NetworkSpec struct {
+	CniType     string                `json:"cniType" yaml:"cniType"`
+	Ipv4Subnets []nettypes.Ipv4Subnet `json:"ipv4Subnets" yaml:"ipv4Subnets"`
+}
+
+// NetworkKey is the key structure that is used in the database
+type NetworkKey struct {
+	ClusterProviderName string `json:"provider"`
+	ClusterName         string `json:"cluster"`
+	NetworkName         string `json:"network"`
+}
+
+// structure for the Network Custom Resource
+type CrNetwork struct {
+	ApiVersion string  `yaml:"apiVersion"`
+	Kind       string  `yaml:"kind"`
+	Network    Network `yaml:",inline"`
+}
+
+const NETWORK_APIVERSION = "k8s.plugin.opnfv.org/v1alpha1"
+const NETWORK_KIND = "Network"
+
+// Manager is an interface exposing the Network functionality
+type NetworkManager interface {
+	CreateNetwork(pr Network, clusterProvider, cluster string, exists bool) (Network, error)
+	GetNetwork(name, clusterProvider, cluster string) (Network, error)
+	GetNetworks(clusterProvider, cluster string) ([]Network, error)
+	DeleteNetwork(name, clusterProvider, cluster string) error
+}
+
+// NetworkClient implements the Manager
+// It will also be used to maintain some localized state
+type NetworkClient struct {
+	db ncmtypes.ClientDbInfo
+}
+
+// NewNetworkClient returns an instance of the NetworkClient
+// which implements the Manager
+func NewNetworkClient() *NetworkClient {
+	return &NetworkClient{
+		db: ncmtypes.ClientDbInfo{
+			StoreName: "cluster",
+			TagMeta:   "networkmetadata",
+		},
+	}
+}
+
+// CreateNetwork - create a new Network
+func (v *NetworkClient) CreateNetwork(p Network, clusterProvider, cluster string, exists bool) (Network, error) {
+
+	//Construct key and tag to select the entry
+	key := NetworkKey{
+		ClusterProviderName: clusterProvider,
+		ClusterName:         cluster,
+		NetworkName:         p.Metadata.Name,
+	}
+
+	//Check if cluster exists
+	_, err := clusterPkg.NewClusterClient().GetCluster(clusterProvider, cluster)
+	if err != nil {
+		return Network{}, pkgerrors.New("Unable to find the cluster")
+	}
+
+	//Check if this Network already exists
+	_, err = v.GetNetwork(p.Metadata.Name, clusterProvider, cluster)
+	if err == nil && !exists {
+		return Network{}, pkgerrors.New("Network already exists")
+	}
+
+	err = db.DBconn.Insert(v.db.StoreName, key, nil, v.db.TagMeta, p)
+	if err != nil {
+		return Network{}, pkgerrors.Wrap(err, "Creating DB Entry")
+	}
+
+	return p, nil
+}
+
+// GetNetwork returns the Network for corresponding name
+func (v *NetworkClient) GetNetwork(name, clusterProvider, cluster string) (Network, error) {
+
+	//Construct key and tag to select the entry
+	key := NetworkKey{
+		ClusterProviderName: clusterProvider,
+		ClusterName:         cluster,
+		NetworkName:         name,
+	}
+
+	value, err := db.DBconn.Find(v.db.StoreName, key, v.db.TagMeta)
+	if err != nil {
+		return Network{}, pkgerrors.Wrap(err, "Get Network")
+	}
+
+	//value is a byte array
+	if value != nil {
+		cp := Network{}
+		err = db.DBconn.Unmarshal(value[0], &cp)
+		if err != nil {
+			return Network{}, pkgerrors.Wrap(err, "Unmarshalling Value")
+		}
+		return cp, nil
+	}
+
+	return Network{}, pkgerrors.New("Error getting Network")
+}
+
+// GetNetworkList returns all of the Network for corresponding name
+func (v *NetworkClient) GetNetworks(clusterProvider, cluster string) ([]Network, error) {
+
+	//Construct key and tag to select the entry
+	key := NetworkKey{
+		ClusterProviderName: clusterProvider,
+		ClusterName:         cluster,
+		NetworkName:         "",
+	}
+
+	var resp []Network
+	values, err := db.DBconn.Find(v.db.StoreName, key, v.db.TagMeta)
+	if err != nil {
+		return []Network{}, pkgerrors.Wrap(err, "Get Networks")
+	}
+
+	for _, value := range values {
+		cp := Network{}
+		err = db.DBconn.Unmarshal(value, &cp)
+		if err != nil {
+			return []Network{}, pkgerrors.Wrap(err, "Unmarshalling Value")
+		}
+		resp = append(resp, cp)
+	}
+
+	return resp, nil
+}
+
+// Delete the  Network from database
+func (v *NetworkClient) DeleteNetwork(name, clusterProvider, cluster string) error {
+
+	//Construct key and tag to select the entry
+	key := NetworkKey{
+		ClusterProviderName: clusterProvider,
+		ClusterName:         cluster,
+		NetworkName:         name,
+	}
+
+	err := db.DBconn.Remove(v.db.StoreName, key)
+	if err != nil {
+		return pkgerrors.Wrap(err, "Delete Network Entry;")
+	}
+
+	return nil
+}
diff --git a/src/ncm/pkg/networkintents/providernet.go b/src/ncm/pkg/networkintents/providernet.go
new file mode 100644
index 00000000..0eb763c1
--- /dev/null
+++ b/src/ncm/pkg/networkintents/providernet.go
@@ -0,0 +1,186 @@
+/*
+ * 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 networkintents
+
+import (
+	clusterPkg "github.com/onap/multicloud-k8s/src/ncm/pkg/cluster"
+	ncmtypes "github.com/onap/multicloud-k8s/src/ncm/pkg/module/types"
+	nettypes "github.com/onap/multicloud-k8s/src/ncm/pkg/networkintents/types"
+	"github.com/onap/multicloud-k8s/src/orchestrator/pkg/infra/db"
+	mtypes "github.com/onap/multicloud-k8s/src/orchestrator/pkg/module/types"
+
+	pkgerrors "github.com/pkg/errors"
+)
+
+// ProviderNet contains the parameters needed for dynamic networks
+type ProviderNet struct {
+	Metadata mtypes.Metadata `json:"metadata"`
+	Spec     ProviderNetSpec `json:"spec"`
+}
+
+type ProviderNetSpec struct {
+	CniType         string                `json:"cniType" yaml:"cniType"`
+	Ipv4Subnets     []nettypes.Ipv4Subnet `json:"ipv4Subnets" yaml:"ipv4Subnets"`
+	ProviderNetType string                `json:"providerNetType" yaml:"providerNetType"`
+	Vlan            nettypes.Vlan         `json:"vlan" yaml:"vlan"`
+}
+
+// structure for the Network Custom Resource
+type CrProviderNet struct {
+	ApiVersion  string      `yaml:"apiVersion"`
+	Kind        string      `yaml:"kind"`
+	ProviderNet ProviderNet `yaml:",inline"`
+}
+
+const PROVIDER_NETWORK_APIVERSION = "k8s.plugin.opnfv.org/v1alpha1"
+const PROVIDER_NETWORK_KIND = "ProviderNetwork"
+
+// ProviderNetKey is the key structure that is used in the database
+type ProviderNetKey struct {
+	ClusterProviderName string `json:"provider"`
+	ClusterName         string `json:"cluster"`
+	ProviderNetName     string `json:"providernet"`
+}
+
+// Manager is an interface exposing the ProviderNet functionality
+type ProviderNetManager interface {
+	CreateProviderNet(pr ProviderNet, clusterProvider, cluster string, exists bool) (ProviderNet, error)
+	GetProviderNet(name, clusterProvider, cluster string) (ProviderNet, error)
+	GetProviderNets(clusterProvider, cluster string) ([]ProviderNet, error)
+	DeleteProviderNet(name, clusterProvider, cluster string) error
+}
+
+// ProviderNetClient implements the Manager
+// It will also be used to maintain some localized state
+type ProviderNetClient struct {
+	db ncmtypes.ClientDbInfo
+}
+
+// NewProviderNetClient returns an instance of the ProviderNetClient
+// which implements the Manager
+func NewProviderNetClient() *ProviderNetClient {
+	return &ProviderNetClient{
+		db: ncmtypes.ClientDbInfo{
+			StoreName: "cluster",
+			TagMeta:   "networkmetadata",
+		},
+	}
+}
+
+// CreateProviderNet - create a new ProviderNet
+func (v *ProviderNetClient) CreateProviderNet(p ProviderNet, clusterProvider, cluster string, exists bool) (ProviderNet, error) {
+
+	//Construct key and tag to select the entry
+	key := ProviderNetKey{
+		ClusterProviderName: clusterProvider,
+		ClusterName:         cluster,
+		ProviderNetName:     p.Metadata.Name,
+	}
+
+	//Check if cluster exists
+	_, err := clusterPkg.NewClusterClient().GetCluster(clusterProvider, cluster)
+	if err != nil {
+		return ProviderNet{}, pkgerrors.New("Unable to find the cluster")
+	}
+
+	//Check if this ProviderNet already exists
+	_, err = v.GetProviderNet(p.Metadata.Name, clusterProvider, cluster)
+	if err == nil && !exists {
+		return ProviderNet{}, pkgerrors.New("ProviderNet already exists")
+	}
+
+	err = db.DBconn.Insert(v.db.StoreName, key, nil, v.db.TagMeta, p)
+	if err != nil {
+		return ProviderNet{}, pkgerrors.Wrap(err, "Creating DB Entry")
+	}
+
+	return p, nil
+}
+
+// GetProviderNet returns the ProviderNet for corresponding name
+func (v *ProviderNetClient) GetProviderNet(name, clusterProvider, cluster string) (ProviderNet, error) {
+
+	//Construct key and tag to select the entry
+	key := ProviderNetKey{
+		ClusterProviderName: clusterProvider,
+		ClusterName:         cluster,
+		ProviderNetName:     name,
+	}
+
+	value, err := db.DBconn.Find(v.db.StoreName, key, v.db.TagMeta)
+	if err != nil {
+		return ProviderNet{}, pkgerrors.Wrap(err, "Get ProviderNet")
+	}
+
+	//value is a byte array
+	if value != nil {
+		cp := ProviderNet{}
+		err = db.DBconn.Unmarshal(value[0], &cp)
+		if err != nil {
+			return ProviderNet{}, pkgerrors.Wrap(err, "Unmarshalling Value")
+		}
+		return cp, nil
+	}
+
+	return ProviderNet{}, pkgerrors.New("Error getting ProviderNet")
+}
+
+// GetProviderNetList returns all of the ProviderNet for corresponding name
+func (v *ProviderNetClient) GetProviderNets(clusterProvider, cluster string) ([]ProviderNet, error) {
+
+	//Construct key and tag to select the entry
+	key := ProviderNetKey{
+		ClusterProviderName: clusterProvider,
+		ClusterName:         cluster,
+		ProviderNetName:     "",
+	}
+
+	var resp []ProviderNet
+	values, err := db.DBconn.Find(v.db.StoreName, key, v.db.TagMeta)
+	if err != nil {
+		return []ProviderNet{}, pkgerrors.Wrap(err, "Get ProviderNets")
+	}
+
+	for _, value := range values {
+		cp := ProviderNet{}
+		err = db.DBconn.Unmarshal(value, &cp)
+		if err != nil {
+			return []ProviderNet{}, pkgerrors.Wrap(err, "Unmarshalling Value")
+		}
+		resp = append(resp, cp)
+	}
+
+	return resp, nil
+}
+
+// Delete the  ProviderNet from database
+func (v *ProviderNetClient) DeleteProviderNet(name, clusterProvider, cluster string) error {
+
+	//Construct key and tag to select the entry
+	key := ProviderNetKey{
+		ClusterProviderName: clusterProvider,
+		ClusterName:         cluster,
+		ProviderNetName:     name,
+	}
+
+	err := db.DBconn.Remove(v.db.StoreName, key)
+	if err != nil {
+		return pkgerrors.Wrap(err, "Delete ProviderNet Entry;")
+	}
+
+	return nil
+}
diff --git a/src/ncm/pkg/networkintents/types/types.go b/src/ncm/pkg/networkintents/types/types.go
new file mode 100644
index 00000000..e6fea72e
--- /dev/null
+++ b/src/ncm/pkg/networkintents/types/types.go
@@ -0,0 +1,90 @@
+/*
+ * 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 types
+
+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"
+
+const SEPARATOR = "+"
+const CONTEXT_CLUSTER_APP = "network-intents"
+
+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}
+
+type Ipv4Subnet struct {
+	Subnet  string `json:"subnet" yaml:"subnet"` // CIDR notation, e.g. 172.16.33.0/24
+	Name    string `json:"name" yaml:"name"`
+	Gateway string `json:"gateway" yaml:"gateway"`       // IPv4 addre, e.g. 172.16.33.1/24
+	Exclude string `json:"excludeIps" yaml:"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                string   `json:"vlanID" yaml:"vlanId"`
+	ProviderInterfaceName string   `json:"providerInterfaceName" yaml:"providerInterfaceName"`
+	LogicalInterfaceName  string   `json:"logicalInterfaceName" yaml:"logicalInterfaceName"`
+	VlanNodeSelector      string   `json:"vlanNodeSelector" yaml:"vlanNodeSelector"`
+	NodeLabelList         []string `json:"nodeLabelList" yaml:"nodeLabelList"`
+}
+
+// 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
+}