Working integration to 0.23.0 (#2)

* Working create & Lookup

* Aligned with latest alpha

* Updated docs

* Bump to 0.1.0

Author: JohnPreston

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+    rev: v4.3.0
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace
@@ -9,16 +9,16 @@ repos:
       - id: fix-encoding-pragma
       - id: forbid-new-submodules
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.31.1
+    rev: v3.2.0
     hooks:
       - id: pyupgrade
         args: [ "--py38-plus" ]
   - repo: https://github.com/psf/black
-    rev: 21.9b0
+    rev: 22.10.0
     hooks:
       - id: black
   - repo: https://github.com/pycqa/isort
-    rev: 5.9.3
+    rev: 5.10.1
     hooks:
       - id: isort
         args: [ "--profile", "black", "--filter-files" ]

HISTORY.rst renamed to CHANGELOG.rst

@@ -1,196 +1,92 @@
 #!/usr/bin/env python
-#
-# ecs_composex_msk_cluster documentation build configuration file, created by
-# sphinx-quickstart on Fri Jun  9 13:47:02 2017.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-# If extensions (or modules to document with autodoc) are in another
-# directory, add these directories to sys.path here. If the directory is
-# relative to the documentation root, use os.path.abspath to make it
-# absolute, like shown here.
-#
-import os
-import sys
-sys.path.insert(0, os.path.abspath('..'))
-
-import ecs_composex_msk_cluster
-
-# -- General configuration ---------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+
+import sphinx_material
+
+try:
+    import ecs_composex_msk_cluster
+except ImportError:
+    import os
+    import sys
+
+    sys.path.insert(0, os.path.abspath('..'))
+    import ecs_composex_msk_cluster
+
+
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
 
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
+source_suffix = ['.rst', '.md']
+# source_suffix = '.rst'
 
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
-
-# The master toctree document.
 master_doc = 'index'
-
-# General information about the project.
-project = 'msk_cluster'
-copyright = "2022, John Preston"
+project = 'ecs_composex_msk_cluster'
+copyright = '2022, John "Preston" Mille'
 author = "John Preston"
 
-# The version info for the project you're documenting, acts as replacement
-# for |version| and |release|, also used in various other places throughout
-# the built documents.
-#
-# The short X.Y version.
 version = ecs_composex_msk_cluster.__version__
-# The full version, including alpha/beta/rc tags.
 release = ecs_composex_msk_cluster.__version__
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
 language = None
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-
-# The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
-
-# If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
-
-# -- Options for HTML output -------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-
-import sphinx_material
-
 extensions += [
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinx.ext.autodoc",
+    "sphinx_autodoc_typehints",
+    "sphinx-jsonschema",
+    "sphinx_material"
 ]
 
-html_theme = "sphinx_rtd_theme"
 autosummary_generate = True
 autoclass_content = "class"
 
-html_baseurl = "https://docs"
+html_baseurl = "https://msk-cluster.docs.compose-x.io"
 
-extensions.append("sphinx_material")
 html_theme_path = sphinx_material.html_theme_path()
 html_context = sphinx_material.get_html_context()
 html_theme = "sphinx_material"
-# Theme options are theme-specific and customize the look and feel of a
-# theme further.  For a list of options available for each theme, see the
-# documentation.
-#
 html_theme_options = {
     # Set the name of the project to appear in the navigation.
-    "nav_title": "msk_cluster",
-    # Set you GA account ID to enable tracking
+    "nav_title": "Compose-X MSK Cluster",
     # 'google_analytics_account': 'UA-XXXXX',
-    # Specify a base_url used to generate sitemap.xml. If not
-    # specified, then no sitemap will be built.
     "base_url": "https://docs.msk-cluster.ecs-composex.io",
     "html_minify": False,
     "html_prettify": True,
     "css_minify": True,
-    # Set the color and the accent color
     "color_primary": "blue-grey",
     "color_accent": "white",
-    # Set the repo location to get a badge with stats
     "repo_url": "https://github.com/compose-x/ecs_composex_msk_cluster/",
     "repo_name": "compose-x/ecs_composex_msk_cluster",
     "repo_type": "github",
-    # Visible levels of the global TOC; -1 means unlimited
     "globaltoc_depth": 2,
-    # If False, expand all TOC entries
     "globaltoc_collapse": True,
-    # If True, show hidden TOC entries
     "globaltoc_includehidden": False,
 }
 
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 html_show_sourcelink = True
 html_sidebars = {
     "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
 }
 
-# -- Options for HTMLHelp output ---------------------------------------
-
-# Output file base name for HTML help builder.
 htmlhelp_basename = 'ecs_composex_msk_clusterdoc'
 
-
-# -- Options for LaTeX output ------------------------------------------
-
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass
-# [howto, manual, or own class]).
+latex_elements = {}
 latex_documents = [
     (master_doc, 'ecs_composex_msk_cluster.tex',
      'msk_cluster Documentation',
      'John Preston', 'manual'),
 ]
 
-# -- Options for manual page output ------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
 man_pages = [
     (master_doc, 'ecs_composex_msk_cluster',
      'msk_cluster Documentation',
      [author], 1)
 ]
 
-# -- Options for Texinfo output ----------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc, 'ecs_composex_msk_cluster',
      'msk_cluster Documentation',

docs/conf.py

@@ -1 +1 @@
-.. include:: ../HISTORY.rst
+.. include:: ../CHANGELOG.rst

docs/history.rst

@@ -1,19 +1,18 @@
 
 .. meta::
     :description: ECS Compose-X MSK Cluster
-    :keywords: AWS, ECS, docker, compose, MSK, kafka
+    :keywords: AWS, ECS, MSK, compose
 
 .. 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.
+This package is an extension to `ECS Compose-X`_ to create or use AWS Managed Kafka Clusters (MSK).
 
-Install
-==========
+Installation
+=============
 
-.. code-block:: bash
+.. code-block::
 
     python3 -m venv venv
     source venv/bin/activate
@@ -26,51 +25,27 @@ Install
     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.
 
+Usage
+=======
 
-Test files
-===========
+To use this module, after installing it, set `x-msk_cluster` in your docker-compose file, and link your services to it.
+For example, with the Conduktor Platform
 
-.. literalinclude:: ../use-cases/create_only/services.yaml
-    :language: yaml
+.. code-block:: console
 
+    ecs-compose-x render -d templates -f use-cases/conduktor.yaml -p conduktor-msk-iam
 
 .. _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
 
 
 .. toctree::
    :maxdepth: 2
-   :caption: x-msk_cluster:
+   :caption: Content
 
    installation
    usage
+   syntax
    modules
    contributing
    authors

docs/index.rst

@@ -12,7 +12,7 @@ To install msk_cluster, run this command in your terminal:
 
 .. code-block:: console
 
-    $ pip install ecs_composex_msk_cluster
+    pip install ecs_composex_msk_cluster
 
 This is the preferred method to install msk_cluster, as it will always install the most recent stable release.
 
@@ -32,19 +32,19 @@ You can either clone the public repository:
 
 .. code-block:: console
 
-    $ git clone git://github.com/compose-x/ecs_composex_msk_cluster
+    git clone git://github.com/compose-x/ecs_composex_msk_cluster
 
 Or download the `tarball`_:
 
 .. code-block:: console
 
-    $ curl -OJL https://github.com/compose-x/ecs_composex_msk_cluster/tarball/master
+    curl -OJL https://github.com/compose-x/ecs_composex_msk_cluster/tarball/master
 
 Once you have a copy of the source, you can install it with:
 
 .. code-block:: console
 
-    $ python setup.py install
+    python3 -m pip install .
 
 
 .. _Github repo: https://github.com/compose-x/ecs_composex_msk_cluster