pdk

package module

v0.11.0 Latest Latest Go to latest Published: Mar 13, 2024 License: Apache-2.0 Imports: 14 Imported by: 31

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Kong/go-pdk

Links

Open Source Insights

README ¶

Kong Plugin Development Kit - Go edition

Docs: https://pkg.go.dev/github.com/Kong/go-pdk.

Documentation ¶

Overview ¶

Package Kong/go-pdk implements Kong's Plugin Development Kit for Go.

It directly parallels the existing kong PDK for Lua plugins.

Kong plugins written in Go implement event handlers as methods on the Plugin's structure, with the given signature:

func (conf *MyConfig) Access (kong *pdk.PDK) {
	...
}

The `kong` argument of type `*pdk.PDK` is the entrypoint for all PDK functions. For example, to get the client's IP address, you'd use `kong.Client.GetIp()`.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type PDK ¶

type PDK struct {
	Client          client.Client
	Ctx             ctx.Ctx
	Log             log.Log
	Nginx           nginx.Nginx
	Request         request.Request
	Response        response.Response
	Router          router.Router
	IP              ip.Ip
	Node            node.Node
	Service         service.Service
	ServiceRequest  service_request.Request
	ServiceResponse service_response.Response
}

PDK go pdk module

func Init ¶

func Init(conn net.Conn) *PDK

Init initialize go pdk. Called by the pluginserver at initialization.

Source Files ¶

View all Source files

pdk.go

Directories ¶

Path	Synopsis
bridge Used internally for the RPC protocol.	Used internally for the RPC protocol.
bridgetest
client Client information module.	Client information module.
ctx Current request context data.	Current request context data.
entities Some struct definitons for Kong entities.	Some struct definitons for Kong entities.
ip Trusted IPs module.	Trusted IPs module.
log Write to log file.	Write to log file.
nginx Access Nginx APIs.	Access Nginx APIs.
node Node-level utilities	Node-level utilities
request Client request module.	Client request module.
response Client response module.	Client response module.
router Router module.	Router module.
server
kong_plugin_protocol
service Service module.	Service module.
request Manipulation of the request to the Service.	Manipulation of the request to the Service.
response Manipulation of the response from the Service.	Manipulation of the response from the Service.
test Utilities to test plugins.	Utilities to test plugins.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL