onapsdk.msb.k8s package

Submodules

onapsdk.msb.k8s.connectivity_info module

Connectivity-Info module.

class onapsdk.msb.k8s.connectivity_info.ConnectivityInfo(cloud_region_id, cloud_owner, other_connectivity_list, kubeconfig)

Bases: onapsdk.msb.msb_service.MSB

Connectivity-Info class.

api_version = '/api/multicloud-k8s/v1/v1'
classmethod create(cloud_region_id, cloud_owner, kubeconfig=None)

Create Connectivity Info.

Parameters

  • cloud_region_id (str) – Cloud region ID

  • cloud_owner (str) – Cloud owner name

  • kubeconfig (bytes) – kubernetes cluster kubeconfig file

Returns

Created object

Return type

ConnectivityInfo

delete()

Delete connectivity info.

Return type

None

classmethod get_connectivity_info_by_region_id(cloud_region_id)

Get connectivity-info by its name (cloud region id).

Parameters

cloud_region_id (str) – Cloud region ID

Returns

Connectivity-Info object

Return type

ConnectivityInfo

url = 'https://msb.api.simpledemo.onap.org:30283/api/multicloud-k8s/v1/v1/connectivity-info'

onapsdk.msb.k8s.definition module

Definition module.

class onapsdk.msb.k8s.definition.ConfigurationTemplate(rb_name, rb_version, template_name, description='')

Bases: onapsdk.msb.k8s.definition.DefinitionBase

ConfigurationTemplate class.

property url

URL address for ConfigurationTemplate calls.

Returns

URL to Configuration template in Multicloud-k8s API.

Return type

str

class onapsdk.msb.k8s.definition.Definition(rb_name, rb_version, chart_name, description, labels)

Bases: onapsdk.msb.k8s.definition.DefinitionBase

Definition class.

classmethod create(rb_name, rb_version, chart_name='', description='', labels=None)

Create Definition.

Parameters

  • rb_name (str) – Definition name

  • rb_version (str) – Definition version

  • chart_name (str) – Chart name, optional field, will be detected if it is not provided

  • description (str) – Definition description

  • labels (str) – Labels

Returns

Created object

Return type

Definition

create_configuration_template(template_name, description='')

Create configuration template.

Parameters

  • template_name (str) – Name of the template

  • description (str) – Description

Returns

Created object

Return type

ConfigurationTemplate

create_profile(profile_name, namespace, kubernetes_version, release_name=None)

Create Profile for Definition.

Parameters

  • profile_name (str) – Name of profile

  • namespace (str) – Namespace that service is created in

  • kubernetes_version (str) – Required Kubernetes version

  • release_name (str) – Release name

Returns

Created object

Return type

Profile

classmethod get_all()

Get all definitions.

Yields

Definition – Definition object

get_all_configuration_templates()

Get all configuration templates.

Yields

ConfigurationTemplate – ConfigurationTemplate object

get_all_profiles()

Get all profiles.

Yields

Profile – Profile object

Return type

Iterator[Profile]

get_configuration_template_by_name(template_name)

Get configuration template.

Parameters

template_name (str) – Name of the template

Returns

object

Return type

ConfigurationTemplate

classmethod get_definition_by_name_version(rb_name, rb_version)

Get definition by it’s name and version.

Parameters

  • rb_name (str) – definition name

  • rb_version (str) – definition version

Returns

Definition object

Return type

Definition

get_profile_by_name(profile_name)

Get profile by it’s name.

Parameters

profile_name (str) – profile name

Returns

Profile object

Return type

Profile

class onapsdk.msb.k8s.definition.DefinitionBase(rb_name, rb_version)

Bases: onapsdk.msb.msb_service.MSB

DefinitionBase class.

base_url = 'https://msb.api.simpledemo.onap.org:30283/api/multicloud-k8s/v1/v1/rb/definition'
delete()

Delete Definition Based object.

Return type

None

upload_artifact(package=None)

Upload artifact.

Parameters

package (bytes) – Artifact to be uploaded to multicloud-k8s plugin

property url

URL address for Definition Based calls.

Returns

URL to RB Definition

Return type

str

class onapsdk.msb.k8s.definition.Profile(rb_name, rb_version, profile_name, namespace, kubernetes_version, labels=None, release_name=None)

Bases: onapsdk.msb.k8s.definition.ProfileBase

Profile class.

class onapsdk.msb.k8s.definition.ProfileBase(rb_name, rb_version, profile_name)

Bases: onapsdk.msb.k8s.definition.DefinitionBase

ProfileBase class.

property url

URL address for Profile calls.

Returns

URL to RB Profile

Return type

str

onapsdk.msb.k8s.instance module

Instantiation module.

class onapsdk.msb.k8s.instance.Instance(instance_id, namespace, request, resources=None, override_values=None)

Bases: onapsdk.msb.msb_service.MSB

Instance class.

base_url = 'https://msb.api.simpledemo.onap.org:30283/api/multicloud-k8s/v1/v1/instance'
classmethod create(cloud_region_id, profile_name, rb_name, rb_version, override_values=None, labels=None)

Create Instance.

Parameters

  • cloud_region_id (str) – Cloud region ID

  • profile_name (str) – Name of profile to be instantiated

  • rb_name (str) – (bytes): Definition name

  • rb_version (str) – Definition version

  • override_values (dict) – List of optional override values

  • labels (dict) – List of optional labels

Returns

Created object

Return type

Instance

delete()

Delete Instance object.

Return type

None

classmethod get_all()

Get all instantiated Kubernetes resources.

Yields

Instantiation – Instantiation object

Return type

Iterator[Instance]

classmethod get_by_id(instance_id)

Get Kubernetes resource by id.

Parameters

instance_id (str) – instance ID

Returns

Instantiation object

Return type

Instantiation

property url

URL address.

Returns

URL to Instance

Return type

str

class onapsdk.msb.k8s.instance.InstantiationParameter(name, value)

Bases: object

Class to store instantiation parameters used to pass override_values and labels.

Contains two values: name of parameter and it’s value

name: str
value: str
class onapsdk.msb.k8s.instance.InstantiationRequest(request)

Bases: object

Instantiation Request class.

Module contents

K8s package.