-
Notifications
You must be signed in to change notification settings - Fork 390
/
vnc_cfg_api_server.py
1742 lines (1522 loc) · 67 KB
/
vnc_cfg_api_server.py
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# Copyright (c) 2013 Juniper Networks, Inc. All rights reserved.
#
"""
This is the main module in vnc_cfg_api_server package. It manages interaction
between http/rest, address management, authentication and database interfaces.
"""
from gevent import monkey
monkey.patch_all()
from gevent import hub
# from neutron plugin to api server, the request URL could be large. fix the const
import gevent.pywsgi
gevent.pywsgi.MAX_REQUEST_LINE = 65535
import sys
reload(sys)
sys.setdefaultencoding('UTF8')
import re
import logging
import logging.config
import signal
import os
import socket
import json
import uuid
import copy
import argparse
import ConfigParser
from pprint import pformat
import cgitb
from cStringIO import StringIO
#import GreenletProfiler
import logging
logger = logging.getLogger(__name__)
"""
Following is needed to silence warnings on every request when keystone\
auth_token middleware + Sandesh is used. Keystone or Sandesh alone\
do not produce these warnings.
Exception AttributeError: AttributeError(
"'_DummyThread' object has no attribute '_Thread__block'",)
in <module 'threading' from '/usr/lib64/python2.7/threading.pyc'> ignored
See http://stackoverflow.com/questions/13193278/understand-python-threading-bug
for more information.
"""
import threading
threading._DummyThread._Thread__stop = lambda x: 42
CONFIG_VERSION = '1.0'
import bottle
bottle.BaseRequest.MEMFILE_MAX = 1024000
import vnc_cfg_types
from vnc_cfg_ifmap import VncDbClient
from cfgm_common import ignore_exceptions
from cfgm_common.uve.vnc_api.ttypes import VncApiCommon, VncApiReadLog,\
VncApiConfigLog, VncApiError
from cfgm_common.uve.virtual_network.ttypes import UveVirtualNetworkConfig,\
UveVirtualNetworkConfigTrace
from cfgm_common import illegal_xml_chars_RE
from sandesh_common.vns.ttypes import Module, NodeType
from sandesh_common.vns.constants import ModuleNames, Module2NodeType,\
NodeTypeNames, INSTANCE_ID_DEFAULT, API_SERVER_DISCOVERY_SERVICE_NAME,\
IFMAP_SERVER_DISCOVERY_SERVICE_NAME
from provision_defaults import Provision
from vnc_quota import *
from gen.resource_xsd import *
from gen.resource_common import *
from gen.resource_server import *
from gen.vnc_api_server_gen import VncApiServerGen
import cfgm_common
from cfgm_common.rest import LinkObject
from cfgm_common.exceptions import *
from cfgm_common.vnc_extensions import ExtensionManager, ApiHookManager
import gen.resource_xsd
import vnc_addr_mgmt
import vnc_auth
import vnc_auth_keystone
import vnc_perms
from cfgm_common import vnc_cpu_info
from pysandesh.sandesh_base import *
from pysandesh.gen_py.sandesh.ttypes import SandeshLevel
import discoveryclient.client as client
#from gen_py.vnc_api.ttypes import *
import netifaces
from pysandesh.connection_info import ConnectionState
from cfgm_common.uve.cfgm_cpuinfo.ttypes import NodeStatusUVE, \
NodeStatus
from sandesh.traces.ttypes import RestApiTrace
_WEB_HOST = '0.0.0.0'
_WEB_PORT = 8082
_ADMIN_PORT = 8095
_ACTION_RESOURCES = [
{'uri': '/ref-update', 'link_name': 'ref-update',
'method_name': 'ref_update_http_post'},
{'uri': '/fqname-to-id', 'link_name': 'name-to-id',
'method_name': 'fq_name_to_id_http_post'},
{'uri': '/id-to-fqname', 'link_name': 'id-to-name',
'method_name': 'id_to_fq_name_http_post'},
# ifmap-to-id only for ifmap subcribers using rest for publish
{'uri': '/ifmap-to-id', 'link_name': 'ifmap-to-id',
'method_name': 'ifmap_to_id_http_post'},
{'uri': '/useragent-kv', 'link_name': 'useragent-keyvalue',
'method_name': 'useragent_kv_http_post'},
{'uri': '/db-check', 'link_name': 'database-check',
'method_name': 'db_check'},
{'uri': '/fetch-records', 'link_name': 'fetch-records',
'method_name': 'fetch_records'},
{'uri': '/start-profile', 'link_name': 'start-profile',
'method_name': 'start_profile'},
{'uri': '/stop-profile', 'link_name': 'stop-profile',
'method_name': 'stop_profile'},
{'uri': '/list-bulk-collection', 'link_name': 'list-bulk-collection',
'method_name': 'list_bulk_collection_http_post'},
]
@bottle.error(400)
def error_400(err):
return err.body
# end error_400
@bottle.error(403)
def error_403(err):
return err.body
# end error_403
@bottle.error(404)
def error_404(err):
return err.body
# end error_404
@bottle.error(409)
def error_409(err):
return err.body
# end error_409
@bottle.error(500)
def error_500(err):
return err.body
# end error_500
@bottle.error(503)
def error_503(err):
return err.body
# end error_503
# Masking of password from openstack/common/log.py
_SANITIZE_KEYS = ['adminPass', 'admin_pass', 'password', 'admin_password']
# NOTE(ldbragst): Let's build a list of regex objects using the list of
# _SANITIZE_KEYS we already have. This way, we only have to add the new key
# to the list of _SANITIZE_KEYS and we can generate regular expressions
# for XML and JSON automatically.
_SANITIZE_PATTERNS = []
_FORMAT_PATTERNS = [r'(%(key)s\s*[=]\s*[\"\']).*?([\"\'])',
r'(<%(key)s>).*?(</%(key)s>)',
r'([\"\']%(key)s[\"\']\s*:\s*[\"\']).*?([\"\'])',
r'([\'"].*?%(key)s[\'"]\s*:\s*u?[\'"]).*?([\'"])']
for key in _SANITIZE_KEYS:
for pattern in _FORMAT_PATTERNS:
reg_ex = re.compile(pattern % {'key': key}, re.DOTALL)
_SANITIZE_PATTERNS.append(reg_ex)
def mask_password(message, secret="***"):
"""Replace password with 'secret' in message.
:param message: The string which includes security information.
:param secret: value with which to replace passwords.
:returns: The unicode value of message with the password fields masked.
For example:
>>> mask_password("'adminPass' : 'aaaaa'")
"'adminPass' : '***'"
>>> mask_password("'admin_pass' : 'aaaaa'")
"'admin_pass' : '***'"
>>> mask_password('"password" : "aaaaa"')
'"password" : "***"'
>>> mask_password("'original_password' : 'aaaaa'")
"'original_password' : '***'"
>>> mask_password("u'original_password' : u'aaaaa'")
"u'original_password' : u'***'"
"""
if not any(key in message for key in _SANITIZE_KEYS):
return message
secret = r'\g<1>' + secret + r'\g<2>'
for pattern in _SANITIZE_PATTERNS:
message = re.sub(pattern, secret, message)
return message
class VncApiServer(VncApiServerGen):
"""
This is the manager class co-ordinating all classes present in the package
"""
_INVALID_NAME_CHARS = set(':')
def __new__(cls, *args, **kwargs):
obj = super(VncApiServer, cls).__new__(cls, *args, **kwargs)
bottle.route('/', 'GET', obj.homepage_http_get)
for act_res in _ACTION_RESOURCES:
method = getattr(obj, act_res['method_name'])
obj.route(act_res['uri'], 'POST', method)
return obj
# end __new__
def __init__(self, args_str=None):
self._args = None
if not args_str:
args_str = ' '.join(sys.argv[1:])
self._parse_args(args_str)
# set python logging level from logging_level cmdline arg
if not self._args.logging_conf:
logging.basicConfig(level = getattr(logging, self._args.logging_level))
else:
logging.config.fileConfig(self._args.logging_conf)
self._base_url = "http://%s:%s" % (self._args.listen_ip_addr,
self._args.listen_port)
super(VncApiServer, self).__init__()
self._pipe_start_app = None
#GreenletProfiler.set_clock_type('wall')
self._profile_info = None
# REST interface initialization
self._get_common = self._http_get_common
self._put_common = self._http_put_common
self._delete_common = self._http_delete_common
self._post_validate = self._http_post_validate
self._post_common = self._http_post_common
# Type overrides from generated code
self._resource_classes['global-system-config'] = \
vnc_cfg_types.GlobalSystemConfigServer
self._resource_classes['floating-ip'] = vnc_cfg_types.FloatingIpServer
self._resource_classes['instance-ip'] = vnc_cfg_types.InstanceIpServer
self._resource_classes['logical-router'] = vnc_cfg_types.LogicalRouterServer
self._resource_classes['security-group'] = vnc_cfg_types.SecurityGroupServer
self._resource_classes['virtual-machine-interface'] = \
vnc_cfg_types.VirtualMachineInterfaceServer
self._resource_classes['virtual-network'] = \
vnc_cfg_types.VirtualNetworkServer
self._resource_classes['network-policy'] = \
vnc_cfg_types.NetworkPolicyServer
self._resource_classes['network-ipam'] = \
vnc_cfg_types.NetworkIpamServer
self._resource_classes['virtual-DNS'] = vnc_cfg_types.VirtualDnsServer
self._resource_classes['virtual-DNS-record'] = \
vnc_cfg_types.VirtualDnsRecordServer
self._resource_classes['logical-interface'] = \
vnc_cfg_types.LogicalInterfaceServer
self._resource_classes['physical-interface'] = \
vnc_cfg_types.PhysicalInterfaceServer
self._resource_classes['virtual-ip'] = vnc_cfg_types.VirtualIpServer
self._resource_classes['loadbalancer-healthmonitor'] = (
vnc_cfg_types.LoadbalancerHealthmonitorServer)
self._resource_classes['loadbalancer-member'] = (
vnc_cfg_types.LoadbalancerMemberServer)
self._resource_classes['loadbalancer-pool'] = (
vnc_cfg_types.LoadbalancerPoolServer)
# TODO default-generation-setting can be from ini file
self._resource_classes['bgp-router'].generate_default_instance = False
self._resource_classes[
'virtual-router'].generate_default_instance = False
self._resource_classes[
'access-control-list'].generate_default_instance = False
self._resource_classes[
'floating-ip-pool'].generate_default_instance = False
self._resource_classes['instance-ip'].generate_default_instance = False
self._resource_classes['logical-router'].generate_default_instance = False
self._resource_classes['security-group'].generate_default_instance = False
self._resource_classes[
'virtual-machine'].generate_default_instance = False
self._resource_classes[
'virtual-machine-interface'].generate_default_instance = False
self._resource_classes[
'service-template'].generate_default_instance = False
self._resource_classes[
'service-instance'].generate_default_instance = False
self._resource_classes[
'virtual-DNS-record'].generate_default_instance = False
self._resource_classes['virtual-DNS'].generate_default_instance = False
self._resource_classes[
'global-vrouter-config'].generate_default_instance = False
self._resource_classes[
'loadbalancer-pool'].generate_default_instance = False
self._resource_classes[
'loadbalancer-member'].generate_default_instance = False
self._resource_classes[
'loadbalancer-healthmonitor'].generate_default_instance = False
self._resource_classes[
'virtual-ip'].generate_default_instance = False
for act_res in _ACTION_RESOURCES:
link = LinkObject('action', self._base_url, act_res['uri'],
act_res['link_name'])
self._homepage_links.append(link)
# Register for VN delete request. Disallow delete of system default VN
bottle.route('/virtual-network/<id>', 'DELETE', self.virtual_network_http_delete)
bottle.route('/documentation/<filename:path>',
'GET', self.documentation_http_get)
self._homepage_links.insert(
0, LinkObject('documentation', self._base_url,
'/documentation/index.html',
'documentation'))
# APIs to reserve/free block of IP address from a VN/Subnet
bottle.route('/virtual-network/<id>/ip-alloc',
'POST', self.vn_ip_alloc_http_post)
self._homepage_links.append(
LinkObject('action', self._base_url,
'/virtual-network/%s/ip-alloc',
'virtual-network-ip-alloc'))
bottle.route('/virtual-network/<id>/ip-free',
'POST', self.vn_ip_free_http_post)
self._homepage_links.append(
LinkObject('action', self._base_url,
'/virtual-network/%s/ip-free',
'virtual-network-ip-free'))
# APIs to find out number of ip instances from given VN subnet
bottle.route('/virtual-network/<id>/subnet-ip-count',
'POST', self.vn_subnet_ip_count_http_post)
self._homepage_links.append(
LinkObject('action', self._base_url,
'/virtual-network/%s/subnet-ip-count',
'virtual-network-subnet-ip-count'))
# Enable/Disable multi tenancy
bottle.route('/multi-tenancy', 'GET', self.mt_http_get)
bottle.route('/multi-tenancy', 'PUT', self.mt_http_put)
# Initialize discovery client
self._disc = None
if self._args.disc_server_ip and self._args.disc_server_port:
self._disc = client.DiscoveryClient(self._args.disc_server_ip,
self._args.disc_server_port,
ModuleNames[Module.API_SERVER])
# sandesh init
self._sandesh = Sandesh()
module = Module.API_SERVER
module_name = ModuleNames[Module.API_SERVER]
node_type = Module2NodeType[module]
node_type_name = NodeTypeNames[node_type]
if self._args.worker_id:
instance_id = self._args.worker_id
else:
instance_id = INSTANCE_ID_DEFAULT
hostname = socket.gethostname()
self._sandesh.init_generator(module_name, hostname,
node_type_name, instance_id,
self._args.collectors,
'vnc_api_server_context',
int(self._args.http_server_port),
['cfgm_common'], self._disc)
self._sandesh.trace_buffer_create(name="VncCfgTraceBuf", size=1000)
self._sandesh.trace_buffer_create(name="RestApiTraceBuf", size=1000)
self._sandesh.trace_buffer_create(name="DBRequestTraceBuf", size=1000)
self._sandesh.trace_buffer_create(name="MessageBusNotifyTraceBuf",
size=1000)
self._sandesh.trace_buffer_create(name="IfmapTraceBuf", size=1000)
self._sandesh.set_logging_params(
enable_local_log=self._args.log_local,
category=self._args.log_category,
level=self._args.log_level,
file=self._args.log_file,
enable_syslog=self._args.use_syslog,
syslog_facility=self._args.syslog_facility)
ConnectionState.init(self._sandesh, hostname, module_name,
instance_id,
staticmethod(ConnectionState.get_process_state_cb),
NodeStatusUVE, NodeStatus)
# Load extensions
self._extension_mgrs = {}
self._load_extensions()
# Address Management interface
addr_mgmt = vnc_addr_mgmt.AddrMgmt(self)
vnc_cfg_types.LogicalRouterServer.addr_mgmt = addr_mgmt
vnc_cfg_types.SecurityGroupServer.addr_mgmt = addr_mgmt
vnc_cfg_types.VirtualMachineInterfaceServer.addr_mgmt = addr_mgmt
vnc_cfg_types.FloatingIpServer.addr_mgmt = addr_mgmt
vnc_cfg_types.InstanceIpServer.addr_mgmt = addr_mgmt
vnc_cfg_types.VirtualNetworkServer.addr_mgmt = addr_mgmt
vnc_cfg_types.InstanceIpServer.manager = self
self._addr_mgmt = addr_mgmt
# Authn/z interface
if self._args.auth == 'keystone':
auth_svc = vnc_auth_keystone.AuthServiceKeystone(self, self._args)
else:
auth_svc = vnc_auth.AuthService(self, self._args)
self._pipe_start_app = auth_svc.get_middleware_app()
if not self._pipe_start_app:
self._pipe_start_app = bottle.app()
# When the multi tenancy is disable, add 'admin' role into the
# header for all requests to see all resources
@self._pipe_start_app.hook('before_request')
@bottle.hook('before_request')
def set_admin_role(*args, **kwargs):
if bottle.request.app != self._pipe_start_app:
return
bottle.request.environ['HTTP_X_ROLE'] = 'admin'
self._auth_svc = auth_svc
# API/Permissions check
self._permissions = vnc_perms.VncPermissions(self, self._args)
# DB interface initialization
if self._args.wipe_config:
self._db_connect(True)
else:
self._db_connect(self._args.reset_config)
self._db_init_entries()
# Cpuinfo interface
sysinfo_req = True
config_node_ip = self.get_server_ip()
cpu_info = vnc_cpu_info.CpuInfo(
self._sandesh.module(), self._sandesh.instance_id(), sysinfo_req,
self._sandesh, 60, config_node_ip)
self._cpu_info = cpu_info
# end __init__
@ignore_exceptions
def _generate_rest_api_request_trace(self):
method = bottle.request.method.upper()
if method == 'GET':
return None
req_id = bottle.request.headers.get('X-Request-Id',
'req-%s' %(str(uuid.uuid4())))
gevent.getcurrent().trace_request_id = req_id
url = bottle.request.url
if method == 'DELETE':
req_data = ''
else:
try:
req_data = json.dumps(bottle.request.json)
except Exception as e:
req_data = '%s: Invalid request body' %(e)
rest_trace = RestApiTrace(request_id=req_id)
rest_trace.url = url
rest_trace.method = method
rest_trace.request_data = req_data
return rest_trace
# end _generate_rest_api_request_trace
@ignore_exceptions
def _generate_rest_api_response_trace(self, rest_trace, response):
if not rest_trace:
return
rest_trace.status = bottle.response.status
rest_trace.response_body = json.dumps(response)
rest_trace.trace_msg(name='RestApiTraceBuf', sandesh=self._sandesh)
# end _generate_rest_api_response_trace
# Public Methods
def route(self, uri, method, handler):
def handler_trap_exception(*args, **kwargs):
trace = self._generate_rest_api_request_trace()
try:
response = handler(*args, **kwargs)
self._generate_rest_api_response_trace(trace, response)
return response
except Exception as e:
if trace:
trace.trace_msg(name='RestApiTraceBuf',
sandesh=self._sandesh)
# don't log details of bottle.abort i.e handled error cases
if not isinstance(e, bottle.HTTPError):
string_buf = StringIO()
cgitb.Hook(
file=string_buf,
format="text",
).handle(sys.exc_info())
err_msg = mask_password(string_buf.getvalue())
self.config_log(err_msg, level=SandeshLevel.SYS_ERR)
raise
bottle.route(uri, method, handler_trap_exception)
# end route
def get_args(self):
return self._args
# end get_args
def get_server_ip(self):
ip_list = []
for i in netifaces.interfaces():
try:
if netifaces.AF_INET in netifaces.ifaddresses(i):
addr = netifaces.ifaddresses(i)[netifaces.AF_INET][0][
'addr']
if addr != '127.0.0.1' and addr not in ip_list:
ip_list.append(addr)
except ValueError, e:
self.config_log("Skipping interface %s" % i,
level=SandeshLevel.SYS_DEBUG)
return ip_list
# end get_server_ip
def get_listen_ip(self):
return self._args.listen_ip_addr
# end get_listen_ip
def get_server_port(self):
return self._args.listen_port
# end get_server_port
def get_pipe_start_app(self):
return self._pipe_start_app
# end get_pipe_start_app
# Check for the system created VN. Disallow such VN delete
def virtual_network_http_delete(self, id):
db_conn = self._db_conn
# if obj doesn't exist return early
try:
obj_type = db_conn.uuid_to_obj_type(id)
if obj_type != 'virtual_network':
bottle.abort(404, 'No virtual-network object found for id %s' %(id))
vn_name = db_conn.uuid_to_fq_name(id)
except NoIdError:
bottle.abort(404, 'ID %s does not exist' %(id))
if vn_name == cfgm_common.IP_FABRIC_VN_FQ_NAME or \
vn_name == cfgm_common.LINK_LOCAL_VN_FQ_NAME:
bottle.abort(409, 'Can not delete system created default virtual-network %s' %(id))
super(VncApiServer, self).virtual_network_http_delete(id)
# end
def homepage_http_get(self):
json_body = {}
json_links = []
# strip trailing '/' in url
url = bottle.request.url[:-1]
for link in self._homepage_links:
# strip trailing '/' in url
json_links.append(
{'link': link.to_dict(with_url=url)}
)
json_body = \
{"href": url,
"links": json_links
}
return json_body
# end homepage_http_get
def documentation_http_get(self, filename):
return bottle.static_file(
filename,
root='/usr/share/doc/python-vnc_cfg_api_server/build/html')
# end documentation_http_get
def ref_update_http_post(self):
self._post_common(bottle.request, None, None)
obj_type = bottle.request.json['type']
obj_uuid = bottle.request.json['uuid']
ref_type = bottle.request.json['ref-type'].replace('-', '_')
operation = bottle.request.json['operation']
ref_uuid = bottle.request.json.get('ref-uuid')
ref_fq_name = bottle.request.json.get('ref-fq-name')
attr = bottle.request.json.get('attr')
if not ref_uuid and not ref_fq_name:
bottle.abort(404, 'Either ref-uuid or ref-fq-name must be specified')
if not ref_uuid:
try:
ref_uuid = self._db_conn.fq_name_to_uuid(ref_type, ref_fq_name)
except NoIdError:
bottle.abort(404, 'Name ' + pformat(ref_fq_name) + ' not found')
# type-specific hook
r_class = self._resource_classes.get(obj_type)
if r_class:
try:
fq_name = self._db_conn.uuid_to_fq_name(obj_uuid)
except NoIdError:
bottle.abort(404, 'UUID ' + obj_uuid + ' not found')
(read_ok, read_result) = self._db_conn.dbe_read(
obj_type, bottle.request.json)
if not read_ok:
self.config_object_error(obj_uuid, None, obj_type, 'ref_update', read_result)
bottle.abort(404, read_result)
obj_dict = read_result
if operation == 'ADD':
if ref_type+'_refs' not in obj_dict:
obj_dict[ref_type+'_refs'] = []
obj_dict[ref_type+'_refs'].append({'to':ref_fq_name, 'uuid': ref_uuid, 'attr':attr})
elif operation == 'DELETE':
for old_ref in obj_dict.get(ref_type+'_refs', []):
if old_ref['to'] == ref_fq_name or old_ref['uuid'] == ref_uuid:
obj_dict[ref_type+'_refs'].remove(old_ref)
break
else:
msg = 'Unknown operation ' + operation
self.config_object_error(obj_uuid, None, obj_type, 'ref_update', msg)
bottle.abort(409, msg)
(ok, put_result) = r_class.http_put(obj_uuid, fq_name, obj_dict, self._db_conn)
if not ok:
(code, msg) = put_result
self.config_object_error(obj_uuid, None, obj_type, 'ref_update', msg)
bottle.abort(code, msg)
obj_type = obj_type.replace('-', '_')
try:
id = self._db_conn.ref_update(obj_type, obj_uuid, ref_type, ref_uuid, {'attr': attr}, operation)
except NoIdError:
bottle.abort(404, 'uuid ' + obj_uuid + ' not found')
apiConfig = VncApiCommon()
apiConfig.object_type = obj_type.replace('-', '_')
fq_name = self._db_conn.uuid_to_fq_name(obj_uuid)
apiConfig.identifier_name=':'.join(fq_name)
apiConfig.identifier_uuid = obj_uuid
apiConfig.operation = 'ref-update'
apiConfig.body = str(bottle.request.json)
self._set_api_audit_info(apiConfig)
log = VncApiConfigLog(api_log=apiConfig, sandesh=self._sandesh)
log.send(sandesh=self._sandesh)
return {'uuid': id}
# end ref_update_id_http_post
def fq_name_to_id_http_post(self):
self._post_common(bottle.request, None, None)
obj_type = bottle.request.json['type'].replace('-', '_')
fq_name = bottle.request.json['fq_name']
try:
id = self._db_conn.fq_name_to_uuid(obj_type, fq_name)
except NoIdError:
bottle.abort(404, 'Name ' + pformat(fq_name) + ' not found')
return {'uuid': id}
# end fq_name_to_id_http_post
def id_to_fq_name_http_post(self):
self._post_common(bottle.request, None, None)
try:
obj_uuid = bottle.request.json['uuid']
fq_name = self._db_conn.uuid_to_fq_name(obj_uuid)
except NoIdError:
bottle.abort(404, 'UUID ' + obj_uuid + ' not found')
obj_type = self._db_conn.uuid_to_obj_type(obj_uuid)
return {'fq_name': fq_name, 'type': obj_type}
# end id_to_fq_name_http_post
def ifmap_to_id_http_post(self):
self._post_common(bottle.request, None, None)
uuid = self._db_conn.ifmap_id_to_uuid(bottle.request.json['ifmap_id'])
return {'uuid': uuid}
# end ifmap_to_id_http_post
# Enables a user-agent to store and retrieve key-val pair
# TODO this should be done only for special/quantum plugin
def useragent_kv_http_post(self):
self._post_common(bottle.request, None, None)
oper = bottle.request.json['operation']
key = bottle.request.json['key']
val = bottle.request.json.get('value', '')
# TODO move values to common
if oper == 'STORE':
self._db_conn.useragent_kv_store(key, val)
elif oper == 'RETRIEVE':
try:
result = self._db_conn.useragent_kv_retrieve(key)
return {'value': result}
except NoUserAgentKey:
bottle.abort(404, "Unknown User-Agent key " + key)
elif oper == 'DELETE':
result = self._db_conn.useragent_kv_delete(key)
else:
bottle.abort(404, "Invalid Operation " + oper)
# end useragent_kv_http_post
def db_check(self):
""" Check database for inconsistencies. No update to database """
check_result = self._db_conn.db_check()
return {'results': check_result}
# end db_check
def fetch_records(self):
""" Retrieve and return all records """
result = self._db_conn.db_read()
return {'results': result}
# end fetch_records
def start_profile(self):
#GreenletProfiler.start()
pass
# end start_profile
def stop_profile(self):
pass
#GreenletProfiler.stop()
#stats = GreenletProfiler.get_func_stats()
#self._profile_info = stats.print_all()
#return self._profile_info
# end stop_profile
def get_profile_info(self):
return self._profile_info
# end get_profile_info
def get_resource_class(self, resource_type):
if resource_type in self._resource_classes:
return self._resource_classes[resource_type]
return None
# end get_resource_class
def list_bulk_collection_http_post(self):
""" List collection when requested ids don't fit in query params."""
obj_type = bottle.request.json.get('type') # e.g. virtual-network
if not obj_type:
bottle.abort(400, "Bad Request, no 'type' in POST body")
obj_class = self._resource_classes.get(obj_type)
if not obj_class:
bottle.abort(400,
"Bad Request, Unknown type %s in POST body" %(obj_type))
try:
parent_ids = bottle.request.json['parent_id'].split(',')
parent_uuids = [str(uuid.UUID(p_uuid)) for p_uuid in parent_ids]
except KeyError:
parent_uuids = None
try:
back_ref_ids = bottle.request.json['back_ref_id'].split(',')
back_ref_uuids = [str(uuid.UUID(b_uuid)) for b_uuid in back_ref_ids]
except KeyError:
back_ref_uuids = None
try:
obj_ids = bottle.request.json['obj_uuids'].split(',')
obj_uuids = [str(uuid.UUID(b_uuid)) for b_uuid in obj_ids]
except KeyError:
obj_uuids = None
try:
is_count = bottle.request.json['count']
except KeyError:
is_count = False
try:
is_detail = bottle.request.json['detail']
except KeyError:
is_detail = False
return self._list_collection(obj_type, parent_uuids, back_ref_uuids,
obj_uuids, is_count, is_detail)
# end list_bulk_collection_http_post
# Private Methods
def _parse_args(self, args_str):
'''
Eg. python vnc_cfg_api_server.py --ifmap_server_ip 192.168.1.17
--ifmap_server_port 8443
--ifmap_username test
--ifmap_password test
--cassandra_server_list\
10.1.2.3:9160 10.1.2.4:9160
--redis_server_ip 127.0.0.1
--redis_server_port 6382
--collectors 127.0.0.1:8086
--http_server_port 8090
--listen_ip_addr 127.0.0.1
--listen_port 8082
--admin_port 8095
--log_local
--log_level SYS_DEBUG
--logging_level DEBUG
--logging_conf <logger-conf-file>
--log_category test
--log_file <stdout>
--trace_file /var/log/contrail/vnc_openstack.err
--use_syslog
--syslog_facility LOG_USER
--disc_server_ip 127.0.0.1
--disc_server_port 5998
--worker_id 1
--rabbit_max_pending_updates 4096
--cluster_id <testbed-name>
[--auth keystone]
[--ifmap_server_loc
/home/contrail/source/ifmap-server/]
[--default_encoding ascii ]
'''
# Source any specified config/ini file
# Turn off help, so we print all options in response to -h
conf_parser = argparse.ArgumentParser(add_help=False)
conf_parser.add_argument("-c", "--conf_file", action='append',
help="Specify config file", metavar="FILE")
args, remaining_argv = conf_parser.parse_known_args(args_str.split())
defaults = {
'reset_config': False,
'wipe_config': False,
'listen_ip_addr': _WEB_HOST,
'listen_port': _WEB_PORT,
'admin_port': _ADMIN_PORT,
'ifmap_server_ip': '127.0.0.1',
'ifmap_server_port': "8443",
'collectors': None,
'http_server_port': '8084',
'log_local': True,
'log_level': SandeshLevel.SYS_NOTICE,
'log_category': '',
'log_file': Sandesh._DEFAULT_LOG_FILE,
'trace_file': '/var/log/contrail/vnc_openstack.err',
'use_syslog': False,
'syslog_facility': Sandesh._DEFAULT_SYSLOG_FACILITY,
'logging_level': 'WARN',
'logging_conf': '',
'multi_tenancy': True,
'disc_server_ip': None,
'disc_server_port': '5998',
'zk_server_ip': '127.0.0.1:2181',
'worker_id': '0',
'rabbit_server': 'localhost',
'rabbit_port': '5672',
'rabbit_user': 'guest',
'rabbit_password': 'guest',
'rabbit_vhost': None,
'rabbit_max_pending_updates': '4096',
'cluster_id': '',
}
# ssl options
secopts = {
'use_certs': False,
'keyfile': '',
'certfile': '',
'ca_certs': '',
'ifmap_certauth_port': "8444",
}
# keystone options
ksopts = {
'auth_host': '127.0.0.1',
'auth_port': '35357',
'auth_protocol': 'http',
'admin_user': '',
'admin_password': '',
'admin_tenant_name': '',
'insecure': True
}
config = None
if args.conf_file:
config = ConfigParser.SafeConfigParser({'admin_token': None})
config.read(args.conf_file)
defaults.update(dict(config.items("DEFAULTS")))
if 'multi_tenancy' in config.options('DEFAULTS'):
defaults['multi_tenancy'] = config.getboolean(
'DEFAULTS', 'multi_tenancy')
if 'SECURITY' in config.sections() and\
'use_certs' in config.options('SECURITY'):
if config.getboolean('SECURITY', 'use_certs'):
secopts.update(dict(config.items("SECURITY")))
if 'KEYSTONE' in config.sections():
ksopts.update(dict(config.items("KEYSTONE")))
if 'QUOTA' in config.sections():
for (k, v) in config.items("QUOTA"):
try:
if str(k) != 'admin_token':
QuotaHelper.default_quota[str(k)] = int(v)
except ValueError:
pass
if 'default_encoding' in config.options('DEFAULTS'):
default_encoding = config.get('DEFAULTS', 'default_encoding')
gen.resource_xsd.ExternalEncoding = default_encoding
# Override with CLI options
# Don't surpress add_help here so it will handle -h
parser = argparse.ArgumentParser(
# Inherit options from config_parser
parents=[conf_parser],
# print script description with -h/--help
description=__doc__,
# Don't mess with format of description
formatter_class=argparse.RawDescriptionHelpFormatter,
)
defaults.update(secopts)
defaults.update(ksopts)
parser.set_defaults(**defaults)
parser.add_argument(
"--ifmap_server_ip", help="IP address of ifmap server")
parser.add_argument(
"--ifmap_server_port", help="Port of ifmap server")
# TODO should be from certificate
parser.add_argument(
"--ifmap_username",
help="Username known to ifmap server")
parser.add_argument(
"--ifmap_password",
help="Password known to ifmap server")
parser.add_argument(
"--cassandra_server_list",
help="List of cassandra servers in IP Address:Port format",
nargs='+')
parser.add_argument(
"--redis_server_ip",
help="IP address of redis server")
parser.add_argument(
"--redis_server_port",
help="Port of redis server")
parser.add_argument(
"--auth", choices=['keystone'],
help="Type of authentication for user-requests")
parser.add_argument(
"--reset_config", action="store_true",
help="Warning! Destroy previous configuration and start clean")
parser.add_argument(
"--wipe_config", action="store_true",
help="Warning! Destroy previous configuration")
parser.add_argument(
"--listen_ip_addr",
help="IP address to provide service on, default %s" % (_WEB_HOST))
parser.add_argument(
"--listen_port",
help="Port to provide service on, default %s" % (_WEB_PORT))
parser.add_argument(
"--admin_port",
help="Port with local auth for admin access, default %s"
% (_ADMIN_PORT))
parser.add_argument(
"--collectors",
help="List of VNC collectors in ip:port format",
nargs="+")
parser.add_argument(
"--http_server_port",
help="Port of local HTTP server")
parser.add_argument(
"--ifmap_server_loc",
help="Location of IFMAP server")
parser.add_argument(
"--log_local", action="store_true",
help="Enable local logging of sandesh messages")
parser.add_argument(
"--log_level",
help="Severity level for local logging of sandesh messages")
parser.add_argument(
"--logging_level",
help=("Log level for python logging: DEBUG, INFO, WARN, ERROR default: %s"
% defaults['logging_level']))
parser.add_argument(
"--logging_conf",
help=("Optional logging configuration file, default: None"))