add prereqs for examples

Kong · May 3, 2024 · 241ae4d · 241ae4d
1 parent 9f91ccd
commit 241ae4d
Show file tree

Hide file tree

Showing 12 changed files with 41 additions and 16 deletions.
diff --git a/app/assets/hub/kong-inc/ai-proxy/anthropic.yaml b/app/assets/hub/kong-inc/ai-proxy/anthropic.yaml
@@ -1,7 +1,8 @@
 description: |
   This configuration enables AI Proxy with Anthropic.
-  
-  Apply this plugin to a route with `"paths[]=~/anthropic-chat$"` configured.
+
+prereqs: 
+  - A route with `paths[]=~/anthropic-chat$` configured. Apply the plugin to this route.
 
 custom_values: 
   - config.auth.header_value

diff --git a/app/assets/hub/kong-inc/ai-proxy/azure.yaml b/app/assets/hub/kong-inc/ai-proxy/azure.yaml
@@ -1,7 +1,8 @@
 description: |
   This configuration enables AI Proxy with Azure OpenAI Service.
-  
-  Apply this plugin to a route with `"paths[]=~/azure-chat$"` configured.
+
+prereqs: 
+  - A route with `paths[]=~/azure-chat$` configured. Apply the plugin to this route.
 
 custom_values: 
   - config.auth.header_value

diff --git a/app/assets/hub/kong-inc/ai-proxy/cohere.yaml b/app/assets/hub/kong-inc/ai-proxy/cohere.yaml
@@ -1,7 +1,8 @@
 description: |
   This configuration enables AI Proxy with Cohere.
-  
-  Apply this plugin to a route with `"paths[]=~/cohere-chat$"` configured.
+
+prereqs: 
+  - A route with `paths[]=~/cohere-chat$` configured. Apply the plugin to this route.
 
 custom_values: 
   - config.auth.header_value

diff --git a/app/assets/hub/kong-inc/ai-proxy/llama2.yaml b/app/assets/hub/kong-inc/ai-proxy/llama2.yaml
@@ -1,8 +1,9 @@
 description: |
   This configuration enables AI Proxy with Llama2.
 
-  You need a running Llama2 instance to use this option.
-  Apply this plugin to a route with `"paths[]=~/llama2-chat$"` configured.
+prereqs: 
+  - A running Llama2 instance.
+  - A route with `paths[]=~/llama2-chat$` configured. Apply the plugin to this route.
 
 config:
   route_type: "llm/v1/chat"

diff --git a/app/assets/hub/kong-inc/ai-proxy/mistral.yaml b/app/assets/hub/kong-inc/ai-proxy/mistral.yaml
@@ -1,8 +1,9 @@
 description: |
   This configuration enables AI Proxy with Mistral.
 
-  You need a running Mistral instance to use this option.
-  Apply this plugin to a route with `"paths[]=~/mistral-chat$"` configured.
+prereqs: 
+  - A running Mistral instance.
+  - A route with `paths[]=~/mistral-chat$` configured. Apply the plugin to this route.
 
 custom_values: 
   - config.auth.header_value

diff --git a/app/assets/hub/kong-inc/ai-proxy/openai.yaml b/app/assets/hub/kong-inc/ai-proxy/openai.yaml
@@ -1,7 +1,8 @@
 description: |
   This configuration enables AI Proxy with OpenAI.
 
-  Apply this plugin to a route with `"paths[]=~/openai-chat$"` configured.
+prereqs:
+  - A route with `paths[]=~/openai-chat$` configured. Apply the plugin to this route.
 
 custom_values: 
   - config.auth.header_value

diff --git a/app/assets/hub/kong-inc/openid-connect/auth0.yaml b/app/assets/hub/kong-inc/openid-connect/auth0.yaml
@@ -1,9 +1,10 @@
 description: |
   Authenticate headless service consumers using Auth0's identity provider.
 
-  This configuration uses the `client_credentials` grant, and requires you to have 
-  an Auth0 API configured with the `openid` scope. Find your `issuer` URL and `audience`
+prereqs:
+  - Auth0 API configured with the `openid` scope. Find your `issuer` URL and `audience`
   in your Auth0 API configuration.
+  - A Kong service with `url` configured to match your Auth0 API Identifier.
 
 custom_values: 
   - config.issuer
@@ -14,6 +15,4 @@ config:
     - client_credentials
   issuer: "https://<auth0 API name>.auth0.com/.well-known/openid-configuration"
   audience: "<auth0 API identifier>"
-
-  # Need to re-check this example, it looks incomplete. Does it actually work?
 
diff --git a/app/assets/hub/kong-inc/openid-connect/azure-ad.yaml b/app/assets/hub/kong-inc/openid-connect/azure-ad.yaml
@@ -1,6 +1,11 @@
 description: |
   Authenticate browser clients using an Azure AD identity provider.
 
+prereqs:
+  - A Kong route secured with HTTPS.
+  - In Azure AD, configure a redirect URI that is handled by your route.
+  - In Azure AD, register an app and add a client secret credential that this plugin will use to access it.
+
 custom_values: 
   - config.issuer
   - config.client_id

diff --git a/app/assets/hub/kong-inc/openid-connect/cognito.yaml b/app/assets/hub/kong-inc/openid-connect/cognito.yaml
@@ -1,7 +1,8 @@
 description: |
   Integrate Kong Gateway with Amazon Cognito.
 
-  Set up an Amazon Cognito User Pool and Application Definition before configuring the plugin.
+prereqs:
+  - Set up an Amazon Cognito User Pool and Application Definition before configuring the plugin.
 
 custom_values: 
   - config.issuer

diff --git a/app/assets/hub/kong-inc/openid-connect/curity.yaml b/app/assets/hub/kong-inc/openid-connect/curity.yaml
@@ -2,6 +2,10 @@ description: |
   Integrate Kong Gateway and the Curity Identity Server for introspection using the
   Phantom Token pattern.
 
+prereqs:
+  - Curity Identity Server installed.
+  - An introspection endpoint configured with the Token Procedure Approach.
+
 custom_values: 
   - config.issuer
   - config.client_id

diff --git a/app/assets/hub/kong-inc/openid-connect/google.yaml b/app/assets/hub/kong-inc/openid-connect/google.yaml
@@ -1,6 +1,11 @@
 description: |
   Authenticate browser clients using Google's identity provider.
 
+prereqs: 
+  - A Kong service secured with HTTPS.
+  - Set up a Google API project and create a set of OAuth client ID credentials with the Web application class. 
+  - An authorized redirect URI for the part of the API you want to protect.
+
 custom_values: 
   - config.issuer
   - config.client_id

diff --git a/app/assets/hub/kong-inc/openid-connect/okta.yaml b/app/assets/hub/kong-inc/openid-connect/okta.yaml
@@ -1,6 +1,11 @@
 description: |
   Authenticate browser clients using Okta.
 
+prereqs: 
+  - A Kong route secured with HTTPS.
+  - A registered application in Okta pointing to the Kong route.
+  - Any network access control to your Kong node must allow traffic to and from Okta, the upstream service, and the client.
+
 custom_values: 
   - config.issuer
   - config.client_id