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

Commit b6a0960

Browse files
mangelajoNickCao
authored andcommitted
Document TLS caveats
(cherry picked from commit 5e6c2f0)
1 parent 4ec8941 commit b6a0960

2 files changed

Lines changed: 19 additions & 3 deletions

File tree

docs/source/getting-started/configuration/authentication.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,14 @@ Note, the HTTPS URL is mandatory, and you only need to include certificateAuthor
4646
prefix usernames with `keycloak:` as configured in the claim mappings:
4747

4848
```shell
49-
$ jmp admin create client test-client --oidc-username keycloak:developer-1
49+
$ jmp admin create client test-client --insecure-tls-config --oidc-username keycloak:developer-1
5050
```
5151

5252
4. Instruct users to log in with:
5353

5454
```shell
5555
$ jmp login --client <client alias> \
56+
--insecure-tls-config \
5657
--endpoint <jumpstarter controller endpoint> \
5758
--namespace <namespace> --name <client name> \
5859
--issuer https://<keycloak domain>/realms/<realm name>
@@ -62,6 +63,7 @@ For non-interactive login, add username and password:
6263

6364
```shell
6465
$ jmp login --client <client alias> [other parameters] \
66+
--insecure-tls-config \
6567
--username <username> \
6668
--password <password>
6769
```
@@ -76,6 +78,7 @@ For exporters, use similar login command but with the `--exporter` flag:
7678

7779
```shell
7880
$ jmp login --exporter <exporter alias> \
81+
--insecure-tls-config \
7982
--endpoint <jumpstarter controller endpoint> \
8083
--namespace <namespace> --name <exporter name> \
8184
--issuer https://<keycloak domain>/realms/<realm name>
@@ -188,6 +191,7 @@ jwt:
188191

189192
```shell
190193
$ jmp admin create exporter test-exporter \
194+
--insecure-tls-config \
191195
--oidc-username dex:system:serviceaccount:default:test-service-account
192196
```
193197

@@ -197,6 +201,7 @@ For clients:
197201

198202
```shell
199203
$ jmp login --client <client alias> \
204+
--insecure-tls-config \
200205
--endpoint <jumpstarter controller endpoint> \
201206
--namespace <namespace> --name <client name> \
202207
--issuer https://dex.dex.svc.cluster.local:5556 \
@@ -208,6 +213,7 @@ For exporters:
208213

209214
```shell
210215
$ jmp login --exporter <exporter alias> \
216+
--insecure-tls-config \
211217
--endpoint <jumpstarter controller endpoint> \
212218
--namespace <namespace> --name <exporter name> \
213219
--issuer https://dex.dex.svc.cluster.local:5556 \

docs/source/getting-started/usage/setup-distributed-mode.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@
33
This guide walks you through the process of creating an exporter using the
44
controller service, configuring drivers, and running the exporter.
55

6+
```{warning}
7+
The jumpstarter-controller endpoints are secured by TLS. However, in release 0.6.x,
8+
the certificates are self-signed and rotated on every restart. This means the client
9+
will not be able to verify the server certificate. To bypass this, you should use the
10+
`--insecure-tls-config` flag when creating clients and exporters. This issue will be
11+
resolved in the next release. See [issue #455](https://github.com/jumpstarter-dev/jumpstarter/issues/455)
12+
for more details.
13+
Alternatively, you can configure the ingress/route in reencrypt mode with your own key and certificate.
14+
```
15+
616
## Prerequisites
717

818
Install [the following packages](../installation/packages.md) in your Python
@@ -30,7 +40,7 @@ Run this command to create an exporter named `example-distributed` and save the
3040
configuration locally:
3141

3242
```shell
33-
$ jmp admin create exporter example-distributed --save
43+
$ jmp admin create exporter example-distributed --save --insecure-tls-config
3444
```
3545

3646
After creating the exporter, find the new configuration file at
@@ -78,7 +88,7 @@ development purposes, and saves the configuration locally in
7888
`${HOME}/.config/jumpstarter/clients/`:
7989

8090
```shell
81-
$ jmp admin create client hello --save --unsafe
91+
$ jmp admin create client hello --save --unsafe --insecure-tls-config
8292
```
8393

8494
### Spawn an Exporter Shell

0 commit comments

Comments
 (0)