Metadata-Version: 2.0
Name: python-vnfm-sdk
Version: 2.2.1b0
Summary: The Python version of the Open Baton vnfm-sdk
Home-page: http://openbaton.github.io/
Author: Open Baton
Author-email: dev@openbaton.org
License: Apache 2
Keywords: python vnfm nfvo open baton openbaton sdk
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: Apache Software License
Requires-Dist: pika

Python version of the vnfm-sdk
==============================

This project contains a vnfm sdk for python projects.

Technical Requirements
----------------------

This section covers the requirements that must be met by the
python-vnfm-sdk in order to satisfy the demands for such a component:

-  python 2.7
-  pika

How to install python-vfnm-sdk
------------------------------

The safer way to start is to clone the sdk and then use a `virtual environment <https://virtualenv.pypa.io/en/stable/>`__. Once activated, just run

.. code:: bash

   git clone 
   python setup.py build  
   python setup.py install

After that, in this virtual environment a module *interfaces* will be
available from which you can inherit the AbstractVnfm class in this way:

.. code:: python

    import logging

    from interfaces.AbstractVnfmABC import AbstractVnfm

    class PythonVnfm(AbstractVnfm):

        def upgradeSoftware(self):
            pass

        def updateSoftware(self):
            pass

        def terminate(self, virtualNetworkFunctionRecord):
            pass

        def scale(self, scaleOut, virtualNetworkFunctionRecord, component, scripts, dependency):
            pass

        def query(self):
            pass

        def notifyChange(self):
            pass

        def modify(self, virtualNetworkFunctionRecord, dependency):
            pass

        def instantiate(self, virtualNetworkFunctionRecord, scripts, vimInstances):
            pass

        def heal(self, virtualNetworkFunctionRecord, vnfcInstanceComponent, cause):
            pass

        def checkInstantiationFeasibility(self):
            pass


    if __name__ == "__main__":
        logging.basicConfig(level="DEBUG")
        vnfm = PythonVnfm("python")
        vnfm.run()

Issue tracker
-------------

Issues and bug reports should be posted to the GitHub Issue Tracker of
this project

What is Open Baton?
===================

OpenBaton is an open source project providing a comprehensive
implementation of the ETSI Management and Orchestration (MANO)
specification.

Open Baton is a ETSI NFV MANO compliant framework. Open Baton was part
of the OpenSDNCore (www.opensdncore.org) project started almost three
years ago by Fraunhofer FOKUS with the objective of providing a
compliant implementation of the ETSI NFV specification.

Open Baton is easily extensible. It integrates with OpenStack, and
provides a plugin mechanism for supporting additional VIM types. It
supports Network Service management either using a generic VNFM or
interoperating with VNF-specific VNFM. It uses different mechanisms
(REST or PUB/SUB) for interoperating with the VNFMs. It integrates with
additional components for the runtime management of a Network Service.
For instance, it provides autoscaling and fault management based on
monitoring information coming from the the monitoring system available
at the NFVI level.

Source Code and documentation
-----------------------------

The Source Code of the other Open Baton projects can be found
`here <http://github.org/openbaton>`__ and the documentation can be
found `here <http://openbaton.org/documentation>`__ .

News and Website
----------------

Check the `Open Baton Website <http://openbaton.org>`__ Follow us on
Twitter @\ `openbaton <https://twitter.com/openbaton>`__.

Licensing and distribution
--------------------------

Copyright [2015-2016] Open Baton project

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License. You may
obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Copyright © 2015-2016 `Open Baton <http://openbaton.org>`__. Licensed
under `Apache v2
License <http://www.apache.org/licenses/LICENSE-2.0>`__.

Support
-------

The Open Baton project provides community support through the Open Baton
Public Mailing List and through StackOverflow using the tags openbaton.

Supported by
------------

.. image:: https://raw.githubusercontent.com/openbaton/openbaton.github.io/master/images/fokus.png
  :width: 250 px

.. image:: https://raw.githubusercontent.com/openbaton/openbaton.github.io/master/images/tu.png
   :width: 250 px

