Hivy

Hivy is yet an other RESTful interface between http requests and jobs. But it comes with it's own, modular and simple way to do that and ease the building of such a popular and efficient web interface.

The goal is to provide a powerful framework that let you focus on your API design and the available methods your users can reach, without worrying about so-standard process between.

The project makes heavy use of etcd as a highly-available centralized configuration storage. Server and clients preferences are easily stored and accessed from a (soon...) ssl-secured etcd cluster database.

Out of the box, and because it is part of the Unide project, Hivy exposes awesome juju commands to authentified remote users. Powerful IT infrasctructure building accessible from robust but simple http requests !

Batteries inluded

• Deadly easy to use, build serious applications in minutes
• Http standard authentification
• Method permission per user
• Plug and play endpoints, authentification and permission methods
• But not only, up to 2 filters actually before endpoint processing
• Secured, higly-available and centralized configuration storage
• Mysql-ready for users logins
• Complete but low-dependency python client provided
• 21st century tests

Suit-up

First make sure etcd binary is available in your $PATH.

$ git clone https://github.com/hivetech/hivy.go
$ make
$ make tests
$ ./hivy --help

Usage

Endpoints with admin rights to create users and set default configurations are on the way !

$ ./hivy -d node -n master --verbose
$ # In another terminal
$ curl --user name:pass http://127.0.0.1:8080/dummy  # Test your installation
$ ./client/pencil login
$ ./client/pencil configure --app quantrade --config client/sample-hivy.yml
$ ./client/pencil up --app quantrade

To add a new service to your app:

• Implement in endpoints package a method with this signature: func (e *Endpoint) YourMethod(request *restful.Request, response *restful.Response)
• In your main(), create an authority with authentification and permission methods: a := NewAuthority(authMethod, permissionMethod)
• Finally, still in your main(), register your service: a.RegisterGET("/path/with/{parameter}", endpoint.YourMethod)

You can see as well where to insert custom authentification, permission or any filter method.

Current API

Here are listed currently supported methods. With the ./hivy application, all need user:pass authentification and permissions:

GET /dummy/
GET /login/{user}
GET /deploy/{project}?user={user}

Etcd configuration storage topology

Etcd storage follows filesystem convention.

http://127.0.0.1:4001/v1/keys/hivy/setting1
                                   ...
                                   settingN
                                   security/user1
                                            ...
                                            userN/password
                                                  methods/method1
                                                          ...
                                                          methodN
                             /user1
                             ...
                             /userN/project1
                                    ...
                                   /projectN/setting1
                                             ...
                                             settingN
                                             cell1
                                             ...
                                             cellN/setting1
                                                   ...
                                                   settingN