Skip to content
Micro-service framework in Go
Go Python Makefile Other
Latest commit 9c09e38 May 20, 2016 @cihangir cihangir Merge pull request #155 from rjeczalik/kontrol
TMS-3007 kontrol: gracefully handle key updates
Failed to load latest commit information.
config config: add KITE_TRANSPORT env config Feb 2, 2015
dnode dnode/partial: checking is done in Unmarshall() already Jul 12, 2014
examples examples: use struct arguments instead of float64 Oct 27, 2015
kitectl kitectl/command: removed test for func deleted in 3fa3c58 Oct 2, 2015
kitekey kite: fix jwt which broke API compability with 2.x version Oct 20, 2014
kontrol onceevery: rework OnceEvery May 19, 2016
postgres.d make: add postgres target May 13, 2016
protocol kite: more verbose errors May 10, 2016
reverseproxy reverseproxy: fix reverseproxy code Jun 11, 2015
sockjsclient klient: force close session on 404 send error May 19, 2016
systeminfo systeminfo: add basic disk/memory collection openbsd Jul 20, 2015
test test: increase timeout and set GOMAXPROCS for go1.4 May 19, 2016
testkeys kontrol/test: move helpers to separate file / add test key May 19, 2016
testutil test: get rid of race on global logger May 19, 2016
tunnelproxy tunnelproxy: fix tests Jun 11, 2015
utils utils: new helper package for registiration purposes Jun 19, 2014
.gitignore make: add .env file May 19, 2016
.travis.yml test: increase timeout and set GOMAXPROCS for go1.4 May 18, 2016
LICENSE Update LICENSE Jan 7, 2016
Makefile travis: run all tests in one command May 19, 2016
README.md Merge pull request #94 from techjanitor/master Apr 29, 2015
client.go kite: fix race on c.send May 19, 2016
errors.go kite/errors: better error string Jun 2, 2014
handlers.go kontrol/test: wait for kites after restarting kontrol May 19, 2016
heartbeat.go Kite: fix typo Sep 27, 2015
kite.go kite: ensure all sessions are terminated after kontrol is closed May 19, 2016
kite_test.go kite: more test fixes May 19, 2016
kontrolclient.go sockjs/xhr: abort session on second o frame May 19, 2016
logger.go kite/logger: fix set level Oct 21, 2014
method.go method: improve throttle Feb 27, 2015
method_test.go test: get rid of race on global logger May 18, 2016
registerurl.go kite: add new RegisterURL() method for easy register URLs Jun 23, 2014
request.go kontrol: fix DeleteKeyPair May 19, 2016
server.go kite: ensure all sessions are terminated after kontrol is closed May 18, 2016
tokenrenewer.go tokenrenewer: add 2 defensive checks Mar 27, 2016

README.md

Kite Micro-Service Framework

Kite is a framework for developing micro-services in Go.

GoDoc Build Status

Kite

Kite is both the name of the framework and the micro-service that is written by using this framework. Basically, Kite is a RPC server as well as a client. It connects to other kites and peers to communicate with each other. They can discover other kites using a service called Kontrol, and communicate with them bidirectionaly. The communication protocol uses a WebSocket (or XHR) as transport in order to allow web applications to connect directly to kites.

Kites can talk with each other by sending dnode messages over a socket session. If the client knows the URL of the server kite it can connect to it directly. If the URL is not known, client can ask for it from Kontrol (Service Discovery).

For more info checkout the blog post at GopherAcademy which explains Kite in more detail: http://blog.gopheracademy.com/birthday-bash-2014/kite-microservice-library/

Install and Usage

Install the package with:

go get github.com/koding/kite

Import it with:

import "github.com/koding/kite"

and use kite as the package name inside the code.

What is Kontrol?

Kontrol is the service registry and authentication service used by Kites. It is itself a kite too.

When a kite starts to run, it can registers itself to Kontrol with the Register() method if wished. That enables others to find it by querying Kontrol. There is also a Proxy Kite for giving public URLs to registered kites.

Query has 7 fields:

/<username>/<environment>/<name>/<version>/<region>/<hostname>/<id>
  • You must at least give the username.
  • The order of the fields is from general to specific.
  • Query cannot contains empty parts between fields.

Installing Kontrol

Install Kontrol:

go get github.com/koding/kite/kontrol/kontrol

Generate keys for the Kite key:

openssl genrsa -out key.pem 2048
openssl rsa -in key.pem -pubout > key_pub.pem

Set environment variables:

KONTROL_PORT=6000
KONTROL_USERNAME="kontrol"
KONTROL_STORAGE="etcd"
KONTROL_KONTROLURL="http://127.0.0.1:6000/kite"
KONTROL_PUBLICKEYFILE="certs/key_pub.pem"
KONTROL_PRIVATEKEYFILE="certs/key.pem"

Generate initial Kite key:

./bin/kontrol -initial

How can I use kites from a browser?

A browser can also be a Kite. It has it's own methods ("log" for logging a message to the console, "alert" for displaying alert to the user, etc.). A connected kite can call methods defined on the webpage.

See kite.js library for more information.

How can I write a new kite?

  • Import kite package.
  • Create a new instance with kite.New().
  • Add your method handlers with k.HandleFunc() or k.Handle().
  • Call k.Run()

Below you can find an example, a math kite which calculates the square of a received number:

package main

import "github.com/koding/kite"

func main() {
    // Create a kite
    k := kite.New("math", "1.0.0")

    // Add our handler method with the name "square"
    k.HandleFunc("square", func(r *kite.Request) (interface{}, error) {
        a := r.Args.One().MustFloat64()
        result := a * a    // calculate the square
        return result, nil // send back the result
    }).DisableAuthentication()

    // Attach to a server with port 3636 and run it
    k.Config.Port = 3636
    k.Run()
}

Now let's connect to it and send a 4 as an argument.

package main

import (
    "fmt"

    "github.com/koding/kite"
)

func main() {
    k := kite.New("exp2", "1.0.0")

    // Connect to our math kite
    mathWorker := k.NewClient("http://localhost:3636/kite")
    mathWorker.Dial()

    response, _ := mathWorker.Tell("square", 4) // call "square" method with argument 4
    fmt.Println("result:", response.MustFloat64())
}

Check out the examples folder for more examples.

Something went wrong with that request. Please try again.