kubernator 1.0.23.dev20251016050525__tar.gz → 1.0.24.dev20251028221359__tar.gz

{kubernator-1.0.23.dev20251016050525 → kubernator-1.0.24.dev20251028221359}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kubernator
-Version: 1.0.23.dev20251016050525
+Version: 1.0.24.dev20251028221359
 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.23.dev20251016050525 → kubernator-1.0.24.dev20251028221359}/kubernator/__init__.py

@@ -16,7 +16,7 @@
 #   limitations under the License.
 #
 
-__version__ = "1.0.23.dev20251016050525"
+__version__ = "1.0.24.dev20251028221359"
 
 
 def _main():

{kubernator-1.0.23.dev20251016050525 → kubernator-1.0.24.dev20251028221359}/kubernator/api.py

@@ -20,10 +20,10 @@ import fnmatch
 import json
 import logging
 import os
-import io
 import platform
 import re
 import sys
+import textwrap
 import traceback
 import urllib.parse
 from collections.abc import Callable
@@ -48,6 +48,7 @@ from jinja2 import (Environment,
                     pass_context)
 from jsonschema import validators
 from platformdirs import user_cache_dir
+from yaml import MarkedYAMLError
 
 from kubernator._json_path import jp  # noqa: F401
 from kubernator._k8s_client_patches import (URLLIB_HEADERS_PATCH,
@@ -59,6 +60,43 @@ _CACHE_HEADER_TRANSLATION = {"etag": "if-none-match",
 _CACHE_HEADERS = ("etag", "last-modified")
 
 
+def to_json(obj: Union[dict, list]):
+    return json.dumps(obj)
+
+
+def to_yaml_str(s: str):
+    return repr(s)
+
+
+def to_json_yaml_str(obj: Union[dict, list]):
+    """
+    Takes `obj`, dumps as json representation, converts json representation to YAML string literal.
+    """
+    return to_yaml_str(to_json(obj))
+
+
+def to_yaml_str_block(s: str, indent: int = 4, pretty_indent: int = 2):
+    """
+    Takes a multiline string, dedents it then indents it `indent` spaces for in-yaml alignment and
+    `pretty-indent` spaces for in-block alignment.
+    """
+    return (f"|+{pretty_indent}\n" +
+            textwrap.indent(textwrap.dedent(s), " " * (indent + pretty_indent)))
+
+
+def to_json_yaml_str_block(obj: Union[str, dict, list], indent: int = 4, pretty_indent=2):
+    """
+    Takes an `obj`, serializes it as pretty JSON with `pretty_indent` in-json indentation and then
+    passes it to `to_yaml_str_block`.
+    """
+    return to_yaml_str_block(json.dumps(obj, indent=pretty_indent), indent=indent, pretty_indent=pretty_indent)
+
+
+def to_yaml(obj: Union[dict, list], level_indent: int, indent: int):
+    s = yaml.safe_dump(obj, indent=indent)
+    return "\n" + textwrap.indent(s, " " * level_indent)
+
+
 class TemplateEngine:
     VARIABLE_START_STRING = "{${"
     VARIABLE_END_STRING = "}$}"
@@ -97,7 +135,15 @@ class TemplateEngine:
                                variable_end_string=self.VARIABLE_END_STRING,
                                autoescape=False,
                                finalize=variable_finalizer,
-                               undefined=logging_undefined)
+                               undefined=logging_undefined,
+                               )
+
+        self.env.filters["to_json"] = to_json
+        self.env.filters["to_yaml_str"] = to_yaml_str
+        self.env.filters["to_yaml"] = to_yaml
+        self.env.filters["to_yaml_str_block"] = to_yaml_str_block
+        self.env.filters["to_json_yaml_str_block"] = to_json_yaml_str_block
+        self.env.filters["to_json_yaml_str"] = to_json_yaml_str
 
     def from_string(self, template):
         return self.env.from_string(template)
@@ -136,9 +182,18 @@ def scan_dir(logger, path: Path, path_filter: Callable[[os.DirEntry], bool], exc
                 yield path / f
 
 
+def parse_yaml_docs(document: str, source=None):
+    try:
+        return list(d for d in yaml.safe_load_all(document) if d)
+    except MarkedYAMLError:
+        raise
+
+
 class FileType(Enum):
-    JSON = (json.load,)
-    YAML = (yaml.safe_load_all,)
+    TEXT = (lambda x: x,)
+    BINARY = (lambda x: x,)
+    JSON = (json.loads,)
+    YAML = (parse_yaml_docs,)
 
     def __init__(self, func):
         self.func = func
@@ -147,13 +202,13 @@ class FileType(Enum):
 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:
+    with open(path, "rb" if file_type == FileType.BINARY else "rt") as f:
         try:
-            if template_engine:
+            if template_engine and not file_type == FileType.BINARY:
                 raw_data = template_engine.from_string(f.read()).render(template_context)
-                f.close()
-                f = io.StringIO(raw_data)
-            data = file_type.func(f)
+            else:
+                raw_data = f.read()
+            data = file_type.func(raw_data)
             if isinstance(data, GeneratorType):
                 data = list(data)
             return data

{kubernator-1.0.23.dev20251016050525 → kubernator-1.0.24.dev20251028221359}/kubernator/plugins/k8s.py

@@ -112,6 +112,7 @@ class KubernetesPlugin(KubernatorPlugin, K8SResourcePluginMixin):
 
         self._transformers = []
         self._validators = []
+        self._manifest_patchers = []
         self._summary = 0, 0, 0
         self._template_engine = TemplateEngine(logger)
 
@@ -150,6 +151,7 @@ class KubernetesPlugin(KubernatorPlugin, K8SResourcePluginMixin):
                                    add_transformer=self.api_add_transformer,
                                    remove_transformer=self.api_remove_transformer,
                                    add_validator=self.api_remove_validator,
+                                   add_manifest_patcher=self.api_add_manifest_patcher,
                                    get_api_versions=self.get_api_versions,
                                    create_resource=self.create_resource,
                                    disable_client_patches=disable_client_patches,
@@ -373,6 +375,10 @@ class KubernetesPlugin(KubernatorPlugin, K8SResourcePluginMixin):
         if validator not in self._validators:
             self._validators.append(validator)
 
+    def api_add_manifest_patcher(self, patcher):
+        if patcher not in self._manifest_patchers:
+            self._manifest_patchers.append(patcher)
+
     def api_remove_transformer(self, transformer):
         if transformer in self._transformers:
             self._transformers.remove(transformer)
@@ -391,6 +397,17 @@ class KubernetesPlugin(KubernatorPlugin, K8SResourcePluginMixin):
             frame = frame.f_back
         return ValueError((msg % args) if args else msg).with_traceback(tb)
 
+    def _patch_manifest(self,
+                        manifest: dict,
+                        resource_description: str):
+        for patcher in reversed(self._manifest_patchers):
+            logger.debug("Applying patcher %s to %s",
+                         getattr(patcher, "__name__", patcher),
+                         resource_description)
+            manifest = patcher(manifest, resource_description) or manifest
+
+        return manifest
+
     def _transform_resource(self, resources: Sequence[K8SResource], resource: K8SResource) -> K8SResource:
         for transformer in reversed(self._transformers):
             logger.debug("Applying transformer %s to %s from %s",

{kubernator-1.0.23.dev20251016050525 → kubernator-1.0.24.dev20251028221359}/kubernator/plugins/k8s_api.py

@@ -23,7 +23,6 @@ from collections import namedtuple
 from collections.abc import Callable, Mapping, MutableMapping, Sequence, Iterable
 from enum import Enum, auto
 from functools import partial
-from io import StringIO
 from pathlib import Path
 from typing import Union, Optional
 
@@ -34,7 +33,7 @@ from jsonschema.exceptions import ValidationError
 from jsonschema.validators import extend, Draft7Validator
 from openapi_schema_validator import OAS31Validator
 
-from kubernator.api import load_file, FileType, load_remote_file, calling_frame_source
+from kubernator.api import load_file, FileType, load_remote_file, calling_frame_source, parse_yaml_docs
 
 K8S_WARNING_HEADER = re.compile(r'(?:,\s*)?(\d{3})\s+(\S+)\s+"(.+?)(?<!\\)"(?:\s+\"(.+?)(?<!\\)\")?\s*')
 UPPER_FOLLOWED_BY_LOWER_RE = re.compile(r"(.)([A-Z][a-z]+)")
@@ -524,7 +523,7 @@ class K8SResourcePluginMixin:
             source = calling_frame_source()
 
         if isinstance(manifests, str):
-            manifests = list(yaml.safe_load_all(StringIO(manifests)))
+            manifests = list(parse_yaml_docs(manifests, source))
 
         if isinstance(manifests, (Mapping, dict)):
             return self.add_resource(manifests, source)
@@ -557,7 +556,7 @@ class K8SResourcePluginMixin:
             source = calling_frame_source()
 
         if isinstance(manifests, str):
-            manifests = list(yaml.safe_load_all(StringIO(manifests)))
+            manifests = list(parse_yaml_docs(manifests, source))
 
         if isinstance(manifests, (Mapping, dict)):
             return self.add_crd(manifests, source)
@@ -614,8 +613,13 @@ class K8SResourcePluginMixin:
 
     def _create_resource(self, manifest: dict, source: Union[str, Path] = None):
         resource_description = K8SResource.get_manifest_description(manifest, source)
-        self.logger.debug("Validating K8S manifest for %s", resource_description)
 
+        new_manifest = self._patch_manifest(manifest, resource_description)
+        if new_manifest != manifest:
+            manifest = new_manifest
+            resource_description = K8SResource.get_manifest_description(manifest, source)
+
+        self.logger.debug("Validating K8S manifest for %s", resource_description)
         errors = list(self._validate_resource(manifest, source))
         if errors:
             for error in errors:
@@ -644,6 +648,11 @@ class K8SResourcePluginMixin:
 
         return resource
 
+    def _patch_manifest(self,
+                        manifest: dict,
+                        resource_description: str):
+        return manifest
+
     def _transform_resource(self,
                             resources: Sequence[K8SResource],
                             resource: K8SResource) -> K8SResource:

{kubernator-1.0.23.dev20251016050525 → kubernator-1.0.24.dev20251028221359}/kubernator/plugins/kubectl.py

@@ -16,7 +16,6 @@
 #   limitations under the License.
 #
 
-import io
 import json
 import logging
 import os
@@ -121,7 +120,7 @@ class KubectlPlugin(KubernatorPlugin):
             args += ["-n", namespace]
         args += ["-o", "yaml"]
 
-        res = list(yaml.safe_load_all(io.StringIO(self.context.kubectl.run_capturing(*args))))
+        res = list(yaml.safe_load_all(self.context.kubectl.run_capturing(*args)))
         if len(res):
             if len(res) > 1:
                 return res

{kubernator-1.0.23.dev20251016050525 → kubernator-1.0.24.dev20251028221359}/kubernator.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kubernator
-Version: 1.0.23.dev20251016050525
+Version: 1.0.24.dev20251028221359
 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.23.dev20251016050525 → kubernator-1.0.24.dev20251028221359}/setup.py

@@ -21,7 +21,7 @@ class install(_install):
 if __name__ == '__main__':
     setup(
         name = 'kubernator',
-        version = '1.0.23.dev20251016050525',
+        version = '1.0.24.dev20251028221359',
         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',