Metadata-Version: 1.1
Name: cf-configuration-exporter
Version: 0.0.9
Summary: Simple utility to generate a configuration manifest from a live CloudFoundry installation
Home-page: https://github.com/SpringerPE/cf-configuration-exporter
Author: Claudio Benfatto
Author-email: claudio.benfatto@springer.com
License: MIT
Download-URL: https://github.com/SpringerPE/cf-configuration-exporter/releases/tag/v0.0.9
Description: # cf-configuration-exporter
        
        `cf-configuration-exporter` is a simple utility whose aim is to generate a 
        configuration manifest from a live installation of CloudFoundry.
        
        The utility is meant to be used in combination with 2 other projects:
        
        - https://github.com/SpringerPE/python-cfconfigurator
        - https://github.com/SpringerPE/ansible-cloudfoundry-role
        
        and helps you get started with an initial manifest without having to extract manually
        all the information needed.
        
        The code is compatible with Python 3
        
        Documentation of the APIs used:
        
        * https://apidocs.cloudfoundry.org
        * https://docs.cloudfoundry.org/api/uaa
        
        #INSTALLATION
        
        ## Example
        
        Install via pip: `pip install cf-configuration-exporter`
        
        ## Upload to PyPI
        
        1. Create a `.pypirc` configuration file. This file holds your information for authenticating with PyPI.
        
           ```
           [distutils]
           index-servers = pypi
           
           [pypi]
           repository=https://pypi.python.org/pypi
           username=your_username
           password=your_password
           ```
        2. Login and upload it to PyPI
        
           ```
           python setup.py register -r pypi
           python setup.py sdist upload -r pypi
           ```
        
        #USAGE
        
        ```
        Define the following env variables:
        
        `EXPORTER_API_URL` = the endpoint of the Cloudfoundry API
        `EXPORTER_ADMIN_USER` = username used for logging in to CloudFoundry
        `EXPORTER_ADMIN_PASSWORD` = password used for logging in to Cloudfoundry
        `EXPORTER_EXCLUDE_ENV_VARS` = list of `,` separated strings. The env variables whose name starts by
                                                                 one of the prefixes listed will not be exported.
        ```
        
        You can run the utility by executing the run script:
        
        ```
        ./run
        ```
        
        or after installing the pip package
        
        ```
        python setup.py install
        ```
        
        by running
        
        ```
        cf_export_configuration
        ```
        
        ## Author
        
        Springer Nature Platform Engineering, Claudio Benfatto (claudio.benfatto@springer.com)
        
        Copyright 2017 Springer Nature
Keywords: cf cloudfoundry cloud foundry
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: System :: Systems Administration
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
