Metadata-Version: 1.0
Name: xenosimager
Version: 0.002
Summary: Create an image of a instance from data obtained from within the instance
Home-page: http://github.com/cloudnull/transporter
Author: Kevin Carter
Author-email: kevin.carter@rackspace.com
License: Apache2.0
Description: Transporter
        ###########
        :date: 2012-03-08 16:22
        :tags: Openstack, Nova Compute, Nova, Glance, Imaging, XenServer
        :category: \*nix
        
        
        Create an Image from within an Instance
        =======================================
        
        General Overview
        ----------------
        
        This application will create an image from information from within an instance. The application will look at the "*xenstore*" data from within the instance and then use your provided OpenStack credentials to create an image on the understood instance.
        
        Simply this will allow you to create images of instances on as a simple CRON job or on demand.
        
        
        Prerequisites :
          * Python => 2.6 but < 3.0
          * python-setuptools
        
        
        Installation is simple :
        
            .. code-block:: bash
        
                git clone git://github.com/cloudnull/transporter.git
                cd transporter
                python setup.py install
        
        
        Setup is Simple too edit the file "/etc/xenosimager/config.cfg" :
        
            .. code-block:: bash
        
                vi /etc/xenosimager/config.cfg
        
        
        In the previous file, add your credentials. If you feel so inclined, you can also add your mail relay information and the system will send you a message when the images are created or if there are overall issues. 
        
        
        Available Options in the config file or on the CLI : 
        
        
        Required Variables from CLI
        ---------------------------
        
         - ``system-config`` | Where your config file exists
         - ``image-name`` | the name of the image
        
        
        OpenStack Variables
        -------------------
        
         - ``os_user`` | YOU
         - ``os_apikey`` | SuperSecretInformation
         - ``os_auth_url`` | Authentication URL
         - ``os_rax_auth`` | A-LOCATION
         - ``os_verbose`` | True or False
         - ``os_password`` | SuperSecretInformation
         - ``os_tenant`` | UsernameGenerally
         - ``os_region`` | WhereIsThisInstance
         - ``os_version`` | v2.0
        
        
        Mail Variables
        --------------
        
         - ``mail-main-contact`` | WhoReadsEmail
         - ``mail_debug`` | True or False
         - ``mail_url`` | AURL
         - ``mail_user`` | Username
         - ``mail_password`` | Password
         - ``mail_cert`` | /location/cert
         - ``mail_key`` | KeyForCert
         - ``mail_tls`` | True or False
         - ``mail_port`` | Port Number
        
        
        How to use this tool
        --------------------
        
        Application is simple to use. Simply follow this command and add your own custom name to the end.
        
            .. code-block:: bash
        
                xenosimager --system-config /etc/xenosimager/config.cfg --image-name $NAME_OF_THE_IMAGE
        
        
        Logs are created for all interaction of the imager, and can be found here :
        
            .. code-block:: bash
        
                /var/log/xenosimager.log
        
        
        For automated image create please have a look at the example.cron.txt file, which is where you can find cron job examples, but with little to no ingenuity I am sure you could figure out other methods for automated image creation.
        
        
        Get Social
        ----------
        
        * Downloadable on PyPi_
        * Downloadable on GitHub_
        * See My `GitHub Issues Page`_ for any and all Issues or Feature requests
        
        .. _PyPi: https://pypi.python.org/pypi/transporter
        .. _GitHub: https://github.com/cloudnull/transporter
        .. _GitHub Issues Page: https://github.com/cloudnull/transporter/issues
        
        See ``https://github.com/cloudnull/transporter/issues`` for Issues or Feature requests
        
        
        License
        _______
        
        Copyright [2013] [Kevin Carter]
        
        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.
Platform: UNKNOWN
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Libraries :: Python Modules
