Metadata-Version: 1.1
Name: mgmtsystem
Version: 1.3.2
Summary: A base system for provider management
Home-page: UNKNOWN
Author: Peter Savage
Author-email: psavage@redhat.com
License: UNKNOWN
Description: .. image:: https://landscape.io/github/RedHatQE/mgmtsystem/master/landscape.svg?style=fla
           :scale: 50 %
           :alt: Health Status
           :align: left
           :target: (https://landscape.io/github/RedHatQE/mgmtsystem/master
        .. image:: https://coveralls.io/repos/RedHatQE/mgmtsystem/badge.svg?branch=master&service=github
           :scale: 50 %
           :alt: Coverage Status
           :align: left
           :target: https://coveralls.io/github/RedHatQE/mgmtsystem?branch=master
        .. image:: https://travis-ci.org/RedHatQE/mgmtsystem.svg
           :scale: 50 %
           :alt: Build Status
           :align: left
           :target: https://travis-ci.org/RedHatQE/mgmtsystem
        
        mgmtsystem
        ==========
        
        Introduction
        ------------
        mgmtsystem is a simple virtualization client with support (in varying degrees) for the following
        
        * Red Hat Enterprize Virtualization (RHEV)
        * Red Hat Openstack (RHOS)
        * Openshift
        * VMware vCenter
        * Microsoft SCVMM
        * Microsoft Azure
        * Google Compute Engine
        * Kubernetes
        * Hawkular
        
        It can be used to control virtualization clients and offersoperations such as
        
        * list_vm (returns a list of vm_names)
        * list_template (returns a list of templates/images)
        * start_vm (starts a vm)
        * stop_vm (stops a vm)
        
        Though conceptually names differ between cloud and infrastructure virualization technologies ie. instance/v
        it was decided to stick to one representation in the codebase and interface to give a singlar API across
        all systems.
        
        Usage
        -----
        Each management system is invoked usually with a hostname and some credentials
        
        .. code-block:: python
        
          from mgmtsystem.virtualcenter import VMWareSystem
          
          system = VMWareSystem(hostname='10.0.0.0', username="root", password="password")
          system.list_vm()
        
        Adding a new Management System
        ------------------------------
        A management system should extend the Base class, and supply "Not Implemented" raises for items which
        it doesn't support. This behaviour may change in the future as more and more diverse management systems.
        
        .. code-block:: python
        
          from base import MgmtSystemAPIBase
        
          class RHEVMSystem(MgmtSystemAPIBase):
          
            _stats_available = {
              'num_vm': lambda self: self.api.get_summary().get_vms().total,
              'num_host': lambda self: len(self.list_host()),
              'num_cluster': lambda self: len(self.list_cluster()),
              'num_template': lambda self: len(self.list_template()),
              'num_datastore': lambda self: len(self.list_datastore()),
            }
          
            def __init__(self, hostname, username, password, **kwargs):
              super(RHEVMSystem, self).__init__(kwargs)
        
        The call to ``super`` is necessary to set up the logger if noe has not been passed in with the ``logger``
        keyword.
        
        The developer can then add their own methods to interact with their own management system. Commonly accessible
        statistics are generally all named the same across management systems. In this way we can treat multiple management
        systems the same and use an identical method to check the number of vms on a RHEV system, to a VMware system.
        
        Exceptions currently sit in a single module, this will probably change later with each management system having it's own
        package and exceptions stored there.
        
        This module was originally developed for assisting in the ManageIQ testing team.
        
        Contributing
        ------------
        The guidelines to follow for this project can be found in the 
        cfme `dev_guide <http://cfme-tests.readthedocs.org/guides/dev_guide.html>`_.
        
        
Keywords: setup
distutils
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Utilities
