hashicorp/consul-aws repository overview

⁠Consul-AWS

consul-aws syncs the services in an AWS CloudMap namespace to a Consul datacenter. Consul services will be created in AWS CloudMap and the other way around. This enables native service discovery across Consul and AWS CloudMap.

This project is versioned separately from Consul. Supported Consul versions for each feature will be noted below. By versioning this project separately, we can iterate on AWS integrations more quickly and release new versions without forcing Consul users to do a full Consul upgrade.

⁠Usage

consul-aws can sync from Consul to AWS CloudMap (-to-aws), from AWS CloudMap to Consul (-to-consul) and both at the same time. No matter which direction is being used consul-aws needs to be connected to Consul and AWS CloudMap.

In order to help with connecting to a Consul cluster, consul-aws provides all the flags you might need including the possibility to set an ACL token. consul-aws loads your AWS configuration from .aws, from the instance profile and ENV variables - it supports everything provided by the AWS golang sdk.

Apart from that, an AWS CloudMap namespace id has to be provided. This is how consul-aws could be invoked to sync both directions:

$ docker run hashicorp/consul-aws consul-aws sync-catalog -aws-namespace-id ns-hjrgt3bapp7phzff -to-aws -to-consul

⁠Contributing

Please see the Contributing Guidelines in the consul-aws GitHub repository⁠.

⁠Compatibility with Consul

consul-aws supports the current version of Consul and the version before. At the time of writing this, it means 1.7 and 1.6.