Metadata-Version: 1.1
Name: humilis-es
Version: 0.0.5
Summary: Humilis plug-in to create an Elasticsearch domain
Home-page: https://github.com/humilis/humilis-es
Author: German Gomez-Herrero, FindHotel BV
Author-email: german@findhotel.net
License: MIT
Description: Humilis plug-in to deploy an Elasticsearch domain
        =================================================
        
        |PyPI|
        
        A `humilis <https://github.com//humilis/blob/master/README.md>`__
        plug-in layer that provides support for layer type ``es``, which deploys
        an `Elasticsearch <https://aws.amazon.com/elasticsearch-service/>`__
        domain into a humilis environment.
        
        Installation
        ------------
        
        ::
        
            pip install humilis-es
        
        To install the development version:
        
        ::
        
            pip install git+https://github.com/humilis/humilis-es
        
        Development
        -----------
        
        Assuming you have
        `virtualenv <https://virtualenv.readthedocs.org/en/latest/>`__
        installed:
        
        ::
        
            make develop
        
        Configure humilis:
        
        ::
        
            make configure
        
        Testing
        -------
        
        There is no logic in this layer beyond the deployment of AWS resources
        so there is no unit test suite. You can test the deployment of a dummy
        ES domain with:
        
        ::
        
            make testi
        
        Layer parameters
        ----------------
        
        Layer type ``es`` accepts the following parameters.
        
        Required
        ~~~~~~~~
        
        -  ``domain_name``: The actual name will be
           ``[envname]-[stage]-[domain_name]``
        
        Optional
        ~~~~~~~~
        
        -  ``whitelisted_ips``: A list of whitelisted CIDRs or IPs.
        -  ``iam_users_arns``: These users will be given full access to the ES
           domain.
        -  ``iam_roles_arns``: These roles will be given full access to the ES
           domain.
        
        More information
        ----------------
        
        See `humilis <https://github.com//humilis/blob/master/README.md>`__
        documentation.
        
        Contact
        -------
        
        If you have questions, bug reports, suggestions, etc. please create an
        issue on the `GitHub project
        page <http://github.com/humilis/humilis-es>`__.
        
        License
        -------
        
        This software is licensed under the `MIT
        license <http://en.wikipedia.org/wiki/MIT_License>`__.
        
        See `License
        file <https://github.com/humilis/humilis-es/blob/master/LICENSE.txt>`__.
        
        © 2016 German Gomez-Herrero, `Find
        Hotel <http://company.findhotel.net>`__ and others.
        
        .. |PyPI| image:: https://img.shields.io/pypi/v/humilis-es.svg?style=flat
           :target: https://pypi.python.org/pypi/humilis-es
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
