consul-guides icon indicating copy to clipboard operation
consul-guides copied to clipboard

Example usage of HashiCorp Consul



Consul Guides

This repository aims to assist individuals in learning how to install, configure, and administer HashiCorp Consul.

Disclaimer

This repo is a work in progress. We've decided to open source it while we build as the initial examples may be useful for some. Please bear with us while we work to create meaningful content that will be useful for all.

Operations Guides

Guides for Consul Operational tasks.

  • Provision a Dev Consul Cluster locally with Vagrant
  • Provision a Dev Consul Cluster on AWS with Terraform
  • Provision a Quick Start Consul Cluster on AWS with Terraform
  • Provision a Best Practices Consul Cluster on AWS with Terraform
  • Automated Upgrades with Consul Enterprise
  • [ ] Automated Backups with Consul Enterprise

Service Discovery Guides

This area contains example use cases for how to use Consul for service discovery.

Service Configuration Guides

None yet, check back soon or feel free to contribute!

Service Segementation Guides

This area contains examples of securing service-to-service communication using Consul Connect.

Assets

This directory contains graphics and other material for the repository.

gitignore.tf Files

You may notice some gitignore.tf files in certain directories. .tf files that contain the word "gitignore" are ignored by git in the .gitignore file.

If you have local Terraform configuration that you want ignored (like Terraform backend configuration), create a new file in the directory (separate from gitignore.tf) that contains the word "gitignore" (e.g. backend.gitignore.tf) and it won't be picked up as a change.

Contributing

We welcome contributions and feedback! For guide submissions, please see the contributions guide