open-consul/contributing
..
acl contrib: add first draft of ACL docs 2021-07-05 18:25:06 -04:00
cli
client-agent
cluster-federation
cluster-membership
config
http-api
persistence
rpc
service-discovery
service-mesh
consul-mermaid-theme.json
faq.md
INTERNALS.md
overview.mmd
overview.svg
README.md

Contributing to Consul

See our contributing guide to get started.

This directory contains documentation intended for anyone interested in understanding, and contributing changes to, the Consul codebase.

Overview

This documentation is organized into the following categories. Each category is either a significant architectural layer, or major functional area of Consul. These documents assume a basic understanding of Consul's feature set, which can found in the public user documentation.

Overview

source

Contents

  1. Overview
  2. Command-Line Interface (CLI)
  3. HTTP API
  4. Agent Configuration
  5. RPC
  6. Cluster Persistence
  7. Client Agent
  8. Service Discovery
  9. Service Mesh (Connect)
  10. Cluster Membership
  11. Key/Value Store
  12. ACL
  13. Multi-Cluster Federation

Also see the FAQ.