Add ObjectMeta field to client configuration

Author: NickCao

packages/jumpstarter-cli-admin/jumpstarter_cli_admin/create_test.py

@@ -33,19 +33,21 @@
 CLIENT_OBJECT = V1Alpha1Client(
     api_version="jumpstarter.dev/v1alpha1",
     kind="Client",
-    metadata=V1ObjectMeta(name=CLIENT_NAME, namespace="default", creation_timestamp="2024-01-01T21:00:00Z"),
+    metadata=V1ObjectMeta(namespace="default", name=CLIENT_NAME, creation_timestamp="2024-01-01T21:00:00Z"),
     status=V1Alpha1ClientStatus(endpoint=CLIENT_ENDPOINT, credential=None),
 )
 
 UNSAFE_CLIENT_CONFIG = ClientConfigV1Alpha1(
     name=CLIENT_NAME,
+    metadata=ObjectMeta(namespace="default", name=CLIENT_NAME),
     endpoint=CLIENT_ENDPOINT,
     token=CLIENT_TOKEN,
     drivers=ClientConfigV1Alpha1Drivers(allow=[], unsafe=True),
 )
 
 CLIENT_CONFIG = ClientConfigV1Alpha1(
     name=CLIENT_NAME,
+    metadata=ObjectMeta(namespace="default", name=CLIENT_NAME),
     endpoint=CLIENT_ENDPOINT,
     token=CLIENT_TOKEN,
     drivers=ClientConfigV1Alpha1Drivers(allow=[], unsafe=True),

packages/jumpstarter-cli-admin/jumpstarter_cli_admin/delete_test.py

@@ -30,6 +30,7 @@
 
 CLIENT_CONFIG = ClientConfigV1Alpha1(
     name=CLIENT_NAME,
+    metadata=ObjectMeta(namespace="default", name=CLIENT_NAME),
     endpoint=CLIENT_ENDPOINT,
     token=CLIENT_TOKEN,
     drivers=ClientConfigV1Alpha1Drivers(allow=[], unsafe=True),

packages/jumpstarter-cli-admin/jumpstarter_cli_admin/import_res_test.py

@@ -24,12 +24,14 @@
 # Create a test client config
 UNSAFE_CLIENT_CONFIG = ClientConfigV1Alpha1(
     name=CLIENT_NAME,
+    metadata=ObjectMeta(namespace="default", name=CLIENT_NAME),
     endpoint=CLIENT_ENDPOINT,
     token=CLIENT_TOKEN,
     drivers=ClientConfigV1Alpha1Drivers(allow=[], unsafe=True),
 )
 CLIENT_CONFIG = ClientConfigV1Alpha1(
     name=CLIENT_NAME,
+    metadata=ObjectMeta(namespace="default", name=CLIENT_NAME),
     endpoint=CLIENT_ENDPOINT,
     token=CLIENT_TOKEN,
     drivers=ClientConfigV1Alpha1Drivers(allow=[DRIVER_NAME], unsafe=False),

packages/jumpstarter-cli-client/jumpstarter_cli_client/client_config.py

@@ -3,17 +3,29 @@
 import asyncclick as click
 from jumpstarter_cli_common import make_table
 
-from jumpstarter.config import ClientConfigV1Alpha1, ClientConfigV1Alpha1Drivers, UserConfigV1Alpha1
+from jumpstarter.config import ClientConfigV1Alpha1, ClientConfigV1Alpha1Drivers, ObjectMeta, UserConfigV1Alpha1
 
 
 @click.command("create-config", short_help="Create a client config.")
-@click.argument("name")
+@click.argument("alias")
 @click.option(
     "-o",
     "--out",
     type=click.Path(dir_okay=False, resolve_path=True, writable=True),
     help="Specify an output file for the client config.",
 )
+@click.option(
+    "--namespace",
+    type=str,
+    help="Enter the Jumpstarter client namespace.",
+    prompt="Enter a valid Jumpstarter client nespace",
+)
+@click.option(
+    "--name",
+    type=str,
+    help="Enter the Jumpstarter client name.",
+    prompt="Enter a valid Jumpstarter client name",
+)
 @click.option(
     "-e",
     "--endpoint",
@@ -39,6 +51,8 @@
 )
 @click.option("--unsafe", is_flag=True, help="Should all driver client packages be allowed to load (UNSAFE!).")
 def create_client_config(
+    alias: str,
+    namespace: str,
     name: str,
     endpoint: str,
     token: str,
@@ -47,11 +61,12 @@ def create_client_config(
     out: Optional[str],
 ):
     """Create a Jumpstarter client configuration."""
-    if out is None and ClientConfigV1Alpha1.exists(name):
-        raise click.ClickException(f"A client with the name '{name}' already exists.")
+    if out is None and ClientConfigV1Alpha1.exists(alias):
+        raise click.ClickException(f"A client with the name '{alias}' already exists.")
 
     config = ClientConfigV1Alpha1(
-        name=name,
+        name=alias,
+        metadata=ObjectMeta(namespace=namespace, name=name),
         endpoint=endpoint,
         token=token,
         drivers=ClientConfigV1Alpha1Drivers(allow=allow.split(","), unsafe=unsafe),

packages/jumpstarter-cli-client/jumpstarter_cli_client/client_test.py

@@ -18,22 +18,48 @@ async def test_client(tmp_config_path):
     # create client non-interactively
     result = await runner.invoke(
         client,
-        ["create-config", "test1", "--endpoint", "example.com:443", "--token", "dummy", "--allow", "jumpstarter.*"],
+        [
+            "create-config",
+            "test1",
+            "--namespace",
+            "default",
+            "--name",
+            "test1",
+            "--endpoint",
+            "example.com:443",
+            "--token",
+            "dummy",
+            "--allow",
+            "jumpstarter.*",
+        ],
     )
     assert result.exit_code == 0
 
     # create duplicate client
     result = await runner.invoke(
         client,
-        ["create-config", "test1", "--endpoint", "example.com:443", "--token", "dummy", "--allow", "jumpstarter.*"],
+        [
+            "create-config",
+            "test1",
+            "--namespace",
+            "default",
+            "--name",
+            "test1",
+            "--endpoint",
+            "example.com:443",
+            "--token",
+            "dummy",
+            "--allow",
+            "jumpstarter.*",
+        ],
     )
     assert result.exit_code != 0
 
     # create client interactively
     result = await runner.invoke(
         client,
         ["create-config", "test2"],
-        input="example.org:443\ndummytoken\njumpstarter.*,com.example.*\n",
+        input="default\ntest2\nexample.org:443\ndummytoken\njumpstarter.*,com.example.*\n",
     )
     assert result.exit_code == 0
 

packages/jumpstarter-kubernetes/jumpstarter_kubernetes/clients.py

@@ -7,7 +7,7 @@
 from kubernetes_asyncio.client.models import V1ObjectMeta, V1ObjectReference
 
 from .util import AbstractAsyncCustomObjectApi
-from jumpstarter.config import ClientConfigV1Alpha1, ClientConfigV1Alpha1Drivers
+from jumpstarter.config import ClientConfigV1Alpha1, ClientConfigV1Alpha1Drivers, ObjectMeta
 
 logger = logging.getLogger(__name__)
 
@@ -105,6 +105,10 @@ async def get_client_config(self, name: str, allow: list[str], unsafe=False) ->
         token = base64.b64decode(secret.data["token"]).decode("utf8")
         return ClientConfigV1Alpha1(
             name=name,
+            metadata=ObjectMeta(
+                namespace=client.metadata.namespace,
+                name=client.metadata.name,
+            ),
             endpoint=endpoint,
             token=token,
             drivers=ClientConfigV1Alpha1Drivers(allow=allow, unsafe=unsafe),

packages/jumpstarter/jumpstarter/config/client.py

@@ -9,8 +9,8 @@
 from jumpstarter_protocol import jumpstarter_pb2, jumpstarter_pb2_grpc
 from pydantic import BaseModel, Field, ValidationError
 
-from .common import CONFIG_PATH
-from .env import JMP_DRIVERS_ALLOW, JMP_ENDPOINT, JMP_LEASE, JMP_TOKEN
+from .common import CONFIG_PATH, ObjectMeta
+from .env import JMP_DRIVERS_ALLOW, JMP_ENDPOINT, JMP_LEASE, JMP_NAME, JMP_NAMESPACE, JMP_TOKEN
 from .tls import TLSConfigV1Alpha1
 from jumpstarter.common import MetadataFilter
 from jumpstarter.common.grpc import aio_secure_channel, ssl_channel_credentials
@@ -41,6 +41,8 @@ class ClientConfigV1Alpha1(BaseModel):
     apiVersion: Literal["jumpstarter.dev/v1alpha1"] = Field(default="jumpstarter.dev/v1alpha1")
     kind: Literal["ClientConfig"] = Field(default="ClientConfig")
 
+    metadata: ObjectMeta
+
     endpoint: str
     tls: TLSConfigV1Alpha1 = Field(default_factory=TLSConfigV1Alpha1)
     token: str
@@ -141,6 +143,10 @@ def try_from_env(cls):
     def from_env(cls):
         allow, unsafe = _allow_from_env()
         return cls(
+            metadata=ObjectMeta(
+                namespace=os.environ.get(JMP_NAMESPACE),
+                name=os.environ.get(JMP_NAME),
+            ),
             endpoint=os.environ.get(JMP_ENDPOINT),
             token=os.environ.get(JMP_TOKEN),
             drivers=ClientConfigV1Alpha1Drivers(

packages/jumpstarter/jumpstarter/config/client_config_test.py

@@ -7,11 +7,8 @@
 import yaml
 from pydantic import ValidationError
 
-from jumpstarter.config import (
-    ClientConfigV1Alpha1,
-    ClientConfigV1Alpha1Drivers,
-)
-from jumpstarter.config.env import JMP_DRIVERS_ALLOW, JMP_ENDPOINT, JMP_TOKEN
+from jumpstarter.config import ClientConfigV1Alpha1, ClientConfigV1Alpha1Drivers, ObjectMeta
+from jumpstarter.config.env import JMP_DRIVERS_ALLOW, JMP_ENDPOINT, JMP_NAME, JMP_NAMESPACE, JMP_TOKEN
 
 
 def test_client_ensure_exists_makes_dir(monkeypatch: pytest.MonkeyPatch):
@@ -22,12 +19,16 @@ def test_client_ensure_exists_makes_dir(monkeypatch: pytest.MonkeyPatch):
 
 
 def test_client_config_try_from_env(monkeypatch: pytest.MonkeyPatch):
+    monkeypatch.setenv(JMP_NAMESPACE, "default")
+    monkeypatch.setenv(JMP_NAME, "testclient")
     monkeypatch.setenv(JMP_TOKEN, "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz")
     monkeypatch.setenv(JMP_ENDPOINT, "jumpstarter.my-lab.com:1443")
     monkeypatch.setenv(JMP_DRIVERS_ALLOW, "jumpstarter.drivers.*,vendorpackage.*")
 
     config = ClientConfigV1Alpha1.try_from_env()
     assert config.name == "default"
+    assert config.metadata.namespace == "default"
+    assert config.metadata.name == "testclient"
     assert config.token == "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz"
     assert config.endpoint == "jumpstarter.my-lab.com:1443"
     assert config.drivers.allow == ["jumpstarter.drivers.*", "vendorpackage.*"]
@@ -40,25 +41,33 @@ def test_client_config_try_from_env_not_set():
 
 
 def test_client_config_from_env(monkeypatch: pytest.MonkeyPatch):
+    monkeypatch.setenv(JMP_NAMESPACE, "default")
+    monkeypatch.setenv(JMP_NAME, "testclient")
     monkeypatch.setenv(JMP_TOKEN, "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz")
     monkeypatch.setenv(JMP_ENDPOINT, "jumpstarter.my-lab.com:1443")
     monkeypatch.setenv(JMP_DRIVERS_ALLOW, "jumpstarter.drivers.*,vendorpackage.*")
 
     config = ClientConfigV1Alpha1.from_env()
     assert config.name == "default"
+    assert config.metadata.namespace == "default"
+    assert config.metadata.name == "testclient"
     assert config.token == "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz"
     assert config.endpoint == "jumpstarter.my-lab.com:1443"
     assert config.drivers.allow == ["jumpstarter.drivers.*", "vendorpackage.*"]
     assert config.drivers.unsafe is False
 
 
 def test_client_config_from_env_allow_unsafe(monkeypatch: pytest.MonkeyPatch):
+    monkeypatch.setenv(JMP_NAMESPACE, "default")
+    monkeypatch.setenv(JMP_NAME, "testclient")
     monkeypatch.setenv(JMP_TOKEN, "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz")
     monkeypatch.setenv(JMP_ENDPOINT, "jumpstarter.my-lab.com:1443")
     monkeypatch.setenv(JMP_DRIVERS_ALLOW, "UNSAFE")
 
     config = ClientConfigV1Alpha1.from_env()
     assert config.name == "default"
+    assert config.metadata.namespace == "default"
+    assert config.metadata.name == "testclient"
     assert config.token == "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz"
     assert config.endpoint == "jumpstarter.my-lab.com:1443"
     assert config.drivers.allow == []
@@ -67,6 +76,8 @@ def test_client_config_from_env_allow_unsafe(monkeypatch: pytest.MonkeyPatch):
 
 @pytest.mark.parametrize("missing_field", [JMP_TOKEN, JMP_ENDPOINT])
 def test_client_config_from_env_missing_field_raises(monkeypatch: pytest.MonkeyPatch, missing_field):
+    monkeypatch.setenv(JMP_NAMESPACE, "default")
+    monkeypatch.setenv(JMP_NAME, "testclient")
     monkeypatch.setenv(JMP_TOKEN, "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz")
     monkeypatch.setenv(JMP_ENDPOINT, "jumpstarter.my-lab.com:1443")
     monkeypatch.setenv(JMP_DRIVERS_ALLOW, "jumpstarter.drivers.*,vendorpackage.*")
@@ -80,6 +91,9 @@ def test_client_config_from_env_missing_field_raises(monkeypatch: pytest.MonkeyP
 def test_client_config_from_file():
     CLIENT_CONFIG = """apiVersion: jumpstarter.dev/v1alpha1
 kind: ClientConfig
+metadata:
+  namespace: default
+  name: testclient
 endpoint: jumpstarter.my-lab.com:1443
 token: dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz
 drivers:
@@ -92,6 +106,8 @@ def test_client_config_from_file():
         f.close()
         config = ClientConfigV1Alpha1.from_file(f.name)
         assert config.name == f.name.split("/")[-1]
+        assert config.metadata.namespace == "default"
+        assert config.metadata.name == "testclient"
         assert config.endpoint == "jumpstarter.my-lab.com:1443"
         assert config.token == "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz"
         assert config.drivers.allow == ["jumpstarter.drivers.*", "vendorpackage.*"]
@@ -160,6 +176,7 @@ def test_client_config_load():
                 "from_file",
                 return_value=ClientConfigV1Alpha1(
                     name="another",
+                    metadata=ObjectMeta(namespace="default", name="another"),
                     endpoint="abc",
                     token="123",
                     drivers=ClientConfigV1Alpha1Drivers(allow=[], unsafe=False),
@@ -180,6 +197,9 @@ def test_client_config_load_not_found_raises():
 def test_client_config_save(monkeypatch: pytest.MonkeyPatch):
     CLIENT_CONFIG = """apiVersion: jumpstarter.dev/v1alpha1
 kind: ClientConfig
+metadata:
+  namespace: default
+  name: testclient
 endpoint: jumpstarter.my-lab.com:1443
 tls:
   ca: ''
@@ -193,6 +213,7 @@ def test_client_config_save(monkeypatch: pytest.MonkeyPatch):
 """
     config = ClientConfigV1Alpha1(
         name="testclient",
+        metadata=ObjectMeta(namespace="default", name="testclient"),
         endpoint="jumpstarter.my-lab.com:1443",
         token="dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz",
         drivers=ClientConfigV1Alpha1Drivers(allow=["jumpstarter.drivers.*", "vendorpackage.*"], unsafe=False),
@@ -211,6 +232,9 @@ def test_client_config_save(monkeypatch: pytest.MonkeyPatch):
 def test_client_config_save_explicit_path():
     CLIENT_CONFIG = """apiVersion: jumpstarter.dev/v1alpha1
 kind: ClientConfig
+metadata:
+  namespace: default
+  name: testclient
 endpoint: jumpstarter.my-lab.com:1443
 tls:
   ca: ''
@@ -224,6 +248,7 @@ def test_client_config_save_explicit_path():
 """
     config = ClientConfigV1Alpha1(
         name="testclient",
+        metadata=ObjectMeta(namespace="default", name="testclient"),
         endpoint="jumpstarter.my-lab.com:1443",
         token="dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz",
         drivers=ClientConfigV1Alpha1Drivers(allow=["jumpstarter.drivers.*", "vendorpackage.*"], unsafe=False),
@@ -240,6 +265,9 @@ def test_client_config_save_explicit_path():
 def test_client_config_save_unsafe_drivers():
     CLIENT_CONFIG = """apiVersion: jumpstarter.dev/v1alpha1
 kind: ClientConfig
+metadata:
+  namespace: default
+  name: testclient
 endpoint: jumpstarter.my-lab.com:1443
 tls:
   ca: ''
@@ -251,6 +279,7 @@ def test_client_config_save_unsafe_drivers():
 """
     config = ClientConfigV1Alpha1(
         name="testclient",
+        metadata=ObjectMeta(namespace="default", name="testclient"),
         endpoint="jumpstarter.my-lab.com:1443",
         token="dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz",
         drivers=ClientConfigV1Alpha1Drivers(allow=[], unsafe=True),
@@ -275,6 +304,9 @@ def test_client_config_exists():
 def test_client_config_list(monkeypatch: pytest.MonkeyPatch):
     CLIENT_CONFIG = """apiVersion: jumpstarter.dev/v1alpha1
 kind: ClientConfig
+metadata:
+  namespace: default
+  name: testclient
 endpoint: jumpstarter.my-lab.com:1443
 token: dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz
 drivers:

packages/jumpstarter/jumpstarter/config/env.py

@@ -1,5 +1,7 @@
 # Common environment variables for client/exporter config
 JMP_CLIENT_CONFIG = "JMP_CLIENT_CONFIG"
+JMP_NAMESPACE = "JMP_NAMESPACE"
+JMP_NAME = "JMP_NAME"
 JMP_ENDPOINT = "JMP_ENDPOINT"
 JMP_TOKEN = "JMP_TOKEN"
 JMP_DRIVERS_ALLOW = "JMP_DRIVERS_ALLOW"

packages/jumpstarter/jumpstarter/config/exporter_test.py

@@ -40,6 +40,7 @@ async def test_exporter_serve(mock_controller):
 
     client = ClientConfigV1Alpha1(
         name="testclient",
+        metadata=ObjectMeta(namespace="default", name="testclient"),
         endpoint=mock_controller,
         token="dummy-client-token",
         drivers=ClientConfigV1Alpha1Drivers(allow=[], unsafe=True),