glkit

README

This directory contains the code for creating simple Go-Kit glick plugins.

Note that a glick Pugin type has the same Go signature as a go-kit Endpoint type. This means that glick Plugins can be used as go-kit Endpoints (or vice-versa).

Documentation

Overview

Package glkit enables integration with gokit.io from the glick library. It can do so in two ways, either within the server, or as a client.

Within a go-kit server, the glick package can provide gokit endpoints created using glick (and therefore the glick 3-level configuration) by using the MakeEndpoint() function.

When writing a client to a go-kit server, the PluginKitJSONoverHTTP() function allows the creation of simple plugins for JSON over HTTP (the most basic form of microservice available within go-kit); while ConfigKit() allows those simple plugins to be configured via the library JSON configuration process.

Index

• func ConfigKit(lib *glick.Library) error
• func MakeEndpoint(l *glick.Library, api, action string) endpoint.Endpoint
• func PluginKitJSONoverHTTP(cmdPath string, ppo glick.ProtoPlugOut) glick.Plugin

Functions

func ConfigKit

func ConfigKit(lib *glick.Library) error

ConfigKit provides the Configurator for the GoKit class of plugin.

func MakeEndpoint

func MakeEndpoint(l *glick.Library, api, action string) endpoint.Endpoint

MakeEndpoint returns a gokit.io endpoint from a glick library, it is intended for use inside servers constructed using gokit.

func PluginKitJSONoverHTTP

func PluginKitJSONoverHTTP(cmdPath string, ppo glick.ProtoPlugOut) glick.Plugin

PluginKitJSONoverHTTP enables calls to plugin commands implemented as microservices using "gokit.io".