X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osmclient%2Fscripts%2Fosm.py;h=1df00d680df0c86034362233bf5082a259949805;hb=54887b0f2caac06a58e6467ef917d2111696c1d3;hp=ab90dd78fd5fff92ccefaf40861ede2e06b67b41;hpb=6bc001c642c74e6742d0a5dd5922738ae4c4fb0d;p=osm%2Fosmclient.git diff --git a/osmclient/scripts/osm.py b/osmclient/scripts/osm.py index ab90dd7..1df00d6 100755 --- a/osmclient/scripts/osm.py +++ b/osmclient/scripts/osm.py @@ -20,7 +20,7 @@ OSM shell/cli import click from osmclient import client -from osmclient.common.exceptions import ClientException +from osmclient.common.exceptions import ClientException, NotFound from prettytable import PrettyTable import yaml import json @@ -30,6 +30,7 @@ import os import textwrap import pkg_resources import logging +from datetime import datetime # Global variables @@ -68,6 +69,21 @@ def check_client_version(obj, what, version='sol005'): return +def get_project(project_list, item): + # project_list = ctx.obj.project.list() + item_project_list = item.get('_admin').get('projects_read') + project_id = 'None' + project_name = 'None' + if item_project_list: + for p1 in item_project_list: + project_id = p1 + for p2 in project_list: + if p2['_id'] == project_id: + project_name = p2['name'] + return project_id, project_name + return project_id, project_name + + @click.group(context_settings=dict(help_option_names=['-h', '--help'], max_content_width=160)) @click.option('--hostname', default="127.0.0.1", @@ -96,6 +112,22 @@ def check_client_version(obj, what, version='sol005'): 'Also can set OSM_PROJECT in environment') @click.option('-v', '--verbose', count=True, help='increase verbosity (-v INFO, -vv VERBOSE, -vvv DEBUG)') +@click.option('--all-projects', + default=None, + is_flag=True, + help='include all projects') +@click.option('--public/--no-public', default=None, + help='flag for public items (packages, instances, VIM accounts, etc.)') +@click.option('--project-domain-name', 'project_domain_name', + default=None, + envvar='OSM_PROJECT_DOMAIN_NAME', + help='project domain name for keystone authentication (default to None). ' + + 'Also can set OSM_PROJECT_DOMAIN_NAME in environment') +@click.option('--user-domain-name', 'user_domain_name', + default=None, + envvar='OSM_USER_DOMAIN_NAME', + help='user domain name for keystone authentication (default to None). ' + + 'Also can set OSM_USER_DOMAIN_NAME in environment') #@click.option('--so-port', # default=None, # envvar='OSM_SO_PORT', @@ -117,14 +149,16 @@ def check_client_version(obj, what, version='sol005'): # help='hostname of RO server. ' + # 'Also can set OSM_RO_PORT in environment') @click.pass_context -def cli_osm(ctx, hostname, user, password, project, verbose): +def cli_osm(ctx, **kwargs): global logger + hostname = kwargs.pop("hostname", None) if hostname is None: print(( "either hostname option or OSM_HOSTNAME " + "environment variable needs to be specified")) exit(1) - kwargs = {'verbose': verbose} + # Remove None values + kwargs = {k: v for k, v in kwargs.items() if v is not None} # if so_port is not None: # kwargs['so_port']=so_port # if so_project is not None: @@ -134,12 +168,16 @@ def cli_osm(ctx, hostname, user, password, project, verbose): # if ro_port is not None: # kwargs['ro_port']=ro_port sol005 = os.getenv('OSM_SOL005', True) - if user is not None: - kwargs['user']=user - if password is not None: - kwargs['password']=password - if project is not None: - kwargs['project']=project +# if user is not None: +# kwargs['user']=user +# if password is not None: +# kwargs['password']=password +# if project is not None: +# kwargs['project']=project +# if all_projects: +# kwargs['all_projects']=all_projects +# if public is not None: +# kwargs['public']=public ctx.obj = client.Client(host=hostname, sol005=sol005, **kwargs) logger = logging.getLogger('osmclient') @@ -149,10 +187,12 @@ def cli_osm(ctx, hostname, user, password, project, verbose): #################### @cli_osm.command(name='ns-list', short_help='list all NS instances') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the NS instances matching the filter.') +@click.option('--long', is_flag=True, + help='get more details of the NS (project, vim, deployment status, configuration status.') @click.pass_context -def ns_list(ctx, filter): +def ns_list(ctx, filter, long): """list all NS instances \b @@ -200,93 +240,258 @@ def ns_list(ctx, filter): --filter nsd.vendor=&nsd-ref= --filter nsd.constituent-vnfd.vnfd-id-ref= """ + def summarize_deployment_status(status_dict): + #Nets + summary = "" + if not status_dict: + return summary + n_nets = 0 + status_nets = {} + net_list = status_dict.get('nets',[]) + for net in net_list: + n_nets += 1 + if net['status'] not in status_nets: + status_nets[net['status']] = 1 + else: + status_nets[net['status']] +=1 + message = "Nets: " + for k,v in status_nets.items(): + message += "{}:{},".format(k,v) + message += "TOTAL:{}".format(n_nets) + summary += "{}".format(message) + #VMs and VNFs + n_vms = 0 + status_vms = {} + status_vnfs = {} + vnf_list = status_dict['vnfs'] + for vnf in vnf_list: + member_vnf_index = vnf['member_vnf_index'] + if member_vnf_index not in status_vnfs: + status_vnfs[member_vnf_index] = {} + for vm in vnf['vms']: + n_vms += 1 + if vm['status'] not in status_vms: + status_vms[vm['status']] = 1 + else: + status_vms[vm['status']] +=1 + if vm['status'] not in status_vnfs[member_vnf_index]: + status_vnfs[member_vnf_index][vm['status']] = 1 + else: + status_vnfs[member_vnf_index][vm['status']] += 1 + message = "VMs: " + for k,v in status_vms.items(): + message += "{}:{},".format(k,v) + message += "TOTAL:{}".format(n_vms) + summary += "\n{}".format(message) + summary += "\nNFs:" + for k,v in status_vnfs.items(): + total = 0 + message = "\n {} VMs: ".format(k) + for k2,v2 in v.items(): + message += "{}:{},".format(k2,v2) + total += v2 + message += "TOTAL:{}".format(total) + summary += message + return summary + + def summarize_config_status(ee_list): + summary = "" + if not ee_list: + return summary + n_ee = 0 + status_ee = {} + for ee in ee_list: + n_ee += 1 + if ee['elementType'] not in status_ee: + status_ee[ee['elementType']] = {} + status_ee[ee['elementType']][ee['status']] = 1 + continue + if ee['status'] in status_ee[ee['elementType']]: + status_ee[ee['elementType']][ee['status']] += 1 + else: + status_ee[ee['elementType']][ee['status']] = 1 + for elementType in ["KDU", "VDU", "PDU", "VNF", "NS"]: + if elementType in status_ee: + message = "" + total = 0 + for k,v in status_ee[elementType].items(): + message += "{}:{},".format(k,v) + total += v + message += "TOTAL:{}\n".format(total) + summary += "{}: {}".format(elementType, message) + summary += "TOTAL Exec. Env.: {}".format(n_ee) + return summary + logger.debug("") if filter: check_client_version(ctx.obj, '--filter') + filter='&'.join(filter) resp = ctx.obj.ns.list(filter) else: resp = ctx.obj.ns.list() - table = PrettyTable( + if long: + table = PrettyTable( ['ns instance name', 'id', - 'operational status', - 'config status', - 'detailed status']) + 'date', + 'ns state', + 'current operation', + 'error details', + 'project', + 'vim (inst param)', + 'deployment status', + 'configuration status']) + project_list = ctx.obj.project.list() + vim_list = ctx.obj.vim.list() + else: + table = PrettyTable( + ['ns instance name', + 'id', + 'date', + 'ns state', + 'current operation', + 'error details']) for ns in resp: fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': nsr = ns + logger.debug('NS info: {}'.format(nsr)) nsr_name = nsr['name'] nsr_id = nsr['_id'] + date = datetime.fromtimestamp(nsr['create-time']).strftime("%Y-%m-%dT%H:%M:%S") + ns_state = nsr.get('nsState', nsr['_admin']['nsState']) + if long: + deployment_status = summarize_deployment_status(nsr.get('deploymentStatus')) + config_status = summarize_config_status(nsr.get('configurationStatus')) + project_id = nsr.get('_admin').get('projects_read')[0] + project_name = '-' + for p in project_list: + if p['_id'] == project_id: + project_name = p['name'] + break + #project = '{} ({})'.format(project_name, project_id) + project = project_name + vim_id = nsr.get('datacenter') + vim_name = '-' + for v in vim_list: + if v['uuid'] == vim_id: + vim_name = v['name'] + break + #vim = '{} ({})'.format(vim_name, vim_id) + vim = vim_name + if 'currentOperation' in nsr: + current_operation = "{} ({})".format(nsr['currentOperation'],nsr['currentOperationID']) + else: + current_operation = "{} ({})".format(nsr['_admin'].get('current-operation','-'), nsr['_admin']['nslcmop']) + error_details = "N/A" + if ns_state == "BROKEN" or ns_state == "DEGRADED" or \ + ('currentOperation' not in nsr and nsr.get('errorDescription')): + error_details = "{}\nDetail: {}".format(nsr['errorDescription'], nsr['errorDetail']) else: nsopdata = ctx.obj.ns.get_opdata(ns['id']) nsr = nsopdata['nsr:nsr'] nsr_name = nsr['name-ref'] nsr_id = nsr['ns-instance-config-ref'] - opstatus = nsr['operational-status'] if 'operational-status' in nsr else 'Not found' - configstatus = nsr['config-status'] if 'config-status' in nsr else 'Not found' - detailed_status = nsr['detailed-status'] if 'detailed-status' in nsr else 'Not found' - detailed_status = wrap_text(text=detailed_status,width=50) - if configstatus == "config_not_needed": - configstatus = "configured (no charms)" - - table.add_row( - [nsr_name, - nsr_id, - opstatus, - configstatus, - detailed_status]) + date = '-' + project = '-' + deployment_status = nsr['operational-status'] if 'operational-status' in nsr else 'Not found' + ns_state = deployment_status + config_status = nsr.get('config-status', 'Not found') + current_operation = "Unknown" + error_details = nsr.get('detailed-status', 'Not found') + if config_status == "config_not_needed": + config_status = "configured (no charms)" + + if long: + table.add_row( + [nsr_name, + nsr_id, + date, + ns_state, + current_operation, + wrap_text(text=error_details,width=40), + project, + vim, + deployment_status, + config_status]) + else: + table.add_row( + [nsr_name, + nsr_id, + date, + ns_state, + current_operation, + wrap_text(text=error_details,width=40)]) table.align = 'l' print(table) + print('To get the history of all operations over a NS, run "osm ns-op-list NS_ID"') + print('For more details on the current operation, run "osm ns-op-show OPERATION_ID"') - -def nsd_list(ctx, filter): +def nsd_list(ctx, filter, long): logger.debug("") if filter: check_client_version(ctx.obj, '--filter') + filter='&'.join(filter) resp = ctx.obj.nsd.list(filter) else: resp = ctx.obj.nsd.list() # print(yaml.safe_dump(resp)) - table = PrettyTable(['nsd name', 'id']) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': - for ns in resp: - name = ns['name'] if 'name' in ns else '-' - table.add_row([name, ns['_id']]) + if long: + table = PrettyTable(['nsd name', 'id', 'onboarding state', 'operational state', + 'usage state', 'date', 'last update']) + else: + table = PrettyTable(['nsd name', 'id']) + for nsd in resp: + name = nsd.get('name','-') + if long: + onb_state = nsd['_admin'].get('onboardingState','-') + op_state = nsd['_admin'].get('operationalState','-') + usage_state = nsd['_admin'].get('usageState','-') + date = datetime.fromtimestamp(nsd['_admin']['created']).strftime("%Y-%m-%dT%H:%M:%S") + last_update = datetime.fromtimestamp(nsd['_admin']['modified']).strftime("%Y-%m-%dT%H:%M:%S") + table.add_row([name, nsd['_id'], onb_state, op_state, usage_state, date, last_update]) + else: + table.add_row([name, nsd['_id']]) else: - for ns in resp: - table.add_row([ns['name'], ns['id']]) + table = PrettyTable(['nsd name', 'id']) + for nsd in resp: + table.add_row([nsd['name'], nsd['id']]) table.align = 'l' print(table) @cli_osm.command(name='nsd-list', short_help='list all NS packages') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the NSD/NSpkg matching the filter') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def nsd_list1(ctx, filter): +def nsd_list1(ctx, filter, long): """list all NSD/NS pkg in the system""" logger.debug("") - nsd_list(ctx, filter) + nsd_list(ctx, filter, long) @cli_osm.command(name='nspkg-list', short_help='list all NS packages') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the NSD/NSpkg matching the filter') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def nsd_list2(ctx, filter): +def nsd_list2(ctx, filter, long): """list all NS packages""" logger.debug("") - nsd_list(ctx, filter) + nsd_list(ctx, filter, long) -def vnfd_list(ctx, nf_type, filter): +def vnfd_list(ctx, nf_type, filter, long): logger.debug("") if nf_type: check_client_version(ctx.obj, '--nf_type') elif filter: check_client_version(ctx.obj, '--filter') + if filter: + filter='&'.join(filter) if nf_type: if nf_type == "vnf": nf_filter = "_admin.type=vnfd" @@ -305,13 +510,28 @@ def vnfd_list(ctx, nf_type, filter): else: resp = ctx.obj.vnfd.list() # print(yaml.safe_dump(resp)) - table = PrettyTable(['nfpkg name', 'id']) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': + if long: + table = PrettyTable(['nfpkg name', 'id', 'vendor', 'version', 'onboarding state', 'operational state', + 'usage state', 'date', 'last update']) + else: + table = PrettyTable(['nfpkg name', 'id']) for vnfd in resp: name = vnfd['name'] if 'name' in vnfd else '-' - table.add_row([name, vnfd['_id']]) + if long: + onb_state = vnfd['_admin'].get('onboardingState','-') + op_state = vnfd['_admin'].get('operationalState','-') + vendor = vnfd.get('vendor') + version = vnfd.get('version') + usage_state = vnfd['_admin'].get('usageState','-') + date = datetime.fromtimestamp(vnfd['_admin']['created']).strftime("%Y-%m-%dT%H:%M:%S") + last_update = datetime.fromtimestamp(vnfd['_admin']['modified']).strftime("%Y-%m-%dT%H:%M:%S") + table.add_row([name, vnfd['_id'], vendor, version, onb_state, op_state, usage_state, date, last_update]) + else: + table.add_row([name, vnfd['_id']]) else: + table = PrettyTable(['nfpkg name', 'id']) for vnfd in resp: table.add_row([vnfd['name'], vnfd['id']]) table.align = 'l' @@ -320,48 +540,127 @@ def vnfd_list(ctx, nf_type, filter): @cli_osm.command(name='vnfd-list', short_help='list all xNF packages (VNF, HNF, PNF)') @click.option('--nf_type', help='type of NF (vnf, pnf, hnf)') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the NF pkg matching the filter') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def vnfd_list1(ctx, nf_type, filter): +def vnfd_list1(ctx, nf_type, filter, long): """list all xNF packages (VNF, HNF, PNF)""" logger.debug("") - vnfd_list(ctx, nf_type, filter) + vnfd_list(ctx, nf_type, filter, long) @cli_osm.command(name='vnfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)') @click.option('--nf_type', help='type of NF (vnf, pnf, hnf)') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the NFpkg matching the filter') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def vnfd_list2(ctx, nf_type, filter): +def vnfd_list2(ctx, nf_type, filter, long): """list all xNF packages (VNF, HNF, PNF)""" logger.debug("") - vnfd_list(ctx, nf_type, filter) + vnfd_list(ctx, nf_type, filter, long) @cli_osm.command(name='nfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)') @click.option('--nf_type', help='type of NF (vnf, pnf, hnf)') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the NFpkg matching the filter') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def nfpkg_list(ctx, nf_type, filter): +def nfpkg_list(ctx, nf_type, filter, long): """list all xNF packages (VNF, HNF, PNF)""" logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) - vnfd_list(ctx, nf_type, filter) + vnfd_list(ctx, nf_type, filter, long) # except ClientException as e: # print(str(e)) # exit(1) -def vnf_list(ctx, ns, filter): +def pkg_repo_list(ctx, pkgtype, filter, repo, long): + if filter: + filter='&'.join(filter) + resp = ctx.obj.osmrepo.pkg_list(pkgtype, filter, repo) + if long: + table = PrettyTable(['nfpkg name', 'vendor', 'version', 'latest', 'description', 'repository']) + else: + table = PrettyTable(['nfpkg name', 'repository']) + for vnfd in resp: + name = vnfd.get('name', '-') + repository = vnfd.get('repository') + if long: + vendor = vnfd.get('vendor') + version = vnfd.get('version') + description = vnfd.get('description') + latest = vnfd.get('latest') + table.add_row([name, vendor, version, latest, description, repository]) + else: + table.add_row([name, repository]) + table.align = 'l' + print(table) + + +@cli_osm.command(name='vnfpkg-repo-list', short_help='list all xNF from OSM repositories') +@click.option('--filter', default=None, multiple=True, + help='restricts the list to the NFpkg matching the filter') +@click.option('--repo', default=None, + help='restricts the list to a particular OSM repository') +@click.option('--long', is_flag=True, help='get more details') +@click.pass_context +def nfpkg_repo_list1(ctx, filter, repo, long): + """list xNF packages from OSM repositories""" + pkgtype = 'vnf' + pkg_repo_list(ctx, pkgtype, filter, repo, long) + + +@cli_osm.command(name='nfpkg-repo-list', short_help='list all xNF from OSM repositories') +@click.option('--filter', default=None, multiple=True, + help='restricts the list to the NFpkg matching the filter') +@click.option('--repo', default=None, + help='restricts the list to a particular OSM repository') +@click.option('--long', is_flag=True, help='get more details') +@click.pass_context +def nfpkg_repo_list2(ctx, filter, repo, long): + """list xNF packages from OSM repositories""" + pkgtype = 'vnf' + pkg_repo_list(ctx, pkgtype, filter, repo, long) + + +@cli_osm.command(name='nsd-repo-list', short_help='list all NS from OSM repositories') +@click.option('--filter', default=None, multiple=True, + help='restricts the list to the NS matching the filter') +@click.option('--repo', default=None, + help='restricts the list to a particular OSM repository') +@click.option('--long', is_flag=True, help='get more details') +@click.pass_context +def nspkg_repo_list(ctx, filter, repo, long): + """list xNF packages from OSM repositories""" + pkgtype = 'ns' + pkg_repo_list(ctx, pkgtype, filter, repo, long) + + +@cli_osm.command(name='nspkg-repo-list', short_help='list all NS from OSM repositories') +@click.option('--filter', default=None, multiple=True, + help='restricts the list to the NS matching the filter') +@click.option('--repo', default=None, + help='restricts the list to a particular OSM repository') +@click.option('--long', is_flag=True, help='get more details') +@click.pass_context +def nspkg_repo_list2(ctx, filter, repo, long): + """list xNF packages from OSM repositories""" + pkgtype = 'ns' + pkg_repo_list(ctx, pkgtype, filter, repo, long) + + +def vnf_list(ctx, ns, filter, long): # try: if ns or filter: if ns: check_client_version(ctx.obj, '--ns') if filter: + filter='&'.join(filter) check_client_version(ctx.obj, '--filter') resp = ctx.obj.vnf.list(ns, filter) else: @@ -371,24 +670,23 @@ def vnf_list(ctx, ns, filter): # exit(1) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': - table = PrettyTable( - ['vnf id', - 'name', - 'ns id', - 'vnf member index', - 'vnfd name', - 'vim account id', - 'ip address']) + field_names = ['vnf id', 'name', 'ns id', 'vnf member index', + 'vnfd name', 'vim account id', 'ip address'] + if long: + field_names = ['vnf id', 'name', 'ns id', 'vnf member index', + 'vnfd name', 'vim account id', 'ip address', + 'date', 'last update'] + table = PrettyTable(field_names) for vnfr in resp: name = vnfr['name'] if 'name' in vnfr else '-' - table.add_row( - [vnfr['_id'], - name, - vnfr['nsr-id-ref'], - vnfr['member-vnf-index-ref'], - vnfr['vnfd-ref'], - vnfr['vim-account-id'], - vnfr['ip-address']]) + new_row = [vnfr['_id'], name, vnfr['nsr-id-ref'], + vnfr['member-vnf-index-ref'], vnfr['vnfd-ref'], + vnfr['vim-account-id'], vnfr['ip-address']] + if long: + date = datetime.fromtimestamp(vnfr['_admin']['created']).strftime("%Y-%m-%dT%H:%M:%S") + last_update = datetime.fromtimestamp(vnfr['_admin']['modified']).strftime("%Y-%m-%dT%H:%M:%S") + new_row.extend([date, last_update]) + table.add_row(new_row) else: table = PrettyTable( ['vnf name', @@ -410,21 +708,23 @@ def vnf_list(ctx, ns, filter): @cli_osm.command(name='vnf-list', short_help='list all NF instances') @click.option('--ns', default=None, help='NS instance id or name to restrict the NF list') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the NF instances matching the filter.') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def vnf_list1(ctx, ns, filter): +def vnf_list1(ctx, ns, filter, long): """list all NF instances""" logger.debug("") - vnf_list(ctx, ns, filter) + vnf_list(ctx, ns, filter, long) @cli_osm.command(name='nf-list', short_help='list all NF instances') @click.option('--ns', default=None, help='NS instance id or name to restrict the NF list') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the NF instances matching the filter.') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def nf_list(ctx, ns, filter): +def nf_list(ctx, ns, filter, long): """list all NF instances \b @@ -473,17 +773,31 @@ def nf_list(ctx, ns, filter): --filter vnfd-ref=,vdur.ip-address= """ logger.debug("") - vnf_list(ctx, ns, filter) + vnf_list(ctx, ns, filter, long) @cli_osm.command(name='ns-op-list', short_help='shows the history of operations over a NS instance') @click.argument('name') +@click.option('--long', is_flag=True, + help='get more details of the NS operation (date, ).') @click.pass_context -def ns_op_list(ctx, name): +def ns_op_list(ctx, name, long): """shows the history of operations over a NS instance NAME: name or ID of the NS instance """ + def formatParams(params): + if params['lcmOperationType']=='instantiate': + params.pop('nsDescription') + params.pop('nsName') + params.pop('nsdId') + params.pop('nsr_id') + elif params['lcmOperationType']=='action': + params.pop('primitive') + params.pop('lcmOperationType') + params.pop('nsInstanceId') + return params + logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) @@ -492,14 +806,39 @@ def ns_op_list(ctx, name): # print(str(e)) # exit(1) - table = PrettyTable(['id', 'operation', 'action_name', 'status']) + if long: + table = PrettyTable(['id', 'operation', 'action_name', 'operation_params', 'status', 'date', 'last update', 'detail']) + else: + table = PrettyTable(['id', 'operation', 'action_name', 'status', 'date', 'detail']) + #print(yaml.safe_dump(resp)) for op in resp: action_name = "N/A" if op['lcmOperationType']=='action': action_name = op['operationParams']['primitive'] - table.add_row([op['id'], op['lcmOperationType'], action_name, - op['operationState']]) + detail = "-" + if op['operationState'] == 'PROCESSING': + if op['queuePosition'] is not None and op['queuePosition'] > 0: + detail = "In queue. Current position: {}".format(op['queuePosition']) + elif op['lcmOperationType'] in ('instantiate', 'terminate'): + if op['stage']: + detail = op['stage'] + elif op['operationState'] in ('FAILED', 'FAILED_TEMP'): + detail = op.get('errorMessage','-') + date = datetime.fromtimestamp(op['startTime']).strftime("%Y-%m-%dT%H:%M:%S") + last_update = datetime.fromtimestamp(op['statusEnteredTime']).strftime("%Y-%m-%dT%H:%M:%S") + if long: + table.add_row([op['id'], + op['lcmOperationType'], + action_name, + wrap_text(text=json.dumps(formatParams(op['operationParams']),indent=2),width=50), + op['operationState'], + date, + last_update, + wrap_text(text=detail,width=50)]) + else: + table.add_row([op['id'], op['lcmOperationType'], action_name, + op['operationState'], date, wrap_text(text=detail or "",width=50)]) table.align = 'l' print(table) @@ -509,6 +848,8 @@ def nsi_list(ctx, filter): logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) + if filter: + filter='&'.join(filter) resp = ctx.obj.nsi.list(filter) # except ClientException as e: # print(str(e)) @@ -538,7 +879,7 @@ def nsi_list(ctx, filter): @cli_osm.command(name='nsi-list', short_help='list all Network Slice Instances (NSI)') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the Network Slice Instances matching the filter') @click.pass_context def nsi_list1(ctx, filter): @@ -548,7 +889,7 @@ def nsi_list1(ctx, filter): @cli_osm.command(name='netslice-instance-list', short_help='list all Network Slice Instances (NSI)') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the Network Slice Instances matching the filter') @click.pass_context def nsi_list2(ctx, filter): @@ -561,6 +902,8 @@ def nst_list(ctx, filter): logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) + if filter: + filter='&'.join(filter) resp = ctx.obj.nst.list(filter) # except ClientException as e: # print(str(e)) @@ -575,7 +918,7 @@ def nst_list(ctx, filter): @cli_osm.command(name='nst-list', short_help='list all Network Slice Templates (NST)') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the NST matching the filter') @click.pass_context def nst_list1(ctx, filter): @@ -585,7 +928,7 @@ def nst_list1(ctx, filter): @cli_osm.command(name='netslice-template-list', short_help='list all Network Slice Templates (NST)') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the NST matching the filter') @click.pass_context def nst_list2(ctx, filter): @@ -635,7 +978,7 @@ def nsi_op_list2(ctx, name): @cli_osm.command(name='pdu-list', short_help='list all Physical Deployment Units (PDU)') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the Physical Deployment Units matching the filter') @click.pass_context def pdu_list(ctx, filter): @@ -643,6 +986,8 @@ def pdu_list(ctx, filter): logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) + if filter: + filter='&'.join(filter) resp = ctx.obj.pdu.list(filter) # except ClientException as e: # print(str(e)) @@ -684,17 +1029,17 @@ def nsd_show(ctx, name, literal): # exit(1) if literal: - print(yaml.safe_dump(resp)) + print(yaml.safe_dump(resp, indent=4, default_flow_style=False)) return table = PrettyTable(['field', 'value']) for k, v in list(resp.items()): - table.add_row([k, json.dumps(v, indent=2)]) + table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)]) table.align = 'l' print(table) -@cli_osm.command(name='nsd-show', short_help='shows the content of a NSD') +@cli_osm.command(name='nsd-show', short_help='shows the details of a NS package') @click.option('--literal', is_flag=True, help='print literally, no pretty table') @click.argument('name') @@ -708,7 +1053,7 @@ def nsd_show1(ctx, name, literal): nsd_show(ctx, name, literal) -@cli_osm.command(name='nspkg-show', short_help='shows the content of a NSD') +@cli_osm.command(name='nspkg-show', short_help='shows the details of a NS package') @click.option('--literal', is_flag=True, help='print literally, no pretty table') @click.argument('name') @@ -732,17 +1077,42 @@ def vnfd_show(ctx, name, literal): # exit(1) if literal: - print(yaml.safe_dump(resp)) + print(yaml.safe_dump(resp, indent=4, default_flow_style=False)) return table = PrettyTable(['field', 'value']) for k, v in list(resp.items()): - table.add_row([k, json.dumps(v, indent=2)]) + table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)]) + table.align = 'l' + print(table) + + +def pkg_repo_show(ctx, pkgtype, name, repo, version, filter, literal): + logger.debug("") + if filter: + filter='&'.join(filter) + # try: + resp = ctx.obj.osmrepo.pkg_get(pkgtype, name, repo, version, filter) + + if literal: + print(yaml.safe_dump(resp, indent=4, default_flow_style=False)) + return + pkgtype += 'd' + catalog = pkgtype + '-catalog' + full_catalog = pkgtype + ':' + catalog + if resp.get(catalog): + resp = resp.pop(catalog)[pkgtype][0] + elif resp.get(full_catalog): + resp = resp.pop(full_catalog)[pkgtype][0] + + table = PrettyTable(['field', 'value']) + for k, v in list(resp.items()): + table.add_row([k, wrap_text(text=json.dumps(v, indent=2), width=100)]) table.align = 'l' print(table) -@cli_osm.command(name='vnfd-show', short_help='shows the content of a VNFD') +@cli_osm.command(name='vnfd-show', short_help='shows the details of a NF package') @click.option('--literal', is_flag=True, help='print literally, no pretty table') @click.argument('name') @@ -756,7 +1126,7 @@ def vnfd_show1(ctx, name, literal): vnfd_show(ctx, name, literal) -@cli_osm.command(name='vnfpkg-show', short_help='shows the content of a VNFD') +@cli_osm.command(name='vnfpkg-show', short_help='shows the details of a NF package') @click.option('--literal', is_flag=True, help='print literally, no pretty table') @click.argument('name') @@ -770,7 +1140,73 @@ def vnfd_show2(ctx, name, literal): vnfd_show(ctx, name, literal) -@cli_osm.command(name='nfpkg-show', short_help='shows the content of a NF Descriptor') +@cli_osm.command(name='vnfpkg-repo-show', short_help='shows the details of a NF package in an OSM repository') +@click.option('--literal', is_flag=True, + help='print literally, no pretty table') +@click.option('--repo', + required=True, + help='Repository name') +@click.argument('name') +@click.option('--filter', default=None, multiple=True, + help='filter by fields') +@click.option('--version', + default='latest', + help='package version') +@click.pass_context +def vnfd_show3(ctx, name, repo, version, literal=None, filter=None): + """shows the content of a VNFD in a repository + + NAME: name or ID of the VNFD/VNFpkg + """ + pkgtype = 'vnf' + pkg_repo_show(ctx, pkgtype, name, repo, version, filter, literal) + + +@cli_osm.command(name='nsd-repo-show', short_help='shows the details of a NS package in an OSM repository') +@click.option('--literal', is_flag=True, + help='print literally, no pretty table') +@click.option('--repo', + required=True, + help='Repository name') +@click.argument('name') +@click.option('--filter', default=None, multiple=True, + help='filter by fields') +@click.option('--version', + default='latest', + help='package version') +@click.pass_context +def nsd_repo_show(ctx, name, repo, version, literal=None, filter=None): + """shows the content of a VNFD in a repository + + NAME: name or ID of the VNFD/VNFpkg + """ + pkgtype = 'ns' + pkg_repo_show(ctx, pkgtype, name, repo, version, filter, literal) + + +@cli_osm.command(name='nspkg-repo-show', short_help='shows the details of a NS package in an OSM repository') +@click.option('--literal', is_flag=True, + help='print literally, no pretty table') +@click.option('--repo', + required=True, + help='Repository name') +@click.argument('name') +@click.option('--filter', default=None, multiple=True, + help='filter by fields') +@click.option('--version', + default='latest', + help='package version') +@click.pass_context +def nsd_repo_show2(ctx, name, repo, version, literal=None, filter=None): + """shows the content of a VNFD in a repository + + NAME: name or ID of the VNFD/VNFpkg + """ + pkgtype = 'ns' + pkg_repo_show(ctx, pkgtype, name, repo, version, filter, literal) + + +@cli_osm.command(name='nfpkg-show', short_help='shows the details of a NF package') @click.option('--literal', is_flag=True, help='print literally, no pretty table') @click.argument('name') @@ -784,11 +1220,34 @@ def nfpkg_show(ctx, name, literal): vnfd_show(ctx, name, literal) +@cli_osm.command(name='nfpkg-repo-show', short_help='shows the details of a NF package in an OSM repository') +@click.option('--literal', is_flag=True, + help='print literally, no pretty table') +@click.option('--repo', + required=True, + help='Repository name') +@click.argument('name') +@click.option('--filter', default=None, multiple=True, + help='filter by fields') +@click.option('--version', + default='latest', + help='package version') +@click.pass_context +def vnfd_show4(ctx, name, repo, version, literal=None, filter=None): + """shows the content of a VNFD in a repository + + NAME: name or ID of the VNFD/VNFpkg + """ + pkgtype = 'vnf' + pkg_repo_show(ctx, pkgtype, name, repo, version, filter, literal) + + @cli_osm.command(name='ns-show', short_help='shows the info of a NS instance') @click.argument('name') @click.option('--literal', is_flag=True, help='print literally, no pretty table') -@click.option('--filter', default=None) +@click.option('--filter', multiple=True, + help='restricts the information to the fields in the filter') @click.pass_context def ns_show(ctx, name, literal, filter): """shows the info of a NS instance @@ -803,13 +1262,13 @@ def ns_show(ctx, name, literal, filter): # exit(1) if literal: - print(yaml.safe_dump(ns)) + print(yaml.safe_dump(ns, indent=4, default_flow_style=False)) return table = PrettyTable(['field', 'value']) for k, v in list(ns.items()): - if filter is None or filter in k: + if not filter or k in filter: table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)]) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ @@ -817,7 +1276,7 @@ def ns_show(ctx, name, literal, filter): nsopdata = ctx.obj.ns.get_opdata(ns['id']) nsr_optdata = nsopdata['nsr:nsr'] for k, v in list(nsr_optdata.items()): - if filter is None or filter in k: + if not filter or k in filter: table.add_row([k, wrap_text(json.dumps(v, indent=2),width=100)]) table.align = 'l' print(table) @@ -827,7 +1286,8 @@ def ns_show(ctx, name, literal, filter): @click.argument('name') @click.option('--literal', is_flag=True, help='print literally, no pretty table') -@click.option('--filter', default=None, help='restricts the information to the fields in the filter') +@click.option('--filter', multiple=True, + help='restricts the information to the fields in the filter') @click.option('--kdu', default=None, help='KDU name (whose status will be shown)') @click.pass_context def vnf_show(ctx, name, literal, filter, kdu): @@ -835,6 +1295,33 @@ def vnf_show(ctx, name, literal, filter, kdu): NAME: name or ID of the VNF instance """ + def print_kdu_status(op_info_status): + """print KDU status properly formatted + """ + try: + op_status = yaml.safe_load(op_info_status) + if "namespace" in op_status and "info" in op_status and \ + "last_deployed" in op_status["info"] and "status" in op_status["info"] and \ + "code" in op_status["info"]["status"] and "resources" in op_status["info"]["status"] and \ + "seconds" in op_status["info"]["last_deployed"]: + last_deployed_time = datetime.fromtimestamp(op_status["info"]["last_deployed"]["seconds"]).strftime("%a %b %d %I:%M:%S %Y") + print("LAST DEPLOYED: {}".format(last_deployed_time)) + print("NAMESPACE: {}".format(op_status["namespace"])) + status_code = "UNKNOWN" + if op_status["info"]["status"]["code"]==1: + status_code = "DEPLOYED" + print("STATUS: {}".format(status_code)) + print() + print("RESOURCES:") + print(op_status["info"]["status"]["resources"]) + if "notes" in op_status["info"]["status"]: + print("NOTES:") + print(op_status["info"]["status"]["notes"]) + else: + print(op_info_status) + except Exception: + print(op_info_status) + logger.debug("") if kdu: if literal: @@ -858,20 +1345,21 @@ def vnf_show(ctx, name, literal, filter, kdu): while t<30: op_info = ctx.obj.ns.get_op(op_id) if op_info['operationState'] == 'COMPLETED': - print(op_info['detailed-status']) + print_kdu_status(op_info['detailed-status']) return time.sleep(5) t += 5 print ("Could not determine KDU status") + return if literal: - print(yaml.safe_dump(resp)) + print(yaml.safe_dump(resp, indent=4, default_flow_style=False)) return table = PrettyTable(['field', 'value']) for k, v in list(resp.items()): - if filter is None or filter in k: + if not filter or k in filter: table.add_row([k, wrap_text(text=json.dumps(v,indent=2),width=100)]) table.align = 'l' print(table) @@ -928,7 +1416,8 @@ def vnf_show(ctx, name, literal, filter, kdu): @cli_osm.command(name='ns-op-show', short_help='shows the info of a NS operation') @click.argument('id') -@click.option('--filter', default=None) +@click.option('--filter', multiple=True, + help='restricts the information to the fields in the filter') @click.option('--literal', is_flag=True, help='print literally, no pretty table') @click.pass_context @@ -946,12 +1435,12 @@ def ns_op_show(ctx, id, filter, literal): # exit(1) if literal: - print(yaml.safe_dump(op_info)) + print(yaml.safe_dump(op_info, indent=4, default_flow_style=False)) return table = PrettyTable(['field', 'value']) for k, v in list(op_info.items()): - if filter is None or filter in k: + if not filter or k in filter: table.add_row([k, wrap_text(json.dumps(v, indent=2), 100)]) table.align = 'l' print(table) @@ -968,7 +1457,7 @@ def nst_show(ctx, name, literal): # exit(1) if literal: - print(yaml.safe_dump(resp)) + print(yaml.safe_dump(resp, indent=4, default_flow_style=False)) return table = PrettyTable(['field', 'value']) @@ -1016,13 +1505,13 @@ def nsi_show(ctx, name, literal, filter): # exit(1) if literal: - print(yaml.safe_dump(nsi)) + print(yaml.safe_dump(nsi, indent=4, default_flow_style=False)) return table = PrettyTable(['field', 'value']) for k, v in list(nsi.items()): - if filter is None or filter in k: + if not filter or k in filter: table.add_row([k, json.dumps(v, indent=2)]) table.align = 'l' @@ -1033,7 +1522,8 @@ def nsi_show(ctx, name, literal, filter): @click.argument('name') @click.option('--literal', is_flag=True, help='print literally, no pretty table') -@click.option('--filter', default=None) +@click.option('--filter', multiple=True, + help='restricts the information to the fields in the filter') @click.pass_context def nsi_show1(ctx, name, literal, filter): """shows the content of a Network Slice Instance (NSI) @@ -1048,7 +1538,8 @@ def nsi_show1(ctx, name, literal, filter): @click.argument('name') @click.option('--literal', is_flag=True, help='print literally, no pretty table') -@click.option('--filter', default=None) +@click.option('--filter', multiple=True, + help='restricts the information to the fields in the filter') @click.pass_context def nsi_show2(ctx, name, literal, filter): """shows the content of a Network Slice Instance (NSI) @@ -1070,7 +1561,7 @@ def nsi_op_show(ctx, id, filter): table = PrettyTable(['field', 'value']) for k, v in list(op_info.items()): - if filter is None or filter in k: + if not filter or k in filter: table.add_row([k, json.dumps(v, indent=2)]) table.align = 'l' print(table) @@ -1078,7 +1569,8 @@ def nsi_op_show(ctx, id, filter): @cli_osm.command(name='nsi-op-show', short_help='shows the info of an operation over a Network Slice Instance(NSI)') @click.argument('id') -@click.option('--filter', default=None) +@click.option('--filter', multiple=True, + help='restricts the information to the fields in the filter') @click.pass_context def nsi_op_show1(ctx, id, filter): """shows the info of an operation over a Network Slice Instance(NSI) @@ -1091,7 +1583,8 @@ def nsi_op_show1(ctx, id, filter): @cli_osm.command(name='netslice-instance-op-show', short_help='shows the info of an operation over a Network Slice Instance(NSI)') @click.argument('id') -@click.option('--filter', default=None) +@click.option('--filter', multiple=True, + help='restricts the information to the fields in the filter') @click.pass_context def nsi_op_show2(ctx, id, filter): """shows the info of an operation over a Network Slice Instance(NSI) @@ -1106,7 +1599,8 @@ def nsi_op_show2(ctx, id, filter): @click.argument('name') @click.option('--literal', is_flag=True, help='print literally, no pretty table') -@click.option('--filter', default=None) +@click.option('--filter', multiple=True, + help='restricts the information to the fields in the filter') @click.pass_context def pdu_show(ctx, name, literal, filter): """shows the content of a Physical Deployment Unit (PDU) @@ -1122,13 +1616,13 @@ def pdu_show(ctx, name, literal, filter): # exit(1) if literal: - print(yaml.safe_dump(pdu)) + print(yaml.safe_dump(pdu, indent=4, default_flow_style=False)) return table = PrettyTable(['field', 'value']) for k, v in list(pdu.items()): - if filter is None or filter in k: + if not filter or k in filter: table.add_row([k, json.dumps(v, indent=2)]) table.align = 'l' @@ -1139,11 +1633,13 @@ def pdu_show(ctx, name, literal, filter): # CREATE operations #################### -def nsd_create(ctx, filename, overwrite): +def nsd_create(ctx, filename, overwrite, skip_charm_build, repo, vendor, version): logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.nsd.create(filename, overwrite) + if repo: + filename = ctx.obj.osmrepo.get_pkg('ns', filename, repo, vendor, version) + ctx.obj.nsd.create(filename, overwrite=overwrite, skip_charm_build=skip_charm_build) # except ClientException as e: # print(str(e)) # exit(1) @@ -1151,43 +1647,71 @@ def nsd_create(ctx, filename, overwrite): @cli_osm.command(name='nsd-create', short_help='creates a new NSD/NSpkg') @click.argument('filename') -@click.option('--overwrite', 'overwrite', default=None, hidden=True, +@click.option('--overwrite', 'overwrite', default=None, # hidden=True, help='Deprecated. Use override') @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') +@click.option('--repo', default=None, + help='[repository]: Repository name') +@click.option('--vendor', default=None, + help='[repository]: filter by vendor]') +@click.option('--version', default='latest', + help='[repository]: filter by version. Default: latest') @click.pass_context -def nsd_create1(ctx, filename, overwrite): - """creates a new NSD/NSpkg +def nsd_create1(ctx, filename, overwrite, skip_charm_build, repo, vendor, version): + """onboards a new NSpkg (alias of nspkg-create) (TO BE DEPRECATED) - FILENAME: NSD yaml file or NSpkg tar.gz file + \b + FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder + If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded. + If FILENAME is an NF Package folder, it is built and then onboarded. """ logger.debug("") - nsd_create(ctx, filename, overwrite) + nsd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build, repo=repo, vendor=vendor, + version=version) @cli_osm.command(name='nspkg-create', short_help='creates a new NSD/NSpkg') @click.argument('filename') -@click.option('--overwrite', 'overwrite', default=None, hidden=True, +@click.option('--overwrite', 'overwrite', default=None, # hidden=True, help='Deprecated. Use override') @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') +@click.option('--repo', default=None, + help='[repository]: Repository name') +@click.option('--vendor', default=None, + help='[repository]: filter by vendor]') +@click.option('--version', default='latest', + help='[repository]: filter by version. Default: latest') @click.pass_context -def nsd_create2(ctx, filename, overwrite): - """creates a new NSD/NSpkg - - FILENAME: NSD yaml file or NSpkg tar.gz file +def nsd_pkg_create(ctx, filename, overwrite, skip_charm_build, repo, vendor, version): + """onboards a new NSpkg + \b + FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder + If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded. + If FILENAME is an NF Package folder, it is built and then onboarded. """ logger.debug("") - nsd_create(ctx, filename, overwrite) + nsd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build, repo=repo, vendor=vendor, + version=version) -def vnfd_create(ctx, filename, overwrite): +def vnfd_create(ctx, filename, overwrite, skip_charm_build, override_epa, override_nonepa, override_paravirt, + repo, vendor, version): logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.vnfd.create(filename, overwrite) + if repo: + filename = ctx.obj.osmrepo.get_pkg('vnf', filename, repo, vendor, version) + ctx.obj.vnfd.create(filename, overwrite=overwrite, skip_charm_build=skip_charm_build, + override_epa=override_epa, override_nonepa=override_nonepa, + override_paravirt=override_paravirt) # except ClientException as e: # print(str(e)) # exit(1) @@ -1200,48 +1724,105 @@ def vnfd_create(ctx, filename, overwrite): @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') +@click.option('--override-epa', required=False, default=False, is_flag=True, + help='adds guest-epa parameters to all VDU') +@click.option('--override-nonepa', required=False, default=False, is_flag=True, + help='removes all guest-epa parameters from all VDU') +@click.option('--override-paravirt', required=False, default=False, is_flag=True, + help='overrides all VDU interfaces to PARAVIRT') +@click.option('--repo', default=None, + help='[repository]: Repository name') +@click.option('--vendor', default=None, + help='[repository]: filter by vendor]') +@click.option('--version', default='latest', + help='[repository]: filter by version. Default: latest') @click.pass_context -def vnfd_create1(ctx, filename, overwrite): +def vnfd_create1(ctx, filename, overwrite, skip_charm_build, override_epa, override_nonepa, override_paravirt, + repo,vendor, version): """creates a new VNFD/VNFpkg - - FILENAME: VNFD yaml file or VNFpkg tar.gz file + \b + FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder + If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded. + If FILENAME is an NF Package folder, it is built and then onboarded. """ logger.debug("") - vnfd_create(ctx, filename, overwrite) + vnfd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build, + override_epa=override_epa, override_nonepa=override_nonepa, override_paravirt=override_paravirt, + repo=repo, vendor=vendor, version=version) @cli_osm.command(name='vnfpkg-create', short_help='creates a new VNFD/VNFpkg') @click.argument('filename') -@click.option('--overwrite', 'overwrite', default=None, hidden=True, +@click.option('--overwrite', 'overwrite', default=None, # hidden=True, help='Deprecated. Use override') @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') +@click.option('--override-epa', required=False, default=False, is_flag=True, + help='adds guest-epa parameters to all VDU') +@click.option('--override-nonepa', required=False, default=False, is_flag=True, + help='removes all guest-epa parameters from all VDU') +@click.option('--override-paravirt', required=False, default=False, is_flag=True, + help='overrides all VDU interfaces to PARAVIRT') +@click.option('--repo', default=None, + help='[repository]: Repository name') +@click.option('--vendor', default=None, + help='[repository]: filter by vendor]') +@click.option('--version', default='latest', + help='[repository]: filter by version. Default: latest') @click.pass_context -def vnfd_create2(ctx, filename, overwrite): +def vnfd_create2(ctx, filename, overwrite, skip_charm_build, override_epa, override_nonepa, override_paravirt, + repo, vendor, version): """creates a new VNFD/VNFpkg - - FILENAME: VNFD yaml file or VNFpkg tar.gz file + \b + FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder + If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded. + If FILENAME is an NF Package folder, it is built and then onboarded. """ logger.debug("") - vnfd_create(ctx, filename, overwrite) - + vnfd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build, + override_epa=override_epa, override_nonepa=override_nonepa, override_paravirt=override_paravirt, + repo=repo, vendor=vendor, version=version) @cli_osm.command(name='nfpkg-create', short_help='creates a new NFpkg') @click.argument('filename') -@click.option('--overwrite', 'overwrite', default=None, hidden=True, +@click.option('--overwrite', 'overwrite', default=None, # hidden=True, help='Deprecated. Use override') @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') +@click.option('--override-epa', required=False, default=False, is_flag=True, + help='adds guest-epa parameters to all VDU') +@click.option('--override-nonepa', required=False, default=False, is_flag=True, + help='removes all guest-epa parameters from all VDU') +@click.option('--override-paravirt', required=False, default=False, is_flag=True, + help='overrides all VDU interfaces to PARAVIRT') +@click.option('--repo', default=None, + help='[repository]: Repository name') +@click.option('--vendor', default=None, + help='[repository]: filter by vendor]') +@click.option('--version', default='latest', + help='[repository]: filter by version. Default: latest') @click.pass_context -def nfpkg_create(ctx, filename, overwrite): +def nfpkg_create(ctx, filename, overwrite, skip_charm_build, override_epa, override_nonepa, override_paravirt, + repo, vendor, version): """creates a new NFpkg - FILENAME: NF Descriptor yaml file or NFpkg tar.gz file + \b + FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder + If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded. + If FILENAME is an NF Package folder, it is built and then onboarded. """ logger.debug("") - vnfd_create(ctx, filename, overwrite) + vnfd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build, + override_epa=override_epa, override_nonepa=override_nonepa, override_paravirt=override_paravirt, + repo=repo, vendor=vendor, version=version) @cli_osm.command(name='ns-create', short_help='creates a new Network Service instance') @@ -1312,7 +1893,7 @@ def nst_create(ctx, filename, overwrite): @cli_osm.command(name='nst-create', short_help='creates a new Network Slice Template (NST)') @click.argument('filename') -@click.option('--overwrite', 'overwrite', default=None, hidden=True, +@click.option('--overwrite', 'overwrite', default=None, # hidden=True, help='Deprecated. Use override') @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' @@ -1321,7 +1902,7 @@ def nst_create(ctx, filename, overwrite): def nst_create1(ctx, filename, overwrite): """creates a new Network Slice Template (NST) - FILENAME: NST yaml file or NSTpkg tar.gz file + FILENAME: NST package folder, NST yaml file or NSTpkg tar.gz file """ logger.debug("") nst_create(ctx, filename, overwrite) @@ -1329,7 +1910,7 @@ def nst_create1(ctx, filename, overwrite): @cli_osm.command(name='netslice-template-create', short_help='creates a new Network Slice Template (NST)') @click.argument('filename') -@click.option('--overwrite', 'overwrite', default=None, hidden=True, +@click.option('--overwrite', 'overwrite', default=None, # hidden=True, help='Deprecated. Use override') @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' @@ -1702,6 +2283,9 @@ def nfpkg_delete(ctx, name, force): @cli_osm.command(name='ns-delete', short_help='deletes a NS instance') @click.argument('name') @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions') +@click.option('--config', default=None, + help="specific yaml configuration for the termination, e.g. '{autoremove: False, timeout_ns_terminate: " + "600, skip_terminate_primitives: True}'") @click.option('--wait', required=False, default=False, @@ -1709,7 +2293,7 @@ def nfpkg_delete(ctx, name, force): help='do not return the control immediately, but keep it ' 'until the operation is completed, or timeout') @click.pass_context -def ns_delete(ctx, name, force, wait): +def ns_delete(ctx, name, force, config, wait): """deletes a NS instance NAME: name or ID of the NS instance to be deleted @@ -1717,10 +2301,10 @@ def ns_delete(ctx, name, force, wait): logger.debug("") # try: if not force: - ctx.obj.ns.delete(name, wait=wait) + ctx.obj.ns.delete(name, config=config, wait=wait) else: check_client_version(ctx.obj, '--force') - ctx.obj.ns.delete(name, force, wait=wait) + ctx.obj.ns.delete(name, force, config=config, wait=wait) # except ClientException as e: # print(str(e)) # exit(1) @@ -1851,7 +2435,7 @@ def pdu_delete(ctx, name, force): default='openstack', help='VIM type') @click.option('--description', - default='no description', + default=None, help='human readable description') @click.option('--sdn_controller', default=None, help='Name or id of the SDN controller associated to this VIM account') @click.option('--sdn_port_mapping', default=None, help="File describing the port mapping between compute nodes' ports and switch ports") @@ -1908,7 +2492,8 @@ def vim_create(ctx, @click.option('--config', help='VIM specific config parameters') @click.option('--account_type', help='VIM type') @click.option('--description', help='human readable description') -@click.option('--sdn_controller', default=None, help='Name or id of the SDN controller associated to this VIM account') +@click.option('--sdn_controller', default=None, help='Name or id of the SDN controller to be associated with this VIM' + 'account. Use empty string to disassociate') @click.option('--sdn_port_mapping', default=None, help="File describing the port mapping between compute nodes' ports and switch ports") @click.option('--wait', required=False, @@ -1983,13 +2568,16 @@ def vim_delete(ctx, name, force, wait): #@click.option('--ro_update/--no_ro_update', # default=False, # help='update list from RO') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the VIM accounts matching the filter') +@click.option('--long', is_flag=True, + help='get more details of the NS (project, vim, deployment status, configuration status.') @click.pass_context -def vim_list(ctx, filter): +def vim_list(ctx, filter, long): """list all VIM accounts""" logger.debug("") if filter: + filter='&'.join(filter) check_client_version(ctx.obj, '--filter') # if ro_update: # check_client_version(ctx.obj, '--ro_update', 'v1') @@ -1998,17 +2586,37 @@ def vim_list(ctx, filter): resp = ctx.obj.vim.list(filter) # else: # resp = ctx.obj.vim.list(ro_update) - table = PrettyTable(['vim name', 'uuid']) + if long: + table = PrettyTable(['vim name', 'uuid', 'project', 'operational state', 'error details']) + project_list = ctx.obj.project.list() + else: + table = PrettyTable(['vim name', 'uuid', 'operational state']) for vim in resp: - table.add_row([vim['name'], vim['uuid']]) + if long: + if 'vim_password' in vim: + vim['vim_password']='********' + logger.debug('VIM details: {}'.format(yaml.safe_dump(vim))) + vim_state = vim['_admin'].get('operationalState', '-') + error_details = 'N/A' + if vim_state == 'ERROR': + error_details = vim['_admin'].get('detailed-status', 'Not found') + project_id, project_name = get_project(project_list, vim) + #project_info = '{} ({})'.format(project_name, project_id) + project_info = project_name + table.add_row([vim['name'], vim['uuid'], project_info, + vim_state, wrap_text(text=error_details, width=80)]) + else: + table.add_row([vim['name'], vim['uuid'], vim['_admin'].get('operationalState', '-')]) table.align = 'l' print(table) @cli_osm.command(name='vim-show', short_help='shows the details of a VIM account') @click.argument('name') +@click.option('--filter', multiple=True, + help='restricts the information to the fields in the filter') @click.pass_context -def vim_show(ctx, name): +def vim_show(ctx, name, filter): """shows the details of a VIM account NAME: name or ID of the VIM account @@ -2024,7 +2632,8 @@ def vim_show(ctx, name): table = PrettyTable(['key', 'attribute']) for k, v in list(resp.items()): - table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)]) + if not filter or k in filter: + table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)]) table.align = 'l' print(table) @@ -2052,7 +2661,7 @@ def vim_show(ctx, name): @click.option('--wim_type', help='WIM type') @click.option('--description', - default='no description', + default=None, help='human readable description') @click.option('--wim_port_mapping', default=None, help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge " @@ -2172,7 +2781,7 @@ def wim_delete(ctx, name, force, wait): @cli_osm.command(name='wim-list', short_help='list all WIM accounts') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the WIM accounts matching the filter') @click.pass_context def wim_list(ctx, filter): @@ -2180,6 +2789,8 @@ def wim_list(ctx, filter): logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) + if filter: + filter='&'.join(filter) resp = ctx.obj.wim.list(filter) table = PrettyTable(['wim name', 'uuid']) for wim in resp: @@ -2227,18 +2838,19 @@ def wim_show(ctx, name): @click.option('--type', prompt=True, help='SDN controller type') -@click.option('--sdn_controller_version', hidden=True, +@click.option('--sdn_controller_version', # hidden=True, help='Deprecated. Use --config {version: sdn_controller_version}') @click.option('--url', help='URL in format http[s]://HOST:IP/') -@click.option('--ip_address', hidden=True, +@click.option('--ip_address', # hidden=True, help='Deprecated. Use --url') -@click.option('--port', hidden=True, +@click.option('--port', # hidden=True, help='Deprecated. Use --url') -@click.option('--switch_dpid', hidden=True, - help='Deprecated. Use --config {dpid: DPID}') +@click.option('--switch_dpid', # hidden=True, + help='Deprecated. Use --config {switch_id: DPID}') @click.option('--config', - help='Extra information for SDN in yaml format, as {dpid: (Openflow Datapath ID), version: version}') + help='Extra information for SDN in yaml format, as {switch_id: identity used for the plugin (e.g. DPID: ' + 'Openflow Datapath ID), version: version}') @click.option('--user', help='SDN controller username') @click.option('--password', @@ -2258,16 +2870,16 @@ def sdnc_create(ctx, **kwargs): sdncontroller = {x: kwargs[x] for x in kwargs if kwargs[x] and x not in ("wait", "ip_address", "port", "switch_dpid")} if kwargs.get("port"): - print("option '--port' is deprecated, use '-url' instead") + print("option '--port' is deprecated, use '--url' instead") sdncontroller["port"] = int(kwargs["port"]) if kwargs.get("ip_address"): - print("option '--ip_address' is deprecated, use '-url' instead") + print("option '--ip_address' is deprecated, use '--url' instead") sdncontroller["ip"] = kwargs["ip_address"] if kwargs.get("switch_dpid"): - print("option '--switch_dpid' is deprecated, use '---config={dpid: DPID}' instead") + print("option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead") sdncontroller["dpid"] = kwargs["switch_dpid"] if kwargs.get("sdn_controller_version"): - print("option '--sdn_controller_version' is deprecated, use '---config={version: SDN_CONTROLLER_VERSION}'" + print("option '--sdn_controller_version' is deprecated, use '--config={version: SDN_CONTROLLER_VERSION}'" " instead") # try: check_client_version(ctx.obj, ctx.command.name) @@ -2283,13 +2895,14 @@ def sdnc_create(ctx, **kwargs): @click.option('--type', help='SDN controller type') @click.option('--url', help='URL in format http[s]://HOST:IP/') @click.option('--config', help='Extra information for SDN in yaml format, as ' - '{dpid: (Openflow Datapath ID), version: version}') + '{switch_id: identity used for the plugin (e.g. DPID: ' + 'Openflow Datapath ID), version: version}') @click.option('--user', help='SDN controller username') @click.option('--password', help='SDN controller password') -@click.option('--ip_address', hidden=True, help='Deprecated. Use --url') -@click.option('--port', hidden=True, help='Deprecated. Use --url') -@click.option('--switch_dpid', hidden=True, help='Deprecated. Use --config {switch_dpid: DPID}') -@click.option('--sdn_controller_version', hidden=True, help='Deprecated. Use --config {version: VERSION}') +@click.option('--ip_address', help='Deprecated. Use --url') # hidden=True +@click.option('--port', help='Deprecated. Use --url') # hidden=True +@click.option('--switch_dpid', help='Deprecated. Use --config {switch_dpid: DPID}') # hidden=True +@click.option('--sdn_controller_version', help='Deprecated. Use --config {version: VERSION}') # hidden=True @click.option('--wait', required=False, default=False, is_flag=True, help='do not return the control immediately, but keep it until the operation is completed, or timeout') @click.pass_context @@ -2304,13 +2917,13 @@ def sdnc_update(ctx, **kwargs): if kwargs.get("newname"): sdncontroller["name"] = kwargs["newname"] if kwargs.get("port"): - print("option '--port' is deprecated, use '-url' instead") + print("option '--port' is deprecated, use '--url' instead") sdncontroller["port"] = int(kwargs["port"]) if kwargs.get("ip_address"): - print("option '--ip_address' is deprecated, use '-url' instead") + print("option '--ip_address' is deprecated, use '--url' instead") sdncontroller["ip"] = kwargs["ip_address"] if kwargs.get("switch_dpid"): - print("option '--switch_dpid' is deprecated, use '---config={dpid: DPID}' instead") + print("option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead") sdncontroller["dpid"] = kwargs["switch_dpid"] if kwargs.get("sdn_controller_version"): print("option '--sdn_controller_version' is deprecated, use '---config={version: SDN_CONTROLLER_VERSION}'" @@ -2345,7 +2958,7 @@ def sdnc_delete(ctx, name, force, wait): @cli_osm.command(name='sdnc-list', short_help='list all SDN controllers') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help="restricts the list to the SDN controllers matching the filter with format: 'k[.k..]=v[&k[.k]=v2]'") @click.pass_context def sdnc_list(ctx, filter): @@ -2353,6 +2966,8 @@ def sdnc_list(ctx, filter): logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) + if filter: + filter='&'.join(filter) resp = ctx.obj.sdnc.list(filter) # except ClientException as e: # print(str(e)) @@ -2391,7 +3006,7 @@ def sdnc_show(ctx, name): # K8s cluster operations ########################### -@cli_osm.command(name='k8scluster-add') +@cli_osm.command(name='k8scluster-add', short_help='adds a K8s cluster to OSM') @click.argument('name') @click.option('--creds', prompt=True, @@ -2406,7 +3021,7 @@ def sdnc_show(ctx, name): prompt=True, help='list of VIM networks, in JSON inline format, where the cluster is accessible via L3 routing, e.g. "{(k8s_net1:vim_network1) [,(k8s_net2:vim_network2) ...]}"') @click.option('--description', - default='', + default=None, help='human readable description') @click.option('--namespace', default='kube-system', @@ -2443,7 +3058,8 @@ def k8scluster_add(ctx, cluster['k8s_version'] = version cluster['vim_account'] = vim cluster['nets'] = yaml.safe_load(k8s_nets) - cluster['description'] = description + if description: + cluster['description'] = description if namespace: cluster['namespace'] = namespace if cni: cluster['cni'] = yaml.safe_load(cni) ctx.obj.k8scluster.create(name, cluster) @@ -2496,7 +3112,7 @@ def k8scluster_update(ctx, # exit(1) -@cli_osm.command(name='k8scluster-delete') +@cli_osm.command(name='k8scluster-delete', short_help='deletes a K8s cluster') @click.argument('name') @click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)') #@click.option('--wait', @@ -2517,24 +3133,46 @@ def k8scluster_delete(ctx, name, force): @cli_osm.command(name='k8scluster-list') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the K8s clusters matching the filter') @click.option('--literal', is_flag=True, help='print literally, no pretty table') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def k8scluster_list(ctx, filter, literal): +def k8scluster_list(ctx, filter, literal, long): """list all K8s clusters""" # try: check_client_version(ctx.obj, ctx.command.name) + if filter: + filter='&'.join(filter) resp = ctx.obj.k8scluster.list(filter) if literal: - print(yaml.safe_dump(resp)) + print(yaml.safe_dump(resp, indent=4, default_flow_style=False)) return - table = PrettyTable(['Name', 'Id', 'Version', 'VIM', 'K8s-nets', 'Operational State', 'Description']) + if long: + table = PrettyTable(['Name', 'Id', 'Project', 'Version', 'VIM', 'K8s-nets', + 'Operational State', 'Op. state (details)', 'Description', 'Detailed status']) + project_list = ctx.obj.project.list() + else: + table = PrettyTable(['Name', 'Id', 'VIM', 'Operational State', 'Op. state details']) for cluster in resp: - table.add_row([cluster['name'], cluster['_id'], cluster['k8s_version'], cluster['vim_account'], - json.dumps(cluster['nets']), cluster["_admin"]["operationalState"], - trunc_text(cluster.get('description',''),40)]) + op_state_details = "Helm: {}\nJuju: {}".format( + cluster["_admin"].get("helm-chart", "-").get("operationalState", "-"), + cluster["_admin"].get("juju-bundle", "-").get("operationalState", "-")) + if long: + logger.debug('Cluster details: {}'.format(yaml.safe_dump(cluster))) + project_id, project_name = get_project(project_list, cluster) + #project_info = '{} ({})'.format(project_name, project_id) + project_info = project_name + detailed_status = cluster["_admin"].get("detailed-status","-") + table.add_row([cluster['name'], cluster['_id'], project_info, + cluster['k8s_version'], cluster['vim_account'], + json.dumps(cluster['nets']), cluster["_admin"]["operationalState"], + op_state_details, trunc_text(cluster.get('description') or '', 40), + wrap_text(text=detailed_status, width=40)]) + else: + table.add_row([cluster['name'], cluster['_id'], cluster['vim_account'], + cluster["_admin"]["operationalState"], op_state_details]) table.align = 'l' print(table) # except ClientException as e: @@ -2542,7 +3180,7 @@ def k8scluster_list(ctx, filter, literal): # exit(1) -@cli_osm.command(name='k8scluster-show') +@cli_osm.command(name='k8scluster-show', short_help='shows the details of a K8s cluster') @click.argument('name') @click.option('--literal', is_flag=True, help='print literally, no pretty table') @@ -2555,7 +3193,7 @@ def k8scluster_show(ctx, name, literal): # try: resp = ctx.obj.k8scluster.get(name) if literal: - print(yaml.safe_dump(resp)) + print(yaml.safe_dump(resp, indent=4, default_flow_style=False)) return table = PrettyTable(['key', 'attribute']) for k, v in list(resp.items()): @@ -2572,49 +3210,49 @@ def k8scluster_show(ctx, name, literal): # Repo operations ########################### -@cli_osm.command(name='repo-add') +@cli_osm.command(name='repo-add', short_help='adds a repo to OSM') @click.argument('name') @click.argument('uri') @click.option('--type', - type=click.Choice(['helm-chart', 'juju-bundle']), - prompt=True, - help='type of repo (helm-chart for Helm Charts, juju-bundle for Juju Bundles)') + type=click.Choice(['helm-chart', 'juju-bundle', 'osm']), + default='osm', + help='type of repo (helm-chart for Helm Charts, juju-bundle for Juju Bundles, osm for OSM Repositories)') @click.option('--description', - default='', + default=None, help='human readable description') +@click.option('--user', + default=None, + help='OSM repository: The username of the OSM repository') +@click.option('--password', + default=None, + help='OSM repository: The password of the OSM repository') #@click.option('--wait', # is_flag=True, # help='do not return the control immediately, but keep it until the operation is completed, or timeout') @click.pass_context -def repo_add(ctx, - name, - uri, - type, - description): +def repo_add(ctx, **kwargs): """adds a repo to OSM NAME: name of the repo URI: URI of the repo """ # try: - check_client_version(ctx.obj, ctx.command.name) - repo = {} - repo['name'] = name - repo['url'] = uri - repo['type'] = type - repo['description'] = description - ctx.obj.repo.create(name, repo) + kwargs = {k: v for k, v in kwargs.items() if v is not None} + repo = kwargs + repo["url"] = repo.pop("uri") + if repo["type"] in ['helm-chart', 'juju-bundle']: + ctx.obj.repo.create(repo['name'], repo) + else: + ctx.obj.osmrepo.create(repo['name'], repo) # except ClientException as e: # print(str(e)) # exit(1) -@cli_osm.command(name='repo-update') +@cli_osm.command(name='repo-update', short_help='updates a repo in OSM') @click.argument('name') @click.option('--newname', help='New name for the repo') @click.option('--uri', help='URI of the repo') -@click.option('--type', type=click.Choice(['helm-chart', 'juju-bundle']), - help='type of repo (helm-chart for Helm Charts, juju-bundle for Juju Bundles)') @click.option('--description', help='human readable description') #@click.option('--wait', # is_flag=True, @@ -2624,7 +3262,6 @@ def repo_update(ctx, name, newname, uri, - type, description): """updates a repo in OSM @@ -2633,17 +3270,35 @@ def repo_update(ctx, # try: check_client_version(ctx.obj, ctx.command.name) repo = {} - if newname: repo['name'] = newname - if uri: repo['uri'] = uri - if type: repo['type'] = type + if newname: + repo['name'] = newname + if uri: + repo['uri'] = uri if description: repo['description'] = description - ctx.obj.repo.update(name, repo) + try: + ctx.obj.repo.update(name, repo) + except NotFound: + ctx.obj.osmrepo.update(name, repo) + # except ClientException as e: # print(str(e)) # exit(1) -@cli_osm.command(name='repo-delete') +@cli_osm.command(name='repo-index', short_help='Index a repository from a folder with artifacts') +@click.option('--origin', default='.', help='origin path where the artifacts are located') +@click.option('--destination', default='.', help='destination path where the index is deployed') +@click.pass_context +def repo_index(ctx, origin, destination): + """Index a repository + + NAME: name or ID of the repo to be deleted + """ + check_client_version(ctx.obj, ctx.command.name) + ctx.obj.osmrepo.repo_index(origin, destination) + + +@cli_osm.command(name='repo-delete', short_help='deletes a repo') @click.argument('name') @click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)') #@click.option('--wait', @@ -2655,16 +3310,18 @@ def repo_delete(ctx, name, force): NAME: name or ID of the repo to be deleted """ - # try: - check_client_version(ctx.obj, ctx.command.name) - ctx.obj.repo.delete(name, force=force) + logger.debug("") + try: + ctx.obj.repo.delete(name, force=force) + except NotFound: + ctx.obj.osmrepo.delete(name, force=force) # except ClientException as e: # print(str(e)) # exit(1) @cli_osm.command(name='repo-list') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the repos matching the filter') @click.option('--literal', is_flag=True, help='print literally, no pretty table') @@ -2672,23 +3329,28 @@ def repo_delete(ctx, name, force): def repo_list(ctx, filter, literal): """list all repos""" # try: + # K8s Repositories check_client_version(ctx.obj, ctx.command.name) + if filter: + filter='&'.join(filter) resp = ctx.obj.repo.list(filter) + resp += ctx.obj.osmrepo.list(filter) if literal: - print(yaml.safe_dump(resp)) + print(yaml.safe_dump(resp, indent=4, default_flow_style=False)) return table = PrettyTable(['Name', 'Id', 'Type', 'URI', 'Description']) for repo in resp: #cluster['k8s-nets'] = json.dumps(yaml.safe_load(cluster['k8s-nets'])) - table.add_row([repo['name'], repo['_id'], repo['type'], repo['url'], trunc_text(repo.get('description',''),40)]) + table.add_row([repo['name'], repo['_id'], repo['type'], repo['url'], trunc_text(repo.get('description') or '',40)]) table.align = 'l' print(table) + # except ClientException as e: # print(str(e)) # exit(1) -@cli_osm.command(name='repo-show') +@cli_osm.command(name='repo-show', short_help='shows the details of a repo') @click.argument('name') @click.option('--literal', is_flag=True, help='print literally, no pretty table') @@ -2698,14 +3360,20 @@ def repo_show(ctx, name, literal): NAME: name or ID of the repo """ - # try: - resp = ctx.obj.repo.get(name) + try: + resp = ctx.obj.repo.get(name) + except NotFound: + resp = ctx.obj.osmrepo.get(name) + if literal: - print(yaml.safe_dump(resp)) + if resp: + print(yaml.safe_dump(resp, indent=4, default_flow_style=False)) return table = PrettyTable(['key', 'attribute']) - for k, v in list(resp.items()): - table.add_row([k, json.dumps(v, indent=2)]) + if resp: + for k, v in list(resp.items()): + table.add_row([k, json.dumps(v, indent=2)]) + table.align = 'l' print(table) # except ClientException as e: @@ -2723,15 +3391,28 @@ def repo_show(ctx, name, literal): #@click.option('--description', # default='no description', # help='human readable description') +@click.option('--domain-name', 'domain_name', + default=None, + help='assign to a domain') +@click.option('--quotas', 'quotas', multiple=True, default=None, + help="provide quotas. Can be used several times: 'quota1=number[,quota2=number,...]'. Quotas can be one " + "of vnfds, nsds, nsts, pdus, nsrs, nsis, vim_accounts, wim_accounts, sdns, k8sclusters, k8srepos") @click.pass_context -def project_create(ctx, name): +def project_create(ctx, name, domain_name, quotas): """Creates a new project NAME: name of the project + DOMAIN_NAME: optional domain name for the project when keystone authentication is used + QUOTAS: set quotas for the project """ logger.debug("") - project = {} - project['name'] = name + project = {'name': name} + if domain_name: + project['domain_name'] = domain_name + quotas_dict = _process_project_quotas(quotas) + if quotas_dict: + project['quotas'] = quotas_dict + # try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.project.create(name, project) @@ -2740,6 +3421,20 @@ def project_create(ctx, name): # exit(1) +def _process_project_quotas(quota_list): + quotas_dict = {} + if not quota_list: + return quotas_dict + try: + for quota in quota_list: + for single_quota in quota.split(","): + k, v = single_quota.split("=") + quotas_dict[k] = None if v in ('None', 'null', '') else int(v) + except (ValueError, TypeError): + raise ClientException("invalid format for 'quotas'. Use 'k1=v1,v1=v2'. v must be a integer or null") + return quotas_dict + + @cli_osm.command(name='project-delete', short_help='deletes a project') @click.argument('name') #@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions') @@ -2759,7 +3454,7 @@ def project_delete(ctx, name): @cli_osm.command(name='project-list', short_help='list all projects') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the projects matching the filter') @click.pass_context def project_list(ctx, filter): @@ -2767,6 +3462,8 @@ def project_list(ctx, filter): logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) + if filter: + filter='&'.join(filter) resp = ctx.obj.project.list(filter) # except ClientException as e: # print(str(e)) @@ -2803,23 +3500,29 @@ def project_show(ctx, name): @cli_osm.command(name='project-update', short_help='updates a project (only the name can be updated)') @click.argument('project') -@click.option('--name', - prompt=True, +@click.option('--name', default=None, help='new name for the project') - +@click.option('--quotas', 'quotas', multiple=True, default=None, + help="change quotas. Can be used several times: 'quota1=number|empty[,quota2=...]' " + "(use empty to reset quota to default") @click.pass_context -def project_update(ctx, project, name): +def project_update(ctx, project, name, quotas): """ Update a project name :param ctx: :param project: id or name of the project to modify :param name: new name for the project + :param quotas: change quotas of the project :return: """ logger.debug("") project_changes = {} - project_changes['name'] = name + if name: + project_changes['name'] = name + quotas_dict = _process_project_quotas(quotas) + if quotas_dict: + project_changes['quotas'] = quotas_dict # try: check_client_version(ctx.obj, ctx.command.name) @@ -2846,9 +3549,12 @@ def project_update(ctx, project, name): help='list of project ids that the user belongs to') @click.option('--project-role-mappings', 'project_role_mappings', default=None, multiple=True, - help='creating user project/role(s) mapping') + help="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'") +@click.option('--domain-name', 'domain_name', + default=None, + help='assign to a domain') @click.pass_context -def user_create(ctx, username, password, projects, project_role_mappings): +def user_create(ctx, username, password, projects, project_role_mappings, domain_name): """Creates a new user \b @@ -2856,6 +3562,7 @@ def user_create(ctx, username, password, projects, project_role_mappings): PASSWORD: password of the user PROJECTS: projects assigned to user (internal only) PROJECT_ROLE_MAPPING: roles in projects assigned to user (keystone) + DOMAIN_NAME: optional domain name for the user when keystone authentication is used """ logger.debug("") user = {} @@ -2863,7 +3570,9 @@ def user_create(ctx, username, password, projects, project_role_mappings): user['password'] = password user['projects'] = projects user['project_role_mappings'] = project_role_mappings - + if domain_name: + user['domain_name'] = domain_name + # try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.user.create(username, user) @@ -2884,16 +3593,16 @@ def user_create(ctx, username, password, projects, project_role_mappings): help='change username') @click.option('--set-project', 'set_project', default=None, multiple=True, - help='create/replace the project,role(s) mapping for this project: \'project,role1,role2,...\'') + help="create/replace the roles for this project: 'project,role1[,role2,...]'") @click.option('--remove-project', 'remove_project', default=None, multiple=True, - help='removes project from user: \'project\'') + help="removes project from user: 'project'") @click.option('--add-project-role', 'add_project_role', default=None, multiple=True, - help='adds project,role(s) mapping: \'project,role1,role2,...\'') + help="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'") @click.option('--remove-project-role', 'remove_project_role', default=None, multiple=True, - help='removes project,role(s) mapping: \'project,role1,role2,...\'') + help="remove role(s) in a project. Can be used several times: 'project,role1[,role2,...]'") @click.pass_context def user_update(ctx, username, password, set_username, set_project, remove_project, add_project_role, remove_project_role): @@ -2945,13 +3654,15 @@ def user_delete(ctx, name): @cli_osm.command(name='user-list', short_help='list all users') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the users matching the filter') @click.pass_context def user_list(ctx, filter): """list all users""" # try: check_client_version(ctx.obj, ctx.command.name) + if filter: + filter='&'.join(filter) resp = ctx.obj.user.list(filter) # except ClientException as e: # print(str(e)) @@ -3101,9 +3812,10 @@ def ns_metric_export(ctx, ns, vnf, vdu, metric, interval): # Other operations #################### -@cli_osm.command(name='version') +@cli_osm.command(name='version', short_help='shows client and server versions') @click.pass_context def get_version(ctx): + """shows client and server versions""" # try: check_client_version(ctx.obj, "version") print ("Server version: {}".format(ctx.obj.get_version())) @@ -3114,15 +3826,17 @@ def get_version(ctx): @cli_osm.command(name='upload-package', short_help='uploads a VNF package or NS package') @click.argument('filename') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='the charm will not be compiled, it is assumed to already exist') @click.pass_context -def upload_package(ctx, filename): - """uploads a VNF package or NS package +def upload_package(ctx, filename, skip_charm_build): + """uploads a vnf package or ns package - FILENAME: VNF or NS package file (tar.gz) + filename: vnf or ns package folder, or vnf or ns package file (tar.gz) """ logger.debug("") # try: - ctx.obj.package.upload(filename) + ctx.obj.package.upload(filename, skip_charm_build=skip_charm_build) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname != 'osmclient.sol005.client.Client': ctx.obj.package.wait_for_upload(filename) @@ -3286,10 +4000,11 @@ def upload_package(ctx, filename): @click.option('--vnf_name', default=None, help='member-vnf-index if the target is a vnf instead of a ns)') @click.option('--kdu_name', default=None, help='kdu-name if the target is a kdu)') @click.option('--vdu_id', default=None, help='vdu-id if the target is a vdu') -@click.option('--vdu_count', default=None, help='number of vdu instance of this vdu_id') +@click.option('--vdu_count', default=None, type=int, help='number of vdu instance of this vdu_id') @click.option('--action_name', prompt=True, help='action name') @click.option('--params', default=None, help='action params in YAML/JSON inline string') @click.option('--params_file', default=None, help='YAML/JSON file with action params') +@click.option('--timeout', required=False, default=None, type=int, help='timeout in seconds') @click.option('--wait', required=False, default=False, @@ -3305,6 +4020,7 @@ def ns_action(ctx, action_name, params, params_file, + timeout, wait): """executes an action/primitive over a NS instance @@ -3320,8 +4036,10 @@ def ns_action(ctx, op_data['kdu_name'] = kdu_name if vdu_id: op_data['vdu_id'] = vdu_id - if vdu_count: + if vdu_count is not None: op_data['vdu_count_index'] = vdu_count + if timeout: + op_data['timeout_ns_action'] = timeout op_data['primitive'] = action_name if params_file: with open(params_file, 'r') as pf: @@ -3343,13 +4061,18 @@ def ns_action(ctx, @click.option('--scaling-group', prompt=True, help="scaling-group-descriptor name to use") @click.option('--scale-in', default=False, is_flag=True, help="performs a scale in operation") @click.option('--scale-out', default=False, is_flag=True, help="performs a scale out operation (by default)") +@click.option('--timeout', required=False, default=None, type=int, help='timeout in seconds') +@click.option('--wait', required=False, default=False, is_flag=True, + help='do not return the control immediately, but keep it until the operation is completed, or timeout') @click.pass_context def vnf_scale(ctx, ns_name, vnf_name, scaling_group, scale_in, - scale_out): + scale_out, + timeout, + wait): """ Executes a VNF scale (adding/removing VDUs) @@ -3362,7 +4085,7 @@ def vnf_scale(ctx, check_client_version(ctx.obj, ctx.command.name) if not scale_in and not scale_out: scale_out = True - ctx.obj.ns.scale_vnf(ns_name, vnf_name, scaling_group, scale_in, scale_out) + ctx.obj.ns.scale_vnf(ns_name, vnf_name, scaling_group, scale_in, scale_out, wait, timeout) # except ClientException as e: # print(str(e)) # exit(1) @@ -3450,7 +4173,7 @@ def role_delete(ctx, name): @cli_osm.command(name='role-list', short_help='list all roles') -@click.option('--filter', default=None, +@click.option('--filter', default=None, multiple=True, help='restricts the list to the projects matching the filter') @click.pass_context def role_list(ctx, filter): @@ -3460,6 +4183,8 @@ def role_list(ctx, filter): logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) + if filter: + filter='&'.join(filter) resp = ctx.obj.role.list(filter) # except ClientException as e: # print(str(e)) @@ -3589,9 +4314,14 @@ def package_create(ctx, @click.argument('base-directory', default=".", required=False) +@click.option('--recursive/--no-recursive', + default=True, + help='The activated recursive option will validate the yaml files' + ' within the indicated directory and in its subdirectories') @click.pass_context def package_validate(ctx, - base_directory): + base_directory, + recursive): """ Validate descriptors given a base directory. @@ -3600,7 +4330,7 @@ def package_validate(ctx, """ # try: check_client_version(ctx.obj, ctx.command.name) - results = ctx.obj.package_tool.validate(base_directory) + results = ctx.obj.package_tool.validate(base_directory, recursive) table = PrettyTable() table.field_names = ["TYPE", "PATH", "VALID", "ERROR"] # Print the dictionary generated by the validation function @@ -3622,10 +4352,13 @@ def package_validate(ctx, default=False, is_flag=True, help='skip package validation') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='the charm will not be compiled, it is assumed to already exist') @click.pass_context def package_build(ctx, package_folder, - skip_validation): + skip_validation, + skip_charm_build): """ Build the package NS, VNF given the package_folder. @@ -3634,7 +4367,9 @@ def package_build(ctx, """ # try: check_client_version(ctx.obj, ctx.command.name) - results = ctx.obj.package_tool.build(package_folder, skip_validation) + results = ctx.obj.package_tool.build(package_folder, + skip_validation=skip_validation, + skip_charm_build=skip_charm_build) print(results) # except ClientException as inst: # print("ERROR: {}".format(inst)) @@ -3644,13 +4379,17 @@ def package_build(ctx, def cli(): try: cli_osm() + exit(0) except pycurl.error as exc: print(exc) print('Maybe "--hostname" option or OSM_HOSTNAME environment variable needs to be specified') - exit(1) except ClientException as exc: print("ERROR: {}".format(exc)) - exit(1) + except (FileNotFoundError, PermissionError) as exc: + print("Cannot open file: {}".format(exc)) + except yaml.YAMLError as exc: + print("Invalid YAML format: {}".format(exc)) + exit(1) # TODO capture other controlled exceptions here # TODO remove the ClientException captures from all places, unless they do something different