README
¶
Consul 
- Website: https://www.consul.io
- Tutorials: HashiCorp Learn
- Forum: Discuss
Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.
Consul provides several key features:
-
Multi-Datacenter - Consul is built to be datacenter aware, and can support any number of regions without complex configuration.
-
Service Mesh/Service Segmentation - Consul Connect enables secure service-to-service communication with automatic TLS encryption and identity-based authorization. Applications can use sidecar proxies in a service mesh configuration to establish TLS connections for inbound and outbound connections without being aware of Connect at all.
-
Service Discovery - Consul makes it simple for services to register themselves and to discover other services via a DNS or HTTP interface. External services such as SaaS providers can be registered as well.
-
Health Checking - Health Checking enables Consul to quickly alert operators about any issues in a cluster. The integration with service discovery prevents routing traffic to unhealthy hosts and enables service level circuit breakers.
-
Key/Value Storage - A flexible key/value store enables storing dynamic configuration, feature flagging, coordination, leader election and more. The simple HTTP API makes it easy to use anywhere.
Consul runs on Linux, Mac OS X, FreeBSD, Solaris, and Windows. A commercial version called Consul Enterprise is also available.
Please note: We take Consul's security and our users' trust very seriously. If you believe you have found a security issue in Consul, please responsibly disclose by contacting us at security@hashicorp.com.
Quick Start
A few quick start guides are available on the Consul website:
- Standalone binary install: https://learn.hashicorp.com/tutorials/consul/get-started-install
- Minikube install: https://learn.hashicorp.com/tutorials/consul/kubernetes-minikube
- Kind install: https://learn.hashicorp.com/tutorials/consul/kubernetes-kind
- Kubernetes install: https://learn.hashicorp.com/tutorials/consul/kubernetes-deployment-guide
Documentation
Full, comprehensive documentation is available on the Consul website:
Contributing
Thank you for your interest in contributing! Please refer to CONTRIBUTING.md for guidance.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
ae
Package ae provides tools to synchronize state between local and remote consul servers.
|
Package ae provides tools to synchronize state between local and remote consul servers. |
|
cache
Package cache provides caching features for data from a Consul server.
|
Package cache provides caching features for data from a Consul server. |
|
cache-types
Code generated by mockery v1.0.0
|
Code generated by mockery v1.0.0 |
|
consul
The snapshot endpoint is a special non-RPC endpoint that supports streaming for taking and restoring snapshots for disaster recovery.
|
The snapshot endpoint is a special non-RPC endpoint that supports streaming for taking and restoring snapshots for disaster recovery. |
|
proxycfg
Package proxycfg provides a component that monitors local agent state for Connect proxy service registrations and maintains the necessary cache state for those proxies locally.
|
Package proxycfg provides a component that monitors local agent state for Connect proxy service registrations and maintains the necessary cache state for those proxies locally. |
|
router
Package servers provides a Manager interface for Manager managed metadata.Server objects.
|
Package servers provides a Manager interface for Manager managed metadata.Server objects. |
|
xds
Package xds provides an implementation of a gRPC service that exports Envoy's xDS API for config discovery.
|
Package xds provides an implementation of a gRPC service that exports Envoy's xDS API for config discovery. |
|
api
module
|
|
|
certgen
certgen: a tool for generating test certificates on disk for use as test-fixtures and for end-to-end testing and local development.
|
certgen: a tool for generating test certificates on disk for use as test-fixtures and for end-to-end testing and local development. |
|
envoyextensions
module
|
|
|
internal
module
|
|
|
go-sso/oidcauth
package oidcauth bundles up an opinionated approach to authentication using both the OIDC authorization code workflow and simple JWT decoding (via static keys, JWKS, and OIDC discovery).
|
package oidcauth bundles up an opinionated approach to authentication using both the OIDC authorization code workflow and simple JWT decoding (via static keys, JWKS, and OIDC discovery). |
|
go-sso/oidcauth/oidcauthtest
package oidcauthtest exposes tools to assist in writing unit tests of OIDC and JWT authentication workflows.
|
package oidcauthtest exposes tools to assist in writing unit tests of OIDC and JWT authentication workflows. |
|
tools/proto-gen-rpc-glue
Module
|
|
|
decode
Package decode provides tools for customizing the decoding of configuration, into structures using mapstructure.
|
Package decode provides tools for customizing the decoding of configuration, into structures using mapstructure. |
|
semaphore
Package semaphore implements a simple semaphore that is based on golang.org/x/sync/semaphore but doesn't support weights.
|
Package semaphore implements a simple semaphore that is based on golang.org/x/sync/semaphore but doesn't support weights. |
|
proto-public
module
|
|
|
sdk
module
|
|
|
The archive utilities manage the internal format of a snapshot, which is a tar file with the following contents: meta.json - JSON-encoded snapshot metadata from Raft state.bin - Encoded snapshot data from Raft SHA256SUMS - SHA-256 sums of the above two files The integrity information is automatically created and checked, and a failure there just looks like an error to the caller.
|
The archive utilities manage the internal format of a snapshot, which is a tar file with the following contents: meta.json - JSON-encoded snapshot metadata from Raft state.bin - Encoded snapshot data from Raft SHA256SUMS - SHA-256 sums of the above two files The integrity information is automatically created and checked, and a failure there just looks like an error to the caller. |
|
test
|
|
|
integration/consul-container
Module
|
|
|
test-integ
module
|
|
|
testing
|
|
|
deployer
Module
|
|
|
troubleshoot
module
|
|