5 # Licensed under the Apache License, Version 2.0 (the "License"); you may
6 # not use this file except in compliance with the License. You may obtain
7 # a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 # License for the specific language governing permissions and limitations
20 from osm_ro_plugin
.sdnconn
import SdnConnectorError
21 from osm_rosdn_juniper_contrail
.rest_lib
import ContrailHttp
22 from osm_rosdn_juniper_contrail
.rest_lib
import NotFound
24 # from osm_rosdn_juniper_contrail.rest_lib import DuplicateFound
25 # from osm_rosdn_juniper_contrail.rest_lib import HttpException
29 """ Class with CRUD operations for the underlay API """
31 def __init__(self
, url
, config
=None, user
=None, password
=None, logger
=None):
32 self
.logger
= logger
or logging
.getLogger("ro.sdn.junipercontrail.sdnapi")
33 self
.controller_url
= url
36 raise SdnConnectorError("'url' must be provided")
38 if not url
.startswith("http"):
41 if not url
.endswith("/"):
52 self
.auth_url
= config
.get("auth_url")
53 self
.project
= config
.get("project")
54 self
.domain
= config
.get("domain")
55 self
.asn
= config
.get("asn")
56 self
.fabric
= config
.get("fabric")
58 # Init http headers for all requests
59 self
.http_header
= {"Content-Type": "application/json"}
65 self
.password
= password
68 "Config parameters for the underlay controller: auth_url: {}, project: {},"
69 " domain: {}, user: {}, password: {}".format(
70 self
.auth_url
, self
.project
, self
.domain
, self
.user
, self
.password
75 auth_dict
["auth"] = {}
76 auth_dict
["auth"]["scope"] = {}
77 auth_dict
["auth"]["scope"]["project"] = {}
78 auth_dict
["auth"]["scope"]["project"]["domain"] = {}
79 auth_dict
["auth"]["scope"]["project"]["domain"]["id"] = self
.domain
80 auth_dict
["auth"]["scope"]["project"]["name"] = self
.project
81 auth_dict
["auth"]["identity"] = {}
82 auth_dict
["auth"]["identity"]["methods"] = ["password"]
83 auth_dict
["auth"]["identity"]["password"] = {}
84 auth_dict
["auth"]["identity"]["password"]["user"] = {}
85 auth_dict
["auth"]["identity"]["password"]["user"]["name"] = self
.user
86 auth_dict
["auth"]["identity"]["password"]["user"]["password"] = self
.password
87 auth_dict
["auth"]["identity"]["password"]["user"]["domain"] = {}
88 auth_dict
["auth"]["identity"]["password"]["user"]["domain"]["id"] = self
.domain
89 self
.auth_dict
= auth_dict
92 auth_info
= {"auth_url": self
.auth_url
, "auth_dict": auth_dict
}
93 self
.http
= ContrailHttp(auth_info
, self
.logger
)
96 response
= self
.http
.get_cmd(url
=self
.auth_url
, headers
=self
.http_header
)
100 # Helper methods for CRUD operations
101 def get_all_by_type(self
, controller_url
, type):
102 endpoint
= controller_url
+ type
103 response
= self
.http
.get_cmd(url
=endpoint
, headers
=self
.http_header
)
105 return response
.get(type)
107 def get_by_uuid(self
, type, uuid
):
109 endpoint
= self
.controller_url
+ type + "/{}".format(uuid
)
110 response
= self
.http
.get_cmd(url
=endpoint
, headers
=self
.http_header
)
112 return response
.get(type)
116 def delete_by_uuid(self
, controller_url
, type, uuid
):
117 endpoint
= controller_url
+ type + "/{}".format(uuid
)
118 self
.http
.delete_cmd(url
=endpoint
, headers
=self
.http_header
)
120 def get_uuid_from_fqname(self
, type, fq_name
):
122 Obtain uuid from fqname
123 Returns: If resource not found returns None
124 In case of error raises an Exception
126 payload
= {"type": type, "fq_name": fq_name
}
129 endpoint
= self
.controller_url
+ "fqname-to-id"
130 resp
= self
.http
.post_cmd(
131 url
=endpoint
, headers
=self
.http_header
, post_fields_dict
=payload
134 return json
.loads(resp
).get("uuid")
138 def get_by_fq_name(self
, type, fq_name
):
139 # Obtain uuid by fqdn and then get data by uuid
140 uuid
= self
.get_uuid_from_fqname(type, fq_name
)
143 return self
.get_by_uuid(type, uuid
)
147 def delete_ref(self
, type, uuid
, ref_type
, ref_uuid
, ref_fq_name
):
151 "ref-type": ref_type
,
152 "ref-fq-name": ref_fq_name
,
153 "operation": "DELETE",
155 endpoint
= self
.controller_url
+ "ref-update"
156 resp
= self
.http
.post_cmd(
157 url
=endpoint
, headers
=self
.http_header
, post_fields_dict
=payload
162 # Aux methods to avoid code duplication of name conventions
163 def get_vpg_name(self
, switch_id
, switch_port
):
164 return "{}_{}".format(switch_id
, switch_port
).replace(":", "_")
166 def get_vmi_name(self
, switch_id
, switch_port
, vlan
):
167 return "{}_{}-{}".format(switch_id
, switch_port
, vlan
).replace(":", "_")
169 # Virtual network operations
171 def create_virtual_network(self
, name
, vni
):
172 self
.logger
.debug("create vname, name: {}, vni: {}".format(name
, vni
))
173 routetarget
= "{}:{}".format(self
.asn
, vni
)
176 "virtual_network_properties": {
177 "vxlan_network_identifier": vni
,
179 "parent_type": "project",
180 "fq_name": [self
.domain
, self
.project
, name
],
181 "route_target_list": {"route_target": ["target:" + routetarget
]},
184 endpoint
= self
.controller_url
+ "virtual-networks"
185 resp
= self
.http
.post_cmd(
186 url
=endpoint
, headers
=self
.http_header
, post_fields_dict
=vnet_dict
190 raise SdnConnectorError("Error creating virtual network: empty response")
192 vnet_info
= json
.loads(resp
)
193 self
.logger
.debug("created vnet, vnet_info: {}".format(vnet_info
))
195 return vnet_info
.get("virtual-network").get("uuid"), vnet_info
.get(
199 def get_virtual_networks(self
):
200 return self
.get_all_by_type("virtual-networks")
202 def get_virtual_network(self
, network_id
):
203 return self
.get_by_uuid("virtual-network", network_id
)
205 def delete_virtual_network(self
, network_id
):
206 self
.logger
.debug("delete vnet uuid: {}".format(network_id
))
207 self
.delete_by_uuid(self
.controller_url
, "virtual-network", network_id
)
208 self
.logger
.debug("deleted vnet uuid: {}".format(network_id
))
212 def create_vpg(self
, switch_id
, switch_port
):
214 "create vpg, switch_id: {}, switch_port: {}".format(switch_id
, switch_port
)
216 vpg_name
= self
.get_vpg_name(switch_id
, switch_port
)
218 "virtual-port-group": {
219 "parent_type": "fabric",
220 "fq_name": ["default-global-system-config", self
.fabric
, vpg_name
],
223 endpoint
= self
.controller_url
+ "virtual-port-groups"
224 resp
= self
.http
.post_cmd(
225 url
=endpoint
, headers
=self
.http_header
, post_fields_dict
=vpg_dict
229 raise SdnConnectorError("Error creating virtual port group: empty response")
231 vpg_info
= json
.loads(resp
)
232 self
.logger
.debug("created vpg, vpg_info: {}".format(vpg_info
))
234 return vpg_info
.get("virtual-port-group").get("uuid"), vpg_info
.get(
239 return self
.get_all_by_type(self
.controller_url
, "virtual-port-groups")
241 def get_vpg(self
, vpg_id
):
242 return self
.get_by_uuid(self
.controller_url
, "virtual-port-group", vpg_id
)
244 def get_vpg_by_name(self
, vpg_name
):
245 fq_name
= ["default-global-system-config", self
.fabric
, vpg_name
]
247 return self
.get_by_fq_name("virtual-port-group", fq_name
)
249 def delete_vpg(self
, vpg_id
):
250 self
.logger
.debug("delete vpg, uuid: {}".format(vpg_id
))
251 self
.delete_by_uuid(self
.controller_url
, "virtual-port-group", vpg_id
)
252 self
.logger
.debug("deleted vpg, uuid: {}".format(vpg_id
))
254 def create_vmi(self
, switch_id
, switch_port
, network
, vlan
):
256 "create vmi, switch_id: {}, switch_port: {}, network: {}, vlan: {}".format(
257 switch_id
, switch_port
, network
, vlan
260 vmi_name
= self
.get_vmi_name(switch_id
, switch_port
, vlan
)
261 vpg_name
= self
.get_vpg_name(switch_id
, switch_port
)
263 "local_link_information": [
265 "port_id": switch_port
.replace(":", "_"),
266 "switch_id": switch_port
.replace(":", "_"),
267 "switch_info": switch_id
,
268 "fabric": self
.fabric
,
273 "virtual-machine-interface": {
274 "parent_type": "project",
275 "fq_name": [self
.domain
, self
.project
, vmi_name
],
276 "virtual_network_refs": [{"to": [self
.domain
, self
.project
, network
]}],
277 "virtual_machine_interface_properties": {
278 "sub_interface_vlan_tag": vlan
280 "virtual_machine_interface_bindings": {
282 {"key": "vnic_type", "value": "baremetal"},
283 {"key": "vif_type", "value": "vrouter"},
284 {"key": "vpg", "value": vpg_name
},
285 {"key": "profile", "value": json
.dumps(profile_dict
)},
290 endpoint
= self
.controller_url
+ "virtual-machine-interfaces"
291 self
.logger
.debug("vmi_dict: {}".format(vmi_dict
))
292 resp
= self
.http
.post_cmd(
294 headers
=self
.http_header
,
295 post_fields_dict
=vmi_dict
,
299 raise SdnConnectorError("Error creating vmi: empty response")
301 vmi_info
= json
.loads(resp
)
302 self
.logger
.debug("created vmi, info: {}".format(vmi_info
))
304 return vmi_info
.get("virtual-machine-interface").get("uuid"), vmi_info
.get(
305 "virtual-machine-interface"
308 def get_vmi(self
, vmi_uuid
):
309 return self
.get_by_uuid(
310 self
.controller_url
, "virtual-machine-interface", vmi_uuid
313 def delete_vmi(self
, uuid
):
314 self
.logger
.debug("delete vmi uuid: {}".format(uuid
))
315 self
.delete_by_uuid(self
.controller_url
, "virtual-machine-interface", uuid
)
316 self
.logger
.debug("deleted vmi: {}".format(uuid
))
318 def unref_vmi_vpg(self
, vpg_id
, vmi_id
, vmi_fq_name
):
320 "virtual-port-group",
322 "virtual-machine-interface",