Skip to content

Commit 57a6e28

Browse files
committed
docs: fix auth validation text and platform-specific verify commands
Correct grammar in authentication validation rule messages and split service verification commands so Kubernetes and OpenShift/OKD use supported resource types. Made-with: Cursor
1 parent c28d7fe commit 57a6e28

2 files changed

Lines changed: 13 additions & 6 deletions

File tree

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

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ $ kubectl -n dex create secret tls dex-tls \
111111
--key=pki/private/dex.dex.svc.cluster.local.key
112112
```
113113

114-
2. Install Dex using your preferred deployment method with the following equivalent configuration:
114+
2. Install Dex with Helm using the following `values.yaml`:
115115

116116
```yaml
117117
https:
@@ -165,9 +165,15 @@ $ kubectl create clusterrolebinding oidc-reviewer \
165165
--group=system:unauthenticated
166166
```
167167

168-
Then deploy Dex in the `dex` namespace with this configuration applied.
168+
Then install Dex:
169169

170-
3. Configure Jumpstarter to trust Dex by setting `spec.authentication.jwt`:
170+
```console
171+
$ helm repo add dex https://charts.dexidp.io
172+
$ helm install --namespace dex --wait -f values.yaml dex dex/dex
173+
```
174+
175+
3. Configure Jumpstarter to trust Dex. Use this configuration for
176+
`jumpstarter-controller.authenticationConfiguration` during installation:
171177

172178
```yaml
173179
spec:
@@ -289,7 +295,7 @@ spec:
289295
# validation rules applied to the final user object.
290296
userValidationRules:
291297
- expression: "!user.username.startsWith('system:')"
292-
message: 'username cannot used reserved system: prefix'
298+
message: 'username cannot use reserved system: prefix'
293299
- expression: "user.groups.all(group, !group.startsWith('system:'))"
294-
message: 'groups cannot used reserved system: prefix'
300+
message: 'groups cannot use reserved system: prefix'
295301
```

python/docs/source/getting-started/installation/service/service-operator.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,8 @@ Check CR status and workloads:
192192

193193
```{code-block} console
194194
$ kubectl get jumpstarter -n jumpstarter-lab
195-
$ kubectl get deploy,svc,ingress,route -n jumpstarter-lab
195+
$ kubectl get deploy,svc,ingress -n jumpstarter-lab # Kubernetes
196+
$ kubectl get deploy,svc,route -n jumpstarter-lab # OpenShift/OKD
196197
```
197198

198199
```{note}

0 commit comments

Comments
 (0)