nyl 0.0.3__tar.gz → 0.0.4__tar.gz

nyl-0.0.4/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.1
+Name: nyl
+Version: 0.0.4
+Summary: Default template for PDM package
+Author-Email: Niklas Rosenstein <rosensteinniklas@gmail.com>
+License: MIT
+Requires-Python: >=3.10
+Requires-Dist: bcrypt>=4.2.0
+Requires-Dist: databind>=4.5.2
+Requires-Dist: filelock>=3.15.4
+Requires-Dist: jinja2>=3.1.4
+Requires-Dist: kubernetes>=30.1.0
+Requires-Dist: loguru>=0.7.2
+Requires-Dist: nr-stream>=1.1.5
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: requests>=2.32.3
+Requires-Dist: stablehash>=0.2.0
+Requires-Dist: structured-templates<0.1.0,>=0.0.5
+Requires-Dist: typer>=0.12.3
+Requires-Dist: typing-extensions>=4.12.2
+Description-Content-Type: text/markdown
+
+# nyl
+
+Nyl is a versatile tool for generating Kubernetes manifests from a simple YAML configuration, encouraging
+consistent and reusable deployment configurations, project layouts and operational workflows.
+
+## Local development
+
+This project uses the [PDM](https://pdm-project.org/latest/) package manager for Python. Start with
+`$ pipx install pdm` followed by `$ pdm install --frozen-lockfile`.

nyl-0.0.4/README.md

@@ -0,0 +1,9 @@
+# nyl
+
+Nyl is a versatile tool for generating Kubernetes manifests from a simple YAML configuration, encouraging
+consistent and reusable deployment configurations, project layouts and operational workflows.
+
+## Local development
+
+This project uses the [PDM](https://pdm-project.org/latest/) package manager for Python. Start with
+`$ pipx install pdm` followed by `$ pdm install --frozen-lockfile`.

{nyl-0.0.3 → nyl-0.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nyl"
-version = "0.0.3"
+version = "0.0.4"
 description = "Default template for PDM package"
 authors = [
     { name = "Niklas Rosenstein", email = "rosensteinniklas@gmail.com" },
@@ -37,9 +37,13 @@ build-backend = "pdm.backend"
 
 [tool.pdm]
 distribution = true
+source = [
+    { name = "pypi", url = "https://pypi.org/simple" },
+]
 
 [tool.pdm.scripts]
 lint = "bash -c 'ruff format && ruff check --fix && mypy src' && pytest"
+docs = "bash -c 'cd docs && mkdocs serve'"
 
 [tool.pdm.dev-dependencies]
 dev = [

nyl-0.0.4/src/nyl/__init__.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version("nyl")

{nyl-0.0.3 → nyl-0.0.4}/src/nyl/commands/__init__.py

@@ -3,6 +3,8 @@ Nyl is a flexible configuration management tool for Kubernetes resources that ca
 applications directly or integrate as an ArgoCD ConfigManagementPlugin.
 """
 
+from pathlib import Path
+from nyl import __version__
 from enum import Enum
 import sys
 from loguru import logger
@@ -26,6 +28,12 @@ app.add_typer(secrets.app)
 app.add_typer(tun.app)
 
 
+LOG_TIME_FORMAT = "<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green>"
+LOG_LEVEL_FORAMT = "<level>{level: <8}</level>"
+LOG_DETAILS_FORMAT = "<cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan>"
+LOG_MESSAGE_FORMAT = "<level>{message}</level>"
+
+
 class LogLevel(str, Enum):
     TRACE = "trace"
     DEBUG = "debug"
@@ -38,6 +46,23 @@ class LogLevel(str, Enum):
 @app.callback()
 def _callback(
     log_level: LogLevel = Option(LogLevel.INFO, "--log-level", "-l", help="The log level to use."),
+    log_details: bool = Option(False, help="Include logger- and function names in the log message format."),
 ) -> None:
+    if log_details:
+        fmt = f"{LOG_TIME_FORMAT} | {LOG_LEVEL_FORAMT} | {LOG_DETAILS_FORMAT} | {LOG_MESSAGE_FORMAT}"
+    else:
+        fmt = f"{LOG_TIME_FORMAT} | {LOG_LEVEL_FORAMT} | {LOG_MESSAGE_FORMAT}"
+
     logger.remove()
-    logger.add(sys.stderr, level=log_level.name)
+    logger.add(sys.stderr, level=log_level.name, format=fmt)
+    logger.opt(ansi=True).debug("Nyl v{} run from <yellow>{}</>.", __version__, Path.cwd())
+
+
+@app.command()
+def version() -> None:
+    """
+    Print the version of Nyl.
+    """
+
+    print(f"Nyl v{__version__}")
+    sys.exit(0)

{nyl-0.0.3 → nyl-0.0.4}/src/nyl/commands/template.py

@@ -1,7 +1,7 @@
 import atexit
 from dataclasses import dataclass
 from pathlib import Path
-from typing import cast
+from typing import Optional, cast
 from loguru import logger
 from structured_templates import TemplateEngine
 from typer import Argument, Option
@@ -20,6 +20,8 @@ from nyl.tools.types import Manifest, Manifests
 
 from . import app
 
+DEFAULT_PROFILE = "default"
+
 
 @dataclass
 class ManifestsWithSource:
@@ -34,7 +36,7 @@ class ManifestsWithSource:
 @app.command()
 def template(
     paths: list[Path] = Argument(..., help="The YAML file(s) to render. Can be a directory."),
-    profile: str = Option("default", envvar="NYL_PROFILE", help="The Nyl profile to use."),
+    profile: Optional[str] = Option(None, envvar="NYL_PROFILE", help="The Nyl profile to use."),
     in_cluster: bool = Option(
         False, help="Use the in-cluster Kubernetes configuration. The --profile option is ignored."
     ),
@@ -68,10 +70,18 @@ def template(
         logger.info("Using in-cluster configuration.")
         load_incluster_config()
     else:
-        with ProfileManager.load() as profiles:
-            active = profiles.activate_profile(profile)
-            logger.info(f"Using profile '{profile}' with kubeconfig '{active.kubeconfig}'.")
-            load_kube_config(str(active.kubeconfig))
+        with ProfileManager.load(required=False) as profiles:
+            # If no profile to activate is specified, and there are no profiles defined, we're not activating a
+            # a profile. It should be valid to use Nyl without a `nyl-profiles.yaml` file.
+            if profile is not None or profiles.config.profiles:
+                profile = profile or DEFAULT_PROFILE
+                active = profiles.activate_profile(profile)
+                load_kube_config(str(active.kubeconfig))
+            else:
+                logger.opt(ansi=True).info(
+                    "No <yellow>nyl-profiles.yaml</> file found, using default kubeconfig and context."
+                )
+                load_kube_config()
 
     project = ProjectConfig.load()
     if project.file:
@@ -97,7 +107,7 @@ def template(
     )
 
     for source in load_manifests(paths):
-        logger.info("Rendering manifests from {}", source.file)
+        logger.opt(ansi=True).info("Rendering manifests from <blue>{}</>.", source.file)
 
         source.manifests = cast(Manifests, template_engine.evaluate(source.manifests))
         source.manifests = reconcile_generator(
@@ -116,14 +126,32 @@ def template(
                 namespaces.add(manifest["metadata"]["name"])
             elif ApplySet.matches(manifest):
                 if applyset is not None:
-                    logger.error(
-                        "Multiple ApplySet resources defined in '{}', there can only be one per source.",
+                    logger.opt(ansi=True).error(
+                        "Multiple ApplySet resources defined in <yellow>{}</>, there can only be one per source.",
                         source.file,
                     )
                     exit(1)
                 applyset = ApplySet.load(manifest)
                 source.manifests.remove(manifest)
 
+        if not applyset and project.config.automatic_applyset:
+            if len(namespaces) > 1:
+                logger.opt(ansi=True).error(
+                    "Multiple namespaces defined in <yellow>{}</>, but automatic ApplySet generation is enabled. "
+                    "There can only be one namespace per source in this case.",
+                    source.file,
+                )
+                exit(1)
+            elif len(namespaces) == 1:
+                applyset_name = next(iter(namespaces))
+            else:
+                applyset_name = source.file.stem
+
+            logger.opt(ansi=True).info(
+                "Automatically creating ApplySet for <blue>{}</> (name: <magenta>{}</>).", source.file, applyset_name
+            )
+            applyset = ApplySet.new(applyset_name)
+
         if applyset is not None:
             applyset.set_group_kinds(source.manifests)
             # HACK: Kubectl 1.30 can't create the custom resource, so we need to create it. But it will also reject
@@ -134,7 +162,11 @@ def template(
 
             if apply:
                 # We need to ensure that ApplySet parent object exists before invoking `kubectl apply --applyset=...`.
-                logger.info("Kubectl-apply ApplySet resource '{}' from '{}'", applyset.reference, source.file)
+                logger.opt(ansi=True).info(
+                    "Kubectl-apply ApplySet resource <yellow>{}</> from <cyan>{}</>.",
+                    applyset.reference,
+                    source.file,
+                )
                 kubectl.apply(Manifests([applyset.dump()]), force_conflicts=True)
             else:
                 print("---")
@@ -206,7 +238,13 @@ def load_manifests(paths: list[Path]) -> list[ManifestsWithSource]:
     for path in paths:
         if path.is_dir():
             for item in path.iterdir():
-                if item.name.startswith("nyl-") or item.suffix != ".yaml" or not item.is_file():
+                if (
+                    item.name.startswith("nyl-")
+                    or item.name.startswith(".")
+                    or item.name.startswith("_")
+                    or item.suffix != ".yaml"
+                    or not item.is_file()
+                ):
                     continue
                 files.append(item)
         else:

{nyl-0.0.3 → nyl-0.0.4}/src/nyl/profiles/__init__.py

@@ -42,12 +42,16 @@ class ProfileManager:
     tunnels: TunnelManager
     kubeconfig: KubeconfigManager
 
+    def __post_init__(self) -> None:
+        # We don't need to enter the TunnelsManager context manager until we actually need to open a tunnel.
+        self._tunnels_entered: bool = False
+
     def __enter__(self) -> "ProfileManager":
-        self.tunnels.__enter__()
         return self
 
     def __exit__(self, *args: Any) -> None:
-        self.tunnels.__exit__(*args)
+        if self._tunnels_entered:
+            self.tunnels.__exit__(*args)
 
     def activate_profile(self, profile_name: str, update_process_env: bool = True) -> ActivatedProfile:
         """
@@ -59,10 +63,18 @@ class ProfileManager:
                                 point to the activated profile's Kubeconfig file.
         """
 
+        logger.opt(ansi=True).info("Activating profile <magenta>{}</>...", profile_name)
+
         profile = self.config.profiles[profile_name]
+
         raw_kubeconfig = self.kubeconfig.get_raw_kubeconfig(profile_name, profile.kubeconfig)
 
         if profile.tunnel:
+            # If the tunnel manager has not been entered yet, do so now.
+            if not self._tunnels_entered:
+                self.tunnels.__enter__()
+                self._tunnels_entered = True
+
             forwardings = {"kubernetes": f"{raw_kubeconfig.api_host}:{raw_kubeconfig.api_port}"}
             assert self.config.file is not None, "Profile configuration file must be set."
             tun_spec = get_tunnel_spec(self.config.file, profile_name, profile.tunnel)
@@ -80,10 +92,6 @@ class ProfileManager:
             tun_description = ""
             timeout = 2
 
-        api_server = f"https://{raw_kubeconfig.api_host}:{raw_kubeconfig.api_port}"
-        logger.debug("Checking for API server connectivity ({}{})", api_server, tun_description)
-        _wait_for_api_server(api_server, timeout)
-
         activated_profile = ActivatedProfile(
             kubeconfig=self.kubeconfig.get_updated_kubeconfig(
                 profile_name=profile_name,
@@ -94,6 +102,10 @@ class ProfileManager:
             )
         )
 
+        api_server = f"https://{raw_kubeconfig.api_host}:{raw_kubeconfig.api_port}"
+        logger.opt(ansi=True).info("Waiting for API server connectivity (<blue>{}{}</>)", api_server, tun_description)
+        _wait_for_api_server(api_server, timeout)
+
         if update_process_env:
             logger.trace("Updating process environment with activated profile: {}", activated_profile.env)
             os.environ.update(activated_profile.env)
@@ -101,15 +113,23 @@ class ProfileManager:
         return activated_profile
 
     @staticmethod
-    def load() -> "ProfileManager":
+    def load(required: bool = True) -> "ProfileManager":
         """
         Load the profile manager from the default configuration file.
+
+        Args:
+            required: Passed on to [`ProfileConfig.load()`]. If it is set to `False`, the Nyl state directory
+                is assumed relative to the current working directory (`./.nyl`).
         """
 
-        config = ProfileConfig.load()
-        assert config.file is not None, "Profile configuration file must be set."
+        config = ProfileConfig.load(required=required)
+        context_dir = config.file.parent if config.file else Path.cwd()
+
         tunnels = TunnelManager()
-        kubeconfig = KubeconfigManager(cwd=config.file.parent, state_dir=config.file.with_name(".nyl") / "profiles")
+        kubeconfig = KubeconfigManager(
+            cwd=context_dir,
+            state_dir=context_dir / ".nyl" / "profiles",
+        )
         return ProfileManager(config, tunnels, kubeconfig)
 
 

{nyl-0.0.3 → nyl-0.0.4}/src/nyl/profiles/kubeconfig.py

@@ -1,10 +1,13 @@
 from dataclasses import dataclass
 import os
 from pathlib import Path
+import shlex
 import subprocess
 from typing import Any
 from urllib.parse import urlparse
 import yaml
+
+from nyl.tools.shell import pretty_cmd
 from .config import KubeconfigFromSsh, LocalKubeconfig
 from loguru import logger
 
@@ -55,42 +58,41 @@ class KubeconfigManager:
         match source:
             case LocalKubeconfig():
                 raw_kubeconfig = Path(os.getenv("KUBECONFIG", os.path.expanduser("~/.kube/config")))
-                if Path(raw_kubeconfig).exists():
+                if not raw_kubeconfig.exists():
                     raise FileNotFoundError(f"Kubeconfig file '{raw_kubeconfig}' does not exist.")
-                logger.info("Using local Kubeconfig file '{}'.", raw_kubeconfig)
+                logger.opt(ansi=True).info("Using kubeconfig <yellow>{}</>.", raw_kubeconfig)
 
             case KubeconfigFromSsh():
                 raw_kubeconfig = self._state_dir / profile_name / "kubeconfig.orig"
-                if not Path(raw_kubeconfig).exists() or force_refresh:
-                    logger.info(
-                        "Fetching Kubeconfig via SSH ({}@{}:{}).",
-                        source.user,
-                        source.host,
-                        source.path,
-                    )
-                    # Fetch the Kubeconfig file.
+
+                command = [
+                    "ssh",
+                    f"{source.user}@{source.host}",
+                    f"cat {shlex.quote(source.path)}",
+                ]
+                if source.identity_file:
+                    command[1:1] = ["-i", str(self._cwd / source.identity_file)]
+
+                # Fetch the Kubeconfig file.
+                if not raw_kubeconfig.exists() or force_refresh:
+                    logger.opt(ansi=True).info("Fetching kubeconfig with <yellow>$ {}</>.", pretty_cmd(command))
                     raw_kubeconfig.parent.mkdir(parents=True, exist_ok=True)
-                    command = [
-                        "ssh",
-                        f"{source.user}@{source.host}",
-                        "cat",
-                        source.path,
-                    ]
-                    if source.identity_file:
-                        command[1:1] = ["-i", str(self._cwd / source.identity_file)]
                     kubeconfig_content = subprocess.check_output(command, text=True)
                     Path(raw_kubeconfig).write_text(kubeconfig_content)
                 else:
-                    logger.debug("Reusing cached Kubeconfig ({}).", raw_kubeconfig)
+                    logger.opt(ansi=True).info(
+                        "Using <u>cached</> kubeconfig from <yellow>$ {}</>.", pretty_cmd(command)
+                    )
             case _:
                 raise ValueError(f"Unsupported Kubeconfig type: {source.__class__.__name__}")
 
         # Find the Kubernetes API host and port.
         kubeconfig_data = yaml.safe_load(raw_kubeconfig.read_text())
         kubeconfig_data = _trim_to_context(kubeconfig_data, source.context)
-        server = kubeconfig_data["clusters"][0]["cluster"]["server"]
-        api_host = urlparse(server).hostname
-        api_port = urlparse(server).port or 443
+        server: str = kubeconfig_data["clusters"][0]["cluster"]["server"]
+        api_host, api_port = (lambda parsed: (parsed.hostname, parsed.port or 443))(urlparse(server))
+        if api_host is None:
+            raise ValueError(f"no hostname in Kubeconfig server URL: {server!r}")
 
         raw_kubeconfig.chmod(0o600)
         return GetRawKubeconfigResult(

{nyl-0.0.3 → nyl-0.0.4}/src/nyl/profiles/tunnel.py

@@ -1,4 +1,3 @@
-import shlex
 from dataclasses import dataclass
 import os
 import random
@@ -10,6 +9,7 @@ from loguru import logger
 
 from stablehash import stablehash
 from nyl.tools.kvstore import JsonFileKvStore, SerializingStore
+from nyl.tools.shell import pretty_cmd
 
 
 @dataclass
@@ -169,7 +169,7 @@ class TunnelManager:
         # Check if the tunnel is open and up-to-date.
         spec_hash = stablehash(spec).hexdigest()
         if status is not None and status.status == "open" and status.spec_hash == spec_hash:
-            logger.debug("Tunnel for '{}' is already open.", spec.locator)
+            logger.opt(ansi=True).info("Reusing existing SSH tunnel.", spec.locator)
             return status
 
         # Close the tunnel if it is open.
@@ -206,7 +206,7 @@ class TunnelManager:
         if spec.identity_file is not None:
             ssh_args.extend(["-i", spec.identity_file])
 
-        logger.debug("Opening SSH tunnel for '{}': $ {}", spec.locator, " ".join(map(shlex.quote, ssh_args)))
+        logger.opt(ansi=True).info("Opening SSH tunnel with <yellow>$ {}</>.", pretty_cmd(ssh_args))
         proc = subprocess.Popen(ssh_args)
 
         # Update the status.

{nyl-0.0.3 → nyl-0.0.4}/src/nyl/project/config.py

@@ -12,6 +12,15 @@ class Project:
     Configuration for a Nyl project that is stored in a `nyl-project.toml` file.
     """
 
+    automatic_applyset: bool = True
+    """
+    Automatically generate an ApplySet for every template file. The applyset will be named after the template file,
+    unless there is namespace defined in the template file, in which case the applyset will be named after the
+    namespace.
+
+    This option is turned on by default. Using Nyl without a `nyl-project.toml` file will have this option enabled.
+    """
+
     search_path: list[Path] = field(default_factory=list)
     """
     Search path for additional resources used by the project. Used for example when using the `chart.path` option on a

{nyl-0.0.3 → nyl-0.0.4}/src/nyl/resources/applyset.py

@@ -194,6 +194,19 @@ class ApplySet(NylResource, api_version=API_VERSION_K8S):
         if self.contains_group_kinds is None:
             raise ValueError(f"ApplySet resource must have a {APPLYSET_ANNOTATION_CONTAINS_GROUP_KINDS!r} annotation")
 
+    @staticmethod
+    def new(name: str) -> "ApplySet":
+        """
+        Create a new ApplySet resource with the specified name.
+        """
+
+        return ApplySet(
+            metadata=ObjectMetadata(
+                name=name,
+                namespace=None,
+            )
+        )
+
 
 def calculate_applyset_id(*, name: str, namespace: str = "", group: str) -> str:
     """

nyl-0.0.4/src/nyl/tools/shell.py

@@ -0,0 +1,6 @@
+from collections.abc import Iterable
+import shlex
+
+
+def pretty_cmd(command: Iterable[str]) -> str:
+    return " ".join(map(shlex.quote, command))

nyl-0.0.3/PKG-INFO

@@ -1,158 +0,0 @@
-Metadata-Version: 2.1
-Name: nyl
-Version: 0.0.3
-Summary: Default template for PDM package
-Author-Email: Niklas Rosenstein <rosensteinniklas@gmail.com>
-License: MIT
-Requires-Python: >=3.10
-Requires-Dist: bcrypt>=4.2.0
-Requires-Dist: databind>=4.5.2
-Requires-Dist: filelock>=3.15.4
-Requires-Dist: jinja2>=3.1.4
-Requires-Dist: kubernetes>=30.1.0
-Requires-Dist: loguru>=0.7.2
-Requires-Dist: nr-stream>=1.1.5
-Requires-Dist: pyyaml>=6.0.1
-Requires-Dist: requests>=2.32.3
-Requires-Dist: stablehash>=0.2.0
-Requires-Dist: structured-templates<0.1.0,>=0.0.5
-Requires-Dist: typer>=0.12.3
-Requires-Dist: typing-extensions>=4.12.2
-Description-Content-Type: text/markdown
-
-# nyl
-
-Nyl is a versatile Kubernetes resource management tool that fulfills various functions to enable reusable
-deployment configurations.
-
-__Features__
-
-* Generate Kubernetes manifests from a simple YAML configuration with templating support.
-* Inject secrets into Kubernetes manifests as time of generation.
-* Bootstrap a cluster and transfer control to ArgoCD or use it to manage a cluster from CI/CD or locally.
-* Connect to a Kubernetes cluster via an SSH tunnel.
-
-__Roadmap__
-
-* Integrate as an ArgoCD ConfigManagementPlugin.
-* Diffing
-* How to work around fields owned by a different field manager (e.g. MetalLB CRD `conversion..caBundle`) or `Job` resources?
-
-## Concepts
-
-### Packages
-
-A package is similar to a Helm chart in that it is a source for Kubernetes resources that can make use of
-templating to conditionally render resources and inject values into them. Resources generated by packages
-may make use of Nyl-specific resource kinds that are only available time of resource generation (see the
-[Templating > Resource Kinds](#resource-kinds) section below).
-
-Nyl packages can be checked into a source repository in a DRY form, but can be compiled to a bundle (e.g.
-including other referenced packages or Helm charts) for deployment when needed (e.g. for shipping to an
-air-gapped environment).
-
-Packages may have a `nyl-package.yaml` file that defines a schema for the package parameters and additional
-metadata. A package without this file may still accept and use parameters in its templates.
-
-### Applications
-
-An application is an instance of one package that is deployed to a Kubernetes cluster and are in turn defined
-also in a Nyl package. Packages instantiated as applications may not produce other applications. Applications
-are usually accompanied by a `nyl-deployment.yaml` file that defines the top-level templating context for the
-package(s), such as the secret store.
-
-When deploying a package as an application, the package must not generated resources other than applications,
-as all deployed resources must be owned by an application.
-
-### Deployment
-
-A deployment is where things get together: This is the place where you define the applications that should be
-deployed to a Kubernetes cluster, which cluster they are being deployed to, as well as sourcing secrets from
-a secret store. The configuration for a deployment is defined in a `nyl-deployment.yaml` file.
-
-```yaml
-apiVersion: nyl/v1
-kind: Deployment
-spec:
-  secretStores:
-    default:
-      type: Sops
-      path: secrets.yaml
-```
-
-__Spec__
-
-* `secrets` (array): The secret stores to make available in the templating context of the deployment. Any secrets
-  need to be injected from these stores into the application values at templating time.
-
-## Templating
-
-  [Jinja2]: https://jinja.palletsprojects.com/en/3.0.x/
-
-Nyl uses [Jinja2] as a templating engine, and as such is slightly different from Helm.
-
-### Injecting secrets
-
-Secrets are only available at the deployment level and need to be propagated further down.
-
-```yaml
-apiVersion: nyl/v1
-kind: Application
-metadata:
-  name: my-app
-spec:
-  package: ./path/to/package
-  values:
-    theSecret: {{ Secrets.default.get("my-secret") }}
-```
-
-### Resource kinds
-
-At templating time, Nyl supports special resource kinds that will be expanded to more Kubernetes resources.
-
-#### `templating.nyl/v1/HelmChart`
-
-This resource can be used to instantiate Helm charts as part of a package.
-
-```yaml
-apiVersion: templating.nyl/v1
-kind: HelmChart
-spec:
-  repository: https://kubernetes.github.io/ingress-nginx
-  chart: ingress-nginx
-  version: 4.10.1
-  releaseName: ingress-nginx
-  releaseNamespace: ingress-nginx
-  values: {}
-```
-
-__Spec__
-
-* `repository` (string): The Helm repository URL, OCI registry URL (sans the chart name), a local path or a
-  Git repository clone URL.
-* `chart` (string): The name of the chart in the repository, the chart name to append to the OCI registry URL,
-  the name of the chart in the local path or the path to the chart in the Git repository.
-* `version` (string): The version of the chart to use. Only relevant for Helm/OCI repositories.
-* `releaseName` (string): The name of the Helm release.
-* `releaseNamespace` (string): The namespace to install the Helm release into. If any resources generated by the
-  chart have no `metadata.namespace` field, it will be set to this value.
-* `values` (object): The values to pass to the Helm chart.
-
-#### `templating.nyl/v1/Package`
-
-Use this resource to instantiate another package.
-
-```yaml
-apiVersion: templating.nyl/v1
-kind: Package
-spec:
-  package: ./path/to/package
-  values: {}
-```
-
-__Spec__
-
-* `package` (string): The path to the package to instantiate. Must be prefixed with `./` to be resolved relative
-  to the package that references it. Otherwise, it will be resolved in a search path that is defined in the
-  `nyl-deployment.yaml` file.
-* `values` (object): The values to pass to the package.

nyl-0.0.3/README.md

@@ -1,136 +0,0 @@
-# nyl
-
-Nyl is a versatile Kubernetes resource management tool that fulfills various functions to enable reusable
-deployment configurations.
-
-__Features__
-
-* Generate Kubernetes manifests from a simple YAML configuration with templating support.
-* Inject secrets into Kubernetes manifests as time of generation.
-* Bootstrap a cluster and transfer control to ArgoCD or use it to manage a cluster from CI/CD or locally.
-* Connect to a Kubernetes cluster via an SSH tunnel.
-
-__Roadmap__
-
-* Integrate as an ArgoCD ConfigManagementPlugin.
-* Diffing
-* How to work around fields owned by a different field manager (e.g. MetalLB CRD `conversion..caBundle`) or `Job` resources?
-
-## Concepts
-
-### Packages
-
-A package is similar to a Helm chart in that it is a source for Kubernetes resources that can make use of
-templating to conditionally render resources and inject values into them. Resources generated by packages
-may make use of Nyl-specific resource kinds that are only available time of resource generation (see the
-[Templating > Resource Kinds](#resource-kinds) section below).
-
-Nyl packages can be checked into a source repository in a DRY form, but can be compiled to a bundle (e.g.
-including other referenced packages or Helm charts) for deployment when needed (e.g. for shipping to an
-air-gapped environment).
-
-Packages may have a `nyl-package.yaml` file that defines a schema for the package parameters and additional
-metadata. A package without this file may still accept and use parameters in its templates.
-
-### Applications
-
-An application is an instance of one package that is deployed to a Kubernetes cluster and are in turn defined
-also in a Nyl package. Packages instantiated as applications may not produce other applications. Applications
-are usually accompanied by a `nyl-deployment.yaml` file that defines the top-level templating context for the
-package(s), such as the secret store.
-
-When deploying a package as an application, the package must not generated resources other than applications,
-as all deployed resources must be owned by an application.
-
-### Deployment
-
-A deployment is where things get together: This is the place where you define the applications that should be
-deployed to a Kubernetes cluster, which cluster they are being deployed to, as well as sourcing secrets from
-a secret store. The configuration for a deployment is defined in a `nyl-deployment.yaml` file.
-
-```yaml
-apiVersion: nyl/v1
-kind: Deployment
-spec:
-  secretStores:
-    default:
-      type: Sops
-      path: secrets.yaml
-```
-
-__Spec__
-
-* `secrets` (array): The secret stores to make available in the templating context of the deployment. Any secrets
-  need to be injected from these stores into the application values at templating time.
-
-## Templating
-
-  [Jinja2]: https://jinja.palletsprojects.com/en/3.0.x/
-
-Nyl uses [Jinja2] as a templating engine, and as such is slightly different from Helm.
-
-### Injecting secrets
-
-Secrets are only available at the deployment level and need to be propagated further down.
-
-```yaml
-apiVersion: nyl/v1
-kind: Application
-metadata:
-  name: my-app
-spec:
-  package: ./path/to/package
-  values:
-    theSecret: {{ Secrets.default.get("my-secret") }}
-```
-
-### Resource kinds
-
-At templating time, Nyl supports special resource kinds that will be expanded to more Kubernetes resources.
-
-#### `templating.nyl/v1/HelmChart`
-
-This resource can be used to instantiate Helm charts as part of a package.
-
-```yaml
-apiVersion: templating.nyl/v1
-kind: HelmChart
-spec:
-  repository: https://kubernetes.github.io/ingress-nginx
-  chart: ingress-nginx
-  version: 4.10.1
-  releaseName: ingress-nginx
-  releaseNamespace: ingress-nginx
-  values: {}
-```
-
-__Spec__
-
-* `repository` (string): The Helm repository URL, OCI registry URL (sans the chart name), a local path or a
-  Git repository clone URL.
-* `chart` (string): The name of the chart in the repository, the chart name to append to the OCI registry URL,
-  the name of the chart in the local path or the path to the chart in the Git repository.
-* `version` (string): The version of the chart to use. Only relevant for Helm/OCI repositories.
-* `releaseName` (string): The name of the Helm release.
-* `releaseNamespace` (string): The namespace to install the Helm release into. If any resources generated by the
-  chart have no `metadata.namespace` field, it will be set to this value.
-* `values` (object): The values to pass to the Helm chart.
-
-#### `templating.nyl/v1/Package`
-
-Use this resource to instantiate another package.
-
-```yaml
-apiVersion: templating.nyl/v1
-kind: Package
-spec:
-  package: ./path/to/package
-  values: {}
-```
-
-__Spec__
-
-* `package` (string): The path to the package to instantiate. Must be prefixed with `./` to be resolved relative
-  to the package that references it. Otherwise, it will be resolved in a search path that is defined in the
-  `nyl-deployment.yaml` file.
-* `values` (object): The values to pass to the package.