open-consul/api
Dhia Ayachi 96d7842118
partition dicovery chains (#10983)
* partition dicovery chains

* fix default partition for OSS
2021-09-07 16:29:32 -04:00
..
watch tests: skip cases that depend on test server when -short flag set (#10576) 2021-07-09 16:42:30 -07:00
.golangci.yml
README.md
acl.go Merge pull request #10612 from bigmikes/acl-replication-fix 2021-08-06 18:29:51 -04:00
acl_test.go api: remove client library tests for old API endpoints 2021-08-17 13:09:30 -04:00
agent.go oss portion of ent #1069 (#10883) 2021-08-20 12:57:45 -04:00
agent_test.go agent: ensure that most agent behavior correctly respects partition configuration (#10880) 2021-08-19 15:09:42 -05:00
api.go sync changes to oss files made in enterprise (#10670) 2021-07-22 13:58:08 -05:00
api_test.go sync changes to oss files made in enterprise (#10670) 2021-07-22 13:58:08 -05:00
catalog.go replumbing a bunch of api and agent structs for partitions (#10681) 2021-07-22 14:33:22 -05:00
catalog_test.go state: partition nodes and coordinates in the state store (#10859) 2021-08-17 13:29:39 -05:00
config_entry.go api: properly close the response body 2021-06-14 18:52:59 -04:00
config_entry_cluster.go
config_entry_discoverychain.go
config_entry_discoverychain_test.go
config_entry_gateways.go
config_entry_gateways_test.go
config_entry_intentions.go
config_entry_intentions_test.go
config_entry_test.go
connect.go
connect_ca.go ca: remove unused RotationPeriod field 2021-07-05 19:15:44 -04:00
connect_ca_test.go ca: remove unused RotationPeriod field 2021-07-05 19:15:44 -04:00
connect_intention.go api: properly close the response body 2021-06-14 18:52:59 -04:00
connect_intention_test.go
coordinate.go replumbing a bunch of api and agent structs for partitions (#10681) 2021-07-22 14:33:22 -05:00
coordinate_test.go agent: ensure that most agent behavior correctly respects partition configuration (#10880) 2021-08-19 15:09:42 -05:00
debug.go debug: restore cancel on SigInt 2021-08-18 12:29:34 -04:00
debug_test.go
discovery_chain.go api: properly close the response body 2021-06-14 18:52:59 -04:00
discovery_chain_test.go partition dicovery chains (#10983) 2021-09-07 16:29:32 -04:00
event.go api: properly close the response body 2021-06-14 18:52:59 -04:00
event_test.go
go.mod
go.sum
health.go http: add partition query param parsing 2021-07-14 12:07:38 -07:00
health_test.go oss: Rename default partition 2021-08-12 14:31:37 -07:00
kv.go api: properly close the response body 2021-06-14 18:52:59 -04:00
kv_test.go
lock.go
lock_test.go
mock_api_test.go
namespace.go api: properly close the response body 2021-06-14 18:52:59 -04:00
namespace_test.go
operator.go
operator_area.go api: properly close the response body 2021-06-14 18:52:59 -04:00
operator_autopilot.go Fix defaults for autopilot config update 2021-07-06 18:39:40 -04:00
operator_autopilot_test.go
operator_keyring.go api: properly close the response body 2021-06-14 18:52:59 -04:00
operator_keyring_test.go
operator_license.go Revert early out errors in license API (#10952) 2021-08-31 10:36:35 -06:00
operator_raft.go api: properly close the response body 2021-06-14 18:52:59 -04:00
operator_raft_test.go
operator_segment.go
oss_test.go oss: Rename default partition 2021-08-12 14:31:37 -07:00
partition.go Sync partitions support in api module (#10938) 2021-08-26 18:40:34 -06:00
prepared_query.go api: properly close the response body 2021-06-14 18:52:59 -04:00
prepared_query_test.go
raw.go
semaphore.go
semaphore_test.go
session.go api: properly close the response body 2021-06-14 18:52:59 -04:00
session_test.go
snapshot.go
snapshot_test.go
status.go api: properly close the response body 2021-06-14 18:52:59 -04:00
status_test.go
txn.go replumbing a bunch of api and agent structs for partitions (#10681) 2021-07-22 14:33:22 -05:00
txn_test.go state: partition nodes and coordinates in the state store (#10859) 2021-08-17 13:29:39 -05: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.6.0 are supported.

Documentation

The full documentation is available on Godoc

Usage

Below is an example of using the Consul client:

package main

import "github.com/hashicorp/consul/api"
import "fmt"

func main() {
	// Get a new client
	client, err := api.NewClient(api.DefaultConfig())
	if err != nil {
		panic(err)
	}

	// Get a handle to the KV API
	kv := client.KV()

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

	// Lookup the pair
	pair, _, err := kv.Get("REDIS_MAXCLIENTS", nil)
	if err != nil {
		panic(err)
	}
	fmt.Printf("KV: %v %s\n", pair.Key, pair.Value)
}

To run this example, start a Consul server:

consul agent -dev

Copy the code above into a file such as main.go.

Install and run. You'll see a key (REDIS_MAXCLIENTS) and value (1000) printed.

$ go get
$ go run main.go
KV: REDIS_MAXCLIENTS 1000

After running the code, you can also view the values in the Consul UI on your local machine at http://localhost:8500/ui/dc1/kv