Go Plugin Upgrade Guide

This guide shows you how to compile your custom Go plugins for upgrade.

The table below links you to the upgrade steps for the version of Tyk you are upgrading from and to:

Path 1 - Current Version < 4.1.0 and Target Version < 4.1.0

1. Open a terminal/command prompt in the directory of your plugin source file(s)
2. Run the following commands to initialise your plugin:

go get 
github.com/TykTechnologies/tyk@6c76e802a29838d058588ff924358706a078d0c5

# Tyk Gateway versions < 4.2 have a dependency on graphql-go-tools
go mod edit -replace github.com/jensneuse/graphql-go-tools=github.com/TykTechnologies/[email protected]

go mod tidy
go mod vendor

Path 2 - Current Version < 4.1.0 and Target Version >= 4.1.0

1. Open a terminal/command prompt in the directory of your plugin source file(s)
2. Based on your Target Version run the appropriate commands to initialize your plugin:

• Target Version <= v4.2.0

  go get github.com/TykTechnologies/tyk@6c76e802a29838d058588ff924358706a078d0c5
  # Tyk Gateway versions < 4.2 have a dependency on graphql-go-tools
  go mod edit -replace github.com/jensneuse/graphql-go-tools=github.com/TykTechnologies/[email protected]
  go mod tidy
  go mod vendor
  

• Target Version > v4.2.0 and < v5.1

  go get github.com/TykTechnologies/tyk@54e1072a6a9918e29606edf6b60def437b273d0a
  # For Gateway versions earlier than 5.1 using the go mod vendor tool is required
  go mod tidy
  go mod vendor
  

• Target Version >= v5.1.0

  go get github.com/TykTechnologies/tyk@ffa83a27d3bf793aa27e5f6e4c7106106286699d
  # In Gateway version 5.1, the Gateway and plugins transitioned to using Go modules builds and don't use Go mod vendor anymore
  go mod tidy
  

Path 3 - Current Version >= 4.1.0 and Target Version >= 5.1.0

1. Open a terminal/command prompt in the directory of your plugin source file(s)
2. Based on your Target Version run the appropriate commands to initialise your plugin:

• Target Version > v4.2.0 and < v5.1.0

  go get github.com/TykTechnologies/tyk@54e1072a6a9918e29606edf6b60def437b273d0a
  # For Gateway versions earlier than 5.1 using the go mod vendor tool is required
  go mod tidy
  go mod vendor
  

  • Target Version >= v5.1.0

  go get github.com/TykTechnologies/tyk@ffa83a27d3bf793aa27e5f6e4c7106106286699d
  # In Gateway version 5.1, the Gateway and plugins transitioned to using
  # Go modules builds and don't use Go mod vendor anymore
  go mod tidy
  

Compile the plugins

Download the plugin compiler for the target Gateway version you’re upgrading to (e.g. 5.2.5). Docker images for plugin compiler versions are available in the Tyk Docker Hub.

docker pull tykio/tyk-plugin-compiler:v5.2.5

Recompile your plugin with this version

docker run --rm -v "$(pwd)":/plugin-source \
           --platform=linux/amd64 \
           tykio/tyk-plugin-compiler:v5.2.5 plugin.so

Example:

You can remove the plugin complier images once your plugin has been successfully recompiled:

docker rmi plugin_compiler_image_name_or_id