Metadata-Version: 2.1
Name: ecs-composex-msk-cluster
Version: 0.0.1
Summary: msk_cluster - Module for ECS Compose-X
License: MPL-2.0
Author: johnpreston
Author-email: john@compose-x.io
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: ecs_composex (==0.18.0b4)
Project-URL: Compose-X Labs, https://labs.compose-x.io/
Project-URL: Compose-X Blog, https://blog.compose-x.io/
Project-URL: ECS ComposeX, https://github.com/compose-x/ecs_composex/
Description-Content-Type: text/x-rst


.. meta::
    :description: ECS Compose-X MSK Cluster
    :keywords: AWS, ECS, docker, compose, MSK, kafka

================
msk_cluster
================

.. image:: https://img.shields.io/pypi/v/ecs_composex_msk_cluster.svg
    :target: https://pypi.python.org/pypi/ecs_composex_msk_cluster


This package is an extension to `ECS Compose-X`_ that manages Creation of new MSK clusters and automatically links
to services to grant access and permissions.

Install
==========

.. code-block:: bash

    python3 -m venv venv
    source venv/bin/activate
    # With poetry

    pip install pip poetry -U
    poetry install

    # Via pip
    pip install pip -U
    pip install ecs-composex-msk-cluster

Syntax Reference
==================

.. code-block:: yaml

    x-msk_cluster:
          Properties: {}
          Lookup: {}
          Settings: {}
          Services: {}

Properties
--------------

See `Properties for MSK Cluster`_ in AWS Cloudformation documentation.


Lookup
--------

Lookup is not yet implemented.

Services
---------

Mappings between the MSK cluster and the services. To be implemented.


.. _ECS Compose-X: https://docs.compose-x.io
.. _Properties for MSK Cluster: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html

