From a22e48b13e986d48d844d44b9b8d58bd74799928 Mon Sep 17 00:00:00 2001 From: Nick Cao Date: Thu, 6 Feb 2025 09:21:11 -0500 Subject: [PATCH 1/2] Add dummy metadata to ExporterConfig examples --- __templates__/driver/examples/exporter.yaml.tmpl | 3 +++ docs/source/cli/exporters.md | 6 ++++++ docs/source/getting-started/setup-local-client.md | 3 +++ docs/source/introduction/drivers.md | 3 +++ docs/source/introduction/exporters.md | 3 +++ .../soc-pytest/jumpstarter_example_soc_pytest/exporter.yaml | 5 ++++- packages/jumpstarter-driver-dutlink/examples/exporter.yaml | 3 +++ packages/jumpstarter-driver-tftp/examples/exporter.yaml | 3 +++ 8 files changed, 28 insertions(+), 1 deletion(-) diff --git a/__templates__/driver/examples/exporter.yaml.tmpl b/__templates__/driver/examples/exporter.yaml.tmpl index 4c558ecf8..c65a0e95d 100644 --- a/__templates__/driver/examples/exporter.yaml.tmpl +++ b/__templates__/driver/examples/exporter.yaml.tmpl @@ -1,5 +1,8 @@ apiVersion: jumpstarter.dev/v1alpha1 kind: ExporterConfig +metadata: + namespace: default + name: demo endpoint: grpc.jumpstarter.192.168.0.203.nip.io:8082 token: "" export: diff --git a/docs/source/cli/exporters.md b/docs/source/cli/exporters.md index 591252035..ebdf41862 100644 --- a/docs/source/cli/exporters.md +++ b/docs/source/cli/exporters.md @@ -24,6 +24,9 @@ This creates an exporter named `my-exporter` and produces a YAML configuration f ```yaml apiVersion: jumpstarter.dev/v1alpha1 kind: ExporterConfig +metadata: + namespace: jumpstarter-lab + name: my-exporter endpoint: grpc.jumpstarter.example.com:443 token: <> @@ -40,6 +43,9 @@ will provide a few mock interfaces to play with: ```yaml apiVersion: jumpstarter.dev/v1alpha1 kind: ExporterConfig +metadata: + namespace: default + name: demo endpoint: grpc.jumpstarter.192.168.1.10.nip.io:8082 token: <> tls: diff --git a/docs/source/getting-started/setup-local-client.md b/docs/source/getting-started/setup-local-client.md index 0383242e0..11ef4c303 100644 --- a/docs/source/getting-started/setup-local-client.md +++ b/docs/source/getting-started/setup-local-client.md @@ -8,6 +8,9 @@ Create a text file with the following content # /etc/jumpstarter/exporters/demo.yaml apiVersion: jumpstarter.dev/v1alpha1 kind: ExporterConfig +metadata: + namespace: default + name: demo # endpoint and token are intentionally left empty endpoint: "" token: "" diff --git a/docs/source/introduction/drivers.md b/docs/source/introduction/drivers.md index c449022b7..1420c6a02 100644 --- a/docs/source/introduction/drivers.md +++ b/docs/source/introduction/drivers.md @@ -26,6 +26,9 @@ Here is an example exporter config that loads a driver: ```yaml apiVersion: jumpstarter.dev/v1alpha1 kind: ExporterConfig +metadata: + namespace: default + name: demo endpoint: grpc.jumpstarter.example.com:443 token: xxxxx export: diff --git a/docs/source/introduction/exporters.md b/docs/source/introduction/exporters.md index 15bc15383..c9f0d3735 100644 --- a/docs/source/introduction/exporters.md +++ b/docs/source/introduction/exporters.md @@ -24,6 +24,9 @@ Here is an example Exporter config file: ```yaml apiVersion: jumpstarter.dev/v1alpha1 kind: ExporterConfig +metadata: + namespace: default + name: demo endpoint: grpc.jumpstarter.example.com:443 token: xxxxx export: diff --git a/examples/soc-pytest/jumpstarter_example_soc_pytest/exporter.yaml b/examples/soc-pytest/jumpstarter_example_soc_pytest/exporter.yaml index 6aafb3fd6..e5c3bab57 100644 --- a/examples/soc-pytest/jumpstarter_example_soc_pytest/exporter.yaml +++ b/examples/soc-pytest/jumpstarter_example_soc_pytest/exporter.yaml @@ -1,5 +1,8 @@ apiVersion: jumpstarter.dev/v1alpha1 kind: ExporterConfig +metadata: + namespace: default + name: demo endpoint: grpc.jumpstarter.example.com:443 token: xxxxx export: @@ -21,4 +24,4 @@ export: config: args: device: '/dev/v4l/by-path/pci-0000:00:14.0-usbv2-0:4:1.0-video-index0' - resolution: 1280x720 \ No newline at end of file + resolution: 1280x720 diff --git a/packages/jumpstarter-driver-dutlink/examples/exporter.yaml b/packages/jumpstarter-driver-dutlink/examples/exporter.yaml index 067146ce2..972a84f6c 100644 --- a/packages/jumpstarter-driver-dutlink/examples/exporter.yaml +++ b/packages/jumpstarter-driver-dutlink/examples/exporter.yaml @@ -1,6 +1,9 @@ # /etc/jumpstarter/exporters/dutlink.yaml apiVersion: jumpstarter.dev/v1alpha1 kind: ExporterConfig +metadata: + namespace: default + name: demo endpoint: "" token: "" export: diff --git a/packages/jumpstarter-driver-tftp/examples/exporter.yaml b/packages/jumpstarter-driver-tftp/examples/exporter.yaml index fc5a2acf5..6d1fae19e 100644 --- a/packages/jumpstarter-driver-tftp/examples/exporter.yaml +++ b/packages/jumpstarter-driver-tftp/examples/exporter.yaml @@ -1,5 +1,8 @@ apiVersion: jumpstarter.dev/v1alpha1 kind: ExporterConfig +metadata: + namespace: default + name: demo endpoint: grpc.jumpstarter.192.168.0.203.nip.io:8082 token: "" export: From 63ea8e2aecb58cfe42f9e4753ca96d1c063b1c62 Mon Sep 17 00:00:00 2001 From: Nick Cao Date: Thu, 6 Feb 2025 09:23:00 -0500 Subject: [PATCH 2/2] Add dummy metadata to ClientConfig examples --- docs/source/cli/clients.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/cli/clients.md b/docs/source/cli/clients.md index 16b972b3f..0a35e0d16 100644 --- a/docs/source/cli/clients.md +++ b/docs/source/cli/clients.md @@ -32,6 +32,9 @@ file named `john.yaml`: ```yaml apiVersion: jumpstarter.dev/v1alpha1 kind: ClientConfig +metadata: + namespace: jumpstarter-lab + name: john endpoint: grpc.jumpstarter.192.168.1.10.nip.io:8082 token: <> tls: