History

Frank Schroeder c58c310419 Update github.com/hashicorp/go-discover to pull in new config parser This patch updates the go-discover library to use the new config parser which uses a different encoding scheme for the go-discover config DSL. Values are no longer URL encoded but taken literally unless they contain spaces, backslashes or double quotes. To support keys or values with these special characters the string needs to be double quoted and usual escaping rules apply. Fixes #3417		2017-10-04 19:12:28 +02:00
..
provider	Add support to discover public v4 and v6 addresses on AWS (#3471 )	2017-09-25 03:16:27 +02:00
LICENSE	vendor: add go-discover	2017-08-01 11:41:43 +02:00
README.md	Update github.com/hashicorp/go-discover to pull in new config parser	2017-10-04 19:12:28 +02:00
config.go	Update github.com/hashicorp/go-discover to pull in new config parser	2017-10-04 19:12:28 +02:00
discover.go	vendor: upgrade github.com/hashicorp/go-discover	2017-08-23 21:23:34 +02:00

README.md

Go Discover Nodes for Cloud Providers

go-discover is a Go (golang) library and command line tool to discover ip addresses of nodes in cloud environments based on meta information like tags provided by the environment.

The configuration for the providers is provided as a list of key=val key=val ... tuples. If either the key or the value contains a space ( ), a backslash (\) or double quotes (") then it needs to be quoted with double quotes. Within a quoted string you can use the backslash to escape double quotes or the backslash itself, e.g. key=val "some key"="some value"

Duplicate keys are reported as error and the provider is determined through the provider key.

Supported Providers

The following cloud providers have implementations in the go-discover/provider sub packages. Additional providers can be added through the Register function.

Amazon AWS Config options
Google Cloud Config options
Microsoft Azure Config options
SoftLayer Config options

Config Example

# Amazon AWS
provider=aws region=eu-west-1 tag_key=consul tag_value=... access_key_id=... secret_access_key=...

# Google Cloud
provider=gce project_name=... zone_pattern=eu-west-* tag_value=consul credentials_file=...

# Microsoft Azure
provider=azure tag_name=consul tag_value=... tenant_id=... client_id=... subscription_id=... secret_access_key=...

# SoftLayer
provider=softlayer datacenter=dal06 tag_value=consul username=... api_key=...

Command Line Tool Usage

Install the command line tool with:

go get -u github.com/hashicorp/go-discover/cmd/discover

Then run it with:

$ discover addrs provider=aws region=eu-west-1 ...

Library Usage

Install the library with:

go get -u github.com/hashicorp/go-discover

You can then either support discovery for all available providers or only for some of them.

// support discovery for all supported providers
d := discover.Discover{}

// support discovery for AWS and GCE only
d := discover.Discover{
	Providers : map[string]discover.Provider{
		"aws": discover.Providers["aws"],
		"gce": discover.Providers["gce"],
	}
}

// use ioutil.Discard for no log output
l := log.New(os.Stderr, "", log.LstdFlags)

cfg := "provider=aws region=eu-west-1 ..."
addrs, err := d.Addrs(cfg, l)

For complete API documentation, see GoDoc. The configuration for the supported providers is documented in the providers sub-package.