Metadata-Version: 2.1
Name: carica_cfn_tools
Version: 1.9.3
Summary: Tools to manage CloudFormation stack configuration
Home-page: https://github.com/caricalabs/carica-cfn-tools
Author: Carica Labs, LLC
Author-email: info@caricalabs.com
License: APL 2.0
Description: carica-cfn-tools - Tools to manage CloudFormation stack configuration
        ==================================================================================
        
        Simple command line tools to create and update CloudFormation stacks that
        make it easy to version-control both your templates and stack configurations
        in one place.  Supports a few proprietary transforms useful for dynamically
        merging a manually maintained template with a generated template (for example,
        sam.json from "chalice package") that contains resources you'd like to include
        in your main template.
        
        Development
        -----------
        
        The ``vinstall`` script uses virtualenv to prepare a Python environment useful
        for development, so you don't have to build and install carica-cfn-tools to be
        able to run and test it.
        
        #. Run ``./vinstall``
        #. Activate the virtualenv by running ``. ./venv/bin/activate``
        #. The ``console_scripts`` listed in ``setup.py`` are now in your path, so you
           can simply run them like:
        
           ``carica-cfn ...``
        
        Sample Stack Config
        -------------------
        ::
        
            Region: us-east-1
            Bucket: mycorp-cfn-us-east-1
            Name: WarehouseApp
            Template: ../templates/warehouse-app.yml
            Parameters:
              # Normal parameter values can include strings, numbers, booleans, etc.
              Stage: dev
              TableReadCapacityUnits: 10
              TableWriteCapacityUnits: 5
              AdminPassword:
                # A parameter with a "ParameterStore" sub-key will be resolved to the
                # SSM Parameter Store parameter with that name.
                ParameterStore: dev.warehouseapp.admin-password
              PostgreSQLPassword:
                # A parameter with a "SecretsManager" sub-key will be resolved to the
                # Secrets Manager secret with that ID.
                SecretsManager: dev.warehouseapp.postgresql-password
            Extras:
              - ../cfn/static/logo.png
              - ../cfn/static/index.html
            JinjaExtras:
              - ../cfn/includes/*.yml
            JinjaExtrasContext:
              FOO: bar
        
        
        `Extras` and `JinjaExtras` can be absolute paths or glob patterns relative to
        the stack config file.
        
        `Extras` or `JinjaExtras` that are directories, whether specified by absolute
        path or expanded from a glob pattern, are copied recursively into the deployment
        at a top-level directory named after the *last* directory component of the source.
        An extra directory path like `/foo/bar/baz` ends up as `/baz` in the deployment.
        
        `Extras` or `JinjaExtras` that are files, whether by absolute path or expanded
        from a glob pattern, are copied into the root of the deployment.
        
        `JinjaExtras` are processed with the Jinja2 template engine after all extras
        are copied to a temporary directory.
        
        `JinjaExtrasContext` is a dictionary passed as the context when Jinja is run.
Keywords: cloudformation cfn stack template config configuration
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Provides-Extra: dev
Provides-Extra: test
