import time
import pycurl
import os
+import textwrap
+import pkg_resources
+
+
+def wrap_text(text, width):
+ wrapper = textwrap.TextWrapper(width=width)
+ lines = text.splitlines()
+ return "\n".join(map(wrapper.fill, lines))
+
+
+def trunc_text(text, length):
+ if len(text) > length:
+ return text[:(length - 3)] + '...'
+ else:
+ return text
def check_client_version(obj, what, version='sol005'):
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,
print(str(e))
exit(1)
- table = PrettyTable(['id', 'operation', 'status'])
+ table = PrettyTable(['id', 'operation', 'action_name', 'status'])
+ #print(yaml.safe_dump(resp))
for op in resp:
- table.add_row([op['id'], op['lcmOperationType'],
+ action_name = "N/A"
+ if op['lcmOperationType']=='action':
+ action_name = op['operationParams']['primitive']
+ table.add_row([op['id'], op['lcmOperationType'], action_name,
op['operationState']])
table.align = 'l'
print(table)
for k, v in list(ns.items()):
if filter is None or filter in k:
- table.add_row([k, json.dumps(v, indent=2)])
+ table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)])
fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
if fullclassname != 'osmclient.sol005.client.Client':
nsr_optdata = nsopdata['nsr:nsr']
for k, v in list(nsr_optdata.items()):
if filter is None or filter in k:
- table.add_row([k, json.dumps(v, indent=2)])
+ table.add_row([k, wrap_text(json.dumps(v, indent=2),width=100)])
table.align = 'l'
print(table)
@click.argument('name')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
-@click.option('--filter', default=None)
+@click.option('--filter', default=None, 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):
+def vnf_show(ctx, name, literal, filter, kdu):
"""shows the info of a VNF instance
NAME: name or ID of the VNF instance
"""
+ if kdu:
+ if literal:
+ raise ClientException('"--literal" option is incompatible with "--kdu" option')
+ if filter:
+ raise ClientException('"--filter" option is incompatible with "--kdu" option')
+
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.vnf.get(name)
+
+ if kdu:
+ ns_id = resp['nsr-id-ref']
+ op_data={}
+ op_data['member_vnf_index'] = resp['member-vnf-index-ref']
+ op_data['kdu_name'] = kdu
+ op_data['primitive'] = 'status'
+ op_data['primitive_params'] = {}
+ op_id = ctx.obj.ns.exec_op(ns_id, op_name='action', op_data=op_data, wait=False)
+ t = 0
+ while t<30:
+ op_info = ctx.obj.ns.get_op(op_id)
+ if op_info['operationState'] == 'COMPLETED':
+ print(op_info['detailed-status'])
+ return
+ time.sleep(5)
+ t += 5
+ print ("Could not determine KDU status")
+
+ if literal:
+ print(yaml.safe_dump(resp))
+ return
+
+ table = PrettyTable(['field', 'value'])
+
+ for k, v in list(resp.items()):
+ if filter is None or filter in k:
+ table.add_row([k, wrap_text(text=json.dumps(v,indent=2),width=100)])
+ table.align = 'l'
+ print(table)
except ClientException as e:
print(str(e))
exit(1)
- if literal:
- print(yaml.safe_dump(resp))
- return
-
- table = PrettyTable(['field', 'value'])
- for k, v in list(resp.items()):
- if filter is None or filter in k:
- table.add_row([k, json.dumps(v, indent=2)])
- table.align = 'l'
- print(table)
-
#@cli.command(name='vnf-monitoring-show')
#@click.argument('vnf_name')
@cli.command(name='ns-op-show', short_help='shows the info of a NS operation')
@click.argument('id')
@click.option('--filter', default=None)
+@click.option('--literal', is_flag=True,
+ help='print literally, no pretty table')
@click.pass_context
-def ns_op_show(ctx, id, filter):
+def ns_op_show(ctx, id, filter, literal):
"""shows the detailed info of a NS operation
ID: operation identifier
print(str(e))
exit(1)
+ if literal:
+ print(yaml.safe_dump(op_info))
+ return
+
table = PrettyTable(['field', 'value'])
for k, v in list(op_info.items()):
if filter is None or filter in k:
- table.add_row([k, json.dumps(v, indent=2)])
+ table.add_row([k, wrap_text(json.dumps(v, indent=2), 100)])
table.align = 'l'
print(table)
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(json.dumps(v, indent=2), 100)])
table.align = 'l'
print(table)
@cli.command(name='nsd-create', short_help='creates a new NSD/NSpkg')
@click.argument('filename')
-@click.option('--overwrite', 'overwrite', default=None,
- help='overwrite deprecated, use override')
+@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;...]"')
@cli.command(name='nspkg-create', short_help='creates a new NSD/NSpkg')
@click.argument('filename')
-@click.option('--overwrite', 'overwrite', default=None,
- help='overwrite deprecated, use override')
+@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;...]"')
@cli.command(name='vnfpkg-create', short_help='creates a new VNFD/VNFpkg')
@click.argument('filename')
-@click.option('--overwrite', 'overwrite', default=None,
- help='overwrite deprecated, use override')
+@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;...]"')
@cli.command(name='nfpkg-create', short_help='creates a new NFpkg')
@click.argument('filename')
-@click.option('--overwrite', 'overwrite', default=None,
- help='overwrite deprecated, use override')
+@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;...]"')
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def ns_create(ctx,
nsd_name,
@cli.command(name='nst-create', short_help='creates a new Network Slice Template (NST)')
@click.argument('filename')
-@click.option('--overwrite', 'overwrite', default=None,
- help='overwrites deprecated use override')
-@click.option('--override', 'overwrite' ,default=None,
+@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.pass_context
@cli.command(name='netslice-template-create', short_help='creates a new Network Slice Template (NST)')
@click.argument('filename')
-@click.option('--overwrite', 'overwrite', default=None,
- help='overwrites deprecated use override')
+@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;...]"')
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def nsi_create1(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait):
"""creates a new Network Slice Instance (NSI)"""
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def nsi_create2(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait):
"""creates a new Network Slice Instance (NSI)"""
multiple=True)
@click.option('--description', help='human readable description')
@click.option('--vim_account', help='list of VIM accounts (in the same VIM) that can reach this PDU', multiple=True)
-@click.option('--descriptor_file', default=None, help='PDU descriptor file (as an alternative to using the other arguments')
+@click.option('--descriptor_file', default=None,
+ help='PDU descriptor file (as an alternative to using the other arguments')
@click.pass_context
def pdu_create(ctx, name, pdu_type, interface, description, vim_account, descriptor_file):
"""creates a new Physical Deployment Unit (PDU)"""
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ 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):
"""deletes a NS instance
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def nsi_delete1(ctx, name, force, wait):
"""deletes a Network Slice Instance (NSI)
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def vim_create(ctx,
name,
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def vim_update(ctx,
name,
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def vim_delete(ctx, name, force, wait):
"""deletes a VIM account
table = PrettyTable(['key', 'attribute'])
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)
@click.option('--description',
default='no description',
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 (WAN service endpoint id and info)")
+@click.option('--wim_port_mapping', default=None,
+ help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
+ "(WAN service endpoint id and info)")
@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')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def wim_create(ctx,
name,
@click.option('--config', help='WIM specific config parameters')
@click.option('--wim_type', help='WIM type')
@click.option('--description', 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 (WAN service endpoint id and info)")
+@click.option('--wim_port_mapping', default=None,
+ help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
+ "(WAN service endpoint id and info)")
@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')
+ help='do not return the control immediately, but keep it until the operation is completed, or timeout')
@click.pass_context
def wim_update(ctx,
name,
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it until the operation is completed, or timeout')
@click.pass_context
def wim_delete(ctx, name, force, wait):
"""deletes a WIM account
@click.option('--type',
prompt=True,
help='SDN controller type')
-@click.option('--sdn_controller_version',
- help='SDN controller version')
-@click.option('--ip_address',
- prompt=True,
- help='SDN controller IP address')
-@click.option('--port',
- prompt=True,
- help='SDN controller port')
-@click.option('--switch_dpid',
- prompt=True,
- help='Switch DPID (Openflow Datapath ID)')
+@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,
+ help='Deprecated. Use --url')
+@click.option('--port', hidden=True,
+ help='Deprecated. Use --url')
+@click.option('--switch_dpid', hidden=True,
+ help='Deprecated. Use --config {dpid: DPID}')
+@click.option('--config',
+ help='Extra information for SDN in yaml format, as {dpid: (Openflow Datapath ID), version: version}')
@click.option('--user',
help='SDN controller username')
@click.option('--password',
hide_input=True,
confirmation_prompt=True,
help='SDN controller password')
-#@click.option('--description',
-# default='no description',
-# help='human readable description')
+@click.option('--description', default=None, help='human readable description')
@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 sdnc_create(ctx,
- name,
- type,
- sdn_controller_version,
- ip_address,
- port,
- switch_dpid,
- user,
- password,
- wait):
+ help="do not return the control immediately, but keep it until the operation is completed, or timeout")
+@click.pass_context
+def sdnc_create(ctx, **kwargs):
"""creates a new SDN controller"""
- sdncontroller = {}
- sdncontroller['name'] = name
- sdncontroller['type'] = type
- sdncontroller['ip'] = ip_address
- sdncontroller['port'] = int(port)
- sdncontroller['dpid'] = switch_dpid
- if sdn_controller_version:
- sdncontroller['version'] = sdn_controller_version
- if user:
- sdncontroller['user'] = user
- if password:
- sdncontroller['password'] = password
-# sdncontroller['description'] = description
+ 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")
+ sdncontroller["port"] = int(kwargs["port"])
+ if kwargs.get("ip_address"):
+ 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")
+ sdncontroller["dpid"] = kwargs["switch_dpid"]
+ if kwargs.get("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)
- ctx.obj.sdnc.create(name, sdncontroller, wait=wait)
+ ctx.obj.sdnc.create(kwargs["name"], sdncontroller, wait=kwargs["wait"])
except ClientException as e:
print(str(e))
exit(1)
@cli.command(name='sdnc-update', short_help='updates an SDN controller')
@click.argument('name')
@click.option('--newname', help='New name for the SDN controller')
+@click.option('--description', default=None, help='human readable description')
@click.option('--type', help='SDN controller type')
-@click.option('--sdn_controller_version', help='SDN controller username')
-@click.option('--ip_address', help='SDN controller IP address')
-@click.option('--port', help='SDN controller port')
-@click.option('--switch_dpid', help='Switch DPID (Openflow Datapath ID)')
+@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}')
@click.option('--user', help='SDN controller username')
@click.option('--password', help='SDN controller password')
-#@click.option('--description', default=None, help='human readable description')
-@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 sdnc_update(ctx,
- name,
- newname,
- type,
- sdn_controller_version,
- ip_address,
- port,
- switch_dpid,
- user,
- password,
- wait):
+@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('--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 sdnc_update(ctx, **kwargs):
"""updates an SDN controller
NAME: name or ID of the SDN controller
"""
- sdncontroller = {}
- if newname: sdncontroller['name'] = newname
- if type: sdncontroller['type'] = type
- if ip_address: sdncontroller['ip'] = ip_address
- if port: sdncontroller['port'] = int(port)
- if switch_dpid: sdncontroller['dpid'] = switch_dpid
-# sdncontroller['description'] = description
- if sdn_controller_version is not None:
- if sdn_controller_version=="":
- sdncontroller['version'] = None
- else:
- sdncontroller['version'] = sdn_controller_version
- if user is not None:
- if user=="":
- sdncontroller['user'] = None
- else:
- sdncontroller['user'] = user
- if password is not None:
- if password=="":
- sdncontroller['password'] = None
- else:
- sdncontroller['password'] = user
+ sdncontroller = {x: kwargs[x] for x in kwargs if kwargs[x] and
+ x not in ("wait", "ip_address", "port", "switch_dpid", "new_name")}
+ if kwargs.get("newname"):
+ sdncontroller["name"] = kwargs["newname"]
+ if kwargs.get("port"):
+ 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")
+ sdncontroller["ip"] = kwargs["ip_address"]
+ if kwargs.get("switch_dpid"):
+ print("option '--switch_dpid' is deprecated, use '---config={dpid: 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}'"
+ " instead")
+
try:
check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.sdnc.update(name, sdncontroller, wait=wait)
+ ctx.obj.sdnc.update(kwargs["name"], sdncontroller, wait=kwargs["wait"])
except ClientException as e:
print(str(e))
exit(1)
@cli.command(name='sdnc-delete', short_help='deletes an SDN controller')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
-@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.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 sdnc_delete(ctx, name, force, wait):
"""deletes an SDN controller
@cli.command(name='sdnc-list', short_help='list all SDN controllers')
@click.option('--filter', default=None,
- help='restricts the list to the SDN controllers matching the filter')
+ 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):
"""list all SDN controllers"""
print(table)
+###########################
+# K8s cluster operations
+###########################
+
+@cli.command(name='k8scluster-add')
+@click.argument('name')
+@click.option('--creds',
+ prompt=True,
+ help='credentials file, i.e. a valid `.kube/config` file')
+@click.option('--version',
+ prompt=True,
+ help='Kubernetes version')
+@click.option('--vim',
+ prompt=True,
+ help='VIM target, the VIM where the cluster resides')
+@click.option('--k8s-nets',
+ 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='',
+ help='human readable description')
+@click.option('--namespace',
+ default='kube-system',
+ help='namespace to be used for its operation, defaults to `kube-system`')
+@click.option('--cni',
+ default=None,
+ help='list of CNI plugins, in JSON inline format, used in the cluster')
+#@click.option('--skip-init',
+# is_flag=True,
+# help='If set, K8s cluster is assumed to be ready for its use with OSM')
+#@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 k8scluster_add(ctx,
+ name,
+ creds,
+ version,
+ vim,
+ k8s_nets,
+ description,
+ namespace,
+ cni):
+ """adds a K8s cluster to OSM
+
+ NAME: name of the K8s cluster
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ cluster = {}
+ cluster['name'] = name
+ with open(creds, 'r') as cf:
+ cluster['credentials'] = yaml.safe_load(cf.read())
+ cluster['k8s_version'] = version
+ cluster['vim_account'] = vim
+ cluster['nets'] = yaml.safe_load(k8s_nets)
+ cluster['description'] = description
+ if namespace: cluster['namespace'] = namespace
+ if cni: cluster['cni'] = yaml.safe_load(cni)
+ ctx.obj.k8scluster.create(name, cluster)
+ except ClientException as e:
+ print(str(e))
+ exit(1)
+
+
+@cli.command(name='k8scluster-update', short_help='updates a K8s cluster')
+@click.argument('name')
+@click.option('--newname', help='New name for the K8s cluster')
+@click.option('--creds', help='credentials file, i.e. a valid `.kube/config` file')
+@click.option('--version', help='Kubernetes version')
+@click.option('--vim', help='VIM target, the VIM where the cluster resides')
+@click.option('--k8s-nets', 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', help='human readable description')
+@click.option('--namespace', help='namespace to be used for its operation, defaults to `kube-system`')
+@click.option('--cni', help='list of CNI plugins, in JSON inline format, used in the cluster')
+@click.pass_context
+def k8scluster_update(ctx,
+ name,
+ newname,
+ creds,
+ version,
+ vim,
+ k8s_nets,
+ description,
+ namespace,
+ cni):
+ """updates a K8s cluster
+
+ NAME: name or ID of the K8s cluster
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ cluster = {}
+ if newname: cluster['name'] = newname
+ if creds:
+ with open(creds, 'r') as cf:
+ cluster['credentials'] = yaml.safe_load(cf.read())
+ if version: cluster['k8s_version'] = version
+ if vim: cluster['vim_account'] = vim
+ if k8s_nets: cluster['nets'] = yaml.safe_load(k8s_nets)
+ if description: cluster['description'] = description
+ if namespace: cluster['namespace'] = namespace
+ if cni: cluster['cni'] = yaml.safe_load(cni)
+ ctx.obj.k8scluster.update(name, cluster)
+ except ClientException as e:
+ print(str(e))
+ exit(1)
+
+
+@cli.command(name='k8scluster-delete')
+@click.argument('name')
+@click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)')
+#@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 k8scluster_delete(ctx, name, force):
+ """deletes a K8s cluster
+
+ NAME: name or ID of the K8s cluster to be deleted
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.k8scluster.delete(name, force=force)
+ except ClientException as e:
+ print(str(e))
+ exit(1)
+
+
+@cli.command(name='k8scluster-list')
+@click.option('--filter', default=None,
+ help='restricts the list to the K8s clusters matching the filter')
+@click.option('--literal', is_flag=True,
+ help='print literally, no pretty table')
+@click.pass_context
+def k8scluster_list(ctx, filter, literal):
+ """list all K8s clusters"""
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.k8scluster.list(filter)
+ if literal:
+ print(yaml.safe_dump(resp))
+ return
+ table = PrettyTable(['Name', 'Id', 'Version', 'VIM', 'K8s-nets', 'Operational State', 'Description'])
+ 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)])
+ table.align = 'l'
+ print(table)
+ except ClientException as e:
+ print(str(e))
+ exit(1)
+
+
+@cli.command(name='k8scluster-show')
+@click.argument('name')
+@click.option('--literal', is_flag=True,
+ help='print literally, no pretty table')
+@click.pass_context
+def k8scluster_show(ctx, name, literal):
+ """shows the details of a K8s cluster
+
+ NAME: name or ID of the K8s cluster
+ """
+ try:
+ resp = ctx.obj.k8scluster.get(name)
+ if literal:
+ print(yaml.safe_dump(resp))
+ return
+ 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)])
+ table.align = 'l'
+ print(table)
+ except ClientException as e:
+ print(str(e))
+ exit(1)
+
+
+
+###########################
+# Repo operations
+###########################
+
+@cli.command(name='repo-add')
+@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)')
+@click.option('--description',
+ default='',
+ help='human readable description')
+#@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):
+ """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)
+ except ClientException as e:
+ print(str(e))
+ exit(1)
+
+
+@cli.command(name='repo-update')
+@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,
+# help='do not return the control immediately, but keep it until the operation is completed, or timeout')
+@click.pass_context
+def repo_update(ctx,
+ name,
+ newname,
+ uri,
+ type,
+ description):
+ """updates a repo in OSM
+
+ NAME: name of the repo
+ """
+ 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 description: repo['description'] = description
+ ctx.obj.repo.update(name, repo)
+ except ClientException as e:
+ print(str(e))
+ exit(1)
+
+
+@cli.command(name='repo-delete')
+@click.argument('name')
+@click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)')
+#@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_delete(ctx, name, force):
+ """deletes a repo
+
+ 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)
+ except ClientException as e:
+ print(str(e))
+ exit(1)
+
+
+@cli.command(name='repo-list')
+@click.option('--filter', default=None,
+ help='restricts the list to the repos matching the filter')
+@click.option('--literal', is_flag=True,
+ help='print literally, no pretty table')
+@click.pass_context
+def repo_list(ctx, filter, literal):
+ """list all repos"""
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.repo.list(filter)
+ if literal:
+ print(yaml.safe_dump(resp))
+ 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.align = 'l'
+ print(table)
+ except ClientException as e:
+ print(str(e))
+ exit(1)
+
+
+@cli.command(name='repo-show')
+@click.argument('name')
+@click.option('--literal', is_flag=True,
+ help='print literally, no pretty table')
+@click.pass_context
+def repo_show(ctx, name, literal):
+ """shows the details of a repo
+
+ NAME: name or ID of the repo
+ """
+ try:
+ resp = ctx.obj.repo.get(name)
+ if literal:
+ print(yaml.safe_dump(resp))
+ return
+ table = PrettyTable(['key', 'attribute'])
+ 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:
+ print(str(e))
+ exit(1)
+
+
+
####################
# Project mgmt operations
####################
# Other operations
####################
+@cli.command(name='version')
+@click.pass_context
+def get_version(ctx):
+ try:
+ check_client_version(ctx.obj, "version")
+ print ("Server version: {}".format(ctx.obj.get_version()))
+ print ("Client version: {}".format(pkg_resources.get_distribution("osmclient").version))
+ except ClientException as e:
+ print(str(e))
+ exit(1)
+
@cli.command(name='upload-package', short_help='uploads a VNF package or NS package')
@click.argument('filename')
@click.pass_context
@cli.command(name='ns-action', short_help='executes an action/primitive over a NS instance')
@click.argument('ns_name')
@click.option('--vnf_name', default=None, help='member-vnf-index if the target is a vnf instead of a ns)')
-@click.option('--vdu_id', default=None, help='vdu-id if the target is a vdu o a vnf')
+@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('--action_name', prompt=True)
-@click.option('--params', default=None)
+@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('--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')
+ help='do not return the control immediately, but keep it until the operation is completed, or timeout')
@click.pass_context
def ns_action(ctx,
ns_name,
vnf_name,
+ kdu_name,
vdu_id,
vdu_count,
action_name,
params,
+ params_file,
wait):
"""executes an action/primitive over a NS instance
op_data = {}
if vnf_name:
op_data['member_vnf_index'] = vnf_name
+ if kdu_name:
+ op_data['kdu_name'] = kdu_name
if vdu_id:
op_data['vdu_id'] = vdu_id
if vdu_count:
op_data['vdu_count_index'] = vdu_count
op_data['primitive'] = action_name
+ if params_file:
+ with open(params_file, 'r') as pf:
+ params = pf.read()
if params:
op_data['primitive_params'] = yaml.safe_load(params)
else:
op_data['primitive_params'] = {}
- ctx.obj.ns.exec_op(ns_name, op_name='action', op_data=op_data, wait=wait)
+ print(ctx.obj.ns.exec_op(ns_name, op_name='action', op_data=op_data, wait=wait))
except ClientException as e:
print(str(e))
table.align = 'l'
print(table)
+
+@cli.command(name='package-create',
+ short_help='Create a package descriptor')
+@click.argument('package-type')
+@click.argument('package-name')
+@click.option('--base-directory',
+ default='.',
+ help=('(NS/VNF/NST) Set the location for package creation. Default: "."'))
+@click.option('--image',
+ default="image-name",
+ help='(VNF) Set the name of the vdu image. Default "image-name"')
+@click.option('--vdus',
+ default=1,
+ help='(VNF) Set the number of vdus in a VNF. Default 1')
+@click.option('--vcpu',
+ default=1,
+ help='(VNF) Set the number of virtual CPUs in a vdu. Default 1')
+@click.option('--memory',
+ default=1024,
+ help='(VNF) Set the memory size (MB) of the vdu. Default 1024')
+@click.option('--storage',
+ default=10,
+ help='(VNF) Set the disk size (GB) of the vdu. Default 10')
+@click.option('--interfaces',
+ default=0,
+ help='(VNF) Set the number of additional interfaces apart from the management interface. Default 0')
+@click.option('--vendor',
+ default="OSM",
+ help='(NS/VNF) Set the descriptor vendor. Default "OSM"')
+@click.option('--override',
+ default=False,
+ is_flag=True,
+ help='(NS/VNF/NST) Flag for overriding the package if exists.')
+@click.option('--detailed',
+ is_flag=True,
+ default=False,
+ help='(NS/VNF/NST) Flag for generating descriptor .yaml with all possible commented options')
+@click.option('--netslice-subnets',
+ default=1,
+ help='(NST) Number of netslice subnets. Default 1')
+@click.option('--netslice-vlds',
+ default=1,
+ help='(NST) Number of netslice vlds. Default 1')
+@click.pass_context
+def package_create(ctx,
+ package_type,
+ base_directory,
+ package_name,
+ override,
+ image,
+ vdus,
+ vcpu,
+ memory,
+ storage,
+ interfaces,
+ vendor,
+ detailed,
+ netslice_subnets,
+ netslice_vlds):
+ """
+ Creates an OSM NS, VNF, NST package
+
+ \b
+ PACKAGE_TYPE: Package to be created: NS, VNF or NST.
+ PACKAGE_NAME: Name of the package to create the folder with the content.
+ """
+
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ print("Creating the {} structure: {}/{}".format(package_type.upper(), base_directory, package_name))
+ resp = ctx.obj.package_tool.create(package_type,
+ base_directory,
+ package_name,
+ override=override,
+ image=image,
+ vdus=vdus,
+ vcpu=vcpu,
+ memory=memory,
+ storage=storage,
+ interfaces=interfaces,
+ vendor=vendor,
+ detailed=detailed,
+ netslice_subnets=netslice_subnets,
+ netslice_vlds=netslice_vlds)
+ print(resp)
+ except ClientException as inst:
+ print("ERROR: {}".format(inst))
+ exit(1)
+
+@cli.command(name='package-validate',
+ short_help='Validate a package descriptor')
+@click.argument('base-directory',
+ default=".",
+ required=False)
+@click.pass_context
+def package_validate(ctx,
+ base_directory):
+ """
+ Validate descriptors given a base directory.
+
+ \b
+ BASE_DIRECTORY: Stub folder for NS, VNF or NST package.
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ results = ctx.obj.package_tool.validate(base_directory)
+ table = PrettyTable()
+ table.field_names = ["TYPE", "PATH", "VALID", "ERROR"]
+ # Print the dictionary generated by the validation function
+ for result in results:
+ table.add_row([result["type"], result["path"], result["valid"], result["error"]])
+ table.sortby = "VALID"
+ table.align["PATH"] = "l"
+ table.align["TYPE"] = "l"
+ table.align["ERROR"] = "l"
+ print(table)
+ except ClientException as inst:
+ print("ERROR: {}".format(inst))
+ exit(1)
+
+@cli.command(name='package-build',
+ short_help='Build the tar.gz of the package')
+@click.argument('package-folder')
+@click.option('--skip-validation',
+ default=False,
+ is_flag=True,
+ help='skip package validation')
+@click.pass_context
+def package_build(ctx,
+ package_folder,
+ skip_validation):
+ """
+ Build the package NS, VNF given the package_folder.
+
+ \b
+ PACKAGE_FOLDER: Folder of the NS, VNF or NST to be packaged
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ results = ctx.obj.package_tool.build(package_folder, skip_validation)
+ print(results)
+ except ClientException as inst:
+ print("ERROR: {}".format(inst))
+ exit(1)
+
+
if __name__ == '__main__':
try:
cli()
projects / osm / osmclient.git / blobdiff