Sedky Haider sedkis

title

Deploying Custom Plugins: Volume Mounts vs Bundles

description

Understand the trade-offs between volume-mounted files and plugin bundles when supplying custom middleware to Tyk Gateway.

Why plugin location matters

Tyk Gateway only runs a custom plugin if the file (JavaScript, Python, gRPC stub, Go .so, etc.) is reachable at the path declared in custom_middleware or middleware.global within your API definition. You therefore need a repeatable way to make that file available inside every Gateway instance—either by shipping it with the container filesystem or by letting the Gateway download it at runtime. This page compares the two supported patterns so you can choose the right fit for your environments.

Summary

A custom Docker image has been prepared that extends the official Tyk Gateway v5.3.0, and packages a compiled .so binary

The tag is sedkis/tyk-gateway-jwt-custom-auth:v5.3.0-0.1

https://hub.docker.com/repository/docker/sedkis/tyk-gateway-jwt-custom-auth/general

The custom auth plugin can be seen and compiled here

compile plugin
load into gateway
use the below YAML:

apiVersion: tyk.tyk.io/v1alpha1

	{
	"name": "Go Plugin Hello",
	"api_id": "gopl-hello",
	"org_id": "default",
	"active": true,
	"use_keyless": true,
	"definition": {
	"location": "header",
	"key": "x-api-version"
	},

	package main

	import (
	"bytes"
	"context"
	"encoding/base64"
	"io/ioutil"
	"net/http"
	"os"

	{
	"info": {
	"title": "test",
	"version": "1.0.0"
	},
	"openapi": "3.0.3",
	"servers": [
	{
	"url": "http://localhost:8080/test/"
	}

	// TerminateRequest checks for a specific query parameter and terminates the request if present.
	func TerminateRequest(rw http.ResponseWriter, r *http.Request) {
	// Check for the query parameter
	if value := r.URL.Query().Get("terminate"); value == "true" {
	// Prepare the data to send in response
	responseData := map[string]string{
	"message": "Request terminated by custom Tyk plugin.",
	}
	jsonData, err := json.Marshal(responseData)
	if err != nil {

	var auth0OAuthClientCredMiddleware = new TykJS.TykMiddleware.NewMiddleware({});

	// "Cache"
	zendeskAccessToken = {
	token: "",
	expiry: 0,
	}

	salesforceAccessToken = {
	token: "",

	<!DOCTYPE html>

	<html>
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
	<title>Spoon-Knife</title>
	<LINK href="styles.css" rel="stylesheet" type="text/css">
	</head>

	<body>

	from locust import HttpLocust, TaskSet, task

	def index(l):
	l.client.get("/")

	def stats(l):
	l.client.get("/stats/requests")

	class UserTasks(TaskSet):
	# one can specify tasks like this