consul/api
Freddy 02f8ed4ca2
Backport of Allow HCP metrics collection for Envoy proxies into release/1.15.x (#16611)
Co-authored-by: Ashvitha Sridharan <ashvitha.sridharan@hashicorp.com>
Co-authored-by: Freddy <freddygv@users.noreply.github.com>
Co-authored-by: Ashvitha <ashvitha297@gmail.com>
2023-03-10 21:50:30 +00:00
..
watch
.golangci.yml
README.md
acl.go Update token language to distinguish Accessor and Secret ID usage (#16044) 2023-02-07 12:26:30 -06:00
acl_test.go Synthesize anonymous token pre-bootstrap when needed (#16200) 2023-02-09 20:34:02 +00:00
agent.go Add some fixes to allow for registering via consul connect envoy -gateway api (#16219) 2023-02-09 20:28:04 +00:00
agent_test.go Remove legacy acl policies (#15922) 2023-02-06 15:35:52 +00:00
api.go Add the `operator usage instances` command and api endpoint (#16205) 2023-02-08 12:07:21 -08:00
api_test.go Synthesize anonymous token pre-bootstrap when needed (#16200) 2023-02-09 20:34:02 +00:00
catalog.go
catalog_test.go
config_entry.go Revert "feat: envoy extension - http local rate limit (#16196)" (#16373) 2023-02-22 14:59:53 -05:00
config_entry_discoverychain.go Backport of Add ServiceResolver RequestTimeout for route timeouts to make TerminatingGateway upstream timeouts configurable into release/1.15.x (#16520) 2023-03-03 11:13:25 -05:00
config_entry_discoverychain_test.go
config_entry_exports.go
config_entry_exports_test.go
config_entry_gateways.go Backport of [API Gateway] Validate listener name is not empty into release/1.15.x (#16341) 2023-02-21 19:34:04 +00:00
config_entry_gateways_test.go
config_entry_inline_certificate.go Backport of Fix infinite recursion in inline-certificate config entry into release/1.15.x (#16281) 2023-02-15 20:03:29 +00:00
config_entry_inline_certificate_test.go Backport of Add stricter validation and some normalization code for API Gateway ConfigEntries into release/1.15.x (#16317) 2023-02-17 21:03:30 +00:00
config_entry_intentions.go
config_entry_intentions_test.go
config_entry_mesh.go
config_entry_routes.go Backport of [API Gateway] Various fixes for Config Entry fields into release/1.15.x (#16354) 2023-02-21 23:36:25 -05:00
config_entry_status.go Add additional controller implementations (#16188) 2023-02-08 14:50:17 -05:00
config_entry_test.go
connect.go Backport of Allow HCP metrics collection for Envoy proxies into release/1.15.x (#16611) 2023-03-10 21:50:30 +00:00
connect_ca.go
connect_ca_test.go
connect_intention.go
connect_intention_test.go
coordinate.go
coordinate_test.go
debug.go
debug_test.go
discovery_chain.go
discovery_chain_test.go
event.go
event_test.go
go.mod Bump consul/sdk to v0.13.1 2023-03-07 11:45:36 -06:00
go.sum Bump consul/sdk to v0.13.1 2023-03-07 11:45:36 -06:00
health.go
health_test.go
kv.go
kv_test.go
lock.go
lock_test.go
mock_api_test.go
namespace.go
namespace_test.go
operator.go
operator_area.go
operator_autopilot.go
operator_autopilot_test.go
operator_keyring.go
operator_keyring_test.go
operator_license.go backport of commit ed697687c4 (#16402) 2023-02-23 19:39:12 +00:00
operator_raft.go
operator_raft_test.go
operator_segment.go
operator_usage.go Add the `operator usage instances` command and api endpoint (#16205) 2023-02-08 12:07:21 -08:00
operator_usage_test.go Add the `operator usage instances` command and api endpoint (#16205) 2023-02-08 12:07:21 -08:00
oss_test.go
partition.go
peering.go
peering_test.go
prepared_query.go Remove empty tags 2 (#16113) 2023-02-06 11:12:43 -08:00
prepared_query_test.go Remove empty tags 2 (#16113) 2023-02-06 11:12:43 -08:00
raw.go
semaphore.go
semaphore_test.go
session.go
session_test.go
snapshot.go
snapshot_test.go
status.go
status_test.go
txn.go
txn_test.go

README.md

Consul API Client

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

The full documentation is available on Godoc.

Usage

Below is an example of using the Consul client. To run the example, you must first install Consul and Go.

To run the client API, create a new Go module.

go mod init consul-demo

Copy the example code into a file called main.go in the directory where the module is defined. As seen in the example, the Consul API is often imported with the alias capi.

package main

import (
	"fmt"

	capi "github.com/hashicorp/consul/api"
)

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

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

	// PUT a new KV pair
	p := &capi.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)
}

Install the Consul API dependency with go mod tidy.

In a separate terminal window, start a local Consul server.

consul agent -dev -node machine

Run the example.

go run .

You should get the following result printed to the terminal.

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