├── .gitignore ├── CHANGES.txt ├── LICENSE ├── MANIFEST.in ├── README.md ├── bin └── meta-compose ├── meta-compose ├── metacompose ├── __init__.py └── cli │ ├── __init__.py │ └── main.py ├── requirements.txt ├── setup.py └── tests ├── __init__.py └── simple_template_test.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | *.egg-info/ 23 | .installed.cfg 24 | *.egg 25 | 26 | # PyInstaller 27 | # Usually these files are written by a python script from a template 28 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 29 | *.manifest 30 | *.spec 31 | 32 | # Installer logs 33 | pip-log.txt 34 | pip-delete-this-directory.txt 35 | 36 | # Unit test / coverage reports 37 | htmlcov/ 38 | .tox/ 39 | .coverage 40 | .coverage.* 41 | .cache 42 | nosetests.xml 43 | coverage.xml 44 | *,cover 45 | 46 | # Translations 47 | *.mo 48 | *.pot 49 | 50 | # Django stuff: 51 | *.log 52 | 53 | # Sphinx documentation 54 | docs/_build/ 55 | 56 | # PyBuilder 57 | target/ 58 | 59 | .test 60 | -------------------------------------------------------------------------------- /CHANGES.txt: -------------------------------------------------------------------------------- 1 | v0.1.0, 2015-06-06 -- Initial release. 2 | v0.1.1, 2015-06-10 -- Make meta-compose-data.yml optional 3 | v0.1.2, 2015-07-13 -- Allow multiple data files 4 | v0.1.3, 2015-07-14 -- Make template and output files configurable, fixed bug 5 | that made it fail when no data file was specified 6 | v0.1.4, 2016-01-27 -- Add fileglob filter 7 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE 2 | include requirements.txt 3 | include *.md 4 | recursive-include tests * 5 | global-exclude *.pyc 6 | global-exclude *.pyo 7 | global-exclude *.un~ 8 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # meta-compose 2 | 3 | This package aims to solve the problem of variable substitution in 4 | docker-compose files by parsing them as [Jinja2](http://jinja.pocoo.org/) 5 | template. 6 | 7 | It was inspired by the discussion 8 | [here](https://github.com/docker/compose/issues/1377) 9 | 10 | It supports variable declaration in a separate YAML file as well as 11 | access to environment variables. 12 | 13 | ## Quickstart: 14 | 15 | - Install with `pip install meta-compose` 16 | 17 | - Create a file `meta-compose.yml` that is a [Jinja2](http://jinja.pocoo.org/) 18 | template for a docker compose file. 19 | 20 | - [Optional] Create a file `meta-compose-data.yml` that contains the variables 21 | used in the template that are not environment variables. 22 | 23 | - Call `meta-compose` and it will create a docker-compose.yml in the current 24 | directory 25 | 26 | ## Usage 27 | 28 | ``` 29 | usage: meta-compose [-h] [-d DATAFILE] [-t TEMPLATE] [-o OUTPUTFILE] 30 | 31 | optional arguments: 32 | -h, --help show this help message and exit 33 | -d DATAFILE, --datafile DATAFILE 34 | Use to specify data files in addition to meta-compose- 35 | data.yml. They must be JSON or YAML files. 36 | -t TEMPLATE, --template TEMPLATE 37 | Use to specify the template file to use. Defaults to 38 | ./meta-compose.yml 39 | -o OUTPUTFILE, --outputfile OUTPUTFILE 40 | Use to specify the output file to create. Defaults to 41 | ./docker-compose.yml 42 | ``` 43 | 44 | ## Syntax of meta-compose.yml 45 | 46 | - Everything in basic [Jinja2](http://jinja.pocoo.org/) is allowed. 47 | 48 | - To access environment variables use `{{'default'| env('VARIABLE_NAME')}}` 49 | where `VARIABLE_NAME` is the name of your environment variable and `default` 50 | is the default value you want it to be if the environment variable is not set. 51 | -------------------------------------------------------------------------------- /bin/meta-compose: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | from metacompose.cli.main import main 3 | main() 4 | -------------------------------------------------------------------------------- /meta-compose: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | from metacompose.cli.main import main 3 | main() 4 | -------------------------------------------------------------------------------- /metacompose/__init__.py: -------------------------------------------------------------------------------- 1 | __version__ = '0.1.4' 2 | -------------------------------------------------------------------------------- /metacompose/cli/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/webcrofting/meta-compose/e52e0c8ce3c9877477b6443d5c94f2896db071c8/metacompose/cli/__init__.py -------------------------------------------------------------------------------- /metacompose/cli/main.py: -------------------------------------------------------------------------------- 1 | import glob 2 | import sys 3 | import os 4 | import yaml 5 | from jinja2 import Environment, FileSystemLoader, StrictUndefined 6 | import argparse 7 | 8 | def env_override(value, key): 9 | return os.getenv(key, value) 10 | 11 | 12 | def fileglob(pathname): 13 | return glob.glob(pathname) 14 | 15 | 16 | def parse_args(): 17 | 18 | parser = argparse.ArgumentParser() 19 | 20 | parser.add_argument( 21 | "-d", "--datafile", action='append', 22 | default=[], 23 | help="Use to specify data files in addition to meta-compose-data.yml. " 24 | "They must be JSON or YAML files.") 25 | 26 | parser.add_argument( 27 | "-t", "--template", 28 | default="./meta-compose.yml", 29 | help="Use to specify the template file to use. " 30 | "Defaults to ./meta-compose.yml") 31 | 32 | parser.add_argument( 33 | "-o", "--outputfile", 34 | default="./docker-compose.yml", 35 | help="Use to specify the output file to create. " 36 | "Defaults to ./docker-compose.yml") 37 | 38 | return parser.parse_args() 39 | 40 | def setup_jinja(template_file_name): 41 | 42 | jinja = Environment(loader=FileSystemLoader("."), undefined=StrictUndefined) 43 | jinja.filters['env'] = env_override 44 | jinja.filters['fileglob'] = fileglob 45 | return jinja.get_template(template_file_name) 46 | 47 | def collect_data(data_file_names): 48 | 49 | data = {} 50 | for data_file_name in data_file_names: 51 | if os.path.isfile(data_file_name): 52 | with open(data_file_name, "r") as fh: 53 | data.update(yaml.safe_load(fh)) 54 | return data 55 | 56 | def write_compose_file(composition, outputfile): 57 | 58 | with open(outputfile, "w") as fh: 59 | fh.write(composition) 60 | 61 | 62 | 63 | def main(): 64 | 65 | args = parse_args() 66 | 67 | 68 | template = setup_jinja(args.template) 69 | data = collect_data(["meta-compose-data.yml"] + args.datafile) 70 | 71 | write_compose_file(template.render(data), args.outputfile) 72 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | docker-compose 2 | Jinja2 3 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | from __future__ import unicode_literals 4 | from __future__ import absolute_import 5 | from setuptools import setup, find_packages 6 | import codecs 7 | import os 8 | import re 9 | import sys 10 | 11 | 12 | def read(*parts): 13 | path = os.path.join(os.path.dirname(__file__), *parts) 14 | with codecs.open(path, encoding='utf-8') as fobj: 15 | return fobj.read() 16 | 17 | 18 | def find_version(*file_paths): 19 | version_file = read(*file_paths) 20 | version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", 21 | version_file, re.M) 22 | if version_match: 23 | return version_match.group(1) 24 | raise RuntimeError("Unable to find version string.") 25 | 26 | 27 | install_requires = [ 28 | 'docker-compose >= 1.2, < 2', 29 | 'Jinja2 >= 2.7, < 3', 30 | ] 31 | 32 | 33 | 34 | setup( 35 | name='meta-compose', 36 | version=find_version("metacompose", "__init__.py"), 37 | description='Templating wrapper for docker-compose', 38 | url='https://github.com/webcrofting/meta-compose', 39 | author='Christoph Witzany', 40 | license='Apache License 2.0', 41 | packages=find_packages(exclude=['tests.*', 'tests']), 42 | include_package_data=True, 43 | install_requires=install_requires, 44 | entry_points=""" 45 | [console_scripts] 46 | meta-compose=metacompose.cli.main:main 47 | """, 48 | ) 49 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | if sys.version_info >= (2, 7): 4 | import unittest # NOQA 5 | else: 6 | import unittest2 as unittest # NOQA 7 | -------------------------------------------------------------------------------- /tests/simple_template_test.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/webcrofting/meta-compose/e52e0c8ce3c9877477b6443d5c94f2896db071c8/tests/simple_template_test.py --------------------------------------------------------------------------------