Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

Commit 38d9727

Browse files
NickCaomangelajo
authored andcommitted
Update doc to match the updated client config format
1 parent 04d7b42 commit 38d9727

2 files changed

Lines changed: 12 additions & 13 deletions

File tree

docs/source/cli/clients.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The Jumpstarter CLI can be used to manage your client configurations.
77
To create a new client config, run the following command:
88

99
```bash
10-
$ jumpstarter client create my-client
10+
$ jmp client create my-client
1111
```
1212

1313
### Automatic Provisioning
@@ -27,10 +27,10 @@ This creates a client a new client named `my-client` and outputs the configurati
2727
file called `my-client.yaml`:
2828

2929
```yaml
30-
client:
31-
name: my-client
32-
endpoint: "jumpstarter.my-lab.com:1443"
33-
token: dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz
30+
apiVersion: jumpstarter.dev/v1alpha1
31+
kind: ClientConfig
32+
endpoint: "jumpstarter.my-lab.com:1443"
33+
token: dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz
3434
```
3535
3636
@@ -46,7 +46,7 @@ a client can also be provisioned manually on a different machine.
4646
apiVersion: jumpstarter.dev/v1alpha1
4747
kind: Client
4848
metadata:
49-
name: my-client
49+
name: my-client
5050
```
5151
5252
```bash
@@ -64,7 +64,7 @@ a client can also be provisioned manually on a different machine.
6464
3. Create the client config manually:
6565

6666
```bash
67-
$ jmp client create --manual
67+
$ jmp client create
6868
Enter a valid Jumpstarter service endpoint: devl.jumpstarter.dev
6969
Enter a Jumpstarter auth token (hidden): ***
7070
Enter a comma-separated list of allowed driver packages (optional):

docs/source/config.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,11 @@ the client name, access token, and any configuration parameters.
6868
6969
apiVersion: jumpstarter.dev/v1alpha1
7070
kind: Client
71-
client:
72-
endpoint: "jumpstarter.my-lab.com:1443"
73-
token: "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz"
74-
drivers:
75-
# Wildcards are supported
76-
allow: ["jumpstarter.drivers.*", "vendorpackage.*"]
71+
endpoint: "jumpstarter.my-lab.com:1443"
72+
token: "dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz"
73+
drivers:
74+
# Wildcards are supported
75+
allow: ["jumpstarter.drivers.*", "vendorpackage.*"]
7776
```
7877

7978
- `endpoint` - The gRPC endpoint of the Jumpstarter controller server.

0 commit comments

Comments
 (0)