adeploy 1.0.0__tar.gz

adeploy-1.0.0/.gitignore

@@ -0,0 +1,107 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+/build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+.idea/

adeploy-1.0.0/.gitlab-ci.yml

@@ -0,0 +1,95 @@
+include:
+  - project: awesome/cicd
+    file: common.yml
+    ref: v1.0
+  - project: awesome/cicd
+    file: mkdocs.yml
+    ref: v1.0
+  - project: awesome/cicd
+    file: python.yml
+    ref: v1.0
+
+.install_common: &install_common |
+  test -z "$SLEEP" || debug_sleep
+  apt-get update
+  apt-get install -y apt-transport-https ca-certificates curl gpg jq
+
+.install_helm: &install_helm |
+  test -z "$SLEEP" || debug_sleep
+  helm_version=$(curl -s https://api.github.com/repos/helm/helm/releases  | jq '.[] | select( .tag_name | contains("v3")) | select( .tag_name | contains("rc") | not ) | .tag_name' -r | head -n1)
+  curl -L https://get.helm.sh/helm-${helm_version}-linux-amd64.tar.gz | tar xvz
+  mv linux-amd64/helm /usr/bin/helm
+  chmod +x /usr/bin/helm
+  rm -r linux-amd64
+  echo "Installed helm $(helm version --short)"  
+
+.install_kubectl: &install_kubectl |
+  test -z "$SLEEP" || debug_sleep
+  kubectl_version=$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)
+  curl -LO https://storage.googleapis.com/kubernetes-release/release/${kubectl_version}/bin/linux/amd64/kubectl
+  mv kubectl /usr/bin/kubectl
+  chmod +x /usr/bin/kubectl
+  echo "Installed kubectl $(kubectl version --client -o json | jq .clientVersion.gitVersion -r)"  
+
+.install_adeploy: &install_adeploy |
+  test -z "$SLEEP" || debug_sleep
+  python -m venv adeploy
+  source adeploy/bin/activate
+  pip install -e .
+  echo "Installed adeploy $(python runner.py --version)"
+
+.test_adeploy_jinja: &test_adeploy_jinja |
+  test -z "$SLEEP" || debug_sleep
+  for dir in examples/jinja/*
+  do
+    pushd $dir
+      mv build build.orig
+      python ../../../runner.py -d -p jinja render .
+      if [[ -e ".exclude-from-test" ]] ; then
+        diff -ru --exclude-from=../../.exclude-from-test --exclude-from=.exclude-from-test build build.orig
+      else 
+        diff -ru --exclude-from=../../.exclude-from-test build build.orig
+      fi
+    popd
+  done  
+
+.test_adeploy_helm: &test_adeploy_helm |
+  test -z "$SLEEP" || debug_sleep
+  for dir in examples/helm/*
+  do
+    pushd $dir
+      mv build build.orig
+      python ../../../runner.py -d -p helm --skip-validate render .
+      if [[ -e ".exclude-from-test" ]] ; then
+        diff -ru --exclude-from=../../.exclude-from-test --exclude-from=.exclude-from-test build build.orig
+      else 
+        diff -ru --exclude-from=../../.exclude-from-test build build.orig
+      fi
+    popd
+  done
+
+adeploy-test-python3.8:
+  stage: test
+  image: registry.awesome-it.de/upstream-dockerhub/python:3.8
+  script:
+    - *install_common
+    - *install_kubectl
+    - *install_adeploy
+    - *test_adeploy_jinja
+    - *install_helm
+    - *test_adeploy_helm
+  rules:
+    - if: ($CI_MERGE_REQUEST_TARGET_BRANCH_NAME == 'main' || $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == 'master')
+
+adeploy-test-python3.12:
+  stage: test
+  image: registry.awesome-it.de/upstream-dockerhub/python:3.12
+  script:
+    - *install_common
+    - *install_kubectl
+    - *install_adeploy
+    - *test_adeploy_jinja
+    - *install_helm
+    - *test_adeploy_helm
+  rules:
+    - if: ($CI_MERGE_REQUEST_TARGET_BRANCH_NAME == 'main' || $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == 'master')

adeploy-1.0.0/DEVELOP.md

@@ -0,0 +1,88 @@
+# adeploy
+
+This doc is for developers.
+
+## Setup for development usage
+
+Get the source code:
+
+```bash
+$ git clone https://gitlab.awesome-it.de/tools/adeploy.git ~/path/to/atracker
+```
+Setup a virtualenv using `Python3` and activate it:
+
+```bash
+$ virtualenv -p python3 ~/.virtualenvs/adeploy
+$ source ~/.virtualenvs/adeploy/bin/activate
+# alternatively install it in your project directory
+$ cd ~/path/to/adeploy
+$ virtualenv -p python3 env3
+$ source env3/bin/activate
+(adeploy)$ 
+```
+
+Install requirements:
+
+```bash
+(adeploy)$ pip install -r requirements.txt
+```
+#### Usage while developing
+
+There are two ways you can invoke adeploy while developing (i.e. while in your virtualenv).
+
+1. There is a wrapper that can be used to run it from your PATH. This is only intended for quick usage while development,
+not as a binary (i.e. don't link to it or anything; have a look at the next topic).
+```bash
+$ ./runner.py
+```
+
+2. The second way is via pip. Pip can install a python package in edit-mode. If you do this all code changes will
+immediately take effect. To skip the virtualenv, you can append "--user" to pip in order to install adeploy using the user scheme.
+ ```bash
+ $ cd ~/path/to/adeploy
+ $ pip install [--user] -e .
+ $ adeploy
+ # make changes
+ $ adeploy
+ # new behaviour, changes take effect immediately.
+````
+
+## Writing Documentation
+
+The docs are build via [MkDocs Material](https://squidfunk.github.io/mkdocs-material/), the markdown files are located in the `docs` subfolder.
+
+In order to create the docs, you need to install `mkdocs-material` and dependencies as follows:
+
+```bash
+pipx install mkdocs-material
+pipx inject mkdocs-material beautifulsoup4 # Required for hooks/asciinema.py
+pipx inject mkdocs-material "mkdocstrings[python]" # Required to read docstrings from python files i.e. filters.py
+```
+
+Now you run the `mkdocs` live preview at http://127.0.0.1:8000/ as follows:
+
+```bash
+mkdocs serve
+```
+
+Or generate static docs as:
+
+```bash
+mkdocs build
+```
+
+### Terminal records via `asciinema`
+
+Install `asciinema` as follows:
+
+```bash
+pipx install asciinema
+```
+
+To record you terminal sessions, use the following:
+
+```bash
+asciinema rec -c "bash --rcfile ~/.bashrc-asciinema" --rows 10 --cols 75 <output_file>.cast
+```
+
+Make sure to set your `PS1` variable to `$ ` in your `~/.bashrc-asciinema`.

adeploy-1.0.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2021, awesome information technology GmbH
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

adeploy-1.0.0/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.1
+Name: adeploy
+Version: 1.0.0
+Summary: Universal deployment tool for Kubernetes that supports rendering and deployment of lightweight Jinja templated k8s manifests as well as complex Helm charts.
+Author: awesome IT
+Author-email: Daniel Morlock <daniel.morlock@awesome-it.de>, Daniel Bross <daniel.bross@awesome-it.de>, Robin Lutz <robin.lutz@awesome-it.de>, Adrian Vielsack <adrian.vielsack@awesome-it.de>, Philip Flohr <philip.flohr@awesome-it.de>
+Project-URL: Homepage, https://awesome-it.de
+Project-URL: Source, https://github.com/awesome-it/adeploy
+Project-URL: Issues, https://github.com/awesome-it/adeploy/issues
+Project-URL: Documentation, https://awesome-it.de/docs/adeploy/latest
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: colorama>=0.4.3
+Requires-Dist: Jinja2
+Requires-Dist: PyYAML
+Requires-Dist: ruamel.yaml>=0.16.12
+Requires-Dist: ruamel.yaml.clib>=0.2.2
+Requires-Dist: packaging>=20.4
+Requires-Dist: shortuuid>=1.0.1
+Requires-Dist: watchdog>=3.0.0
+
+# adeploy
+
+<!-- --8<-- [start:intro] -->
+
+We build `adeploy`, an universal deployment tool for Kubernetes that supports rendering and deployment of lightweight 
+Jinja templated k8s manifests and also Helm charts. 
+
+We’ve added support for ... 
+
+* using **Jinja variables** from per cluster, namespaces or release configuration 
+* easy **secret management** based on [Gopass](https://github.com/gopasspw/gopass) or other command line based password managers
+* running deployment tests in **CI/CD pipelines**
+* **previewing** and **patching** upstream [Helm Charts](https://artifacthub.io/) before deploying
+* **extending** upstream Helm Charts with custom Jinja-templates manifests
+* handy templating for **labels, annotations, probes, resource limits** and other metadata
+
+... and even more to make your daily work with k8s easier.
+
+<!-- --8<-- [end:intro] -->
+
+## Documentation & Support 
+
+* `adeploy` is Open Source and hosted on GitHub: [https://github.com/awesome-it/adeploy](https://github.com/awesome-it/adeploy).
+* You can report issues on GitHub: [https://github.com/awesome-it/adeploy/issues](https://github.com/awesome-it/adeploy/issues).
+* Find the documentation at [https://awesome-it.de/docs/adeploy/latest](https://awesome-it.de/docs/adeploy/latest).
+
+## Examples
+
+This is how you can render, test (preview) and deploy a Helm Chart:
+[![asciicast](https://asciinema.org/a/iToqBOzT8t2Up6x6lRhjF0sk2.svg)](https://asciinema.org/a/iToqBOzT8t2Up6x6lRhjF0sk2)
+
+Or you can render, test (preview) and deploy Jinja-templated manifests:
+[![asciicast](https://asciinema.org/a/li2ZqLa5pnh6pj1KWoOrUIHOe.svg)](https://asciinema.org/a/li2ZqLa5pnh6pj1KWoOrUIHOe)
+
+You'll find some examples in the [example](https://github.com/awesome-it/adeploy/tree/master/examples) directory.
+
+## Getting Started
+
+<!-- --8<-- [start:install] -->
+
+You can find `adeploy` on [GitHub](https://github.com/awesome-it/adeploy). But it is recommended to install 
+or upgrade [adeploy](https://pipy.org/project/adeploy) using `pip`:
+
+```shell
+$ pip install adeploy
+```
+
+Or use [pipx](https://github.com/pypa/pipx) to install, upgrade and run `adeploy` in an isolated environment:
+
+```shell
+$ pipx install adeploy
+$ pipx upgrade adeploy
+```
+
+You should now be able to run `adeploy` from the command line:
+
+```shell
+adeploy --help
+```
+
+You can now start to use `adeploy`.  
+
+<!-- --8<-- [end:install] -->
+
+See the [usage documentation](https://awesome-it.de/docs/adeploy/latest/usage/) to start using `adeploy`.
+
+## Read More
+
+* https://awesome-it.de/2020/09/11/adeploy-an-universal-deployment-tool-for-kubernetes/

adeploy-1.0.0/README.md

@@ -0,0 +1,69 @@
+# adeploy
+
+<!-- --8<-- [start:intro] -->
+
+We build `adeploy`, an universal deployment tool for Kubernetes that supports rendering and deployment of lightweight 
+Jinja templated k8s manifests and also Helm charts. 
+
+We’ve added support for ... 
+
+* using **Jinja variables** from per cluster, namespaces or release configuration 
+* easy **secret management** based on [Gopass](https://github.com/gopasspw/gopass) or other command line based password managers
+* running deployment tests in **CI/CD pipelines**
+* **previewing** and **patching** upstream [Helm Charts](https://artifacthub.io/) before deploying
+* **extending** upstream Helm Charts with custom Jinja-templates manifests
+* handy templating for **labels, annotations, probes, resource limits** and other metadata
+
+... and even more to make your daily work with k8s easier.
+
+<!-- --8<-- [end:intro] -->
+
+## Documentation & Support 
+
+* `adeploy` is Open Source and hosted on GitHub: [https://github.com/awesome-it/adeploy](https://github.com/awesome-it/adeploy).
+* You can report issues on GitHub: [https://github.com/awesome-it/adeploy/issues](https://github.com/awesome-it/adeploy/issues).
+* Find the documentation at [https://awesome-it.de/docs/adeploy/latest](https://awesome-it.de/docs/adeploy/latest).
+
+## Examples
+
+This is how you can render, test (preview) and deploy a Helm Chart:
+[![asciicast](https://asciinema.org/a/iToqBOzT8t2Up6x6lRhjF0sk2.svg)](https://asciinema.org/a/iToqBOzT8t2Up6x6lRhjF0sk2)
+
+Or you can render, test (preview) and deploy Jinja-templated manifests:
+[![asciicast](https://asciinema.org/a/li2ZqLa5pnh6pj1KWoOrUIHOe.svg)](https://asciinema.org/a/li2ZqLa5pnh6pj1KWoOrUIHOe)
+
+You'll find some examples in the [example](https://github.com/awesome-it/adeploy/tree/master/examples) directory.
+
+## Getting Started
+
+<!-- --8<-- [start:install] -->
+
+You can find `adeploy` on [GitHub](https://github.com/awesome-it/adeploy). But it is recommended to install 
+or upgrade [adeploy](https://pipy.org/project/adeploy) using `pip`:
+
+```shell
+$ pip install adeploy
+```
+
+Or use [pipx](https://github.com/pypa/pipx) to install, upgrade and run `adeploy` in an isolated environment:
+
+```shell
+$ pipx install adeploy
+$ pipx upgrade adeploy
+```
+
+You should now be able to run `adeploy` from the command line:
+
+```shell
+adeploy --help
+```
+
+You can now start to use `adeploy`.  
+
+<!-- --8<-- [end:install] -->
+
+See the [usage documentation](https://awesome-it.de/docs/adeploy/latest/usage/) to start using `adeploy`.
+
+## Read More
+
+* https://awesome-it.de/2020/09/11/adeploy-an-universal-deployment-tool-for-kubernetes/

adeploy-1.0.0/adeploy/common/args.py

@@ -0,0 +1,112 @@
+import argparse
+import sys
+from pathlib import Path
+
+from adeploy import steps
+from adeploy.common import colors
+from adeploy.common.helpers import get_submodules
+
+__args: argparse.Namespace
+__unknown_args: argparse.Namespace
+
+
+def get_args():
+    global __args
+    return __args
+
+
+def parse(parser: argparse.ArgumentParser):
+    global __args, __unknown_args
+
+    # Pass --help to a provider if a provider was already specified
+    if ('--help' in sys.argv or '-h' in sys.argv) and ('--provider' in sys.argv or '-p' in sys.argv):
+        real_args = list(filter(lambda x: x not in ['--help', '-h'], sys.argv))
+        args, unknown_args = parser.parse_known_args(real_args[1:])
+        unknown_args.append('--help')
+    else:
+        args, unknown_args = parser.parse_known_args()
+
+    __args = args
+    __unknown_args = unknown_args
+
+    return args, unknown_args
+
+
+def setup_parser():
+    parser = argparse.ArgumentParser(description='An awesome universal deployment tool for k8s',
+                                     usage=colors.bold(
+                                         f'adeploy -p {colors.blue("provider")} {colors.gray("[optional args ...]")} '
+                                         f'{colors.blue("build-step")} {colors.gray("[optional build args ...]")} '
+                                         f'{colors.blue("src_dir")} [{colors.blue("src_dir")} ...]'))
+
+    parser.add_argument('-l', '--log', dest='logfile', help='Path to logfile')
+
+    parser.add_argument('-d', '--debug', action='store_true')
+
+    parser.add_argument('-s', '--skip-colors', dest='skip_colors', action='store_true')
+
+    parser.add_argument('-f', '--force', dest='force', action='store_true')
+
+    parser.add_argument('-p', '--provider', dest='provider',
+                        help='The provider to use, type --providers to get a list of supported providers.',
+                        required='--providers' not in sys.argv and '--version' not in sys.argv)
+
+    parser.add_argument('--providers', dest='list_providers', action='store_true',
+                        help='A list of supported providers')
+
+    parser.add_argument('-n', '--name', dest="deployment_name", default=None,
+                        help='Specify a deployment name. This will overwrite deployment name derived from repo dir')
+
+    parser.add_argument('--adeploy-dir', dest='adeploy_dir',
+                        help='Configuration directory for adeploy', default=Path.home().joinpath('.adeploy'),
+                        metavar='adeploy_dir', type=Path)
+
+    parser.add_argument('--build-dir', dest='build_dir',
+                        help='Build directory for output', default='./build', metavar='build_dir')
+
+    parser.add_argument('--defaults', dest='defaults_path', default='defaults.yml',
+                        help='YML file or directory containing <deployment_name>.yml with default variables. '
+                             'Relative to source dirs.')
+
+    parser.add_argument('--namespaces', dest='namespaces_dir', default='namespaces',
+                        help='Directory containing namespaces and variables for deployments')
+
+    parser.add_argument('--recreate-secrets', dest='recreate_secrets', action='store_true',
+                        help='Force to re-create secrets. This might invoke a password store to retrieve secrets.')
+
+    parser.add_argument('--filter-namespace', dest='filters_namespace', nargs='+', action='append',
+                        help='Only include specified namespace. Argument can be specified multiple times.')
+
+    parser.add_argument('--filter-release', dest='filters_release', nargs='+', action='append',
+                        help='Only include specified deployment release i.e. "prod", "testing". '
+                             'Argument can be specified multiple times.')
+
+    parser.add_argument('--show-configs', dest='show_configs', action='store_true', default=False,
+                        help='Print out rendered namespace configurations and quit.')
+
+    parser.add_argument('--gopass-repo', dest='gopass_repo', nargs='+', action='append',
+                        help='Gopass repo names, where the awesome secrets are stored. This argument can be specified '
+                             'multiple times for multiple Gpoass repos. This params can also be specified by the env '
+                             'var ADEPLOY_GOPASS_REPOS where comma separated list of Gopass repo names is expected. '
+                             'If args are specified, these take precedence and the env var is ignored.')
+
+    parser.add_argument('--version', action='store_true', help='Print version and exit')
+
+    subparsers = parser.add_subparsers(title=f'Available build steps', metavar=colors.bold('build-steps'))
+
+    for (module, class_name) in get_submodules(steps):
+        module_name = module.__name__
+        subparser = subparsers.add_parser(module_name,
+                                          help=f'Call module "{module_name}", '
+                                               f'type: {sys.argv[0]} {module_name} --help for more options')
+        subparser.add_argument("src_dirs",
+                               help="Directory containing deployment sources",
+                               nargs='*', default='.', metavar='src_dir')
+
+        if module_name == 'config':
+            subparser.add_argument("-o,--out", dest='config_out', default="",
+                                   help="Filename to store the rendered namespace configurations as JSON.")
+
+        subparser.add_argument(f'--{module_name}', default=True, help=argparse.SUPPRESS)
+
+    return parser

adeploy-1.0.0/adeploy/common/colors.py

@@ -0,0 +1,49 @@
+from colorama import Style, Fore
+
+_skip_colors = False
+
+
+def skip_colors(skip=True):
+    global _skip_colors
+    _skip_colors = skip
+
+
+def blue(text):
+    return f'{Fore.BLUE}{text}{Fore.RESET}' if not _skip_colors else text
+
+
+def green(text):
+    return f'{Fore.GREEN}{text}{Fore.RESET}' if not _skip_colors else text
+
+
+def red(text):
+    return f'{Fore.RED}{text}{Fore.RESET}' if not _skip_colors else text
+
+
+def orange(text):
+    return f'{Fore.YELLOW}{text}{Fore.RESET}' if not _skip_colors else text
+
+
+def gray(text):
+    # Fore.Gray is not readable in some terminals.
+    return f'{Fore.RESET}{text}' if not _skip_colors else text
+
+
+def bold(text):
+    return f'{Style.BRIGHT}{text}{Style.NORMAL}' if not _skip_colors else text
+
+
+def red_bold(text):
+    return bold(red(text))
+
+
+def green_bold(text):
+    return bold(green(text))
+
+
+def blue_bold(text):
+    return bold(blue(text))
+
+
+def orange_bold(text):
+    return bold(orange(text))