Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add envoy to the proxycfg diagram #16834

Merged
merged 2 commits into from
Apr 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions agent/proxycfg/proxycfg.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@
// | State | | State Sync |
// +-------+ +-----+------+
// ▲ |
// | +---------------+ | 2.
// 4. | 4a. | Local | |
// | +-▶ | Config Source +-+ |
// | | +---------------+ | |
// | | ▼ ▼
// +-------+ | +---------------+ | 2.
// | envoy | 4. | 4a. | Local | |
// +-------+ | +-▶ | Config Source +-+ |
// | stream | | +---------------+ | |
// | | ▼ ▼
// +--------+ 3. +-+-+-----------+ 6. +----------+ 2a. +----------+
// | xDS +---▶ | Catalog +-----▶ | proxycfg +----▶ | proxycfg |
// | Server | ◀---+ Config Source +-----▶ | Manager +--+ | State |
Expand All @@ -41,10 +41,10 @@
// they are sync'd to the proxycfg.Manager.
// 2a. proxycfg.Manager creates a state object for the service and begins
// pre-fetching data (go to 8).
// 3. Client begins a stream and the xDS server calls Watch on its ConfigSource -
// on a client agent this would be a local config source, on a server it would
// be a catalog config source.
// 4. The catalog config source will check if service is registered locally.
// 3. Client (i.e., envoy) begins a stream and the xDS server calls Watch on its
// ConfigSource - on a client agent this would be a local config source, on a
// server it would be a catalog config source.
// 4. On server, the catalog config source will check if service is registered locally.
// 4a. If the service *is* registered locally it hands off the the local config
// source, which calls Watch on the proxycfg manager (and serves the pre-
// fetched data).
Expand Down
2 changes: 1 addition & 1 deletion docs/service-mesh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The core of the built-in proxy is implemented in the [connect/proxy](https://git
The high-level flow of configuring Envoy is:
1. The initial "bootstrap" configuration is generated for an Envoy proxy by a consul-dataplane instance or a Consul client agent.
2. Envoy dials the xDS server, requesting configuration to act as a particular proxy or gateway instance. The xDS server will either be a Consul server or a Consul client agent.
3. Consul in initializes internal watches for the snapshot of data necessary to configure Envoy. This snapshot will contain data as collected from Consul's state.
3. Consul initializes internal watches for the snapshot of data necessary to configure Envoy. This snapshot will contain data as collected from Consul's state.
4. As these snapshots are generated and updated, Consul will generate and push Envoy configuration for the various xDS resource types if there were changes.

### Bootstrapping Envoy proxies
Expand Down