Skip to content

Commit e868efd

Browse files
committed
Update the title for the OIDC plugin
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
1 parent c1b18f5 commit e868efd

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

docs/reference/authentication.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,32 +33,29 @@ You can configure the gateway to use an auth plugin with the following two envir
3333

3434
See also: [auth plugins](https://github.com/openfaas/faas/tree/master/auth)
3535

36-
### OAuth2 support in the API Gateway (commercial add-on)
36+
### OIDC and OAuth2 for the OpenFaaS API
3737

38-
The OpenFaaS API Gateway has support for OAuth2 and OpenID Connect as of version 0.14.4. This is enabled through the use of an [external authentication module](https://github.com/openfaas/faas/tree/master/auth) as documented above.
38+
You can enable authentication via OpenID Connect and OAuth2 using the OpenFaaS REST API. This functionality is part of of the [OpenFaaS Premium Subscription](https://openfaas.com/support/).
3939

40-
You need to use the [OIDC plugin](https://github.com/alexellis/openfaas-oidc-plugin-pkg) which is available in binary format for Linux and MacOS on GitHub.
40+
* [Get a 14-day free trial here](https://forms.gle/mFmwtoez1obZzm286)
4141

42-
The OIDC plugin is a commercial add-on, and you can request a trial or purchase a license from OpenFaaS Ltd via [sales@openfaas.com](mailto:sales@openfaas.com).
42+
See also: [OpenFaaS and Okta for SSO](https://www.openfaas.com/blog/openfaas-oidc-okta/)
4343

44-
* [Fill out the following form for you trial](https://forms.gle/mFmwtoez1obZzm286)
44+
#### Deploy the plugin using the helm chart
4545

46-
You will need two DNS A records and to enable `Ingress` for your Kubernetes cluster.
46+
You will need two DNS A records and to enable `Ingress` for your Kubernetes cluster. In the example below the sub-zone `oauth.example.com` is used, however you can use a top-level domain or your own sub-zone.
4747

4848
* Gateway - `http://gw.oauth.example.com`
4949
* Auth - `http://auth.oauth.example.com`
5050

51-
#### Deploy the plugin using the helm chart
52-
53-
These instructions are valid for 0.3.0 and higher of the commercial auth plugin.
54-
5551
Use `arkade` or `helm` and pass the following overrides, or edit your `values.yaml` file:
5652

5753
```sh
5854
export PROVIDER="" # Set this to "azure" if using Azure AD.
5955
export LICENSE="" # Obtain a trial from OpenFaaS Ltd, see above for instructions.
6056
export OAUTH_CLIENT_SECRET=""
6157
export OAUTH_CLIENT_ID=""
58+
export DOMAIN="oauth.example.com"
6259

6360
arkade install openfaas \
6461
--set oauth2Plugin.enabled=true \
@@ -68,11 +65,11 @@ arkade install openfaas \
6865
--set oauth2Plugin.scopes="openid profile email" \
6966
--set oauth2Plugin.jwksURL=https://example.eu.auth0.com/.well-known/jwks.json \
7067
--set oauth2Plugin.tokenURL=https://example.eu.auth0.com/oauth/token \
71-
--set oauth2Plugin.audience=https://gw.oauth.example.com \
68+
--set oauth2Plugin.audience=https://gw.$DOMAIN \
7269
--set oauth2Plugin.authorizeURL=https://example.eu.auth0.com/authorize \
73-
--set oauth2Plugin.welcomePageURL=https://gw.oauth.example.com \
74-
--set oauth2Plugin.cookieDomain=.oauth.example.com \
75-
--set oauth2Plugin.baseHost=https://auth.oauth.example.com \
70+
--set oauth2Plugin.welcomePageURL=https://gw.$DOMAIN \
71+
--set oauth2Plugin.cookieDomain=.$DOMAIN \
72+
--set oauth2Plugin.baseHost=https://auth.$DOMAIN \
7673
--set oauth2Plugin.clientSecret=$OAUTH_CLIENT_SECRET \
7774
--set oauth2Plugin.clientID=$OAUTH_CLIENT_ID
7875
```

0 commit comments

Comments
 (0)