Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.

consul api-gateway kubernetes ecs service-discovery service-mesh vault

Tree: 312bb96372

History

R.B. Boyer ef6f2494c7 resource: allow for the ACLs.Read hook to request the entire data payload to perform the authz check (#18925 ) The ACLs.Read hook for a resource only allows for the identity of a resource to be passed in for use in authz consideration. For some resources we wish to allow for the current stored value to dictate how to enforce the ACLs (such as reading a list of applicable services from the payload and allowing service:read on any of them to control reading the enclosing resource). This change update the interface to usually accept a *pbresource.ID, but if the hook decides it needs more data it returns a sentinel error and the resource service knows to defer the authz check until after fetching the data from storage.		1 year ago
..
acl	…
cli	…
client-agent	…
cluster-federation	…
cluster-membership	…
config	OSS -> CE (community edition) changes (#18517 )	1 year ago
contributing	…
debug	Add some docs on pprof usage (#12551 )	3 years ago
http-api	…
persistence	OSS -> CE (community edition) changes (#18517 )	1 year ago
resources	resource: allow for the ACLs.Read hook to request the entire data payload to perform the authz check (#18925 )	1 year ago
rpc	grpc: rename public/private directories to external/internal (#13721 )	2 years ago
service-discovery	fix: missing UDP field in checkType (#14885 )	2 years ago
service-mesh	docs: add envoy to the proxycfg diagram (#16834 )	2 years ago
README.md	update readme.md (#18191 )	1 year ago
consul-mermaid-theme.json	…
faq.md	…
overview.mmd	…
overview.svg	…

README.md

Consul Developer Documentation

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 be found in the public user documentation.

^source

Also see the FAQ.

Other Docs

Important Directories

Most top level directories contain Go source code. The directories listed below contain other important source related to Consul.

ui contains the source code for the Consul UI.
website contains the source for consul.io. A pull requests can update the source code and Consul's documentation at the same time.
.github contains the source for our CI and GitHub repository automation.
.changelog contains markdown files that are used by hashicorp/go-changelog to produce the CHANGELOG.md.
build-support contains bash functions and scripts used to automate. development tasks. Generally these scripts are called from the Makefile.
grafana contains the source for a Grafana dashboard that can be used to monitor Consul.

Contributing to these docs

This section is meta documentation about contributing to these docs.

Diagrams

The diagrams in these documents are created using the mermaid-js live editor. The mermaid-js docs provide a complete reference for how to create and edit the diagrams. Use the consul-mermaid-theme.json (paste it into the Config tab in the editor) to maintain a consistent Consul style for the diagrams.