Skip to content

Commit 8140b9a

Browse files
committed
Edit notes on rotating signing key for IAM
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent 7fe5368 commit 8140b9a

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/openfaas-pro/iam/overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -237,9 +237,9 @@ Update the OpenFaaS chart and add a reference to the Kubernetes secret with the
237237
caBundleSecretName: ca-bundle
238238
```
239239

240-
## Rotate the IAM issuer key
240+
## Rotate the signing key
241241

242-
The OpenFaaS IAM issuer has a single key that is used to sign JWT access tokens. It is recommended to regularly rotate this key. To rotate the signing key simply generate a new key and update the `issuer-key` secret in the `openfaas` namespace.
242+
The OpenFaaS IAM issuer uses a key to sign OpenFaaS API and Function Invocation JWTs. It is a best practice to rotate signing keys periodically. To rotate the signing key, generate a new key and update the `issuer-key` secret in the `openfaas` namespace.
243243

244244
```bash
245245
# Generate a key
@@ -254,16 +254,16 @@ kubectl -n openfaas \
254254
--from-file=issuer.key=./issuer.key
255255
```
256256

257-
Restart the OpenFaaS gataway and OIDC plugin:
257+
Restart the OpenFaaS gateway and OIDC plugin:
258258

259259
```bash
260260
kubectl rollout restart deploy/oidc-plugin -n openfaas
261261
kubectl rollout restart deploy/gateway -n openfaas
262262
```
263263

264-
!!! warning
264+
!!! note
265265

266-
All existing OpenFaaS API and function access tokens will immediately become invalid after rotating the signing key.
266+
When the signing key is rotated, any OpenFaaS API and Function Invocation JWTs issued with the previous key will be invalidated. Users of the Dashboard and CLI should log out, and re-authenticate.
267267

268268
## FAQ
269269

0 commit comments

Comments
 (0)