Configuration Examples
The following examples provide some typical configurations for enabling
the openid-connect
plugin on a
service.
Make the following request:
curl -X POST http://localhost:8001/services/SERVICE_NAME|SERVICE_ID/plugins \
--data "name=openid-connect" \
--data "config.auth_methods=authorization_code" \
--data "config.auth_methods=session" \
--data "config.issuer=http://example.org" \
--data "config.client_id=<client-id>" \
--data "config.client_secret=<client-secret>" \
--data "config.session_secret=<session-secret>" \
--data "config.response_mode=form_post"
Replace SERVICE_NAME|SERVICE_ID
with the id
or name
of the service that this plugin configuration will target.
First, create a KongPlugin resource:
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: openid-connect-example
plugin: openid-connect
config:
auth_methods:
- authorization_code
- session
issuer: http://example.org
client_id:
- "<client-id>"
client_secret:
- "<client-secret>"
session_secret: "<session-secret>"
response_mode: form_post
" | kubectl apply -f -
Next, apply the KongPlugin
resource to an ingress by annotating the service
as follows:
kubectl annotate service SERVICE_NAME konghq.com/plugins=openid-connect-example
Replace SERVICE_NAME
with the name of the service that this plugin configuration will target.
You can see your available ingresses by running kubectl get service
.
Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as aKongClusterPlugin
instead ofKongPlugin
.
Add this section to your declarative configuration file:
plugins:
- name: openid-connect
service: SERVICE_NAME|SERVICE_ID
config:
auth_methods:
- authorization_code
- session
issuer: http://example.org
client_id:
- "<client-id>"
client_secret:
- "<client-secret>"
session_secret: "<session-secret>"
response_mode: form_post
Replace SERVICE_NAME|SERVICE_ID
with the id
or name
of the service that this plugin configuration will target.
The following examples provide some typical configurations for enabling
the openid-connect
plugin on a
route.
Make the following request:
curl -X POST http://localhost:8001/routes/ROUTE_NAME|ROUTE_ID/plugins \
--data "name=openid-connect" \
--data "config.auth_methods=authorization_code" \
--data "config.auth_methods=session" \
--data "config.issuer=http://example.org" \
--data "config.client_id=<client-id>" \
--data "config.client_secret=<client-secret>" \
--data "config.session_secret=<session-secret>" \
--data "config.response_mode=form_post"
Replace ROUTE_NAME|ROUTE_ID
with the id
or name
of the route that this plugin configuration will target.
First, create a KongPlugin resource:
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: openid-connect-example
plugin: openid-connect
config:
auth_methods:
- authorization_code
- session
issuer: http://example.org
client_id:
- "<client-id>"
client_secret:
- "<client-secret>"
session_secret: "<session-secret>"
response_mode: form_post
" | kubectl apply -f -
Next, apply the KongPlugin
resource to an ingress by annotating the ingress
as follows:
kubectl annotate ingress INGRESS_NAME konghq.com/plugins=openid-connect-example
Replace INGRESS_NAME
with the name of the ingress that this plugin configuration will target.
You can see your available ingresses by running kubectl get ingress
.
Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as aKongClusterPlugin
instead ofKongPlugin
.
Add this section to your declarative configuration file:
plugins:
- name: openid-connect
route: ROUTE_NAME|ROUTE_ID
config:
auth_methods:
- authorization_code
- session
issuer: http://example.org
client_id:
- "<client-id>"
client_secret:
- "<client-secret>"
session_secret: "<session-secret>"
response_mode: form_post
Replace ROUTE_NAME|ROUTE_ID
with the id
or name
of the route that this plugin configuration
will target.
A plugin which is not associated to any service, route, or consumer is considered global, and will be run on every request. Read the Plugin Reference and the Plugin Precedence sections for more information.
The following examples provide some typical configurations for enabling
the OpenID Connect
plugin globally.
Make the following request:
curl -X POST http://localhost:8001/plugins/ \
--data "name=openid-connect" \
--data "config.auth_methods=authorization_code" \
--data "config.auth_methods=session" \
--data "config.issuer=http://example.org" \
--data "config.client_id=<client-id>" \
--data "config.client_secret=<client-secret>" \
--data "config.session_secret=<session-secret>" \
--data "config.response_mode=form_post"
Create a KongClusterPlugin resource and label it as global:
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: <global-openid-connect>
annotations:
kubernetes.io/ingress.class: kong
labels:
global: "true"
config:
auth_methods:
- authorization_code
- session
issuer: http://example.org
client_id:
- "<client-id>"
client_secret:
- "<client-secret>"
session_secret: "<session-secret>"
response_mode: form_post
plugin: openid-connect
Add a plugins
entry in the declarative
configuration file:
plugins:
- name: openid-connect
config:
auth_methods:
- authorization_code
- session
issuer: http://example.org
client_id:
- "<client-id>"
client_secret:
- "<client-secret>"
session_secret: "<session-secret>"
response_mode: form_post