mirror of https://github.com/hashicorp/consul
b023904298
Adds the ability to simply check whether a TCP socket accepts
connections to determine if it is healthy. This is a light-weight -
though less comprehensive than scripting - method of checking network
service health.
The check parameter `tcp` should be set to the `address:port`
combination for the service to be tested. Supports both IPv6 and IPv4,
in the case of a hostname that resolves to both, connections will be
attempted via both protocol versions, with the first successful
connection returning a successful check result.
Example check:
```json
{
"check": {
"id": "ssh",
"name": "SSH (TCP)",
"tcp": "example.com:22",
"interval": "10s"
}
}
```
|
||
|---|---|---|
| .. | ||
| README.md | ||
| acl.go | ||
| acl_test.go | ||
| agent.go | ||
| agent_test.go | ||
| api.go | ||
| api_test.go | ||
| catalog.go | ||
| catalog_test.go | ||
| event.go | ||
| event_test.go | ||
| health.go | ||
| health_test.go | ||
| kv.go | ||
| kv_test.go | ||
| lock.go | ||
| lock_test.go | ||
| raw.go | ||
| semaphore.go | ||
| semaphore_test.go | ||
| session.go | ||
| session_test.go | ||
| status.go | ||
| status_test.go | ||
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)