nyl 0.9.1__tar.gz → 0.9.2__tar.gz

nyl-0.9.2/.changelog/0.9.2.toml

@@ -0,0 +1,13 @@
+release-date = "2025-04-22"
+
+[[entries]]
+id = "469033a3-ec4d-4a54-9294-b1608735bacb"
+type = "improvement"
+description = "Introduce new `values` object into templating evaluation namespace, replacing the `locals` object going forward. The `locals` name is still available but will be removed in an upcoming release."
+author = "@NiklasRosenstein"
+
+[[entries]]
+id = "7cd10ee2-9c5a-4c23-8fe4-9f4d9291ceb4"
+type = "feature"
+description = "Allow defining parameters in the \"values\" of a profile, accessible via `${{ values.PARAM }}` throughout manifest rendering with the profile."
+author = "@NiklasRosenstein"

nyl-0.9.2/DEPRECATION_NOTICE.md

@@ -0,0 +1,7 @@
+The following is a list of features and functionalities that are deprecated and will be removed in a future version
+of Nyl. This file serves as an announcement as well as reminder before cutting a new release.
+
+## Deprecated Features
+
+* `locals` in templates: The use of `locals` in templates is deprecated and will be removed in Nyl 0.10.x. Please
+  use `values` instead.

{nyl-0.9.1 → nyl-0.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nyl
-Version: 0.9.1
+Version: 0.9.2
 Summary: Advanced templating engine for Kubernetes and GitOps.
 Author-email: Niklas Rosenstein <rosensteinniklas@gmail.com>
 License: MIT

{nyl-0.9.1 → nyl-0.9.2}/docs/content/changelog.md

@@ -1,3 +1,14 @@
+## 0.9.2 (2025-04-22)
+
+<table><tr><th>Type</th><th>Description</th><th>PR</th><th>Issues</th><th>Author</th></tr>
+  <tr><td>Improvement</td><td>
+
+Introduce new `values` object into templating evaluation namespace, replacing the `locals` object going forward. The `locals` name is still available but will be removed in an upcoming release.</td><td></td><td></td><td>@NiklasRosenstein</td></tr>
+  <tr><td>Feature</td><td>
+
+Allow defining parameters in the "values" of a profile, accessible via `${{ values.PARAM }}` throughout manifest rendering with the profile.</td><td></td><td></td><td>@NiklasRosenstein</td></tr>
+</table>
+
 ## 0.9.1 (2025-04-20)
 
 <table><tr><th>Type</th><th>Description</th><th>PR</th><th>Issues</th><th>Author</th></tr>

{nyl-0.9.1 → nyl-0.9.2}/docs/content/reference/templating/basics.md

@@ -17,5 +17,6 @@ Currently, only the following names are available in the scope of the expression
 
 - `secrets`: A reference to the secrets provider. This is used to retrieve secrets from the configured secrets
   provider. See [Secrets](./secrets.md) for more information.
-- `locals`: A container for local variables defined in the same manifest. See [Local Variables](./locals.md) for more
-  information.
+- `values`: A container for values defined on the profile-level (see [Profiles](../configuration/profiles.md)) or in the
+  manifest (see [Local Variables](./locals.md)). (Note that the use of `locals` instead of `values` is deprecated and
+  will be removed in Nyl 0.10.x).

{nyl-0.9.1 → nyl-0.9.2}/docs/content/reference/templating/locals.md

@@ -2,10 +2,10 @@
 
 You may define a YAML object in your Kubernetes manifest that is used to define variables that can later be accessed
 in the same manifest to achieve some level of DRY-ness. This is done by not setting any `apiVersion` or `kind`, and
-instead just define variables prefixed with `$`. Variables can later be accessed using the `${{ locals.var }}`.
+instead just define variables prefixed with `$`. Variables can later be accessed using the `${{ values.var }}`.
 
 Note that expressions in values assigned to variables are not currently supported. This means that you cannot use e.g.
-`${{ secrets.get("my-secret") }}` in the value of a variable, nor can you use `${{ locals.var }}`.
+`${{ secrets.get("my-secret") }}` in the value of a variable, nor can you use `${{ values.var }}`.
 
 ## Example
 
@@ -17,7 +17,7 @@ $name: my-app
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: ${{ locals.name }}
+  name: ${{ values.name }}
 # ...
 ```
 

{nyl-0.9.1 → nyl-0.9.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "nyl"
-version = "0.9.1"
+version = "0.9.2"
 description = "Advanced templating engine for Kubernetes and GitOps."
 authors = [
     {name = "Niklas Rosenstein", email = "rosensteinniklas@gmail.com"},

{nyl-0.9.1 → nyl-0.9.2}/src/nyl/commands/__init__.py

@@ -20,6 +20,7 @@ from typer import Option, Typer
 from kubernetes.client.api_client import ApiClient
 from nyl import __version__
 from nyl.profiles import ProfileManager
+from nyl.profiles.config import Profile
 from nyl.project.config import ProjectConfig
 from nyl.secrets.config import SecretsConfig
 from nyl.tools.di import DependenciesProvider
@@ -110,6 +111,12 @@ def _callback(
             PROVIDER.get(ProfileManager), PROVIDER.get(ApiClientConfig).profile
         ),
     )
+    PROVIDER.set_lazy(
+        Profile,
+        lambda: PROVIDER.get(ProfileManager).config.profiles[
+            PROVIDER.get(ApiClientConfig).profile or template.DEFAULT_PROFILE
+        ],
+    )
 
 
 @app.command()

{nyl-0.9.1 → nyl-0.9.2}/src/nyl/commands/template.py

@@ -16,6 +16,7 @@ from nyl.commands import PROVIDER, ApiClientConfig, app
 from nyl.generator import reconcile_generator
 from nyl.generator.dispatch import DispatchingGenerator
 from nyl.profiles import ProfileManager
+from nyl.profiles.config import Profile
 from nyl.project.config import ProjectConfig
 from nyl.resources import API_VERSION_INLINE, NylResource
 from nyl.resources.applyset import APPLYSET_LABEL_PART_OF, ApplySet
@@ -64,7 +65,7 @@ def get_profile_kubernetes_client(profiles: ProfileManager, profile: str | None)
 
     If no *profile* is specified, but the profile manager contains at least one profile, the *profile* argument will
     default to the value of :data:`DEFAULT_PROFILE` (which is `"default"`). Otherwise, if no profile is selected and
-    none is configured, the standard Kubernetes config load takes place (i.e. try `KUBECONFIG` and then
+    none is configured, the standard Kubernetes config loading is used (i.e. try `KUBECONFIG` and then
     `~/.kube/config`).
     """
 
@@ -210,6 +211,9 @@ def template(
             else project.config.settings.on_lookup_failure,
         )
 
+        # Seed the template engine with the profile values.
+        vars(template_engine.values).update(PROVIDER.get(Profile).values)
+
         # Look for objects that contain local variables and feed them into the template engine.
         for manifest in source.manifests[:]:
             if "apiVersion" in manifest or "kind" in manifest:
@@ -227,7 +231,7 @@ def template(
                 exit(1)
             for key, value in manifest.items():
                 assert key.startswith("$"), key
-                setattr(template_engine.locals, key[1:], value)
+                setattr(template_engine.values, key[1:], value)
             source.manifests.remove(manifest)
 
         # Begin populating the default namespace to resources.

{nyl-0.9.1 → nyl-0.9.2}/src/nyl/profiles/config.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from dataclasses import dataclass, field
 from pathlib import Path
-from typing import Literal
+from typing import Any, Literal
 
 from loguru import logger
 
@@ -13,7 +13,14 @@ from nyl.tools.loads import loadf
 @dataclass
 class Profile:
     """
-    Represents a Kubernetes connection profile.
+    A profile embodies a set of configurations for a Kubernetes cluster that resources will be deployed to using Nyl.
+    It defines the Kubeconfig to use, whether to use an SSH tunnel to reach the cluster, as well as global values that
+    are accessible during rendering any manifest with the profile activated.
+    """
+
+    values: dict[str, Any] = field(default_factory=dict)
+    """
+    Global values that are accessible during manifest rendering under the `values` object.
     """
 
     kubeconfig: LocalKubeconfig | KubeconfigFromSsh = field(default_factory=lambda: LocalKubeconfig())

{nyl-0.9.1 → nyl-0.9.2}/src/nyl/templating.py

@@ -173,7 +173,7 @@ class NylTemplateEngine:
 
     secrets: SecretProvider
     client: ApiClient
-    locals: Namespace = field(default_factory=Namespace)
+    values: Namespace = field(default_factory=Namespace)
     on_lookup_failure: Literal["Error", "CreatePlaceholder", "SkipResource"] = "Error"
 
     def __post_init__(self) -> None:
@@ -196,7 +196,14 @@ class NylTemplateEngine:
                 NylTemplateEngine.current = prev
 
     def _new_engine(self) -> _TemplateEngine:
-        return _TemplateEngine({"secrets": self.secrets, "locals": self.locals, **registered_functions})
+        return _TemplateEngine(
+            {
+                "secrets": self.secrets,
+                "locals": self.values,  # TODO: Deprecate in 0.10.x
+                "values": self.values,
+                **registered_functions,
+            }
+        )
 
     def evaluate(self, value: Manifests, recursive: bool = True) -> Manifests:
         result = []