Merge pull request #135 from jumpstarter-dev/grpcs

Drop grpcs scheme from endpoints

Author: mangelajo

docs/source/cli/clients.md

@@ -29,7 +29,7 @@ file called `my-client.yaml`:
 ```yaml
 client:
     name: my-client
-    endpoint: "grpcs://jumpstarter.my-lab.com:1443"
+    endpoint: "jumpstarter.my-lab.com:1443"
     token: dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz
 ```
 

docs/source/cli/exporters.md

@@ -22,7 +22,7 @@ YAML file called `my-exporter.yaml`:
 ```yaml
 exporter:
     name: my-exporter
-    endpoint: "grpcs://jumpstarter.my-lab.com:1443"
+    endpoint: "jumpstarter.my-lab.com:1443"
     token: dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz
     # environmentConfig: /etc/jumpstarter/environment.py
 ```

docs/source/cli/run-tests.md

@@ -14,7 +14,7 @@ service.
 Alternatively the client can receive the endpoint and token as environment variables:
 
 ```bash
-export JUMPSTARTER_ENDPOINT=grpcs://jumpstarter.my-lab.com:1443
+export JUMPSTARTER_ENDPOINT=jumpstarter.my-lab.com:1443
 export JUMPSTARTER_TOKEN=dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz
 ```
 

docs/source/config.md

@@ -69,7 +69,7 @@ the client name, access token, and any configuration parameters.
 apiVersion: jumpstarter.dev/v1alpha1
 kind: Client
 client:
-  endpoint: "grpcs://jumpstarter.my-lab.com:1443"
+  endpoint: "jumpstarter.my-lab.com:1443"
   token: "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz"
   drivers:
     # Wildcards are supported
@@ -115,10 +115,10 @@ All client configurations can be listed with `jmp client list`:
 
 ```bash
 $ jmp client list
-CURRENT   NAME       ENDPOINT                               PATH
-*         default    grpcs://jumpstarter1.my-lab.com:1443   /home/jdoe/.config/jumpstarter/clients/default.yaml
-          myclient   grpcs://jumpstarter2.my-lab.com:1443   /home/jdoe/.config/jumpstarter/clients/myclient.yaml
-          another    grpcs://jumpstarter3.my-lab.com:1443   /home/jdoe/.config/jumpstarter/clients/another.yaml
+CURRENT   NAME       ENDPOINT                       PATH
+*         default    jumpstarter1.my-lab.com:1443   /home/jdoe/.config/jumpstarter/clients/default.yaml
+          myclient   jumpstarter2.my-lab.com:1443   /home/jdoe/.config/jumpstarter/clients/myclient.yaml
+          another    jumpstarter3.my-lab.com:1443   /home/jdoe/.config/jumpstarter/clients/another.yaml
 ```
 
 Clients can also be removed using `jmp client delete <name>`:
@@ -158,7 +158,7 @@ of built-in drivers and any additional driver packages registered by the user.
 
 apiVersion: jumpstarter.dev/v1alpha1
 kind: Exporter
-endpoint: "grpcs://jumpstarter.my-lab.com:1443"
+endpoint: "jumpstarter.my-lab.com:1443"
 token: "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz"
 export:
   power:
@@ -222,10 +222,10 @@ All exporter configurations can be listed with `jmp exporter list`:
 
 ```bash
 $ jmp exporter list
-CURRENT   NAME         ENDPOINT                               PATH                                           SCRIPT
-*         default      grpcs://jumpstarter1.my-lab.com:1443   /etc/jumpstarter/exporters/default.yaml            N/A
-          myexporter   grpcs://jumpstarter2.my-lab.com:1443   /etc/jumpstarter/exporters/myexporter.yaml         N/A
-          another      grpcs://jumpstarter3.my-lab.com:1443   /etc/jumpstarter/exporters/another/exporter.yaml   /etc/jumpstarter/exporters/another/setup.py
+CURRENT   NAME         ENDPOINT                       PATH
+*         default      jumpstarter1.my-lab.com:1443   /etc/jumpstarter/exporters/default.yaml
+          myexporter   jumpstarter2.my-lab.com:1443   /etc/jumpstarter/exporters/myexporter.yaml
+          another      jumpstarter3.my-lab.com:1443   /etc/jumpstarter/exporters/another/exporter.yaml
 ```
 
 Clients can also be removed using `jmp client delete <name>`:

jumpstarter/config/exporter_test.py

@@ -63,7 +63,7 @@ def test_exporter_config(monkeypatch, tmp_path):
     text = """apiVersion: jumpstarter.dev/v1alpha1
 kind: ExporterConfig
 
-endpoint: "grpcs://jumpstarter.my-lab.com:1443"
+endpoint: "jumpstarter.my-lab.com:1443"
 token: "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz"
 
 export:
@@ -98,7 +98,7 @@ def test_exporter_config(monkeypatch, tmp_path):
         alias="test",
         apiVersion="jumpstarter.dev/v1alpha1",
         kind="ExporterConfig",
-        endpoint="grpcs://jumpstarter.my-lab.com:1443",
+        endpoint="jumpstarter.my-lab.com:1443",
         token="dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz",
         export={
             "power": ExporterConfigV1Alpha1DriverInstance(

tests/test_client_config.py

@@ -24,13 +24,13 @@ def test_client_ensure_exists_makes_dir(monkeypatch):
 
 def test_client_config_try_from_env(monkeypatch):
     monkeypatch.setenv(JMP_TOKEN, "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz")
-    monkeypatch.setenv(JMP_ENDPOINT, "grpcs://jumpstarter.my-lab.com:1443")
+    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.client.token == "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz"
-    assert config.client.endpoint == "grpcs://jumpstarter.my-lab.com:1443"
+    assert config.client.endpoint == "jumpstarter.my-lab.com:1443"
     assert config.client.drivers.allow == ["jumpstarter.drivers.*", "vendorpackage.*"]
     assert config.client.drivers.unsafe is False
 
@@ -42,34 +42,34 @@ def test_client_config_try_from_env_not_set():
 
 def test_client_config_from_env(monkeypatch):
     monkeypatch.setenv(JMP_TOKEN, "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz")
-    monkeypatch.setenv(JMP_ENDPOINT, "grpcs://jumpstarter.my-lab.com:1443")
+    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.client.token == "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz"
-    assert config.client.endpoint == "grpcs://jumpstarter.my-lab.com:1443"
+    assert config.client.endpoint == "jumpstarter.my-lab.com:1443"
     assert config.client.drivers.allow == ["jumpstarter.drivers.*", "vendorpackage.*"]
     assert config.client.drivers.unsafe is False
 
 
 def test_client_config_from_env_allow_unsafe(monkeypatch):
     monkeypatch.setenv(JMP_TOKEN, "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz")
-    monkeypatch.setenv(JMP_ENDPOINT, "grpcs://jumpstarter.my-lab.com:1443")
+    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.client.token == "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz"
-    assert config.client.endpoint == "grpcs://jumpstarter.my-lab.com:1443"
+    assert config.client.endpoint == "jumpstarter.my-lab.com:1443"
     assert config.client.drivers.allow == []
     assert config.client.drivers.unsafe is True
 
 
 @pytest.mark.parametrize("missing_field", [JMP_TOKEN, JMP_ENDPOINT])
 def test_client_config_from_env_missing_field_raises(monkeypatch, missing_field):
     monkeypatch.setenv(JMP_TOKEN, "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz")
-    monkeypatch.setenv(JMP_ENDPOINT, "grpcs://jumpstarter.my-lab.com:1443")
+    monkeypatch.setenv(JMP_ENDPOINT, "jumpstarter.my-lab.com:1443")
     monkeypatch.setenv(JMP_DRIVERS_ALLOW, "jumpstarter.drivers.*,vendorpackage.*")
 
     monkeypatch.delenv(missing_field)
@@ -82,7 +82,7 @@ def test_client_config_from_file():
     CLIENT_CONFIG = """apiVersion: jumpstarter.dev/v1alpha1
 kind: ClientConfig
 client:
-  endpoint: grpcs://jumpstarter.my-lab.com:1443
+  endpoint: jumpstarter.my-lab.com:1443
   token: dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz
   drivers:
     allow:
@@ -94,7 +94,7 @@ def test_client_config_from_file():
         f.close()
         config = ClientConfigV1Alpha1.from_file(f.name)
         assert config.name == f.name.split("/")[-1]
-        assert config.client.endpoint == "grpcs://jumpstarter.my-lab.com:1443"
+        assert config.client.endpoint == "jumpstarter.my-lab.com:1443"
         assert (
             config.client.token == "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz"
         )
@@ -109,7 +109,7 @@ def test_client_config_from_file_invalid_field_raises(invalid_field):
         "apiVersion": "jumpstarter.dev/v1alpha1",
         "kind": "ClientConfig",
         "client": {
-            "endpoint": "grpcs://jumpstarter.my-lab.com:1443",
+            "endpoint": "jumpstarter.my-lab.com:1443",
             "token": "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz",
             "drivers": {"allow": ["jumpstarter.drivers.*", "vendorpackage.*"]},
         },
@@ -128,7 +128,7 @@ def test_client_config_from_file_missing_field_raises(missing_field):
         "apiVersion": "jumpstarter.dev/v1alpha1",
         "kind": "ClientConfig",
         "client": {
-            "endpoint": "grpcs://jumpstarter.my-lab.com:1443",
+            "endpoint": "jumpstarter.my-lab.com:1443",
             "token": "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz",
             "drivers": {"allow": ["jumpstarter.drivers.*", "vendorpackage.*"]},
         },
@@ -147,7 +147,7 @@ def test_client_config_from_file_missing_client_field_raises(missing_field):
         "apiVersion": "jumpstarter.dev/v1alpha1",
         "kind": "ClientConfig",
         "client": {
-            "endpoint": "grpcs://jumpstarter.my-lab.com:1443",
+            "endpoint": "jumpstarter.my-lab.com:1443",
             "token": "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz",
             "drivers": {"allow": ["jumpstarter.drivers.*", "vendorpackage.*"]},
         },
@@ -166,7 +166,7 @@ def test_client_config_from_file_invalid_client_drivers_field_raises(invalid_fie
         "apiVersion": "jumpstarter.dev/v1alpha1",
         "kind": "ClientConfig",
         "client": {
-            "endpoint": "grpcs://jumpstarter.my-lab.com:1443",
+            "endpoint": "jumpstarter.my-lab.com:1443",
             "token": "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz",
             "drivers": {"allow": ["jumpstarter.drivers.*", "vendorpackage.*"]},
         },
@@ -212,7 +212,7 @@ def test_client_config_save(monkeypatch):
     CLIENT_CONFIG = """apiVersion: jumpstarter.dev/v1alpha1
 kind: ClientConfig
 client:
-  endpoint: grpcs://jumpstarter.my-lab.com:1443
+  endpoint: jumpstarter.my-lab.com:1443
   token: dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz
   drivers:
     allow:
@@ -223,7 +223,7 @@ def test_client_config_save(monkeypatch):
     config = ClientConfigV1Alpha1(
         name="testclient",
         client=ClientConfigV1Alpha1Client(
-            endpoint="grpcs://jumpstarter.my-lab.com:1443",
+            endpoint="jumpstarter.my-lab.com:1443",
             token="dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz",
             drivers=ClientConfigV1Alpha1Drivers(allow=["jumpstarter.drivers.*", "vendorpackage.*"], unsafe=False),
         ),
@@ -243,7 +243,7 @@ def test_client_config_save_explicit_path():
     CLIENT_CONFIG = """apiVersion: jumpstarter.dev/v1alpha1
 kind: ClientConfig
 client:
-  endpoint: grpcs://jumpstarter.my-lab.com:1443
+  endpoint: jumpstarter.my-lab.com:1443
   token: dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz
   drivers:
     allow:
@@ -254,7 +254,7 @@ def test_client_config_save_explicit_path():
     config = ClientConfigV1Alpha1(
         name="testclient",
         client=ClientConfigV1Alpha1Client(
-            endpoint="grpcs://jumpstarter.my-lab.com:1443",
+            endpoint="jumpstarter.my-lab.com:1443",
             token="dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz",
             drivers=ClientConfigV1Alpha1Drivers(allow=["jumpstarter.drivers.*", "vendorpackage.*"], unsafe=False),
         ),
@@ -272,7 +272,7 @@ def test_client_config_save_unsafe_drivers():
     CLIENT_CONFIG = """apiVersion: jumpstarter.dev/v1alpha1
 kind: ClientConfig
 client:
-  endpoint: grpcs://jumpstarter.my-lab.com:1443
+  endpoint: jumpstarter.my-lab.com:1443
   token: dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz
   drivers:
     allow: []
@@ -281,7 +281,7 @@ def test_client_config_save_unsafe_drivers():
     config = ClientConfigV1Alpha1(
         name="testclient",
         client=ClientConfigV1Alpha1Client(
-            endpoint="grpcs://jumpstarter.my-lab.com:1443",
+            endpoint="jumpstarter.my-lab.com:1443",
             token="dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz",
             drivers=ClientConfigV1Alpha1Drivers(allow=[], unsafe=True),
         ),
@@ -307,7 +307,7 @@ def test_client_config_list(monkeypatch):
     CLIENT_CONFIG = """apiVersion: jumpstarter.dev/v1alpha1
 kind: ClientConfig
 client:
-  endpoint: grpcs://jumpstarter.my-lab.com:1443
+  endpoint: jumpstarter.my-lab.com:1443
   token: dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz
   drivers:
     allow: