Working basic features

Author: JohnPreston

.gitignore

@@ -8,6 +8,7 @@ __pycache__/
 
 *~
 .idea/
+docs/ecs_files_*.rst
 
 # Distribution / packaging
 .Python

CONTRIBUTING.rst

@@ -15,7 +15,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/compose-x/ecs_config_composer/issues.
+Report bugs at https://github.com/compose-x/ecs_files_composer/issues.
 
 If you are reporting a bug, please include:
 
@@ -45,7 +45,7 @@ articles, and such.
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/compose-x/ecs_config_composer/issues.
+The best way to send feedback is to file an issue at https://github.com/compose-x/ecs_files_composer/issues.
 
 If you are proposing a feature:
 
@@ -57,17 +57,17 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `ecs_config_composer` for local development.
+Ready to contribute? Here's how to set up `ecs_files_composer` for local development.
 
-1. Fork the `ecs_config_composer` repo on GitHub.
+1. Fork the `ecs_files_composer` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone [email protected]:your_name_here/ecs_config_composer.git
+    $ git clone [email protected]:your_name_here/ecs_files_composer.git
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
 
-    $ mkvirtualenv ecs_config_composer
-    $ cd ecs_config_composer/
+    $ mkvirtualenv ecs_files_composer
+    $ cd ecs_files_composer/
     $ python setup.py develop
 
 4. Create a branch for local development::
@@ -79,7 +79,7 @@ Ready to contribute? Here's how to set up `ecs_config_composer` for local develo
 5. When you're done making changes, check that your changes pass flake8 and the
    tests, including testing other Python versions with tox::
 
-    $ flake8 ecs_config_composer tests
+    $ flake8 ecs_files_composer tests
     $ python setup.py test or pytest
     $ tox
 
@@ -103,15 +103,15 @@ Before you submit a pull request, check that it meets these guidelines:
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
 3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
-   https://travis-ci.com/compose-x/ecs_config_composer/pull_requests
+   https://travis-ci.com/compose-x/ecs_files_composer/pull_requests
    and make sure that the tests pass for all supported Python versions.
 
 Tips
 ----
 
 To run a subset of tests::
 
-$ pytest tests.test_ecs_config_composer
+$ pytest tests.test_ecs_files_composer
 
 
 Deploying

Dockerfile

@@ -1,16 +1,21 @@
+ARG ARCH=
 ARG PY_VERSION=3.8
 ARG BASE_IMAGE=public.ecr.aws/ews-network/python:${PY_VERSION}
-FROM $BASE_IMAGE
+ARG LAMBDA_IMAGE=public.ecr.aws/lambda/python:latest
+FROM $BASE_IMAGE as builder
 
-RUN yum upgrade -y ;                                                            \
-    yum install -y shadow-utils ;                                               \
-    groupadd -r app -g 1042 &&                                                  \
-    useradd -u 1042 -r -g app -m -d /app -s /sbin/nologin -c "App user" app &&  \
-    chown -R app: /app &&                                                       \
-    yum erase shadow-utils -y && yum clean all && rm -rfv /var/cache/yum
+WORKDIR /opt
+COPY ecs_config_composer /opt/ecs_config_composer
+COPY setup.py requirements.txt MANIFEST.in README.rst LICENSE /opt/
+RUN python -m venv venv ; source venv/bin/activate ; pip install wheel;  python setup.py sdist bdist_wheel; ls -l dist/
 
+FROM $BASE_IMAGE
 
+RUN yum upgrade -y
+ENV PATH=/app/.local/bin:${PATH}
+COPY --from=builder /opt/dist/ecs_config_composer-*.whl ${LAMBDA_TASK_ROOT:-/app/}/
 WORKDIR /app
-USER app
-ENTRYPOINT ["ecs-config-composer"]
+RUN echo $PATH ; pip install pip -U --no-cache-dir && pip install wheel --no-cache-dir && pip install *.whl --no-cache-dir
+WORKDIR /
+ENTRYPOINT ["ecs_config_composer"]
 CMD ["--env", "CONFIG"]

HISTORY.rst

@@ -2,7 +2,7 @@
 History
 =======
 
-0.0.1 (2021-07-12)
+0.0.1 (2021-07-15)
 ------------------
 
 * First release on PyPI.

MANIFEST.in

@@ -3,7 +3,10 @@ include CONTRIBUTING.rst
 include HISTORY.rst
 include LICENSE
 include README.rst
-include ecs-config-input.json
+include USAGE.rst
+include NOTICES.rst
+include requirements*.txt
+include ecs-files-input.json
 
 recursive-include tests *
 recursive-exclude * __pycache__

Makefile

@@ -48,7 +48,7 @@ clean-test: ## remove test and coverage artifacts
 	rm -fr .pytest_cache
 
 lint: ## check style with flake8
-	flake8 ecs_config_composer tests
+	flake8 ecs_files_composer tests
 
 test: ## run tests quickly with the default Python
 	pytest
@@ -57,15 +57,15 @@ test-all: ## run tests on every Python version with tox
 	tox
 
 coverage: ## check code coverage quickly with the default Python
-	coverage run --source ecs_config_composer -m pytest
+	coverage run --source ecs_files_composer -m pytest
 	coverage report -m
 	coverage html
 	$(BROWSER) htmlcov/index.html
 
 docs: ## generate Sphinx HTML documentation, including API docs
-	rm -f docs/ecs_config_composer.rst
+	rm -f docs/ecs_files_composer.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ ecs_config_composer
+	sphinx-apidoc -o docs/ ecs_files_composer
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html
@@ -89,12 +89,12 @@ install: clean ## install the package to the active Python's site-packages
 	python setup.py install
 
 conform	: ## Conform to a standard of coding syntax
-	isort --profile black ecs_config_composer
-	black ecs_config_composer tests setup.py
-	find ecs_config_composer -name "*.json" -type f  -exec sed -i '1s/^\xEF\xBB\xBF//' {} +
+	isort --profile black ecs_files_composer
+	black ecs_files_composer tests setup.py
+	find ecs_files_composer -name "*.json" -type f  -exec sed -i '1s/^\xEF\xBB\xBF//' {} +
 
 data-model:
-	datamodel-codegen  --input ecs-config-input.json \
+	datamodel-codegen  --input ecs-files-input.json \
 		--input-file-type jsonschema \
-		--output ecs_config_composer/input.py
+		--output ecs_files_composer/input.py
 # 		--enum-field-as-literal all

README.rst

@@ -1,5 +1,5 @@
 ===================
-ECS Config Composer
+ECS Files Composer
 ===================
 
 
@@ -15,12 +15,67 @@ ECS Config Composer
 Files and configuration handler to inject configuration files into volumes for ECS containers.
 ------------------------------------------------------------------------------------------------------
 
-* Free software: MPL2.0
-* Documentation: https://ecs-config-composer.compose-x.io.
+Usage
+=======
 
+.. code-block:: bash
+
+
+    usage: ecs_files_composer [-h] [-f FILE_PATH | -e ENV_VAR | --from-ssm SSM_CONFIG | --from-s3 S3_CONFIG] [--role-arn ROLE_ARN] [_ ...]
+
+    positional arguments:
+      _
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      -f FILE_PATH, --from-file FILE_PATH
+                            Configuration for execution from a file
+      -e ENV_VAR, --from-env-var ENV_VAR
+                            Configuration for execution is in an environment variable
+      --from-ssm SSM_CONFIG
+                            Configuration for execution is in an SSM Parameter
+      --from-s3 S3_CONFIG   Configuration for execution is in an S3
+      --role-arn ROLE_ARN   The Role ARN to use for the configuration initialization
+
+
+Example inputs
+===============
+
+.. code-block:: yaml
+
+    files:
+      /opt/app/test.txt:
+        content: >-
+          test from a yaml raw content
+        owner: john
+        group: root
+        mode: 600
+      /opt/app/aws.template:
+        source:
+          S3:
+            BucketName: ${BUCKET_NAME:-sacrificial-lamb}
+            Key: aws.yml
+
+      /opt/app/ssm.txt:
+        source:
+          Ssm:
+            ParameterName: /cicd/shared/kms/arn
+        commands:
+          post:
+            - file /opt/app/ssm.txt
+
+      /opt/app/secret.txt:
+        source:
+          Secret:
+            SecretId: GHToken
+
+.. attention::
+
+    The default user is root to avoid running into issues when using chmod/chown and other commands.
+    Change behaviour at your own risks.
 
 Features
---------
+=========
 
-* Pulls configuration files from S3 and inject into volumes
-* Pulls template files and render based on configuration or environment variables
+* Pulls configuration files from SSM | S3 | Secrets Manager | and inject into volumes
+* Allows to use environment variables for your YAML values. Limited operations.

docs/Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = python -msphinx
-SPHINXPROJ    = ecs_config_composer
+SPHINXPROJ    = ecs_files_composer
 SOURCEDIR     = .
 BUILDDIR      = _build
 

docs/conf.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# ecs_config_composer documentation build configuration file, created by
+# ecs_files_composer 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
@@ -22,7 +22,7 @@
 
 sys.path.insert(0, os.path.abspath('..'))
 
-import ecs_config_composer
+import ecs_files_composer
 
 # -- General configuration ---------------------------------------------
 
@@ -56,9 +56,9 @@
 # the built documents.
 #
 # The short X.Y version.
-version = ecs_config_composer.__version__
+version = ecs_files_composer.__version__
 # The full version, including alpha/beta/rc tags.
-release = ecs_config_composer.__version__
+release = ecs_files_composer.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -125,8 +125,8 @@
     "color_primary": "blue",
     "color_accent": "light-blue",
     # Set the repo location to get a badge with stats
-    "repo_url": "https://github.com/compose-x/ecs_config_composer/",
-    "repo_name": "compose-x/ecs_config_composer",
+    "repo_url": "https://github.com/compose-x/ecs_files_composer/",
+    "repo_name": "compose-x/ecs_files_composer",
     "repo_type": "github",
     # Visible levels of the global TOC; -1 means unlimited
     "globaltoc_depth": 2,
@@ -146,7 +146,7 @@
 # -- Options for HTMLHelp output ---------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'ecs_config_composerdoc'
+htmlhelp_basename = 'ecs_files_composerdoc'
 
 
 # -- Options for LaTeX output ------------------------------------------
@@ -170,14 +170,14 @@
 # (source start file, target name, title, author, documentclass
 # [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'ecs_config_composer.tex', 'ECS Config Composer Documentation', 'John Preston', 'manual'),
+    (master_doc, 'ecs_files_composer.tex', 'ECS Config Composer 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_config_composer', 'ECS Config Composer Documentation', [author], 1)]
+man_pages = [(master_doc, 'ecs_files_composer', 'ECS Config Composer Documentation', [author], 1)]
 
 # -- Options for Texinfo output ----------------------------------------
 
@@ -187,10 +187,10 @@
 texinfo_documents = [
     (
         master_doc,
-        'ecs_config_composer',
+        'ecs_files_composer',
         'ECS Config Composer Documentation',
         author,
-        'ecs_config_composer',
+        'ecs_files_composer',
         'One line description of project.',
         'Miscellaneous',
     ),