consul/api
Jeff Mitchell 11a3ce0bdd RPC and HTTP interfaces fully generically-sockified so Unix is supported.
Client works for RPC; will honor CONSUL_RPC_ADDR. HTTP works via consul/api;
honors CONSUL_HTTP_ADDR.

The format of a Unix socket in configuration data is:
"unix://[/path/to/socket];[username or uid];[gid];[mode]"

Obviously, the user must have appropriate permissions to create the socket
file in the given path and assign the requested uid/gid. Also note that Go does
not support gid lookups from group name, so gid must be numeric. See
https://codereview.appspot.com/101310044

When connecting from the client, the format is just the first part of the
above line:
"unix://[/path/to/socket]"

This code is copyright 2014 Akamai Technologies, Inc. <opensource@akamai.com>
2015-01-14 19:31:21 +00:00
..
README.md api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
acl.go api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
acl_test.go api: add harnessing for tests 2015-01-06 15:52:06 -08:00
agent.go api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
agent_test.go api: add harnessing for tests 2015-01-06 15:52:06 -08:00
api.go RPC and HTTP interfaces fully generically-sockified so Unix is supported. 2015-01-14 19:31:21 +00:00
api_test.go api: Enable debug output from Consul for tests 2015-01-13 11:50:09 -08:00
catalog.go api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
catalog_test.go api: improve reliability of catalog endpoint tests 2015-01-07 18:29:42 -08:00
event.go api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
event_test.go api: add harnessing for tests 2015-01-06 15:52:06 -08:00
health.go api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
health_test.go api: make node health test more reliable 2015-01-13 11:25:32 -08:00
kv.go api: Add support for DeleteCAS 2015-01-13 13:57:48 -08:00
kv_test.go api: Add support for DeleteCAS 2015-01-13 13:57:48 -08:00
lock.go api: Adding Destroy to cleanup a lock 2015-01-13 14:01:50 -08:00
lock_test.go api: Adding Destroy to cleanup a lock 2015-01-13 14:01:50 -08:00
semaphore.go api: Adding Destroy to cleanup a semaphore 2015-01-13 14:18:28 -08:00
semaphore_test.go api: Adding Destroy to cleanup a semaphore 2015-01-13 14:18:28 -08:00
session.go api: Adding constants for session behaviors 2015-01-07 14:01:27 -08:00
session_test.go api: add harnessing for tests 2015-01-06 15:52:06 -08:00
status.go api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
status_test.go api: add harnessing for tests 2015-01-06 15:52:06 -08:00

README.md

Consul API client

This package provides the api package which attempts to provide programmatic access to the full Consul API.

Currently, all of the Consul APIs included in version 0.3 are supported.

Documentation

The full documentation is available on Godoc

Usage

Below is an example of using the Consul client:

// Get a new client, with KV endpoints
client, _ := api.NewClient(api.DefaultConfig())
kv := client.KV()

// PUT a new KV pair
p := &api.KVPair{Key: "foo", Value: []byte("test")}
_, err := kv.Put(p, nil)
if err != nil {
    panic(err)
}

// Lookup the pair
pair, _, err := kv.Get("foo", nil)
if err != nil {
    panic(err)
}
fmt.Printf("KV: %v", pair)