open-consul/api
Dhia Ayachi d4a04457e1
update gateway-services table with endpoints (#13217)
* update gateway-services table with endpoints

* fix failing test

* remove unneeded config in test

* rename "endpoint" to "destination"

* more endpoint renaming to destination in tests

* update isDestination based on service-defaults config entry creation

* use a 3 state kind to be able to set the kind to unknown (when neither a service or a destination exist)

* set unknown state to empty to avoid modifying alot of tests

* fix logic to set the kind correctly on CRUD

* fix failing tests

* add missing tests and fix service delete

* fix failing test

* Apply suggestions from code review

Co-authored-by: Dan Stough <dan.stough@hashicorp.com>

* fix a bug with kind and add relevant test

* fix compile error

* fix failing tests

* add kind to clone

* fix failing tests

* fix failing tests in catalog endpoint

* fix service dump test

* Apply suggestions from code review

Co-authored-by: Dan Stough <dan.stough@hashicorp.com>

* remove duplicate tests

* rename consts and fix kind when no destination is defined in the service-defaults.

* rename Kind to ServiceKind and change switch to use .(type)

Co-authored-by: Dan Stough <dan.stough@hashicorp.com>
2022-05-31 16:20:12 -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 ci: Use golangci-lint for linting 2020-03-17 13:43:40 -04:00
README.md Copy-and-paste Go client example (#4448) 2018-07-30 12:48:19 +01:00
acl.go Fix namespace default field names in expanded token output 2022-04-13 16:46:39 -07:00
acl_test.go syncing changes back from enterprise (#12701) 2022-04-05 15:46:56 -05:00
agent.go peering: Make Upstream peer-aware (#12900) 2022-04-29 18:12:51 -04:00
agent_test.go peering: initial sync (#12842) 2022-04-21 17:34:40 -05:00
api.go Add support for merge-central-config query param (#13001) 2022-05-25 13:20:17 -07:00
api_test.go api: add the ability to specify a path prefix (#12914) 2022-05-19 16:07:59 -07:00
catalog.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05:00
catalog_test.go bulk rewrite using this script 2022-01-20 10:46:23 -06:00
config_entry.go update gateway-services table with endpoints (#13217) 2022-05-31 16:20:12 -04:00
config_entry_discoverychain.go Update api module and decoding tests 2021-12-06 12:32:29 -07:00
config_entry_discoverychain_test.go fix test failures 2021-12-06 14:45:44 -06:00
config_entry_exports.go structs: ensure exported-services PeerName field can be addressed as peer_name (#12862) 2022-04-27 10:27:21 -05:00
config_entry_exports_test.go add general runstep test helper instead of copying it all over the place (#13013) 2022-05-10 15:25:51 -05:00
config_entry_gateways.go ingress: allow setting TLS min version and cipher suites in ingress gateway config entries (#11576) 2022-01-11 11:46:42 -05:00
config_entry_gateways_test.go ingress: allow setting TLS min version and cipher suites in ingress gateway config entries (#11576) 2022-01-11 11:46:42 -05:00
config_entry_intentions.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -04:00
config_entry_intentions_test.go connect: intentions are now managed as a new config entry kind "service-intentions" (#8834) 2020-10-06 13:24:05 -05:00
config_entry_mesh.go Fixup missed config entry 2022-05-04 08:50:59 -07:00
config_entry_test.go update gateway-services table with endpoints (#13217) 2022-05-31 16:20:12 -04:00
connect.go api: fix up some comments and rename IssuedCert to LeafCert 2018-06-14 09:41:56 -07:00
connect_ca.go add root_cert_ttl option for consul connect, vault ca providers (#11428) 2021-11-02 11:02:10 -07:00
connect_ca_test.go bulk rewrite using this script 2022-01-20 10:46:23 -06:00
connect_intention.go api: ensure new partition fields are omit empty for back compat (#11585) 2021-11-16 12:28:34 -06:00
connect_intention_test.go Support partitions in connect expose cmd 2021-11-12 14:45:32 -07:00
coordinate.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -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 Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
debug_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
discovery_chain.go xds: ensure that all connect timeout configs can apply equally to tproxy direct dial connections (#12711) 2022-04-07 16:58:21 -05:00
discovery_chain_test.go xds: ensure that all connect timeout configs can apply equally to tproxy direct dial connections (#12711) 2022-04-07 16:58:21 -05:00
event.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
event_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
go.mod Update go version to 1.18.1 2022-04-18 11:41:10 -04:00
go.sum Update go version to 1.18.1 2022-04-18 11:41:10 -04:00
health.go Add GRPC and GRPCUseTLS to api.HealthCheckDefinition (#12108) 2022-01-19 16:09:15 -05:00
health_test.go oss: Rename default partition 2021-08-12 14:31:37 -07:00
kv.go KV refactoring, part 2 (#11512) 2021-11-08 11:43:21 -05:00
kv_test.go ci: Enabled SA2002 staticcheck check 2020-06-05 17:50:11 -04:00
lock.go Make LockDelay configurable in api locks (#8621) 2020-09-04 13:38:26 -06:00
lock_test.go ci: Enabled SA2002 staticcheck check 2020-06-05 17:50:11 -04:00
mock_api_test.go AutopilotServerHealth now handles the 429 status code (#8599) 2021-03-12 09:40:49 -05:00
namespace.go remove gogo from acl protobufs 2022-03-28 16:20:56 -04:00
namespace_test.go re-run gofmt on 1.17 (#11579) 2021-11-16 12:04:01 -06:00
operator.go Moves operator sub-functions into their own files. 2017-03-30 12:35:50 -07:00
operator_area.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
operator_autopilot.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
operator_autopilot_test.go add StatusError to api package (#11054) 2021-09-20 14:04:13 -07:00
operator_keyring.go partitions: various refactors to support partitioning the serf LAN pool (#11568) 2021-11-15 09:51:14 -06:00
operator_keyring_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
operator_license.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
operator_raft.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
operator_raft_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
operator_segment.go Change segment list endpoint in docs/client api 2017-09-01 12:40:07 -07:00
oss_test.go re-run gofmt on 1.17 (#11579) 2021-11-16 12:04:01 -06:00
partition.go Clarify feature name in partition docstring 2021-12-03 17:05:17 -07:00
peering.go api: ensure peering API endpoints do not use protobufs (#13204) 2022-05-25 13:43:35 -05:00
peering_test.go api: ensure peering API endpoints do not use protobufs (#13204) 2022-05-25 13:43:35 -05:00
prepared_query.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
prepared_query_test.go [OSS] Remove remaining references to master (#11827) 2022-01-20 12:47:50 +00:00
raw.go api: Refactoring into shared write logic 2015-02-18 15:15:02 -08:00
semaphore.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
semaphore_test.go ci: enable SA4006 staticcheck check 2020-06-16 13:10:11 -04:00
session.go api: properly close the response body 2021-06-14 18:52:59 -04:00
session_test.go ci: enable SA4006 staticcheck check 2020-06-16 13:10:11 -04:00
snapshot.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
snapshot_test.go add serf check to TestAPI_Snapshot 2019-02-22 17:34:45 -05:00
status.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
status_test.go bulk rewrite using this script 2022-01-20 10:46:23 -06:00
txn.go replumbing a bunch of api and agent structs for partitions (#10681) 2021-07-22 14:33:22 -05:00
txn_test.go KV refactoring, part 2 (#11512) 2021-11-08 11:43:21 -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