nyl 0.3.0__tar.gz → 0.4.0__tar.gz

{nyl-0.3.0 → nyl-0.4.0}/PKG-INFO

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

{nyl-0.3.0 → nyl-0.4.0}/docs/content/reference/configuration/profiles.md

@@ -45,9 +45,12 @@ machine and use that to connect to the Kubernetes cluster.
     ```toml title="nyl-profile.toml"
     [default.kubeconfig]
     type = "ssh"
+    sudo = false  # default, set to true to use `sudo cat <path>`
     user = "root"
     host = "mycluster.example.com"
+    port = 22 # default
     path = "/etc/rancher/k3s/k3s.yaml"
+    # replace_apiserver_hostname
 
     [default.tunnel]
     type = "ssh"
@@ -61,9 +64,12 @@ machine and use that to connect to the Kubernetes cluster.
     default:
       kubeconfig:
         type: ssh
+        sudo: false
         user: root
         host: mycluster.example.com
+        port: 22
         path: /etc/rancher/k3s/k3s.yaml
+        replace_apiserver_hostname: null
       tunnel:
         type: ssh
         user: root
@@ -77,9 +83,12 @@ machine and use that to connect to the Kubernetes cluster.
       "default": {
         "kubeconfig": {
           "type": "ssh",
+          "sudo": false,
           "user": "root",
           "host": "mycluster.example.com",
-          "path": "/etc/rancher/k3s/k3s.yaml"
+          "port": 22,
+          "path": "/etc/rancher/k3s/k3s.yaml",
+          "replace_apiserver_hostname": null
         },
         "tunnel": {
           "type": "ssh",
@@ -100,7 +109,7 @@ is reachable from your local machine.
     user = "root"
     host = "mycluster.example.com"
     path = "/etc/rancher/k3s/k3s.yaml"
-    replace_apiserver_hostname = "mycluster.example.com"
+    replace_apiserver_hostname = "reachable-address.com"
     ```
 
 === "YAML"
@@ -112,7 +121,7 @@ is reachable from your local machine.
         user: root
         host: mycluster.example.com
         path: /etc/rancher/k3s/k3s.yaml
-        replace_apiserver_hostname: mycluster.example.com
+        replace_apiserver_hostname: reachable-address.com
     ```
 
 === "JSON"
@@ -125,11 +134,19 @@ is reachable from your local machine.
           "user": "root",
           "host": "mycluster.example.com",
           "path": "/etc/rancher/k3s/k3s.yaml",
-          "replace_apiserver_hostname": "mycluster.example.com"
+          "replace_apiserver_hostname": "reachable-address.com"
         }
     }
     ```
 
+!!! note
+
+    When retrieving a Kubeconfig via SSH that has `127.0.0.1`, `0.0.0.0` or `localhost` as the hostname in the `server`
+    field, and `replace_apiserver_hostname` is not specified, Nyl will automatically replace it with the `host` field
+    specified that was used to execute the remote command to read the Kubeconfig. This is because we expect the two
+    hosts to be the same, and you cannot reach the Kubernetes API server through your local machine without using tunnel
+    (which you can use, see [Tunnel management](#tunnel-management)).
+
 If you are you are already setup with a kubeconfig file, you can specify the path to the file directly or have it
 automatically use your `~/.kube/config` file/`KUBECONFIG` environment variable. You may specify the context to use
 from that kubeconfig file which ensures Nyl interacts with the correct cluster, even if your

{nyl-0.3.0 → nyl-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "nyl"
-version = "0.3.0"  # sed'ed on publish in CI
+version = "0.4.0"  # sed'ed on publish in CI
 description = "Advanced templating engine for Kubernetes and GitOps."
 authors = [
     {name = "Niklas Rosenstein", email = "rosensteinniklas@gmail.com"},

{nyl-0.3.0 → nyl-0.4.0}/src/nyl/profiles/config.py

@@ -58,11 +58,21 @@ class KubeconfigFromSsh:
     The username to connect to the remote host with.
     """
 
+    sudo: bool = False
+    """
+    Use `sudo cat` to retrieve the file instead of ust `cat`.
+    """
+
     host: str
     """
     The remote host to connect to.
     """
 
+    port: int = 22
+    """
+    SSH port to use.
+    """
+
     identity_file: str | None = None
     """
     An SSH private key file to use for authentication.
@@ -82,7 +92,10 @@ class KubeconfigFromSsh:
     """
     Replace the hostname in the apiserver configuration of the Kubeconfig. This is useful for example with K3s when
     reading reading the `/etc/rancher/k3s/k3s.yaml` file from a remote host, but the API server in that file is not
-    reachable from the local machine (e.g. because it `0.0.0.0`).
+    reachable from that machine.
+
+    Note that if the host in the retrieve Kubeconfig is `localhost`, `0.0.0.0` or `127.0.0.1`, it will be automatically
+    replaced with the specified `host` that was also SSH-ed to, unless this option is set.
     """
 
 

{nyl-0.3.0 → nyl-0.4.0}/src/nyl/profiles/kubeconfig.py

@@ -67,9 +67,13 @@ class KubeconfigManager:
 
                 command = [
                     "ssh",
+                    "-p",
+                    str(source.port),
                     f"{source.user}@{source.host}",
                     f"cat {shlex.quote(source.path)}",
                 ]
+                if source.sudo:
+                    command[4] = "sudo " + command[4]
                 if source.identity_file:
                     command[1:1] = ["-i", str(self._cwd / source.identity_file)]
 
@@ -94,8 +98,13 @@ class KubeconfigManager:
         if api_host is None:
             raise ValueError(f"no hostname in Kubeconfig server URL: {server!r}")
 
-        if isinstance(source, KubeconfigFromSsh) and source.replace_apiserver_hostname:
-            api_host = source.replace_apiserver_hostname
+        if isinstance(source, KubeconfigFromSsh):
+            if source.replace_apiserver_hostname:
+                api_host = source.replace_apiserver_hostname
+            elif api_host in ("127.0.0.1", "0.0.0.0", "localhost"):
+                # Automatically replace the API server since we won't be able to reach the Kubernetes API server
+                # pointing to localhost from the current machine.
+                api_host = source.host
 
         raw_kubeconfig.chmod(0o600)
         return GetRawKubeconfigResult(