kubernator 1.0.21__tar.gz → 1.0.22__tar.gz

{kubernator-1.0.21 → kubernator-1.0.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kubernator
-Version: 1.0.21
+Version: 1.0.22
 Summary: Kubernator is the a pluggable framework for K8S provisioning
 Home-page: https://github.com/karellen/kubernator
 Author: Express Systems USA, Inc.

{kubernator-1.0.21 → kubernator-1.0.22}/kubernator/__init__.py

@@ -16,7 +16,7 @@
 #   limitations under the License.
 #
 
-__version__ = "1.0.21"
+__version__ = "1.0.22"
 
 
 def _main():

{kubernator-1.0.21 → kubernator-1.0.22}/kubernator/api.py

@@ -20,6 +20,7 @@ import fnmatch
 import json
 import logging
 import os
+import io
 import platform
 import re
 import sys
@@ -58,6 +59,53 @@ _CACHE_HEADER_TRANSLATION = {"etag": "if-none-match",
 _CACHE_HEADERS = ("etag", "last-modified")
 
 
+class TemplateEngine:
+    VARIABLE_START_STRING = "{${"
+    VARIABLE_END_STRING = "}$}"
+
+    def __init__(self, logger):
+        self.template_failures = 0
+        self.templates = {}
+
+        class CollectingUndefined(ChainableUndefined):
+            __slots__ = ()
+
+            def __str__(self):
+                self.template_failures += 1
+                return super().__str__()
+
+        logging_undefined = make_logging_undefined(
+            logger=logger,
+            base=CollectingUndefined
+        )
+
+        @pass_context
+        def variable_finalizer(ctx, value):
+            normalized_value = str(value)
+            if self.VARIABLE_START_STRING in normalized_value and self.VARIABLE_END_STRING in normalized_value:
+                value_template_content = sys.intern(normalized_value)
+                env: Environment = ctx.environment
+                value_template = self.templates.get(value_template_content)
+                if not value_template:
+                    value_template = env.from_string(value_template_content, env.globals)
+                    self.templates[value_template_content] = value_template
+                return value_template.render(ctx.parent)
+
+            return normalized_value
+
+        self.env = Environment(variable_start_string=self.VARIABLE_START_STRING,
+                               variable_end_string=self.VARIABLE_END_STRING,
+                               autoescape=False,
+                               finalize=variable_finalizer,
+                               undefined=logging_undefined)
+
+    def from_string(self, template):
+        return self.env.from_string(template)
+
+    def failures(self):
+        return self.template_failures
+
+
 def calling_frame_source(depth=2):
     f = traceback.extract_stack(limit=depth + 1)[0]
     return f"file {f.filename}, line {f.lineno} in {f.name}"
@@ -96,9 +144,15 @@ class FileType(Enum):
         self.func = func
 
 
-def _load_file(logger, path: Path, file_type: FileType, source=None) -> Iterable[dict]:
-    with open(path, "rb") as f:
+def _load_file(logger, path: Path, file_type: FileType, source=None,
+               template_engine: Optional[TemplateEngine] = None,
+               template_context: Optional[dict] = None) -> Iterable[dict]:
+    with open(path, "rb" if not template_engine else "rt") as f:
         try:
+            if template_engine:
+                raw_data = template_engine.from_string(f.read()).render(template_context)
+                f.close()
+                f = io.StringIO(raw_data)
             data = file_type.func(f)
             if isinstance(data, GeneratorType):
                 data = list(data)
@@ -191,9 +245,12 @@ def load_remote_file(logger, url, file_type: FileType, category: str = "k8s", su
     return _load_file(logger, file_name, file_type, url)
 
 
-def load_file(logger, path: Path, file_type: FileType, source=None) -> Iterable[dict]:
+def load_file(logger, path: Path, file_type: FileType, source=None,
+              template_engine: Optional[TemplateEngine] = None,
+              template_context: Optional[dict] = None) -> Iterable[dict]:
     logger.debug("Loading %s using %s", source or path, file_type.name)
-    return _load_file(logger, path, file_type)
+    return _load_file(logger, path, file_type,
+                      source, template_engine, template_context)
 
 
 def validator_with_defaults(validator_class):
@@ -513,53 +570,6 @@ class Globs(MutableSet[Union[str, re.Pattern]]):
         return f"Globs[{self._list}]"
 
 
-class TemplateEngine:
-    VARIABLE_START_STRING = "{${"
-    VARIABLE_END_STRING = "}$}"
-
-    def __init__(self, logger):
-        self.template_failures = 0
-        self.templates = {}
-
-        class CollectingUndefined(ChainableUndefined):
-            __slots__ = ()
-
-            def __str__(self):
-                self.template_failures += 1
-                return super().__str__()
-
-        logging_undefined = make_logging_undefined(
-            logger=logger,
-            base=CollectingUndefined
-        )
-
-        @pass_context
-        def variable_finalizer(ctx, value):
-            normalized_value = str(value)
-            if self.VARIABLE_START_STRING in normalized_value and self.VARIABLE_END_STRING in normalized_value:
-                value_template_content = sys.intern(normalized_value)
-                env: Environment = ctx.environment
-                value_template = self.templates.get(value_template_content)
-                if not value_template:
-                    value_template = env.from_string(value_template_content, env.globals)
-                    self.templates[value_template_content] = value_template
-                return value_template.render(ctx.parent)
-
-            return normalized_value
-
-        self.env = Environment(variable_start_string=self.VARIABLE_START_STRING,
-                               variable_end_string=self.VARIABLE_END_STRING,
-                               autoescape=False,
-                               finalize=variable_finalizer,
-                               undefined=logging_undefined)
-
-    def from_string(self, template):
-        return self.env.from_string(template)
-
-    def failures(self):
-        return self.template_failures
-
-
 class Template:
     def __init__(self, name: str, template: JinjaTemplate, defaults: dict = None, path=None, source=None):
         self.name = name

{kubernator-1.0.21 → kubernator-1.0.22}/kubernator/plugins/helm.py

@@ -37,7 +37,7 @@ from kubernator.api import (KubernatorPlugin, Globs, StripNL,
                             validator_with_defaults,
                             get_golang_os,
                             get_golang_machine,
-                            prepend_os_path
+                            prepend_os_path, TemplateEngine
                             )
 from kubernator.plugins.k8s_api import K8SResource
 from kubernator.proc import DEVNULL
@@ -102,6 +102,7 @@ class HelmPlugin(KubernatorPlugin):
         self.context = None
         self.repositories = set()
         self.helm_dir = None
+        self.template_engine = TemplateEngine(logger)
 
     def set_context(self, context):
         self.context = context
@@ -180,7 +181,9 @@ class HelmPlugin(KubernatorPlugin):
             display_p = context.app.display_path(p)
             logger.debug("Adding Helm template from %s", display_p)
 
-            helm_templates = load_file(logger, p, FileType.YAML, display_p)
+            helm_templates = load_file(logger, p, FileType.YAML, display_p,
+                                       self.template_engine,
+                                       {"ktor": context})
 
             for helm_template in helm_templates:
                 self._add_helm(helm_template, display_p)
@@ -232,6 +235,17 @@ class HelmPlugin(KubernatorPlugin):
             values_file = Path(values_file)
             if not values_file.is_absolute():
                 values_file = self.context.app.cwd / values_file
+            values = list(load_file(logger, values_file, FileType.YAML,
+                                    template_engine=self.template_engine,
+                                    template_context={"ktor": self.context,
+                                                      "helm": {"chart": chart,
+                                                               "name": name,
+                                                               "namespace": namespace,
+                                                               "include_crds": include_crds,
+                                                               "repository": repository,
+                                                               "version": version,
+                                                               }}))
+            values = values[0] if values else {}
 
         version_spec = []
         if repository:
@@ -260,8 +274,7 @@ class HelmPlugin(KubernatorPlugin):
                                                         ] +
                                                        version_spec +
                                                        (["--include-crds"] if include_crds else []) +
-                                                       (["-f", values_file] if values_file else []) +
-                                                       (["-f", "-"] if values else []),
+                                                       ["-f", "-"],
                                                        stderr_logger,
                                                        stdin=stdin,
                                                        )

{kubernator-1.0.21 → kubernator-1.0.22}/kubernator/plugins/istio.py

@@ -33,7 +33,7 @@ from kubernator.api import (KubernatorPlugin, scan_dir,
                             Globs,
                             get_golang_os,
                             get_golang_machine,
-                            prepend_os_path, jp)
+                            prepend_os_path, jp, load_file)
 from kubernator.plugins.k8s_api import K8SResourcePluginMixin
 
 logger = logging.getLogger("kubernator.istio")
@@ -210,10 +210,11 @@ class IstioPlugin(KubernatorPlugin, K8SResourcePluginMixin):
             display_p = context.app.display_path(p)
             logger.info("Adding Istio Operator from %s", display_p)
 
-            with open(p, "rt") as file:
-                template = self.template_engine.from_string(file.read())
+            manifests = load_file(logger, p, FileType.YAML, display_p,
+                                  self.template_engine,
+                                  {"ktor": context})
 
-            self.add_resources(template.render({"ktor": context}), display_p)
+            self.add_resources(manifests, display_p)
 
     def handle_apply(self):
         context = self.context

{kubernator-1.0.21 → kubernator-1.0.22}/kubernator/plugins/k8s.py

@@ -38,7 +38,8 @@ from kubernator.api import (KubernatorPlugin,
                             FileType,
                             load_remote_file,
                             StripNL,
-                            install_python_k8s_client)
+                            install_python_k8s_client,
+                            TemplateEngine)
 from kubernator.merge import extract_merge_instructions, apply_merge_instructions
 from kubernator.plugins.k8s_api import (K8SResourcePluginMixin,
                                         K8SResource,
@@ -95,6 +96,7 @@ class KubernetesPlugin(KubernatorPlugin, K8SResourcePluginMixin):
         self._transformers = []
         self._validators = []
         self._summary = 0, 0, 0
+        self._template_engine = TemplateEngine(logger)
 
     def set_context(self, context):
         self.context = context
@@ -239,7 +241,10 @@ class KubernetesPlugin(KubernatorPlugin, K8SResourcePluginMixin):
             display_p = context.app.display_path(p)
             logger.debug("Adding Kubernetes manifest from %s", display_p)
 
-            manifests = load_file(logger, p, FileType.YAML, display_p)
+            manifests = load_file(logger, p, FileType.YAML, display_p,
+                                  self._template_engine,
+                                  {"ktor": context}
+                                  )
 
             for manifest in manifests:
                 if manifest:

{kubernator-1.0.21 → kubernator-1.0.22}/kubernator/plugins/kops.py

@@ -30,7 +30,7 @@ from kubernator.api import (KubernatorPlugin, scan_dir,
                             io_StringIO,
                             TemplateEngine,
                             StripNL,
-                            Globs)
+                            Globs, load_file)
 from kubernator.plugins.k8s_api import K8SResourcePluginMixin
 from kubernator.proc import CalledProcessError
 
@@ -136,10 +136,11 @@ class KopsPlugin(KubernatorPlugin, K8SResourcePluginMixin):
             display_p = context.app.display_path(p)
             logger.debug("Adding Kops resources from %s", display_p)
 
-            with open(p, "rt") as file:
-                template = self.template_engine.from_string(file.read())
+            manifests = load_file(logger, p, FileType.YAML, display_p,
+                                  self.template_engine,
+                                  {"ktor": context})
 
-            self.add_resources(template.render({"ktor": context}), display_p)
+            self.add_resources(manifests, display_p)
 
     def update(self):
         context = self.context

{kubernator-1.0.21 → kubernator-1.0.22}/kubernator.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kubernator
-Version: 1.0.21
+Version: 1.0.22
 Summary: Kubernator is the a pluggable framework for K8S provisioning
 Home-page: https://github.com/karellen/kubernator
 Author: Express Systems USA, Inc.

{kubernator-1.0.21 → kubernator-1.0.22}/setup.py

@@ -21,7 +21,7 @@ class install(_install):
 if __name__ == '__main__':
     setup(
         name = 'kubernator',
-        version = '1.0.21',
+        version = '1.0.22',
         description = 'Kubernator is the a pluggable framework for K8S provisioning',
         long_description = '# Kubernator\n\nKubernator™ (Ktor™) is an integrated solution for the Kubernetes state management. It operates on directories,\nprocessing their content via a collection of plugins, generating Kubernetes resources in the process, validating them,\ntransforming them and then applying against the Kubernetes cluster.\n\n[![Gitter](https://img.shields.io/gitter/room/karellen/lobby?logo=gitter)](https://gitter.im/karellen/Lobby)\n[![Build Status](https://img.shields.io/github/actions/workflow/status/karellen/kubernator/kubernator.yml?branch=master)](https://github.com/karellen/kubernator/actions/workflows/kubernator.yml)\n[![Coverage Status](https://img.shields.io/coveralls/github/karellen/kubernator/master?logo=coveralls)](https://coveralls.io/r/karellen/kubernator?branch=master)\n\n[![Kubernator Version](https://img.shields.io/pypi/v/kubernator?logo=pypi)](https://pypi.org/project/kubernator/)\n[![Kubernator Python Versions](https://img.shields.io/pypi/pyversions/kubernator?logo=pypi)](https://pypi.org/project/kubernator/)\n[![Kubernator Downloads Per Day](https://img.shields.io/pypi/dd/kubernator?logo=pypi)](https://pypi.org/project/kubernator/)\n[![Kubernator Downloads Per Week](https://img.shields.io/pypi/dw/kubernator?logo=pypi)](https://pypi.org/project/kubernator/)\n[![Kubernator Downloads Per Month](https://img.shields.io/pypi/dm/kubernator?logo=pypi)](https://pypi.org/project/kubernator/)\n\n## Notices\n\n### Beta Software\n\nWhile fully functional in the current state and used in production, this software is in **BETA**. A lot of things\nare expected to change rapidly, including main APIs, initialization procedures and some core features. Documentation at\nthis stage is basically non-existent.\n\n### License\n\nThe product is licensed under the Apache License, Version 2.0. Please see LICENSE for further details.\n\n### Warranties and Liability\n\nKubernator and its plugins are provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either\nexpress or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,\nMERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of\nusing or redistributing Kubernator and assume any risks associated with doing so.\n\n### Trademarks\n\n"Kubernator" and "Ktor" are trademarks or registered trademarks of Express Systems USA, Inc and Karellen, Inc. All other\ntrademarks are property of their respective owners.\n\n## Problem Statement\n\n## Solution\n\n## Using Kubernator with Docker\n\nA simple example is as follows:\n```\n$ docker run --mount type=bind,source="$(pwd)",target=/root,readonly -t ghcr.io/karellen/kubernator:latest\n```\n\n## Using Kubernator on MacOS\n\n```\n$ brew install python3.11\n$ pip3.11 install \'kubernator~=1.0.9\'\n$ kubernator --version\n```\n\nPlease note, that some plugins (e.g. `awscli`, `eks`) may require additional volume mounts or environmental\nvariables to be passed for credentials and other external configuration.\n\n## Mode of Operation\n\nKubernator is a command line utility. Upon startup and processing of the command line arguments and initializing\nlogging, Kubernator initializes plugins. Current plugins include:\n\n0. Kubernator App\n1. Terraform\n2. kOps\n3. Kubernetes\n4. Helm\n5. Template\n\nThe order of initialization matters as it\'s the order the plugin handlers are executed!\n\nThe entire application operates in the following stages by invoking each plugin\'s stage handler in sequence:\n\n1. Plugin Init Stage\n2. Pre-start script (if specified)\n3. Plugin Start Stage\n4. For each directory in the pipeline:\n    1. Plugin Before Directory Stage\n    2. If `.kubernator.py` is present in the directory:\n        1. Plugin Before Script Stage\n        2. `.kubernator.py` script\n        3. Plugin After Script Stage\n    3. Plugin After Directory Stage\n5. Plugin End Stage\n\nEach plugin individually plays a specific role and performs a specific function which will be described in a later\nsection.\n\n## State/Context\n\nThere is a global state that is carried through as the application is running. It is a hierarchy of objects (`context`)\nthat follows the parent-child relationship as the application traverses the directory structure. For example, given the\ndirectory structure `/a/b`, `/a/c`, and `/a/c/d` any value of the context set or modified in context scoped to\ndirectory `/a` is visible in directories `/a/b`, `/a/c` and `/a/c/d`, while the same modified or set in `/a/b` is only\nvisible there, while one in `/a/c` is visible in `/a/c` and in `/a/c/d` but not `/a` or `/a/b`.\n\nAdditionally, there is a `context.globals` which is the top-most context that is available in all stages that are not\nassociated with the directory structure.\n\nNote, that in cases where the directory structure traversal moves to remote directories (that are actualized by local\ntemporary directories), such remote directory structure enters the context hierarchy as a child of the directory in\nwhich remote was registered.\n\nAlso note, that context carries not just data by references to essential functions.\n\nIn pre-start and `.kubernator.py` scripts the context is fully available as a global variable `ktor`.\n\n### Plugins\n\n#### Kubernator App Plugin\n\nThe role of the Kubernator App Plugin is to traverse the directory structure, expose essential functions through context\nand to run Kubernator scripts.\n\nIn the *After Directory Stage* Kubernator app scans the directories immediately available in the current, sorts them in\nthe alphabetic order, excludes those matching any of the patterns in `context.app.excludes` and then queues up the\nremaining directories in the order the match the patterns in `context.app.includes`.\n\nThus, for a directory content `/a/foo`, `/a/bal`, `/a/bar`, `/a/baz`, excludes `f*`, and includes `baz` and `*`, the\nresulting queue of directories to traverse will be `/a/baz`, `/a/bal`, `/a/bar`.\n\nNotice, that user can further interfere with processing order of the directory queue by asking Kubernator to walk\narbitrary paths, both local and remote.\n\n##### Context\n\n* `ktor.app.args`\n  > Namespace containing command line argument values\n* `ktor.app.walk_local(*paths: Union[Path, str, bytes])`\n  > Immediately schedules the paths to be traversed after the current directory by adding them to the queue\n  > Relative path is relative to the current directory\n* `ktor.app.walk_remote(repo, *path_prefixes: Union[Path, str, bytes])`\n  > Immediately schedules the path prefixes under the remote repo URL to be traversed after the current directory by\n  > adding them to the queue. Only Git URLs are currently supported.\n  > All absolute path prefixes are relativized based on the repository.\n* `ktor.app.repository_credentials_provider(func: Callable)`\n  > Sets a repository credentials provider function `func` that sets/overwrites credentials for URLs being specified by\n  > `walk_remote`. The callable `func` accepts a single argument containing a parsed URL in a form of tuple. The `func`\n  > is expected to return a tuple of three elements representing URL schema, username and password. If the value should\n  > not be changed it should be None. To convert from `git://repo.com/hello` to HTTPS authentication one should write\n  > a function returning `("https", "username", "password")`. The best utility is achieved by logic that allows running\n  > the plan both in CI and local environments using different authentication mechanics in different environments.\n\n#### Terraform\n\nThis is exclusively designed to pull the configuration options out of Terraform and to allow scripts and plugins to\nutilize that data.\n\n##### Context\n\n* `ktor.tf`\n  > A dictionary containing the values from Terraform output\n\n#### Kops\n\n##### Context\n\n#### Kubernetes\n\n##### Context\n\n#### Helm\n\n##### Context\n\n#### Templates\n\n##### Context\n\n## Examples\n\n### Adding Remote Directory\n\n```python\nktor.app.repository_credentials_provider(lambda r: ("ssh", "git", None))\nktor.app.walk_remote("git://repo.example.com/org/project?ref=dev", "/project")\n```\n\n### Adding Local Directory\n\n```python\nktor.app.walk_local("/home/username/local-dir")\n```\n\n### Using Transformers\n\n```python\ndef remove_replicas(resources, r: "K8SResource"):\n    if (r.group == "apps" and r.kind in ("StatefulSet", "Deployment")\n            and "replicas" in r.manifest["spec"]):\n        logger.warning("Resource %s in %s contains `replica` specification that will be removed. Use HPA!!!",\n                       r, r.source)\n        del r.manifest["spec"]["replicas"]\n\n\nktor.k8s.add_transformer(remove_replicas)\n```\n',
         long_description_content_type = 'text/markdown',