aboutsummaryrefslogtreecommitdiffstats
path: root/src/ncm/pkg/module/chaining.go
blob: 45f061fa1d4570b23b06ae29a102136d2be10e10 (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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/*
 * 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 (
	"github.com/onap/multicloud-k8s/src/orchestrator/pkg/infra/db"

	pkgerrors "github.com/pkg/errors"
)

// Chain defines the high level structure of a network chain document
type Chain struct {
	Metadata Metadata            `json:"metadata" yaml:"metadata"`
	Spec     NetworkChainingSpec `json:"spec" yaml:"spec"`
}

// NetworkChainingSpec contains the specification of a network chain
type NetworkChainingSpec struct {
	ChainType   string    `json:"type"`
	RoutingSpec RouteSpec `json:"routingSpec"`
}

// RouteSpec contains the routing specificaiton of a network chain
type RouteSpec struct {
	LeftNetwork  []RoutingNetwork `json:"leftNetwork"`
	RightNetwork []RoutingNetwork `json:"rightNetwork"`
	NetworkChain string           `json:"networkChain"`
	Namespace    string           `json:"namespace"`
}

// RoutingNetwork contains the route networkroute network details for en element of a network chain
type RoutingNetwork struct {
	NetworkName string `json:"networkName"`
	GatewayIP   string `json:"gatewayIp"`
	Subnet      string `json:"subnet"`
}

// ChainKey is the key structure that is used in the database
type ChainKey struct {
	Project             string `json:"project"`
	CompositeApp        string `json:"compositeapp"`
	CompositeAppVersion string `json:"compositeappversion"`
	NetControlIntent    string `json:"netcontrolintent"`
	NetworkChain        string `json:"networkchain"`
}

// CrChain is the structure for the Network Chain Custom Resource
type CrChain struct {
	APIVersion string `yaml:"apiVersion"`
	Kind       string `yaml:"kind"`
	Chain      Chain
}

// RoutingChainType is currently only defined chaining type
const RoutingChainType = "routing"

// ChainingAPIVersion is the kubernetes version of a network chain custom resource
const ChainingAPIVersion = "k8s.plugin.opnfv.org/v1"

// ChainingKind is the Kind string for a network chain
const ChainingKind = "NetworkChaining"

// ChainManager is an interface exposing the Chain functionality
type ChainManager interface {
	CreateChain(ch Chain, pr, ca, caver, netctrlint string, exists bool) (Chain, error)
	GetChain(name, pr, ca, caver, netctrlint string) (Chain, error)
	GetChains(pr, ca, caver, netctrlint string) ([]Chain, error)
	DeleteChain(name, pr, ca, caver, netctrlint string) error
}

// ChainClient implements the Manager
// It will also be used to maintain some localized state
type ChainClient struct {
	db ClientDbInfo
}

// NewChainClient returns an instance of the ChainClient
// which implements the Manager
func NewChainClient() *ChainClient {
	return &ChainClient{
		db: ClientDbInfo{
			storeName: "orchestrator",
			tagMeta:   "chainmetadata",
		},
	}
}

// CreateChain - create a new Chain
func (v *ChainClient) CreateChain(ch Chain, pr, ca, caver, netctrlint string, exists bool) (Chain, error) {
	//Construct key and tag to select the entry
	key := ChainKey{
		Project:             pr,
		CompositeApp:        ca,
		CompositeAppVersion: caver,
		NetControlIntent:    netctrlint,
		NetworkChain:        ch.Metadata.Name,
	}

	//Check if the Network Control Intent exists
	_, err := NewNetControlIntentClient().GetNetControlIntent(netctrlint, pr, ca, caver)
	if err != nil {
		return Chain{}, pkgerrors.Errorf("Network Control Intent %v does not exist", netctrlint)
	}

	//Check if this Chain already exists
	_, err = v.GetChain(ch.Metadata.Name, pr, ca, caver, netctrlint)
	if err == nil && !exists {
		return Chain{}, pkgerrors.New("Chain already exists")
	}

	err = db.DBconn.Insert(v.db.storeName, key, nil, v.db.tagMeta, ch)
	if err != nil {
		return Chain{}, pkgerrors.Wrap(err, "Creating DB Entry")
	}

	return ch, nil
}

// GetChain returns the Chain for corresponding name
func (v *ChainClient) GetChain(name, pr, ca, caver, netctrlint string) (Chain, error) {
	//Construct key and tag to select the entry
	key := ChainKey{
		Project:             pr,
		CompositeApp:        ca,
		CompositeAppVersion: caver,
		NetControlIntent:    netctrlint,
		NetworkChain:        name,
	}

	value, err := db.DBconn.Find(v.db.storeName, key, v.db.tagMeta)
	if err != nil {
		return Chain{}, pkgerrors.Wrap(err, "Get Chain")
	}

	//value is a byte array
	if value != nil {
		ch := Chain{}
		err = db.DBconn.Unmarshal(value[0], &ch)
		if err != nil {
			return Chain{}, pkgerrors.Wrap(err, "Unmarshalling Value")
		}
		return ch, nil
	}

	return Chain{}, pkgerrors.New("Error getting Chain")
}

// GetChains returns all of the Chains for for the given network control intent
func (v *ChainClient) GetChains(pr, ca, caver, netctrlint string) ([]Chain, error) {
	//Construct key and tag to select the entry
	key := ChainKey{
		Project:             pr,
		CompositeApp:        ca,
		CompositeAppVersion: caver,
		NetControlIntent:    netctrlint,
		NetworkChain:        "",
	}

	var resp []Chain
	values, err := db.DBconn.Find(v.db.storeName, key, v.db.tagMeta)
	if err != nil {
		return []Chain{}, pkgerrors.Wrap(err, "Get Chains")
	}

	for _, value := range values {
		cp := Chain{}
		err = db.DBconn.Unmarshal(value, &cp)
		if err != nil {
			return []Chain{}, pkgerrors.Wrap(err, "Unmarshalling Value")
		}
		resp = append(resp, cp)
	}

	return resp, nil
}

// DeleteChain deletes the Chain from the database
func (v *ChainClient) DeleteChain(name, pr, ca, caver, netctrlint string) error {

	//Construct key and tag to select the entry
	key := ChainKey{
		Project:             pr,
		CompositeApp:        ca,
		CompositeAppVersion: caver,
		NetControlIntent:    netctrlint,
		NetworkChain:        name,
	}

	err := db.DBconn.Remove(v.db.storeName, key)
	if err != nil {
		return pkgerrors.Wrap(err, "Delete Chain Entry;")
	}

	return nil
}