Merge pull request #252 from jumpstarter-dev/metadata

Add ObjectMeta to config

Author: mangelajo

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

@@ -18,6 +18,7 @@
     ClientConfigV1Alpha1,
     ClientConfigV1Alpha1Drivers,
     ExporterConfigV1Alpha1,
+    ObjectMeta,
 )
 
 # Generate a random client name
@@ -32,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),
@@ -116,11 +119,12 @@ async def test_create_client(
 EXPORTER_OBJECT = V1Alpha1Exporter(
     api_version="jumpstarter.dev/v1alpha1",
     kind="Exporter",
-    metadata=V1ObjectMeta(name=EXPORTER_NAME, namespace="default", creation_timestamp="2024-01-01T21:00:00Z"),
+    metadata=V1ObjectMeta(namespace="default", name=EXPORTER_NAME, creation_timestamp="2024-01-01T21:00:00Z"),
     status=V1Alpha1ExporterStatus(endpoint=EXPORTER_ENDPOINT, credential=None, devices=[]),
 )
 EXPORTER_CONFIG = ExporterConfigV1Alpha1(
     alias=EXPORTER_NAME,
+    metadata=ObjectMeta(namespace="default", name=EXPORTER_NAME),
     endpoint=EXPORTER_ENDPOINT,
     token=EXPORTER_TOKEN,
 )

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

@@ -15,6 +15,7 @@
     ClientConfigV1Alpha1,
     ClientConfigV1Alpha1Drivers,
     ExporterConfigV1Alpha1,
+    ObjectMeta,
     UserConfigV1Alpha1,
     UserConfigV1Alpha1Config,
 )
@@ -29,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),
@@ -133,11 +135,12 @@ async def test_delete_client(
 EXPORTER_OBJECT = V1Alpha1Exporter(
     api_version="jumpstarter.dev/v1alpha1",
     kind="Exporter",
-    metadata=V1ObjectMeta(name=EXPORTER_NAME, namespace="default", creation_timestamp="2024-01-01T21:00:00Z"),
+    metadata=V1ObjectMeta(namespace="default", name=EXPORTER_NAME, creation_timestamp="2024-01-01T21:00:00Z"),
     status=V1Alpha1ExporterStatus(endpoint=EXPORTER_ENDPOINT, credential=None, devices=[]),
 )
 EXPORTER_CONFIG = ExporterConfigV1Alpha1(
     alias=EXPORTER_NAME,
+    metadata=ObjectMeta(namespace="default", name=EXPORTER_NAME),
     endpoint=EXPORTER_ENDPOINT,
     token=EXPORTER_TOKEN,
 )

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

@@ -13,6 +13,7 @@
     ClientConfigV1Alpha1,
     ClientConfigV1Alpha1Drivers,
     ExporterConfigV1Alpha1,
+    ObjectMeta,
 )
 
 # Generate a random client name
@@ -23,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),
@@ -85,6 +88,7 @@ async def test_import_client(_load_kube_config_mock, get_client_config_mock: Asy
 # Create a test exporter config
 EXPORTER_CONFIG = ExporterConfigV1Alpha1(
     alias=EXPORTER_NAME,
+    metadata=ObjectMeta(namespace="default", name=EXPORTER_NAME),
     endpoint=EXPORTER_ENDPOINT,
     token=EXPORTER_TOKEN,
 )

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-cli-exporter/jumpstarter_cli_exporter/exporter_config.py

@@ -1,16 +1,18 @@
 import asyncclick as click
 from jumpstarter_cli_common import make_table
 
-from jumpstarter.config.exporter import ExporterConfigV1Alpha1
+from jumpstarter.config.exporter import ExporterConfigV1Alpha1, ObjectMeta
 
 arg_alias = click.argument("alias", default="default")
 
 
 @click.command("create-config")
+@click.option("--namespace", prompt=True)
+@click.option("--name", prompt=True)
 @click.option("--endpoint", prompt=True)
 @click.option("--token", prompt=True)
 @arg_alias
-def create_exporter_config(alias, endpoint, token):
+def create_exporter_config(alias, namespace, name, endpoint, token):
     """Create an exporter config."""
     try:
         ExporterConfigV1Alpha1.load(alias)
@@ -21,6 +23,7 @@ def create_exporter_config(alias, endpoint, token):
 
     config = ExporterConfigV1Alpha1(
         alias=alias,
+        metadata=ObjectMeta(namespace=namespace, name=name),
         endpoint=endpoint,
         token=token,
     )

packages/jumpstarter-cli-exporter/jumpstarter_cli_exporter/exporter_test.py

@@ -16,18 +16,44 @@ async def test_exporter(tmp_config_path):
 
     # create exporter non-interactively
     result = await runner.invoke(
-        exporter, ["create-config", "test1", "--endpoint", "example.com:443", "--token", "dummy"]
+        exporter,
+        [
+            "create-config",
+            "test1",
+            "--namespace",
+            "default",
+            "--name",
+            "test1",
+            "--endpoint",
+            "example.com:443",
+            "--token",
+            "dummy",
+        ],
     )
     assert result.exit_code == 0
 
     # create duplicate exporter
     result = await runner.invoke(
-        exporter, ["create-config", "test1", "--endpoint", "example.com:443", "--token", "dummy"]
+        exporter,
+        [
+            "create-config",
+            "test1",
+            "--namespace",
+            "default",
+            "--name",
+            "test1",
+            "--endpoint",
+            "example.com:443",
+            "--token",
+            "dummy",
+        ],
     )
     assert result.exit_code != 0
 
     # create exporter interactively
-    result = await runner.invoke(exporter, ["create-config", "test2"], input="example.org:443\ndummytoken\n")
+    result = await runner.invoke(
+        exporter, ["create-config", "test2"], input="default\ntest2\nexample.org:443\ndummytoken\n"
+    )
     assert result.exit_code == 0
 
     # list exporters

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-kubernetes/jumpstarter_kubernetes/exporters.py

@@ -6,7 +6,7 @@
 from kubernetes_asyncio.client.models import V1ObjectMeta, V1ObjectReference
 
 from .util import AbstractAsyncCustomObjectApi
-from jumpstarter.config import ExporterConfigV1Alpha1
+from jumpstarter.config import ExporterConfigV1Alpha1, ObjectMeta
 
 CREATE_EXPORTER_DELAY = 1
 CREATE_EXPORTER_COUNT = 10
@@ -110,7 +110,16 @@ async def get_exporter_config(self, name: str) -> ExporterConfigV1Alpha1:
         secret = await self.core_api.read_namespaced_secret(exporter.status.credential.name, self.namespace)
         endpoint = exporter.status.endpoint
         token = base64.b64decode(secret.data["token"]).decode("utf8")
-        return ExporterConfigV1Alpha1(alias=name, endpoint=endpoint, token=token, export={})
+        return ExporterConfigV1Alpha1(
+            alias=name,
+            metadata=ObjectMeta(
+                namespace=exporter.metadata.namespace,
+                name=exporter.metadata.name,
+            ),
+            endpoint=endpoint,
+            token=token,
+            export={},
+        )
 
     async def delete_exporter(self, name: str):
         """Delete an exporter object"""

packages/jumpstarter/jumpstarter/config/__init__.py

@@ -2,7 +2,7 @@
     ClientConfigV1Alpha1,
     ClientConfigV1Alpha1Drivers,
 )
-from .common import CONFIG_API_VERSION, CONFIG_PATH
+from .common import CONFIG_API_VERSION, CONFIG_PATH, ObjectMeta
 from .env import JMP_CLIENT_CONFIG, JMP_DRIVERS_ALLOW, JMP_ENDPOINT, JMP_TOKEN
 from .exporter import ExporterConfigV1Alpha1, ExporterConfigV1Alpha1DriverInstance
 from .user import UserConfigV1Alpha1, UserConfigV1Alpha1Config
@@ -15,6 +15,7 @@
     "JMP_TOKEN",
     "JMP_DRIVERS_ALLOW",
     "JMP_DRIVERS_ALLOW_UNSAFE",
+    "ObjectMeta",
     "UserConfigV1Alpha1",
     "UserConfigV1Alpha1Config",
     "ClientConfigV1Alpha1",