Use an Azure Function through Kong Gateway
Create an Azure Function and deploy it to Azure, then configure the Azure Functions plugin with the Function App name, the Azure Function name, and the Function App API key.
Prerequisites
Kong Konnect
This is a Konnect tutorial and requires a Konnect personal access token.
-
Create a new personal access token by opening the Konnect PAT page and selecting Generate Token.
-
Export your token to an environment variable:
export KONNECT_TOKEN='YOUR_KONNECT_PAT'
-
Run the quickstart script to automatically provision a Control Plane and Data Plane, and configure your environment:
curl -Ls https://get.konghq.com/quickstart | bash -s -- -k $KONNECT_TOKEN --deck-output
This sets up a Konnect Control Plane named
quickstart
, provisions a local Data Plane, and prints out the following environment variable exports:export DECK_KONNECT_TOKEN=$KONNECT_TOKEN export DECK_KONNECT_CONTROL_PLANE_NAME=quickstart export KONNECT_CONTROL_PLANE_URL=https://us.api.konghq.com export KONNECT_PROXY_URL='http://localhost:8000'
Copy and paste these into your terminal to configure your session.
Kong Gateway running
This tutorial requires Kong Gateway Enterprise. If you don’t have Kong Gateway set up yet, you can use the quickstart script with an enterprise license to get an instance of Kong Gateway running almost instantly.
-
Export your license to an environment variable:
export KONG_LICENSE_DATA='LICENSE-CONTENTS-GO-HERE'
-
Run the quickstart script:
curl -Ls https://get.konghq.com/quickstart | bash -s -- -e KONG_LICENSE_DATA
Once Kong Gateway is ready, you will see the following message:
Kong Gateway Ready
decK
decK is a CLI tool for managing Kong Gateway declaratively with state files. To complete this tutorial you will first need to install decK.
Required entities
For this tutorial, you’ll need Kong Gateway entities, like Gateway Services and Routes, pre-configured. These entities are essential for Kong Gateway to function but installing them isn’t the focus of this guide. Follow these steps to pre-configure them:
-
Run the following command:
echo ' _format_version: "3.0" services: - name: example-service url: http://httpbin.konghq.com/anything routes: - name: example-route paths: - "/anything" service: name: example-service ' | deck gateway apply -
To learn more about entities, you can read our entities documentation.
Azure Function
This tutorial requires an Azure Function. In this example, we’ll use the quickstart function provided by Azure.
If you don’t have an existing Azure Function, you can create one by following the steps in Create your first function.
Once your function is created, save the following values to your environment:
- The Function App name. It’s generated automatically when deploying the quickstart function.
- The function name,
httpget
in this example. - The API key to use to access the function. You can find it in your Function App details in the Azure portal, under Functions > App keys.
export DECK_APP_NAME='YOUR FUNCTION APP NAME'
export DECK_FUNCTION_NAME=httpget
export DECK_FUNCTION_APP_KEY='YOUR FUNCTION APP API KEY'
Enable the Azure Functions plugin
To invoke your Azure Function through your Route, enable the Azure Functions plugin on the Route with the configuration parameters for your function:
echo '
_format_version: "3.0"
plugins:
- route: example-route
name: azure-functions
config:
appname: "${{ env "DECK_APP_NAME" }}"
functionname: "${{ env "DECK_FUNCTION_NAME" }}"
apikey: "${{ env "DECK_FUNCTION_APP_KEY" }}"
' | deck gateway apply -
Validate
Send a request to the Route we created to validate:
curl -i "$KONNECT_PROXY_URL/anything"
curl -i "http://localhost:8000/anything"
With the quickstart function, you should get the following response:
Hello, World.
Cleanup
Clean up Konnect environment
If you created a new control plane and want to conserve your free trial credits or avoid unnecessary charges, delete the new control plane used in this tutorial.
Destroy the Kong Gateway container
curl -Ls https://get.konghq.com/quickstart | bash -s -- -d